chore: shorten docstrings and single-line comments to 79 (ruff w505: doc-line-too-long) (ethereum#2180)

* split comments across multiple lines when necessary

* chore(tooling): check w505 in tox lint env

* fixes

* chore: remove abstract and other admonitions from test module docstrings

* fixes

* chore: fix more malformatted tables

* chore: fix broken unordered-lists/args

* chore: fix broken unordered-lists/args

* chore: improve docstrings, also for D205

* chore: improve docstrings, also for D205

* chore: fix long or poorly formatted comments

* chore: manually revert and fix docstrings/comments

* fix: bad string formatting fix in unit test

* last batch of manual fixes

* fix

* fix

---------

Co-authored-by: danceratopz <danceratopz@gmail.com>

Author: felix314159

amsterdam/__init__.py

@@ -1 +1,4 @@
-"""Test cases for EVM functionality introduced in Amsterdam, [EIP-7773: Hardfork Meta - Glamsterdam](https://eip.directory/eips/eip-7773)."""  # noqa: E501
+"""
+Test cases for EVM functionality introduced in Amsterdam, [EIP-7773: Hardfork
+Meta - Glamsterdam](https://eip.directory/eips/eip-7773).
+"""

amsterdam/eip7928_block_level_access_lists/test_block_access_lists_invalid.py

@@ -1,7 +1,7 @@
 """
 Test cases for invalid Block Access Lists.
 
-These tests verify that clients properly reject blocks with corrupted BALs
+These tests verify that clients properly reject blocks with corrupted BALs.
 """
 
 import pytest
@@ -52,7 +52,10 @@ def test_bal_invalid_missing_nonce(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL is missing required nonce changes."""
+    """
+    Test that clients reject blocks where BAL is missing required nonce
+    changes.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 
@@ -91,7 +94,9 @@ def test_bal_invalid_nonce_value(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL contains incorrect nonce value."""
+    """
+    Test that clients reject blocks where BAL contains incorrect nonce value.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 
@@ -130,7 +135,10 @@ def test_bal_invalid_storage_value(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL contains incorrect storage values."""
+    """
+    Test that clients reject blocks where BAL contains incorrect storage
+    values.
+    """
     sender = pre.fund_eoa(amount=10**18)
 
     # Simple storage contract with canary values
@@ -190,7 +198,10 @@ def test_bal_invalid_tx_order(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL has incorrect transaction ordering."""
+    """
+    Test that clients reject blocks where BAL has incorrect transaction
+    ordering.
+    """
     sender1 = pre.fund_eoa(amount=10**18)
     sender2 = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
@@ -247,7 +258,10 @@ def test_bal_invalid_account(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL contains accounts that don't exist."""
+    """
+    Test that clients reject blocks where BAL contains accounts that don't
+    exist.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
     phantom = pre.fund_eoa(amount=0)
@@ -295,7 +309,10 @@ def test_bal_invalid_duplicate_account(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL contains duplicate account entries."""
+    """
+    Test that clients reject blocks where BAL contains duplicate account
+    entries.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 
@@ -337,7 +354,9 @@ def test_bal_invalid_account_order(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL has incorrect account ordering."""
+    """
+    Test that clients reject blocks where BAL has incorrect account ordering.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 
@@ -454,7 +473,9 @@ def test_bal_invalid_missing_account(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL is missing an entire account."""
+    """
+    Test that clients reject blocks where BAL is missing an entire account.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 
@@ -496,7 +517,9 @@ def test_bal_invalid_balance_value(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
 ):
-    """Test that clients reject blocks where BAL contains incorrect balance value."""
+    """
+    Test that clients reject blocks where BAL contains incorrect balance value.
+    """
     sender = pre.fund_eoa(amount=10**18)
     receiver = pre.fund_eoa(amount=0)
 

benchmark/__init__.py

@@ -1,8 +1,9 @@
 """
-abstract: Benchmark tests for EVMs.
-    Benchmark tests aim to maximize the usage of a specific opcode,
-    precompile, or operation within a transaction or block. These can
-    be executed against EVM implementations to ensure they handle
-    pathological cases efficiently and correctly, allowing Ethereum to
-    safely [Scale the L1](https://protocol.ethereum.foundation/).
+Benchmark tests for EVMs.
+
+Benchmark tests aim to maximize the usage of a specific opcode, precompile,
+or operation within a transaction or block. These can be executed against
+EVM implementations to ensure they handle pathological cases efficiently
+and correctly, allowing Ethereum to safely
+[Scale the L1](https://protocol.ethereum.foundation/).
 """

benchmark/conftest.py

@@ -10,7 +10,10 @@
 
 
 def pytest_generate_tests(metafunc):
-    """Modify test generation to enforce default benchmark fork for benchmark tests."""
+    """
+    Modify test generation to enforce default benchmark fork for benchmark
+    tests.
+    """
     benchmark_dir = Path(__file__).parent
     test_file_path = Path(metafunc.definition.fspath)
 

benchmark/helpers.py

@@ -9,7 +9,8 @@ def code_loop_precompile_call(calldata: Bytecode, attack_block: Bytecode, fork:
     """Create a code loop that calls a precompile with the given calldata."""
     max_code_size = fork.max_code_size()
 
-    # The attack contract is: CALLDATA_PREP + #JUMPDEST + [attack_block]* + JUMP(#)
+    # The attack contract is: CALLDATA_PREP + #JUMPDEST + [attack_block]* +
+    # JUMP(#)
     jumpdest = Op.JUMPDEST
     jump_back = Op.JUMP(len(calldata))
     max_iters_loop = (max_code_size - len(calldata) - len(jumpdest) - len(jump_back)) // len(

benchmark/test_worst_blocks.py

@@ -1,8 +1,5 @@
 """
-abstract: Tests that benchmark EVMs in worst-case block scenarios.
-    Tests that benchmark EVMs in worst-case block scenarios.
-
-Tests running worst-case block scenarios for EVMs.
+Tests that benchmark EVMs in worst-case block scenarios.
 """
 
 import random
@@ -26,7 +23,10 @@
 
 @pytest.fixture
 def iteration_count(intrinsic_cost: int, gas_benchmark_value: int):
-    """Calculate the number of iterations based on the gas limit and intrinsic cost."""
+    """
+    Calculate the number of iterations based on the gas limit and intrinsic
+    cost.
+    """
     return gas_benchmark_value // intrinsic_cost
 
 
@@ -186,12 +186,14 @@ def test_block_full_data(
     gas_benchmark_value: int,
 ):
     """Test a block with empty payload."""
-    # Gas cost calculation based on EIP-7683: (https://eips.ethereum.org/EIPS/eip-7683)
+    # Gas cost calculation based on EIP-7683:
+    # (https://eips.ethereum.org/EIPS/eip-7683)
     #
     #   tx.gasUsed = 21000 + max(
     #       STANDARD_TOKEN_COST * tokens_in_calldata
     #       + execution_gas_used
-    #       + isContractCreation * (32000 + INITCODE_WORD_COST * words(calldata)),
+    #       + isContractCreation * (32000 +
+    #                                 INITCODE_WORD_COST * words(calldata)),
     #       TOTAL_COST_FLOOR_PER_TOKEN * tokens_in_calldata)
     #
     # Simplified in this test case:
@@ -208,7 +210,8 @@ def test_block_full_data(
     # Token accounting:
     #   tokens_in_calldata = zero_bytes + 4 * non_zero_bytes
     #
-    # So we calculate how many bytes we can fit into calldata based on available gas.
+    # So we calculate how many bytes we can fit into calldata based on
+    # available gas.
 
     gas_available = gas_benchmark_value - intrinsic_cost
 
@@ -240,7 +243,10 @@ def test_block_full_access_list_and_data(
     fork: Fork,
     gas_benchmark_value: int,
 ):
-    """Test a block with access lists (60% gas) and calldata (40% gas) using random mixed bytes."""
+    """
+    Test a block with access lists (60% gas) and calldata (40% gas) using
+    random mixed bytes.
+    """
     attack_gas_limit = gas_benchmark_value
     gas_available = attack_gas_limit - intrinsic_cost
 
@@ -271,7 +277,8 @@ def test_block_full_access_list_and_data(
         )
     ]
 
-    # Calculate calldata with 29% of gas for zero bytes and 71% for non-zero bytes
+    # Calculate calldata with 29% of gas for zero bytes and 71% for non-zero
+    # bytes
     # Token accounting: tokens_in_calldata = zero_bytes + 4 * non_zero_bytes
     # We want to split the gas budget:
     # - 29% of gas_for_calldata for zero bytes
@@ -287,7 +294,8 @@ def test_block_full_access_list_and_data(
     # Zero bytes: 1 token per byte
     # Non-zero bytes: 4 tokens per byte
     num_zero_bytes = tokens_for_zero_bytes  # 1 token = 1 zero byte
-    num_non_zero_bytes = tokens_for_non_zero_bytes // 4  # 4 tokens = 1 non-zero byte
+    # 4 tokens = 1 non-zero byte
+    num_non_zero_bytes = tokens_for_non_zero_bytes // 4
 
     # Create calldata with mixed bytes
     calldata = bytearray()