__init__.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# oc_chat/registry/__init__.py
 
# OCT-LINT: disable=tests_exist reason="Covered by oc_chat/tests/registry/test_storage_foundation.py"
"""
Public exports for the orchestration registry storage foundation.
 
Purpose
-------
Expose the small public surface shipped by M11.1a without importing any
unrelated command or workflow-engine code.
 
Responsibilities
----------------
- Re-export the clock contract and implementations.
- Re-export the Registry facade and operation-log/lock return types.
- Re-export the public domain mutation and reader APIs.
- Re-export storage backend types and the SQLite implementation.
- Re-export registry path discovery.
 
Diagnostics
-----------
Domain: OC_CHAT.MAIN
Levels:
    L2 - lifecycle events
    L3 - semantic details
    L4 - deep tracing
 
Contracts
---------
- This module is import-only and has no filesystem or database side effects.
- SQL ownership stays in :mod:`oc_chat.registry.backends.sqlite`.
 
Dependencies
------------
- oc_diagnostics (structured debug logging via _dbg)
- oc_chat.registry.api (re-exported Registry facade)
- oc_chat.registry.backends.base (re-exported storage backend contract, lock handle and operation-log row types)
- oc_chat.registry.backends.sqlite (re-exported SQLiteBackend implementation)
- oc_chat.registry.checkpoint (re-exported checkpoint export, import and write functions and signature error)
- oc_chat.registry.clock (re-exported Clock contract with real and fake clocks)
- oc_chat.registry.discovery (re-exported registry path discovery)
- oc_chat.registry.domain (re-exported plan and queue mutation functions)
- oc_chat.registry.errors (re-exported registry error types)
- oc_chat.registry.readers (re-exported status, plan, lifecycle, queue history and whoami readers)
- oc_chat.registry.render (re-exported render_all for registry-backed filesystem artefacts)
- oc_chat.registry.roadmap.operations (re-exported roadmap item, phase, section, plan-link and version mutations)
"""
from __future__ import annotations
 
from oc_diagnostics import _dbg
 
from oc_chat.registry.api import Registry
from oc_chat.registry.backends.base import (
    BackendCapabilityError,
    LockHandle,
    OperationLogRow,
    StorageBackend,
)
from oc_chat.registry.backends.sqlite import SQLiteBackend
from oc_chat.registry.clock import Clock, FakeClock, RealClock
from oc_chat.registry.checkpoint import (
    CheckpointSignatureError,
    export_checkpoint,
    import_checkpoint,
    write_checkpoint,
)
from oc_chat.registry.domain import (
    plan_assign,
    plan_create,
    plan_reimport,
    plan_set_status,
    plan_supersede,
    queue_complete,
    queue_dequeue,
    queue_enqueue,
    queue_move,
)
from oc_chat.registry.discovery import discover_registry_path
from oc_chat.registry.errors import (
    ActorTypeMismatchError,
    LockHeldError,
    LockOwnerError,
    ParentCycleError,
    PayloadSchemaViolationError,
    PayloadVersionMismatchError,
    RegistryError,
    UnknownActorError,
)
from oc_chat.registry.readers import (
    current_status,
    plan_lifecycle,
    queue_history,
    show_plan,
    whoami,
)
from oc_chat.registry.roadmap.operations import (
    roadmap_item_add_dependency,
    roadmap_item_create,
    roadmap_item_set_status,
    roadmap_phase_complete,
    roadmap_plan_link_create,
    roadmap_section_upsert,
    roadmap_version_bump,
)
from oc_chat.registry.render import render_all
 
_dbg("OC_CHAT.MAIN", "module", "loaded", 4)
 
__all__ = [
    "BackendCapabilityError",
    "Clock",
    "FakeClock",
    "LockHandle",
    "OperationLogRow",
    "Registry",
    "RegistryError",
    "RealClock",
    "SQLiteBackend",
    "StorageBackend",
    "ActorTypeMismatchError",
    "CheckpointSignatureError",
    "LockHeldError",
    "LockOwnerError",
    "ParentCycleError",
    "PayloadSchemaViolationError",
    "PayloadVersionMismatchError",
    "UnknownActorError",
    "discover_registry_path",
    "export_checkpoint",
    "import_checkpoint",
    "plan_assign",
    "plan_create",
    "plan_reimport",
    "plan_set_status",
    "plan_supersede",
    "queue_complete",
    "queue_dequeue",
    "queue_enqueue",
    "queue_move",
    "current_status",
    "plan_lifecycle",
    "queue_history",
    "roadmap_item_add_dependency",
    "roadmap_item_create",
    "roadmap_item_set_status",
    "roadmap_phase_complete",
    "roadmap_plan_link_create",
    "roadmap_section_upsert",
    "roadmap_version_bump",
    "show_plan",
    "whoami",
    "render_all",
    "write_checkpoint",
]