Disallow unused arguments (closes #962)

Author: SamWilsn

setup.cfg

@@ -125,7 +125,7 @@ python_requires = >=3.10
 install_requires =
     pycryptodome>=3,<4
     coincurve>=20,<21
-    typing_extensions>=4.2
+    typing_extensions>=4.4
     py-ecc>=8.0.0b2,<9
     ethereum-types>=0.2.1,<0.3
     ethereum-rlp>=0.1.1,<0.2
@@ -181,6 +181,7 @@ lint =
     flake8-bugbear==23.12.2
     flake8-docstrings==1.7.0
     flake8-spellcheck==0.28.0
+    flake8-unused-arguments==0.0.13
 
 tools =
     platformdirs>=4.2,<5
@@ -197,6 +198,7 @@ optimized =
 dictionaries=en_US,python,technical
 docstring-convention = all
 extend-ignore =
+    U101
     E203
     D107
     D200
@@ -221,4 +223,9 @@ extend-exclude =
 per-file-ignores =
     tests/*:D100,D101,D103,D104,E501,SC100,SC200
 
+unused-arguments-ignore-abstract-functions = true
+unused-arguments-ignore-override-functions = true
+unused-arguments-ignore-overload-functions = true
+unused-arguments-ignore-dunder = true
+
 # vim: set ft=dosini:

src/ethereum/cancun/vm/instructions/system.py

@@ -65,7 +65,6 @@ def generic_create(
     contract_address: Address,
     memory_start_position: U256,
     memory_size: U256,
-    init_code_gas: Uint,
 ) -> None:
     """
     Core logic used by the `CREATE*` family of opcodes.
@@ -182,7 +181,6 @@ def create(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER
@@ -235,7 +233,6 @@ def create2(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER

src/ethereum/fork_criteria.py

@@ -29,6 +29,7 @@
 from typing import Final, Literal, SupportsInt, Tuple
 
 from ethereum_types.numeric import U256, Uint
+from typing_extensions import override
 
 
 @functools.total_ordering
@@ -130,6 +131,7 @@ def __init__(self, block_number: SupportsInt):
         self._internal = (ForkCriteria.BLOCK_NUMBER, int(block_number))
         self.block_number = Uint(int(block_number))
 
+    @override
     def check(self, block_number: Uint, timestamp: U256) -> bool:
         """
         Check whether the block number has been reached.
@@ -162,6 +164,7 @@ def __init__(self, timestamp: SupportsInt):
         self._internal = (ForkCriteria.TIMESTAMP, int(timestamp))
         self.timestamp = U256(timestamp)
 
+    @override
     def check(self, block_number: Uint, timestamp: U256) -> bool:
         """
         Check whether the timestamp has been reached.
@@ -188,6 +191,7 @@ class Unscheduled(ForkCriteria):
     def __init__(self) -> None:
         self._internal = (ForkCriteria.UNSCHEDULED, 0)
 
+    @override
     def check(self, block_number: Uint, timestamp: U256) -> Literal[False]:
         """
         Unscheduled forks never occur; always returns `False`.

src/ethereum/prague/vm/instructions/system.py

@@ -66,7 +66,6 @@ def generic_create(
     contract_address: Address,
     memory_start_position: U256,
     memory_size: U256,
-    init_code_gas: Uint,
 ) -> None:
     """
     Core logic used by the `CREATE*` family of opcodes.
@@ -184,7 +183,6 @@ def create(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER
@@ -237,7 +235,6 @@ def create2(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER

src/ethereum/shanghai/vm/instructions/system.py

@@ -64,7 +64,6 @@ def generic_create(
     contract_address: Address,
     memory_start_position: U256,
     memory_size: U256,
-    init_code_gas: Uint,
 ) -> None:
     """
     Core logic used by the `CREATE*` family of opcodes.
@@ -181,7 +180,6 @@ def create(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER
@@ -234,7 +232,6 @@ def create2(evm: Evm) -> None:
         contract_address,
         memory_start_position,
         memory_size,
-        init_code_gas,
     )
 
     # PROGRAM COUNTER

src/ethereum/trace.py

@@ -170,11 +170,11 @@ class GasAndRefund:
 
 
 def discard_evm_trace(
-    evm: object,
-    event: TraceEvent,
-    trace_memory: bool = False,
-    trace_stack: bool = True,
-    trace_return_data: bool = False,
+    evm: object,  # noqa: U100
+    event: TraceEvent,  # noqa: U100
+    trace_memory: bool = False,  # noqa: U100
+    trace_stack: bool = True,  # noqa: U100
+    trace_return_data: bool = False,  # noqa: U100
 ) -> None:
     """
     An [`EvmTracer`] that discards all events.
@@ -200,9 +200,9 @@ def __call__(
         evm: object,
         event: TraceEvent,
         /,
-        trace_memory: bool = False,
-        trace_stack: bool = True,
-        trace_return_data: bool = False,
+        trace_memory: bool = False,  # noqa: U100
+        trace_stack: bool = True,  # noqa: U100
+        trace_return_data: bool = False,  # noqa: U100
     ) -> None:
         """
         Call `self` as a function, recording a trace event.

src/ethereum_spec_tools/docc.py

@@ -53,7 +53,7 @@
 from fladrif.treediff import Adapter, Operation, TreeMatcher
 from mistletoe import block_token as blocks  # type: ignore
 from mistletoe import span_token as spans
-from typing_extensions import assert_never
+from typing_extensions import assert_never, override
 
 from .forks import Hardfork
 
@@ -775,6 +775,7 @@ def enter(self, node: Node) -> Visit:
         parent.replace_child(flex, new_node)
         return Visit.TraverseChildren
 
+    @override
     def exit(self, node: Node) -> None:
         self._stack.pop()
 
@@ -908,11 +909,13 @@ def insert(self, afters: Sequence[Node]) -> None:
                     )
                 )
 
+    @override
     def equal(self, before: Sequence[Node], after: Sequence[Node]) -> None:
         parent = self.stack[-1]
         for node in after:
             parent.add(node)
 
+    @override
     def descend(self, before: Node, after: Node) -> None:
         parent = self.stack[-1]
         node = _DoccApply.FlexNode(after)
@@ -1000,12 +1003,13 @@ def enter(self, node: Node) -> Visit:
 
         return Visit.SkipChildren
 
+    @override
     def exit(self, node: Node) -> None:
         self._stack.pop()
 
 
 def render_diff(
-    context: object,
+    context: object,  # noqa: U100
     parent: object,
     diff: object,
 ) -> html.RenderResult:

src/ethereum_spec_tools/evm_tools/daemon.py

@@ -14,6 +14,8 @@
 from typing import Any, Tuple, Union
 from urllib.parse import parse_qs, urlparse
 
+from typing_extensions import override
+
 
 def daemon_arguments(subparsers: argparse._SubParsersAction) -> None:
     """
@@ -30,6 +32,7 @@ def daemon_arguments(subparsers: argparse._SubParsersAction) -> None:
 
 
 class _EvmToolHandler(BaseHTTPRequestHandler):
+    @override
     def log_request(
         self, code: int | str = "-", size: int | str = "-"
     ) -> None:

src/ethereum_spec_tools/lint/lints/glacier_forks_hygiene.py

@@ -7,6 +7,8 @@
 import sys
 from typing import Dict, List, Sequence
 
+from typing_extensions import override
+
 from ethereum_spec_tools.forks import Hardfork
 from ethereum_spec_tools.lint import (
     Diagnostic,
@@ -193,12 +195,14 @@ def visit_Module(self, module: ast.Module) -> None:
         for item in module.__dict__["body"]:
             self.visit(item)
 
+    @override
     def visit_Import(self, import_: ast.Import) -> None:
         """
         Visit an Import
         """
         pass
 
+    @override
     def visit_ImportFrom(self, import_from: ast.ImportFrom) -> None:
         """
         Visit an Import From

tests/conftest.py

@@ -114,7 +114,7 @@ def git_clone_fixtures(url: str, commit_hash: str, location: str) -> None:
                 submodule.update(init=True, recursive=True)
 
 
-def pytest_sessionstart(session: Session) -> None:
+def pytest_sessionstart(session: Session) -> None:  # noqa: U100
     for _, props in TEST_FIXTURES.items():
         fixture_path = props["fixture_path"]