Skip to main content

Service layer base class with domain error hierarchy

Project description

csrd.service

Service-layer boilerplate for the CSRD pattern (Controller → Service → Repository / Delegate).

What it provides

Component Purpose
BaseService Lightweight base class with per-class logger and request-context accessors (current_user(), current_request_id())
ServiceError Base domain exception — keeps business logic free of HTTPException
NotFoundError 404 — resource doesn't exist
ConflictError 409 — duplicate, version mismatch, etc.
ValidationError 422 — business-rule validation (not schema validation)
AuthorizationError 403 — authenticated user lacks permission
DownstreamError 502 — a delegate call to another service failed
service_exception_handler FastAPI handler that maps any ServiceError → structured APIErrorResponse JSON

Dependency tier

Tier 1 (standalone)     csrd.models · csrd.lifespan · csrd.context
Tier 2 (uses Tier 1)    csrd.delegate · csrd.repository · csrd.service  ← NEW
Tier 3 (uses Tier 1+2)  csrd.versioning

csrd.service depends on csrd.context and csrd.models only. It does not import csrd.repository or csrd.delegate — your services accept those as constructor params.

Quick start

from csrd.service import BaseService, NotFoundError, DownstreamError


class OrderService(BaseService):
    def __init__(self, repo: OrderRepository, payments: PaymentsDelegate):
        super().__init__()
        self._repo = repo
        self._payments = payments

    async def get_order(self, order_id: int) -> Order:
        order = await self._repo.get_by_id(order_id)
        if order is None:
            raise NotFoundError("Order not found", detail=f"order_id={order_id}")
        return order

    async def place_order(self, cart: Cart) -> Order:
        order = await self._repo.create(cart)
        try:
            await self._payments.charge(order)
        except Exception as exc:
            raise DownstreamError("Payment failed", cause=exc) from exc
        return order

Register the exception handler

With csrd.versioning:

from csrd.service import ServiceError, service_exception_handler
from csrd.versioning import VersionedApiConfig

configure_versioned_api(
    app,
    version_mapping=VERSIONS,
    config=VersionedApiConfig(
        ex_handlers=[(ServiceError, service_exception_handler)],
    ),
)

Or on a plain FastAPI app:

app.add_exception_handler(ServiceError, service_exception_handler)

Wire into FastAPI DI

from functools import cache
from typing import Annotated
from fastapi import Depends

@cache
def order_service_factory(repo: OrderRepository, payments: PaymentsDelegate):
    return OrderService(repo, payments)

OrderServiceDep = Annotated[OrderService, Depends(order_service_factory)]

# In your endpoint:
@router.get("/orders/{order_id}")
async def get_order(service: OrderServiceDep, order_id: int):
    return await service.get_order(order_id)

Installation

uv add csrd-service  # or: pip install csrd-service

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

csrd_service-0.1.43.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

csrd_service-0.1.43-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file csrd_service-0.1.43.tar.gz.

File metadata

  • Download URL: csrd_service-0.1.43.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for csrd_service-0.1.43.tar.gz
Algorithm Hash digest
SHA256 b9370c57a295f4d15097c6297a33afc14f443ea2dd91b5f46d9680e750f90332
MD5 bfd39c4e516816b9891d3cc95be9abb2
BLAKE2b-256 445f704e304800dfa412bb095c6848e94f1ab0f6b2014b0e24a88823a2e397f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for csrd_service-0.1.43.tar.gz:

Publisher: release.yml on csrd-api/fastapi-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file csrd_service-0.1.43-py3-none-any.whl.

File metadata

  • Download URL: csrd_service-0.1.43-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for csrd_service-0.1.43-py3-none-any.whl
Algorithm Hash digest
SHA256 4493128e074e45efab8a4bec6b57db7dfbbdd399e7fe5af985db277301a89cb2
MD5 5c4049908759dde8308645faef670958
BLAKE2b-256 a51410d74bfd735a322346373a2cd1385d148fb5c6c65b098a021b5616cc46de

See more details on using hashes here.

Provenance

The following attestation bundles were made for csrd_service-0.1.43-py3-none-any.whl:

Publisher: release.yml on csrd-api/fastapi-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page