__init__.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# oc_chat/registry/render/__init__.py
 
# OCT-LINT: disable=tests_exist reason="Covered by oc_chat/tests/registry/test_render_determinism.py and test_sync_cli.py"
"""
Registry render orchestration.
 
Purpose
-------
Expose the public `render_all` orchestration entry point for registry-backed
filesystem artifacts.
 
Responsibilities
----------------
- Dispatch to each artifact renderer in a deterministic order.
- Apply shared `prefer_local`, `dry_run`, and artifact filtering options.
- Return an aggregate `RenderReport` for CLI and doctor consumers.
 
Diagnostics
-----------
Domain: OC_CHAT.MAIN
Levels:
    L2 - render-all lifecycle events
    L3 - artifact selection details
    L4 - per-artifact dispatch tracing
 
Contracts
---------
- `render_all` mutates files only through artifact writers.
- Registry state is read-only during rendering.
 
Dependencies
------------
- oc_diagnostics (structured debug logging via _dbg)
- oc_chat.registry.api (Registry facade the artifacts are rendered from)
- oc_chat.registry.render._common (RenderReport, RenderResult and the worktree plan rows)
- oc_chat.registry.render.plan_header (plan header artifact writer)
- oc_chat.registry.render.plan_status (plan status artifact writer)
"""
from __future__ import annotations
 
from pathlib import Path
from typing import Iterable
 
from oc_diagnostics import _dbg
 
from oc_chat.registry.api import Registry
from oc_chat.registry.render._common import (
    RenderReport,
    RenderResult,
    iter_worktree_plans,
)
from oc_chat.registry.render.plan_header import write_plan_header
from oc_chat.registry.render.plan_status import write_plan_status
 
# The legacy versioned roadmap artifacts are retired (Plan 142 cutover): the living
# set is rendered by `oc_chat.registry.roadmap render` (write_living_set), NOT by
# render_all. ``ROADMAP_ARTIFACTS`` was empty, so the old render_all roadmap branch
# was dead — removed here.
#
# The ``agent_queue`` and ``launch_prompt`` artifacts retired with the queue
# machinery (plan 223 P3, design §4.8). The first re-materialised the Markdown
# queue that is now archived history; the second wrote the slot-named
# ``.oc_chat/launch/agent-<x>.md`` files whose staleness was the F33
# duplicate-launch failure class. Launch files are rendered per PLAN by
# ``plan_manage dispatch`` from the one committed template, and the pool is a
# registry view (``plan_manage agents active``), not a rendered file.
 
_dbg("OC_CHAT.MAIN", "module", "loaded", 4)
 
DEFAULT_ARTIFACTS = frozenset({"plan_status", "plan_header"})
ALL_ARTIFACTS = DEFAULT_ARTIFACTS
 
 
def render_all(
    registry: Registry,
    *,
    target_root: Path,
    prefer_local: bool = False,
    dry_run: bool = False,
    artifacts: Iterable[str] | None = None,
) -> RenderReport:
    """Render all requested registry-backed filesystem artifacts."""
 
    selected = set(DEFAULT_ARTIFACTS if artifacts is None else artifacts)
    results: list[RenderResult] = []
    worktree_rows = list(iter_worktree_plans(registry))
    if "plan_status" in selected:
        for row in worktree_rows:
            worktree = row.get("worktree")
            if worktree:
                results.append(
                    write_plan_status(
                        registry,
                        worktree=Path(str(worktree)),
                        prefer_local=prefer_local,
                        dry_run=dry_run,
                    )
                )
    if "plan_header" in selected:
        for row in worktree_rows:
            body_path = row.get("body_path")
            if body_path:
                results.append(
                    write_plan_header(
                        registry,
                        plan_id=str(row["plan_id"]),
                        plan_file=target_root / str(body_path),
                        prefer_local=prefer_local,
                        dry_run=dry_run,
                    )
                )
    return RenderReport(tuple(results))
 
 
__all__ = [
    "DEFAULT_ARTIFACTS",
    "ALL_ARTIFACTS",
    "RenderReport",
    "RenderResult",
    "render_all",
]