Merge pull request #1548 from njgheorghita/type-hints-complete

Type hints complete

Author: njgheorghita

docs/ethpm.rst

@@ -200,8 +200,8 @@ A valid content-addressed Github URI *must* conform to the following scheme, as
 
    >>> from ethpm.uri import create_content_addressed_github_uri
 
-   >>> owned_github_api_uri = "https://api.github.com/repos/ethpm/py-ethpm/contents/ethpm/assets/owned/1.0.1.json"
-   >>> content_addressed_uri = "https://api.github.com/repos/ethpm/py-ethpm/git/blobs/a7232a93f1e9e75d606f6c1da18aa16037e03480"
+   >>> owned_github_api_uri = "https://api.github.com/repos/ethereum/web3.py/contents/ethpm/assets/owned/1.0.1.json"
+   >>> content_addressed_uri = "https://api.github.com/repos/ethereum/web3.py/git/blobs/a7232a93f1e9e75d606f6c1da18aa16037e03480"
 
    >>> actual_blob_uri = create_content_addressed_github_uri(owned_github_api_uri)
    >>> assert actual_blob_uri == content_addressed_uri

ens/main.py

@@ -10,7 +10,6 @@
 from eth_typing import (
     Address,
     ChecksumAddress,
-    Hash32,
     HexAddress,
     HexStr,
 )
@@ -19,6 +18,9 @@
     is_checksum_address,
     to_checksum_address,
 )
+from hexbytes import (
+    HexBytes,
+)
 
 from ens import abis
 from ens.constants import (
@@ -57,9 +59,7 @@
     )
 
 
-ENS_MAINNET_ADDR = ChecksumAddress(
-    HexAddress(HexStr('0x314159265dD8dbb310642f98f50C066173C1259b'))
-)
+ENS_MAINNET_ADDR = ChecksumAddress(HexAddress(HexStr('0x314159265dD8dbb310642f98f50C066173C1259b')))
 
 
 class ENS:
@@ -130,7 +130,7 @@ def setup_address(
         name: str,
         address: Union[Address, ChecksumAddress, HexAddress]=cast(ChecksumAddress, default),
         transact: "TxParams"={}
-    ) -> Hash32:
+    ) -> HexBytes:
         """
         Set up the name to point to the supplied address.
         The sender of the transaction must own the name, or
@@ -169,7 +169,7 @@ def setup_address(
     @dict_copy
     def setup_name(
         self, name: str, address: ChecksumAddress=None, transact: "TxParams"={}
-    ) -> Hash32:
+    ) -> HexBytes:
         """
         Set up the address for reverse lookup, aka "caller ID".
         After successful setup, the method :meth:`~ens.main.ENS.name` will return
@@ -354,7 +354,7 @@ def _set_resolver(
     @dict_copy
     def _setup_reverse(
         self, name: str, address: ChecksumAddress, transact: "TxParams"={}
-    ) -> Hash32:
+    ) -> HexBytes:
         if name:
             name = normalize_name(name)
         else:

ethpm/_utils/chains.py

@@ -17,14 +17,17 @@
     is_integer,
     remove_0x_prefix,
 )
+from hexbytes import (
+    HexBytes,
+)
 
 from ethpm.constants import (
     SUPPORTED_CHAIN_IDS,
 )
 from web3 import Web3
 
 
-def get_genesis_block_hash(web3: Web3) -> str:
+def get_genesis_block_hash(web3: Web3) -> HexBytes:
     return web3.eth.getBlock(BlockNumber(0))["hash"]
 
 

ethpm/package.py

@@ -386,7 +386,7 @@ def _get_all_contract_instances(
                     f"{self.contract_types}."
                 )
             contract_instance = self.get_contract_instance(
-                deployment_data['contract_type'],
+                ContractName(deployment_data['contract_type']),
                 deployment_data['address'],
             )
             yield deployment_name, contract_instance

ethpm/uri.py

@@ -36,6 +36,9 @@
     CannotHandleURI,
 )
 from web3 import Web3
+from web3.types import (
+    BlockNumber,
+)
 
 
 def resolve_uri_contents(uri: URI, fingerprint: bool = None) -> bytes:
@@ -101,13 +104,13 @@ def create_latest_block_uri(w3: Web3, from_blocks_ago: int = 3) -> URI:
     """
     chain_id = to_hex(get_genesis_block_hash(w3))
     latest_block_tx_receipt = w3.eth.getBlock("latest")
-    target_block_number = latest_block_tx_receipt.number - from_blocks_ago
+    target_block_number = BlockNumber(latest_block_tx_receipt["number"] - from_blocks_ago)
     if target_block_number < 0:
         raise Exception(
-            f"Only {latest_block_tx_receipt.number} blocks avaible on provided w3, "
+            f"Only {latest_block_tx_receipt['number']} blocks avaible on provided w3, "
             f"cannot create latest block uri for {from_blocks_ago} blocks ago."
         )
-    recent_block = to_hex(w3.eth.getBlock(target_block_number).hash)
+    recent_block = to_hex(w3.eth.getBlock(target_block_number)["hash"])
     return create_block_uri(chain_id, recent_block)
 
 

tests/ethpm/test_uri.py

@@ -61,8 +61,8 @@ def test_is_valid_content_addressed_github_uri(uri, expected):
 
 
 def test_create_github_uri():
-    api_uri = "https://api.github.com/repos/ethpm/py-ethpm/contents/ethpm/assets/owned/1.0.1.json"
-    expected_blob_uri = "https://api.github.com/repos/ethpm/py-ethpm/git/blobs/a7232a93f1e9e75d606f6c1da18aa16037e03480"  # noqa: E501
+    api_uri = "https://api.github.com/repos/ethereum/web3.py/contents/ethpm/assets/owned/1.0.1.json"
+    expected_blob_uri = "https://api.github.com/repos/ethereum/web3.py/git/blobs/a7232a93f1e9e75d606f6c1da18aa16037e03480"  # noqa: E501
     actual_blob_uri = create_content_addressed_github_uri(api_uri)
     assert actual_blob_uri == expected_blob_uri
 

tox.ini

@@ -63,4 +63,4 @@ extras=linter
 commands=
   flake8 {toxinidir}/web3 {toxinidir}/ens {toxinidir}/ethpm {toxinidir}/tests
   isort --recursive --check-only --diff {toxinidir}/web3/ {toxinidir}/ens/ {toxinidir}/ethpm/ {toxinidir}/tests/
-  mypy -p web3._utils -p web3.providers -p web3.main -p web3.contract -p web3.datastructures -p web3.eth -p web3.exceptions -p web3.geth -p web3.iban -p web3.logs -p web3.manager -p web3.module -p web3.net -p web3.parity -p web3.middleware -p web3.method -p web3.pm -p web3.auto -p web3.gas_strategies -p web3.testing -p web3.tools -p web3.version -p ethpm -p ens --config-file {toxinidir}/mypy.ini
+  mypy -p web3 -p ethpm -p ens --config-file {toxinidir}/mypy.ini

web3/_utils/abi.py

@@ -86,9 +86,7 @@
 
 
 def filter_by_type(_type: str, contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
-    # fix for this just landed, not yet released : https://github.com/python/mypy/pull/7917
-    # after it's released, update Union[ABIFunction, ABIEvent] -> ABIElement
-    return [abi for abi in contract_abi if abi['type'] == _type]  # type: ignore
+    return [abi for abi in contract_abi if abi['type'] == _type]
 
 
 def filter_by_name(name: str, contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
@@ -97,25 +95,24 @@ def filter_by_name(name: str, contract_abi: ABI) -> List[Union[ABIFunction, ABIE
         for abi
         in contract_abi
         if (
-            # type ignored b/c see line 91
-            abi['type'] not in ('fallback', 'constructor') and  # type: ignore
-            abi['name'] == name  # type: ignore
+            abi['type'] not in ('fallback', 'constructor') and
+            abi['name'] == name
         )
     ]
 
 
-def get_abi_input_types(abi: Union[ABIFunction, ABIEvent]) -> List[str]:
+def get_abi_input_types(abi: ABIFunction) -> List[str]:
     if 'inputs' not in abi and abi['type'] == 'fallback':
         return []
     else:
-        return [collapse_if_tuple(arg) for arg in abi['inputs']]
+        return [collapse_if_tuple(cast(Dict[str, Any], arg)) for arg in abi['inputs']]
 
 
-def get_abi_output_types(abi: Union[ABIFunction, ABIEvent]) -> List[str]:
+def get_abi_output_types(abi: ABIFunction) -> List[str]:
     if abi['type'] == 'fallback':
         return []
     else:
-        return [collapse_if_tuple(arg) for arg in abi['outputs']]
+        return [collapse_if_tuple(cast(Dict[str, Any], arg)) for arg in abi['outputs']]
 
 
 def get_abi_input_names(abi: Union[ABIFunction, ABIEvent]) -> List[str]:
@@ -128,7 +125,7 @@ def get_abi_input_names(abi: Union[ABIFunction, ABIEvent]) -> List[str]:
 def get_fallback_func_abi(contract_abi: ABI) -> ABIFunction:
     fallback_abis = filter_by_type('fallback', contract_abi)
     if fallback_abis:
-        return fallback_abis[0]
+        return cast(ABIFunction, fallback_abis[0])
     else:
         raise FallbackNotFound("No fallback function was found in the contract ABI.")
 
@@ -152,8 +149,7 @@ def filter_by_argument_count(
         abi
         for abi
         in contract_abi
-        # type ignored b/c see line 91
-        if len(abi['inputs']) == num_arguments  # type: ignore
+        if len(abi['inputs']) == num_arguments
     ]
 
 
@@ -373,10 +369,12 @@ def filter_by_encodability(
     abi_codec: codec.ABIEncoder, args: Sequence[Any], kwargs: Dict[str, Any], contract_abi: ABI
 ) -> List[ABIFunction]:
     return [
-        function_abi
+        cast(ABIFunction, function_abi)
         for function_abi
         in contract_abi
-        if check_if_arguments_can_be_encoded(function_abi, abi_codec, args, kwargs)
+        if check_if_arguments_can_be_encoded(
+            cast(ABIFunction, function_abi), abi_codec, args, kwargs
+        )
     ]
 
 
@@ -516,7 +514,7 @@ def _align_abi_input(arg_abi: ABIFunctionParams, arg: Any) -> Tuple[Any, ...]:
         new_abi = copy.copy(arg_abi)
         new_abi['type'] = tuple_prefix
 
-        sub_abis = itertools.repeat(new_abi)
+        sub_abis = itertools.repeat(new_abi)  # type: ignore
 
     if isinstance(arg, abc.Mapping):
         # Arg is mapping.  Align values according to abi order.
@@ -555,7 +553,9 @@ def get_aligned_abi_inputs(
         args = tuple(args[abi['name']] for abi in input_abis)
 
     return (
-        tuple(collapse_if_tuple(abi) for abi in input_abis),
+        # typed dict cannot be used w/ a normal Dict
+        # https://github.com/python/mypy/issues/4976
+        tuple(collapse_if_tuple(abi) for abi in input_abis),  # type: ignore
         # too many arguments for Sequence
         type(args)(  # type: ignore
             _align_abi_input(abi, arg)
@@ -566,11 +566,10 @@ def get_aligned_abi_inputs(
 
 def get_constructor_abi(contract_abi: ABI) -> ABIFunction:
     candidates = [
-        # type ignored b/c see line 91
-        abi for abi in contract_abi if abi['type'] == 'constructor'  # type: ignore
+        abi for abi in contract_abi if abi['type'] == 'constructor'
     ]
     if len(candidates) == 1:
-        return candidates[0]
+        return cast(ABIFunction, candidates[0])
     elif len(candidates) == 0:
         return None
     elif len(candidates) > 1:
@@ -725,7 +724,7 @@ def is_probably_enum(abi_type: TypeStr) -> bool:
 @to_tuple
 def normalize_event_input_types(
     abi_args: Collection[Union[ABIFunction, ABIEvent]]
-) -> Iterable[Union[TypeStr, Dict[TypeStr, Any]]]:
+) -> Iterable[Union[ABIFunction, ABIEvent, Dict[TypeStr, Any]]]:
     for arg in abi_args:
         if is_recognized_type(arg['type']):
             yield arg
@@ -739,8 +738,7 @@ def abi_to_signature(abi: Union[ABIFunction, ABIEvent]) -> str:
     function_signature = "{fn_name}({fn_input_types})".format(
         fn_name=abi['name'],
         fn_input_types=','.join([
-            # type ignored b/c see line 91
-            arg['type'] for arg in normalize_event_input_types(abi.get('inputs', []))  # type: ignore # noqa: E501
+            arg['type'] for arg in normalize_event_input_types(abi.get('inputs', []))
         ]),
     )
     return function_signature

web3/_utils/compat/__init__.py

@@ -1,6 +1,7 @@
+import sys
 # remove once web3 supports python>=3.8
 # TypedDict was added to typing in 3.8
-try:
-    from typing import Literal, Protocol, TypedDict  # type: ignore
-except ImportError:
-    from typing_extensions import Literal, Protocol, TypedDict  # type: ignore # noqa: F401
+if sys.version_info >= (3, 8):
+    from typing import Literal, Protocol, TypedDict
+else:
+    from typing_extensions import Literal, Protocol, TypedDict  # noqa: F401

web3/_utils/contracts.py

@@ -6,6 +6,7 @@
     Tuple,
     Type,
     Union,
+    cast,
 )
 
 from eth_abi.codec import (
@@ -199,7 +200,7 @@ def prepare_transaction(
     transaction: TxParams=None,
     fn_args: Sequence[Any]=None,
     fn_kwargs: Any=None,
-) -> HexStr:
+) -> TxParams:
     """
     :parameter `is_function_abi` is used to distinguish  function abi from contract abi
     Returns a dictionary of the transaction that could be used to call this
@@ -214,7 +215,7 @@ def prepare_transaction(
     if transaction is None:
         prepared_transaction: TxParams = {}
     else:
-        prepared_transaction = dict(**transaction)
+        prepared_transaction = cast(TxParams, dict(**transaction))
 
     if 'data' in prepared_transaction:
         raise ValueError("Transaction parameter may not contain a 'data' key")
@@ -280,7 +281,9 @@ def get_function_info(
     if fn_abi is None:
         fn_abi = find_matching_fn_abi(contract_abi, abi_codec, fn_name, args, kwargs)
 
-    fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))
+    # typed dict cannot be used w/ a normal Dict
+    # https://github.com/python/mypy/issues/4976
+    fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))  # type: ignore
 
     fn_arguments = merge_args_and_kwargs(fn_abi, args, kwargs)