Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

2.8 KB
Raw Blame
"""
Capability Protocol
===================

Base class for the Capability layer (Level 2).
Capabilities are multi-step agent pipelines invoked when the user selects
a deep mode (e.g. Deep Solve, Deep Question).
"""

from __future__ import annotations

from abc import ABC, abstractmethod
from contextlib import AbstractAsyncContextManager
from dataclasses import dataclass, field
from typing import Any, Protocol

from .context import UnifiedContext
from .stream import StreamEvent


class CapabilityPrerequisiteError(ValueError):
    """A required capability precondition failed; never bypass it by forced finish."""


class StreamBusProtocol(Protocol):
    """Minimal output port required by a turn capability."""

    async def emit(self, event: StreamEvent) -> None: ...

    def stage(self, name: str, *, source: str = "") -> AbstractAsyncContextManager[None]: ...


@dataclass
class CapabilityManifest:
    """Static metadata for a capability."""

    name: str
    description: str
    stages: list[str] = field(default_factory=list)
    tools_used: list[str] = field(default_factory=list)
    cli_aliases: list[str] = field(default_factory=list)
    request_schema: dict[str, Any] = field(default_factory=dict)
    config_defaults: dict[str, Any] = field(default_factory=dict)


class TurnCapability(ABC):
    """
    Abstract base for all capabilities (deep modes).

    Subclasses must provide ``manifest`` and implement ``run``.

    Example::

        class MySolverCapability(TurnCapability):
            manifest = CapabilityManifest(
                name="deep_solve",
                description="Multi-agent problem solving.",
                stages=["planning", "reasoning", "writing"],
                tools_used=["rag", "web_search", "exec"],
            )

            async def run(self, context, stream):
                async with stream.stage("planning", source=self.manifest.name):
                    plan = await self._plan(context)
                ...
    """

    manifest: CapabilityManifest

    @abstractmethod
    async def run(self, context: UnifiedContext, stream: StreamBusProtocol) -> None:
        """Execute the full capability pipeline, emitting events to *stream*."""
        ...

    @property
    def name(self) -> str:
        return self.manifest.name

    @property
    def stages(self) -> list[str]:
        return self.manifest.stages


def __getattr__(name: str):
    if name == "BaseCapability":
        import warnings

        warnings.warn(
            "BaseCapability is deprecated; use TurnCapability. It will be removed in v3.",
            DeprecationWarning,
            stacklevel=2,
        )
        return TurnCapability
    raise AttributeError(name)


__all__ = [
    "CapabilityPrerequisiteError",
    "CapabilityManifest",
    "StreamBusProtocol",
    "TurnCapability",
]