faster-eth-abi 5.2.9__cp310-cp310-win32.whl → 5.2.11__cp310-cp310-win32.whl

faster_eth_abi/grammar.py

@@ -25,6 +25,14 @@ from typing_extensions import (
     Self,
 )
 
+from faster_eth_abi._grammar import (
+    TYPE_ALIASES,
+    TYPE_ALIAS_RE,
+    ABIType,
+    BasicType,
+    TupleType,
+    normalize,
+)
 from faster_eth_abi.exceptions import (
     ABITypeError,
     ParseError,
@@ -156,313 +164,7 @@ class NodeVisitor(parsimonious.NodeVisitor):  # type: ignore [misc]
 
 visitor: Final = NodeVisitor()
 
-
-class ABIType:
-    """
-    Base class for results of type string parsing operations.
-    """
-
-    __slots__ = ("arrlist", "node")
-
-    def __init__(
-        self, arrlist: Optional[Sequence] = None, node: Optional[Node] = None
-    ) -> None:
-        self.arrlist: Final = arrlist
-        """
-        The list of array dimensions for a parsed type.  Equal to ``None`` if
-        type string has no array dimensions.
-        """
-
-        self.node: Final = node
-        """
-        The parsimonious ``Node`` instance associated with this parsed type.
-        Used to generate error messages for invalid types.
-        """
-
-    def __repr__(self) -> str:  # pragma: no cover
-        return f"<{type(self).__qualname__} {self.to_type_str()!r}>"
-
-    def __eq__(self, other: Any) -> bool:
-        # Two ABI types are equal if their string representations are equal
-        return type(self) is type(other) and self.to_type_str() == other.to_type_str()
-
-    def to_type_str(self) -> TypeStr:  # pragma: no cover
-        """
-        Returns the string representation of an ABI type.  This will be equal to
-        the type string from which it was created.
-        """
-        raise NotImplementedError("Must implement `to_type_str`")
-
-    @property
-    def item_type(self) -> Self:
-        """
-        If this type is an array type, equal to an appropriate
-        :class:`~faster_eth_abi.grammar.ABIType` instance for the array's items.
-        """
-        raise NotImplementedError("Must implement `item_type`")
-
-    def validate(self) -> None:  # pragma: no cover
-        """
-        Validates the properties of an ABI type against the solidity ABI spec:
-
-        https://solidity.readthedocs.io/en/develop/abi-spec.html
-
-        Raises :class:`~faster_eth_abi.exceptions.ABITypeError` if validation fails.
-        """
-        raise NotImplementedError("Must implement `validate`")
-
-    def invalidate(self, error_msg: str) -> NoReturn:
-        # Invalidates an ABI type with the given error message.  Expects that a
-        # parsimonious node was provided from the original parsing operation
-        # that yielded this type.
-        node = self.node
-
-        raise ABITypeError(
-            f"For '{node.text}' type at column {node.start + 1} "
-            f"in '{node.full_text}': {error_msg}"
-        )
-
-    @property
-    def is_array(self) -> bool:
-        """
-        Equal to ``True`` if a type is an array type (i.e. if it has an array
-        dimension list).  Otherwise, equal to ``False``.
-        """
-        return self.arrlist is not None
-
-    @property
-    def is_dynamic(self) -> bool:
-        """
-        Equal to ``True`` if a type has a dynamically sized encoding.
-        Otherwise, equal to ``False``.
-        """
-        raise NotImplementedError("Must implement `is_dynamic`")
-
-    @property
-    def _has_dynamic_arrlist(self) -> bool:
-        return self.is_array and any(len(dim) == 0 for dim in self.arrlist)
-
-
-TComp = TypeVar("TComp", bound=ABIType)
-
-
-@final
-class TupleType(ABIType):
-    """
-    Represents the result of parsing a tuple type string e.g. "(int,bool)".
-    """
-
-    __slots__ = ("components",)
-
-    def __init__(
-        self,
-        components: Tuple[TComp, ...],
-        arrlist: Optional[Sequence] = None,
-        *,
-        node: Optional[Node] = None,
-    ) -> None:
-        super().__init__(arrlist, node)
-
-        self.components: Final = components
-        """
-        A tuple of :class:`~faster_eth_abi.grammar.ABIType` instances for each of the
-        tuple type's components.
-        """
-
-    def to_type_str(self) -> TypeStr:
-        arrlist = self.arrlist
-
-        if isinstance(arrlist, tuple):
-            arrlist = "".join(repr(list(a)) for a in arrlist)
-        else:
-            arrlist = ""
-
-        return f"({','.join(c.to_type_str() for c in self.components)}){arrlist}"
-
-    @property
-    def item_type(self) -> Self:
-        if not self.is_array:
-            raise ValueError(
-                f"Cannot determine item type for non-array type '{self.to_type_str()}'"
-            )
-
-        return type(self)(
-            self.components,
-            self.arrlist[:-1] or None,  # type: ignore [index]
-            node=self.node,
-        )
-
-    def validate(self) -> None:
-        for c in self.components:
-            c.validate()
-
-    @property
-    def is_dynamic(self) -> bool:
-        if self._has_dynamic_arrlist:
-            return True
-
-        return any(c.is_dynamic for c in self.components)
-
-
-@final
-class BasicType(ABIType):
-    """
-    Represents the result of parsing a basic type string e.g. "uint", "address",
-    "ufixed128x19[][2]".
-    """
-
-    __slots__ = ("base", "sub")
-
-    def __init__(
-        self,
-        base: str,
-        sub: Any = None,
-        arrlist: Optional[Sequence] = None,
-        *,
-        node: Optional[Node] = None,
-    ) -> None:
-        super().__init__(arrlist, node)
-
-        self.base: Final = base
-        """The base of a basic type e.g. "uint" for "uint256" etc."""
-
-        self.sub: Final = sub
-        """
-        The sub type of a basic type e.g. ``256`` for "uint256" or ``(128, 18)``
-        for "ufixed128x18" etc.  Equal to ``None`` if type string has no sub
-        type.
-        """
-
-    def to_type_str(self) -> TypeStr:
-        sub, arrlist = self.sub, self.arrlist
-
-        if isinstance(sub, int):
-            substr = str(sub)
-        elif isinstance(sub, tuple):
-            substr = "x".join(str(s) for s in sub)
-        else:
-            substr = ""
-
-        if isinstance(arrlist, tuple):
-            return self.base + substr + "".join(repr(list(a)) for a in arrlist)
-        else:
-            return self.base + substr
-
-    @property
-    def item_type(self) -> Self:
-        if not self.is_array:
-            raise ValueError(
-                f"Cannot determine item type for non-array type '{self.to_type_str()}'"
-            )
-
-        return type(self)(
-            self.base,
-            self.sub,
-            self.arrlist[:-1] or None,  # type: ignore [index]
-            node=self.node,
-        )
-
-    @property
-    def is_dynamic(self) -> bool:
-        if self._has_dynamic_arrlist:
-            return True
-
-        if self.base == "string":
-            return True
-
-        if self.base == "bytes" and self.sub is None:
-            return True
-
-        return False
-
-    def validate(self) -> None:
-        base, sub = self.base, self.sub
-
-        # Check validity of string type
-        if base == "string":
-            if sub is not None:
-                self.invalidate("string type cannot have suffix")
-
-        # Check validity of bytes type
-        elif base == "bytes":
-            if not (sub is None or isinstance(sub, int)):
-                self.invalidate(
-                    "bytes type must have either no suffix or a numerical suffix"
-                )
-
-            if isinstance(sub, int) and sub > 32:
-                self.invalidate("maximum 32 bytes for fixed-length bytes")
-
-        # Check validity of integer type
-        elif base in ("int", "uint"):
-            if not isinstance(sub, int):
-                self.invalidate("integer type must have numerical suffix")
-
-            if sub < 8 or sub > 256:
-                self.invalidate("integer size out of bounds (max 256 bits)")
-
-            if sub % 8 != 0:
-                self.invalidate("integer size must be multiple of 8")
-
-        # Check validity of fixed type
-        elif base in ("fixed", "ufixed"):
-            if not isinstance(sub, tuple):
-                self.invalidate(
-                    "fixed type must have suffix of form <bits>x<exponent>, "
-                    "e.g. 128x19",
-                )
-
-            bits, minus_e = sub
-
-            if bits < 8 or bits > 256:
-                self.invalidate("fixed size out of bounds (max 256 bits)")
-
-            if bits % 8 != 0:
-                self.invalidate("fixed size must be multiple of 8")
-
-            if minus_e < 1 or minus_e > 80:
-                self.invalidate(
-                    f"fixed exponent size out of bounds, {minus_e} must be in 1-80"
-                )
-
-        # Check validity of hash type
-        elif base == "hash":
-            if not isinstance(sub, int):
-                self.invalidate("hash type must have numerical suffix")
-
-        # Check validity of address type
-        elif base == "address":
-            if sub is not None:
-                self.invalidate("address cannot have suffix")
-
-
-TYPE_ALIASES: Final = {
-    "int": "int256",
-    "uint": "uint256",
-    "fixed": "fixed128x18",
-    "ufixed": "ufixed128x18",
-    "function": "bytes24",
-    "byte": "bytes1",
-}
-
-TYPE_ALIAS_RE: Final = re.compile(
-    rf"\b({'|'.join(re.escape(a) for a in TYPE_ALIASES.keys())})\b"
-)
-
-
-def normalize(type_str: TypeStr) -> TypeStr:
-    """
-    Normalizes a type string into its canonical version e.g. the type string
-    'int' becomes 'int256', etc.
-
-    :param type_str: The type string to be normalized.
-    :returns: The canonical version of the input type string.
-    """
-    return TYPE_ALIAS_RE.sub(__normalize, type_str)
-
-
-def __normalize(match: "re.Match[str]") -> str:
-    return TYPE_ALIASES[match.group(0)]
+parse: Final = visitor.parse
 
 
-parse: Final = visitor.parse
+__all__ = ["NodeVisitor", "ABIType", "TupleType", "BasicType", "grammar", "parse", "normalize", "visitor", "TYPE_ALIASES", "TYPE_ALIAS_RE"]

faster_eth_abi/registry.py

@@ -1,17 +1,24 @@
 import abc
-import copy
 import functools
+from copy import copy
 from typing import (
     Any,
     Callable,
+    Dict,
+    Final,
+    Generic,
     Optional,
     Type,
+    TypeVar,
     Union,
 )
 
 from eth_typing import (
     TypeStr,
 )
+from typing_extensions import (
+    Self,
+)
 
 from . import (
     decoding,
@@ -30,6 +37,8 @@ from .io import (
     ContextFramesBytesIO,
 )
 
+T = TypeVar("T")
+
 Lookup = Union[TypeStr, Callable[[TypeStr], bool]]
 
 EncoderCallable = Callable[[Any], bytes]
@@ -51,34 +60,35 @@ class Copyable(abc.ABC):
         return self.copy()
 
 
-class PredicateMapping(Copyable):
+class PredicateMapping(Copyable, Generic[T]):
     """
     Acts as a mapping from predicate functions to values.  Values are retrieved
     when their corresponding predicate matches a given input.  Predicates can
     also be labeled to facilitate removal from the mapping.
     """
 
-    def __init__(self, name):
-        self._name = name
-        self._values = {}
-        self._labeled_predicates = {}
+    def __init__(self, name: str):
+        self._name: Final = name
+        self._values: Dict[Lookup, T] = {}
+        self._labeled_predicates: Dict[str, Lookup] = {}
 
-    def add(self, predicate, value, label=None):
+    def add(self, predicate: Lookup, value: T, label: Optional[str] = None) -> None:
         if predicate in self._values:
             raise ValueError(f"Matcher {predicate!r} already exists in {self._name}")
 
         if label is not None:
-            if label in self._labeled_predicates:
+            labeled_predicates = self._labeled_predicates
+            if label in labeled_predicates:
                 raise ValueError(
                     f"Matcher {predicate!r} with label '{label}' "
                     f"already exists in {self._name}"
                 )
 
-            self._labeled_predicates[label] = predicate
+            labeled_predicates[label] = predicate
 
         self._values[predicate] = value
 
-    def find(self, type_str):
+    def find(self, type_str: TypeStr) -> T:
         results = tuple(
             (predicate, value)
             for predicate, value in self._values.items()
@@ -103,9 +113,9 @@ class PredicateMapping(Copyable):
                 "documentation for more information."
             )
 
-        return values[0]
+        return values[0]  # type: ignore [no-any-return]
 
-    def remove_by_equality(self, predicate):
+    def remove_by_equality(self, predicate: Lookup) -> None:
         # Delete the predicate mapping to the previously stored value
         try:
             del self._values[predicate]
@@ -120,7 +130,7 @@ class PredicateMapping(Copyable):
         else:
             del self._labeled_predicates[label]
 
-    def _label_for_predicate(self, predicate):
+    def _label_for_predicate(self, predicate: Lookup) -> str:
         # Both keys and values in `_labeled_predicates` are unique since the
         # `add` method enforces this
         for key, value in self._labeled_predicates.items():
@@ -131,16 +141,17 @@ class PredicateMapping(Copyable):
             f"Matcher {predicate!r} not referred to by any label in {self._name}"
         )
 
-    def remove_by_label(self, label):
+    def remove_by_label(self, label: str) -> None:
+        labeled_predicates = self._labeled_predicates
         try:
-            predicate = self._labeled_predicates[label]
+            predicate = labeled_predicates[label]
         except KeyError:
             raise KeyError(f"Label '{label}' not found in {self._name}")
 
-        del self._labeled_predicates[label]
+        del labeled_predicates[label]
         del self._values[predicate]
 
-    def remove(self, predicate_or_label):
+    def remove(self, predicate_or_label: Union[Lookup, str]) -> None:
         if callable(predicate_or_label):
             self.remove_by_equality(predicate_or_label)
         elif isinstance(predicate_or_label, str):
@@ -151,11 +162,11 @@ class PredicateMapping(Copyable):
                 f"{type(predicate_or_label)}"
             )
 
