| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) (Mandatory) |
Pass |
snake_case functions, PascalCase State; ruff N rules pass. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes (Mandatory) |
Pass |
find_state, get_missing_states, save_states_to_learn state purpose; assignment names kept. |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions (Mandatory) |
Pass |
ruff format and check clean, no suppressions. |
| 4 |
Every function and method signature is type-annotated, including -> None (Mandatory) |
Pass |
All signatures annotated; mypy --strict passes. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) (Mandatory) |
N-A |
No exception handling; a missing file raises FileNotFoundError to the caller. |
| 6 |
No mutable default arguments and no shadowed builtins (Mandatory) |
Pass |
Default arguments are immutable (Path values); no builtin shadowed. |
| 7 |
Files, locks and connections are managed with context managers (Mandatory) |
Pass |
storage.py opens files with with. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how (Optional) |
Pass |
Docstrings with Doxygen @param/@return on all public items. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output (Mandatory) |
Pass |
No print and no logging in the logic. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded (Mandatory) |
N-A |
No Design Class Diagram exists; State is a plain value object. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network (Mandatory) |
Pass |
15 tests named for behaviour, tmp_path for files, no network or order dependence. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment (Optional) |
Pass |
mypy strict reports no issues. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused (Optional) |
Pass |
No runtime dependencies (ADR-0001). |
| 14 |
Each piece of knowledge (a business rule, constant, format, validation or query) is defined in one place; code is merged only where it expresses the same knowledge, not where it merely looks alike (Mandatory) |
Pass |
Column names and paths defined once in constants.py; matching rule in find_state only. |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles (Mandatory) |
Pass |
states.py imports no IO or UI; storage.py imports inward (states, constants); no cycles. |
| 16 |
SOLID holds: a class or module has one reason to change; new behaviour is added by extension, not by editing a type test in several places; subclasses honour the contract of their base; protocols are narrow; high-level code depends on protocols or abstract types and receives its implementations (Mandatory) |
Pass |
states.py has one reason to change (rules), storage.py another (file format); no inheritance. |
