perf: Enable flake8 type checks (ApeWorX#2352)

Author: antazoey

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
     rev: 7.1.1
     hooks:
     -   id: flake8
-        additional_dependencies: [flake8-breakpoint, flake8-print, flake8-pydantic]
+        additional_dependencies: [flake8-breakpoint, flake8-print, flake8-pydantic, flake8-type-checking]
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.13.0

setup.cfg

@@ -7,10 +7,13 @@ exclude =
 	build
 	.eggs
 	tests/integration/cli/projects
-ignore = E704,W503,PYD002
+ignore = E704,W503,PYD002,TC003,TC006
 per-file-ignores =
     # Need signal handler before imports
     src/ape/__init__.py: E402
 	# Test data causes long lines
 	tests/functional/data/python/__init__.py: E501
 	tests/functional/utils/expected_traces.py: E501
+
+type-checking-pydantic-enabled = True
+type-checking-sqlalchemy-enabled = True

setup.py

@@ -34,6 +34,7 @@
         "flake8-breakpoint>=1.1.0,<2",  # Detect breakpoints left in code
         "flake8-print>=4.0.1,<5",  # Detect print statements left in code
         "flake8-pydantic",  # For detecting issues with Pydantic models
+        "flake8-type-checking",  # Detect imports to move in/out of type-checking blocks
         "isort>=5.13.2,<6",  # Import sorting linter
         "mdformat>=0.7.18",  # Auto-formatter for markdown
         "mdformat-gfm>=0.3.5",  # Needed for formatting GitHub-flavored markdown

src/ape/_cli.py

@@ -7,18 +7,20 @@
 from importlib import import_module
 from importlib.metadata import entry_points
 from pathlib import Path
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 from warnings import catch_warnings, simplefilter
 
 import click
 import rich
 import yaml
-from click import Context
 
 from ape.cli.options import ape_cli_context
 from ape.exceptions import Abort, ApeException, ConfigError, handle_ape_exception
 from ape.logging import logger
 
+if TYPE_CHECKING:
+    from click import Context
+
 _DIFFLIB_CUT_OFF = 0.6
 
 
@@ -53,7 +55,7 @@ def _validate_config():
 class ApeCLI(click.MultiCommand):
     _CLI_GROUP_NAME = "ape_cli_subcommands"
 
-    def parse_args(self, ctx: Context, args: list[str]) -> list[str]:
+    def parse_args(self, ctx: "Context", args: list[str]) -> list[str]:
         # Validate the config before any argument parsing,
         # as arguments may utilize config.
         if "--help" not in args and args != []:

src/ape/api/accounts.py

@@ -10,7 +10,6 @@
 from eip712.messages import SignableMessage as EIP712SignableMessage
 from eth_account import Account
 from eth_account.messages import encode_defunct
-from eth_pydantic_types import HexBytes
 from eth_utils import to_hex
 from ethpm_types import ContractType
 
@@ -31,6 +30,8 @@
 from ape.utils.misc import raises_not_implemented
 
 if TYPE_CHECKING:
+    from eth_pydantic_types import HexBytes
+
     from ape.contracts import ContractContainer, ContractInstance
 
 
@@ -65,7 +66,7 @@ def alias(self) -> Optional[str]:
         """
         return None
 
-    def sign_raw_msghash(self, msghash: HexBytes) -> Optional[MessageSignature]:
+    def sign_raw_msghash(self, msghash: "HexBytes") -> Optional[MessageSignature]:
         """
         Sign a raw message hash.
 

src/ape/api/address.py

@@ -7,13 +7,13 @@
 from ape.exceptions import ConversionError
 from ape.types.address import AddressType
 from ape.types.units import CurrencyValue
-from ape.types.vm import ContractCode
 from ape.utils.basemodel import BaseInterface
 from ape.utils.misc import log_instead_of_fail
 
 if TYPE_CHECKING:
     from ape.api.transactions import ReceiptAPI, TransactionAPI
     from ape.managers.chain import AccountHistory
+    from ape.types.vm import ContractCode
 
 
 class BaseAddress(BaseInterface):
@@ -146,7 +146,7 @@ def __setattr__(self, attr: str, value: Any) -> None:
             super().__setattr__(attr, value)
 
     @property
-    def code(self) -> ContractCode:
+    def code(self) -> "ContractCode":
         """
         The raw bytes of the smart-contract code at the address.
         """

src/ape/api/compiler.py

@@ -4,21 +4,21 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Optional
 
-from eth_pydantic_types import HexBytes
-from ethpm_types import ContractType
-from ethpm_types.source import Content, ContractSource
-from packaging.version import Version
-
-from ape.api.config import PluginConfig
-from ape.api.trace import TraceAPI
 from ape.exceptions import APINotImplementedError, ContractLogicError
-from ape.types.coverage import ContractSourceCoverage
-from ape.types.trace import SourceTraceback
 from ape.utils.basemodel import BaseInterfaceModel
 from ape.utils.misc import log_instead_of_fail, raises_not_implemented
 
 if TYPE_CHECKING:
+    from eth_pydantic_types import HexBytes
+    from ethpm_types import ContractType
+    from ethpm_types.source import Content, ContractSource
+    from packaging.version import Version
+
+    from ape.api.config import PluginConfig
+    from ape.api.trace import TraceAPI
     from ape.managers.project import ProjectManager
+    from ape.types.coverage import ContractSourceCoverage
+    from ape.types.trace import SourceTraceback
 
 
 class CompilerAPI(BaseInterfaceModel):
@@ -44,7 +44,7 @@ def name(self) -> str:
         The name of the compiler.
         """
 
-    def get_config(self, project: Optional["ProjectManager"] = None) -> PluginConfig:
+    def get_config(self, project: Optional["ProjectManager"] = None) -> "PluginConfig":
         """
         The combination of settings from ``ape-config.yaml`` and ``.compiler_settings``.
 
@@ -79,7 +79,7 @@ def get_compiler_settings(  # type: ignore[empty-body]
         contract_filepaths: Iterable[Path],
         project: Optional["ProjectManager"] = None,
         **overrides,
-    ) -> dict[Version, dict]:
+    ) -> dict["Version", dict]:
         """
         Get a mapping of the settings that would be used to compile each of the sources
         by the compiler version number.
@@ -101,7 +101,7 @@ def compile(
         contract_filepaths: Iterable[Path],
         project: Optional["ProjectManager"],
         settings: Optional[dict] = None,
-    ) -> Iterator[ContractType]:
+    ) -> Iterator["ContractType"]:
         """
         Compile the given source files. All compiler plugins must implement this function.
 
