| 1 |
Packages, modules, functions, variables, classes and constants follow PEP 8 casing (snake_case, PascalCase, UPPER_SNAKE) |
Pass |
snake_case functions, variables and modules; UPPER_SNAKE constants. |
| 2 |
Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes |
Pass |
create_driver, open_main_page, read_article_count state their purpose; no abbreviations or one-letter names. |
| 3 |
Code is produced by the project's formatter and passes its linter with no unexplained suppressions |
Pass |
ruff format and ruff check (E, F, I, B, UP) are clean; no noqa suppressions. |
| 4 |
Every function and method signature is type-annotated, including -> None |
Pass |
Every function, test and fake is annotated, including -> None; mypy --strict is clean. |
| 5 |
No bare except:, no swallowed exceptions; specific exceptions are raised and the cause is kept (raise ... from) |
Pass |
No except clause; main uses try/finally so the driver is always quit; errors propagate (tested). |
| 6 |
No mutable default arguments and no shadowed builtins |
Pass |
The only default is the immutable headless: bool = False; no builtins are shadowed. |
| 7 |
Files, locks and connections are managed with context managers |
Pass |
The browser is closed with try/finally and driver.quit(); kept close to the lecture instead of a with block (judgement). |
| 8 |
Public modules, classes and functions have docstrings that say what, not how |
Pass |
Public functions of src and of tests/e2e/capture_screenshots.py have Doxygen @brief/@param/@return; doxygen Doxyfile builds clean on src. |
| 9 |
Logging uses logging, not print; no secrets or personal data in log output |
Pass |
print is the program's console output, which the lecture asks for, not logging; no secrets are handled (judgement). |
| 10 |
Classes and operations trace to the Design Class Diagram they implement; deviations are recorded |
Pass |
No classes and no Design Class Diagram; the test fakes are not production classes (judgement; passes by absence). |
| 11 |
Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network |
Pass |
10 unit tests need no browser, network or order. The e2e test and the capture script use the network by design; they live in tests/e2e, are ignored by the default pytest run and run only in the Docker container (judgement, open to challenge). |
| 12 |
Type checker runs in strict mode without errors; Any is justified in a comment |
Pass |
mypy --strict is clean; the six type: ignore comments mark fakes standing in for WebDriver; no Any. |
| 13 |
Dependencies are declared and pinned in the project's dependency file, none unused |
Pass |
selenium>=4.20 is the only runtime dependency; dev tools are pytest, ruff, mypy; lower bounds rather than exact pins. |
| 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 |
URL, both selectors, Chrome options and env names are defined once in constants.py; the e2e files import them. |
| 15 |
Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles |
Pass |
interaction imports constants and selenium; constants imports nothing; no cycle. |
| 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 |
Each module and function has one reason to change; no type tests. |
| 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 |
Flat package by ADR-0001; tests/unit and tests/e2e follow the test folder layout; ADR-0002 records the selector change. |
| 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 |
All names are English, snake_case, no spaces. |
