Tirsvad-Udemy-100-days-of-code/055-higher-lower
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MIL-003 Higher or Lower game: logic, routes, server.py, tests #25

Merged
Tirsvad merged 4 commits from mil-003-higher-lower-game into main 2026-11-06 05:53:57 +01:00
Conversation 0 Commits 4 Files Changed 14
+62 -62
1 changed files with 62 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ec1f3c6ce5 - Show all commits
docs/sqa/reviews/rc-010-code-mil-003.md
+62 -62
View File
@@ -1,62 +1,62 @@
# RC-010 Code review of MIL-003 # RC-010 Code review of MIL-003
## Metadata ## Metadata
| Key | Value | | Key | Value |
| --- | --- | | --- | --- |
| ID | RC-010 | | ID | RC-010 |
| CrossReference | [MIL-003], [QC-PY-001] | | CrossReference | [MIL-003], [QC-PY-001] |
## Version History ## Version History
| Date | Status | Author | Reviewer | Change | Commit | | Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [f613f8b] | | 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [cc95105] |
--- ---
## Artifact Under Review ## Artifact Under Review
- Instance reviewed: [MIL-003] - Instance reviewed: [MIL-003]
- Checklist used: [QC-PY-001] - Checklist used: [QC-PY-001]
- Scope: Code of MIL-003: domain, application, infrastructure and presentation/web packages, `server.py`, and the unit and integration tests; written by the python-developer agent - Scope: Code of MIL-003: domain, application, infrastructure and presentation/web packages, `server.py`, and the unit and integration tests; written by the python-developer agent
- Language and domain: n/a (technical type) - Language and domain: n/a (technical type)
- Language reviewer: none - Language reviewer: none
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`) - Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`)
## Checklist Results ## Checklist Results
| # | Criterion | Status | Evidence/Notes | | # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | Modules and functions use snake_case, classes PascalCase, constants UPPER_SNAKE | | 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | Modules and functions use 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 (`compare_guess`, `GuessResult`, `HOME_HEADING`); no unexplained abbreviations | | 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names state purpose (`compare_guess`, `GuessResult`, `HOME_HEADING`); no unexplained abbreviations |
| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff check` and `ruff format --check` report no finding; no suppressions | | 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff check` and `ruff format --check` report no finding; no suppressions |
| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Every signature is annotated; `mypy --strict` reports no issue | | 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Every signature is annotated; `mypy --strict` reports no issue |
| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | Pass | No bare `except`; no exception is swallowed | | 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | Pass | No bare `except`; no exception is swallowed |
| 6 | No mutable default arguments and no shadowed builtins | Pass | No mutable default arguments; no builtin is shadowed | | 6 | No mutable default arguments and no shadowed builtins | Pass | No mutable default arguments; no builtin is shadowed |
| 7 | Files, locks and connections are managed with context managers | N-A | No file, lock or connection is opened | | 7 | Files, locks and connections are managed with context managers | N-A | No file, lock or connection is opened |
| 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Public modules, classes and functions have Doxygen-style docstrings | | 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Public modules, classes and functions have Doxygen-style docstrings |
| 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | Pass | No `print`; no secret in the code; `.env` is neither read nor imported | | 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | Pass | No `print`; no secret in the code; `.env` is neither read nor imported |
| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | No DCD exists (plain technical tasks) | | 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | No DCD exists (plain technical tasks) |
| 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | pytest tests are named for behaviour, run in any order and use no network | | 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | pytest tests are named for behaviour, run in any order and use no network |
| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | Pass | `mypy --strict` passes; no `Any` | | 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 | `pyproject.toml` declares Flask (runtime) and pytest, ruff, mypy (extras); none unused | | 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | `pyproject.toml` declares Flask (runtime) and pytest, ruff, mypy (extras); 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 | The comparison rule is only in `domain/rules.py`; headings, colours and GIFs only in `constants.py` | | 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 | The comparison rule is only in `domain/rules.py`; headings, colours and GIFs 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 | domain imports only the standard library; application imports domain and constants; infrastructure imports only the standard library; presentation imports application, infrastructure and Flask; no cycle | | 15 | Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles | Pass | domain imports only the standard library; application imports domain and constants; infrastructure imports only the standard library; presentation imports application, infrastructure and Flask; 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 has one reason to change; behaviour is added by extension | | 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 has one reason to change; behaviour is added by extension |
| 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 rule, application use case, infrastructure random source and presentation web app sit in their layer packages; tests in `tests/unit` and `tests/integration` | | 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 rule, application use case, infrastructure random source and presentation web app sit in their layer packages; tests in `tests/unit` and `tests/integration` |
| 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 and folder names are English with letters, digits and `_` only | | 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 and folder names are English with letters, digits and `_` only |
## Overall Verdict ## Overall Verdict
Go — All criteria pass or are not applicable; no blocking finding. Go — All criteria pass or are not applicable; no blocking finding.
## Action Items ## Action Items
| Action | Owner | Due | | Action | Owner | Due |
| --- | --- | --- | | --- | --- | --- |
| None | S01 | 2026-11-06 | | None | S01 | 2026-11-06 |
--- ---
[MIL-003]: ../../docs/milestones/mil-003-higher-lower-game.md [MIL-003]: ../../docs/milestones/mil-003-higher-lower-game.md
[QC-PY-001]: ../../framework/qc/code/qc-programming-python.md [QC-PY-001]: ../../framework/qc/code/qc-programming-python.md
[f613f8b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/055-higher-lower/commit/f613f8bf2b5b4c385bebcaf8f4a2f975a51044e0 [cc95105]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/055-higher-lower/commit/cc95105cf4fb9915e4c392fa58eec5d9a1f7c454