python-clean-architecture

name	Python Clean Architecture
description	This skill should be used when the user asks to "scaffold a FastAPI project", "set up clean architecture", "refactor to clean architecture", "add a new endpoint", "add a router", "add an operation", "add a repository", "review my code structure", "apply design patterns in Python", "decouple my code", "improve code quality", "make my code testable", or mentions layered architecture, dependency injection, Protocol-based design, or Pythonic design patterns for Python/FastAPI projects.
version	0.9.0

Python Clean Architecture

Provide Clean Architecture guidance for Python projects, specifically FastAPI APIs. Based on seven core design principles, Pythonic implementations of classic patterns, and a three-layer architecture (Routers → Operations → Database).

Attribution: The principles, patterns, and architectural approach in this skill are inspired by and synthesized from Arjan Codes' courses: The Software Designer Mindset, Pythonic Patterns, and Complete Extension. The specific Pythonic framing (Protocol-based DI, functional pattern progression, three-layer FastAPI architecture) originates from his teaching. This plugin distills those principles into actionable guidance for Claude Code — it is not a reproduction of course content. See also: github.com/arjancodes | youtube.com/arjancodes.

When to Apply

• Scaffolding new FastAPI projects with clean separation of concerns
• Refactoring existing Python code to reduce coupling and increase cohesion
• Adding new components (endpoints, operations, repositories, models)
• Reviewing code for design quality and Pythonic idiom adherence
• Making code testable through dependency injection and Protocol-based abstractions

Core Architecture: Three Layers

Every FastAPI project follows a strict three-layer dependency flow:

Routers (API layer)  →  Operations (business logic)  →  Database (persistence)

Each layer depends ONLY on the layer below it. Never skip layers.

Layer Responsibilities

Routers — HTTP interface. Accept requests, call operations, return responses. No business logic. Act as the composition root where concrete implementations are injected.

Operations — Business logic. Accept a DataInterface (Protocol) parameter for data access. Compute derived values, enforce rules, orchestrate workflows. Never import database modules directly.

Database — Persistence. Implement the DataInterface Protocol using SQLAlchemy, file storage, or any backend. Expose read_by_id, read_all, create, update, delete methods. Return DataObject = dict[str, Any] to decouple from ORM models.

The DataInterface Protocol

from typing import Any, Protocol

DataObject = dict[str, Any]

class DataInterface(Protocol):
    def read_by_id(self, id: str) -> DataObject: ...
    def read_all(self) -> list[DataObject]: ...
    def create(self, data: DataObject) -> DataObject: ...
    def update(self, id: str, data: DataObject) -> DataObject: ...
    def delete(self, id: str) -> None: ...

Operations accept data_interface: DataInterface as a parameter. The router passes the concrete implementation. This is dependency injection — no ABC inheritance needed.

Pydantic Models

Define separate Create and Read models per entity:

class CustomerCreate(BaseModel):
    name: str
    email: str

class Customer(BaseModel):
    id: str
    name: str
    email: str

Use **data.model_dump() to unpack Pydantic models into DataObject dicts. Use exclude_none=True on update models for partial updates.

Seven Design Principles

When writing or reviewing code, apply these principles in order of priority:

1. High Cohesion — Each class/function has a single responsibility. Extract class when a class does two things. Extract function when a function does two things.
2. Low Coupling — Minimize dependencies. Move methods to the class that owns the data (Information Expert). Pass only what a function needs.
3. Depend on Abstractions — Use Protocol for structural typing and Callable type aliases for function injection. Patterns emerge from good abstraction.
4. Composition over Inheritance — Extract shared behavior into standalone classes with a Protocol interface. Use list[PaymentSource] patterns. Never use mixins.
5. Separate Creation from Use — One composition root (the router or main function). Dictionary mapping over if/elif chains. Creator functions for complex construction.
6. Start with the Data — Fix data structures first; methods and layers follow. Extract domain classes from prefixed fields. Eliminate parallel lists.
7. Keep Things Simple — DRY (but avoid hasty abstractions). KISS (simplest design that works). YAGNI (implement only what is needed now).

