Add base Web3Exception, ENSError, and PyEthPMError

Exception mixin inherited by all exceptions of each module.

This allows:

    try:
        some_call()
    except Web3Exception as e:
        # deal with web3 exception
    except:
        # deal with other exceptions

Author: jpic

ens/exceptions.py

@@ -1,7 +1,15 @@
 import idna
 
 
-class AddressMismatch(ValueError):
+class ENSError(Exception):
+    """
+    Base class for all ENS Errors
+    """
+
+    pass
+
+
+class AddressMismatch(ENSError):
     """
     In order to set up reverse resolution correctly, the ENS name should first
     point to the address. This exception is raised if the name does
@@ -11,7 +19,7 @@ class AddressMismatch(ValueError):
     pass
 
 
-class InvalidName(idna.IDNAError):
+class InvalidName(idna.IDNAError, ENSError):
     """
     This exception is raised if the provided name does not meet
     the syntax standards specified in `EIP 137 name syntax
@@ -23,7 +31,7 @@ class InvalidName(idna.IDNAError):
     pass
 
 
-class UnauthorizedError(Exception):
+class UnauthorizedError(ENSError):
     """
     Raised if the sending account is not the owner of the name
     you are trying to modify. Make sure to set ``from`` in the
@@ -33,7 +41,7 @@ class UnauthorizedError(Exception):
     pass
 
 
-class UnownedName(Exception):
+class UnownedName(ENSError):
     """
     Raised if you are trying to modify a name that no one owns.
 
@@ -44,47 +52,47 @@ class UnownedName(Exception):
     pass
 
 
-class ResolverNotFound(Exception):
+class ResolverNotFound(ENSError):
     """
     Raised if no resolver was found for the name you are trying to resolve.
     """
 
     pass
 
 
-class UnsupportedFunction(Exception):
+class UnsupportedFunction(ENSError):
     """
     Raised if a resolver does not support a particular method.
     """
 
     pass
 
 
-class BidTooLow(ValueError):
+class BidTooLow(ENSError):
     """
     Raised if you bid less than the minimum amount
     """
 
     pass
 
 
-class InvalidBidHash(ValueError):
+class InvalidBidHash(ENSError):
     """
     Raised if you supply incorrect data to generate the bid hash.
     """
 
     pass
 
 
-class InvalidLabel(ValueError):
+class InvalidLabel(ENSError):
     """
     Raised if you supply an invalid label
     """
 
     pass
 
 
-class OversizeTransaction(ValueError):
+class OversizeTransaction(ENSError):
     """
     Raised if a transaction you are trying to create would cost so
     much gas that it could not fit in a block.
@@ -95,7 +103,7 @@ class OversizeTransaction(ValueError):
     pass
 
 
-class UnderfundedBid(ValueError):
+class UnderfundedBid(ENSError):
     """
     Raised if you send less wei with your bid than you declared
     as your intent to bid.

newsfragments/1478.breaking.rst

@@ -0,0 +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

tests/core/eth-module/test_eth_contract.py

@@ -7,6 +7,10 @@
     to_bytes,
 )
 
+from web3.exceptions import (
+    InvalidAddress,
+)
+
 ABI = [{}]
 ADDRESS = "0xd3CdA913deB6f67967B99D67aCDFa1712C293601"
 BYTES_ADDRESS = to_bytes(hexstr=ADDRESS)
@@ -19,11 +23,11 @@
     (
         ((ADDRESS,), {}, None),
         ((BYTES_ADDRESS,), {}, None),
-        ((INVALID_CHECKSUM_ADDRESS,), {}, ValueError),
-        ((NON_CHECKSUM_ADDRESS,), {}, ValueError),
+        ((INVALID_CHECKSUM_ADDRESS,), {}, InvalidAddress),
+        ((NON_CHECKSUM_ADDRESS,), {}, InvalidAddress),
         ((), {"address": ADDRESS}, None),
-        ((), {"address": INVALID_CHECKSUM_ADDRESS}, ValueError),
-        ((), {"address": NON_CHECKSUM_ADDRESS}, ValueError),
+        ((), {"address": INVALID_CHECKSUM_ADDRESS}, InvalidAddress),
+        ((), {"address": NON_CHECKSUM_ADDRESS}, InvalidAddress),
     ),
 )
 def test_contract_address_validation(w3, args, kwargs, expected):

web3/exceptions.py

@@ -10,7 +10,22 @@
 )
 
 
-class BadFunctionCallOutput(Exception):
+class Web3Exception(Exception):
+    """
+    Exception mixin inherited by all exceptions of web3.py
+
+    This allows::
+
+        try:
+            some_call()
+        except Web3Exception:
+            # deal with web3 exception
+        except:
+            # deal with other exceptions
+    """
+
+
+class BadFunctionCallOutput(Web3Exception):
     """
     We failed to decode ABI output.
 
@@ -20,15 +35,15 @@ class BadFunctionCallOutput(Exception):
     pass
 
 
-class BlockNumberOutofRange(Exception):
+class BlockNumberOutofRange(Web3Exception):
     """
     block_identifier passed does not match known block.
     """
 
     pass
 
 
-class CannotHandleRequest(Exception):
+class CannotHandleRequest(Web3Exception):
     """
     Raised by a provider to signal that it cannot handle an RPC request and
     that the manager should proceed to the next provider.
@@ -37,15 +52,15 @@ class CannotHandleRequest(Exception):
     pass
 
 
-class TooManyRequests(Exception):
+class TooManyRequests(Web3Exception):
     """
     Raised by a provider to signal that too many requests have been made consecutively.
     """
 
     pass
 
 
-class MultipleFailedRequests(Exception):
+class MultipleFailedRequests(Web3Exception):
     """
     Raised by a provider to signal that multiple requests to retrieve the same
     (or similar) data have failed.
@@ -54,15 +69,15 @@ class MultipleFailedRequests(Exception):
     pass
 
 
-class InvalidAddress(ValueError):
+class InvalidAddress(Web3Exception):
     """
     The supplied address does not have a valid checksum, as defined in EIP-55
     """
 
     pass
 
 
-class NameNotFound(ValueError):
+class NameNotFound(Web3Exception):
     """
     Raised when a caller provides an Ethereum Name Service name that
     does not resolve to an address.
@@ -71,7 +86,7 @@ class NameNotFound(ValueError):
     pass
 
 
-class StaleBlockchain(Exception):
+class StaleBlockchain(Web3Exception):
     """
     Raised by the stalecheck_middleware when the latest block is too old.
     """
@@ -93,7 +108,7 @@ def __str__(self) -> str:
         return self.args[0]
 
 
-class MismatchedABI(Exception):
+class MismatchedABI(Web3Exception):
     """
     Raised when an ABI does not match with supplied parameters, or when an
     attempt is made to access a function/event that does not exist in the ABI.
@@ -120,15 +135,15 @@ class ABIFunctionNotFound(AttributeError, MismatchedABI):
     pass
 
 
-class FallbackNotFound(Exception):
+class FallbackNotFound(Web3Exception):
     """
     Raised when fallback function doesn't exist in contract.
     """
 
     pass
 
 
-class ValidationError(Exception):
+class ValidationError(Web3Exception):
     """
     Raised when a supplied value is invalid.
     """
@@ -144,31 +159,31 @@ class ExtraDataLengthError(ValidationError):
     pass
 
 
-class NoABIFunctionsFound(AttributeError):
+class NoABIFunctionsFound(Web3Exception):
     """
     Raised when an ABI is present, but doesn't contain any functions.
     """
 
     pass
 
 
-class NoABIFound(AttributeError):
+class NoABIFound(Web3Exception):
     """
     Raised when no ABI is present.
     """
 
     pass
 
 
-class NoABIEventsFound(AttributeError):
+class NoABIEventsFound(Web3Exception):
     """
     Raised when an ABI doesn't contain any events.
     """
 
     pass
 
 
-class InsufficientData(Exception):
+class InsufficientData(Web3Exception):
     """
     Raised when there are insufficient data points to
     complete a calculation
@@ -177,7 +192,7 @@ class InsufficientData(Exception):
     pass
 
 
-class TimeExhausted(Exception):
+class TimeExhausted(Web3Exception):
     """
     Raised when a method has not retrieved the desired
     result within a specified timeout.
@@ -186,7 +201,7 @@ class TimeExhausted(Exception):
     pass
 
 
-class PMError(Exception):
+class PMError(Web3Exception):
     """
     Raised when an error occurs in the PM module.
     """
@@ -202,48 +217,47 @@ class ManifestValidationError(PMError):
     pass
 
 
-class TransactionNotFound(Exception):
+class TransactionNotFound(Web3Exception):
     """
     Raised when a tx hash used to lookup a tx in a jsonrpc call cannot be found.
     """
 
     pass
 
 
-class BlockNotFound(Exception):
+class BlockNotFound(Web3Exception):
     """
     Raised when the block id used to lookup a block in a jsonrpc call cannot be found.
     """
 
     pass
 
 
-class InfuraProjectIdNotFound(Exception):
+class InfuraProjectIdNotFound(Web3Exception):
     """
     Raised when there is no Infura Project Id set.
     """
 
     pass
 
 
-class LogTopicError(ValueError):
-    # Inherits from ValueError for backwards compatibility
+class LogTopicError(Web3Exception):
     """
     Raised when the number of log topics is mismatched.
     """
+
     pass
 
 
-class InvalidEventABI(ValueError):
-    # Inherits from ValueError for backwards compatibility
+class InvalidEventABI(Web3Exception):
     """
     Raised when the event ABI is invalid.
     """
+
     pass
 
 
-class ContractLogicError(ValueError):
-    # Inherits from ValueError for backwards compatibility
+class ContractLogicError(Web3Exception):
     """
     Raised on a contract revert error
     """
@@ -259,7 +273,7 @@ def __init__(self, payload: Dict[str, Any]) -> None:
         super().__init__()
 
 
-class InvalidTransaction(Exception):
+class InvalidTransaction(Web3Exception):
     """
     Raised when a transaction includes an invalid combination of arguments.
     """
@@ -279,9 +293,9 @@ def __init__(self) -> None:
         super().__init__(message)
 
 
-class BadResponseFormat(ValueError, KeyError):
-    # Inherits from KeyError and ValueError for backwards compatibility
+class BadResponseFormat(Web3Exception):
     """
     Raised when a JSON-RPC response comes back in an unexpected format
     """
+
     pass