-    def copy(self):
+    def copy(self) -> Self:
         cpy = type(self)(self._name)
 
-        cpy._values = copy.copy(self._values)
-        cpy._labeled_predicates = copy.copy(self._labeled_predicates)
+        cpy._values = copy(self._values)
+        cpy._labeled_predicates = copy(self._labeled_predicates)
 
         return cpy
 
@@ -282,6 +293,7 @@ def _clear_encoder_cache(old_method: Callable[..., None]) -> Callable[..., None]
     @functools.wraps(old_method)
     def new_method(self: "ABIRegistry", *args: Any, **kwargs: Any) -> None:
         self.get_encoder.cache_clear()
+        self.get_tuple_encoder.cache_clear()
         return old_method(self, *args, **kwargs)
 
     return new_method
@@ -291,6 +303,7 @@ def _clear_decoder_cache(old_method: Callable[..., None]) -> Callable[..., None]
     @functools.wraps(old_method)
     def new_method(self: "ABIRegistry", *args: Any, **kwargs: Any) -> None:
         self.get_decoder.cache_clear()
+        self.get_tuple_decoder.cache_clear()
         return old_method(self, *args, **kwargs)
 
     return new_method
@@ -343,8 +356,8 @@ class BaseRegistry:
 
 class ABIRegistry(Copyable, BaseRegistry):
     def __init__(self):