@@ -123,7 +123,7 @@ def compile_code(  # type: ignore[empty-body]
         project: Optional["ProjectManager"],
         settings: Optional[dict] = None,
         **kwargs,
-    ) -> ContractType:
+    ) -> "ContractType":
         """
         Compile a program.
 
@@ -162,7 +162,7 @@ def get_version_map(  # type: ignore[empty-body]
         self,
         contract_filepaths: Iterable[Path],
         project: Optional["ProjectManager"] = None,
-    ) -> dict[Version, set[Path]]:
+    ) -> dict["Version", set[Path]]:
         """
         Get a map of versions to source paths.
 
@@ -218,8 +218,8 @@ def enrich_error(self, err: ContractLogicError) -> ContractLogicError:
 
     @raises_not_implemented
     def trace_source(  # type: ignore[empty-body]
-        self, contract_source: ContractSource, trace: TraceAPI, calldata: HexBytes
-    ) -> SourceTraceback:
+        self, contract_source: "ContractSource", trace: "TraceAPI", calldata: "HexBytes"
+    ) -> "SourceTraceback":
         """
         Get a source-traceback for the given contract type.
         The source traceback object contains all the control paths taken in the transaction.
@@ -239,7 +239,7 @@ def trace_source(  # type: ignore[empty-body]
     @raises_not_implemented
     def flatten_contract(  # type: ignore[empty-body]
         self, path: Path, project: Optional["ProjectManager"] = None, **kwargs
-    ) -> Content:
+    ) -> "Content":
         """
         Get the content of a flattened contract via its source path.
         Plugin implementations handle import resolution, SPDX de-duplication,
@@ -259,7 +259,7 @@ def flatten_contract(  # type: ignore[empty-body]
 
     @raises_not_implemented
     def init_coverage_profile(
-        self, source_coverage: ContractSourceCoverage, contract_source: ContractSource
+        self, source_coverage: "ContractSourceCoverage", contract_source: "ContractSource"
     ):  # type: ignore[empty-body]
         """
         Initialize an empty report for the given source ID. Modifies the given source

src/ape/api/explorers.py

@@ -1,12 +1,14 @@
 from abc import abstractmethod
-from typing import Optional
-
-from ethpm_types import ContractType
+from typing import TYPE_CHECKING, Optional
 
 from ape.api.networks import NetworkAPI
-from ape.types.address import AddressType
 from ape.utils.basemodel import BaseInterfaceModel
 
+if TYPE_CHECKING:
+    from ethpm_types import ContractType
+
+    from ape.types.address import AddressType
+
 
 class ExplorerAPI(BaseInterfaceModel):
     """
@@ -18,7 +20,7 @@ class ExplorerAPI(BaseInterfaceModel):
     network: NetworkAPI
 
     @abstractmethod
-    def get_address_url(self, address: AddressType) -> str:
+    def get_address_url(self, address: "AddressType") -> str:
         """
         Get an address URL, such as for a transaction.
 
@@ -42,7 +44,7 @@ def get_transaction_url(self, transaction_hash: str) -> str:
         """
 
     @abstractmethod
-    def get_contract_type(self, address: AddressType) -> Optional[ContractType]:
+    def get_contract_type(self, address: "AddressType") -> Optional["ContractType"]:
         """
         Get the contract type for a given address if it has been published to this explorer.
 
@@ -54,7 +56,7 @@ def get_contract_type(self, address: AddressType) -> Optional[ContractType]:
         """
 
     @abstractmethod
-    def publish_contract(self, address: AddressType):
+    def publish_contract(self, address: "AddressType"):
         """
         Publish a contract to the explorer.