Pythonic Pattern Selection

When encountering these code smells, apply the corresponding pattern:

Code Smell	Pattern	Pythonic Implementation
Long if/elif switching behavior	Strategy	Callable type alias, pass functions as args
Need to create objects from config/JSON	Registry	dict[str, Callable] mapping + **kwargs unpacking
Event/notification side effects mixed with core logic	Notification (Pub/Sub)	subscribe(event, handler) / post_event(event, data) dict-based
Duplicated algorithm across classes	Template Method	Extract to free function + Protocol parameter
Two independent hierarchies that vary	Bridge	Callable type alias replaces abstract reference
Need undo/batch/queue operations	Command	Functions returning undo closures
Object creation coupled to usage	Abstract Factory	Tuples of functions + functools.partial
Sequential data transformations	Pipeline	functools.reduce for composition, or framework .pipe()
Need to react to events without coupling	Callback	Function passed as argument, called when event occurs
Reusing a function with a different interface	Function Wrapper	Calls another function, translates its arguments
Separating configuration from usage	Function Builder	Higher-order function returns a configured function
Bare primitives for domain concepts (prices, emails)	Value Objects	Subclass built-in types with __new__ validation, or frozen dataclass
Need audit trail, temporal queries, or event replay	Event Sourcing	Immutable Event[T], append-only EventStore[T], projection functions
Read/write patterns diverge; list views compute derived fields	CQRS	Separate write model + read projection, projector function after writes
Complex object with many optional parts	Builder	Fluent API with Self return type, .build() returns frozen product
Multiple DB writes that must succeed or fail together	Unit of Work	Context manager wrapping transaction: commit on success, rollback on error
Need exactly one instance of a shared resource	Singleton	Module-level instance (preferred), or metaclass with _instances dict
Object behaves differently depending on internal state	State	Protocol-based state objects, context delegates to current state
Incompatible interface from external library	Adapter	Protocol interface + functools.partial for single-method adaptation
Client coupled to complex subsystem details	Facade	Simplified interface class, functools.partial to bind dependencies
Transient failures in external API/DB calls	Retry	@retry decorator with exponential backoff, fallback strategies
Slow startup loading unused resources	Lazy Loading	functools.cache, TTL cache, generators, background preloading
Data access logic mixed into domain classes	Repository	Protocol interface for CRUD, concrete implementations per backend
Sequential operations on an object are verbose and error-prone	Fluent Interface	Methods return self for chaining, domain-specific verbs
Need extensibility without modifying core code	Plugin Architecture	Config-driven creation, importlib auto-discovery, self-registering modules

Default preferences for all patterns:

• Protocol over ABC — unless shared state in the superclass is needed
• functools.partial — to configure generic functions rather than creating wrapper classes
• Closures — to separate configuration-time args from runtime args
• Don't go full functional — find the happy medium; readability is the ultimate arbiter

Scaffolding a New Project

When asked to create a new FastAPI project, generate this structure:

project_name/
├── main.py                    # FastAPI app, include_router, lifespan handler
├── routers/
│   ├── __init__.py
│   └── {entity}.py            # APIRouter, endpoint functions
├── operations/
│   ├── __init__.py
│   ├── interface.py           # DataInterface Protocol + DataInterfaceStub
│   └── {entity}.py            # Business logic functions
├── db/
│   ├── __init__.py
│   ├── database.py            # Engine, SessionLocal, Base
│   ├── db_interface.py        # Generic DBInterface class
│   └── models.py              # SQLAlchemy models
├── models/
│   ├── __init__.py
│   └── {entity}.py            # Pydantic Create/Read models
├── tests/
│   └── test_{entity}.py       # Tests using DataInterfaceStub
├── requirements.txt
└── .gitignore

