chore(tooling): agree on common post-weld ruff rules

[danceratopz]

To keep post-Weld tooling simple, it would help to align on a shared set of ruff rules without any deviations across EEST and EELS codebases.

Common Ignored Rules (Both repos)

Rule	Description	Notes
D205	Missing blank line after summary	Common to both (STEEL)
D203	1 blank line required before class docstring	Common to both (STEEL)
D212	Multi-line docstring summary should start at the first line	Common to both (STEEL)
D415	First line should end with a ".", "?", or "!"	Common to both (STEEL)

execution-specs Specific Ignored Rules

Rule	Description	Notes
D107	Missing docstring in init	EELS specific
D200	One-line docstring should fit on one line with quotes	EELS specific
D400	First line should end with a period	EELS specific
D401	First line should be in imperative mood	EELS specific
D410	Missing blank line after last section	EELS specific
D411	Missing blank line before last section	EELS specific
D412	No blank lines between sections	EELS specific
D413	Missing blank line after last section	EELS specific (same as D410)
D414	Section should end with a period	EELS specific
D416	Section names should be in the correct order	EELS specific
E203	Whitespace before ':'	EELS specific

execution-spec-tests Specific Ignored Rules

Rule	Description	Notes
C901	Function is too complex	Complexity* handled differently
A005	Builtin shadowing	execution-spec-tests specific
C420	Unnecessary comprehension	execution-spec-tests specific

Regarding complexity: This is configured to 7 in EELS, it's the default in EEST. 7 is fine :)

[danceratopz]

Update

This PR's pyproject.toml almost has the target ruff configuration for all of our code post-Weld:

• https://github.com/ethereum/execution-specs/pull/1428/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711L445

Here are the differences, respectively the work left to do.

Both

• Ignore D200, see discussion here from Implement pre.empty_account() execution-spec-tests#1428.

EELS

• Enable the C4, flake8-comprehensions checks; these are already enabled in EEST. We will however ignore the following two rules as they are less explicit (the more explicit form is beneficial for non-Python devs reading the spec):
  • C401 https://docs.astral.sh/ruff/rules/unnecessary-generator-set/
  • C408 https://docs.astral.sh/ruff/rules/unnecessary-collection-call/
• Disable C90, mccabe complexity. Done in Implement pre.empty_account() execution-spec-tests#1428.
• Review other checks. Scary, but I don't think we have any guarantee that all of the previous EELS flake8 checks have been enabled in ruff.

EEST

• 99 -> 79:
  • Pre-Switch: chore: shorten docstrings and single-line comments to 79 (ruff w505: doc-line-too-long) execution-spec-tests#2180
  • At-Switch: Code formatting
• Trivial config changes - waiting for chore: shorten docstrings and single-line comments to 79 (ruff w505: doc-line-too-long) execution-spec-tests#2180 to get merged first.
  • Reenable C420; trivial, was disabled by mistake.
  • Fix C select as it's ambiguous: Select C40 explicitly instead, perhaps check if other C* checks get disabled by this due ot wildcard match? Update: They no "C" checks got enabled by selecting unknown check `*
  • Remove C90 config. It is selected, but then disabled makes no sense.
  • Disable D100, missing docstring in public module (to align with EELS)
  • Disable C401 https://docs.astral.sh/ruff/rules/unnecessary-generator-set/
  • Disable C408 https://docs.astral.sh/ruff/rules/unnecessary-collection-call/
• Enable ARG (after docstring/comment formatting, this is the bulk of the work left on the EEST side):
  • refactor(tests,tooling): unignore ARG001 in tests/* #1678
  • chore(tooling): enable remaining ruff ARG checks execution-spec-tests#2176

nice-to-have, one post-weld day, tbd

• Enable D205, missing-blank-line-after-summary. Quite a bit work on EEST side, we've never been careful enough to write one-line summaries consistently 😭
• Enable flake8-use-pathlib (PTH), this is an EEST convention, so it'd be nice to enforce.
• Enable C90, mccabe - branching complexity checks.
• Consider enabling PT, flake8-pytest-style. Could be nice-to-have as pytest maxis.
• Review all the other checks that ruff has and consider enabling.