From 3f06fd5b7bc2b57f101d4d1d98dd9f330b304055 Mon Sep 17 00:00:00 2001 From: Ed_ Date: Thu, 25 Jun 2026 15:10:48 -0400 Subject: [PATCH] docs(type_registry): regenerate for new per-aggregate dataclasses Phase 0 added 12 NEW dataclasses (11 in src/type_aliases.py + RAGChunk in src/rag_engine.py). The type registry was regenerated to include them. 23 .md files in docs/type_registry/. --- docs/type_registry/index.md | 17 ++- docs/type_registry/src_rag_engine.md | 15 +++ docs/type_registry/src_type_aliases.md | 164 ++++++++++++++++++++----- docs/type_registry/type_aliases.md | 55 ++------- 4 files changed, 172 insertions(+), 79 deletions(-) create mode 100644 docs/type_registry/src_rag_engine.md diff --git a/docs/type_registry/index.md b/docs/type_registry/index.md index e69d736d..19020bf0 100644 --- a/docs/type_registry/index.md +++ b/docs/type_registry/index.md @@ -19,6 +19,7 @@ Generated by `scripts/generate_type_registry.py`. Re-run the script (or invoke ` - [`src\patch_modal.py`](src\patch_modal.md) - [`src\paths.py`](src\paths.md) - [`src\provider_state.py`](src\provider_state.md) +- [`src\rag_engine.py`](src\rag_engine.md) - [`src\result_types.py`](src\result_types.md) - [`src\startup_profiler.py`](src\startup_profiler.md) - [`src\theme_models.py`](src\theme_models.md) @@ -73,6 +74,7 @@ Generated by `scripts/generate_type_registry.py`. Re-run the script (or invoke ` - `PendingPatch` (dataclass) - [`src\patch_modal.py`](src\patch_modal.md#src\patch_modal.py::PendingPatch) - `PathsConfig` (dataclass) - [`src\paths.py`](src\paths.md#src\paths.py::PathsConfig) - `ProviderHistory` (dataclass) - [`src\provider_state.py`](src\provider_state.md#src\provider_state.py::ProviderHistory) +- `RAGChunk` (dataclass) - [`src\rag_engine.py`](src\rag_engine.md#src\rag_engine.py::RAGChunk) - `ErrorInfo` (dataclass) - [`src\result_types.py`](src\result_types.md#src\result_types.py::ErrorInfo) - `Result` (dataclass) - [`src\result_types.py`](src\result_types.md#src\result_types.py::Result) - `NilPath` (dataclass) - [`src\result_types.py`](src\result_types.md#src\result_types.py::NilPath) @@ -81,15 +83,22 @@ Generated by `scripts/generate_type_registry.py`. Re-run the script (or invoke ` - `StartupProfiler` (dataclass) - [`src\startup_profiler.py`](src\startup_profiler.md#src\startup_profiler.py::StartupProfiler) - `ThemePalette` (dataclass) - [`src\theme_models.py`](src\theme_models.md#src\theme_models.py::ThemePalette) - `ThemeFile` (dataclass) - [`src\theme_models.py`](src\theme_models.md#src\theme_models.py::ThemeFile) +- `CommsLogEntry` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::CommsLogEntry) +- `HistoryMessage` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::HistoryMessage) +- `FileItem` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::FileItem) +- `ToolDefinition` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::ToolDefinition) +- `SessionInsights` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::SessionInsights) +- `DiscussionSettings` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::DiscussionSettings) +- `CustomSlice` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::CustomSlice) +- `MMAUsageStats` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::MMAUsageStats) +- `ProviderPayload` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::ProviderPayload) +- `UIPanelConfig` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::UIPanelConfig) +- `PathInfo` (dataclass) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::PathInfo) - `FileItemsDiff` (NamedTuple) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::FileItemsDiff) - `Metadata` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::Metadata) -- `CommsLogEntry` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::CommsLogEntry) - `CommsLog` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::CommsLog) -- `HistoryMessage` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::HistoryMessage) - `History` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::History) -- `FileItem` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::FileItem) - `FileItems` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::FileItems) -- `ToolDefinition` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::ToolDefinition) - `ToolCall` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::ToolCall) - `CommsLogCallback` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::CommsLogCallback) - `JsonPrimitive` (TypeAlias) - [`src\type_aliases.py`](src\type_aliases.md#src\type_aliases.py::JsonPrimitive) diff --git a/docs/type_registry/src_rag_engine.md b/docs/type_registry/src_rag_engine.md new file mode 100644 index 00000000..aed7578c --- /dev/null +++ b/docs/type_registry/src_rag_engine.md @@ -0,0 +1,15 @@ +# Module: `src\rag_engine.py` + +Auto-generated from source. 1 struct(s) defined in this module. + +## `src\rag_engine.py::RAGChunk` + +**Kind:** `dataclass` +**Defined at:** line 20 + +**Fields:** +- `document: str` +- `path: str` +- `score: float` +- `metadata: Metadata` + diff --git a/docs/type_registry/src_type_aliases.md b/docs/type_registry/src_type_aliases.md index 66e4d8df..6a0a5b71 100644 --- a/docs/type_registry/src_type_aliases.md +++ b/docs/type_registry/src_type_aliases.md @@ -1,11 +1,11 @@ # Module: `src\type_aliases.py` -Auto-generated from source. 13 struct(s) defined in this module. +Auto-generated from source. 20 struct(s) defined in this module. ## `src\type_aliases.py::CommsLog` **Kind:** `TypeAlias` -**Defined at:** line 8 +**Defined at:** line 29 **Resolves to:** `list[CommsLogEntry]` **Used by:** `CommsLogCallback` @@ -14,33 +14,69 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::CommsLogCallback` **Kind:** `TypeAlias` -**Defined at:** line 19 +**Defined at:** line 169 **Resolves to:** `Callable[[CommsLogEntry], None]` **Note:** `CommsLogCallback` is a semantic alias. The type registry is auto-generated from the source code. ## `src\type_aliases.py::CommsLogEntry` -**Kind:** `TypeAlias` -**Defined at:** line 7 -**Resolves to:** `Metadata` -**Used by:** `CommsLog`, `CommsLogCallback` +**Kind:** `dataclass` +**Defined at:** line 10 + +**Fields:** +- `ts: str` +- `role: str` +- `kind: str` +- `direction: str` +- `model: str` +- `source_tier: str` +- `content: str` +- `error: str` + + +## `src\type_aliases.py::CustomSlice` + +**Kind:** `dataclass` +**Defined at:** line 118 + +**Fields:** +- `tag: str` +- `comment: str` +- `start_line: int` +- `end_line: int` + + +## `src\type_aliases.py::DiscussionSettings` + +**Kind:** `dataclass` +**Defined at:** line 108 + +**Fields:** +- `temperature: float` +- `top_p: float` +- `max_output_tokens: int` -**Note:** `CommsLogEntry` is a semantic alias. The type registry is auto-generated from the source code. ## `src\type_aliases.py::FileItem` -**Kind:** `TypeAlias` -**Defined at:** line 13 -**Resolves to:** `Metadata` -**Used by:** `FileItems`, `FileItemsDiff` +**Kind:** `dataclass` +**Defined at:** line 54 + +**Fields:** +- `path: str` +- `content: str` +- `view_mode: str` +- `summary: str` +- `skeleton: str` +- `annotations: Metadata` +- `tags: list` -**Note:** `FileItem` is a semantic alias. The type registry is auto-generated from the source code. ## `src\type_aliases.py::FileItems` **Kind:** `TypeAlias` -**Defined at:** line 14 +**Defined at:** line 72 **Resolves to:** `list[FileItem]` **Used by:** `FileItemsDiff` @@ -49,7 +85,7 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::FileItemsDiff` **Kind:** `NamedTuple` -**Defined at:** line 25 +**Defined at:** line 175 **Fields:** - `refreshed: FileItems` @@ -59,7 +95,7 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::History` **Kind:** `TypeAlias` -**Defined at:** line 11 +**Defined at:** line 50 **Resolves to:** `list[HistoryMessage]` **Used by:** `ProviderHistory` @@ -67,17 +103,22 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::HistoryMessage` -**Kind:** `TypeAlias` -**Defined at:** line 10 -**Resolves to:** `Metadata` -**Used by:** `History`, `ProviderHistory` +**Kind:** `dataclass` +**Defined at:** line 33 + +**Fields:** +- `role: str` +- `content: str` +- `tool_calls: tuple` +- `tool_call_id: str` +- `name: str` +- `ts: float` -**Note:** `HistoryMessage` is a semantic alias. The type registry is auto-generated from the source code. ## `src\type_aliases.py::JsonPrimitive` **Kind:** `TypeAlias` -**Defined at:** line 21 +**Defined at:** line 171 **Resolves to:** `str | int | float | bool | None` **Used by:** `JsonValue` @@ -86,25 +127,73 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::JsonValue` **Kind:** `TypeAlias` -**Defined at:** line 22 +**Defined at:** line 172 **Resolves to:** `JsonPrimitive | list['JsonValue'] | dict[str, 'JsonValue']` **Used by:** `OpenAICompatibleRequest`, `WebSocketMessage` **Note:** `JsonValue` is a semantic alias. The type registry is auto-generated from the source code. +## `src\type_aliases.py::MMAUsageStats` + +**Kind:** `dataclass` +**Defined at:** line 129 + +**Fields:** +- `model: str` +- `input: int` +- `output: int` + + ## `src\type_aliases.py::Metadata` **Kind:** `TypeAlias` -**Defined at:** line 5 +**Defined at:** line 6 **Resolves to:** `dict[str, Any]` -**Used by:** `CommsLogEntry`, `FileItem`, `HistoryMessage`, `Persona`, `Session`, `ToolCall`, `ToolDefinition`, `TrackState`, `WorkerContext`, `WorkspaceProfile` +**Used by:** `FileItem`, `PathInfo`, `Persona`, `ProviderPayload`, `RAGChunk`, `Session`, `ToolCall`, `ToolDefinition`, `TrackState`, `WorkerContext`, `WorkspaceProfile` **Note:** `Metadata` is a semantic alias. The type registry is auto-generated from the source code. +## `src\type_aliases.py::PathInfo` + +**Kind:** `dataclass` +**Defined at:** line 160 + +**Fields:** +- `logs_dir: Metadata` +- `scripts_dir: Metadata` +- `project_root: Metadata` + + +## `src\type_aliases.py::ProviderPayload` + +**Kind:** `dataclass` +**Defined at:** line 139 + +**Fields:** +- `script: str` +- `args: Metadata` +- `output: str` +- `source_tier: str` + + +## `src\type_aliases.py::SessionInsights` + +**Kind:** `dataclass` +**Defined at:** line 95 + +**Fields:** +- `total_tokens: int` +- `call_count: int` +- `burn_rate: float` +- `session_cost: float` +- `completed_tickets: int` +- `efficiency: float` + + ## `src\type_aliases.py::ToolCall` **Kind:** `TypeAlias` -**Defined at:** line 17 +**Defined at:** line 91 **Resolves to:** `Metadata` **Used by:** `ChatMessage`, `NormalizedResponse`, `ToolCall` @@ -112,8 +201,23 @@ Auto-generated from source. 13 struct(s) defined in this module. ## `src\type_aliases.py::ToolDefinition` -**Kind:** `TypeAlias` -**Defined at:** line 16 -**Resolves to:** `Metadata` +**Kind:** `dataclass` +**Defined at:** line 76 + +**Fields:** +- `name: str` +- `description: str` +- `parameters: Metadata` +- `auto_start: bool` + + +## `src\type_aliases.py::UIPanelConfig` + +**Kind:** `dataclass` +**Defined at:** line 150 + +**Fields:** +- `separate_message_panel: bool` +- `separate_response_panel: bool` +- `separate_tool_calls_panel: bool` -**Note:** `ToolDefinition` is a semantic alias. The type registry is auto-generated from the source code. diff --git a/docs/type_registry/type_aliases.md b/docs/type_registry/type_aliases.md index 8e3e3fb4..6e25749b 100644 --- a/docs/type_registry/type_aliases.md +++ b/docs/type_registry/type_aliases.md @@ -2,12 +2,12 @@ # Module: `src/type_aliases.py (TypeAliases only)` -Auto-generated from source. 12 struct(s) defined in this module. +Auto-generated from source. 8 struct(s) defined in this module. ## `src\type_aliases.py::CommsLog` **Kind:** `TypeAlias` -**Defined at:** line 8 +**Defined at:** line 29 **Resolves to:** `list[CommsLogEntry]` **Used by:** `CommsLogCallback` @@ -16,33 +16,15 @@ Auto-generated from source. 12 struct(s) defined in this module. ## `src\type_aliases.py::CommsLogCallback` **Kind:** `TypeAlias` -**Defined at:** line 19 +**Defined at:** line 169 **Resolves to:** `Callable[[CommsLogEntry], None]` **Note:** `CommsLogCallback` is a semantic alias. The type registry is auto-generated from the source code. -## `src\type_aliases.py::CommsLogEntry` - -**Kind:** `TypeAlias` -**Defined at:** line 7 -**Resolves to:** `Metadata` -**Used by:** `CommsLog`, `CommsLogCallback` - -**Note:** `CommsLogEntry` is a semantic alias. The type registry is auto-generated from the source code. - -## `src\type_aliases.py::FileItem` - -**Kind:** `TypeAlias` -**Defined at:** line 13 -**Resolves to:** `Metadata` -**Used by:** `FileItems`, `FileItemsDiff` - -**Note:** `FileItem` is a semantic alias. The type registry is auto-generated from the source code. - ## `src\type_aliases.py::FileItems` **Kind:** `TypeAlias` -**Defined at:** line 14 +**Defined at:** line 72 **Resolves to:** `list[FileItem]` **Used by:** `FileItemsDiff` @@ -51,25 +33,16 @@ Auto-generated from source. 12 struct(s) defined in this module. ## `src\type_aliases.py::History` **Kind:** `TypeAlias` -**Defined at:** line 11 +**Defined at:** line 50 **Resolves to:** `list[HistoryMessage]` **Used by:** `ProviderHistory` **Note:** `History` is a semantic alias. The type registry is auto-generated from the source code. -## `src\type_aliases.py::HistoryMessage` - -**Kind:** `TypeAlias` -**Defined at:** line 10 -**Resolves to:** `Metadata` -**Used by:** `History`, `ProviderHistory` - -**Note:** `HistoryMessage` is a semantic alias. The type registry is auto-generated from the source code. - ## `src\type_aliases.py::JsonPrimitive` **Kind:** `TypeAlias` -**Defined at:** line 21 +**Defined at:** line 171 **Resolves to:** `str | int | float | bool | None` **Used by:** `JsonValue` @@ -78,7 +51,7 @@ Auto-generated from source. 12 struct(s) defined in this module. ## `src\type_aliases.py::JsonValue` **Kind:** `TypeAlias` -**Defined at:** line 22 +**Defined at:** line 172 **Resolves to:** `JsonPrimitive | list['JsonValue'] | dict[str, 'JsonValue']` **Used by:** `OpenAICompatibleRequest`, `WebSocketMessage` @@ -87,25 +60,17 @@ Auto-generated from source. 12 struct(s) defined in this module. ## `src\type_aliases.py::Metadata` **Kind:** `TypeAlias` -**Defined at:** line 5 +**Defined at:** line 6 **Resolves to:** `dict[str, Any]` -**Used by:** `CommsLogEntry`, `FileItem`, `HistoryMessage`, `Persona`, `Session`, `ToolCall`, `ToolDefinition`, `TrackState`, `WorkerContext`, `WorkspaceProfile` +**Used by:** `FileItem`, `PathInfo`, `Persona`, `ProviderPayload`, `RAGChunk`, `Session`, `ToolCall`, `ToolDefinition`, `TrackState`, `WorkerContext`, `WorkspaceProfile` **Note:** `Metadata` is a semantic alias. The type registry is auto-generated from the source code. ## `src\type_aliases.py::ToolCall` **Kind:** `TypeAlias` -**Defined at:** line 17 +**Defined at:** line 91 **Resolves to:** `Metadata` **Used by:** `ChatMessage`, `NormalizedResponse`, `ToolCall` **Note:** `ToolCall` is a semantic alias. The type registry is auto-generated from the source code. - -## `src\type_aliases.py::ToolDefinition` - -**Kind:** `TypeAlias` -**Defined at:** line 16 -**Resolves to:** `Metadata` - -**Note:** `ToolDefinition` is a semantic alias. The type registry is auto-generated from the source code.