Testing Strategy

Create a DataInterfaceStub base class that stores data in a plain dict. Override specific methods in test-specific subclasses. Pass the stub to operations functions — no database needed.

from typing import Any

DataObject = dict[str, Any]

class DataInterfaceStub:
    def __init__(self):
        self.data: dict[str, DataObject] = {}
    def read_by_id(self, id: str) -> DataObject:
        if id not in self.data:
            raise KeyError(f"Not found: {id}")
        return self.data[id]
    def read_all(self) -> list[DataObject]:
        return list(self.data.values())
    def create(self, data: DataObject) -> DataObject:
        self.data[data["id"]] = data
        return data
    def update(self, id: str, data: DataObject) -> DataObject:
        if id not in self.data:
            raise KeyError(f"Not found: {id}")
        self.data[id].update(data)
        return self.data[id]
    def delete(self, id: str) -> None:
        if id not in self.data:
            raise KeyError(f"Not found: {id}")
        del self.data[id]

Additional Resources

Reference Files

For detailed guidance beyond this overview, consult:

Architecture & Design:

• references/design-principles.md — Full treatment of the seven design principles with refactoring recipes and code examples
• references/grasp-principles.md — GRASP principles: Creator, Information Expert, Controller, Low Coupling, High Cohesion, Polymorphism, Indirection, Protected Variations, Pure Fabrication
• references/domain-driven-design.md — Domain-Driven Design: domain models, ubiquitous language, model distillation, code as temporary expression
• references/layered-architecture.md — Detailed three-layer architecture guide: DataInterface (Repository pattern), DBInterface, router composition, Pydantic models, to_dict utility
• references/testable-api.md — Testing strategy: stub-based testing, DataInterfaceStub, test isolation, no-database testing
• references/testing-advanced.md — Pytest organization, property-based testing (Hypothesis), model-based stateful testing, code coverage philosophy
• references/rest-api-design.md — HTTP method semantics, status codes, resource naming, pagination, error response format, OpenAPI, versioning

Python Fundamentals:

• references/classes-and-dataclasses.md — When to use classes vs dataclasses, @dataclass, field(), frozen, encapsulation
• references/function-design.md — Pure functions, higher-order functions, closures, functools.partial, classes vs functions vs modules
• references/data-structures.md — Choosing list vs dict vs tuple vs set, enums, performance trade-offs
• references/types-and-type-hints.md — Python's type system, Callable types, nominal vs structural typing, best practices
• references/error-handling.md — Custom exceptions, context managers, error handling layers, anti-patterns
• references/code-quality.md — 22 code quality rules: naming, nesting, flags, type abuse, isinstance dispatch, overloaded classes, and code review checklist
• references/project-organization.md — Modules, packages, imports, folder structure, avoid "utils" anti-pattern
• references/context-managers.md — Context manager protocol, __enter__/__exit__, @contextmanager, ExitStack, async context managers
• references/decorators.md — Decorator patterns: retry with backoff, logging, timing, functools.wraps, parameterized decorators
• references/async-patterns.md — Async/await for FastAPI: coroutines, asyncio.gather, TaskGroup, async context managers, async generators, async DataInterface
• references/pydantic-validation.md — Pydantic v2 validators: @field_validator, @model_validator, Field() constraints, ConfigDict, serializers, special types
• references/pattern-matching.md — Structural pattern matching (match/case): literal, capture, OR, sequence, class, mapping patterns, guard clauses

Pythonic Patterns:

• references/pythonic-patterns.md — Quick reference lookup table for all 25 patterns (use for reviews and pattern selection)

Pythonic Patterns (full progressions from OOP → functional):

