Remove redundant web3.exceptions.PMError in favor of ethpm.exceptions.PyEthPMException

Author: kclowes

ethpm/exceptions.py

@@ -53,3 +53,11 @@ class ManifestBuildingError(PyEthPMException):
     """
 
     pass
+
+
+class ManifestValidationError(PyEthPMException):
+    """
+    Raised when a provided manifest cannot be published, since it's invalid.
+    """
+
+    pass

ethpm/package.py

@@ -56,7 +56,7 @@
     EthPMValidationError,
     FailureToFetchIPFSAssetsError,
     InsufficientAssetsError,
-    PyEthPMError,
+    PyEthPMException,
 )
 from ethpm.uri import (
     resolve_uri_contents,
@@ -338,7 +338,7 @@ def build_dependencies(self) -> "Dependencies":
             try:
                 validate_build_dependency(name, uri)
                 dependency_package = Package.from_uri(uri, self.w3)
-            except PyEthPMError as e:
+            except PyEthPMException as e:
                 raise FailureToFetchIPFSAssetsError(
                     f"Failed to retrieve build dependency: {name} from URI: {uri}.\n"
                     f"Got error: {e}."

newsfragments/1478.breaking.rst

@@ -1 +1 @@
-All exceptions inherit from a custom class. EthPM exceptions inherit from PyEthPMError, ENS exceptions inherit from ENS Error, and all other web3.py exceptions inherit from Web3Exception
+All exceptions inherit from a custom class. EthPM exceptions inherit from PyEthPMException, ENS exceptions inherit from ENSException, and all other web3.py exceptions inherit from Web3Exception

tests/core/pm-module/test_pm_init.py

@@ -6,14 +6,12 @@
 )
 from ethpm.exceptions import (
     InsufficientAssetsError,
+    PyEthPMException,
 )
 from ethpm.tools import (
     get_ethpm_local_manifest,
     get_ethpm_spec_manifest,
 )
-from web3.exceptions import (
-    PMError,
-)
 
 
 def test_pm_init_with_minimal_manifest(w3):
@@ -123,10 +121,10 @@ def test_get_local_package(w3, tmp_ethpmdir):
 def test_get_local_package_with_invalid_ethpmdir(w3, tmp_path):
     invalid_ethpmdir = tmp_path / "invalid"
     invalid_ethpmdir.mkdir()
-    with pytest.raises(PMError, match="not a valid ethPM packages directory."):
+    with pytest.raises(PyEthPMException, match="not a valid ethPM packages directory."):
         w3.pm.get_local_package("owned", invalid_ethpmdir)
 
 
 def test_get_local_package_with_uninstalled_package(w3, tmp_ethpmdir):
-    with pytest.raises(PMError, match="Package: safe-math not found in "):
+    with pytest.raises(PyEthPMException, match="Package: safe-math not found in "):
         w3.pm.get_local_package("safe-math", tmp_ethpmdir)

tests/core/pm-module/test_registry_integration.py

@@ -11,10 +11,10 @@
 from ethpm.contract import (
     LinkableContract,
 )
-from web3 import Web3
-from web3.exceptions import (
-    PMError,
+from ethpm.exceptions import (
+    PyEthPMException,
 )
+from web3 import Web3
 from web3.pm import (
     SimpleRegistry,
     get_simple_registry_manifest,
@@ -60,25 +60,25 @@ def test_pm_set_custom_registry(empty_sol_registry, fresh_w3):
 
 @pytest.mark.xfail(reason="Need to properly add authorization as of 8/10/2022")
 def test_pm_must_set_registry_before_all_registry_interaction_functions(fresh_w3):
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.release_package(
             "package", "1.0.0", "ipfs://QmcxvhkJJVpbxEAa6cgW3B6XwPJb79w9GpNUv2P2THUzZR"
         )
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_release_id_data(b"invalid_release_id")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_release_id("package", "1.0.0")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_release_data("package", "1.0.0")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_package("package", "1.0.0")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_all_package_names()
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_all_package_releases("package")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_release_count("package")
-    with pytest.raises(PMError):
+    with pytest.raises(PyEthPMException):
         fresh_w3.pm.get_package_count()
 
 

web3/exceptions.py

@@ -201,22 +201,6 @@ class TimeExhausted(Web3Exception):
     pass
 
 
-class PMError(Web3Exception):
-    """
-    Raised when an error occurs in the PM module.
-    """
-
-    pass
-
-
-class ManifestValidationError(PMError):
-    """
-    Raised when a provided manifest cannot be published, since it's invalid.
-    """
-
-    pass
-
-
 class TransactionNotFound(Web3Exception):
     """
     Raised when a tx hash used to lookup a tx in a jsonrpc call cannot be found.

web3/pm.py

@@ -38,6 +38,10 @@
     ASSETS_DIR,
     Package,
 )
+from ethpm.exceptions import (
+    ManifestValidationError,
+    PyEthPMException,
+)
 from ethpm.uri import (
     is_supported_content_addressed_uri,
     resolve_uri_contents,
@@ -56,9 +60,7 @@
 )
 from web3.exceptions import (
     InvalidAddress,
-    ManifestValidationError,
     NameNotFound,
-    PMError,
 )
 from web3.module import (
     Module,
@@ -360,11 +362,13 @@ def get_local_package(self, package_name: str, ethpm_dir: Path = None) -> Packag
             ethpm_dir = Path.cwd() / "_ethpm_packages"
 
         if not ethpm_dir.name == "_ethpm_packages" or not ethpm_dir.is_dir():
-            raise PMError(f"{ethpm_dir} is not a valid ethPM packages directory.")
+            raise PyEthPMException(
+                f"{ethpm_dir} is not a valid ethPM packages directory."
+            )
 
         local_packages = [pkg.name for pkg in ethpm_dir.iterdir() if pkg.is_dir()]
         if package_name not in local_packages:
-            raise PMError(
+            raise PyEthPMException(
                 f"Package: {package_name} not found in {ethpm_dir}. "
                 f"Available packages include: {local_packages}."
             )
@@ -402,7 +406,7 @@ def set_registry(self, address: Union[Address, ChecksumAddress, ENS]) -> None:
                 )
             self.registry = SimpleRegistry(addr_lookup, self.w3)
         else:
-            raise PMError(
+            raise PyEthPMException(
                 "Expected a canonical/checksummed address or ENS name for the address, "
                 f"instead received {type(address)}."
             )
@@ -555,14 +559,14 @@ def _validate_set_registry(self) -> None:
         try:
             self.registry
         except AttributeError:
-            raise PMError(
+            raise PyEthPMException(
                 "web3.pm does not have a set registry. "
                 "Please set registry with either: "
                 "web3.pm.set_registry(address) or "
                 "web3.pm.deploy_and_set_registry()"
             )
         if not isinstance(self.registry, ERC1319Registry):
-            raise PMError(
+            raise PyEthPMException(
                 "web3.pm requires an instance of a subclass of ERC1319Registry "
                 "to be set as the web3.pm.registry attribute. Instead found: "
                 f"{type(self.registry)}."