-        self._encoders = PredicateMapping("encoder registry")
-        self._decoders = PredicateMapping("decoder registry")
+        self._encoders: PredicateMapping[Encoder] = PredicateMapping("encoder registry")
+        self._decoders: PredicateMapping[Decoder] = PredicateMapping("decoder registry")
         self.get_encoder = functools.lru_cache(maxsize=None)(self._get_encoder_uncached)
         self.get_decoder = functools.lru_cache(maxsize=None)(self._get_decoder_uncached)
         self.get_tuple_encoder = functools.lru_cache(maxsize=None)(
@@ -518,8 +531,8 @@ class ABIRegistry(Copyable, BaseRegistry):
         """
         cpy = type(self)()
 
-        cpy._encoders = copy.copy(self._encoders)
-        cpy._decoders = copy.copy(self._decoders)
+        cpy._encoders = copy(self._encoders)
+        cpy._decoders = copy(self._decoders)
 
         return cpy
 

faster_eth_abi/tools/_strategies.py

@@ -2,7 +2,9 @@ from typing import (
     Callable,
     Final,
     Optional,
+    Tuple,
     Union,
+    cast,
 )
 
 from cchecksum import (
@@ -15,11 +17,13 @@ from hypothesis import (
     strategies as st,
 )
 
-from faster_eth_abi.grammar import (
+from faster_eth_abi._grammar import (
     ABIType,
     BasicType,
     TupleType,
     normalize,
+)
+from faster_eth_abi.grammar import (
     parse,
 )
 from faster_eth_abi.registry import (
@@ -81,7 +85,7 @@ class StrategyRegistry(BaseRegistry):
 def get_uint_strategy(
     abi_type: BasicType, registry: StrategyRegistry
 ) -> st.SearchStrategy:
-    bits = abi_type.sub
+    bits = cast(int, abi_type.sub)
 
     return st.integers(
         min_value=0,
@@ -92,7 +96,7 @@ def get_uint_strategy(
 def get_int_strategy(
     abi_type: BasicType, registry: StrategyRegistry
 ) -> st.SearchStrategy:
-    bits = abi_type.sub
+    bits = cast(int, abi_type.sub)
 
     return st.integers(
         min_value=-(2 ** (bits - 1)),
@@ -107,7 +111,7 @@ bool_strategy: Final = st.booleans()
 def get_ufixed_strategy(
     abi_type: BasicType, registry: StrategyRegistry
 ) -> st.SearchStrategy:
-    bits, places = abi_type.sub
+    bits, places = cast(Tuple[int, int], abi_type.sub)
 
     return st.decimals(
         min_value=0,
@@ -119,7 +123,7 @@ def get_ufixed_strategy(
 def get_fixed_strategy(
     abi_type: BasicType, registry: StrategyRegistry
 ) -> st.SearchStrategy:
-    bits, places = abi_type.sub
+    bits, places = cast(Tuple[int, int], abi_type.sub)
 
     return st.decimals(
         min_value=-(2 ** (bits - 1)),

faster_eth_abi/utils/numeric.py

@@ -1,6 +1,7 @@
 import decimal
 from typing import (
     Callable,
+    Dict,
     Final,
     Tuple,
 )
@@ -8,6 +9,7 @@ from typing import (
 ABI_DECIMAL_PREC: Final = 999
 
 abi_decimal_context: Final = decimal.Context(prec=ABI_DECIMAL_PREC)
+decimal_localcontext: Final = decimal.localcontext
 
 ZERO: Final = decimal.Decimal(0)
 TEN: Final = decimal.Decimal(10)
@@ -16,47 +18,76 @@ Decimal: Final = decimal.Decimal
 
 
 def ceil32(x: int) -> int:
-    return x if x % 32 == 0 else x + 32 - (x % 32)
+    remainder = x % 32
+    return x if remainder == 0 else x + 32 - remainder
+
+
+_unsigned_integer_bounds_cache: Final[Dict[int, Tuple[int, int]]] = {}
 
 
 def compute_unsigned_integer_bounds(num_bits: int) -> Tuple[int, int]:
-    return (
-        0,
-        2**num_bits - 1,
-    )
+    bounds = _unsigned_integer_bounds_cache.get(num_bits)
+    if bounds is None:
+        bounds = 0, 2**num_bits - 1
+        _unsigned_integer_bounds_cache[num_bits] = bounds
+    return bounds
+
+
+_signed_integer_bounds_cache: Final[Dict[int, Tuple[int, int]]] = {}
 
 
 def compute_signed_integer_bounds(num_bits: int) -> Tuple[int, int]:
-    return (
-        -1 * 2 ** (num_bits - 1),
-        2 ** (num_bits - 1) - 1,
-    )
+    bounds = _signed_integer_bounds_cache.get(num_bits)
+    if bounds is None:
+        overflow_at = 2 ** (num_bits - 1)
+        min_value = -overflow_at
+        max_value = overflow_at - 1
+        bounds = min_value, max_value
+        _signed_integer_bounds_cache[num_bits] = bounds
+    return bounds
+
+
+_unsigned_fixed_bounds_cache: Final[Dict[Tuple[int, int], decimal.Decimal]] = {}
 
 
 def compute_unsigned_fixed_bounds(
     num_bits: int,
     frac_places: int,
 ) -> Tuple[decimal.Decimal, decimal.Decimal]:
-    int_upper = compute_unsigned_integer_bounds(num_bits)[1]
+    upper = _unsigned_fixed_bounds_cache.get((num_bits, frac_places))
+    if upper is None:
+        int_upper = 2**num_bits - 1
+
+        with decimal_localcontext(abi_decimal_context):
+            upper = Decimal(int_upper) * TEN**-frac_places
 
-    with decimal.localcontext(abi_decimal_context):
-        upper = Decimal(int_upper) * TEN**-frac_places
+        _unsigned_fixed_bounds_cache[(num_bits, frac_places)] = upper
 
     return ZERO, upper
 
 
+_signed_fixed_bounds_cache: Final[
+    Dict[Tuple[int, int], Tuple[decimal.Decimal, decimal.Decimal]]
+] = {}
+
+
 def compute_signed_fixed_bounds(
     num_bits: int,
     frac_places: int,
 ) -> Tuple[decimal.Decimal, decimal.Decimal]:
-    int_lower, int_upper = compute_signed_integer_bounds(num_bits)
+    bounds = _signed_fixed_bounds_cache.get((num_bits, frac_places))
+    if bounds is None:
+        int_lower, int_upper = compute_signed_integer_bounds(num_bits)
+
+        with decimal_localcontext(abi_decimal_context):
+            exp = TEN**-frac_places
+            lower = Decimal(int_lower) * exp
+            upper = Decimal(int_upper) * exp
 
-    with decimal.localcontext(abi_decimal_context):
-        exp = TEN**-frac_places
-        lower = Decimal(int_lower) * exp
-        upper = Decimal(int_upper) * exp
+        bounds = lower, upper
+        _signed_fixed_bounds_cache[(num_bits, frac_places)] = bounds
 
-    return lower, upper
+    return bounds
 
 
 def scale_places(places: int) -> Callable[[decimal.Decimal], decimal.Decimal]:
@@ -70,11 +101,11 @@ def scale_places(places: int) -> Callable[[decimal.Decimal], decimal.Decimal]:
             f"of type {type(places)}.",
         )
 
-    with decimal.localcontext(abi_decimal_context):
+    with decimal_localcontext(abi_decimal_context):
         scaling_factor = TEN**-places
 
     def f(x: decimal.Decimal) -> decimal.Decimal:
-        with decimal.localcontext(abi_decimal_context):
+        with decimal_localcontext(abi_decimal_context):
             return x * scaling_factor
 
     places_repr = f"Eneg{places}" if places > 0 else f"Epos{-places}"