From 4ba714c3892bbe03bc1a1c2854c2724dffff4db7 Mon Sep 17 00:00:00 2001 From: khyari hamza Date: Tue, 17 Feb 2026 14:04:24 +0000 Subject: [PATCH] style: shorten docstring markdown tables to satisfy E501 (88 cols) --- .../domain/models/core/resource.py | 12 ++++++-- src/cleveragents/domain/models/core/tool.py | 14 +++++----- .../infrastructure/database/models.py | 28 +++++++++---------- src/cleveragents/tool/lifecycle.py | 8 +++--- 4 files changed, 34 insertions(+), 28 deletions(-) diff --git a/src/cleveragents/domain/models/core/resource.py b/src/cleveragents/domain/models/core/resource.py index ec37e5d9..7ed9c587 100644 --- a/src/cleveragents/domain/models/core/resource.py +++ b/src/cleveragents/domain/models/core/resource.py @@ -10,8 +10,10 @@ This module implements: physical / virtual classification enum - [`SandboxStrategy`][cleveragents.domain.models.core.resource.SandboxStrategy] -- sandbox isolation strategy enum -- [`ResourceCapabilities`][cleveragents.domain.models.core.resource.ResourceCapabilities] -- +- [`ResourceCapabilities`][caps] -- capability flags (readable, writable, sandboxable, checkpointable) + +[caps]: cleveragents.domain.models.core.resource.ResourceCapabilities - [`Resource`][cleveragents.domain.models.core.resource.Resource] -- the core Resource domain model (``ResourceRecord``) @@ -25,8 +27,10 @@ Based on: - ADR-004: Pydantic v2 Validation See Also: - - [ResourceTypeSpec][cleveragents.domain.models.core.resource_type.ResourceTypeSpec] -- + - [ResourceTypeSpec][rts] -- Resource type schema definitions + + .. [rts]: cleveragents.domain.models.core.resource_type.ResourceTypeSpec """ from __future__ import annotations @@ -124,7 +128,9 @@ class Resource(BaseModel): - ``is_read_only`` -- True when the resource cannot be written See Also: - - [ResourceTypeSpec][cleveragents.domain.models.core.resource_type.ResourceTypeSpec] + - [ResourceTypeSpec][rts2] + + .. [rts2]: cleveragents.domain.models.core.resource_type.ResourceTypeSpec """ # Identity -- resource_id is the primary key (ULID) diff --git a/src/cleveragents/domain/models/core/tool.py b/src/cleveragents/domain/models/core/tool.py index d2f5423c..6eac644b 100644 --- a/src/cleveragents/domain/models/core/tool.py +++ b/src/cleveragents/domain/models/core/tool.py @@ -23,13 +23,13 @@ devops/docker-build ## Source Types -| Source | Description | Required Fields | -|---------------|------------------------------------------------|-----------------------------| -| ``mcp`` | Delegates to an MCP server | ``mcp_server``, ``mcp_tool_name`` | -| ``agent_skill``| Agent Skills Standard folder | ``agent_skill_path`` | -| ``builtin`` | Provided by the runtime | (none) | -| ``custom`` | Inline Python code | ``code`` | -| ``wrapped`` | Validation-only; wraps an existing tool | (set via Validation) | +| Source | Description | Required Fields | +|-------------|----------------------------------|--------------------------| +| ``mcp`` | Delegates to an MCP server | ``mcp_server/tool_name`` | +| ``agent_skill`` | Agent Skills Standard folder | ``agent_skill_path`` | +| ``builtin`` | Provided by the runtime | (none) | +| ``custom`` | Inline Python code | ``code`` | +| ``wrapped`` | Validation-only; wraps a tool | (set via Validation) | ## Validation Modes diff --git a/src/cleveragents/infrastructure/database/models.py b/src/cleveragents/infrastructure/database/models.py index 2fc7b7ae..77aa5d78 100644 --- a/src/cleveragents/infrastructure/database/models.py +++ b/src/cleveragents/infrastructure/database/models.py @@ -5,20 +5,20 @@ Alembic migrations. ## Tables -| Table | Model | Description | -|---------------------------|-------------------------------|---------------------------------| -| ``actions`` | ``ActionModel`` | Action templates | -| ``action_invariants`` | ``ActionInvariantModel`` | Action invariant rules | -| ``action_arguments`` | ``ActionArgumentModel`` | Action typed arguments | -| ``v3_plans`` | ``V3PlanModel`` | Plan lifecycle instances | -| ``plan_projects`` | ``PlanProjectModel`` | Plan-project links | -| ``plan_arguments`` | ``PlanArgumentModel`` | Plan argument values | -| ``plan_invariants`` | ``PlanInvariantModel`` | Plan invariant rules | -| ``resource_types`` | ``ResourceTypeModel`` | Resource type definitions | -| ``resources`` | ``ResourceModel`` | Resource instances | -| ``resource_edges`` | ``ResourceEdgeModel`` | Resource DAG edges | -| ``ns_projects`` | ``NamespacedProjectModel`` | Namespaced projects | -| ``project_resource_links``| ``ProjectResourceLinkModel`` | Project-resource bindings | +| Table | Model | Description | +|------------------------|----------------------------|------------------------| +| ``actions`` | ``ActionModel`` | Action templates | +| ``action_invariants`` | ``ActionInvariantModel`` | Invariant rules | +| ``action_arguments`` | ``ActionArgumentModel`` | Typed arguments | +| ``v3_plans`` | ``V3PlanModel`` | Plan lifecycle | +| ``plan_projects`` | ``PlanProjectModel`` | Plan-project links | +| ``plan_arguments`` | ``PlanArgumentModel`` | Plan argument values | +| ``plan_invariants`` | ``PlanInvariantModel`` | Plan invariant rules | +| ``resource_types`` | ``ResourceTypeModel`` | Resource type defs | +| ``resources`` | ``ResourceModel`` | Resource instances | +| ``resource_edges`` | ``ResourceEdgeModel`` | Resource DAG edges | +| ``ns_projects`` | ``NamespacedProjectModel`` | Namespaced projects | +| ``project_resource_links`` | ``ProjectResourceLinkModel`` | Project-resource | Based on ADR-007 (Repository Pattern) and Phase 0 discovery. Includes spec-aligned lifecycle models per Stage A5 diff --git a/src/cleveragents/tool/lifecycle.py b/src/cleveragents/tool/lifecycle.py index f8cdf62e..868f69eb 100644 --- a/src/cleveragents/tool/lifecycle.py +++ b/src/cleveragents/tool/lifecycle.py @@ -27,10 +27,10 @@ ToolRuntime ## Capability Enforcement -| Constraint | Condition | Error | -|----------------------|----------------------------------|-----------------------------------| -| Read-only plan | Tool has ``writes=True`` | ``ToolAccessDeniedError`` | -| Checkpoint required | Tool has ``checkpointable=False``| ``ToolCheckpointRequiredError`` | +| Constraint | Condition | Error | +|--------------------|----------------------------|-----------------------------| +| Read-only plan | ``writes=True`` | ``ToolAccessDeniedError`` | +| Checkpoint needed | ``checkpointable=False`` | ``ToolCheckpointRequired`` | ## Error Hierarchy