| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
Modules and functions are snake_case, classes PascalCase, constants UPPER_SNAKE |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
Names state purpose (price, target, headers); no abbreviations left unexplained |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff format and ruff check pass: 33 pytest tests with fake SMTP and fakes of the ports, ruff 0 findings, mypy strict 0 errors (26 files) |
| 4 |
Every function and method signature is type-annotated, including -> None |
Pass |
All signatures annotated; mypy --strict passes: 33 pytest tests with fake SMTP and fakes of the ports, ruff 0 findings, mypy strict 0 errors (26 files) |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
Pass |
No bare except; errors are specific and chained with raise ... from where a cause exists |
| 6 |
No mutable default arguments and no shadowed builtins |
Pass |
No mutable defaults, no shadowed builtins |
| 7 |
Files, locks and connections are managed with context managers |
Pass |
The SMTP connection is used as a context manager in SmtpNotifier.send |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Public modules and functions have docstrings with Doxygen tags |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
Pass |
No logging of secrets: the password is excluded from the settings repr and from error texts; print is used only for the assignment output and the missing-setting message |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
N-A |
No Design Class Diagram exists; the milestone's technical tasks need none (Needs use case: No) |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
Tests exist, are named for behaviour and use no network or real mail server: 33 pytest tests with fake SMTP and fakes of the ports, ruff 0 findings, mypy strict 0 errors (26 files) |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
Pass |
mypy --strict passes; no Any |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
Dependencies are in pyproject.toml with lower bounds; none unused |
| 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 |
Pass |
Constants live only in constants.py |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles |
Pass |
Imports point inward; 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 |
Pass |
Notifier, PageFetcher and ProductParser are narrow Protocols; AlertMessage lives in domain so ports and use case share it without a cycle |
| 17 |
Source is laid out in the layers and folders of the clean architecture folder structure (domain, application, infrastructure, presentation packages under src/, and unit, integration and e2e under tests/), in snake_case, and imports between the layers point inward |
Pass |
domain, application and infrastructure packages; main.py is the composition root; tests mirror them under tests/unit/ |
| 18 |
File and folder names are English, contain no space and no character outside letters, digits, -, _ and ., and follow the casing of the language for files |
Pass |
File names are English snake_case |
