chore(tooling): Update static checks

pyproject.toml

@@ -427,19 +427,6 @@ exclude = ["tests/fixtures/", "eest_tests/"]
 ignore_names = ["pytest_*"]
 
 [tool.ruff]
-extend-exclude = [
-    ".cache/",
-    ".git/",
-    ".pytest_cache/",
-    ".ruff_cache/",
-    ".tox/",
-    ".venv/",
-    ".vscode/",
-    "tests/fixtures/*",
-    "tests/json_infra/fixtures/*",
-    "eest_tests/*",
-    "vulture_whitelist.py",
-]
 line-length = 79
 
 [tool.ruff.lint]
@@ -451,6 +438,7 @@ select = [
     "I", # isort
     "A", # flake8-builtins
     "N", # pep8-naming
+    "D", # pydocstyle
     "ARG", # flake8-unused-arguments
 ]
 fixable = [
@@ -463,34 +451,16 @@ fixable = [
 ]
 ignore = [
 # Common to STEEL
-    "D205",     # Missing blank line after summary
+    "D107",     # Missing docstring in __init__
     "D203",     # 1 blank line required before class docstring
+    "D205",     # Missing blank line after summary
     "D212",     # Multi-line docstring summary should start at the first line
-    "D415",     # First line should end with a ".", "?", or "!"
-
-# Specific to EELS
-    "D107",     # Missing docstring in __init__
-    "D200",     # One-line docstring should fit on one line with quotes
-    "D205",     # 1 blank line required between summary and description
     "D400",     # First line should end with a period
     "D401",     # First line should be in imperative mood ("Do", not "Does")
-    "D410",     # Missing blank line after last section (Args, Returns, Raises)
-    "D411",     # Missing blank line before last section
-    "D412",     # No blank lines between sections
-    "D413",     # Missing blank line after last section (same as 410)
-    "D414",     # Section should end with a period
-    "D416",     # Section names should be in the correct order
-    "E203",     # Whitespace before ':'
+    "D415",     # First line should end with a ".", "?", or "!"
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = [
-    "D100",         # Missing docstring in public module
-    "D101",         # Missing docstring in public class
-    "D103",         # Missing docstring in public function
-    "D104",         # Missing docstring in public package
-    "E501",         # Line too long
-]
 "src/ethereum_spec_tools/evm_tools/loaders/fork_loader.py" = [
     "N802"          # Property names do not need to be lowercase
 ]
@@ -508,10 +478,6 @@ ignore = [
     "N815"          # The traces must use camel case in JSON property names
 ]
 
-[tool.ruff.lint.mccabe]
-# Set the maximum allowed cyclomatic complexity. C901 default is 10.
-max-complexity = 7
-
 [tool.codespell]
 builtin = "clear,code,usage"    # Built-in dictionaries to use
 skip = [                        # Don't check these files/folders

src/ethereum/__init__.py

@@ -16,6 +16,7 @@
 This package contains a reference implementation, written as simply as
 possible, to aid in defining the behavior of Ethereum clients.
 """
+
 import sys
 
 __version__ = "2.18.0rc2"

src/ethereum/crypto/__init__.py

@@ -1,3 +1 @@
-"""
-Cryptographic primitives used in Ethereum.
-"""
+"""Cryptographic primitives used in Ethereum."""

src/ethereum/crypto/blake2.py

@@ -2,6 +2,7 @@
 The Blake2 Implementation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 """
+
 import struct
 from dataclasses import dataclass
 from typing import Final, List, Tuple
@@ -21,6 +22,7 @@ def spit_le_to_uint(data: bytes, start: int, num_words: int) -> List[Uint]:
         Position to start the extraction
     num_words:
         The number of words to be extracted
+
     """
     words = []
     for i in range(num_words):
@@ -52,9 +54,7 @@ class Blake2:
 
     @property
     def max_word(self) -> Uint:
-        """
-        Largest value for a given Blake2 flavor.
-        """
+        """Largest value for a given Blake2 flavor."""
         return Uint(2) ** self.w
 
     @property
@@ -126,9 +126,7 @@ def w_R4(self) -> Uint:
 
     @property
     def sigma_len(self) -> int:
-        """
-        Length of the sigma parameter.
-        """
+        """Length of the sigma parameter."""
         return len(self.sigma)
 
     def get_blake2_parameters(self, data: bytes) -> Tuple:
@@ -140,6 +138,7 @@ def get_blake2_parameters(self, data: bytes) -> Tuple:
         ----------
         data :
             The bytes data that has been passed in the message.
+
         """
         rounds = Uint.from_be_bytes(data[:4])
         h = spit_le_to_uint(data, 4, 8)
@@ -164,6 +163,7 @@ def G(
             Indexes within v of the words to be mixed.
         x, y :
             The two input words for the mixing.
+
         """
         v[a] = (v[a] + v[b] + x) % self.max_word
         v[d] = ((v[d] ^ v[a]) >> self.R1) ^ (
@@ -212,6 +212,7 @@ def compress(
             Offset counters. 2 unsigned 64-bit little-endian words
         f:
             The final block indicator flag. An 8-bit word
+
         """
         # Initialize local work vector v[0..15]
         v = [Uint(0)] * 16

src/ethereum/crypto/elliptic_curve.py

@@ -45,6 +45,7 @@ def secp256k1_recover(r: U256, s: U256, v: U256, msg_hash: Hash32) -> Bytes:
     -------
     public_key : `ethereum.base_types.Bytes`
         Recovered public key.
+
     """
     is_square = pow(
         pow(r, U256(3), SECP256K1P) + SECP256K1B,
@@ -114,8 +115,8 @@ def secp256r1_verify(
 
     Raises
     ------
-
     Raises an `InvalidSignatureError` if the signature is not valid.
+
     """
     # Convert U256 to regular integers for DerSequence
     r_int = int(r)
@@ -152,6 +153,7 @@ def is_on_curve_secp256r1(x: U256, y: U256) -> bool:
     -------
     bool
         True if the point is on the curve, False otherwise
+
     """
     # Convert U256 to int for calculations
     x_int = int(x)

src/ethereum/crypto/hash.py

@@ -32,6 +32,7 @@ def keccak256(buffer: Bytes | bytearray) -> Hash32:
     -------
     hash : `ethereum.base_types.Hash32`
         Output of the hash function.
+
     """
     k = keccak.new(digest_bits=256)
     return Hash32(k.update(buffer).digest())
@@ -50,6 +51,7 @@ def keccak512(buffer: Bytes | bytearray) -> Hash64:
     -------
     hash : `ethereum.base_types.Hash32`
         Output of the hash function.
+
     """
     k = keccak.new(digest_bits=512)
     return Hash64(k.update(buffer).digest())

src/ethereum/crypto/kzg.py

@@ -2,6 +2,7 @@
 The KZG Implementation
 ^^^^^^^^^^^^^^^^^^^^^^
 """
+
 from hashlib import sha256
 from typing import Tuple
 
@@ -67,9 +68,7 @@ class VersionedHash(Bytes32):
 def kzg_commitment_to_versioned_hash(
     kzg_commitment: KZGCommitment,
 ) -> VersionedHash:
-    """
-    Convert a KZG commitment to a versioned hash.
-    """
+    """Convert a KZG commitment to a versioned hash."""
     return VersionedHash(
         VERSIONED_HASH_VERSION_KZG
         + Bytes32(sha256(kzg_commitment).digest())[1:]
@@ -88,9 +87,7 @@ def validate_kzg_g1(b: Bytes48) -> None:
 
 
 def bytes_to_kzg_commitment(b: Bytes48) -> KZGCommitment:
-    """
-    Convert untrusted bytes into a trusted and validated KZGCommitment.
-    """
+    """Convert untrusted bytes into a trusted and validated KZGCommitment."""
     validate_kzg_g1(b)
     return KZGCommitment(b)
 
@@ -107,17 +104,13 @@ def bytes_to_bls_field(b: Bytes32) -> BLSFieldElement:
 
 
 def bytes_to_kzg_proof(b: Bytes48) -> KZGProof:
-    """
-    Convert untrusted bytes into a trusted and validated KZGProof.
-    """
+    """Convert untrusted bytes into a trusted and validated KZGProof."""
     validate_kzg_g1(b)
     return KZGProof(b)
 
 
 def pairing_check(values: Tuple[Tuple[FQ, FQ2], Tuple[FQ, FQ2]]) -> bool:
-    """
-    Check if the pairings are valid.
-    """
+    """Check if the pairings are valid."""
     p_q_1, p_q_2 = values
     final_exponentiation = final_exponentiate(
         pairing(p_q_1[1], p_q_1[0], final_exponentiate=False)

src/ethereum/exceptions.py

@@ -1,31 +1,23 @@
-"""
-Error types common across all Ethereum forks.
-"""
+"""Error types common across all Ethereum forks."""
 
 
-class EthereumException(Exception):     # noqa N818
+class EthereumException(Exception):  # noqa N818
     """
     Base class for all exceptions _expected_ to be thrown during normal
     operation.
     """
 
 
 class InvalidBlock(EthereumException):
-    """
-    Thrown when a block being processed is found to be invalid.
-    """
+    """Thrown when a block being processed is found to be invalid."""
 
 
 class StateWithEmptyAccount(EthereumException):
-    """
-    Thrown when the state has empty account.
-    """
+    """Thrown when the state has empty account."""
 
 
 class InvalidTransaction(EthereumException):
-    """
-    Thrown when a transaction being processed is found to be invalid.
-    """
+    """Thrown when a transaction being processed is found to be invalid."""
 
 
 class InvalidSenderError(InvalidTransaction):
@@ -36,9 +28,7 @@ class InvalidSenderError(InvalidTransaction):
 
 
 class InvalidSignatureError(InvalidTransaction):
-    """
-    Thrown when a transaction has an invalid signature.
-    """
+    """Thrown when a transaction has an invalid signature."""
 
 
 class InsufficientBalanceError(InvalidTransaction):
@@ -70,6 +60,4 @@ class InsufficientTransactionGasError(InvalidTransaction):
 
 
 class NonceOverflowError(InvalidTransaction):
-    """
-    Thrown when a transaction's nonce is greater than `2**64 - 2`.
-    """
+    """Thrown when a transaction's nonce is greater than `2**64 - 2`."""

src/ethereum/fork_criteria.py

@@ -70,9 +70,7 @@ class ForkCriteria(ABC):
     _internal: Tuple[int, int]
 
     def __eq__(self, other: object) -> bool:
-        """
-        Equality for fork criteria.
-        """
+        """Equality for fork criteria."""
         if isinstance(other, ForkCriteria):
             return self._internal == other._internal
         return NotImplemented
@@ -95,7 +93,8 @@ def __lt__(self, other: object) -> bool:
 
     def __hash__(self) -> int:
         """
-        Compute a hash for this instance, so it can be stored in dictionaries.
+        Compute a hash for this instance, so it can be stored
+        in dictionaries.
         """
         return hash(self._internal)
 
@@ -111,16 +110,12 @@ def check(self, block_number: Uint, timestamp: U256) -> bool:
 
     @abstractmethod
     def __repr__(self) -> str:
-        """
-        String representation of this object.
-        """
+        """String representation of this object."""
         raise NotImplementedError()
 
 
 class ByBlockNumber(ForkCriteria):
-    """
-    Forks that occur when a specific block number has been reached.
-    """
+    """Forks that occur when a specific block number has been reached."""
 
     block_number: Uint
     """
@@ -144,16 +139,12 @@ def check(self, block_number: Uint, timestamp: U256) -> bool:
         return block_number >= self.block_number
 
     def __repr__(self) -> str:
-        """
-        String representation of this object.
-        """
+        """String representation of this object."""
         return f"ByBlockNumber({self.block_number})"
 
 
 class ByTimestamp(ForkCriteria):
-    """
-    Forks that occur when a specific timestamp has been reached.
-    """
+    """Forks that occur when a specific timestamp has been reached."""
 
     timestamp: U256
     """
@@ -177,29 +168,21 @@ def check(self, block_number: Uint, timestamp: U256) -> bool:
         return timestamp >= self.timestamp
 
     def __repr__(self) -> str:
-        """
-        String representation of this object.
-        """
+        """String representation of this object."""
         return f"ByTimestamp({self.timestamp})"
 
 
 class Unscheduled(ForkCriteria):
-    """
-    Forks that have not been scheduled.
-    """
+    """Forks that have not been scheduled."""
 
     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`.
-        """
+        """Unscheduled forks never occur; always returns `False`."""
         return False
 
     def __repr__(self) -> str:
-        """
-        String representation of this object.
-        """
+        """String representation of this object."""
         return "Unscheduled()"