| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
N-A |
MIL-005 changes no Python file (git diff main --stat -- src tests is empty); the files are a PNG, README.md and wiki/. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
N-A |
No Python file changed. |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff check and ruff format --check still exit 0 on the unchanged src and tests, checked in a fresh clone of the branch. |
| 4 |
Every function and method signature is type-annotated, including -> None |
N-A |
No Python file changed. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
N-A |
No Python file changed. |
| 6 |
No mutable default arguments and no shadowed builtins |
N-A |
No Python file changed. |
| 7 |
Files, locks and connections are managed with context managers |
N-A |
No Python file changed. |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
doxygen Doxyfile exits 0 with no warnings in the fresh clone. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
N-A |
No Python file changed. |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
N-A |
No Python file changed. |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
In a fresh clone of the branch, following the README on Windows PowerShell (python -m venv .venv, python -m pip install --upgrade pip, python -m pip install -e ".[dev]"), pytest reports 39 passed and python -m weather exits 0 and prints the results of the lectures. |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
Pass |
python -m mypy runs with strict = true: no issues in 12 source files in the fresh clone. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
N-A |
No dependency change. |
| 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 |
N-A |
No Python file changed. |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles |
N-A |
No Python file changed. |
| 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 |
N-A |
No Python file changed. |
