chore(tooling): Update static checks (#1428)

* add ruff format

* extend checks to tests

* remove exclude dirs from ruff config

* add D space rules to ruff

* stop ignoring D200 in ruff

* stop ignoring D410 in ruff

* stop ignoring D411 in ruff

* stop ignoring D412 in ruff

* stop ignoring D413 in ruff

* stop ignoring D414 in ruff

* stop ignoring D416 in ruff

* stop ignoring E203 in ruff

* tests follow the same rules as other code

* tests stop ignoring D103

* tests stop ignoring D104

* tests stop ignoring E501

* clean up ruff config

* stop ignoring D400 in ruff

* stop ignoring D415

* Revert "stop ignoring D200 in ruff"

* enable C4

* Apply suggestions from code review

Co-authored-by: Sam Wilson <[email protected]>

---------

Co-authored-by: Sam Wilson <[email protected]>

Author: gurukamath

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,8 @@ select = [
     "I", # isort
     "A", # flake8-builtins
     "N", # pep8-naming
+    "D", # pydocstyle
+    "C4", # flake8-comprehensions
     "ARG", # flake8-unused-arguments
 ]
 fixable = [
@@ -463,34 +452,17 @@ fixable = [
 ]
 ignore = [
 # Common to STEEL
-    "D205",     # Missing blank line after summary
-    "D203",     # 1 blank line required before class docstring
-    "D212",     # Multi-line docstring summary should start at the first line
-    "D415",     # First line should end with a ".", "?", or "!"
-
-# Specific to EELS
+    "C401",     # Unnecessary generator set
+    "C408",     # Unnecessary collection call
     "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
+    "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
     "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 ':'
 ]
 
 [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 +480,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

@@ -1,4 +1,6 @@
 """
+Ethereum base package.
+
 ### Introduction
 
 Seeing as internet connections have been vastly expanding across the
@@ -16,6 +18,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/blake2.py

@@ -1,7 +1,5 @@
-"""
-The Blake2 Implementation
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-"""
+"""The Blake2 Implementation."""
+
 import struct
 from dataclasses import dataclass
 from typing import Final, List, Tuple
@@ -21,6 +19,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):
@@ -61,31 +60,31 @@ def max_word(self) -> Uint:
     def w_R1(self) -> Uint:
         """
         (w - R1) value for a given Blake2 flavor.
-        Used in the function G
+        Used in the function G.
         """
         return self.w - self.R1
 
     @property
     def w_R2(self) -> Uint:
         """
         (w - R2) value for a given Blake2 flavor.
-        Used in the function G
+        Used in the function G.
         """
         return self.w - self.R2
 
     @property
     def w_R3(self) -> Uint:
         """
         (w - R3) value for a given Blake2 flavor.
-        Used in the function G
+        Used in the function G.
         """
         return self.w - self.R3
 
     @property
     def w_R4(self) -> Uint:
         """
         (w - R4) value for a given Blake2 flavor.
-        Used in the function G
+        Used in the function G.
         """
         return self.w - self.R4
 
@@ -140,6 +139,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)
@@ -153,8 +153,11 @@ def G(
         self, v: List, a: Uint, b: Uint, c: Uint, d: Uint, x: Uint, y: Uint
     ) -> List:
         """
-        The mixing function used in Blake2
-        https://datatracker.ietf.org/doc/html/rfc7693#section-3.1
+        The mixing function used in Blake2.
+
+        See [RFC 7693] for more details.
+
+        [RFC 7693]: https://datatracker.ietf.org/doc/html/rfc7693#section-3.1
 
         Parameters
         ----------
@@ -164,6 +167,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) ^ (
@@ -197,8 +201,7 @@ def compress(
         f: bool,
     ) -> bytes:
         """
-        'F Compression' from section 3.2 of RFC 7693:
-        https://tools.ietf.org/html/rfc7693#section-3.2
+        'F Compression' from section 3.2 of RFC 7693.
 
         Parameters
         ----------
@@ -212,6 +215,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

@@ -1,7 +1,4 @@
-"""
-Elliptic Curves
-^^^^^^^^^^^^^^^
-"""
+"""Elliptic Curves."""
 
 import coincurve
 from Crypto.Util.asn1 import DerSequence
@@ -45,6 +42,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 +112,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 +150,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

@@ -1,6 +1,5 @@
 """
-Cryptographic Hash Functions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Cryptographic Hash Functions.
 
 .. contents:: Table of Contents
     :backlinks: none
@@ -32,6 +31,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 +50,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

@@ -1,7 +1,5 @@
-"""
-The KZG Implementation
-^^^^^^^^^^^^^^^^^^^^^^
-"""
+"""The KZG Implementation."""
+
 from hashlib import sha256
 from typing import Tuple
 
@@ -36,7 +34,7 @@ class KZGCommitment(Bytes48):
 
 
 class KZGProof(Bytes48):
-    """KZG proof"""
+    """KZG proof."""
 
     pass
 

src/ethereum/exceptions.py

@@ -3,7 +3,7 @@
 """
 
 
-class EthereumException(Exception):     # noqa N818
+class EthereumException(Exception):  # noqa N818
     """
     Base class for all exceptions _expected_ to be thrown during normal
     operation.

src/ethereum/forks/arrow_glacier/__init__.py

@@ -26,7 +26,7 @@
 [js]: https://github.com/ethereumjs/ethereumjs-monorepo/releases/tag/%40ethereumjs%2Fvm%405.6.0
 [Geth 1.10.12]: https://github.com/ethereum/go-ethereum/releases/tag/v1.10.12
 [nm]: https://github.com/NethermindEth/nethermind/releases/tag/1.11.7
-""" # noqa: E501
+"""  # noqa: E501
 
 from ethereum.fork_criteria import ByBlockNumber
 

src/ethereum/forks/arrow_glacier/blocks.py

@@ -8,6 +8,7 @@
 history of all state transitions that have happened since the genesis of the
 chain.
 """
+
 from dataclasses import dataclass
 from typing import Tuple
 

src/ethereum/forks/arrow_glacier/bloom.py

@@ -1,6 +1,5 @@
 """
-Ethereum Logs Bloom
-^^^^^^^^^^^^^^^^^^^
+Ethereum Logs Bloom.
 
 .. contents:: Table of Contents
     :backlinks: none
@@ -41,6 +40,7 @@ def add_to_bloom(bloom: bytearray, bloom_entry: Bytes) -> None:
         The bloom filter.
     bloom_entry :
         An entry which is to be added to bloom filter.
+
     """
     hashed = keccak256(bloom_entry)
 
@@ -75,6 +75,7 @@ def logs_bloom(logs: Tuple[Log, ...]) -> Bloom:
     logs_bloom : `Bloom`
         The logs bloom obtained which is 256 bytes with some bits set as per
         the caller address and the log topics.
+
     """
     bloom: bytearray = bytearray(b"\x00" * 256)