• references/patterns/strategy.md — Callable type alias, closures, functools.partial
• references/patterns/abstract-factory.md — Tuples of functions, partial, builder functions
• references/patterns/bridge.md — Bound methods as callables, when to stop going functional
• references/patterns/command.md — Functions returning undo closures, batch via list comprehension
• references/patterns/notification.md — Observer, Mediator, and Pub/Sub with dict-based subscribe/post_event
• references/patterns/registry.md — Dict mapping + **kwargs unpacking, self-registering plugins via importlib
• references/patterns/template-method.md — Free function + Protocol parameters, protocol segregation
• references/patterns/pipeline.md — Chain of Responsibility, functools.reduce composition, pandas .pipe()
• references/patterns/functional.md — Callback, Function Wrapper, Function Builder patterns
• references/patterns/retry.md — Exponential backoff, @retry decorator, fallback strategies, tenacity library
• references/patterns/lazy-loading.md — functools.cache, TTL cache, generators, background preloading
• references/patterns/plugin-architecture.md — Config-driven plugins, importlib auto-discovery, self-registering modules, Protocol conformance

Architectural & Domain Patterns:

• references/patterns/repository.md — Repository pattern: separating data storage from data access, relationship to DataInterface
• references/patterns/fluent-interface.md — Method chaining with return self, domain-specific verbs, when to use vs Builder
• references/patterns/value-objects.md — Wrapping primitives in validated domain types: Price, Percentage, EmailAddress
• references/patterns/event-sourcing.md — Immutable events, EventStore[T], projections, cache invalidation
• references/patterns/cqrs.md — Separate read/write models, command handlers, projector functions
• references/patterns/builder.md — Fluent API with Self return type, mutable builder to immutable product
• references/patterns/unit-of-work.md — Transaction context managers, automatic rollback, repository composition
• references/patterns/singleton.md — Module-level instance (preferred), metaclass approach, thread safety
• references/patterns/state.md — Protocol-based state objects, context delegation, state transitions
• references/patterns/adapter.md — Object adapter (composition), function adapter (partial), Protocol interface
• references/patterns/facade.md — Simplified interface to complex subsystems, partial for controller binding

Advanced Error Handling:

• references/monadic-error-handling.md — Railway-oriented programming: Result types, @safe decorator, flow()/bind() composition (functional alternative to exceptions)

Example Files

• examples/fastapi-hotel-api/ — Complete working FastAPI project demonstrating all patterns: rooms and bookings with computed prices

Intentional Upgrades from Source Transcript

The example code applies the same architectural principles taught in the Arjan Codes course but modernizes several implementation details. Each file documents its specific upgrades in its module docstring. Summary of deliberate changes:

Category	Transcript (original)	Example (upgraded)	Rationale
IDs	Integer, autoincrement	String UUID (uuid.uuid4())	App-generated, portable across databases
SQLAlchemy	Legacy 1.x (declarative_base(), session.query())	2.0 style (DeclarativeBase, session.get(), select())	Current best practice, forward-compatible
Pydantic models	@dataclass + raw dicts	BaseModel with Create/Update/Read variants	FastAPI native, automatic validation & serialization
Startup	@app.on_event("startup")	lifespan context manager	on_event is deprecated in modern FastAPI
Test framework	unittest.TestCase	pytest functions	Simpler, more Pythonic, industry standard
Stub pattern	NotImplementedError base, subclass per test	Full in-memory dict implementation	Directly usable without boilerplate subclasses
Error handling	None (silent None returns)	KeyError + HTTPException(404)	Production-ready error responses
Router config	Bare APIRouter()	prefix=, tags=, response_model, status codes	OpenAPI docs, proper HTTP semantics
Customer model	first_name/last_name/email_address	name/email	Simplified for example clarity
Table names	Singular ("room")	Plural ("rooms")	SQL naming convention
Session mgmt	Global db_session in DBInterface	Injected via constructor parameter	Better dependency injection
Package	hotel.* top-level package	Flat imports	Standalone example clarity

The core architecture (three-layer separation, DataInterface Protocol, dependency injection via router composition root, operations decoupled from database) is faithfully preserved.