-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add type hints and clean up ABI code (#253)
* Add type hints and clean up ABI types * Change relative imports to absolute imports * Add type hints for ABI objects * Refactor composer with type hints * Address PR comments, change list type hints, and move type_from_string to ABIType
- Loading branch information
Showing
17 changed files
with
366 additions
and
312 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,139 @@ | ||
| from abc import ABC, abstractmethod | ||
| import re | ||
| from typing import Any, Union | ||
|
|
||
| from algosdk import error | ||
|
|
||
|
|
||
| # Globals | ||
| ABI_LENGTH_SIZE = 2 # We use 2 bytes to encode the length of a dynamic element | ||
| UFIXED_REGEX = r"^ufixed([1-9][\d]*)x([1-9][\d]*)$" | ||
| STATIC_ARRAY_REGEX = r"^([a-z\d\[\](),]+)\[([1-9][\d]*)]$" | ||
|
|
||
|
|
||
| class ABIType(ABC): | ||
| """ | ||
| Represents an ABI Type for encoding. | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| ) -> None: | ||
| def __init__(self) -> None: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def __str__(self): | ||
| def __str__(self) -> str: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def __eq__(self, other) -> bool: | ||
| def __eq__(self, other: object) -> bool: | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def is_dynamic(self): | ||
| def is_dynamic(self) -> bool: | ||
| """ | ||
| Return whether the ABI type is dynamic. | ||
| """ | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def byte_len(self): | ||
| def byte_len(self) -> int: | ||
| """ | ||
| Return the length in bytes of the ABI type. | ||
| """ | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def encode(self, value): | ||
| def encode(self, value: Any) -> bytes: | ||
| """ | ||
| Serialize the ABI value into a byte string using ABI encoding rules. | ||
| """ | ||
| pass | ||
|
|
||
| @abstractmethod | ||
| def decode(self, bytestring): | ||
| def decode(self, bytestring: bytes) -> Any: | ||
| """ | ||
| Deserialize the ABI type and value from a byte string using ABI encoding rules. | ||
| """ | ||
| pass | ||
|
|
||
| @staticmethod | ||
| def from_string(s: str) -> "ABIType": | ||
| """ | ||
| Convert a valid ABI string to a corresponding ABI type. | ||
| """ | ||
| # We define the imports here to avoid circular imports | ||
| from algosdk.abi.uint_type import UintType | ||
| from algosdk.abi.ufixed_type import UfixedType | ||
| from algosdk.abi.byte_type import ByteType | ||
| from algosdk.abi.bool_type import BoolType | ||
| from algosdk.abi.address_type import AddressType | ||
| from algosdk.abi.string_type import StringType | ||
| from algosdk.abi.array_dynamic_type import ArrayDynamicType | ||
| from algosdk.abi.array_static_type import ArrayStaticType | ||
| from algosdk.abi.tuple_type import TupleType | ||
|
|
||
| if s.endswith("[]"): | ||
| array_arg_type = ABIType.from_string(s[:-2]) | ||
| return ArrayDynamicType(array_arg_type) | ||
| elif s.endswith("]"): | ||
| matches = re.search(STATIC_ARRAY_REGEX, s) | ||
| try: | ||
| static_length = int(matches.group(2)) | ||
| array_type = ABIType.from_string(matches.group(1)) | ||
| return ArrayStaticType(array_type, static_length) | ||
| except Exception as e: | ||
| raise error.ABITypeError( | ||
| "malformed static array string: {}".format(s) | ||
| ) from e | ||
| if s.startswith("uint"): | ||
| try: | ||
| if not s[4:].isdecimal(): | ||
| raise error.ABITypeError( | ||
| "uint string does not contain a valid size: {}".format( | ||
| s | ||
| ) | ||
| ) | ||
| type_size = int(s[4:]) | ||
| return UintType(type_size) | ||
| except Exception as e: | ||
| raise error.ABITypeError( | ||
| "malformed uint string: {}".format(s) | ||
| ) from e | ||
| elif s == "byte": | ||
| return ByteType() | ||
| elif s.startswith("ufixed"): | ||
| matches = re.search(UFIXED_REGEX, s) | ||
| try: | ||
| bit_size = int(matches.group(1)) | ||
| precision = int(matches.group(2)) | ||
| return UfixedType(bit_size, precision) | ||
| except Exception as e: | ||
| raise error.ABITypeError( | ||
| "malformed ufixed string: {}".format(s) | ||
| ) from e | ||
| elif s == "bool": | ||
| return BoolType() | ||
| elif s == "address": | ||
| return AddressType() | ||
| elif s == "string": | ||
| return StringType() | ||
| elif len(s) >= 2 and s[0] == "(" and s[-1] == ")": | ||
| # Recursively parse parentheses from a tuple string | ||
| tuples = TupleType._parse_tuple(s[1:-1]) | ||
| tuple_list = [] | ||
| for tup in tuples: | ||
| if isinstance(tup, str): | ||
| tt = ABIType.from_string(tup) | ||
| tuple_list.append(tt) | ||
| elif isinstance(tup, list): | ||
| tts = [ABIType.from_string(t_) for t_ in tup] | ||
| tuple_list.append(tts) | ||
| else: | ||
| raise error.ABITypeError( | ||
| "cannot convert {} to an ABI type".format(tup) | ||
| ) | ||
|
|
||
| return TupleType(tuple_list) | ||
| else: | ||
| raise error.ABITypeError( | ||
| "cannot convert {} to an ABI type".format(s) | ||
| ) |
Oops, something went wrong.