fix docstring lengths

Author: felix314159

.github/scripts/generate_eip_report.py

@@ -1,4 +1,7 @@
-"""Generate a markdown report of outdated EIP references from the EIP version checker output."""
+"""
+Generate a markdown report of outdated EIP references from the EIP version
+checker output.
+"""
 
 import os
 import re
@@ -8,10 +11,13 @@
 
 # Report template using textwrap.dedent for clean multiline strings
 REPORT_TEMPLATE = Template(
-    textwrap.dedent("""\
+    textwrap.dedent(
+        """\
     # EIP Version Check Report
 
-    This automated check has detected that some EIP references in test files are outdated. This means that the EIPs have been updated in the [ethereum/EIPs](https://github.com/ethereum/EIPs) repository since our tests were last updated.
+    This automated check has detected that some EIP references in test files are outdated.
+    This means that the EIPs have been updated in the
+    [ethereum/EIPs](https://github.com/ethereum/EIPs) repository since our tests were last updated.
 
     ## Outdated EIP References
 
@@ -42,7 +48,8 @@
     ## Workflow Information
 
     For more details, see the [workflow run](https://github.com/ethereum/execution-spec-tests/actions/runs/$run_id).
-""")  # noqa: E501
+"""
+    )  # noqa: E501
 )
 
 

src/cli/compare_fixtures.py

@@ -1,9 +1,9 @@
 """
 Compare two fixture folders and remove duplicates based on fixture hashes.
 
-This tool reads the .meta/index.json files from two fixture directories and identifies
-fixtures with identical hashes on a test case basis, then removes the duplicates from
-both of the folders. Used within the coverage workflow.
+This tool reads the .meta/index.json files from two fixture directories and
+identifies fixtures with identical hashes on a test case basis, then removes
+the duplicates from both of the folders. Used within the coverage workflow.
 """
 
 import json
@@ -95,8 +95,8 @@ def batch_remove_fixtures_from_files(removals_by_file):
 
 def rewrite_index(folder: Path, index: IndexFile, dry_run: bool):
     """
-    Rewrite the index to the correct index file, or if the test count was reduced to zero,
-    the entire directory is deleted.
+    Rewrite the index to the correct index file, or if the test count was
+    reduced to zero, the entire directory is deleted.
     """
     if len(index.test_cases) > 0:
         # Just rewrite the index

src/cli/eest/cli.py

@@ -1,5 +1,6 @@
 """
 `eest` is a CLI tool that helps with routine tasks.
+
 Invoke using `uv run eest`.
 """
 
@@ -15,16 +16,9 @@ def eest():
     pass
 
 
-"""
-################################
-||                            ||
-||    Command Registration    ||
-||                            ||
-################################
-
-Register nested commands here. For more information, see Click documentation:
-https://click.palletsprojects.com/en/8.0.x/commands/#nested-handling-and-contexts
-"""
+# Register nested commands here. For more information, see Click documentation:
+# https://click.palletsprojects.com/en/8.0.x/commands/#nested-handling-and-contexts
+
 eest.add_command(make)
 eest.add_command(clean)
 eest.add_command(info)

src/cli/eest/commands/clean.py

@@ -19,7 +19,9 @@
 def clean(all_files: bool, dry_run: bool, verbose: bool):
     """
     Remove all generated files and directories from the repository.
-    If `--all` is specified, the virtual environment and .tox directory will also be removed.
+
+    If `--all` is specified, the virtual environment and .tox directory will also
+    be removed.
 
     Args:
         all_files (bool): Remove the virtual environment and .tox directory as well.

src/cli/eest/make/cli.py

@@ -1,11 +1,12 @@
 """
-The `make` CLI streamlines the process of scaffolding tasks, such as generating new test files,
-enabling developers to concentrate on the core aspects of specification testing.
-
-
-The module calls the appropriate function for the subcommand. If an invalid subcommand
-is chosen, it throws an error and shows a list of valid subcommands. If no subcommand
-is present, it shows a list of valid subcommands to choose from.
+The `make` CLI streamlines the process of scaffolding tasks, such as
+generating new test files, enabling developers to concentrate on the core
+aspects of specification testing.
+
+The module calls the appropriate function for the subcommand. If an invalid
+subcommand is chosen, it throws an error and shows a list of valid subcommands.
+If no subcommand is present, it shows a list of valid subcommands to choose
+from.
 """
 
 import click
@@ -19,15 +20,8 @@ def make():
     pass
 
 
-"""
-################################
-||                            ||
-||    Command Registration    ||
-||                            ||
-################################
-
-Register nested commands here. For more information, see Click documentation:
-https://click.palletsprojects.com/en/8.0.x/commands/#nested-handling-and-contexts
-"""
+# Register nested commands here. For more information, see Click documentation:
+# https://click.palletsprojects.com/en/8.0.x/commands/#nested-handling-and-contexts
+
 make.add_command(test)
 make.add_command(create_default_env)

src/cli/eest/make/commands/__init__.py

@@ -1,7 +1,8 @@
 """
-Holds subcommands for the make command. New subcommands must be created as
-modules and exported from this package, then registered under the make command in
-`cli.py`.
+Holds subcommands for the make command.
+
+New subcommands must be created as modules and exported from this package, then
+registered under the make command in `cli.py`.
 """
 
 from .env import create_default_env

src/cli/eest/make/commands/test.py

@@ -1,9 +1,10 @@
 """
 Provides a CLI command to scaffold a test file.
 
-The `test` command guides the user through a series of prompts to generate a test file
-based on the selected test type, fork, EIP number, and EIP name. The generated test file
-is saved in the appropriate directory with a rendered template using Jinja2.
+The `test` command guides the user through a series of prompts to generate a
+test file based on the selected test type, fork, EIP number, and EIP name. The
+generated test file is saved in the appropriate directory with a rendered
+template using Jinja2.
 """
 
 import os

src/cli/eest/quotes.py

@@ -51,5 +51,8 @@ def box_quote(quote):
 
 
 def get_quote():
-    """Return random inspirational quote related to system design formatted in a box."""
+    """
+    Return random inspirational quote related to system design formatted in a
+    box.
+    """
     return box_quote(random.choice(make_something_great))

src/cli/eofwrap.py

@@ -1,6 +1,6 @@
 """
-Generate a JSON blockchain test from an existing JSON blockchain test by wrapping its pre-state
-code in EOF wherever possible.
+Generate a JSON blockchain test from an existing JSON blockchain test by
+wrapping its pre-state code in EOF wherever possible.
 
 Example Usage:
 
@@ -44,8 +44,8 @@
 @click.option("--traces", is_flag=True, type=bool)
 def eof_wrap(input_path: str, output_dir: str, traces: bool):
     """
-    Wrap JSON blockchain test file(s) found at `input_path` and
-    outputs them to the `output_dir`.
+    Wrap JSON blockchain test file(s) found at `input_path` and outputs them to
+    the `output_dir`.
     """
     eof_wrapper = EofWrapper()
 
@@ -168,8 +168,10 @@ def __init__(self):
 
     def wrap_file(self, in_path: str, out_path: str, traces: bool):
         """
-        Wrap code from a blockchain test JSON file from `in_path` into EOF containers,
-        wherever possible. If not possible - skips and tracks that in metrics. Possible means
+        Wrap code from a blockchain test JSON file from `in_path` into EOF
+        containers, wherever possible.
+
+        If not possible - skips and tracks that in metrics. Possible means
         at least one account's code can be wrapped in a valid EOF container and the assertions
         on post state are satisfied.
         """
@@ -336,8 +338,8 @@ def _validate_eof(self, container: Container, metrics: bool = True) -> bool:
 @no_type_check
 def wrap_code(account_code: Bytes) -> Container:
     """
-    Wrap `account_code` into a simplest EOF container, applying some simple heuristics in
-    order to obtain a valid code section termination.
+    Wrap `account_code` into a simplest EOF container, applying some simple
+    heuristics in order to obtain a valid code section termination.
     """
     assert len(account_code) > 0
 

src/cli/evm_bytes.py

@@ -206,7 +206,8 @@ def hex_string(hex_string: str, assembly: bool):
 @click.argument("binary_file", type=click.File("rb"))
 def binary_file(binary_file, assembly: bool):
     """
-    Convert the BINARY_FILE containing EVM bytes to Python Opcodes or assembly.
+    Convert the BINARY_FILE containing EVM bytes to Python Opcodes or
+    assembly.
 
     BINARY_FILE is a binary file containing EVM bytes, use `-` to read from stdin.