docs: formalize non-Black style rules + ban blanket type: ignore (#237)

.gitignore

@@ -60,3 +60,4 @@ tests/fixtures
 tests/t8n_testdata
 
 fixtures
+logs/

CONTRIBUTING.md

@@ -26,6 +26,8 @@ This specification aims to be:
 - Avoid using EIP numbers in identifiers.
 - If necessary, there is a custom dictionary `whitelist.txt`. 
 
+See [docs/STYLE_GUIDE.md](docs/STYLE_GUIDE.md) for rules not covered by Black (naming, ensure/assert, and typing ignore policy). 
+
 ### Changes across various Forks
 
 Many contributions require changes across multiple forks, organized under `src/ethereum/*`. When making such changes, please ensure that differences between the forks are minimal and consist only of necessary differences. This will help with getting cleaner [diff outputs](https://ethereum.github.io/execution-specs/diffs/index.html).

mypy.ini

@@ -9,5 +9,7 @@ strict_bytes = True
 warn_unused_ignores = True
 warn_unused_configs = True
 warn_redundant_casts = True
+show_error_codes = True
+enable_error_code = ignore-without-code
 
 ignore_missing_imports = False

pyproject.toml

@@ -441,6 +441,7 @@ select = [
     "D", # pydocstyle
     "C4", # flake8-comprehensions
     "ARG", # flake8-unused-arguments
+    "PGH003", # blanket-type-ignore
 ]
 fixable = [
     "E", # pycodestyle errors

src/ethereum_spec_tools/docc.py

@@ -51,8 +51,12 @@
 from docc.transform import Transform
 from fladrif.apply import Apply
 from fladrif.treediff import Adapter, Operation, TreeMatcher
-from mistletoe import block_token as blocks  # type: ignore
-from mistletoe import span_token as spans
+from mistletoe import (  # type: ignore[import-untyped]  # Third-party library without types
+    block_token as blocks,
+)
+from mistletoe import (
+    span_token as spans,
+)
 from typing_extensions import assert_never, override
 
 from .forks import Hardfork

src/ethereum_spec_tools/forks.py

@@ -130,7 +130,7 @@ def load(cls: Type[H], config_dict: Dict["ForkCriteria", str]) -> List[H]:
 
         for criteria, name in config:
             mod = importlib.import_module("ethereum." + name)
-            mod.FORK_CRITERIA = criteria  # type: ignore
+            mod.FORK_CRITERIA = criteria  # type: ignore[attr-defined]  # Dynamic module attribute assignment
             forks.append(cls(mod))
 
         return forks