mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-29 19:35:20 +02:00
f0e00bd3ee
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%).
28 lines
969 B
Python
28 lines
969 B
Python
"""``PlanStep`` — one step in the sequential plan."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
|
|
class PlanStep(BaseModel):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
step_id: str = Field(..., min_length=1, description="Unique within the plan.")
|
|
action: str = Field(..., min_length=1, description="Action type; resolved via registry.")
|
|
when: str | None = Field(
|
|
default=None,
|
|
description="Optional Jinja expression; step is skipped when falsy.",
|
|
)
|
|
config: dict[str, Any] = Field(
|
|
default_factory=dict,
|
|
description="Action-type-specific config; Jinja-rendered at execute time.",
|
|
)
|
|
output_as: str | None = Field(
|
|
default=None,
|
|
description="Bind step output under this name. Defaults to step_id.",
|
|
)
|
|
max_retries: int | None = Field(default=None, ge=0)
|
|
timeout_seconds: int | None = Field(default=None, gt=0)
|