mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-31 19:45:15 +02:00
chore(automation): trim docstrings to intent only
Cut the docstrings and Field(description=...) text across the entire automations/ tree down to single-line intent statements, matching the multi_agent_chat conciseness style: - Module docstrings: one line stating what the file is. - Class docstrings: deleted when the class name + module docstring already cover intent; kept only where they add a constraint or rationale not visible in the signature. - Pydantic Field descriptions: short noun phrases / clauses, not full sentences. Reasoning that belonged in the design plan moved out of the code. - Enum values: per-value docstrings replaced with terse inline comments where the meaning isn't obvious from the name. Behaviour is unchanged. The same 33 files, same public surface, same imports — verified by re-running the 10-point registry smoke test and the 8-point schema round-trip / constraint suite from commits 9 and 10. LOC: 1180 → 691 (-42%).
This commit is contained in:
parent
7a96c0e29c
commit
f0e00bd3ee
33 changed files with 80 additions and 568 deletions
|
|
@ -1,4 +1,4 @@
|
|||
"""Action registry: ``types.py`` (dataclass), ``store.py`` (dict + register fn)."""
|
||||
"""Action registry."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
"""Action registry: in-memory dict + ``register_action`` API."""
|
||||
"""In-memory action registry. Populated once at process startup."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
|
|
@ -8,26 +8,16 @@ _REGISTRY: dict[str, ActionDefinition] = {}
|
|||
|
||||
|
||||
def register_action(action: ActionDefinition) -> None:
|
||||
"""Add an action to the in-memory registry.
|
||||
|
||||
Raises ``ValueError`` on duplicate ``type`` — registration runs
|
||||
once per process, so a duplicate is always a bug.
|
||||
"""
|
||||
|
||||
"""Register an action. Raises on duplicate type."""
|
||||
if action.type in _REGISTRY:
|
||||
raise ValueError(
|
||||
f"Action already registered: {action.type!r}"
|
||||
)
|
||||
raise ValueError(f"Action already registered: {action.type!r}")
|
||||
_REGISTRY[action.type] = action
|
||||
|
||||
|
||||
def get_action(action_type: str) -> ActionDefinition | None:
|
||||
"""Look up one action by type. Returns ``None`` on miss."""
|
||||
|
||||
return _REGISTRY.get(action_type)
|
||||
|
||||
|
||||
def all_actions() -> dict[str, ActionDefinition]:
|
||||
"""Snapshot of the registry as a defensive copy."""
|
||||
|
||||
"""Defensive snapshot of the registry."""
|
||||
return dict(_REGISTRY)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
"""``ActionDefinition`` dataclass — the v1-minimum action shape."""
|
||||
"""``ActionDefinition`` dataclass and handler signature."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
|
|
@ -7,36 +7,10 @@ from dataclasses import dataclass
|
|||
from typing import Any
|
||||
|
||||
ActionHandler = Callable[[dict[str, Any]], Awaitable[Any]]
|
||||
"""The signature every action handler must satisfy.
|
||||
|
||||
Identical in shape to ``CapabilityHandler`` — both receive a
|
||||
caller-validated input dict and return an arbitrary output. The
|
||||
distinction is purely architectural: capabilities are the low-level
|
||||
"what SurfSense can do" surface, actions are the user-facing
|
||||
building blocks composed into a plan.
|
||||
"""
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class ActionDefinition:
|
||||
"""A user-facing step type the plan editor can compose.
|
||||
|
||||
v1 trims the dataclass to the five fields necessary for
|
||||
registry dispatch and form rendering. The full design (§4)
|
||||
includes ``output_contract``, ``uses_capabilities``, and
|
||||
``produces_artifacts``; all three are deferred until a consumer
|
||||
feature requires them:
|
||||
|
||||
- ``output_contract`` — the loose ``agent_task`` action declares
|
||||
its output shape per-step via ``config.output_schema``, so the
|
||||
action-level contract is not needed in v1.
|
||||
- ``uses_capabilities`` — would let the NL generator do static
|
||||
analysis of which capabilities each action invokes; deferred
|
||||
because v1 ships a single (``agent_task``) action.
|
||||
- ``produces_artifacts`` — deferred alongside the artifact
|
||||
pipeline (see §13 decision 26).
|
||||
"""
|
||||
|
||||
type: str
|
||||
name: str
|
||||
description: str
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue