update to run mypy local and update types as needed

Author: pacrob

.pre-commit-config.yaml

@@ -43,11 +43,14 @@ repos:
     -   id: mdformat
         additional_dependencies:
         -   mdformat-gfm
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+-   repo: local
     hooks:
-    -   id: mypy
-        files: eth/
+    -   id: mypy-local
+        name: run mypy with all dev dependencies present
+        entry: python -m mypy -p eth
+        language: system
+        always_run: true
+        pass_filenames: false
 -   repo: https://github.com/PrincetonUniversity/blocklint
     rev: v0.2.5
     hooks:

.readthedocs.yaml

@@ -15,6 +15,7 @@ python:
       path: .
       extra_requirements:
         - docs
+        - test
 
 # Build all formats for RTD Downloads - htmlzip, pdf, epub
 formats: all

eth/consensus/clique/_utils.py

@@ -1,5 +1,6 @@
 from typing import (
     Iterable,
+    cast,
 )
 
 from eth_keys import (
@@ -91,9 +92,12 @@ def get_block_signer(header: BlockHeaderAPI) -> Address:
 
     signature = keys.Signature(signature_bytes=signature_bytes)
 
-    return signature.recover_public_key_from_msg_hash(
-        signature_hash
-    ).to_canonical_address()
+    return cast(
+        Address,
+        signature.recover_public_key_from_msg_hash(
+            signature_hash
+        ).to_canonical_address(),
+    )
 
 
 def is_in_turn(signer: Address, snapshot: Snapshot, header: BlockHeaderAPI) -> bool:

eth/consensus/clique/snapshot_manager.py

@@ -48,7 +48,7 @@
 
 
 def make_snapshot_lookup_key(block_hash: Hash32) -> bytes:
-    return f"block-hash-to-snapshot:{block_hash}".encode()
+    return f"block-hash-to-snapshot:{block_hash!r}".encode()
 
 
 class SnapshotManager:
@@ -123,11 +123,11 @@ def apply(self, current_snapshot: Snapshot, header: BlockHeaderAPI) -> Snapshot:
                 if tally.votes > len(snapshot.signers) / 2:
                     if tally.action is VoteAction.NOMINATE:
                         snapshot.signers.append(header.coinbase)
-                        self.logger.debug(f"New signer added: {header.coinbase}")
+                        self.logger.debug(f"New signer added: {header.coinbase!r}")
                     else:
                         if header.coinbase in snapshot.signers:
                             snapshot.signers.remove(header.coinbase)
-                            self.logger.debug(f"Signer removed: {header.coinbase}")
+                            self.logger.debug(f"Signer removed: {header.coinbase!r}")
 
                     for vote in snapshot.votes.copy():
                         # Discard any pending votes *from* the added or removed member

eth/db/chain.py

@@ -290,8 +290,8 @@ def _persist_block(
             uncles_hash = EMPTY_UNCLE_HASH
         if uncles_hash != block.header.uncles_hash:
             raise ValidationError(
-                f"Block's uncles_hash ({block.header.uncles_hash}) does not match "
-                f"actual uncles' hash ({uncles_hash})"
+                f"Block's uncles_hash ({block.header.uncles_hash!r}) does not match "
+                f"actual uncles' hash ({uncles_hash!r})"
             )
         new_canonical_hashes = tuple(header.hash for header in new_canonical_headers)
         old_canonical_hashes = tuple(header.hash for header in old_canonical_headers)

eth/db/schema.py

@@ -20,7 +20,7 @@ def make_block_number_to_hash_lookup_key(block_number: BlockNumber) -> bytes:
 
     @staticmethod
     def make_block_hash_to_score_lookup_key(block_hash: Hash32) -> bytes:
-        return f"block-hash-to-score:{block_hash}".encode()
+        return f"block-hash-to-score:{block_hash!r}".encode()
 
     @staticmethod
     def make_header_chain_gaps_lookup_key() -> bytes:
@@ -39,8 +39,8 @@ def make_checkpoint_headers_key() -> bytes:
 
     @staticmethod
     def make_transaction_hash_to_block_lookup_key(transaction_hash: Hash32) -> bytes:
-        return f"transaction-hash-to-block:{transaction_hash}".encode()
+        return f"transaction-hash-to-block:{transaction_hash!r}".encode()
 
     @staticmethod
     def make_withdrawal_hash_to_block_lookup_key(withdrawal_hash: Hash32) -> bytes:
-        return f"withdrawal-hash-to-block:{withdrawal_hash}".encode()
+        return f"withdrawal-hash-to-block:{withdrawal_hash!r}".encode()

eth/precompiles/point_evaluation.py

@@ -1,5 +1,8 @@
 import hashlib
 import os
+from typing import (
+    cast,
+)
 
 from ckzg import (
     load_trusted_setup,
@@ -29,7 +32,9 @@
 
 
 def kzg_to_versioned_hash(commitment: bytes) -> Hash32:
-    return VERSIONED_HASH_VERSION_KZG + hashlib.sha256(commitment).digest()[1:]
+    return cast(
+        Hash32, VERSIONED_HASH_VERSION_KZG + hashlib.sha256(commitment).digest()[1:]
+    )
 
 
 def point_evaluation_precompile(computation: ComputationAPI) -> ComputationAPI:

eth/rlp/blocks.py

@@ -1,4 +1,5 @@
 from typing import (
+    Sequence,
     Type,
 )
 
@@ -12,13 +13,39 @@
 )
 from eth.abc import (
     BlockAPI,
+    BlockHeaderAPI,
+    SignedTransactionAPI,
     TransactionBuilderAPI,
+    WithdrawalAPI,
 )
 
 
 class BaseBlock(Configurable, rlp.Serializable, BlockAPI):
     transaction_builder: Type[TransactionBuilderAPI] = None
 
+    def __init__(
+        self,
+        header: BlockHeaderAPI,
+        transactions: Sequence[SignedTransactionAPI] = None,
+        uncles: Sequence[BlockHeaderAPI] = None,
+        withdrawals: Sequence[WithdrawalAPI] = None,
+    ) -> None:
+        if withdrawals is not None:
+            rlp.Serializable.__init__(
+                self,
+                header=header,
+                transactions=transactions,
+                uncles=uncles,
+                withdrawals=withdrawals,
+            )
+        else:
+            rlp.Serializable.__init__(
+                self,
+                header=header,
+                transactions=transactions,
+                uncles=uncles,
+            )
+
     @classmethod
     def get_transaction_builder(cls) -> Type[TransactionBuilderAPI]:
         if cls.transaction_builder is None:

eth/tools/fixtures/loading.py

@@ -1,12 +1,18 @@
+from pytest import (
+    Mark,
+    MarkDecorator,
+)
 import functools
 import json
 import os
 from typing import (
     Any,
     Callable,
+    Collection,
     Dict,
     Iterable,
     Tuple,
+    Union,
 )
 
 from eth_utils import (
@@ -81,7 +87,9 @@ def load_fixture(
 def filter_fixtures(
     all_fixtures: Iterable[Any],
     fixtures_base_dir: str,
-    mark_fn: Callable[[str, str], bool] = None,
+    mark_fn: Callable[
+        [str, str], Union[MarkDecorator, Collection[Union[MarkDecorator, Mark]], None]
+    ] = None,
     ignore_fn: Callable[..., bool] = None,
 ) -> Any:
     """

eth/tools/mining.py

@@ -15,7 +15,9 @@ class POWMiningMixin(VirtualMachineAPI):
     """
 
     def finalize_block(self, block: BlockAPI) -> BlockAndMetaWitness:
-        block_result = super().finalize_block(block)
+        # type ignored because as a mixin, we expect to only use this with another
+        # class that properly implements finalize_block
+        block_result = super().finalize_block(block)  # type: ignore[safe-super]
         block = block_result.block
 
         nonce, mix_hash = pow.mine_pow_nonce(

eth/vm/forks/berlin/transactions.py

@@ -282,7 +282,7 @@ def max_fee_per_blob_gas(self) -> int:
         )
 
     @property
-    def blob_versioned_hashes(self) -> Hash32:
+    def blob_versioned_hashes(self) -> Sequence[Hash32]:
         raise NotImplementedError(
             "blob_versioned_hashes is not implemented until Cancun."
         )
@@ -376,7 +376,7 @@ def max_fee_per_blob_gas(self) -> int:
         )
 
     @property
-    def blob_versioned_hashes(self) -> Hash32:
+    def blob_versioned_hashes(self) -> Sequence[Hash32]:
         raise NotImplementedError(
             "blob_versioned_hashes is not implemented until Cancun."
         )

eth/vm/forks/cancun/constants.py

@@ -1,5 +1,9 @@
+from eth_typing import (
+    Address,
+)
+
 HISTORY_BUFFER_LENGTH = 8191
-BEACON_ROOTS_ADDRESS = (
+BEACON_ROOTS_ADDRESS = Address(
     b'\x00\x0f=\xf6\xd72\x80~\xf11\x9f\xb7\xb8\xbb\x85"\xd0\xbe\xac\x02'
 )
 BEACON_ROOTS_CONTRACT_CODE = b"3s\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\x14`MW` 6\x14`$W__\xfd[_5\x80\x15`IWb\x00\x1f\xff\x81\x06\x90\x81T\x14`<W__\xfd[b\x00\x1f\xff\x01T_R` _\xf3[__\xfd[b\x00\x1f\xffB\x06B\x81U_5\x90b\x00\x1f\xff\x01U\x00"  # noqa: E501

eth/vm/forks/london/transactions.py

@@ -212,7 +212,7 @@ def max_fee_per_blob_gas(self) -> int:
         )
 
     @property
-    def blob_versioned_hashes(self) -> Hash32:
+    def blob_versioned_hashes(self) -> Sequence[Hash32]:
         raise NotImplementedError(
             "blob_versioned_hashes is not implemented until Cancun."
         )

newsfragments/2197.breaking.rst

@@ -0,0 +1 @@
+Adds running ``mypy`` locally with all deps installed, then updating typing as needed. Moves ``eth/tools/factories`` into ``tests`` as it is only ever used there.

setup.py

@@ -13,6 +13,7 @@
         "build>=0.9.0",
         "bump_my_version>=0.19.0",
         "ipython",
+        "mypy==1.10.0",
         "pre-commit>=3.4.0",
         "tox>=4.0.0",
         "twine",

tox.ini

@@ -9,7 +9,7 @@ envlist=
     py{38,39,310,311,312,313}-wheel
     windows-wheel
     docs
-    py312-native-blockchain-{ \
+    py313-native-blockchain-{ \
         metropolis, transition, frontier, homestead, tangerine_whistle, \
         spurious_dragon, byzantium, constantinople, petersburg, istanbul, \
         berlin, london, paris, shanghai, cancun \
@@ -65,6 +65,7 @@ allowlist_externals=make,pre-commit
 
 [testenv:py{38,39,310,311,312,313}-lint]
 deps=pre-commit
+extras=dev
 commands=
     pre-commit install
     pre-commit run --all-files --show-diff-on-failure