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.41.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.41-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: csrd_service-0.1.41.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.41.tar.gz
Algorithm Hash digest
SHA256 afa2aad069e62f1578b001a71fafa9813be762bca663bbb71f0a67adfcfb5219
MD5 bacd6e14faaadd55ad07223f0b000fa4
BLAKE2b-256 1b13039ad5e34fc6f5d69a00401b1dbdc479383b7f0b3a871ad1d0adc5864c0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for csrd_service-0.1.41.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.41-py3-none-any.whl.

File metadata

  • Download URL: csrd_service-0.1.41-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.41-py3-none-any.whl
Algorithm Hash digest
SHA256 e11befe2c5165b884820142c5f02c4cd58f4a915631309c57c002d62bf37a2bd
MD5 541e53f690fa966369ab171b7193d2b3
BLAKE2b-256 3abc19f00a5788745830ab5c546b55f9d445982cd9b26b9cf461b85a1356cd62

See more details on using hashes here.

Provenance

The following attestation bundles were made for csrd_service-0.1.41-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