generated from john/python-template
zoltan57
97b3d0fd62
Removes the duplicated registry CRUD, the hand-written not-found raises, and the three divergent media writers. Behavior is preserved: every existing Document Type and Person Role test passes unchanged, which is the primary proof for MED-11. [MED-11] Generic registry service - New services/registry.py owns RegistryService[ModelT]: list, list with counts, create with IntegrityError -> conflict mapping, read, update, delete with built-in and referenced guards, is_referenced, and label normalization/casefold keying. - DocumentTypeRegistry and PersonRoleRegistry declare only the model, error class, noun, short noun, retainer phrase, and reference columns. - DocumentService and PeopleService keep their public method names and delegate. Every user-facing message, error category, and suggestion string is reproduced verbatim; only the noun is templated. - Deleted _normalize_registry_label, _document_type_label_key, _normalize_role_label, _person_role_label_key, _document_type_is_referenced, and _person_role_is_referenced. [MED-12] Shared not-found lookup - ServiceBase._get_or_raise(model, id, *, session, error, noun, suggestion, options) loads by primary key or raises the caller's error type. - documents.py: local _get_document_or_raise deleted; replaced by _read_document and adopted at read_document, delete_document, and set_document_type, which previously bypassed the helper and hand-wrote the raise. - sources.py: 8 identical Source raises and 1 Job raise collapsed into _read_source / _get_or_raise. - jobs.py and people.py already funneled through local _not_found builders and were left alone. [MED-13][MED-01] Single media writer - New services/media_storage.py owns validate -> name -> mkdir -> write -> wrap OSError. The write runs in asyncio.to_thread, so uploads no longer block the event loop. - store_source_file, store_person_portrait, and store_homepage_image now share it and are async. Callers in store.py, people_page.py, and home_page.py await them. mkdir failures are now also translated to a domain error instead of escaping as a raw OSError. - homepage_store gains HomepageStorageError so its write reports like the others. [MED-14, partial] Service independence - New services/source_media.py owns SOURCE_MIME_TYPES, SOURCE_EXTENSIONS, lookup_source_mime_type, and supported_source_formats. - documents.py no longer imports services/sources.py. Its print projection uses the non-raising lookup and raises DocumentError, so DocumentService no longer emits a TranscriptionError. - api/v4_print.py imports the mapping from the policy module. - store.py and workflows.py still import sources.py; both are orchestration modules, which services.instructions.md:75-77 explicitly permits. - Splitting SourceService itself remains deferred to V4.7. [LOW-08] Query shape - list_sources_detail filters job_id with a JOIN on JobSource instead of loading every Source and filtering in Python. - read_source_navigation replaces the full ordered-id scan and .index() with two row-value comparisons bounded by LIMIT 1. - list_processing_artifacts gains the limit parameter its summary sibling already had. - build_evidence_export runs artifact integrity hashing and file reads through asyncio.to_thread. Tests - tests/test_service_boundaries.py: AST guard asserting no service module imports a sibling service module, plus a guard that the scan is non-empty. - tests/services/test_transcription_service.py: asserts the job_id filter emits a JOIN, and that navigation emits exactly two LIMIT queries. - tests/services/test_store.py: the two storage tests are now async. Verified: 276 passed, 4 skipped; ruff check clean.
85 lines
2.7 KiB
Python
85 lines
2.7 KiB
Python
from abc import ABC
|
|
from collections.abc import Sequence
|
|
from contextlib import asynccontextmanager
|
|
from typing import Any
|
|
|
|
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
|
|
from ..config import Settings
|
|
from ..config import get_settings
|
|
from ..db.session import resolve_session_factory
|
|
from ..db.session import session_scope
|
|
from ..errors import AppError
|
|
from ..errors import ErrorCategory
|
|
|
|
|
|
class ServiceBase(ABC):
|
|
"""Thin service class for managing documents in the database."""
|
|
|
|
settings: Settings
|
|
session_factory: async_sessionmaker[AsyncSession]
|
|
|
|
def __init__(
|
|
self,
|
|
session_factory: async_sessionmaker[AsyncSession] | None = None,
|
|
settings: Settings | None = None,
|
|
):
|
|
self.settings = settings or get_settings()
|
|
self.session_factory = session_factory or resolve_session_factory(settings=self.settings)
|
|
|
|
@asynccontextmanager
|
|
async def _session_scope(self, session: AsyncSession | None = None):
|
|
"""Provide a transactional scope around a series of operations."""
|
|
async with session_scope(
|
|
session_factory=self.session_factory,
|
|
session=session,
|
|
) as active_session:
|
|
yield active_session
|
|
|
|
async def _finalize(
|
|
self,
|
|
*,
|
|
session: AsyncSession,
|
|
caller_session: AsyncSession | None,
|
|
refresh: Sequence[object] = (),
|
|
) -> None:
|
|
"""Finalize a write based on transaction ownership.
|
|
|
|
Service-owned sessions commit immediately. Caller-owned sessions flush so
|
|
orchestration code can commit once at a larger transaction boundary.
|
|
"""
|
|
should_commit = caller_session is None
|
|
if should_commit:
|
|
await session.commit()
|
|
else:
|
|
await session.flush()
|
|
|
|
for obj in refresh:
|
|
await session.refresh(obj)
|
|
|
|
async def _get_or_raise[ModelT](
|
|
self,
|
|
model: type[ModelT],
|
|
entity_id: object,
|
|
*,
|
|
session: AsyncSession,
|
|
error: type[AppError],
|
|
noun: str,
|
|
suggestion: str,
|
|
options: Sequence[Any] = (),
|
|
) -> ModelT:
|
|
"""Load an entity by primary key or raise a not-found service error.
|
|
|
|
``noun`` and ``suggestion`` are supplied by the caller so each domain
|
|
keeps its own user-facing wording.
|
|
"""
|
|
entity = await session.get(model, entity_id, options=list(options) or None)
|
|
if entity is None:
|
|
raise error(
|
|
f"{noun} with id {entity_id} not found",
|
|
category=ErrorCategory.NOT_FOUND,
|
|
suggestion=suggestion,
|
|
)
|
|
return entity
|