Files
atelier/languages/python.md
T
Jon Chery 496303471d docs(milestone): complete v0.1 — initial framework
---ci---
project: atelier
phase: 7
milestone: v0.1
status: complete
phase_role: final
milestone_complete: true
requirements:
  covered: [ATELIER-01, ATELIER-02, ATELIER-03, ATELIER-04, ATELIER-05, ATELIER-06, ATELIER-07, ATELIER-08, ATELIER-09, ATELIER-10, ATELIER-11, ATELIER-12, ATELIER-13, ATELIER-14, ATELIER-15, ATELIER-16, ATELIER-17, ATELIER-18, ATELIER-19, ATELIER-20, ATELIER-21, ATELIER-22, ATELIER-23, ATELIER-24, ATELIER-25, ATELIER-26, ATELIER-27, ATELIER-28, ATELIER-29, ATELIER-30, ATELIER-31, ATELIER-32, ATELIER-33, ATELIER-34, ATELIER-35]
  partial: []
ship:
  milestone: v0.1
  type: NFR
  tag: v0.0.7
  merge: milestone/v0.1-atelier -> main
  release: https://git.cloudinit.dev/cloudinit-bot/atelier/releases/tag/v0.0.7
---/ci---

Milestone v0.1 — Initial Framework (NFR, complete).
8 core principles (C1-C8), 11 domains, 110 domain principles, 27 derived docs, 4 good + 3 bad examples, 4 language docs, full matrix, 3 review docs.
All 35 requirements covered. 7 patches (v0.0.0 pre-execution through v0.0.7 final). v0.0.7 IS the v0.1.0 milestone release.
2026-08-05 00:36:55 +00:00

2.9 KiB

Python — Language Application

How Atelier's domain principles apply in Python specifically. Derives from domains/ docs.

Type System (C1 Correctness, Data P7 Type Fidelity)

  • Type hints on every function: def get_user(id: UUID) -> User | None:.
  • mypy --strict or pyright in CI: type check is not optional.
  • No Any without justification: Any disables the type checker. Use object + narrowing.
  • Pydantic for runtime validation: schemas validate and type at the boundary.
from pydantic import BaseModel
from uuid import UUID

class UserCreate(BaseModel):
    email: str
    name: str
    # additionalProperties: false by default (extra='forbid')

Error Handling (Errors P1 Errors are Data)

  • Exceptions for exceptional cases, not control flow. raise not return None for errors.
  • Custom exception hierarchy:
class AppError(Exception): pass
class ValidationError(AppError): pass
class NotFoundError(AppError): pass
  • Never bare except:: except Exception as e: (catch specific, not everything).
  • Never except: pass: log and re-raise or handle, never swallow (Errors P2).

Async (Concurrency P7, P8)

  • asyncio for I/O-bound: async def, await. Not threads for I/O.
  • anyio for portability if you may switch runtimes (trio compatibility).
  • Timeout on every await: asyncio.wait_for(coro, timeout=5), not bare await.
  • Cancellation propagated: asyncio.CancelledError is not caught; it propagates.

Immutability (Concurrency P1)

  • frozen=True dataclasses for value objects:
from dataclasses import dataclass
@dataclass(frozen=True)
class UserId:
    value: str
  • Tuples over lists for fixed-length, immutable sequences.
  • No in-place mutation of shared state: return new objects.

Nullability (C1)

  • Optional[T] is T | None: explicit, must be checked.
  • None is not "not found": raise NotFoundError or return Result, not None.
  • assert is for invariants, not for runtime checks (stripped with -O).

Testing (Testing)

  • pytest with fixtures (factories, not shared state).
  • pytest --randomly to catch order-dependent tests (P2 Independence).
  • freezegun for time: no datetime.now() in tests; inject the clock.
  • factory_boy or pytest-factoryboy for realistic factories.

Observability (Observability P1)

  • structlog or python-json-logger: JSON logs, not print.
  • logging with structured formatter: every log has request_id, user_id, event.
  • No secrets in logs: mask_secret() helper, or structlog processors.

Tooling (DevOps P2)

  • ruff for lint + format: replaces flake8 + black + isort.
  • mypy --strict in CI: type check.
  • pip-tools or poetry for lockfile: pinned dependencies.
  • pip install --no-deps -r requirements.txt: reproducible install.