SurfSense/surfsense_backend/app/automations/persistence/models/run.py
CREDO23 f0e00bd3ee 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%).
2026-05-26 23:01:22 +02:00

58 lines
1.6 KiB
Python

"""``automation_runs`` table — immutable per-fire execution record."""
from __future__ import annotations
from sqlalchemy import (
TIMESTAMP,
Column,
Enum as SQLAlchemyEnum,
ForeignKey,
Integer,
String,
)
from sqlalchemy.dialects.postgresql import JSONB
from app.db import BaseModel, TimestampMixin
from ..enums.run_status import RunStatus
class AutomationRun(BaseModel, TimestampMixin):
__tablename__ = "automation_runs"
automation_id = Column(
Integer,
ForeignKey("automations.id", ondelete="CASCADE"),
nullable=False,
index=True,
)
trigger_id = Column(
Integer,
ForeignKey("automation_triggers.id", ondelete="SET NULL"),
nullable=True,
index=True,
)
status = Column(
SQLAlchemyEnum(RunStatus, name="automation_run_status"),
nullable=False,
default=RunStatus.PENDING,
server_default=RunStatus.PENDING.value,
index=True,
)
# locked at fire time so historical runs always show the exact code path
definition_snapshot = Column(JSONB, nullable=False)
trigger_payload = Column(JSONB, nullable=True)
resolved_inputs = Column(JSONB, nullable=False, server_default="{}")
step_results = Column(JSONB, nullable=False, server_default="[]")
output = Column(JSONB, nullable=True)
artifacts = Column(JSONB, nullable=False, server_default="[]")
error = Column(JSONB, nullable=True)
started_at = Column(TIMESTAMP(timezone=True), nullable=True)
finished_at = Column(TIMESTAMP(timezone=True), nullable=True)
agent_session_id = Column(String(200), nullable=True)