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%).
26 lines
933 B
Python
26 lines
933 B
Python
"""``AutomationDefinition`` — top-level envelope persisted in ``automations.definition``."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
from .execution import ExecutionBlock
|
|
from .inputs import InputsBlock
|
|
from .metadata import MetadataBlock
|
|
from .plan_step import PlanStep
|
|
from .trigger_spec import TriggerSpec
|
|
|
|
|
|
class AutomationDefinition(BaseModel):
|
|
"""Top-level shape of an automation. See automation-design-plan.md §5."""
|
|
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
schema_version: str = "1.0"
|
|
name: str = Field(..., min_length=1, max_length=200)
|
|
goal: str | None = None
|
|
inputs: InputsBlock | None = None
|
|
triggers: list[TriggerSpec] = Field(default_factory=list)
|
|
plan: list[PlanStep] = Field(..., min_length=1)
|
|
execution: ExecutionBlock = Field(default_factory=ExecutionBlock)
|
|
metadata: MetadataBlock = Field(default_factory=MetadataBlock)
|