mirror of
https://github.com/MervinPraison/PraisonAI.git
synced 2026-11-09 11:51:37 -10:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3386d25022 | ||
|
|
6dca2ace8a | ||
|
|
63548739e8 | ||
|
|
3e046537f4 | ||
|
|
4a34677567 | ||
|
|
19e91cb669 | ||
|
|
5a6125021a | ||
|
|
da26887f24 | ||
|
|
1b2f7139f9 | ||
|
|
aafbc86180 | ||
|
|
3d4ca1b7c0 | ||
|
|
1180aa38bd | ||
|
|
65f65e5c7b | ||
|
|
f81a12d5e8 | ||
|
|
cf6f5fbefe | ||
|
|
908d7710db | ||
|
|
7d5b41e31f | ||
|
|
e46a0bc9f3 | ||
|
|
911483c92c | ||
|
|
4ffb9d6e3f | ||
|
|
b686e5b00f | ||
|
|
d8d84ee3e3 | ||
|
|
9f2c4d10b5 | ||
|
|
42a86c831f | ||
|
|
48443b11d6 | ||
|
|
71745aa14a | ||
|
|
4f309ec16d |
No files matched your search
@@ -0,0 +1,71 @@
|
||||
"""
|
||||
Auto-generated API server for PraisonAI agents.
|
||||
"""
|
||||
from flask import Flask, request, jsonify
|
||||
from flask_cors import CORS
|
||||
from praisonai import PraisonAI
|
||||
import os
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
# CORS configuration
|
||||
CORS(app)
|
||||
|
||||
# Authentication
|
||||
AUTH_ENABLED = False
|
||||
AUTH_TOKEN = None
|
||||
|
||||
def check_auth():
|
||||
"""Check authentication if enabled."""
|
||||
if not AUTH_ENABLED:
|
||||
return True
|
||||
|
||||
token = request.headers.get('Authorization', '').replace('Bearer ', '')
|
||||
return token == AUTH_TOKEN
|
||||
|
||||
@app.route('/health', methods=['GET'])
|
||||
def health():
|
||||
"""Health check endpoint."""
|
||||
return jsonify({"status": "ok", "service": "praisonai-api"})
|
||||
|
||||
@app.route('/chat', methods=['POST'])
|
||||
def chat():
|
||||
"""Chat endpoint for agent interaction."""
|
||||
if not check_auth():
|
||||
return jsonify({"error": "Unauthorized"}), 401
|
||||
|
||||
data = request.get_json()
|
||||
if not data or 'message' not in data:
|
||||
return jsonify({"error": "Message required"}), 400
|
||||
|
||||
try:
|
||||
praisonai = PraisonAI(agent_file="agents.yaml")
|
||||
result = praisonai.run()
|
||||
|
||||
return jsonify({
|
||||
"response": result,
|
||||
"status": "success"
|
||||
})
|
||||
except Exception as e:
|
||||
return jsonify({
|
||||
"error": str(e),
|
||||
"status": "error"
|
||||
}), 500
|
||||
|
||||
@app.route('/agents', methods=['GET'])
|
||||
def list_agents():
|
||||
"""List available agents."""
|
||||
if not check_auth():
|
||||
return jsonify({"error": "Unauthorized"}), 401
|
||||
|
||||
return jsonify({
|
||||
"agents": ["default"],
|
||||
"agent_file": "agents.yaml"
|
||||
})
|
||||
|
||||
if __name__ == '__main__':
|
||||
app.run(
|
||||
host='0.0.0.0',
|
||||
port=8080,
|
||||
debug=False
|
||||
)
|
||||
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
|
||||
# Install Python packages (using latest versions)
|
||||
RUN pip install --no-cache-dir \
|
||||
praisonai_tools \
|
||||
"praisonai>=2.8.4" \
|
||||
"praisonai>=3.0.2" \
|
||||
"praisonai[chat]" \
|
||||
"embedchain[github,youtube]"
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ RUN mkdir -p /root/.praison
|
||||
# Install Python packages (using latest versions)
|
||||
RUN pip install --no-cache-dir \
|
||||
praisonai_tools \
|
||||
"praisonai>=2.8.4" \
|
||||
"praisonai>=3.0.2" \
|
||||
"praisonai[ui]" \
|
||||
"praisonai[chat]" \
|
||||
"praisonai[realtime]" \
|
||||
|
||||
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
|
||||
# Install Python packages (using latest versions)
|
||||
RUN pip install --no-cache-dir \
|
||||
praisonai_tools \
|
||||
"praisonai>=2.8.4" \
|
||||
"praisonai>=3.0.2" \
|
||||
"praisonai[ui]" \
|
||||
"praisonai[crewai]"
|
||||
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
# Profiling CLI
|
||||
|
||||
PraisonAI provides unified profiling capabilities for performance analysis and debugging, with **full visibility from ENTER to first response**.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Basic profiling
|
||||
praisonai "What is 2+2?" --profile
|
||||
|
||||
# Deep profiling with call graph, decision trace, and module breakdown
|
||||
praisonai "What is 2+2?" --profile --profile-deep
|
||||
|
||||
# JSON output format
|
||||
praisonai "What is 2+2?" --profile --profile-format json
|
||||
```
|
||||
|
||||
## Time to First Response (TTFR)
|
||||
|
||||
**TTFR** is the key user-perceived latency metric. It measures the time from when you press ENTER until the first visible output appears.
|
||||
|
||||
### What contributes to TTFR?
|
||||
|
||||
1. **CLI Entry** - Time to reach the CLI entry point
|
||||
2. **CLI Parse** - Argparse/Typer routing time
|
||||
3. **Routing** - Command routing to handler
|
||||
4. **Imports** - Loading required modules
|
||||
5. **Agent Init** - Initializing the agent
|
||||
6. **Network Request** - Sending request to LLM API
|
||||
7. **First Token** - Receiving first token (streaming)
|
||||
8. **First Output** - Rendering first visible output
|
||||
|
||||
### How to reduce TTFR
|
||||
|
||||
1. **Warm runs** - Imports are cached after first run
|
||||
2. **Streaming mode** - See output as tokens arrive
|
||||
3. **Lighter models** - Faster response times
|
||||
4. **Local models** - Eliminate network latency
|
||||
|
||||
## CLI Flags
|
||||
|
||||
| Flag | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `--profile` | Enable profiling with timing breakdown | Disabled |
|
||||
| `--profile-deep` | Enable deep profiling with call graph (higher overhead) | Disabled |
|
||||
| `--profile-format` | Output format: `text` or `json` | `text` |
|
||||
|
||||
## Profile Command
|
||||
|
||||
For more detailed profiling options, use the `profile` subcommand:
|
||||
|
||||
```bash
|
||||
# Profile a query
|
||||
praisonai profile query "What is 2+2?"
|
||||
|
||||
# With deep call tracing
|
||||
praisonai profile query "Hello" --deep
|
||||
|
||||
# Limit functions shown
|
||||
praisonai profile query "Test" --limit 20
|
||||
|
||||
# Save artifacts to directory
|
||||
praisonai profile query "Test" --save ./profile_results
|
||||
|
||||
# JSON output
|
||||
praisonai profile query "Test" --format json
|
||||
```
|
||||
|
||||
### Profile Query Options
|
||||
|
||||
| Option | Description | Default |
|
||||
|--------|-------------|---------|
|
||||
| `--model, -m` | Model to use | Default model |
|
||||
| `--stream/--no-stream` | Use streaming mode | No stream |
|
||||
| `--deep` | Enable deep call tracing | Disabled |
|
||||
| `--limit, -n` | Top N functions to show | 30 |
|
||||
| `--sort, -s` | Sort by: `cumulative` or `tottime` | `cumulative` |
|
||||
| `--show-callers` | Show caller functions | Disabled |
|
||||
| `--show-callees` | Show callee functions | Disabled |
|
||||
| `--save` | Save artifacts to path | None |
|
||||
| `--format, -f` | Output format: `text` or `json` | `text` |
|
||||
|
||||
## Other Profile Commands
|
||||
|
||||
```bash
|
||||
# Profile module import times
|
||||
praisonai profile imports
|
||||
|
||||
# Profile CLI startup time
|
||||
praisonai profile startup
|
||||
|
||||
# Run comprehensive profiling suite
|
||||
praisonai profile suite
|
||||
|
||||
# Create performance snapshots for comparison
|
||||
praisonai profile snapshot --baseline
|
||||
praisonai profile snapshot current --compare
|
||||
|
||||
# Configure performance optimizations
|
||||
praisonai profile optimize --show
|
||||
```
|
||||
|
||||
## Output Format
|
||||
|
||||
### Text Report
|
||||
|
||||
```
|
||||
======================================================================
|
||||
PraisonAI Profile Report
|
||||
======================================================================
|
||||
|
||||
Run ID: abc12345
|
||||
Timestamp: 2024-01-02T12:00:00.000000Z
|
||||
Method: cli_direct
|
||||
Version: 3.0.1
|
||||
|
||||
## Execution Timeline
|
||||
---------------------------------------------
|
||||
Imports : 500.00 ms
|
||||
Agent Init : 0.50 ms
|
||||
Execution : 2000.00 ms
|
||||
───────────────────────────────────────────
|
||||
⏱ Time to First Response : 2500.50 ms
|
||||
TOTAL : 2500.50 ms
|
||||
|
||||
## Timing Breakdown
|
||||
----------------------------------------
|
||||
Imports: 500.00 ms
|
||||
Agent Init: 0.50 ms
|
||||
Execution: 2000.00 ms
|
||||
─────────────────────────────────────
|
||||
TOTAL: 2500.50 ms
|
||||
|
||||
## Decision Trace (deep profile only)
|
||||
----------------------------------------
|
||||
Agent Config: default
|
||||
Model: gpt-4
|
||||
Streaming: disabled
|
||||
Profile Layer: 2
|
||||
|
||||
## Top Functions by Cumulative Time
|
||||
----------------------------------------------------------------------
|
||||
Function Calls Cumul (ms)
|
||||
----------------------------------------------------------------------
|
||||
request 1 1800.00
|
||||
send 1 1750.00
|
||||
...
|
||||
```
|
||||
|
||||
### JSON Report
|
||||
|
||||
```json
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"run_id": "abc12345",
|
||||
"timestamp": "2024-01-02T12:00:00.000000Z",
|
||||
"invocation": {
|
||||
"method": "cli_direct",
|
||||
"flags": {"layer": 1, "stream": false, "model": null},
|
||||
"praisonai_version": "3.0.1",
|
||||
"python_version": "3.12.0"
|
||||
},
|
||||
"timing": {
|
||||
"total_ms": 2500.5,
|
||||
"imports_ms": 500.0,
|
||||
"agent_init_ms": 0.5,
|
||||
"execution_ms": 2000.0
|
||||
},
|
||||
"functions": [...],
|
||||
"response_preview": "four"
|
||||
}
|
||||
```
|
||||
|
||||
## Profiling Layers
|
||||
|
||||
| Layer | Overhead | Features |
|
||||
|-------|----------|----------|
|
||||
| 0 | < 1ms | Wall-clock phases only |
|
||||
| 1 | ~5% | + cProfile function stats |
|
||||
| 2 | ~15% | + Call graph (callers/callees) |
|
||||
|
||||
- `--profile` uses Layer 1
|
||||
- `--profile --profile-deep` uses Layer 2
|
||||
|
||||
## Performance Tips
|
||||
|
||||
1. **Use Layer 0 for production monitoring** - minimal overhead
|
||||
2. **Use Layer 1 for development profiling** - good balance
|
||||
3. **Use Layer 2 only for deep debugging** - higher overhead
|
||||
|
||||
## Observational Equivalence
|
||||
|
||||
The following commands produce equivalent profile reports:
|
||||
|
||||
```bash
|
||||
# CLI direct
|
||||
praisonai "prompt" --profile
|
||||
|
||||
# Profile command
|
||||
praisonai profile query "prompt"
|
||||
```
|
||||
|
||||
Both use the same unified profiling architecture and produce identical schema output.
|
||||
@@ -0,0 +1,257 @@
|
||||
# Profiling Module
|
||||
|
||||
PraisonAI provides a unified profiling module for programmatic performance analysis.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
from praisonai.cli.execution import (
|
||||
ExecutionRequest,
|
||||
Profiler,
|
||||
ProfilerConfig,
|
||||
)
|
||||
|
||||
# Create execution request
|
||||
request = ExecutionRequest(prompt="What is 2+2?")
|
||||
|
||||
# Configure profiler
|
||||
config = ProfilerConfig(layer=1)
|
||||
|
||||
# Run with profiling
|
||||
profiler = Profiler(config)
|
||||
result, report = profiler.profile_sync(request)
|
||||
|
||||
# Access results
|
||||
print(f"Output: {result.output}")
|
||||
print(f"Total time: {report.timing.total_ms}ms")
|
||||
```
|
||||
|
||||
## ExecutionRequest
|
||||
|
||||
Immutable request descriptor for execution.
|
||||
|
||||
```python
|
||||
from praisonai.cli.execution import ExecutionRequest
|
||||
|
||||
# Basic request
|
||||
request = ExecutionRequest(prompt="Hello")
|
||||
|
||||
# With model
|
||||
request = ExecutionRequest(
|
||||
prompt="Hello",
|
||||
model="gpt-4",
|
||||
agent_name="MyAgent",
|
||||
)
|
||||
|
||||
# With streaming
|
||||
request = ExecutionRequest(
|
||||
prompt="Hello",
|
||||
stream=True,
|
||||
)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|-----------|------|---------|-------------|
|
||||
| `prompt` | str | Required | The prompt to execute |
|
||||
| `agent_name` | str | "Assistant" | Name of the agent |
|
||||
| `agent_instructions` | str | None | Custom instructions |
|
||||
| `model` | str | None | Model to use |
|
||||
| `stream` | bool | False | Enable streaming |
|
||||
| `tools` | tuple | () | Tools to provide |
|
||||
|
||||
## ProfilerConfig
|
||||
|
||||
Configuration for profiling behavior.
|
||||
|
||||
```python
|
||||
from praisonai.cli.execution import ProfilerConfig
|
||||
|
||||
# Layer 0: Wall-clock only (< 1ms overhead)
|
||||
config = ProfilerConfig(layer=0)
|
||||
|
||||
# Layer 1: + cProfile stats (~5% overhead)
|
||||
config = ProfilerConfig(layer=1)
|
||||
|
||||
# Layer 2: + Call graph (~15% overhead)
|
||||
config = ProfilerConfig(
|
||||
layer=2,
|
||||
show_callers=True,
|
||||
show_callees=True,
|
||||
)
|
||||
|
||||
# From CLI flags
|
||||
config = ProfilerConfig.from_flags(
|
||||
profile=True,
|
||||
deep=True,
|
||||
network=False,
|
||||
)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|-----------|------|---------|-------------|
|
||||
| `layer` | int | 1 | Profiling layer (0, 1, or 2) |
|
||||
| `limit` | int | 30 | Max functions to show |
|
||||
| `sort_by` | str | "cumulative" | Sort by: cumulative, time, calls |
|
||||
| `show_callers` | bool | False | Show caller functions |
|
||||
| `show_callees` | bool | False | Show callee functions |
|
||||
| `track_network` | bool | False | Track network requests |
|
||||
| `output_format` | str | "text" | Output format: text, json |
|
||||
| `save_path` | str | None | Path to save artifacts |
|
||||
|
||||
## Profiler
|
||||
|
||||
The main profiler class that wraps execution.
|
||||
|
||||
```python
|
||||
from praisonai.cli.execution import Profiler, ProfilerConfig, ExecutionRequest
|
||||
|
||||
config = ProfilerConfig(layer=1)
|
||||
profiler = Profiler(config)
|
||||
|
||||
request = ExecutionRequest(prompt="Hello")
|
||||
result, report = profiler.profile_sync(request, invocation_method="api")
|
||||
```
|
||||
|
||||
### Methods
|
||||
|
||||
#### `profile_sync(request, invocation_method="profile_command")`
|
||||
|
||||
Profile synchronous execution.
|
||||
|
||||
**Parameters:**
|
||||
- `request`: ExecutionRequest - The execution request
|
||||
- `invocation_method`: str - How this was invoked (for report)
|
||||
|
||||
**Returns:** Tuple of (ExecutionResult, ProfileReport)
|
||||
|
||||
## ProfileReport
|
||||
|
||||
The canonical profile report with timing and statistics.
|
||||
|
||||
```python
|
||||
# Access timing breakdown
|
||||
print(f"Total: {report.timing.total_ms}ms")
|
||||
print(f"Imports: {report.timing.imports_ms}ms")
|
||||
print(f"Agent Init: {report.timing.agent_init_ms}ms")
|
||||
print(f"Execution: {report.timing.execution_ms}ms")
|
||||
|
||||
# Access function stats (layer 1+)
|
||||
if report.functions:
|
||||
for func in report.functions[:5]:
|
||||
print(f"{func.name}: {func.cumulative_time_ms}ms")
|
||||
|
||||
# Access call graph (layer 2)
|
||||
if report.call_graph:
|
||||
print(f"Edges: {len(report.call_graph.edges)}")
|
||||
|
||||
# Export formats
|
||||
json_str = report.to_json()
|
||||
text_str = report.to_text()
|
||||
dict_data = report.to_dict()
|
||||
```
|
||||
|
||||
### Schema Version
|
||||
|
||||
The report uses schema version `1.0`. Schema is frozen after release - new fields are always optional with defaults.
|
||||
|
||||
### Mandatory Fields
|
||||
|
||||
- `schema_version`: str
|
||||
- `run_id`: str
|
||||
- `timestamp`: str (ISO 8601)
|
||||
- `invocation`: InvocationInfo
|
||||
- `timing`: TimingBreakdown
|
||||
- `response_preview`: str
|
||||
|
||||
### Optional Fields
|
||||
|
||||
- `functions`: List[FunctionStat] (layer 1+)
|
||||
- `call_graph`: CallGraph (layer 2)
|
||||
- `network`: List[RequestTiming] (if track_network)
|
||||
|
||||
## ExecutionResult
|
||||
|
||||
Result of execution with output and metadata.
|
||||
|
||||
```python
|
||||
# Access output
|
||||
print(result.output)
|
||||
print(result.success)
|
||||
print(result.run_id)
|
||||
|
||||
# Check for errors
|
||||
if result.error:
|
||||
print(f"Error: {result.error}")
|
||||
|
||||
# Duration
|
||||
print(f"Duration: {result.duration_ms}ms")
|
||||
```
|
||||
|
||||
## Data Bounds
|
||||
|
||||
Profile data is strictly bounded to prevent memory issues:
|
||||
|
||||
| Data Type | Maximum |
|
||||
|-----------|---------|
|
||||
| Function stats | 1000 |
|
||||
| Call graph edges | 5000 |
|
||||
| Network requests | 100 |
|
||||
|
||||
## Example: Full Profiling Workflow
|
||||
|
||||
```python
|
||||
from praisonai.cli.execution import (
|
||||
ExecutionRequest,
|
||||
Profiler,
|
||||
ProfilerConfig,
|
||||
)
|
||||
|
||||
# Configure deep profiling
|
||||
config = ProfilerConfig(
|
||||
layer=2,
|
||||
limit=50,
|
||||
show_callers=True,
|
||||
show_callees=True,
|
||||
)
|
||||
|
||||
# Create request
|
||||
request = ExecutionRequest(
|
||||
prompt="Explain quantum computing in simple terms",
|
||||
model="gpt-4",
|
||||
)
|
||||
|
||||
# Profile execution
|
||||
profiler = Profiler(config)
|
||||
result, report = profiler.profile_sync(request)
|
||||
|
||||
# Print text report
|
||||
print(report.to_text())
|
||||
|
||||
# Save JSON report
|
||||
with open("profile.json", "w") as f:
|
||||
f.write(report.to_json())
|
||||
|
||||
# Analyze timing
|
||||
print(f"\nTiming Analysis:")
|
||||
print(f" Import overhead: {report.timing.imports_ms / report.timing.total_ms * 100:.1f}%")
|
||||
print(f" Execution time: {report.timing.execution_ms / report.timing.total_ms * 100:.1f}%")
|
||||
|
||||
# Top 5 hotspots
|
||||
if report.functions:
|
||||
print(f"\nTop 5 Hotspots:")
|
||||
for func in report.functions[:5]:
|
||||
print(f" {func.name}: {func.cumulative_time_ms:.2f}ms ({func.calls} calls)")
|
||||
```
|
||||
|
||||
## Invariants
|
||||
|
||||
The profiling module guarantees:
|
||||
|
||||
1. **Output Equivalence**: Profiled execution produces identical output to non-profiled execution
|
||||
2. **Schema Stability**: Schema version 1.0 is frozen; new fields are always optional
|
||||
3. **Bounded Data**: All profile data respects maximum bounds
|
||||
4. **Zero Overhead When Disabled**: No profiling code runs unless explicitly enabled
|
||||
@@ -0,0 +1,137 @@
|
||||
# ACP (Agent Client Protocol) Examples
|
||||
|
||||
This directory contains examples for using PraisonAI with the Agent Client Protocol (ACP).
|
||||
|
||||
## What is ACP?
|
||||
|
||||
The Agent Client Protocol (ACP) is a standardized JSON-RPC 2.0 protocol that allows code editors and IDEs to communicate with AI coding agents. It enables seamless integration between PraisonAI and editors like:
|
||||
|
||||
- **Zed**
|
||||
- **JetBrains IDEs** (IntelliJ, PyCharm, WebStorm, etc.)
|
||||
- **VSCode** (via extensions)
|
||||
- **Toad**
|
||||
|
||||
## Quick Start
|
||||
|
||||
### CLI Usage
|
||||
|
||||
```bash
|
||||
# Start ACP server with defaults
|
||||
praisonai acp
|
||||
|
||||
# Enable debug logging
|
||||
praisonai acp --debug
|
||||
|
||||
# Allow file writes
|
||||
praisonai acp --allow-write
|
||||
|
||||
# Use a specific model
|
||||
praisonai acp -m gpt-4o
|
||||
|
||||
# Resume last session
|
||||
praisonai acp --resume --last
|
||||
```
|
||||
|
||||
### Python API
|
||||
|
||||
```python
|
||||
from praisonai.acp import serve
|
||||
|
||||
serve(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True,
|
||||
)
|
||||
```
|
||||
|
||||
## Editor Configuration
|
||||
|
||||
### Zed
|
||||
|
||||
Add to `~/.config/zed/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### JetBrains
|
||||
|
||||
Add to `~/.jetbrains/acp.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Toad
|
||||
|
||||
```bash
|
||||
toad acp "praisonai acp"
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
- `basic_acp_server.py` - Simple ACP server with default settings
|
||||
- `custom_agent_acp.py` - ACP server with a custom agent
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-w, --workspace` | Workspace root directory |
|
||||
| `-a, --agent` | Agent name or config file |
|
||||
| `-m, --model` | LLM model to use |
|
||||
| `-r, --resume` | Resume session by ID |
|
||||
| `--last` | Resume the last session |
|
||||
| `--approve` | Approval mode: manual, auto, scoped |
|
||||
| `--read-only` | Read-only mode (default) |
|
||||
| `--allow-write` | Allow file writes |
|
||||
| `--allow-shell` | Allow shell commands |
|
||||
| `--debug` | Enable debug logging |
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install praisonai[acp]
|
||||
```
|
||||
|
||||
## Protocol Details
|
||||
|
||||
ACP uses JSON-RPC 2.0 over stdio:
|
||||
- **stdin**: Receives JSON-RPC requests from the client
|
||||
- **stdout**: Sends JSON-RPC responses to the client
|
||||
- **stderr**: Debug/log output (never pollutes stdout)
|
||||
|
||||
### Supported Methods
|
||||
|
||||
**Agent Methods (client → agent):**
|
||||
- `initialize` - Negotiate protocol version and capabilities
|
||||
- `authenticate` - Optional authentication
|
||||
- `session/new` - Create a new session
|
||||
- `session/load` - Load an existing session
|
||||
- `session/prompt` - Send user message
|
||||
- `session/cancel` - Cancel ongoing operations
|
||||
- `session/set_mode` - Change operating mode
|
||||
|
||||
**Client Methods (agent → client):**
|
||||
- `session/update` - Send progress updates
|
||||
- `session/request_permission` - Request user approval
|
||||
- `fs/read_text_file` - Read file contents
|
||||
- `fs/write_text_file` - Write file contents
|
||||
- `terminal/create` - Create terminal
|
||||
- `terminal/output` - Get terminal output
|
||||
@@ -0,0 +1,27 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Basic ACP Server Example
|
||||
|
||||
This example demonstrates how to run PraisonAI as an ACP server
|
||||
that can be connected to by IDEs like Zed, JetBrains, VSCode, or Toad.
|
||||
|
||||
Usage:
|
||||
# Run from command line
|
||||
praisonai acp
|
||||
|
||||
# Or run this script directly
|
||||
python basic_acp_server.py
|
||||
"""
|
||||
|
||||
from praisonai.acp import serve
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Start ACP server with default settings
|
||||
# This will listen on stdin/stdout for JSON-RPC messages
|
||||
serve(
|
||||
workspace=".", # Current directory as workspace
|
||||
agent="default", # Use default agent
|
||||
debug=False, # Set to True for debug logging to stderr
|
||||
read_only=True, # Safe by default
|
||||
approval_mode="manual", # Require approval for actions
|
||||
)
|
||||
@@ -0,0 +1,45 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Custom Agent ACP Server Example
|
||||
|
||||
This example shows how to run a custom PraisonAI agent as an ACP server.
|
||||
|
||||
Usage:
|
||||
python custom_agent_acp.py
|
||||
"""
|
||||
|
||||
from praisonai.acp import serve, ACPServer, ACPConfig
|
||||
from praisonaiagents import Agent
|
||||
|
||||
# Create a custom agent
|
||||
agent = Agent(
|
||||
name="CodeAssistant",
|
||||
instructions="""You are an expert coding assistant. You help users:
|
||||
- Write clean, efficient code
|
||||
- Debug issues
|
||||
- Explain complex concepts
|
||||
- Review code for best practices
|
||||
|
||||
Always provide clear explanations with your code suggestions.""",
|
||||
model="gpt-4o-mini",
|
||||
)
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Create config
|
||||
config = ACPConfig(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True, # Allow file modifications
|
||||
approval_mode="manual",
|
||||
)
|
||||
|
||||
# Create server with custom agent
|
||||
server = ACPServer(config=config, agent=agent)
|
||||
|
||||
# Run the server
|
||||
serve(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True,
|
||||
approval_mode="manual",
|
||||
)
|
||||
@@ -0,0 +1,135 @@
|
||||
"""
|
||||
Agent-Centric Tools Example
|
||||
|
||||
This example demonstrates how to use LSP/ACP-powered tools that make
|
||||
the Agent the central orchestrator for file operations.
|
||||
|
||||
How to run:
|
||||
export OPENAI_API_KEY=your_key
|
||||
python examples/agent_tools/agent_centric_example.py
|
||||
|
||||
Prerequisites:
|
||||
pip install praisonai praisonaiagents
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import os
|
||||
import sys
|
||||
import tempfile
|
||||
import shutil
|
||||
|
||||
# Add paths for development
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai'))
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai-agents'))
|
||||
|
||||
|
||||
async def main():
|
||||
print("=" * 60)
|
||||
print("AGENT-CENTRIC TOOLS EXAMPLE")
|
||||
print("=" * 60)
|
||||
print()
|
||||
|
||||
# Create temporary workspace
|
||||
workspace = tempfile.mkdtemp(prefix="praisonai_example_")
|
||||
print(f"Workspace: {workspace}")
|
||||
print()
|
||||
|
||||
try:
|
||||
# Import after path setup
|
||||
from praisonai.cli.features import (
|
||||
create_agent_centric_tools,
|
||||
InteractiveRuntime,
|
||||
RuntimeConfig
|
||||
)
|
||||
from praisonaiagents import Agent
|
||||
|
||||
# 1. Create runtime with ACP enabled
|
||||
print("1. Creating InteractiveRuntime with ACP...")
|
||||
config = RuntimeConfig(
|
||||
workspace=workspace,
|
||||
lsp_enabled=False, # Skip LSP for this example
|
||||
acp_enabled=True,
|
||||
approval_mode="auto" # Auto-approve for demo
|
||||
)
|
||||
runtime = InteractiveRuntime(config)
|
||||
status = await runtime.start()
|
||||
|
||||
print(f" ACP ready: {runtime.acp_ready}")
|
||||
print(f" Read-only: {runtime.read_only}")
|
||||
print()
|
||||
|
||||
# 2. Create agent-centric tools
|
||||
print("2. Creating agent-centric tools...")
|
||||
tools = create_agent_centric_tools(runtime)
|
||||
print(f" Tools created: {len(tools)}")
|
||||
for tool in tools:
|
||||
print(f" - {tool.__name__}")
|
||||
print()
|
||||
|
||||
# 3. Create Agent with ACP-powered tools
|
||||
print("3. Creating Agent with ACP-powered tools...")
|
||||
agent = Agent(
|
||||
name="FileAgent",
|
||||
instructions="""You help create and manage files.
|
||||
Use acp_create_file to create files.
|
||||
Use read_file to read files.
|
||||
Use list_files to list directory contents.""",
|
||||
tools=tools,
|
||||
verbose=True
|
||||
)
|
||||
print()
|
||||
|
||||
# 4. Ask agent to create a file
|
||||
print("4. Asking agent to create a Python file...")
|
||||
print("-" * 40)
|
||||
result = agent.start(
|
||||
"Create a Python file called calculator.py with add and subtract functions"
|
||||
)
|
||||
print("-" * 40)
|
||||
print(f"Agent response: {result[:200]}..." if len(str(result)) > 200 else f"Agent response: {result}")
|
||||
print()
|
||||
|
||||
# 5. Verify file was created
|
||||
print("5. Verifying file creation...")
|
||||
calc_path = os.path.join(workspace, "calculator.py")
|
||||
if os.path.exists(calc_path):
|
||||
print(f" ✓ File created at {calc_path}")
|
||||
with open(calc_path) as f:
|
||||
content = f.read()
|
||||
print(f" Content preview:")
|
||||
for line in content.split('\n')[:10]:
|
||||
print(f" {line}")
|
||||
else:
|
||||
# Check what files exist
|
||||
files = os.listdir(workspace)
|
||||
print(f" Files in workspace: {files}")
|
||||
for f in files:
|
||||
fp = os.path.join(workspace, f)
|
||||
if os.path.isfile(fp):
|
||||
print(f" ✓ Found: {f}")
|
||||
print()
|
||||
|
||||
# 6. Ask agent to read the file
|
||||
print("6. Asking agent to read the file...")
|
||||
print("-" * 40)
|
||||
result2 = agent.start("Read the calculator.py file and tell me what functions it has")
|
||||
print("-" * 40)
|
||||
print(f"Agent response: {result2[:300]}..." if len(str(result2)) > 300 else f"Agent response: {result2}")
|
||||
print()
|
||||
|
||||
# Cleanup
|
||||
await runtime.stop()
|
||||
|
||||
finally:
|
||||
# Clean up workspace
|
||||
shutil.rmtree(workspace, ignore_errors=True)
|
||||
print(f"Cleaned up workspace: {workspace}")
|
||||
|
||||
print()
|
||||
print("=" * 60)
|
||||
print("EXAMPLE COMPLETE")
|
||||
print("=" * 60)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,228 @@
|
||||
"""
|
||||
Debug Interactive Mode Example
|
||||
|
||||
This example demonstrates how to use the debug CLI commands to test
|
||||
the Interactive Coding Assistant without entering TUI mode.
|
||||
|
||||
Features demonstrated:
|
||||
- LSP symbol listing
|
||||
- LSP definition lookup
|
||||
- ACP action planning
|
||||
- ACP action execution
|
||||
- Trace capture and JSON output
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add the src directory to path for development
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent.parent / "src" / "praisonai"))
|
||||
|
||||
from praisonai.cli.features.interactive_runtime import create_runtime
|
||||
from praisonai.cli.features.code_intelligence import CodeIntelligenceRouter
|
||||
from praisonai.cli.features.action_orchestrator import ActionOrchestrator
|
||||
|
||||
|
||||
async def demo_lsp_queries(workspace: str):
|
||||
"""Demonstrate LSP-based code queries."""
|
||||
print("\n" + "=" * 60)
|
||||
print("LSP CODE QUERIES DEMO")
|
||||
print("=" * 60)
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=workspace,
|
||||
lsp=True,
|
||||
acp=False,
|
||||
trace=True
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
router = CodeIntelligenceRouter(runtime)
|
||||
|
||||
# Query 1: List symbols
|
||||
print("\n[Query 1] List all symbols in app.py")
|
||||
result = await router.handle_query("list all functions in app.py", "app.py")
|
||||
print(f" Success: {result.success}")
|
||||
print(f" LSP Used: {result.lsp_used}")
|
||||
print(f" Fallback Used: {result.fallback_used}")
|
||||
if result.data:
|
||||
print(f" Symbols found: {len(result.data)}")
|
||||
for symbol in result.data[:5]:
|
||||
print(f" - {symbol['name']} ({symbol['kind']}) at line {symbol['line']}")
|
||||
|
||||
# Query 2: Find definition
|
||||
print("\n[Query 2] Find definition of Calculator")
|
||||
result = await router.handle_query("where is Calculator defined", "app.py")
|
||||
print(f" Success: {result.success}")
|
||||
if result.citations:
|
||||
print(f" Found at: {result.citations[0]}")
|
||||
|
||||
# Get trace
|
||||
trace = runtime.get_trace()
|
||||
print(f"\n[Trace] {len(trace.entries)} entries captured")
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
|
||||
async def demo_acp_actions(workspace: str):
|
||||
"""Demonstrate ACP-based code modifications."""
|
||||
print("\n" + "=" * 60)
|
||||
print("ACP CODE MODIFICATIONS DEMO")
|
||||
print("=" * 60)
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=workspace,
|
||||
lsp=False,
|
||||
acp=True,
|
||||
approval="auto",
|
||||
trace=True
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
print(f"\n ACP Ready: {runtime.acp_ready}")
|
||||
print(f" Read Only: {runtime.read_only}")
|
||||
|
||||
orchestrator = ActionOrchestrator(runtime)
|
||||
|
||||
# Action 1: Create a plan
|
||||
print("\n[Action 1] Create plan for new file")
|
||||
result = await orchestrator.create_plan("create a new file called demo_output.py")
|
||||
print(f" Success: {result.success}")
|
||||
if result.plan:
|
||||
print(f" Plan ID: {result.plan.id}")
|
||||
print(f" Steps: {len(result.plan.steps)}")
|
||||
for step in result.plan.steps:
|
||||
print(f" - {step.action_type.value}: {step.target}")
|
||||
|
||||
# Action 2: Execute with auto-approve
|
||||
print("\n[Action 2] Execute file creation")
|
||||
exec_result = await orchestrator.execute(
|
||||
"create a new file called demo_output.py with a hello function",
|
||||
auto_approve=True
|
||||
)
|
||||
print(f" Success: {exec_result.success}")
|
||||
print(f" Applied Steps: {exec_result.applied_steps}")
|
||||
|
||||
# Verify file was created
|
||||
output_file = Path(workspace) / "demo_output.py"
|
||||
if output_file.exists():
|
||||
print(f" File created: {output_file}")
|
||||
print(f" Content preview: {output_file.read_text()[:100]}...")
|
||||
|
||||
# Get trace
|
||||
trace = runtime.get_trace()
|
||||
print(f"\n[Trace] {len(trace.entries)} entries captured")
|
||||
for entry in trace.entries:
|
||||
print(f" [{entry.category}] {entry.action}")
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
|
||||
async def demo_full_interactive_turn(workspace: str):
|
||||
"""Demonstrate full interactive turn simulation."""
|
||||
print("\n" + "=" * 60)
|
||||
print("FULL INTERACTIVE TURN SIMULATION")
|
||||
print("=" * 60)
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=workspace,
|
||||
lsp=True,
|
||||
acp=True,
|
||||
approval="auto",
|
||||
trace=True
|
||||
)
|
||||
|
||||
try:
|
||||
status = await runtime.start()
|
||||
print("\n Runtime Status:")
|
||||
print(f" LSP: {'ready' if status['lsp']['ready'] else 'fallback'}")
|
||||
print(f" ACP: {'ready' if status['acp']['ready'] else 'unavailable'}")
|
||||
|
||||
router = CodeIntelligenceRouter(runtime)
|
||||
orchestrator = ActionOrchestrator(runtime)
|
||||
|
||||
# Simulate user prompt: code query
|
||||
prompt1 = "What functions are in app.py?"
|
||||
print(f"\n[Turn 1] User: {prompt1}")
|
||||
|
||||
# Classify and route
|
||||
result = await router.handle_query(prompt1, "app.py")
|
||||
print(f" Intent: {result.intent.value}")
|
||||
print(f" Response: Found {len(result.data) if result.data else 0} symbols")
|
||||
|
||||
# Simulate user prompt: code modification
|
||||
prompt2 = "Create a new test file"
|
||||
print(f"\n[Turn 2] User: {prompt2}")
|
||||
|
||||
exec_result = await orchestrator.execute(
|
||||
"create a new file called test_demo.py",
|
||||
auto_approve=True
|
||||
)
|
||||
print(" Action: file_create")
|
||||
print(f" Result: {'success' if exec_result.success else 'failed'}")
|
||||
|
||||
# Export trace as JSON
|
||||
trace = runtime.get_trace()
|
||||
trace_json = trace.to_dict()
|
||||
print("[Trace Export]")
|
||||
print(json.dumps(trace_json, indent=2, default=str)[:500] + "...")
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
|
||||
def main():
|
||||
"""Run the debug demo."""
|
||||
# Create a temporary workspace
|
||||
workspace = Path(__file__).parent / "_demo_workspace"
|
||||
workspace.mkdir(exist_ok=True)
|
||||
|
||||
# Create a sample app.py
|
||||
app_file = workspace / "app.py"
|
||||
app_file.write_text('''"""Sample application."""
|
||||
|
||||
def greet(name: str) -> str:
|
||||
"""Greet someone."""
|
||||
return f"Hello, {name}!"
|
||||
|
||||
def add(a: int, b: int) -> int:
|
||||
"""Add two numbers."""
|
||||
return a + b
|
||||
|
||||
class Calculator:
|
||||
"""Simple calculator."""
|
||||
|
||||
def __init__(self):
|
||||
self.value = 0
|
||||
|
||||
def add(self, x):
|
||||
self.value += x
|
||||
return self.value
|
||||
|
||||
if __name__ == "__main__":
|
||||
print(greet("World"))
|
||||
''')
|
||||
|
||||
print("=" * 60)
|
||||
print("PRAISONAI DEBUG MODE DEMO")
|
||||
print("=" * 60)
|
||||
print(f"Workspace: {workspace}")
|
||||
|
||||
# Run demos
|
||||
asyncio.run(demo_lsp_queries(str(workspace)))
|
||||
asyncio.run(demo_acp_actions(str(workspace)))
|
||||
asyncio.run(demo_full_interactive_turn(str(workspace)))
|
||||
|
||||
print("\n" + "=" * 60)
|
||||
print("DEMO COMPLETE")
|
||||
print("=" * 60)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,147 @@
|
||||
"""
|
||||
Interactive Default Tools Example
|
||||
|
||||
This example demonstrates how PraisonAI's interactive modes (TUI and prompt)
|
||||
include ACP and LSP tools by default.
|
||||
|
||||
Tool Groups:
|
||||
- ACP: acp_create_file, acp_edit_file, acp_delete_file, acp_execute_command
|
||||
- LSP: lsp_list_symbols, lsp_find_definition, lsp_find_references, lsp_get_diagnostics
|
||||
- Basic: read_file, write_file, list_files, execute_command, internet_search
|
||||
|
||||
Usage:
|
||||
python interactive_tools_example.py
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
# Add paths for development
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai'))
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai-agents'))
|
||||
|
||||
|
||||
def example_get_default_tools():
|
||||
"""Example: Get all default interactive tools."""
|
||||
from praisonai.cli.features.interactive_tools import (
|
||||
get_interactive_tools,
|
||||
ToolConfig,
|
||||
TOOL_GROUPS,
|
||||
)
|
||||
|
||||
print("=== Default Interactive Tools ===\n")
|
||||
|
||||
# Show tool groups
|
||||
print("Tool Groups:")
|
||||
for group, tools in TOOL_GROUPS.items():
|
||||
if group != "interactive":
|
||||
print(f" {group}: {tools}")
|
||||
print()
|
||||
|
||||
# Get all tools
|
||||
config = ToolConfig(workspace=os.getcwd())
|
||||
tools = get_interactive_tools(config=config)
|
||||
|
||||
print(f"Total tools loaded: {len(tools)}")
|
||||
print(f"Tool names: {[t.__name__ for t in tools]}")
|
||||
print()
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def example_disable_acp():
|
||||
"""Example: Disable ACP tools."""
|
||||
from praisonai.cli.features.interactive_tools import (
|
||||
get_interactive_tools,
|
||||
ToolConfig,
|
||||
)
|
||||
|
||||
print("=== Disable ACP Tools (--no-acp) ===\n")
|
||||
|
||||
config = ToolConfig(workspace=os.getcwd(), enable_acp=False)
|
||||
tools = get_interactive_tools(config=config, disable=["acp"])
|
||||
|
||||
acp_tools = [t for t in tools if t.__name__.startswith("acp_")]
|
||||
print(f"ACP tools after --no-acp: {len(acp_tools)}")
|
||||
print(f"Remaining tools: {[t.__name__ for t in tools]}")
|
||||
print()
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def example_disable_lsp():
|
||||
"""Example: Disable LSP tools."""
|
||||
from praisonai.cli.features.interactive_tools import (
|
||||
get_interactive_tools,
|
||||
ToolConfig,
|
||||
)
|
||||
|
||||
print("=== Disable LSP Tools (--no-lsp) ===\n")
|
||||
|
||||
config = ToolConfig(workspace=os.getcwd(), enable_lsp=False)
|
||||
tools = get_interactive_tools(config=config, disable=["lsp"])
|
||||
|
||||
lsp_tools = [t for t in tools if t.__name__.startswith("lsp_")]
|
||||
print(f"LSP tools after --no-lsp: {len(lsp_tools)}")
|
||||
print(f"Remaining tools: {[t.__name__ for t in tools]}")
|
||||
print()
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def example_agent_with_default_tools():
|
||||
"""Example: Create an Agent with default interactive tools."""
|
||||
from praisonai.cli.features.interactive_tools import get_interactive_tools, ToolConfig
|
||||
from praisonaiagents import Agent
|
||||
|
||||
print("=== Agent with Default Interactive Tools ===\n")
|
||||
|
||||
# Get default tools
|
||||
config = ToolConfig(workspace=os.getcwd())
|
||||
tools = get_interactive_tools(config=config)
|
||||
|
||||
# Create agent with tools
|
||||
agent = Agent(
|
||||
name="InteractiveAgent",
|
||||
instructions="You are a helpful coding assistant with file and code analysis capabilities.",
|
||||
tools=tools,
|
||||
verbose=False
|
||||
)
|
||||
|
||||
print(f"Agent created with {len(tools)} tools")
|
||||
print(f"Tools: {[t.__name__ for t in tools]}")
|
||||
print()
|
||||
|
||||
# Simple test - list files
|
||||
print("Testing agent with list_files tool...")
|
||||
result = agent.start("List the Python files in the current directory using list_files tool.")
|
||||
print(f"Result: {result[:200]}..." if len(str(result)) > 200 else f"Result: {result}")
|
||||
print()
|
||||
|
||||
return agent
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("=" * 60)
|
||||
print("PraisonAI Interactive Default Tools Example")
|
||||
print("=" * 60)
|
||||
print()
|
||||
|
||||
# Example 1: Get default tools
|
||||
example_get_default_tools()
|
||||
|
||||
# Example 2: Disable ACP
|
||||
example_disable_acp()
|
||||
|
||||
# Example 3: Disable LSP
|
||||
example_disable_lsp()
|
||||
|
||||
# Example 4: Agent with default tools (requires API key)
|
||||
if os.environ.get("OPENAI_API_KEY"):
|
||||
example_agent_with_default_tools()
|
||||
else:
|
||||
print("=== Agent Example Skipped (no OPENAI_API_KEY) ===")
|
||||
|
||||
print("=" * 60)
|
||||
print("Examples Complete")
|
||||
print("=" * 60)
|
||||
@@ -0,0 +1,130 @@
|
||||
"""
|
||||
LSP Code Intelligence Example
|
||||
|
||||
This example demonstrates how to use LSP-powered tools through an Agent
|
||||
for semantic code analysis (listing symbols, finding definitions, etc.).
|
||||
|
||||
How to run:
|
||||
export OPENAI_API_KEY=your_key
|
||||
python examples/lsp/lsp_code_analysis_example.py
|
||||
|
||||
Prerequisites:
|
||||
pip install praisonai praisonaiagents
|
||||
pip install python-lsp-server # Optional, for full LSP support
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import os
|
||||
import sys
|
||||
|
||||
# Add paths for development
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai'))
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../src/praisonai-agents'))
|
||||
|
||||
|
||||
async def main():
|
||||
print("=" * 60)
|
||||
print("LSP CODE INTELLIGENCE EXAMPLE")
|
||||
print("=" * 60)
|
||||
print()
|
||||
|
||||
# Import after path setup
|
||||
from praisonai.cli.features import (
|
||||
create_agent_centric_tools,
|
||||
InteractiveRuntime,
|
||||
RuntimeConfig
|
||||
)
|
||||
from praisonaiagents import Agent
|
||||
|
||||
# Use the praisonaiagents source as workspace for analysis
|
||||
workspace = os.path.join(
|
||||
os.path.dirname(__file__),
|
||||
'../../src/praisonai-agents/praisonaiagents'
|
||||
)
|
||||
workspace = os.path.abspath(workspace)
|
||||
|
||||
print(f"Workspace: {workspace}")
|
||||
print()
|
||||
|
||||
# 1. Create runtime with LSP enabled
|
||||
print("1. Creating InteractiveRuntime with LSP...")
|
||||
config = RuntimeConfig(
|
||||
workspace=workspace,
|
||||
lsp_enabled=True, # Enable LSP for code intelligence
|
||||
acp_enabled=False, # Disable ACP for this example
|
||||
approval_mode="auto"
|
||||
)
|
||||
runtime = InteractiveRuntime(config)
|
||||
status = await runtime.start()
|
||||
|
||||
print(f" LSP enabled: {status['lsp']['enabled']}")
|
||||
print(f" LSP ready: {runtime.lsp_ready}")
|
||||
print(f" LSP status: {status['lsp']['status']}")
|
||||
if not runtime.lsp_ready:
|
||||
print(" Note: LSP not available, will use regex fallback")
|
||||
print()
|
||||
|
||||
# 2. Create agent-centric tools
|
||||
print("2. Creating agent-centric tools...")
|
||||
tools = create_agent_centric_tools(runtime)
|
||||
|
||||
# Filter to show only LSP tools
|
||||
lsp_tools = [t for t in tools if t.__name__.startswith('lsp_')]
|
||||
print(f" LSP tools available:")
|
||||
for tool in lsp_tools:
|
||||
print(f" - {tool.__name__}")
|
||||
print()
|
||||
|
||||
# 3. Create Agent with LSP-powered tools
|
||||
print("3. Creating Agent with LSP tools...")
|
||||
agent = Agent(
|
||||
name="CodeAnalyzer",
|
||||
instructions="""You are a code analysis assistant.
|
||||
Use lsp_list_symbols to list functions and classes in files.
|
||||
Use lsp_find_definition to find where symbols are defined.
|
||||
Use lsp_find_references to find where symbols are used.
|
||||
Provide clear, organized summaries of code structure.""",
|
||||
tools=tools,
|
||||
verbose=True
|
||||
)
|
||||
print()
|
||||
|
||||
# 4. Test 1: List symbols in a file
|
||||
print("4. TEST 1: List symbols in agent/agent.py")
|
||||
print("-" * 50)
|
||||
result1 = agent.start("List all the main classes and public methods in agent/agent.py. Give me a brief summary.")
|
||||
print("-" * 50)
|
||||
print(f"Summary: {str(result1)[:300]}...")
|
||||
print()
|
||||
|
||||
# 5. Test 2: Find definition of a symbol
|
||||
print("5. TEST 2: Find where 'Agent' class is defined")
|
||||
print("-" * 50)
|
||||
result2 = agent.start("Where is the Agent class defined? Use lsp_find_definition to find it.")
|
||||
print("-" * 50)
|
||||
print(f"Result: {str(result2)[:300]}...")
|
||||
print()
|
||||
|
||||
# 6. Test 3: Analyze main.py
|
||||
print("6. TEST 3: Analyze main.py structure")
|
||||
print("-" * 50)
|
||||
result3 = agent.start("List all the functions in main.py and briefly describe what the file does.")
|
||||
print("-" * 50)
|
||||
print(f"Analysis: {str(result3)[:300]}...")
|
||||
print()
|
||||
|
||||
# Cleanup
|
||||
await runtime.stop()
|
||||
|
||||
print("=" * 60)
|
||||
print("EXAMPLE COMPLETE")
|
||||
print("=" * 60)
|
||||
print()
|
||||
print("Key takeaways:")
|
||||
print("- LSP tools work through the Agent (agentic LSP)")
|
||||
print("- Falls back to regex if LSP server not available")
|
||||
print("- Returns structured data with citations")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,133 @@
|
||||
"""
|
||||
PraisonAI Output UX Examples
|
||||
|
||||
This example demonstrates the various output modes and configurations
|
||||
available in PraisonAI agents.
|
||||
|
||||
Features demonstrated:
|
||||
- verbose=True: Full output with agent info, task, and response panels
|
||||
- verbose=False: Clean output with just the result
|
||||
- Tool call display with consolidated output
|
||||
- Multi-agent output with clear attribution
|
||||
"""
|
||||
|
||||
import sys
|
||||
sys.path.insert(0, '/Users/praison/praisonai-package/src/praisonai-agents')
|
||||
from praisonaiagents import Agent, Task, PraisonAIAgents
|
||||
|
||||
|
||||
def get_weather(city: str) -> str:
|
||||
"""Get the current weather for a city.
|
||||
|
||||
Args:
|
||||
city: The name of the city to get weather for
|
||||
|
||||
Returns:
|
||||
Weather information string
|
||||
"""
|
||||
return f"The weather in {city} is sunny and 72°F"
|
||||
|
||||
|
||||
def example_verbose_true():
|
||||
"""Example with verbose=True (default) - shows full output panels."""
|
||||
print("\n" + "=" * 60)
|
||||
print("EXAMPLE 1: verbose=True (Full Output)")
|
||||
print("=" * 60)
|
||||
|
||||
agent = Agent(
|
||||
name="Assistant",
|
||||
instructions="You are a helpful assistant. Be concise.",
|
||||
verbose=True # Default - shows Agent Info, Task, and Response panels
|
||||
)
|
||||
result = agent.start("What is the capital of France? Answer in one sentence.")
|
||||
print(f"\nReturned value: {result}")
|
||||
|
||||
|
||||
def example_verbose_false():
|
||||
"""Example with verbose=False - clean output, just the result."""
|
||||
print("\n" + "=" * 60)
|
||||
print("EXAMPLE 2: verbose=False (Clean Output)")
|
||||
print("=" * 60)
|
||||
|
||||
agent = Agent(
|
||||
name="Assistant",
|
||||
instructions="You are a helpful assistant. Be concise.",
|
||||
verbose=False # No panels, just returns the result
|
||||
)
|
||||
result = agent.start("What is 2+2? Answer in one word.")
|
||||
print(f"Result: {result}")
|
||||
|
||||
|
||||
def example_with_tools():
|
||||
"""Example showing tool call output."""
|
||||
print("\n" + "=" * 60)
|
||||
print("EXAMPLE 3: Agent with Tools")
|
||||
print("=" * 60)
|
||||
|
||||
agent = Agent(
|
||||
name="Weather Bot",
|
||||
instructions="You help users check the weather. Use the get_weather tool.",
|
||||
tools=[get_weather],
|
||||
verbose=True
|
||||
)
|
||||
result = agent.start("What's the weather in Tokyo?")
|
||||
print(f"\nReturned value: {result}")
|
||||
|
||||
|
||||
def example_multi_agent():
|
||||
"""Example showing multi-agent output with clear attribution."""
|
||||
print("\n" + "=" * 60)
|
||||
print("EXAMPLE 4: Multi-Agent Output")
|
||||
print("=" * 60)
|
||||
|
||||
researcher = Agent(
|
||||
name="Researcher",
|
||||
role="Research Analyst",
|
||||
instructions="You research topics and provide factual information.",
|
||||
verbose=True
|
||||
)
|
||||
|
||||
writer = Agent(
|
||||
name="Writer",
|
||||
role="Content Writer",
|
||||
instructions="You write clear summaries based on research.",
|
||||
verbose=True
|
||||
)
|
||||
|
||||
task1 = Task(
|
||||
description="Research what AI is in one sentence",
|
||||
expected_output="A brief factual description",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
task2 = Task(
|
||||
description="Write a one-sentence summary about AI",
|
||||
expected_output="A clear summary",
|
||||
agent=writer
|
||||
)
|
||||
|
||||
agents = PraisonAIAgents(
|
||||
agents=[researcher, writer],
|
||||
tasks=[task1, task2],
|
||||
process="sequential",
|
||||
verbose=1
|
||||
)
|
||||
|
||||
result = agents.start()
|
||||
print(f"\nFinal result: {result}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("=" * 60)
|
||||
print("PRAISONAI OUTPUT UX EXAMPLES")
|
||||
print("=" * 60)
|
||||
|
||||
# Run examples
|
||||
example_verbose_true()
|
||||
example_verbose_false()
|
||||
example_with_tools()
|
||||
example_multi_agent()
|
||||
|
||||
print("\n" + "=" * 60)
|
||||
print("ALL EXAMPLES COMPLETE")
|
||||
print("=" * 60)
|
||||
@@ -0,0 +1,83 @@
|
||||
# PraisonAI Profiling Examples
|
||||
|
||||
This directory contains examples for profiling PraisonAI agent performance.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
```bash
|
||||
pip install praisonai
|
||||
export OPENAI_API_KEY=your_key_here
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
### 1. Basic Profiling (`basic_profiling.py`)
|
||||
|
||||
Demonstrates programmatic profiling of a single query:
|
||||
|
||||
```bash
|
||||
python basic_profiling.py
|
||||
```
|
||||
|
||||
### 2. Suite Profiling (`suite_profiling.py`)
|
||||
|
||||
Runs a comprehensive profiling suite with multiple scenarios:
|
||||
|
||||
```bash
|
||||
python suite_profiling.py
|
||||
```
|
||||
|
||||
### 3. Optimization Demo (`optimization_example.py`)
|
||||
|
||||
Demonstrates Tier 0/1/2 performance optimizations:
|
||||
|
||||
```bash
|
||||
python optimization_example.py
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
|
||||
You can also profile directly from the command line:
|
||||
|
||||
```bash
|
||||
# Profile a query
|
||||
praisonai profile query "What is 2+2?"
|
||||
|
||||
# Profile with file grouping
|
||||
praisonai profile query "Hello" --show-files --limit 20
|
||||
|
||||
# Profile imports
|
||||
praisonai profile imports
|
||||
|
||||
# Profile startup time
|
||||
praisonai profile startup
|
||||
|
||||
# Run comprehensive suite
|
||||
praisonai profile suite --quick
|
||||
|
||||
# Create performance baseline
|
||||
praisonai profile snapshot --baseline
|
||||
|
||||
# Compare against baseline
|
||||
praisonai profile snapshot current --compare
|
||||
|
||||
# Show optimization status
|
||||
praisonai profile optimize --show
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
- **Text output**: Human-readable timing breakdown
|
||||
- **JSON output**: Machine-readable for CI/CD (`--format json`)
|
||||
- **Artifacts**: Binary cProfile data and reports (`--save ./results`)
|
||||
- **Snapshots**: Performance baselines for regression detection
|
||||
|
||||
## Performance Optimizations
|
||||
|
||||
Enable opt-in optimizations via environment variables:
|
||||
|
||||
```bash
|
||||
export PRAISONAI_LITE_MODE=1
|
||||
export PRAISONAI_SKIP_TYPE_VALIDATION=1
|
||||
export PRAISONAI_MINIMAL_IMPORTS=1
|
||||
```
|
||||
@@ -0,0 +1,71 @@
|
||||
"""
|
||||
Basic Profiling Example for PraisonAI
|
||||
|
||||
This example demonstrates how to use the unified profiler programmatically
|
||||
to measure agent performance.
|
||||
|
||||
Run with:
|
||||
python basic_profiling.py
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
# Ensure API key is set
|
||||
if not os.environ.get("OPENAI_API_KEY"):
|
||||
print("Please set OPENAI_API_KEY environment variable")
|
||||
exit(1)
|
||||
|
||||
from praisonai.cli.execution import (
|
||||
ExecutionRequest,
|
||||
Profiler,
|
||||
ProfilerConfig,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
"""Run a profiled query and display results."""
|
||||
|
||||
# Configure profiler (Layer 1 = basic profiling with function stats)
|
||||
config = ProfilerConfig(
|
||||
layer=1, # 0=minimal, 1=basic, 2=deep
|
||||
limit=15, # Show top 15 functions
|
||||
show_callers=False, # Set True for caller info (layer 2)
|
||||
show_callees=False, # Set True for callee info (layer 2)
|
||||
)
|
||||
|
||||
# Create execution request
|
||||
request = ExecutionRequest(
|
||||
prompt="What is 2+2?",
|
||||
agent_name="ProfiledAgent",
|
||||
)
|
||||
|
||||
# Run profiled query
|
||||
print("🔬 Running profiled query...")
|
||||
profiler = Profiler(config)
|
||||
result, report = profiler.profile_sync(request)
|
||||
|
||||
# Print formatted report
|
||||
print("\n" + report.to_text())
|
||||
|
||||
# Access timing data programmatically
|
||||
print("\n📊 Timing Summary:")
|
||||
print(f" Imports: {report.timing.imports_ms:>10.2f} ms")
|
||||
print(f" Agent Init: {report.timing.agent_init_ms:>10.2f} ms")
|
||||
print(f" Execution: {report.timing.execution_ms:>10.2f} ms")
|
||||
print(f" Total: {report.timing.total_ms:>10.2f} ms")
|
||||
|
||||
# Show top 5 functions
|
||||
if report.functions:
|
||||
print("\n🔥 Top 5 Functions by Cumulative Time:")
|
||||
for i, func in enumerate(report.functions[:5], 1):
|
||||
print(f" {i}. {func.name}: {func.cumulative_time_ms:.2f}ms")
|
||||
|
||||
# Show response
|
||||
print(f"\n💬 Response: {result.output}")
|
||||
|
||||
# Export to JSON
|
||||
print("\n📄 JSON Export available via: report.to_json()")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,223 @@
|
||||
"""
|
||||
Performance Optimization Example for PraisonAI
|
||||
|
||||
This example demonstrates how to use the Tier 0/1/2 optimization features
|
||||
programmatically.
|
||||
|
||||
Run with:
|
||||
python optimization_example.py
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
# Ensure API key is set
|
||||
if not os.environ.get("OPENAI_API_KEY"):
|
||||
print("Please set OPENAI_API_KEY environment variable")
|
||||
exit(1)
|
||||
|
||||
|
||||
def demo_provider_cache():
|
||||
"""Demonstrate provider caching (Tier 0)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 0: Provider Cache Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import (
|
||||
get_provider_cache,
|
||||
resolve_model_provider,
|
||||
)
|
||||
|
||||
cache = get_provider_cache()
|
||||
cache.invalidate() # Start fresh
|
||||
|
||||
# Resolve some models
|
||||
models = ['gpt-4o', 'claude-3-opus', 'gemini-pro', 'gpt-4o-mini']
|
||||
|
||||
print("\nResolving models:")
|
||||
for model in models:
|
||||
provider, name = resolve_model_provider(model)
|
||||
print(f" {model} -> {provider}/{name}")
|
||||
|
||||
# Check cache stats
|
||||
stats = cache.get_stats()
|
||||
print("\nCache Stats:")
|
||||
print(f" Hits: {stats['hits']}")
|
||||
print(f" Misses: {stats['misses']}")
|
||||
print(f" Size: {stats['size']}")
|
||||
|
||||
|
||||
def demo_lazy_importer():
|
||||
"""Demonstrate lazy imports (Tier 0)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 0: Lazy Importer Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import LazyImporter
|
||||
import time
|
||||
|
||||
LazyImporter.clear()
|
||||
|
||||
# Time lazy import
|
||||
start = time.perf_counter()
|
||||
json_module = LazyImporter.get('json')
|
||||
first_import = (time.perf_counter() - start) * 1000
|
||||
|
||||
# Second import (cached)
|
||||
start = time.perf_counter()
|
||||
json_module2 = LazyImporter.get('json')
|
||||
cached_import = (time.perf_counter() - start) * 1000
|
||||
|
||||
print(f"\nFirst import: {first_import:.3f}ms")
|
||||
print(f"Cached import: {cached_import:.3f}ms")
|
||||
print(f"Same object: {json_module is json_module2}")
|
||||
|
||||
|
||||
def demo_client_pool():
|
||||
"""Demonstrate client pooling (Tier 1)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 1: Client Pool Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import ClientPool
|
||||
|
||||
pool = ClientPool(max_size=3)
|
||||
|
||||
# Create some mock clients
|
||||
def create_client(name):
|
||||
return {'name': name, 'created': True}
|
||||
|
||||
# Get or create clients
|
||||
client1 = pool.get_or_create('openai', lambda: create_client('openai'))
|
||||
_ = pool.get_or_create('anthropic', lambda: create_client('anthropic'))
|
||||
|
||||
# Reuse existing client
|
||||
client1_again = pool.get_or_create('openai', lambda: create_client('openai_new'))
|
||||
|
||||
print(f"\nPool size: {pool.size()}")
|
||||
print(f"Client reused: {client1 is client1_again}")
|
||||
print(f"Client1 name: {client1['name']}")
|
||||
|
||||
|
||||
def demo_prewarm():
|
||||
"""Demonstrate pre-warming (Tier 1)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 1: Pre-warming Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import PrewarmManager
|
||||
import time
|
||||
|
||||
PrewarmManager.reset()
|
||||
|
||||
print(f"\nPre-warming enabled: {PrewarmManager.is_enabled()}")
|
||||
|
||||
# Enable and prewarm
|
||||
PrewarmManager.enable()
|
||||
print(f"After enable: {PrewarmManager.is_enabled()}")
|
||||
|
||||
# Prewarm OpenAI (runs in background)
|
||||
PrewarmManager.prewarm_provider('openai')
|
||||
print("Pre-warming OpenAI in background...")
|
||||
|
||||
# Wait a bit for background thread
|
||||
time.sleep(0.5)
|
||||
|
||||
print(f"OpenAI prewarmed: {PrewarmManager.is_prewarmed('openai')}")
|
||||
|
||||
PrewarmManager.reset()
|
||||
|
||||
|
||||
def demo_lite_mode():
|
||||
"""Demonstrate lite mode (Tier 2)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 2: Lite Mode Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import (
|
||||
LiteModeConfig,
|
||||
is_lite_mode,
|
||||
)
|
||||
|
||||
# Default config
|
||||
config = LiteModeConfig()
|
||||
print(f"\nDefault lite mode: {config.enabled}")
|
||||
|
||||
# Config from env
|
||||
print("\nTo enable lite mode, set environment variables:")
|
||||
print(" export PRAISONAI_LITE_MODE=1")
|
||||
print(" export PRAISONAI_SKIP_TYPE_VALIDATION=1")
|
||||
|
||||
print(f"\nCurrent is_lite_mode(): {is_lite_mode()}")
|
||||
|
||||
|
||||
def demo_perf_snapshot():
|
||||
"""Demonstrate performance snapshots (Tier 2)."""
|
||||
print("\n" + "=" * 60)
|
||||
print("Tier 2: Performance Snapshot Demo")
|
||||
print("=" * 60)
|
||||
|
||||
from praisonai.cli.features.profiler import (
|
||||
PerfSnapshot,
|
||||
PerfComparison,
|
||||
PerfSnapshotManager,
|
||||
)
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
# Create manager with temp directory
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
manager = PerfSnapshotManager(snapshot_dir=Path(tmpdir))
|
||||
|
||||
# Create baseline
|
||||
baseline = PerfSnapshot(
|
||||
timestamp='2025-01-01T00:00:00Z',
|
||||
name='baseline',
|
||||
startup_cold_ms=100.0,
|
||||
startup_warm_ms=80.0,
|
||||
import_time_ms=500.0,
|
||||
query_time_ms=2000.0,
|
||||
first_token_ms=300.0,
|
||||
)
|
||||
manager.save_baseline(baseline)
|
||||
print("\nBaseline saved")
|
||||
|
||||
# Create current snapshot (simulated improvement)
|
||||
current = PerfSnapshot(
|
||||
timestamp='2025-01-02T00:00:00Z',
|
||||
name='current',
|
||||
startup_cold_ms=95.0, # 5% faster
|
||||
startup_warm_ms=78.0,
|
||||
import_time_ms=480.0, # 4% faster
|
||||
query_time_ms=1900.0, # 5% faster
|
||||
first_token_ms=280.0,
|
||||
)
|
||||
|
||||
# Compare
|
||||
comparison = PerfComparison(baseline=baseline, current=current)
|
||||
|
||||
print(f"\nStartup improvement: {-comparison.startup_cold_diff_pct:.1f}%")
|
||||
print(f"Import improvement: {-comparison.import_time_diff_pct:.1f}%")
|
||||
print(f"Query improvement: {-comparison.query_time_diff_pct:.1f}%")
|
||||
print(f"Is regression: {comparison.is_regression()}")
|
||||
|
||||
|
||||
def main():
|
||||
"""Run all demos."""
|
||||
print("=" * 60)
|
||||
print("PraisonAI Performance Optimization Demo")
|
||||
print("=" * 60)
|
||||
|
||||
demo_provider_cache()
|
||||
demo_lazy_importer()
|
||||
demo_client_pool()
|
||||
demo_prewarm()
|
||||
demo_lite_mode()
|
||||
demo_perf_snapshot()
|
||||
|
||||
print("\n" + "=" * 60)
|
||||
print("All demos complete!")
|
||||
print("=" * 60)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,227 @@
|
||||
{
|
||||
"timestamp": "2025-12-31T18:45:38.187539Z",
|
||||
"metadata": {
|
||||
"python_version": "3.12.11",
|
||||
"platform": "macOS-15.7.4-arm64-arm-64bit",
|
||||
"praisonai_version": "2.9.2",
|
||||
"timestamp": "2025-12-31T18:45:38.226558Z"
|
||||
},
|
||||
"startup": {
|
||||
"cold_ms": 80.9305000002496,
|
||||
"warm_ms": 55.266541996388696
|
||||
},
|
||||
"import_analysis": [
|
||||
{
|
||||
"module": "praisonaiagents",
|
||||
"self_us": 2419,
|
||||
"cumulative_us": 1645390,
|
||||
"self_ms": 2.419,
|
||||
"cumulative_ms": 1645.39
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.workflows",
|
||||
"self_us": 670,
|
||||
"cumulative_us": 1375919,
|
||||
"self_ms": 0.67,
|
||||
"cumulative_ms": 1375.919
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.workflows.yaml_parser",
|
||||
"self_us": 775,
|
||||
"cumulative_us": 1369435,
|
||||
"self_ms": 0.775,
|
||||
"cumulative_ms": 1369.435
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.agent.agent",
|
||||
"self_us": 19,
|
||||
"cumulative_us": 1349174,
|
||||
"self_ms": 0.019,
|
||||
"cumulative_ms": 1349.174
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.agent",
|
||||
"self_us": 537,
|
||||
"cumulative_us": 1349155,
|
||||
"self_ms": 0.537,
|
||||
"cumulative_ms": 1349.155
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.agent.agent",
|
||||
"self_us": 1453,
|
||||
"cumulative_us": 1285299,
|
||||
"self_ms": 1.453,
|
||||
"cumulative_ms": 1285.299
|
||||
},
|
||||
{
|
||||
"module": "praisonaiagents.llm.openai_client",
|
||||
"self_us": 7887,
|
||||
"cumulative_us": 1123578,
|
||||
"self_ms": 7.887,
|
||||
"cumulative_ms": 1123.578
|
||||
},
|
||||
{
|
||||
"module": "openai",
|
||||
"self_us": 1083,
|
||||
"cumulative_us": 1115692,
|
||||
"self_ms": 1.083,
|
||||
"cumulative_ms": 1115.692
|
||||
},
|
||||
{
|
||||
"module": "openai.types",
|
||||
"self_us": 2606,
|
||||
"cumulative_us": 957990,
|
||||
"self_ms": 2.606,
|
||||
"cumulative_ms": 957.99
|
||||
},
|
||||
{
|
||||
"module": "openai.types.batch",
|
||||
"self_us": 1787,
|
||||
"cumulative_us": 485667,
|
||||
"self_ms": 1.787,
|
||||
"cumulative_ms": 485.667
|
||||
},
|
||||
{
|
||||
"module": "openai._models",
|
||||
"self_us": 13423,
|
||||
"cumulative_us": 450798,
|
||||
"self_ms": 13.423,
|
||||
"cumulative_ms": 450.798
|
||||
},
|
||||
{
|
||||
"module": "openai.types.eval_create_params",
|
||||
"self_us": 644,
|
||||
"cumulative_us": 393275,
|
||||
"self_ms": 0.644,
|
||||
"cumulative_ms": 393.275
|
||||
},
|
||||
{
|
||||
"module": "openai.types.graders.grader_inputs_param",
|
||||
"self_us": 17,
|
||||
"cumulative_us": 359515,
|
||||
"self_ms": 0.017,
|
||||
"cumulative_ms": 359.515
|
||||
},
|
||||
{
|
||||
"module": "openai.types.graders",
|
||||
"self_us": 392,
|
||||
"cumulative_us": 359498,
|
||||
"self_ms": 0.392,
|
||||
"cumulative_ms": 359.498
|
||||
},
|
||||
{
|
||||
"module": "openai.types.graders.multi_grader",
|
||||
"self_us": 3847,
|
||||
"cumulative_us": 351251,
|
||||
"self_ms": 3.847,
|
||||
"cumulative_ms": 351.251
|
||||
},
|
||||
{
|
||||
"module": "openai.types.graders.label_model_grader",
|
||||
"self_us": 5450,
|
||||
"cumulative_us": 337291,
|
||||
"self_ms": 5.45,
|
||||
"cumulative_ms": 337.291
|
||||
},
|
||||
{
|
||||
"module": "openai.types.graders.grader_inputs",
|
||||
"self_us": 545,
|
||||
"cumulative_us": 331841,
|
||||
"self_ms": 0.545,
|
||||
"cumulative_ms": 331.841
|
||||
},
|
||||
{
|
||||
"module": "openai.types.responses.response_input_text",
|
||||
"self_us": 21,
|
||||
"cumulative_us": 331297,
|
||||
"self_ms": 0.021,
|
||||
"cumulative_ms": 331.297
|
||||
},
|
||||
{
|
||||
"module": "openai.types.responses",
|
||||
"self_us": 1301,
|
||||
"cumulative_us": 331277,
|
||||
"self_ms": 1.301,
|
||||
"cumulative_ms": 331.277
|
||||
},
|
||||
{
|
||||
"module": "rich.logging",
|
||||
"self_us": 1066,
|
||||
"cumulative_us": 238256,
|
||||
"self_ms": 1.066,
|
||||
"cumulative_ms": 238.256
|
||||
}
|
||||
],
|
||||
"scenarios": [
|
||||
{
|
||||
"name": "simple_query",
|
||||
"config": {
|
||||
"prompt": "What is 2+2?",
|
||||
"model": "default",
|
||||
"stream": false,
|
||||
"iterations": 2
|
||||
},
|
||||
"import_time_stats": {
|
||||
"mean": 0.008833496394800022,
|
||||
"min": 0.005916997906751931,
|
||||
"max": 0.011749994882848114,
|
||||
"stdev": 0.0041245517164382375,
|
||||
"median": 0.008833496394800022
|
||||
},
|
||||
"total_time_stats": {
|
||||
"mean": 1727.4090415012324,
|
||||
"min": 1367.2264170018025,
|
||||
"max": 2087.5916660006624,
|
||||
"stdev": 509.3751524982296,
|
||||
"median": 1727.4090415012324
|
||||
},
|
||||
"first_token_stats": null,
|
||||
"raw_import_times_ms": [
|
||||
0.011749994882848114,
|
||||
0.005916997906751931
|
||||
],
|
||||
"raw_total_times_ms": [
|
||||
1367.2264170018025,
|
||||
2087.5916660006624
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "simple_stream",
|
||||
"config": {
|
||||
"prompt": "What is 2+2?",
|
||||
"model": "default",
|
||||
"stream": true,
|
||||
"iterations": 2
|
||||
},
|
||||
"import_time_stats": {
|
||||
"mean": 0.008792001608526334,
|
||||
"min": 0.006375004886649549,
|
||||
"max": 0.01120899833040312,
|
||||
"stdev": 0.0034181495442894613,
|
||||
"median": 0.008792001608526334
|
||||
},
|
||||
"total_time_stats": {
|
||||
"mean": 2321.0982290001994,
|
||||
"min": 1697.1089580038097,
|
||||
"max": 2945.087499996589,
|
||||
"stdev": 882.4540898183949,
|
||||
"median": 2321.0982290001994
|
||||
},
|
||||
"first_token_stats": {
|
||||
"mean": 2312.8511880022415,
|
||||
"min": 1681.2440420035273,
|
||||
"max": 2944.458334000956,
|
||||
"stdev": 893.2273919631452,
|
||||
"median": 2312.8511880022415
|
||||
},
|
||||
"raw_import_times_ms": [
|
||||
0.01120899833040312,
|
||||
0.006375004886649549
|
||||
],
|
||||
"raw_total_times_ms": [
|
||||
2945.087499996589,
|
||||
1697.1089580038097
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
"""
|
||||
Profile Suite Example for PraisonAI
|
||||
|
||||
This example demonstrates how to run a comprehensive profiling suite
|
||||
programmatically with multiple scenarios.
|
||||
|
||||
Run with:
|
||||
python suite_profiling.py
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
# Ensure API key is set
|
||||
if not os.environ.get("OPENAI_API_KEY"):
|
||||
print("Please set OPENAI_API_KEY environment variable")
|
||||
exit(1)
|
||||
|
||||
from praisonai.cli.features.profiler import (
|
||||
ScenarioConfig,
|
||||
run_profile_suite,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
"""Run a profiling suite with custom scenarios."""
|
||||
|
||||
# Define custom scenarios
|
||||
scenarios = [
|
||||
ScenarioConfig(
|
||||
name="simple_query",
|
||||
prompt="What is 2+2?",
|
||||
stream=False,
|
||||
iterations=2,
|
||||
warmup=1,
|
||||
),
|
||||
ScenarioConfig(
|
||||
name="simple_stream",
|
||||
prompt="What is 2+2?",
|
||||
stream=True,
|
||||
iterations=2,
|
||||
warmup=1,
|
||||
),
|
||||
]
|
||||
|
||||
# Run suite with custom output directory
|
||||
print("🔬 Running Profile Suite...")
|
||||
result = run_profile_suite(
|
||||
output_dir="./profile_results",
|
||||
scenarios=scenarios,
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Print summary
|
||||
print("\n" + "=" * 60)
|
||||
print("Profile Suite Results")
|
||||
print("=" * 60)
|
||||
|
||||
print("\n📊 Startup Times:")
|
||||
print(f" Cold Start: {result.startup_cold_ms:.2f}ms")
|
||||
print(f" Warm Start: {result.startup_warm_ms:.2f}ms")
|
||||
|
||||
if result.import_analysis:
|
||||
print("\n📦 Top Import:")
|
||||
print(f" {result.import_analysis[0]['module']}: {result.import_analysis[0]['cumulative_ms']:.2f}ms")
|
||||
|
||||
print("\n🎯 Scenario Results:")
|
||||
for scenario in result.scenarios:
|
||||
stats = scenario.get_stats(scenario.total_times)
|
||||
print(f" {scenario.name}:")
|
||||
print(f" Mean: {stats['mean']:.2f}ms")
|
||||
print(f" Min: {stats['min']:.2f}ms")
|
||||
print(f" Max: {stats['max']:.2f}ms")
|
||||
|
||||
print("\n✅ Results saved to: ./profile_results/")
|
||||
print(" - suite_results.json (machine-readable)")
|
||||
print(" - suite_report.txt (human-readable)")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,30 @@
|
||||
"""
|
||||
Basic TUI Usage Example for PraisonAI.
|
||||
|
||||
This example demonstrates how to launch the interactive TUI.
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
# Ensure API key is set
|
||||
if not os.environ.get("OPENAI_API_KEY"):
|
||||
print("Please set OPENAI_API_KEY environment variable")
|
||||
exit(1)
|
||||
|
||||
|
||||
def main():
|
||||
"""Launch the TUI."""
|
||||
try:
|
||||
from praisonai.cli.features.tui import run_tui
|
||||
|
||||
# Launch with default settings
|
||||
run_tui()
|
||||
|
||||
except ImportError:
|
||||
print("Textual is required for TUI. Install with:")
|
||||
print(" pip install praisonai[tui]")
|
||||
exit(1)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,134 @@
|
||||
"""
|
||||
Headless TUI Simulation Example for PraisonAI.
|
||||
|
||||
This example demonstrates how to run TUI simulations without
|
||||
launching the interactive UI - useful for testing and CI.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from praisonai.cli.features.tui import (
|
||||
TuiOrchestrator,
|
||||
SimulationRunner,
|
||||
MockProvider,
|
||||
)
|
||||
from praisonai.cli.features.tui.orchestrator import OutputMode
|
||||
from praisonai.cli.features.queue import QueueConfig
|
||||
|
||||
|
||||
async def run_simulation():
|
||||
"""Run a headless simulation."""
|
||||
|
||||
# Create orchestrator with mock provider (no real API calls)
|
||||
config = QueueConfig(enable_persistence=False)
|
||||
orchestrator = TuiOrchestrator(
|
||||
queue_config=config,
|
||||
output_mode=OutputMode.PRETTY,
|
||||
debug=True,
|
||||
)
|
||||
|
||||
# Create simulation runner
|
||||
runner = SimulationRunner(orchestrator, assert_mode=True)
|
||||
|
||||
# Define simulation script
|
||||
script = {
|
||||
"session_id": "sim-example",
|
||||
"model": "gpt-4o-mini",
|
||||
"steps": [
|
||||
# Navigate to different screens
|
||||
{"action": "navigate", "args": {"screen": "main"}},
|
||||
{"action": "focus", "args": {"widget": "composer"}},
|
||||
|
||||
# Change model
|
||||
{
|
||||
"action": "model",
|
||||
"args": {"model": "gpt-4"},
|
||||
"expected": {"model": "gpt-4"}
|
||||
},
|
||||
|
||||
# Navigate to queue screen
|
||||
{"action": "navigate", "args": {"screen": "queue"}},
|
||||
|
||||
# Take a snapshot
|
||||
{"action": "snapshot"},
|
||||
|
||||
# Navigate back
|
||||
{"action": "navigate", "args": {"screen": "main"}},
|
||||
|
||||
# Small delay
|
||||
{"action": "sleep", "args": {"seconds": 0.5}},
|
||||
]
|
||||
}
|
||||
|
||||
# Run the simulation
|
||||
print("Running headless TUI simulation...")
|
||||
print("=" * 50)
|
||||
|
||||
success = await runner.run_script(script)
|
||||
|
||||
# Print results
|
||||
print("=" * 50)
|
||||
summary = runner.get_summary()
|
||||
|
||||
print(f"\nSimulation {'PASSED' if success else 'FAILED'}")
|
||||
print(f" Assertions passed: {summary['assertions_passed']}")
|
||||
print(f" Assertions failed: {summary['assertions_failed']}")
|
||||
|
||||
if summary['errors']:
|
||||
print("\nErrors:")
|
||||
for error in summary['errors']:
|
||||
print(f" - {error}")
|
||||
|
||||
return success
|
||||
|
||||
|
||||
async def run_with_events():
|
||||
"""Run simulation and capture all events."""
|
||||
|
||||
config = QueueConfig(enable_persistence=False)
|
||||
orchestrator = TuiOrchestrator(
|
||||
queue_config=config,
|
||||
output_mode=OutputMode.SILENT,
|
||||
)
|
||||
|
||||
# Capture events
|
||||
events = []
|
||||
orchestrator.add_event_callback(lambda e: events.append(e))
|
||||
|
||||
await orchestrator.start(session_id="event-capture")
|
||||
|
||||
# Perform some actions
|
||||
orchestrator.set_model("gpt-4")
|
||||
orchestrator.navigate_screen("queue")
|
||||
orchestrator.set_focus("queue-panel")
|
||||
orchestrator.navigate_screen("main")
|
||||
|
||||
await orchestrator.stop()
|
||||
|
||||
# Print captured events
|
||||
print("\nCaptured Events:")
|
||||
print("-" * 40)
|
||||
for event in events:
|
||||
print(f" {event.event_type.value}")
|
||||
|
||||
return events
|
||||
|
||||
|
||||
def main():
|
||||
"""Main entry point."""
|
||||
print("PraisonAI TUI Headless Simulation Example")
|
||||
print("=" * 50)
|
||||
|
||||
# Run simulation
|
||||
success = asyncio.run(run_simulation())
|
||||
|
||||
# Run event capture
|
||||
print("\n" + "=" * 50)
|
||||
events = asyncio.run(run_with_events())
|
||||
|
||||
print(f"\nTotal events captured: {len(events)}")
|
||||
|
||||
return 0 if success else 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
exit(main())
|
||||
@@ -0,0 +1,122 @@
|
||||
"""
|
||||
Queue Management Example for PraisonAI.
|
||||
|
||||
This example demonstrates how to use the queue system programmatically.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from praisonai.cli.features.queue import (
|
||||
QueueManager,
|
||||
QueueConfig,
|
||||
QueuedRun,
|
||||
RunState,
|
||||
RunPriority,
|
||||
)
|
||||
|
||||
|
||||
async def main():
|
||||
"""Demonstrate queue management."""
|
||||
|
||||
print("PraisonAI Queue Management Example")
|
||||
print("=" * 50)
|
||||
|
||||
# Create queue configuration
|
||||
config = QueueConfig(
|
||||
max_concurrent_global=2,
|
||||
max_concurrent_per_agent=1,
|
||||
max_queue_size=10,
|
||||
enable_persistence=False, # Use in-memory for demo
|
||||
)
|
||||
|
||||
# Track outputs
|
||||
outputs = {}
|
||||
|
||||
async def on_output(run_id: str, chunk: str):
|
||||
if run_id not in outputs:
|
||||
outputs[run_id] = ""
|
||||
outputs[run_id] += chunk
|
||||
print(f" [{run_id[:8]}] {chunk}", end="", flush=True)
|
||||
|
||||
async def on_complete(run_id: str, run: QueuedRun):
|
||||
print(f"\n [{run_id[:8]}] Completed: {run.state.value}")
|
||||
|
||||
async def on_error(run_id: str, error: Exception):
|
||||
print(f"\n [{run_id[:8]}] Error: {error}")
|
||||
|
||||
# Create queue manager
|
||||
manager = QueueManager(
|
||||
config=config,
|
||||
on_output=on_output,
|
||||
on_complete=on_complete,
|
||||
on_error=on_error,
|
||||
)
|
||||
|
||||
# Start the manager
|
||||
await manager.start(recover=False)
|
||||
print("Queue manager started")
|
||||
|
||||
# Submit some runs with different priorities
|
||||
print("\nSubmitting runs...")
|
||||
|
||||
run1 = await manager.submit(
|
||||
input_content="Low priority task",
|
||||
agent_name="Agent1",
|
||||
priority=RunPriority.LOW,
|
||||
)
|
||||
print(f" Submitted run1: {run1} (LOW priority)")
|
||||
|
||||
run2 = await manager.submit(
|
||||
input_content="High priority task",
|
||||
agent_name="Agent2",
|
||||
priority=RunPriority.HIGH,
|
||||
)
|
||||
print(f" Submitted run2: {run2} (HIGH priority)")
|
||||
|
||||
run3 = await manager.submit(
|
||||
input_content="Normal priority task",
|
||||
agent_name="Agent1",
|
||||
priority=RunPriority.NORMAL,
|
||||
)
|
||||
print(f" Submitted run3: {run3} (NORMAL priority)")
|
||||
|
||||
# Check queue status
|
||||
print(f"\nQueue status:")
|
||||
print(f" Queued: {manager.queued_count}")
|
||||
print(f" Running: {manager.running_count}")
|
||||
|
||||
# List runs
|
||||
runs = manager.list_runs()
|
||||
print(f"\nAll runs ({len(runs)}):")
|
||||
for run in runs:
|
||||
print(f" {run.run_id[:8]}: {run.agent_name} - {run.state.value} ({run.priority.name})")
|
||||
|
||||
# Wait a bit for processing
|
||||
print("\nWaiting for processing...")
|
||||
await asyncio.sleep(2)
|
||||
|
||||
# Cancel a run
|
||||
if runs:
|
||||
cancel_id = runs[-1].run_id
|
||||
print(f"\nCancelling run: {cancel_id[:8]}")
|
||||
await manager.cancel(cancel_id)
|
||||
|
||||
# Get stats
|
||||
stats = manager.get_stats()
|
||||
print(f"\nQueue statistics:")
|
||||
print(f" Total runs: {stats.total_runs}")
|
||||
print(f" Queued: {stats.queued_count}")
|
||||
print(f" Running: {stats.running_count}")
|
||||
print(f" Succeeded: {stats.succeeded_count}")
|
||||
print(f" Failed: {stats.failed_count}")
|
||||
print(f" Cancelled: {stats.cancelled_count}")
|
||||
|
||||
# Stop the manager
|
||||
await manager.stop()
|
||||
print("\nQueue manager stopped")
|
||||
|
||||
print("\n" + "=" * 50)
|
||||
print("Example complete!")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -150,7 +150,10 @@ def _clean_display_content(content: str, max_length: int = 20000) -> str:
|
||||
return content.strip()
|
||||
|
||||
def display_interaction(message, response, markdown=True, generation_time=None, console=None, agent_name=None, agent_role=None, agent_tools=None, task_name=None, task_description=None, task_id=None):
|
||||
"""Synchronous version of display_interaction."""
|
||||
"""Synchronous version of display_interaction.
|
||||
|
||||
Displays the task/message and response in clean panels with response time in title.
|
||||
"""
|
||||
if console is None:
|
||||
console = Console()
|
||||
|
||||
@@ -179,16 +182,18 @@ def display_interaction(message, response, markdown=True, generation_time=None,
|
||||
task_description=task_description,
|
||||
task_id=task_id
|
||||
)
|
||||
# Rest of the display logic...
|
||||
|
||||
# Build response title with time (Agno-style: "Response (1.2s)")
|
||||
response_title = "Response"
|
||||
if generation_time:
|
||||
console.print(Text(f"Response generated in {generation_time:.1f}s", style="dim"))
|
||||
response_title = f"Response ({generation_time:.1f}s)"
|
||||
|
||||
if markdown:
|
||||
console.print(Panel.fit(Markdown(message), title="Task", border_style="cyan"))
|
||||
console.print(Panel.fit(Markdown(response), title="Response", border_style="cyan"))
|
||||
console.print(Panel.fit(Markdown(response), title=response_title, border_style="cyan"))
|
||||
else:
|
||||
console.print(Panel.fit(Text(message, style="bold green"), title="Task", border_style="cyan"))
|
||||
console.print(Panel.fit(Text(response, style="bold blue"), title="Response", border_style="cyan"))
|
||||
console.print(Panel.fit(Text(response, style="bold blue"), title=response_title, border_style="cyan"))
|
||||
|
||||
def display_self_reflection(message: str, console=None):
|
||||
if not message or not message.strip():
|
||||
@@ -226,7 +231,16 @@ def display_instruction(message: str, console=None, agent_name: str = None, agen
|
||||
if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
|
||||
console.print(Panel.fit(Text(message, style="bold blue"), title="Instruction", border_style="cyan"))
|
||||
|
||||
def display_tool_call(message: str, console=None):
|
||||
def display_tool_call(message: str, console=None, tool_name: str = None, tool_input: dict = None, tool_output: str = None):
|
||||
"""Display tool call information in a consolidated panel.
|
||||
|
||||
Args:
|
||||
message: The tool call message (legacy format)
|
||||
console: Rich console for output
|
||||
tool_name: Name of the tool being called
|
||||
tool_input: Input arguments to the tool
|
||||
tool_output: Output from the tool (if available)
|
||||
"""
|
||||
logging.debug(f"display_tool_call called with message: {repr(message)}")
|
||||
if not message or not message.strip():
|
||||
logging.debug("Empty message in display_tool_call, returning early")
|
||||
@@ -235,11 +249,21 @@ def display_tool_call(message: str, console=None):
|
||||
logging.debug(f"Cleaned message in display_tool_call: {repr(message)}")
|
||||
|
||||
# Execute synchronous callbacks (always, even when console is None)
|
||||
execute_sync_callback('tool_call', message=message)
|
||||
execute_sync_callback('tool_call', message=message, tool_name=tool_name, tool_input=tool_input, tool_output=tool_output)
|
||||
|
||||
# Only print panel if console is provided (verbose mode)
|
||||
if console is not None:
|
||||
console.print(Panel.fit(Text(message, style="bold cyan"), title="Tool Call", border_style="green"))
|
||||
# Build consolidated tool call display (Agno-style)
|
||||
if tool_name and tool_input is not None:
|
||||
# Format: tool_name(arg1=val1, arg2=val2)
|
||||
args_str = ", ".join(f"{k}={v}" for k, v in tool_input.items()) if tool_input else ""
|
||||
tool_display = f"• {tool_name}({args_str})"
|
||||
if tool_output:
|
||||
tool_display += f"\n → {tool_output}"
|
||||
console.print(Panel.fit(Text(tool_display, style="bold cyan"), title="Tool Call", border_style="green"))
|
||||
else:
|
||||
# Legacy format
|
||||
console.print(Panel.fit(Text(message, style="bold cyan"), title="Tool Call", border_style="green"))
|
||||
|
||||
def display_error(message: str, console=None):
|
||||
if not message or not message.strip():
|
||||
|
||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "praisonaiagents"
|
||||
version = "0.5.2"
|
||||
version = "0.6.0"
|
||||
description = "Praison AI agents for completing complex tasks with Self Reflection Agents"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.10"
|
||||
|
||||
Generated
+1
-1
@@ -2422,7 +2422,7 @@ wheels = [
|
||||
|
||||
[[package]]
|
||||
name = "praisonaiagents"
|
||||
version = "0.5.2"
|
||||
version = "0.6.0"
|
||||
source = { editable = "." }
|
||||
dependencies = [
|
||||
{ name = "aiohttp" },
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
chainlit.md
|
||||
@@ -0,0 +1,137 @@
|
||||
# ACP (Agent Client Protocol) Examples
|
||||
|
||||
This directory contains examples for using PraisonAI with the Agent Client Protocol (ACP).
|
||||
|
||||
## What is ACP?
|
||||
|
||||
The Agent Client Protocol (ACP) is a standardized JSON-RPC 2.0 protocol that allows code editors and IDEs to communicate with AI coding agents. It enables seamless integration between PraisonAI and editors like:
|
||||
|
||||
- **Zed**
|
||||
- **JetBrains IDEs** (IntelliJ, PyCharm, WebStorm, etc.)
|
||||
- **VSCode** (via extensions)
|
||||
- **Toad**
|
||||
|
||||
## Quick Start
|
||||
|
||||
### CLI Usage
|
||||
|
||||
```bash
|
||||
# Start ACP server with defaults
|
||||
praisonai acp
|
||||
|
||||
# Enable debug logging
|
||||
praisonai acp --debug
|
||||
|
||||
# Allow file writes
|
||||
praisonai acp --allow-write
|
||||
|
||||
# Use a specific model
|
||||
praisonai acp -m gpt-4o
|
||||
|
||||
# Resume last session
|
||||
praisonai acp --resume --last
|
||||
```
|
||||
|
||||
### Python API
|
||||
|
||||
```python
|
||||
from praisonai.acp import serve
|
||||
|
||||
serve(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True,
|
||||
)
|
||||
```
|
||||
|
||||
## Editor Configuration
|
||||
|
||||
### Zed
|
||||
|
||||
Add to `~/.config/zed/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### JetBrains
|
||||
|
||||
Add to `~/.jetbrains/acp.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Toad
|
||||
|
||||
```bash
|
||||
toad acp "praisonai acp"
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
- `basic_acp_server.py` - Simple ACP server with default settings
|
||||
- `custom_agent_acp.py` - ACP server with a custom agent
|
||||
|
||||
## CLI Options
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-w, --workspace` | Workspace root directory |
|
||||
| `-a, --agent` | Agent name or config file |
|
||||
| `-m, --model` | LLM model to use |
|
||||
| `-r, --resume` | Resume session by ID |
|
||||
| `--last` | Resume the last session |
|
||||
| `--approve` | Approval mode: manual, auto, scoped |
|
||||
| `--read-only` | Read-only mode (default) |
|
||||
| `--allow-write` | Allow file writes |
|
||||
| `--allow-shell` | Allow shell commands |
|
||||
| `--debug` | Enable debug logging |
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install praisonai[acp]
|
||||
```
|
||||
|
||||
## Protocol Details
|
||||
|
||||
ACP uses JSON-RPC 2.0 over stdio:
|
||||
- **stdin**: Receives JSON-RPC requests from the client
|
||||
- **stdout**: Sends JSON-RPC responses to the client
|
||||
- **stderr**: Debug/log output (never pollutes stdout)
|
||||
|
||||
### Supported Methods
|
||||
|
||||
**Agent Methods (client → agent):**
|
||||
- `initialize` - Negotiate protocol version and capabilities
|
||||
- `authenticate` - Optional authentication
|
||||
- `session/new` - Create a new session
|
||||
- `session/load` - Load an existing session
|
||||
- `session/prompt` - Send user message
|
||||
- `session/cancel` - Cancel ongoing operations
|
||||
- `session/set_mode` - Change operating mode
|
||||
|
||||
**Client Methods (agent → client):**
|
||||
- `session/update` - Send progress updates
|
||||
- `session/request_permission` - Request user approval
|
||||
- `fs/read_text_file` - Read file contents
|
||||
- `fs/write_text_file` - Write file contents
|
||||
- `terminal/create` - Create terminal
|
||||
- `terminal/output` - Get terminal output
|
||||
@@ -0,0 +1,27 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Basic ACP Server Example
|
||||
|
||||
This example demonstrates how to run PraisonAI as an ACP server
|
||||
that can be connected to by IDEs like Zed, JetBrains, VSCode, or Toad.
|
||||
|
||||
Usage:
|
||||
# Run from command line
|
||||
praisonai acp
|
||||
|
||||
# Or run this script directly
|
||||
python basic_acp_server.py
|
||||
"""
|
||||
|
||||
from praisonai.acp import serve
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Start ACP server with default settings
|
||||
# This will listen on stdin/stdout for JSON-RPC messages
|
||||
serve(
|
||||
workspace=".", # Current directory as workspace
|
||||
agent="default", # Use default agent
|
||||
debug=False, # Set to True for debug logging to stderr
|
||||
read_only=True, # Safe by default
|
||||
approval_mode="manual", # Require approval for actions
|
||||
)
|
||||
@@ -0,0 +1,45 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Custom Agent ACP Server Example
|
||||
|
||||
This example shows how to run a custom PraisonAI agent as an ACP server.
|
||||
|
||||
Usage:
|
||||
python custom_agent_acp.py
|
||||
"""
|
||||
|
||||
from praisonai.acp import serve, ACPServer, ACPConfig
|
||||
from praisonaiagents import Agent
|
||||
|
||||
# Create a custom agent
|
||||
agent = Agent(
|
||||
name="CodeAssistant",
|
||||
instructions="""You are an expert coding assistant. You help users:
|
||||
- Write clean, efficient code
|
||||
- Debug issues
|
||||
- Explain complex concepts
|
||||
- Review code for best practices
|
||||
|
||||
Always provide clear explanations with your code suggestions.""",
|
||||
model="gpt-4o-mini",
|
||||
)
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Create config
|
||||
config = ACPConfig(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True, # Allow file modifications
|
||||
approval_mode="manual",
|
||||
)
|
||||
|
||||
# Create server with custom agent
|
||||
server = ACPServer(config=config, agent=agent)
|
||||
|
||||
# Run the server
|
||||
serve(
|
||||
workspace=".",
|
||||
debug=True,
|
||||
allow_write=True,
|
||||
approval_mode="manual",
|
||||
)
|
||||
@@ -3,8 +3,8 @@ class Praisonai < Formula
|
||||
|
||||
desc "AI tools for various AI applications"
|
||||
homepage "https://github.com/MervinPraison/PraisonAI"
|
||||
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.8.4.tar.gz"
|
||||
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.8.4.tar.gz | shasum -a 256`.split.first
|
||||
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v3.0.2.tar.gz"
|
||||
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v3.0.2.tar.gz | shasum -a 256`.split.first
|
||||
license "MIT"
|
||||
|
||||
depends_on "[email protected]"
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
# __main__.py
|
||||
"""
|
||||
PraisonAI CLI Entry Point.
|
||||
|
||||
from .cli import PraisonAI
|
||||
Supports both new Typer-based CLI and legacy argparse CLI.
|
||||
"""
|
||||
|
||||
def main():
|
||||
praison_ai = PraisonAI()
|
||||
praison_ai.main()
|
||||
"""Main entry point with legacy support."""
|
||||
from .cli.legacy import main_with_legacy_support
|
||||
main_with_legacy_support()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,54 @@
|
||||
"""
|
||||
Agent Client Protocol (ACP) support for PraisonAI.
|
||||
|
||||
This module provides ACP server functionality that allows IDEs/editors
|
||||
(Zed, JetBrains, VSCode, Toad) to connect to PraisonAI agents.
|
||||
|
||||
Usage:
|
||||
# CLI
|
||||
praisonai acp [OPTIONS]
|
||||
|
||||
# Python API
|
||||
from praisonai.acp import serve
|
||||
serve(workspace=".", agent="default")
|
||||
"""
|
||||
|
||||
import importlib.util
|
||||
|
||||
__all__ = [
|
||||
"serve",
|
||||
"ACPServer",
|
||||
"ACPSession",
|
||||
"ACPConfig",
|
||||
]
|
||||
|
||||
# Lazy imports for performance
|
||||
def __getattr__(name: str):
|
||||
"""Lazy import ACP components."""
|
||||
if name == "serve":
|
||||
from .server import serve
|
||||
return serve
|
||||
if name == "ACPServer":
|
||||
from .server import ACPServer
|
||||
return ACPServer
|
||||
if name == "ACPSession":
|
||||
from .session import ACPSession
|
||||
return ACPSession
|
||||
if name == "ACPConfig":
|
||||
from .config import ACPConfig
|
||||
return ACPConfig
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
|
||||
|
||||
def _check_acp_available() -> bool:
|
||||
"""Check if agent-client-protocol package is installed."""
|
||||
return importlib.util.find_spec("acp") is not None
|
||||
|
||||
|
||||
def _get_install_instructions() -> str:
|
||||
"""Get installation instructions for ACP support."""
|
||||
return (
|
||||
"ACP support requires the agent-client-protocol package.\n"
|
||||
"Install with: pip install praisonai[acp]\n"
|
||||
"Or: pip install agent-client-protocol"
|
||||
)
|
||||
@@ -0,0 +1,159 @@
|
||||
"""
|
||||
ACP configuration management.
|
||||
|
||||
Handles configuration precedence:
|
||||
1. CLI flags (highest)
|
||||
2. Environment variables
|
||||
3. Config file (~/.praison/config.yaml)
|
||||
4. Defaults (lowest)
|
||||
"""
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class ACPConfig:
|
||||
"""Configuration for ACP server."""
|
||||
|
||||
# Workspace settings
|
||||
workspace: Path = field(default_factory=Path.cwd)
|
||||
|
||||
# Agent settings
|
||||
agent: str = "default"
|
||||
agents_config: Optional[Path] = None
|
||||
router_enabled: bool = False
|
||||
model: Optional[str] = None
|
||||
|
||||
# Session settings
|
||||
resume_session: Optional[str] = None
|
||||
resume_last: bool = False
|
||||
|
||||
# Permission settings
|
||||
read_only: bool = True
|
||||
allow_write: bool = False
|
||||
allow_shell: bool = False
|
||||
allow_network: bool = False
|
||||
approval_mode: str = "manual" # manual, auto, scoped
|
||||
|
||||
# Workspace boundaries
|
||||
allowed_paths: List[Path] = field(default_factory=list)
|
||||
|
||||
# Debug settings
|
||||
debug: bool = False
|
||||
|
||||
# Profile
|
||||
profile: Optional[str] = None
|
||||
|
||||
def __post_init__(self):
|
||||
"""Validate and normalize configuration."""
|
||||
if isinstance(self.workspace, str):
|
||||
self.workspace = Path(self.workspace).resolve()
|
||||
|
||||
if self.agents_config and isinstance(self.agents_config, str):
|
||||
self.agents_config = Path(self.agents_config)
|
||||
|
||||
# Set up default allowed paths
|
||||
if not self.allowed_paths:
|
||||
self.allowed_paths = [
|
||||
self.workspace,
|
||||
Path.home() / ".praison",
|
||||
]
|
||||
|
||||
# Normalize allowed paths
|
||||
self.allowed_paths = [
|
||||
Path(p).resolve() if isinstance(p, str) else p.resolve()
|
||||
for p in self.allowed_paths
|
||||
]
|
||||
|
||||
@classmethod
|
||||
def from_env(cls) -> "ACPConfig":
|
||||
"""Create config from environment variables."""
|
||||
return cls(
|
||||
workspace=Path(os.environ.get("PRAISONAI_WORKSPACE", ".")).resolve(),
|
||||
agent=os.environ.get("PRAISONAI_AGENT", "default"),
|
||||
model=os.environ.get("PRAISONAI_MODEL") or os.environ.get("OPENAI_MODEL"),
|
||||
debug=os.environ.get("PRAISONAI_DEBUG", "").lower() in ("1", "true", "yes"),
|
||||
read_only=os.environ.get("PRAISONAI_READ_ONLY", "true").lower() in ("1", "true", "yes"),
|
||||
approval_mode=os.environ.get("PRAISONAI_APPROVAL_MODE", "manual"),
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def from_file(cls, path: Optional[Path] = None) -> "ACPConfig":
|
||||
"""Load config from YAML file."""
|
||||
if path is None:
|
||||
path = Path.home() / ".praison" / "config.yaml"
|
||||
|
||||
if not path.exists():
|
||||
return cls()
|
||||
|
||||
try:
|
||||
import yaml
|
||||
with open(path) as f:
|
||||
data = yaml.safe_load(f) or {}
|
||||
|
||||
acp_config = data.get("acp", {})
|
||||
return cls(
|
||||
workspace=Path(acp_config.get("workspace", ".")).resolve(),
|
||||
agent=acp_config.get("agent", "default"),
|
||||
model=acp_config.get("model"),
|
||||
debug=acp_config.get("debug", False),
|
||||
read_only=acp_config.get("read_only", True),
|
||||
approval_mode=acp_config.get("approval_mode", "manual"),
|
||||
)
|
||||
except Exception:
|
||||
return cls()
|
||||
|
||||
@classmethod
|
||||
def merge(cls, *configs: "ACPConfig") -> "ACPConfig":
|
||||
"""Merge multiple configs, later configs override earlier ones."""
|
||||
result = cls()
|
||||
for config in configs:
|
||||
for field_name in [
|
||||
"workspace", "agent", "agents_config", "router_enabled",
|
||||
"model", "resume_session", "resume_last", "read_only",
|
||||
"allow_write", "allow_shell", "allow_network", "approval_mode",
|
||||
"debug", "profile"
|
||||
]:
|
||||
value = getattr(config, field_name)
|
||||
# Only override if value is not default/None
|
||||
if value is not None and value != getattr(cls(), field_name, None):
|
||||
setattr(result, field_name, value)
|
||||
return result
|
||||
|
||||
def is_path_allowed(self, path: Path) -> bool:
|
||||
"""Check if a path is within allowed boundaries."""
|
||||
path = Path(path).resolve()
|
||||
return any(
|
||||
path == allowed or allowed in path.parents
|
||||
for allowed in self.allowed_paths
|
||||
)
|
||||
|
||||
def can_write(self) -> bool:
|
||||
"""Check if write operations are allowed."""
|
||||
return not self.read_only or self.allow_write
|
||||
|
||||
def can_execute_shell(self) -> bool:
|
||||
"""Check if shell commands are allowed."""
|
||||
return self.allow_shell
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert config to dictionary."""
|
||||
return {
|
||||
"workspace": str(self.workspace),
|
||||
"agent": self.agent,
|
||||
"agents_config": str(self.agents_config) if self.agents_config else None,
|
||||
"router_enabled": self.router_enabled,
|
||||
"model": self.model,
|
||||
"resume_session": self.resume_session,
|
||||
"resume_last": self.resume_last,
|
||||
"read_only": self.read_only,
|
||||
"allow_write": self.allow_write,
|
||||
"allow_shell": self.allow_shell,
|
||||
"allow_network": self.allow_network,
|
||||
"approval_mode": self.approval_mode,
|
||||
"debug": self.debug,
|
||||
"profile": self.profile,
|
||||
}
|
||||
@@ -0,0 +1,587 @@
|
||||
"""
|
||||
ACP Server implementation for PraisonAI.
|
||||
|
||||
This module implements the Agent Client Protocol server that allows
|
||||
IDEs/editors to communicate with PraisonAI agents.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Union
|
||||
|
||||
from .config import ACPConfig
|
||||
from .session import ACPSession, SessionStore
|
||||
|
||||
# Configure logging to stderr only (stdout reserved for JSON-RPC)
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def _setup_stderr_logging(debug: bool = False) -> None:
|
||||
"""Configure logging to stderr only."""
|
||||
handler = logging.StreamHandler(sys.stderr)
|
||||
handler.setFormatter(logging.Formatter(
|
||||
"%(asctime)s [%(levelname)s] %(name)s: %(message)s"
|
||||
))
|
||||
|
||||
root_logger = logging.getLogger("praisonai.acp")
|
||||
root_logger.handlers.clear()
|
||||
root_logger.addHandler(handler)
|
||||
root_logger.setLevel(logging.DEBUG if debug else logging.INFO)
|
||||
|
||||
|
||||
class ACPServer:
|
||||
"""
|
||||
ACP Server that exposes PraisonAI agents to IDE clients.
|
||||
|
||||
Implements the Agent Client Protocol (JSON-RPC 2.0 over stdio).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
config: Optional[ACPConfig] = None,
|
||||
agent: Optional[Any] = None,
|
||||
agents: Optional[Any] = None,
|
||||
):
|
||||
"""
|
||||
Initialize ACP server.
|
||||
|
||||
Args:
|
||||
config: ACP configuration
|
||||
agent: Optional pre-configured Agent instance
|
||||
agents: Optional pre-configured PraisonAIAgents instance
|
||||
"""
|
||||
self.config = config or ACPConfig()
|
||||
self._agent = agent
|
||||
self._agents = agents
|
||||
self._session_store = SessionStore()
|
||||
self._sessions: Dict[str, ACPSession] = {}
|
||||
self._client = None # ACP client connection
|
||||
self._cancelled_sessions: set = set()
|
||||
|
||||
_setup_stderr_logging(self.config.debug)
|
||||
|
||||
def _get_agent(self):
|
||||
"""Lazy load or create agent."""
|
||||
if self._agent is not None:
|
||||
return self._agent
|
||||
|
||||
if self._agents is not None:
|
||||
return self._agents
|
||||
|
||||
# Create default agent
|
||||
try:
|
||||
from praisonaiagents import Agent
|
||||
self._agent = Agent(
|
||||
name="PraisonAI",
|
||||
instructions="You are a helpful AI coding assistant.",
|
||||
model=self.config.model or "gpt-4o-mini",
|
||||
)
|
||||
return self._agent
|
||||
except ImportError:
|
||||
logger.error("praisonaiagents not installed")
|
||||
raise RuntimeError("praisonaiagents package required")
|
||||
|
||||
def on_connect(self, client) -> None:
|
||||
"""Called when client connects."""
|
||||
self._client = client
|
||||
logger.info("Client connected")
|
||||
|
||||
async def initialize(
|
||||
self,
|
||||
protocol_version: int,
|
||||
client_capabilities: Optional[Dict[str, Any]] = None,
|
||||
client_info: Optional[Dict[str, Any]] = None,
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Handle initialize request.
|
||||
|
||||
Negotiate protocol version and exchange capabilities.
|
||||
"""
|
||||
logger.info(f"Initialize: protocol_version={protocol_version}, client_info={client_info}")
|
||||
|
||||
# Import here to avoid circular imports and check availability
|
||||
try:
|
||||
from acp import PROTOCOL_VERSION
|
||||
except ImportError:
|
||||
PROTOCOL_VERSION = 1
|
||||
|
||||
return {
|
||||
"protocolVersion": min(protocol_version, PROTOCOL_VERSION),
|
||||
"agentCapabilities": {
|
||||
"loadSession": True,
|
||||
"promptCapabilities": {
|
||||
"image": False,
|
||||
"audio": False,
|
||||
"embeddedContext": True,
|
||||
},
|
||||
"mcpCapabilities": {
|
||||
"http": False,
|
||||
"sse": False,
|
||||
},
|
||||
},
|
||||
"agentInfo": {
|
||||
"name": "praisonai",
|
||||
"title": "PraisonAI",
|
||||
"version": self._get_version(),
|
||||
},
|
||||
"authMethods": [],
|
||||
}
|
||||
|
||||
async def authenticate(self, method_id: str, **kwargs: Any) -> Optional[Dict[str, Any]]:
|
||||
"""Handle authenticate request (optional)."""
|
||||
logger.info(f"Authenticate: method_id={method_id}")
|
||||
return {}
|
||||
|
||||
async def new_session(
|
||||
self,
|
||||
cwd: str,
|
||||
mcp_servers: List[Dict[str, Any]],
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Create a new conversation session.
|
||||
|
||||
Args:
|
||||
cwd: Working directory for the session
|
||||
mcp_servers: List of MCP server configurations
|
||||
"""
|
||||
logger.info(f"New session: cwd={cwd}")
|
||||
|
||||
workspace = Path(cwd).resolve()
|
||||
session = ACPSession.create(
|
||||
workspace=workspace,
|
||||
agent_id=self.config.agent,
|
||||
)
|
||||
session.mcp_servers = mcp_servers
|
||||
|
||||
self._sessions[session.session_id] = session
|
||||
self._session_store.save(session)
|
||||
|
||||
logger.info(f"Created session: {session.session_id}")
|
||||
|
||||
return {
|
||||
"sessionId": session.session_id,
|
||||
"modes": self._get_available_modes(),
|
||||
}
|
||||
|
||||
async def load_session(
|
||||
self,
|
||||
cwd: str,
|
||||
mcp_servers: List[Dict[str, Any]],
|
||||
session_id: str,
|
||||
**kwargs: Any,
|
||||
) -> Optional[Dict[str, Any]]:
|
||||
"""
|
||||
Load an existing session.
|
||||
|
||||
Replays conversation history via session/update notifications.
|
||||
"""
|
||||
logger.info(f"Load session: session_id={session_id}")
|
||||
|
||||
# Try to load from store
|
||||
session = self._session_store.load(session_id)
|
||||
if session is None:
|
||||
logger.warning(f"Session not found: {session_id}")
|
||||
return None
|
||||
|
||||
# Update workspace and MCP servers
|
||||
session.workspace = Path(cwd).resolve()
|
||||
session.mcp_servers = mcp_servers
|
||||
session.update_activity()
|
||||
|
||||
self._sessions[session_id] = session
|
||||
|
||||
# Replay conversation history
|
||||
await self._replay_session_history(session)
|
||||
|
||||
return {}
|
||||
|
||||
async def list_sessions(
|
||||
self,
|
||||
cursor: Optional[str] = None,
|
||||
cwd: Optional[str] = None,
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""List available sessions."""
|
||||
sessions = self._session_store.list_sessions()
|
||||
|
||||
# Filter by cwd if provided
|
||||
if cwd:
|
||||
cwd_path = Path(cwd).resolve()
|
||||
sessions = [s for s in sessions if s.workspace == cwd_path]
|
||||
|
||||
return {
|
||||
"sessions": [
|
||||
{
|
||||
"sessionId": s.session_id,
|
||||
"createdAt": s.created_at,
|
||||
"lastActivity": s.last_activity,
|
||||
}
|
||||
for s in sessions
|
||||
],
|
||||
}
|
||||
|
||||
async def set_session_mode(
|
||||
self,
|
||||
mode_id: str,
|
||||
session_id: str,
|
||||
**kwargs: Any,
|
||||
) -> Optional[Dict[str, Any]]:
|
||||
"""Set the operating mode for a session."""
|
||||
logger.info(f"Set session mode: session_id={session_id}, mode_id={mode_id}")
|
||||
|
||||
session = self._sessions.get(session_id)
|
||||
if session:
|
||||
session.mode = mode_id
|
||||
self._session_store.save(session)
|
||||
|
||||
return {}
|
||||
|
||||
async def set_session_model(
|
||||
self,
|
||||
model_id: str,
|
||||
session_id: str,
|
||||
**kwargs: Any,
|
||||
) -> Optional[Dict[str, Any]]:
|
||||
"""Set the LLM model for a session."""
|
||||
logger.info(f"Set session model: session_id={session_id}, model_id={model_id}")
|
||||
|
||||
session = self._sessions.get(session_id)
|
||||
if session:
|
||||
session.model = model_id
|
||||
self._session_store.save(session)
|
||||
|
||||
return {}
|
||||
|
||||
async def prompt(
|
||||
self,
|
||||
prompt: List[Dict[str, Any]],
|
||||
session_id: str,
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Handle user prompt.
|
||||
|
||||
This is the main interaction method where the user sends a message
|
||||
and the agent processes it.
|
||||
"""
|
||||
logger.info(f"Prompt: session_id={session_id}")
|
||||
|
||||
session = self._sessions.get(session_id)
|
||||
if session is None:
|
||||
logger.error(f"Session not found: {session_id}")
|
||||
return {"stopReason": "refusal"}
|
||||
|
||||
# Check if cancelled
|
||||
if session_id in self._cancelled_sessions:
|
||||
self._cancelled_sessions.discard(session_id)
|
||||
return {"stopReason": "cancelled"}
|
||||
|
||||
# Extract text from prompt blocks
|
||||
user_message = self._extract_prompt_text(prompt)
|
||||
session.add_message("user", user_message)
|
||||
|
||||
try:
|
||||
# Get agent response
|
||||
agent = self._get_agent()
|
||||
|
||||
# Send thinking update
|
||||
await self._send_thought(session_id, "Processing your request...")
|
||||
|
||||
# Generate response
|
||||
response = await self._generate_response(agent, user_message, session)
|
||||
|
||||
# Send response as agent message chunks
|
||||
await self._send_agent_message(session_id, response)
|
||||
|
||||
# Save session
|
||||
session.add_message("assistant", response)
|
||||
self._session_store.save(session)
|
||||
|
||||
return {"stopReason": "end_turn"}
|
||||
|
||||
except asyncio.CancelledError:
|
||||
return {"stopReason": "cancelled"}
|
||||
except Exception as e:
|
||||
logger.exception(f"Error processing prompt: {e}")
|
||||
await self._send_agent_message(session_id, f"Error: {str(e)}")
|
||||
return {"stopReason": "refusal"}
|
||||
|
||||
async def fork_session(
|
||||
self,
|
||||
cwd: str,
|
||||
session_id: str,
|
||||
mcp_servers: Optional[List[Dict[str, Any]]] = None,
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""Fork an existing session."""
|
||||
logger.info(f"Fork session: session_id={session_id}")
|
||||
|
||||
original = self._sessions.get(session_id)
|
||||
if original is None:
|
||||
original = self._session_store.load(session_id)
|
||||
|
||||
if original is None:
|
||||
# Create new session if original not found
|
||||
return await self.new_session(cwd, mcp_servers or [])
|
||||
|
||||
# Create forked session
|
||||
forked = ACPSession.create(
|
||||
workspace=Path(cwd).resolve(),
|
||||
agent_id=original.agent_id,
|
||||
)
|
||||
forked.messages = original.messages.copy()
|
||||
forked.mcp_servers = mcp_servers or original.mcp_servers
|
||||
|
||||
self._sessions[forked.session_id] = forked
|
||||
self._session_store.save(forked)
|
||||
|
||||
return {"sessionId": forked.session_id}
|
||||
|
||||
async def resume_session(
|
||||
self,
|
||||
cwd: str,
|
||||
session_id: str,
|
||||
mcp_servers: Optional[List[Dict[str, Any]]] = None,
|
||||
**kwargs: Any,
|
||||
) -> Dict[str, Any]:
|
||||
"""Resume an existing session."""
|
||||
return await self.load_session(cwd, mcp_servers or [], session_id)
|
||||
|
||||
async def cancel(self, session_id: str, **kwargs: Any) -> None:
|
||||
"""Cancel ongoing operations for a session."""
|
||||
logger.info(f"Cancel: session_id={session_id}")
|
||||
self._cancelled_sessions.add(session_id)
|
||||
|
||||
async def ext_method(self, method: str, params: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Handle extension method calls."""
|
||||
logger.info(f"Extension method: {method}")
|
||||
return {"error": f"Unknown extension method: {method}"}
|
||||
|
||||
async def ext_notification(self, method: str, params: Dict[str, Any]) -> None:
|
||||
"""Handle extension notifications."""
|
||||
logger.info(f"Extension notification: {method}")
|
||||
|
||||
# Helper methods
|
||||
|
||||
def _get_version(self) -> str:
|
||||
"""Get PraisonAI version."""
|
||||
try:
|
||||
from praisonai.version import __version__
|
||||
return __version__
|
||||
except ImportError:
|
||||
return "0.0.0"
|
||||
|
||||
def _get_available_modes(self) -> Optional[List[Dict[str, Any]]]:
|
||||
"""Get available operating modes."""
|
||||
return [
|
||||
{
|
||||
"id": "manual",
|
||||
"name": "Manual",
|
||||
"description": "Requires approval for all actions",
|
||||
},
|
||||
{
|
||||
"id": "auto",
|
||||
"name": "Auto",
|
||||
"description": "Auto-approve within workspace",
|
||||
},
|
||||
]
|
||||
|
||||
def _extract_prompt_text(self, prompt: List[Dict[str, Any]]) -> str:
|
||||
"""Extract text content from prompt blocks."""
|
||||
texts = []
|
||||
for block in prompt:
|
||||
if isinstance(block, dict):
|
||||
block_type = block.get("type", "")
|
||||
if block_type == "text":
|
||||
texts.append(block.get("text", ""))
|
||||
elif block_type == "resource":
|
||||
resource = block.get("resource", {})
|
||||
if "text" in resource:
|
||||
texts.append(f"[File: {resource.get('uri', 'unknown')}]\n{resource['text']}")
|
||||
return "\n".join(texts)
|
||||
|
||||
async def _generate_response(
|
||||
self,
|
||||
agent: Any,
|
||||
message: str,
|
||||
session: ACPSession,
|
||||
) -> str:
|
||||
"""Generate agent response."""
|
||||
try:
|
||||
# Try async chat first
|
||||
if hasattr(agent, "achat"):
|
||||
response = await agent.achat(message)
|
||||
elif hasattr(agent, "chat"):
|
||||
# Run sync chat in executor
|
||||
loop = asyncio.get_event_loop()
|
||||
response = await loop.run_in_executor(None, agent.chat, message)
|
||||
else:
|
||||
response = "Agent does not support chat interface"
|
||||
|
||||
return str(response) if response else ""
|
||||
except Exception as e:
|
||||
logger.exception(f"Error generating response: {e}")
|
||||
return f"Error generating response: {str(e)}"
|
||||
|
||||
async def _send_agent_message(self, session_id: str, text: str) -> None:
|
||||
"""Send agent message chunk to client."""
|
||||
if self._client is None:
|
||||
return
|
||||
|
||||
try:
|
||||
from acp import update_agent_message_text
|
||||
update = update_agent_message_text(text)
|
||||
await self._client.session_update(session_id=session_id, update=update)
|
||||
except ImportError:
|
||||
# Fallback without ACP SDK
|
||||
logger.debug(f"Agent message: {text[:100]}...")
|
||||
|
||||
async def _send_thought(self, session_id: str, text: str) -> None:
|
||||
"""Send agent thought to client."""
|
||||
if self._client is None:
|
||||
return
|
||||
|
||||
try:
|
||||
from acp import update_agent_thought_text
|
||||
update = update_agent_thought_text(text)
|
||||
await self._client.session_update(session_id=session_id, update=update)
|
||||
except ImportError:
|
||||
logger.debug(f"Agent thought: {text}")
|
||||
|
||||
async def _replay_session_history(self, session: ACPSession) -> None:
|
||||
"""Replay session history to client."""
|
||||
if self._client is None:
|
||||
return
|
||||
|
||||
try:
|
||||
from acp import update_user_message_text, update_agent_message_text
|
||||
|
||||
for msg in session.messages:
|
||||
role = msg.get("role", "")
|
||||
content = msg.get("content", "")
|
||||
|
||||
if role == "user":
|
||||
update = update_user_message_text(str(content))
|
||||
elif role == "assistant":
|
||||
update = update_agent_message_text(str(content))
|
||||
else:
|
||||
continue
|
||||
|
||||
await self._client.session_update(
|
||||
session_id=session.session_id,
|
||||
update=update,
|
||||
)
|
||||
except ImportError:
|
||||
logger.debug("Skipping history replay (ACP SDK not available)")
|
||||
|
||||
|
||||
async def _run_server(config: ACPConfig) -> None:
|
||||
"""Run the ACP server."""
|
||||
try:
|
||||
from acp import Agent as ACPAgent, run_agent
|
||||
except ImportError:
|
||||
logger.error(
|
||||
"agent-client-protocol package not installed.\n"
|
||||
"Install with: pip install praisonai[acp]\n"
|
||||
"Or: pip install agent-client-protocol"
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
server = ACPServer(config=config)
|
||||
|
||||
# Create ACP-compatible agent wrapper
|
||||
class PraisonACPAgent(ACPAgent):
|
||||
def on_connect(self, conn):
|
||||
server.on_connect(conn)
|
||||
|
||||
async def initialize(self, protocol_version, client_capabilities=None, client_info=None, **kwargs):
|
||||
return await server.initialize(protocol_version, client_capabilities, client_info, **kwargs)
|
||||
|
||||
async def authenticate(self, method_id, **kwargs):
|
||||
return await server.authenticate(method_id, **kwargs)
|
||||
|
||||
async def new_session(self, cwd, mcp_servers, **kwargs):
|
||||
return await server.new_session(cwd, mcp_servers, **kwargs)
|
||||
|
||||
async def load_session(self, cwd, mcp_servers, session_id, **kwargs):
|
||||
return await server.load_session(cwd, mcp_servers, session_id, **kwargs)
|
||||
|
||||
async def list_sessions(self, cursor=None, cwd=None, **kwargs):
|
||||
return await server.list_sessions(cursor, cwd, **kwargs)
|
||||
|
||||
async def set_session_mode(self, mode_id, session_id, **kwargs):
|
||||
return await server.set_session_mode(mode_id, session_id, **kwargs)
|
||||
|
||||
async def set_session_model(self, model_id, session_id, **kwargs):
|
||||
return await server.set_session_model(model_id, session_id, **kwargs)
|
||||
|
||||
async def prompt(self, prompt, session_id, **kwargs):
|
||||
return await server.prompt(prompt, session_id, **kwargs)
|
||||
|
||||
async def fork_session(self, cwd, session_id, mcp_servers=None, **kwargs):
|
||||
return await server.fork_session(cwd, session_id, mcp_servers, **kwargs)
|
||||
|
||||
async def resume_session(self, cwd, session_id, mcp_servers=None, **kwargs):
|
||||
return await server.resume_session(cwd, session_id, mcp_servers, **kwargs)
|
||||
|
||||
async def cancel(self, session_id, **kwargs):
|
||||
return await server.cancel(session_id, **kwargs)
|
||||
|
||||
async def ext_method(self, method, params):
|
||||
return await server.ext_method(method, params)
|
||||
|
||||
async def ext_notification(self, method, params):
|
||||
return await server.ext_notification(method, params)
|
||||
|
||||
logger.info("Starting PraisonAI ACP server...")
|
||||
await run_agent(PraisonACPAgent(), use_unstable_protocol=True)
|
||||
|
||||
|
||||
def serve(
|
||||
workspace: Union[str, Path] = ".",
|
||||
agent: str = "default",
|
||||
model: Optional[str] = None,
|
||||
resume: Optional[str] = None,
|
||||
resume_last: bool = False,
|
||||
debug: bool = False,
|
||||
read_only: bool = True,
|
||||
allow_write: bool = False,
|
||||
allow_shell: bool = False,
|
||||
approval_mode: str = "manual",
|
||||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""
|
||||
Start the ACP server.
|
||||
|
||||
This is the main entry point for running PraisonAI as an ACP agent.
|
||||
|
||||
Args:
|
||||
workspace: Working directory for the session
|
||||
agent: Agent name or configuration
|
||||
model: LLM model to use
|
||||
resume: Session ID to resume
|
||||
resume_last: Resume the last session
|
||||
debug: Enable debug logging
|
||||
read_only: Read-only mode (default True)
|
||||
allow_write: Allow file writes
|
||||
allow_shell: Allow shell commands
|
||||
approval_mode: Approval mode (manual, auto, scoped)
|
||||
"""
|
||||
config = ACPConfig(
|
||||
workspace=Path(workspace).resolve(),
|
||||
agent=agent,
|
||||
model=model,
|
||||
resume_session=resume,
|
||||
resume_last=resume_last,
|
||||
debug=debug,
|
||||
read_only=read_only,
|
||||
allow_write=allow_write,
|
||||
allow_shell=allow_shell,
|
||||
approval_mode=approval_mode,
|
||||
)
|
||||
|
||||
asyncio.run(_run_server(config))
|
||||
@@ -0,0 +1,219 @@
|
||||
"""
|
||||
ACP session management.
|
||||
|
||||
Handles session creation, persistence, and resume functionality.
|
||||
"""
|
||||
|
||||
import json
|
||||
import logging
|
||||
import time
|
||||
import uuid
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ACPSession:
|
||||
"""Represents an ACP conversation session."""
|
||||
|
||||
session_id: str
|
||||
workspace: Path
|
||||
created_at: float = field(default_factory=time.time)
|
||||
last_activity: float = field(default_factory=time.time)
|
||||
|
||||
# Agent attribution
|
||||
agent_id: Optional[str] = None
|
||||
run_id: Optional[str] = None
|
||||
trace_id: Optional[str] = None
|
||||
|
||||
# Session state
|
||||
mode: str = "manual" # manual, auto, full_auto
|
||||
model: Optional[str] = None
|
||||
|
||||
# Conversation history (for resume)
|
||||
messages: List[Dict[str, Any]] = field(default_factory=list)
|
||||
tool_calls: List[Dict[str, Any]] = field(default_factory=list)
|
||||
|
||||
# MCP servers
|
||||
mcp_servers: List[Dict[str, Any]] = field(default_factory=list)
|
||||
|
||||
@classmethod
|
||||
def create(cls, workspace: Path, agent_id: Optional[str] = None) -> "ACPSession":
|
||||
"""Create a new session."""
|
||||
session_id = f"sess_{uuid.uuid4().hex[:16]}"
|
||||
return cls(
|
||||
session_id=session_id,
|
||||
workspace=workspace,
|
||||
agent_id=agent_id,
|
||||
run_id=f"run_{uuid.uuid4().hex[:8]}",
|
||||
trace_id=f"trace_{uuid.uuid4().hex[:8]}",
|
||||
)
|
||||
|
||||
def update_activity(self) -> None:
|
||||
"""Update last activity timestamp."""
|
||||
self.last_activity = time.time()
|
||||
|
||||
def add_message(self, role: str, content: Any) -> None:
|
||||
"""Add a message to the conversation history."""
|
||||
self.messages.append({
|
||||
"role": role,
|
||||
"content": content,
|
||||
"timestamp": time.time(),
|
||||
})
|
||||
self.update_activity()
|
||||
|
||||
def add_tool_call(self, tool_call_id: str, title: str, status: str, **kwargs) -> None:
|
||||
"""Add a tool call to the history."""
|
||||
self.tool_calls.append({
|
||||
"tool_call_id": tool_call_id,
|
||||
"title": title,
|
||||
"status": status,
|
||||
"timestamp": time.time(),
|
||||
**kwargs,
|
||||
})
|
||||
self.update_activity()
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Serialize session to dictionary."""
|
||||
return {
|
||||
"session_id": self.session_id,
|
||||
"workspace": str(self.workspace),
|
||||
"created_at": self.created_at,
|
||||
"last_activity": self.last_activity,
|
||||
"agent_id": self.agent_id,
|
||||
"run_id": self.run_id,
|
||||
"trace_id": self.trace_id,
|
||||
"mode": self.mode,
|
||||
"model": self.model,
|
||||
"messages": self.messages,
|
||||
"tool_calls": self.tool_calls,
|
||||
"mcp_servers": self.mcp_servers,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, data: Dict[str, Any]) -> "ACPSession":
|
||||
"""Deserialize session from dictionary."""
|
||||
return cls(
|
||||
session_id=data["session_id"],
|
||||
workspace=Path(data["workspace"]),
|
||||
created_at=data.get("created_at", time.time()),
|
||||
last_activity=data.get("last_activity", time.time()),
|
||||
agent_id=data.get("agent_id"),
|
||||
run_id=data.get("run_id"),
|
||||
trace_id=data.get("trace_id"),
|
||||
mode=data.get("mode", "manual"),
|
||||
model=data.get("model"),
|
||||
messages=data.get("messages", []),
|
||||
tool_calls=data.get("tool_calls", []),
|
||||
mcp_servers=data.get("mcp_servers", []),
|
||||
)
|
||||
|
||||
|
||||
class SessionStore:
|
||||
"""Persistent storage for ACP sessions."""
|
||||
|
||||
def __init__(self, storage_dir: Optional[Path] = None):
|
||||
"""Initialize session store."""
|
||||
if storage_dir is None:
|
||||
storage_dir = Path.home() / ".praison" / "acp" / "sessions"
|
||||
self.storage_dir = storage_dir
|
||||
self.storage_dir.mkdir(parents=True, exist_ok=True)
|
||||
self._last_session_file = self.storage_dir / ".last_session"
|
||||
|
||||
def _session_path(self, session_id: str) -> Path:
|
||||
"""Get path for session file."""
|
||||
return self.storage_dir / f"{session_id}.json"
|
||||
|
||||
def save(self, session: ACPSession) -> None:
|
||||
"""Save session to disk."""
|
||||
try:
|
||||
path = self._session_path(session.session_id)
|
||||
with open(path, "w") as f:
|
||||
json.dump(session.to_dict(), f, indent=2)
|
||||
|
||||
# Update last session pointer
|
||||
with open(self._last_session_file, "w") as f:
|
||||
f.write(session.session_id)
|
||||
|
||||
logger.debug(f"Saved session {session.session_id}")
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to save session: {e}")
|
||||
|
||||
def load(self, session_id: str) -> Optional[ACPSession]:
|
||||
"""Load session from disk."""
|
||||
try:
|
||||
path = self._session_path(session_id)
|
||||
if not path.exists():
|
||||
logger.warning(f"Session not found: {session_id}")
|
||||
return None
|
||||
|
||||
with open(path) as f:
|
||||
data = json.load(f)
|
||||
|
||||
return ACPSession.from_dict(data)
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to load session: {e}")
|
||||
return None
|
||||
|
||||
def load_last(self) -> Optional[ACPSession]:
|
||||
"""Load the most recent session."""
|
||||
try:
|
||||
if not self._last_session_file.exists():
|
||||
return None
|
||||
|
||||
with open(self._last_session_file) as f:
|
||||
session_id = f.read().strip()
|
||||
|
||||
if session_id:
|
||||
return self.load(session_id)
|
||||
return None
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to load last session: {e}")
|
||||
return None
|
||||
|
||||
def delete(self, session_id: str) -> bool:
|
||||
"""Delete a session."""
|
||||
try:
|
||||
path = self._session_path(session_id)
|
||||
if path.exists():
|
||||
path.unlink()
|
||||
logger.debug(f"Deleted session {session_id}")
|
||||
return True
|
||||
return False
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to delete session: {e}")
|
||||
return False
|
||||
|
||||
def list_sessions(self, limit: int = 50) -> List[ACPSession]:
|
||||
"""List all sessions, sorted by last activity."""
|
||||
sessions = []
|
||||
try:
|
||||
for path in self.storage_dir.glob("sess_*.json"):
|
||||
try:
|
||||
with open(path) as f:
|
||||
data = json.load(f)
|
||||
sessions.append(ACPSession.from_dict(data))
|
||||
except Exception:
|
||||
continue
|
||||
|
||||
# Sort by last activity, most recent first
|
||||
sessions.sort(key=lambda s: s.last_activity, reverse=True)
|
||||
return sessions[:limit]
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to list sessions: {e}")
|
||||
return []
|
||||
|
||||
def cleanup_old_sessions(self, max_age_days: int = 30) -> int:
|
||||
"""Remove sessions older than max_age_days."""
|
||||
cutoff = time.time() - (max_age_days * 24 * 60 * 60)
|
||||
removed = 0
|
||||
|
||||
for session in self.list_sessions(limit=1000):
|
||||
if session.last_activity < cutoff:
|
||||
if self.delete(session.session_id):
|
||||
removed += 1
|
||||
|
||||
return removed
|
||||
@@ -0,0 +1,213 @@
|
||||
"""
|
||||
PraisonAI CLI Typer Application.
|
||||
|
||||
Main Typer app that registers all command groups and handles global options.
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
from enum import Enum
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from .output.console import OutputController, OutputMode, set_output_controller
|
||||
from .state.identifiers import create_context
|
||||
|
||||
|
||||
class OutputFormat(str, Enum):
|
||||
"""Output format options."""
|
||||
text = "text"
|
||||
json = "json"
|
||||
stream_json = "stream-json"
|
||||
|
||||
|
||||
# Create main Typer app
|
||||
app = typer.Typer(
|
||||
name="praisonai",
|
||||
help="PraisonAI - AI Agents Framework CLI",
|
||||
add_completion=False, # We handle completion manually
|
||||
no_args_is_help=False, # Allow running without args for legacy compatibility
|
||||
rich_markup_mode="rich",
|
||||
)
|
||||
|
||||
|
||||
# Global state for options
|
||||
class GlobalState:
|
||||
"""Global state for CLI options."""
|
||||
output_format: OutputFormat = OutputFormat.text
|
||||
no_color: bool = False
|
||||
quiet: bool = False
|
||||
verbose: bool = False
|
||||
screen_reader: bool = False
|
||||
output_controller: Optional[OutputController] = None
|
||||
|
||||
|
||||
state = GlobalState()
|
||||
|
||||
|
||||
def version_callback(value: bool):
|
||||
"""Show version and exit."""
|
||||
if value:
|
||||
from praisonai.version import __version__
|
||||
typer.echo(f"PraisonAI version {__version__}")
|
||||
raise typer.Exit()
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def main_callback(
|
||||
ctx: typer.Context,
|
||||
version: bool = typer.Option(
|
||||
False,
|
||||
"--version",
|
||||
"-V",
|
||||
callback=version_callback,
|
||||
is_eager=True,
|
||||
help="Show version and exit",
|
||||
),
|
||||
output_format: OutputFormat = typer.Option(
|
||||
OutputFormat.text,
|
||||
"--output-format",
|
||||
"-o",
|
||||
help="Output format",
|
||||
envvar="PRAISONAI_OUTPUT_FORMAT",
|
||||
),
|
||||
json_output: bool = typer.Option(
|
||||
False,
|
||||
"--json",
|
||||
help="Output in JSON format (alias for --output-format json)",
|
||||
),
|
||||
no_color: bool = typer.Option(
|
||||
False,
|
||||
"--no-color",
|
||||
help="Disable colored output",
|
||||
envvar="NO_COLOR",
|
||||
),
|
||||
quiet: bool = typer.Option(
|
||||
False,
|
||||
"--quiet",
|
||||
"-q",
|
||||
help="Minimal output",
|
||||
),
|
||||
verbose: bool = typer.Option(
|
||||
False,
|
||||
"--verbose",
|
||||
"-v",
|
||||
help="Verbose output with debug details",
|
||||
),
|
||||
screen_reader: bool = typer.Option(
|
||||
False,
|
||||
"--screen-reader",
|
||||
help="Screen reader friendly output (no spinners/panels)",
|
||||
),
|
||||
):
|
||||
"""
|
||||
PraisonAI - AI Agents Framework CLI.
|
||||
|
||||
Run agents, manage configuration, and more.
|
||||
"""
|
||||
# Store global options
|
||||
state.output_format = output_format
|
||||
state.no_color = no_color
|
||||
state.quiet = quiet
|
||||
state.verbose = verbose
|
||||
state.screen_reader = screen_reader
|
||||
|
||||
# Handle --json alias
|
||||
if json_output:
|
||||
state.output_format = OutputFormat.json
|
||||
|
||||
# Determine output mode
|
||||
if state.quiet:
|
||||
mode = OutputMode.QUIET
|
||||
elif state.verbose:
|
||||
mode = OutputMode.VERBOSE
|
||||
elif state.screen_reader:
|
||||
mode = OutputMode.SCREEN_READER
|
||||
elif state.output_format == OutputFormat.json:
|
||||
mode = OutputMode.JSON
|
||||
elif state.output_format == OutputFormat.stream_json:
|
||||
mode = OutputMode.STREAM_JSON
|
||||
else:
|
||||
mode = OutputMode.TEXT
|
||||
|
||||
# Create run context
|
||||
context = create_context()
|
||||
|
||||
# Create and set output controller
|
||||
state.output_controller = OutputController(
|
||||
mode=mode,
|
||||
no_color=state.no_color,
|
||||
run_id=context.run_id,
|
||||
trace_id=context.trace_id,
|
||||
)
|
||||
set_output_controller(state.output_controller)
|
||||
|
||||
# If no command provided, show help or handle legacy behavior
|
||||
if ctx.invoked_subcommand is None:
|
||||
# Check if there are remaining args (legacy behavior)
|
||||
# This is handled by the legacy adapter in main.py
|
||||
pass
|
||||
|
||||
|
||||
def get_output_controller() -> OutputController:
|
||||
"""Get the current output controller."""
|
||||
if state.output_controller is None:
|
||||
state.output_controller = OutputController()
|
||||
return state.output_controller
|
||||
|
||||
|
||||
# Import and register command groups
|
||||
def register_commands():
|
||||
"""Register all command groups."""
|
||||
# Import command modules
|
||||
from .commands.config import app as config_app
|
||||
from .commands.traces import app as traces_app
|
||||
from .commands.environment import app as env_app
|
||||
from .commands.session import app as session_app
|
||||
from .commands.completion import app as completion_app
|
||||
from .commands.version import app as version_app
|
||||
from .commands.debug import app as debug_app
|
||||
from .commands.lsp import app as lsp_app
|
||||
from .commands.diag import app as diag_app
|
||||
from .commands.doctor import app as doctor_app
|
||||
from .commands.acp import app as acp_app
|
||||
from .commands.mcp import app as mcp_app
|
||||
from .commands.serve import app as serve_app
|
||||
from .commands.schedule import app as schedule_app
|
||||
from .commands.run import app as run_app
|
||||
from .commands.profile import app as profile_app
|
||||
|
||||
# Import TUI and queue commands
|
||||
from .features.tui.debug import create_debug_app as create_tui_debug_app
|
||||
from .features.tui.cli import create_queue_app
|
||||
|
||||
# Register sub-apps
|
||||
app.add_typer(config_app, name="config", help="Configuration management")
|
||||
app.add_typer(traces_app, name="traces", help="Trace collection management")
|
||||
app.add_typer(env_app, name="env", help="Environment and diagnostics")
|
||||
app.add_typer(session_app, name="session", help="Session management")
|
||||
app.add_typer(completion_app, name="completion", help="Shell completion scripts")
|
||||
app.add_typer(version_app, name="version", help="Version information")
|
||||
app.add_typer(debug_app, name="debug", help="Debug and test interactive flows")
|
||||
app.add_typer(lsp_app, name="lsp", help="LSP service lifecycle")
|
||||
app.add_typer(diag_app, name="diag", help="Diagnostics export")
|
||||
app.add_typer(doctor_app, name="doctor", help="Health checks and diagnostics")
|
||||
app.add_typer(acp_app, name="acp", help="Agent Client Protocol server")
|
||||
app.add_typer(mcp_app, name="mcp", help="MCP server management")
|
||||
app.add_typer(serve_app, name="serve", help="API server management")
|
||||
app.add_typer(schedule_app, name="schedule", help="Scheduler management")
|
||||
app.add_typer(run_app, name="run", help="Run agents")
|
||||
app.add_typer(profile_app, name="profile", help="Performance profiling and diagnostics")
|
||||
|
||||
# Register TUI and queue commands
|
||||
tui_app = create_tui_debug_app()
|
||||
queue_app = create_queue_app()
|
||||
if tui_app:
|
||||
app.add_typer(tui_app, name="tui", help="Interactive TUI and simulation")
|
||||
if queue_app:
|
||||
app.add_typer(queue_app, name="queue", help="Queue management")
|
||||
|
||||
|
||||
# Register commands on import
|
||||
register_commands()
|
||||
@@ -0,0 +1,75 @@
|
||||
"""
|
||||
PraisonAI CLI Commands Module.
|
||||
|
||||
This module contains all Typer command groups and subcommands.
|
||||
Each file represents a command group (e.g., config, traces, session).
|
||||
"""
|
||||
|
||||
# Lazy imports to avoid loading all commands at startup
|
||||
__all__ = [
|
||||
'run_app',
|
||||
'config_app',
|
||||
'traces_app',
|
||||
'env_app',
|
||||
'session_app',
|
||||
'schedule_app',
|
||||
'serve_app',
|
||||
'completion_app',
|
||||
'version_app',
|
||||
'debug_app',
|
||||
'lsp_app',
|
||||
'diag_app',
|
||||
'doctor_app',
|
||||
'acp_app',
|
||||
'mcp_app',
|
||||
]
|
||||
|
||||
|
||||
def __getattr__(name: str):
|
||||
"""Lazy load command apps."""
|
||||
if name == 'run_app':
|
||||
from .run import app as run_app
|
||||
return run_app
|
||||
elif name == 'config_app':
|
||||
from .config import app as config_app
|
||||
return config_app
|
||||
elif name == 'traces_app':
|
||||
from .traces import app as traces_app
|
||||
return traces_app
|
||||
elif name == 'env_app':
|
||||
from .environment import app as env_app
|
||||
return env_app
|
||||
elif name == 'session_app':
|
||||
from .session import app as session_app
|
||||
return session_app
|
||||
elif name == 'schedule_app':
|
||||
from .schedule import app as schedule_app
|
||||
return schedule_app
|
||||
elif name == 'serve_app':
|
||||
from .serve import app as serve_app
|
||||
return serve_app
|
||||
elif name == 'completion_app':
|
||||
from .completion import app as completion_app
|
||||
return completion_app
|
||||
elif name == 'version_app':
|
||||
from .version import app as version_app
|
||||
return version_app
|
||||
elif name == 'debug_app':
|
||||
from .debug import app as debug_app
|
||||
return debug_app
|
||||
elif name == 'lsp_app':
|
||||
from .lsp import app as lsp_app
|
||||
return lsp_app
|
||||
elif name == 'diag_app':
|
||||
from .diag import app as diag_app
|
||||
return diag_app
|
||||
elif name == 'doctor_app':
|
||||
from .doctor import app as doctor_app
|
||||
return doctor_app
|
||||
elif name == 'acp_app':
|
||||
from .acp import app as acp_app
|
||||
return acp_app
|
||||
elif name == 'mcp_app':
|
||||
from .mcp import app as mcp_app
|
||||
return mcp_app
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
@@ -0,0 +1,70 @@
|
||||
"""
|
||||
ACP command group for PraisonAI CLI.
|
||||
|
||||
Wraps existing ACP functionality from features/acp.py.
|
||||
Provides Agent Client Protocol server for IDE integration.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Agent Client Protocol server")
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def acp_main(
|
||||
ctx: typer.Context,
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
agent: str = typer.Option("default", "--agent", "-a", help="Agent name or configuration file"),
|
||||
agents_file: Optional[str] = typer.Option(None, "--agents", help="Multi-agent configuration YAML file"),
|
||||
router: bool = typer.Option(False, "--router", help="Enable router agent for task delegation"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m", help="LLM model to use"),
|
||||
resume: Optional[str] = typer.Option(None, "--resume", "-r", help="Resume session by ID"),
|
||||
last: bool = typer.Option(False, "--last", help="Resume the last session"),
|
||||
approve: str = typer.Option("manual", "--approve", help="Approval mode: manual, auto, scoped"),
|
||||
read_only: bool = typer.Option(True, "--read-only/--allow-write", help="Read-only mode"),
|
||||
allow_shell: bool = typer.Option(False, "--allow-shell", help="Allow shell command execution"),
|
||||
allow_network: bool = typer.Option(False, "--allow-network", help="Allow network requests"),
|
||||
debug: bool = typer.Option(False, "--debug", help="Enable debug logging"),
|
||||
profile: Optional[str] = typer.Option(None, "--profile", help="Use named profile from config"),
|
||||
):
|
||||
"""Start ACP server for IDE integration."""
|
||||
# Build args for existing handler
|
||||
args = [
|
||||
"--workspace", workspace,
|
||||
"--agent", agent,
|
||||
"--approve", approve,
|
||||
]
|
||||
|
||||
if agents_file:
|
||||
args.extend(["--agents", agents_file])
|
||||
if router:
|
||||
args.append("--router")
|
||||
if model:
|
||||
args.extend(["--model", model])
|
||||
if resume:
|
||||
args.extend(["--resume", resume])
|
||||
if last:
|
||||
args.append("--last")
|
||||
if not read_only:
|
||||
args.append("--allow-write")
|
||||
if allow_shell:
|
||||
args.append("--allow-shell")
|
||||
if allow_network:
|
||||
args.append("--allow-network")
|
||||
if debug:
|
||||
args.append("--debug")
|
||||
if profile:
|
||||
args.extend(["--profile", profile])
|
||||
|
||||
try:
|
||||
from ..features.acp import run_acp_command
|
||||
exit_code = run_acp_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"ACP module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
@@ -0,0 +1,333 @@
|
||||
"""
|
||||
Completion command group for PraisonAI CLI.
|
||||
|
||||
Provides shell completion script generation:
|
||||
- completion bash: Generate bash completions
|
||||
- completion zsh: Generate zsh completions
|
||||
- completion fish: Generate fish completions
|
||||
"""
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Shell completion scripts")
|
||||
|
||||
|
||||
BASH_COMPLETION = '''
|
||||
# PraisonAI bash completion
|
||||
_praisonai_completion() {
|
||||
local cur prev opts
|
||||
COMPREPLY=()
|
||||
cur="${COMP_WORDS[COMP_CWORD]}"
|
||||
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
||||
|
||||
# Top-level commands
|
||||
opts="run config traces env session schedule serve completion version debug lsp diag doctor acp mcp chat code call realtime train ui context research memory rules workflow hooks knowledge tools todo docs commit skills profile eval templates recipe endpoints agents thinking compaction output deploy registry package install uninstall"
|
||||
|
||||
# Subcommands for specific commands
|
||||
case "${prev}" in
|
||||
config)
|
||||
COMPREPLY=( $(compgen -W "list get set reset path" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
traces)
|
||||
COMPREPLY=( $(compgen -W "enable disable status list" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
env)
|
||||
COMPREPLY=( $(compgen -W "view check doctor" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
session)
|
||||
COMPREPLY=( $(compgen -W "list resume delete export show" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
schedule)
|
||||
COMPREPLY=( $(compgen -W "start stop list logs restart delete describe save stop-all stats" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
serve)
|
||||
COMPREPLY=( $(compgen -W "start stop status" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
completion)
|
||||
COMPREPLY=( $(compgen -W "bash zsh fish" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
debug)
|
||||
COMPREPLY=( $(compgen -W "interactive lsp acp trace" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
lsp)
|
||||
COMPREPLY=( $(compgen -W "start stop status logs" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
diag)
|
||||
COMPREPLY=( $(compgen -W "export" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
doctor)
|
||||
COMPREPLY=( $(compgen -W "env config tools db mcp obs skills memory permissions network performance ci selftest" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
mcp)
|
||||
COMPREPLY=( $(compgen -W "list add remove test" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
*)
|
||||
;;
|
||||
esac
|
||||
|
||||
# Global options
|
||||
if [[ ${cur} == -* ]] ; then
|
||||
COMPREPLY=( $(compgen -W "--help --version --output-format --json --no-color --quiet --verbose --screen-reader" -- ${cur}) )
|
||||
return 0
|
||||
fi
|
||||
|
||||
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
|
||||
return 0
|
||||
}
|
||||
|
||||
complete -F _praisonai_completion praisonai
|
||||
'''
|
||||
|
||||
ZSH_COMPLETION = '''
|
||||
#compdef praisonai
|
||||
|
||||
_praisonai() {
|
||||
local -a commands
|
||||
local -a subcommands
|
||||
|
||||
commands=(
|
||||
'run:Run agents'
|
||||
'config:Configuration management'
|
||||
'traces:Trace collection management'
|
||||
'env:Environment and diagnostics'
|
||||
'session:Session management'
|
||||
'schedule:Scheduler management'
|
||||
'serve:API server management'
|
||||
'completion:Shell completion scripts'
|
||||
'version:Version information'
|
||||
'debug:Debug and test interactive flows'
|
||||
'lsp:LSP service lifecycle'
|
||||
'diag:Diagnostics export'
|
||||
'doctor:Health checks and diagnostics'
|
||||
'acp:Agent Client Protocol server'
|
||||
'mcp:MCP server management'
|
||||
'chat:Start chat UI'
|
||||
'code:Start code UI'
|
||||
'call:Start call server'
|
||||
'realtime:Start realtime interface'
|
||||
'train:Training commands'
|
||||
'ui:Start UI'
|
||||
'context:Context engineering'
|
||||
'research:Deep research'
|
||||
'memory:Memory management'
|
||||
'rules:Rules management'
|
||||
'workflow:Workflow management'
|
||||
'hooks:Hooks management'
|
||||
'knowledge:Knowledge management'
|
||||
'tools:Tools management'
|
||||
'todo:Todo management'
|
||||
'docs:Documentation'
|
||||
'commit:Git commit'
|
||||
'skills:Skills management'
|
||||
'profile:Profile management'
|
||||
'eval:Evaluation'
|
||||
'templates:Templates'
|
||||
'recipe:Recipe management'
|
||||
'endpoints:Endpoints'
|
||||
'agents:Agents management'
|
||||
'deploy:Deployment'
|
||||
'registry:Registry'
|
||||
'package:Package management'
|
||||
'install:Install packages'
|
||||
'uninstall:Uninstall packages'
|
||||
)
|
||||
|
||||
_arguments -C \\
|
||||
'--help[Show help]' \\
|
||||
'--version[Show version]' \\
|
||||
'--output-format[Output format]:format:(text json stream-json)' \\
|
||||
'--json[JSON output]' \\
|
||||
'--no-color[Disable colors]' \\
|
||||
'--quiet[Minimal output]' \\
|
||||
'--verbose[Verbose output]' \\
|
||||
'--screen-reader[Screen reader mode]' \\
|
||||
'1: :->command' \\
|
||||
'*::arg:->args'
|
||||
|
||||
case $state in
|
||||
command)
|
||||
_describe 'command' commands
|
||||
;;
|
||||
args)
|
||||
case $words[1] in
|
||||
config)
|
||||
subcommands=('list:List config' 'get:Get value' 'set:Set value' 'reset:Reset config' 'path:Show path')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
traces)
|
||||
subcommands=('enable:Enable traces' 'disable:Disable traces' 'status:Show status' 'list:List traces')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
env)
|
||||
subcommands=('view:View env vars' 'check:Check API keys' 'doctor:Run diagnostics')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
session)
|
||||
subcommands=('list:List sessions' 'resume:Resume session' 'delete:Delete session' 'export:Export session' 'show:Show session')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
schedule)
|
||||
subcommands=('start:Start scheduler' 'stop:Stop scheduler' 'list:List jobs' 'logs:View logs' 'restart:Restart' 'delete:Delete job' 'describe:Describe job' 'save:Save config' 'stop-all:Stop all' 'stats:Show stats')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
serve)
|
||||
subcommands=('start:Start server' 'stop:Stop server' 'status:Show status')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
completion)
|
||||
subcommands=('bash:Bash completion' 'zsh:Zsh completion' 'fish:Fish completion')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
debug)
|
||||
subcommands=('interactive:Interactive debug' 'lsp:LSP debug' 'acp:ACP debug' 'trace:Trace debug')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
lsp)
|
||||
subcommands=('start:Start LSP' 'stop:Stop LSP' 'status:LSP status' 'logs:LSP logs')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
diag)
|
||||
subcommands=('export:Export diagnostics')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
doctor)
|
||||
subcommands=('env:Check env' 'config:Check config' 'tools:Check tools' 'db:Check DB' 'mcp:Check MCP' 'obs:Check observability' 'skills:Check skills' 'memory:Check memory' 'permissions:Check permissions' 'network:Check network' 'performance:Check performance' 'ci:CI checks' 'selftest:Self test')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
mcp)
|
||||
subcommands=('list:List servers' 'add:Add server' 'remove:Remove server' 'test:Test server')
|
||||
_describe 'subcommand' subcommands
|
||||
;;
|
||||
esac
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
_praisonai "$@"
|
||||
'''
|
||||
|
||||
FISH_COMPLETION = '''
|
||||
# PraisonAI fish completion
|
||||
|
||||
# Top-level commands
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "run" -d "Run agents"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "config" -d "Configuration management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "traces" -d "Trace collection management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "env" -d "Environment and diagnostics"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "session" -d "Session management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "schedule" -d "Scheduler management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "serve" -d "API server management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "completion" -d "Shell completion scripts"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "version" -d "Version information"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "debug" -d "Debug and test interactive flows"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "lsp" -d "LSP service lifecycle"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "diag" -d "Diagnostics export"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "doctor" -d "Health checks and diagnostics"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "acp" -d "Agent Client Protocol server"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "mcp" -d "MCP server management"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "chat" -d "Start chat UI"
|
||||
complete -c praisonai -f -n "__fish_use_subcommand" -a "code" -d "Start code UI"
|
||||
|
||||
# Global options
|
||||
complete -c praisonai -l help -d "Show help"
|
||||
complete -c praisonai -l version -d "Show version"
|
||||
complete -c praisonai -l output-format -x -a "text json stream-json" -d "Output format"
|
||||
complete -c praisonai -l json -d "JSON output"
|
||||
complete -c praisonai -l no-color -d "Disable colors"
|
||||
complete -c praisonai -l quiet -s q -d "Minimal output"
|
||||
complete -c praisonai -l verbose -s v -d "Verbose output"
|
||||
complete -c praisonai -l screen-reader -d "Screen reader mode"
|
||||
|
||||
# config subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from config" -a "list" -d "List config"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from config" -a "get" -d "Get value"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from config" -a "set" -d "Set value"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from config" -a "reset" -d "Reset config"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from config" -a "path" -d "Show path"
|
||||
|
||||
# traces subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from traces" -a "enable" -d "Enable traces"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from traces" -a "disable" -d "Disable traces"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from traces" -a "status" -d "Show status"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from traces" -a "list" -d "List traces"
|
||||
|
||||
# env subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from env" -a "view" -d "View env vars"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from env" -a "check" -d "Check API keys"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from env" -a "doctor" -d "Run diagnostics"
|
||||
|
||||
# session subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from session" -a "list" -d "List sessions"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from session" -a "resume" -d "Resume session"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from session" -a "delete" -d "Delete session"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from session" -a "export" -d "Export session"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from session" -a "show" -d "Show session"
|
||||
|
||||
# completion subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from completion" -a "bash" -d "Bash completion"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from completion" -a "zsh" -d "Zsh completion"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from completion" -a "fish" -d "Fish completion"
|
||||
|
||||
# debug subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from debug" -a "interactive" -d "Interactive debug"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from debug" -a "lsp" -d "LSP debug"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from debug" -a "acp" -d "ACP debug"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from debug" -a "trace" -d "Trace debug"
|
||||
|
||||
# doctor subcommands
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from doctor" -a "env" -d "Check env"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from doctor" -a "config" -d "Check config"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from doctor" -a "tools" -d "Check tools"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from doctor" -a "db" -d "Check DB"
|
||||
complete -c praisonai -f -n "__fish_seen_subcommand_from doctor" -a "mcp" -d "Check MCP"
|
||||
'''
|
||||
|
||||
|
||||
@app.command("bash")
|
||||
def completion_bash():
|
||||
"""Generate bash completion script."""
|
||||
print(BASH_COMPLETION.strip())
|
||||
|
||||
|
||||
@app.command("zsh")
|
||||
def completion_zsh():
|
||||
"""Generate zsh completion script."""
|
||||
print(ZSH_COMPLETION.strip())
|
||||
|
||||
|
||||
@app.command("fish")
|
||||
def completion_fish():
|
||||
"""Generate fish completion script."""
|
||||
print(FISH_COMPLETION.strip())
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def completion_callback(ctx: typer.Context):
|
||||
"""Show completion installation instructions."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
output = get_output_controller()
|
||||
output.print_panel(
|
||||
"Generate shell completion scripts.\n\n"
|
||||
"Usage:\n"
|
||||
" # Bash\n"
|
||||
" praisonai completion bash >> ~/.bashrc\n\n"
|
||||
" # Zsh\n"
|
||||
" praisonai completion zsh > ~/.zsh/completions/_praisonai\n\n"
|
||||
" # Fish\n"
|
||||
" praisonai completion fish > ~/.config/fish/completions/praisonai.fish",
|
||||
title="Shell Completions"
|
||||
)
|
||||
@@ -0,0 +1,166 @@
|
||||
"""
|
||||
Config command group for PraisonAI CLI.
|
||||
|
||||
Provides configuration management commands:
|
||||
- config list: Show all configuration
|
||||
- config get: Get a specific value
|
||||
- config set: Set a configuration value
|
||||
- config reset: Reset to defaults
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..configuration.loader import get_config_loader
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Configuration management")
|
||||
|
||||
|
||||
@app.command("list")
|
||||
def config_list(
|
||||
scope: str = typer.Option(
|
||||
"all",
|
||||
"--scope",
|
||||
"-s",
|
||||
help="Scope to list: all, user, project",
|
||||
),
|
||||
):
|
||||
"""List all configuration values."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
config = loader.list_all()
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json(config)
|
||||
return
|
||||
|
||||
output.print_panel("Configuration", title="PraisonAI Config")
|
||||
|
||||
def print_dict(d, prefix=""):
|
||||
for key, value in d.items():
|
||||
full_key = f"{prefix}.{key}" if prefix else key
|
||||
if isinstance(value, dict):
|
||||
print_dict(value, full_key)
|
||||
else:
|
||||
output.print(f" {full_key} = {value}")
|
||||
|
||||
print_dict(config)
|
||||
|
||||
|
||||
@app.command("get")
|
||||
def config_get(
|
||||
key: str = typer.Argument(..., help="Configuration key (dotted notation, e.g., output.format)"),
|
||||
):
|
||||
"""Get a configuration value."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
value = loader.get(key)
|
||||
|
||||
if value is None:
|
||||
output.print_error(f"Key not found: {key}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"key": key, "value": value})
|
||||
else:
|
||||
output.print(f"{key} = {value}")
|
||||
|
||||
|
||||
@app.command("set")
|
||||
def config_set(
|
||||
key: str = typer.Argument(..., help="Configuration key (dotted notation)"),
|
||||
value: str = typer.Argument(..., help="Value to set"),
|
||||
scope: str = typer.Option(
|
||||
"user",
|
||||
"--scope",
|
||||
"-s",
|
||||
help="Scope: user or project",
|
||||
),
|
||||
):
|
||||
"""Set a configuration value."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
# Parse value
|
||||
if value.lower() == "true":
|
||||
parsed_value = True
|
||||
elif value.lower() == "false":
|
||||
parsed_value = False
|
||||
else:
|
||||
try:
|
||||
parsed_value = int(value)
|
||||
except ValueError:
|
||||
try:
|
||||
parsed_value = float(value)
|
||||
except ValueError:
|
||||
parsed_value = value
|
||||
|
||||
loader.set(key, parsed_value, scope=scope)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"key": key, "value": parsed_value, "scope": scope})
|
||||
else:
|
||||
output.print_success(f"Set {key} = {parsed_value} ({scope})")
|
||||
|
||||
|
||||
@app.command("reset")
|
||||
def config_reset(
|
||||
scope: str = typer.Option(
|
||||
"user",
|
||||
"--scope",
|
||||
"-s",
|
||||
help="Scope to reset: user or project",
|
||||
),
|
||||
confirm: bool = typer.Option(
|
||||
False,
|
||||
"--yes",
|
||||
"-y",
|
||||
help="Skip confirmation",
|
||||
),
|
||||
):
|
||||
"""Reset configuration to defaults."""
|
||||
output = get_output_controller()
|
||||
|
||||
if not confirm:
|
||||
confirmed = typer.confirm(f"Reset {scope} configuration to defaults?")
|
||||
if not confirmed:
|
||||
output.print_info("Cancelled")
|
||||
raise typer.Exit(0)
|
||||
|
||||
loader = get_config_loader()
|
||||
loader.reset(scope=scope)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"reset": True, "scope": scope})
|
||||
else:
|
||||
output.print_success(f"Reset {scope} configuration to defaults")
|
||||
|
||||
|
||||
@app.command("path")
|
||||
def config_path(
|
||||
scope: str = typer.Option(
|
||||
"user",
|
||||
"--scope",
|
||||
"-s",
|
||||
help="Scope: user or project",
|
||||
),
|
||||
):
|
||||
"""Show configuration file path."""
|
||||
output = get_output_controller()
|
||||
|
||||
from ..configuration.paths import get_user_config_path, get_project_config_path
|
||||
|
||||
if scope == "project":
|
||||
path = get_project_config_path()
|
||||
else:
|
||||
path = get_user_config_path()
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"path": str(path), "exists": path.exists()})
|
||||
else:
|
||||
exists = "✓" if path.exists() else "✗"
|
||||
output.print(f"{path} [{exists}]")
|
||||
@@ -0,0 +1,142 @@
|
||||
"""
|
||||
Debug command group for PraisonAI CLI.
|
||||
|
||||
Wraps existing debug functionality from features/debug.py.
|
||||
Provides debug commands for testing interactive flows.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from typing import List, Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Debug and test interactive flows")
|
||||
|
||||
|
||||
@app.command("interactive")
|
||||
def debug_interactive(
|
||||
prompt: str = typer.Option(..., "--prompt", "-p", help="Prompt to execute"),
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
lsp: bool = typer.Option(True, "--lsp/--no-lsp", help="Enable/disable LSP"),
|
||||
acp: bool = typer.Option(True, "--acp/--no-acp", help="Enable/disable ACP"),
|
||||
approval: str = typer.Option("auto", "--approval", help="Approval mode: manual, auto, scoped"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON trace"),
|
||||
trace_file: Optional[str] = typer.Option(None, "--trace-file", help="Save trace to file"),
|
||||
timeout: float = typer.Option(60.0, "--timeout", help="Timeout in seconds"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m", help="LLM model to use"),
|
||||
):
|
||||
"""Run single interactive turn non-interactively."""
|
||||
output = get_output_controller()
|
||||
|
||||
# Build args for existing handler
|
||||
args = [
|
||||
"interactive",
|
||||
"--prompt", prompt,
|
||||
"--workspace", workspace,
|
||||
"--approval", approval,
|
||||
"--timeout", str(timeout),
|
||||
]
|
||||
|
||||
if not lsp:
|
||||
args.append("--no-lsp")
|
||||
if not acp:
|
||||
args.append("--no-acp")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
if trace_file:
|
||||
args.extend(["--trace-file", trace_file])
|
||||
if model:
|
||||
args.extend(["--model", model])
|
||||
|
||||
# Delegate to existing handler
|
||||
try:
|
||||
from ..features.debug import run_debug_command
|
||||
exit_code = run_debug_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output.print_error(f"Debug module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("lsp")
|
||||
def debug_lsp(
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
language: Optional[str] = typer.Option(None, "--language", "-l", help="Language to probe"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Direct LSP probes."""
|
||||
args = ["lsp", "--workspace", workspace]
|
||||
if language:
|
||||
args.extend(["--language", language])
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.debug import run_debug_command
|
||||
exit_code = run_debug_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Debug module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("acp")
|
||||
def debug_acp(
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Direct ACP probes."""
|
||||
args = ["acp", "--workspace", workspace]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.debug import run_debug_command
|
||||
exit_code = run_debug_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Debug module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("trace")
|
||||
def debug_trace(
|
||||
action: str = typer.Argument("list", help="Action: record, replay, diff, list"),
|
||||
trace_id: Optional[str] = typer.Option(None, "--trace-id", "-t", help="Trace ID"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Trace record/replay/diff."""
|
||||
args = ["trace", action]
|
||||
if trace_id:
|
||||
args.extend(["--trace-id", trace_id])
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.debug import run_debug_command
|
||||
exit_code = run_debug_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Debug module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def debug_callback(ctx: typer.Context):
|
||||
"""Show debug help."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
output = get_output_controller()
|
||||
output.print_panel(
|
||||
"Debug commands for testing interactive coding assistant flows.\n\n"
|
||||
"Commands:\n"
|
||||
" interactive Run single interactive turn\n"
|
||||
" lsp Direct LSP probes\n"
|
||||
" acp Direct ACP probes\n"
|
||||
" trace Trace record/replay/diff",
|
||||
title="Debug Commands"
|
||||
)
|
||||
@@ -0,0 +1,55 @@
|
||||
"""
|
||||
Diag command group for PraisonAI CLI.
|
||||
|
||||
Wraps existing diagnostics functionality from features/diag.py.
|
||||
Provides diagnostic export for bug reports.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Diagnostics export")
|
||||
|
||||
|
||||
@app.command("export")
|
||||
def diag_export(
|
||||
output_path: Optional[str] = typer.Option(None, "--output", "-o", help="Output path"),
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
include_logs: bool = typer.Option(True, "--include-logs/--no-logs", help="Include log files"),
|
||||
include_config: bool = typer.Option(True, "--include-config/--no-config", help="Include configuration"),
|
||||
include_trace: bool = typer.Option(True, "--include-trace/--no-trace", help="Include recent traces"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Export diagnostic bundle for bug reports."""
|
||||
args = ["export", "--workspace", workspace]
|
||||
|
||||
if output_path:
|
||||
args.extend(["--output", output_path])
|
||||
if not include_logs:
|
||||
args.append("--no-logs")
|
||||
if not include_config:
|
||||
args.append("--no-config")
|
||||
if not include_trace:
|
||||
args.append("--no-trace")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.diag import run_diag_command
|
||||
exit_code = run_diag_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Diag module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def diag_callback(ctx: typer.Context):
|
||||
"""Show diag help or run export."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
# Default to export
|
||||
diag_export()
|
||||
@@ -0,0 +1,166 @@
|
||||
"""
|
||||
Doctor command group for PraisonAI CLI.
|
||||
|
||||
Wraps existing doctor functionality from features/doctor/.
|
||||
Provides health checks and diagnostics.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Health checks and diagnostics")
|
||||
|
||||
|
||||
def _run_doctor(args: list) -> int:
|
||||
"""Run doctor command with args."""
|
||||
try:
|
||||
from ..features.doctor.handler import DoctorHandler
|
||||
handler = DoctorHandler()
|
||||
# DoctorHandler uses execute(action, action_args) pattern
|
||||
action = args[0] if args else None
|
||||
action_args = args[1:] if len(args) > 1 else []
|
||||
return handler.execute(action, action_args)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Doctor module not available: {e}")
|
||||
return 4
|
||||
except Exception as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Doctor error: {e}")
|
||||
return 1
|
||||
|
||||
|
||||
@app.command("env")
|
||||
def doctor_env(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
timeout: float = typer.Option(10.0, "--timeout", help="Per-check timeout"),
|
||||
):
|
||||
"""Check environment variables and API keys."""
|
||||
args = ["env"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
args.extend(["--timeout", str(timeout)])
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("config")
|
||||
def doctor_config(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check configuration files."""
|
||||
args = ["config"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("tools")
|
||||
def doctor_tools(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check tools availability."""
|
||||
args = ["tools"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("db")
|
||||
def doctor_db(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check database connections."""
|
||||
args = ["db"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("mcp")
|
||||
def doctor_mcp(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check MCP servers."""
|
||||
args = ["mcp"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("network")
|
||||
def doctor_network(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check network connectivity."""
|
||||
args = ["network"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("performance")
|
||||
def doctor_performance(
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Check performance metrics."""
|
||||
args = ["performance"]
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.command("selftest")
|
||||
def doctor_selftest(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Run self-test."""
|
||||
args = ["selftest"]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def doctor_callback(
|
||||
ctx: typer.Context,
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deeper probes"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
strict: bool = typer.Option(False, "--strict", help="Treat warnings as failures"),
|
||||
quiet: bool = typer.Option(False, "--quiet", "-q", help="Minimal output"),
|
||||
):
|
||||
"""Run all fast health checks."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
args = []
|
||||
if deep:
|
||||
args.append("--deep")
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
if strict:
|
||||
args.append("--strict")
|
||||
if quiet:
|
||||
args.append("--quiet")
|
||||
raise typer.Exit(_run_doctor(args))
|
||||
@@ -0,0 +1,179 @@
|
||||
"""
|
||||
Environment command group for PraisonAI CLI.
|
||||
|
||||
Provides environment management and diagnostics:
|
||||
- env view: Show environment variables
|
||||
- env check: Validate API keys
|
||||
- env doctor: Run diagnostics (alias for doctor command)
|
||||
"""
|
||||
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Environment and diagnostics")
|
||||
|
||||
|
||||
# Known API key patterns
|
||||
API_KEY_PATTERNS = {
|
||||
"OPENAI_API_KEY": {"prefix": "sk-", "min_length": 20},
|
||||
"ANTHROPIC_API_KEY": {"prefix": "sk-ant-", "min_length": 20},
|
||||
"GOOGLE_API_KEY": {"prefix": "AI", "min_length": 20},
|
||||
"GEMINI_API_KEY": {"prefix": "AI", "min_length": 20},
|
||||
"TAVILY_API_KEY": {"prefix": "tvly-", "min_length": 20},
|
||||
"GROQ_API_KEY": {"prefix": "gsk_", "min_length": 20},
|
||||
}
|
||||
|
||||
|
||||
def _redact_key(value: str, show_chars: int = 4) -> str:
|
||||
"""Redact an API key for display."""
|
||||
if len(value) <= show_chars * 2:
|
||||
return "*" * len(value)
|
||||
return value[:show_chars] + "*" * (len(value) - show_chars * 2) + value[-show_chars:]
|
||||
|
||||
|
||||
def _validate_key(name: str, value: str) -> tuple[bool, str]:
|
||||
"""Validate an API key format."""
|
||||
if name not in API_KEY_PATTERNS:
|
||||
return True, "Unknown key type"
|
||||
|
||||
pattern = API_KEY_PATTERNS[name]
|
||||
|
||||
if len(value) < pattern["min_length"]:
|
||||
return False, f"Too short (expected >= {pattern['min_length']} chars)"
|
||||
|
||||
if pattern.get("prefix") and not value.startswith(pattern["prefix"]):
|
||||
return False, f"Invalid prefix (expected {pattern['prefix']}...)"
|
||||
|
||||
return True, "Valid format"
|
||||
|
||||
|
||||
@app.command("view")
|
||||
def env_view(
|
||||
show_values: bool = typer.Option(
|
||||
False,
|
||||
"--show-values",
|
||||
help="Show actual values (redacted by default)",
|
||||
),
|
||||
filter_prefix: Optional[str] = typer.Option(
|
||||
None,
|
||||
"--filter",
|
||||
"-f",
|
||||
help="Filter by prefix (e.g., OPENAI, PRAISONAI)",
|
||||
),
|
||||
):
|
||||
"""Show relevant environment variables."""
|
||||
output = get_output_controller()
|
||||
|
||||
# Relevant prefixes
|
||||
prefixes = ["OPENAI", "ANTHROPIC", "GOOGLE", "GEMINI", "TAVILY", "GROQ",
|
||||
"PRAISONAI", "MODEL", "LLM", "OLLAMA", "AZURE"]
|
||||
|
||||
if filter_prefix:
|
||||
prefixes = [filter_prefix.upper()]
|
||||
|
||||
env_vars = {}
|
||||
for key, value in os.environ.items():
|
||||
for prefix in prefixes:
|
||||
if key.upper().startswith(prefix):
|
||||
if show_values:
|
||||
if "KEY" in key.upper() or "SECRET" in key.upper() or "TOKEN" in key.upper():
|
||||
env_vars[key] = _redact_key(value)
|
||||
else:
|
||||
env_vars[key] = value
|
||||
else:
|
||||
env_vars[key] = "***" if value else "(empty)"
|
||||
break
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"environment": env_vars})
|
||||
return
|
||||
|
||||
if not env_vars:
|
||||
output.print_info("No relevant environment variables found")
|
||||
return
|
||||
|
||||
headers = ["Variable", "Value"]
|
||||
rows = [[k, v] for k, v in sorted(env_vars.items())]
|
||||
output.print_table(headers, rows, title="Environment Variables")
|
||||
|
||||
|
||||
@app.command("check")
|
||||
def env_check():
|
||||
"""Validate API keys and configuration."""
|
||||
output = get_output_controller()
|
||||
|
||||
results = []
|
||||
all_valid = True
|
||||
|
||||
for key_name, pattern in API_KEY_PATTERNS.items():
|
||||
value = os.environ.get(key_name)
|
||||
|
||||
if value:
|
||||
valid, message = _validate_key(key_name, value)
|
||||
results.append({
|
||||
"key": key_name,
|
||||
"present": True,
|
||||
"valid": valid,
|
||||
"message": message,
|
||||
})
|
||||
if not valid:
|
||||
all_valid = False
|
||||
else:
|
||||
results.append({
|
||||
"key": key_name,
|
||||
"present": False,
|
||||
"valid": False,
|
||||
"message": "Not set",
|
||||
})
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"checks": results, "all_valid": all_valid})
|
||||
return
|
||||
|
||||
headers = ["Key", "Status", "Message"]
|
||||
rows = []
|
||||
for r in results:
|
||||
if r["present"]:
|
||||
status = "✅" if r["valid"] else "⚠️"
|
||||
else:
|
||||
status = "❌"
|
||||
rows.append([r["key"], status, r["message"]])
|
||||
|
||||
output.print_table(headers, rows, title="API Key Validation")
|
||||
|
||||
if not all_valid:
|
||||
output.print_warning("Some API keys are missing or invalid")
|
||||
raise typer.Exit(3) # Exit code 3 = missing config/env
|
||||
|
||||
|
||||
@app.command("doctor")
|
||||
def env_doctor(
|
||||
deep: bool = typer.Option(
|
||||
False,
|
||||
"--deep",
|
||||
help="Run deep checks (network, DB connections)",
|
||||
),
|
||||
):
|
||||
"""Run environment diagnostics (alias for 'praisonai doctor env')."""
|
||||
output = get_output_controller()
|
||||
|
||||
# Delegate to doctor command
|
||||
try:
|
||||
from ..features.doctor.handler import DoctorHandler
|
||||
handler = DoctorHandler()
|
||||
|
||||
# Run env checks
|
||||
if output.is_json_mode:
|
||||
# Run and get JSON output
|
||||
result = handler.handle(["env", "--json"] if not deep else ["env", "--json", "--deep"])
|
||||
else:
|
||||
result = handler.handle(["env"] if not deep else ["env", "--deep"])
|
||||
|
||||
raise typer.Exit(result)
|
||||
except ImportError:
|
||||
# Fallback to basic env check
|
||||
env_check()
|
||||
@@ -0,0 +1,112 @@
|
||||
"""
|
||||
LSP command group for PraisonAI CLI.
|
||||
|
||||
Wraps existing LSP functionality from features/lsp_cli.py.
|
||||
Provides LSP service lifecycle management.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="LSP service lifecycle management")
|
||||
|
||||
|
||||
@app.command("start")
|
||||
def lsp_start(
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
language: Optional[str] = typer.Option(None, "--language", "-l", help="Language to start"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Start LSP server(s)."""
|
||||
args = ["start", "--workspace", workspace]
|
||||
if language:
|
||||
args.extend(["--language", language])
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.lsp_cli import run_lsp_command
|
||||
exit_code = run_lsp_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"LSP module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("stop")
|
||||
def lsp_stop(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Stop LSP server(s)."""
|
||||
args = ["stop"]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.lsp_cli import run_lsp_command
|
||||
exit_code = run_lsp_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"LSP module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("status")
|
||||
def lsp_status(
|
||||
workspace: str = typer.Option(".", "--workspace", "-w", help="Workspace root directory"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Show LSP status."""
|
||||
args = ["status", "--workspace", workspace]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.lsp_cli import run_lsp_command
|
||||
exit_code = run_lsp_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"LSP module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("logs")
|
||||
def lsp_logs(
|
||||
tail: int = typer.Option(50, "--tail", "-n", help="Number of lines to show"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Show recent LSP logs."""
|
||||
args = ["logs", "--tail", str(tail)]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.lsp_cli import run_lsp_command
|
||||
exit_code = run_lsp_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"LSP module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def lsp_callback(ctx: typer.Context):
|
||||
"""Show LSP help."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
output = get_output_controller()
|
||||
output.print_panel(
|
||||
"LSP service lifecycle management.\n\n"
|
||||
"Commands:\n"
|
||||
" start Start LSP server(s)\n"
|
||||
" stop Stop LSP server(s)\n"
|
||||
" status Show LSP status\n"
|
||||
" logs Show recent logs",
|
||||
title="LSP Commands"
|
||||
)
|
||||
@@ -0,0 +1,210 @@
|
||||
"""
|
||||
MCP command group for PraisonAI CLI.
|
||||
|
||||
Provides MCP (Model Context Protocol) server management.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
from ..configuration.loader import get_config_loader
|
||||
|
||||
app = typer.Typer(help="MCP server management")
|
||||
|
||||
|
||||
@app.command("list")
|
||||
def mcp_list(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""List configured MCP servers."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
config = loader.load()
|
||||
servers = config.mcp.servers
|
||||
|
||||
if output.is_json_mode or json_output:
|
||||
output.print_json({
|
||||
"servers": {
|
||||
name: {
|
||||
"command": s.command,
|
||||
"args": s.args,
|
||||
"enabled": s.enabled,
|
||||
}
|
||||
for name, s in servers.items()
|
||||
}
|
||||
})
|
||||
return
|
||||
|
||||
if not servers:
|
||||
output.print_info("No MCP servers configured")
|
||||
output.print("\nAdd a server with: praisonai mcp add <name> <command>")
|
||||
return
|
||||
|
||||
headers = ["Name", "Command", "Enabled"]
|
||||
rows = []
|
||||
for name, server in servers.items():
|
||||
cmd = f"{server.command} {' '.join(server.args)}"
|
||||
if len(cmd) > 50:
|
||||
cmd = cmd[:47] + "..."
|
||||
rows.append([name, cmd, "✓" if server.enabled else "✗"])
|
||||
|
||||
output.print_table(headers, rows, title="MCP Servers")
|
||||
|
||||
|
||||
@app.command("add")
|
||||
def mcp_add(
|
||||
name: str = typer.Argument(..., help="Server name"),
|
||||
command: str = typer.Argument(..., help="Command to run"),
|
||||
args: Optional[str] = typer.Option(None, "--args", "-a", help="Command arguments (space-separated)"),
|
||||
env: Optional[str] = typer.Option(None, "--env", "-e", help="Environment variables (KEY=VALUE,...)"),
|
||||
):
|
||||
"""Add an MCP server."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
# Parse args
|
||||
arg_list = args.split() if args else []
|
||||
|
||||
# Parse env
|
||||
env_dict = {}
|
||||
if env:
|
||||
for pair in env.split(","):
|
||||
if "=" in pair:
|
||||
key, value = pair.split("=", 1)
|
||||
env_dict[key.strip()] = value.strip()
|
||||
|
||||
# Build server config
|
||||
server_config = {
|
||||
"command": command,
|
||||
"args": arg_list,
|
||||
"env": env_dict,
|
||||
"enabled": True,
|
||||
}
|
||||
|
||||
# Save to config
|
||||
loader.set(f"mcp.servers.{name}", server_config)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"added": name, "config": server_config})
|
||||
else:
|
||||
output.print_success(f"Added MCP server: {name}")
|
||||
|
||||
|
||||
@app.command("remove")
|
||||
def mcp_remove(
|
||||
name: str = typer.Argument(..., help="Server name to remove"),
|
||||
confirm: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
|
||||
):
|
||||
"""Remove an MCP server."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
config = loader.load()
|
||||
if name not in config.mcp.servers:
|
||||
output.print_error(f"Server not found: {name}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if not confirm:
|
||||
confirmed = typer.confirm(f"Remove MCP server '{name}'?")
|
||||
if not confirmed:
|
||||
output.print_info("Cancelled")
|
||||
raise typer.Exit(0)
|
||||
|
||||
# Remove from config by setting to None (will be cleaned up)
|
||||
# For now, we need to reload and modify the raw config
|
||||
from ..configuration.paths import get_user_config_path
|
||||
from ..configuration.loader import _load_toml, _save_toml
|
||||
|
||||
config_path = get_user_config_path()
|
||||
if config_path.exists():
|
||||
raw_config = _load_toml(config_path)
|
||||
if "mcp" in raw_config and "servers" in raw_config["mcp"]:
|
||||
if name in raw_config["mcp"]["servers"]:
|
||||
del raw_config["mcp"]["servers"][name]
|
||||
_save_toml(config_path, raw_config)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"removed": name})
|
||||
else:
|
||||
output.print_success(f"Removed MCP server: {name}")
|
||||
|
||||
|
||||
@app.command("test")
|
||||
def mcp_test(
|
||||
name: str = typer.Argument(..., help="Server name to test"),
|
||||
timeout: float = typer.Option(10.0, "--timeout", "-t", help="Timeout in seconds"),
|
||||
):
|
||||
"""Test an MCP server connection."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
config = loader.load()
|
||||
if name not in config.mcp.servers:
|
||||
output.print_error(f"Server not found: {name}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
server = config.mcp.servers[name]
|
||||
|
||||
output.print_info(f"Testing MCP server: {name}")
|
||||
output.print(f" Command: {server.command} {' '.join(server.args)}")
|
||||
|
||||
# Try to start the server and check if it responds
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
try:
|
||||
cmd = [server.command] + server.args
|
||||
env = dict(**server.env) if server.env else None
|
||||
|
||||
# Start process
|
||||
proc = subprocess.Popen(
|
||||
cmd,
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.PIPE,
|
||||
env=env,
|
||||
)
|
||||
|
||||
# Wait briefly and check if it's running
|
||||
time.sleep(0.5)
|
||||
|
||||
if proc.poll() is None:
|
||||
# Process is running
|
||||
proc.terminate()
|
||||
proc.wait(timeout=2)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"name": name, "status": "ok", "message": "Server started successfully"})
|
||||
else:
|
||||
output.print_success(f"Server '{name}' started successfully")
|
||||
else:
|
||||
# Process exited
|
||||
stderr = proc.stderr.read().decode() if proc.stderr else ""
|
||||
if output.is_json_mode:
|
||||
output.print_json({"name": name, "status": "error", "message": stderr or "Server exited immediately"})
|
||||
else:
|
||||
output.print_error(f"Server exited immediately: {stderr}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
except FileNotFoundError:
|
||||
if output.is_json_mode:
|
||||
output.print_json({"name": name, "status": "error", "message": f"Command not found: {server.command}"})
|
||||
else:
|
||||
output.print_error(f"Command not found: {server.command}")
|
||||
raise typer.Exit(1)
|
||||
except Exception as e:
|
||||
if output.is_json_mode:
|
||||
output.print_json({"name": name, "status": "error", "message": str(e)})
|
||||
else:
|
||||
output.print_error(f"Test failed: {e}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def mcp_callback(ctx: typer.Context):
|
||||
"""Show MCP help or list servers."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
mcp_list(json_output=False)
|
||||
@@ -0,0 +1,466 @@
|
||||
"""
|
||||
Profile command group for PraisonAI CLI.
|
||||
|
||||
Provides detailed cProfile-based profiling for query execution.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
app = typer.Typer(help="Performance profiling and diagnostics")
|
||||
|
||||
|
||||
@app.command("query")
|
||||
def profile_query(
|
||||
prompt: str = typer.Argument(..., help="Prompt to profile"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m", help="Model to use"),
|
||||
stream: bool = typer.Option(False, "--stream/--no-stream", help="Use streaming mode"),
|
||||
deep: bool = typer.Option(False, "--deep", help="Enable deep call tracing (higher overhead)"),
|
||||
limit: int = typer.Option(30, "--limit", "-n", help="Top N functions to show"),
|
||||
sort: str = typer.Option("cumulative", "--sort", "-s", help="Sort by: cumulative or tottime"),
|
||||
show_callers: bool = typer.Option(False, "--show-callers", help="Show caller functions"),
|
||||
show_callees: bool = typer.Option(False, "--show-callees", help="Show callee functions"),
|
||||
save: Optional[str] = typer.Option(None, "--save", help="Save artifacts to path (creates .prof, .txt, .json)"),
|
||||
output_format: str = typer.Option("text", "--format", "-f", help="Output format: text or json"),
|
||||
):
|
||||
"""
|
||||
Profile a query execution with detailed timing breakdown.
|
||||
|
||||
Uses the unified profiling architecture for consistent results across
|
||||
CLI direct invocation (--profile) and this command.
|
||||
|
||||
Shows per-function timing, call graphs, and latency metrics.
|
||||
|
||||
Examples:
|
||||
praisonai profile query "What is 2+2?"
|
||||
praisonai profile query "Hello" --limit 20
|
||||
praisonai profile query "Test" --deep --show-callers --show-callees
|
||||
praisonai profile query "Test" --save ./profile_results
|
||||
"""
|
||||
# Use unified profiler for consistent results
|
||||
try:
|
||||
from ..execution import ExecutionRequest, Profiler, ProfilerConfig as UnifiedProfilerConfig
|
||||
except ImportError as e:
|
||||
typer.echo(f"Error: Unified profiler not available: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Warn about deep tracing overhead
|
||||
if deep:
|
||||
typer.echo("⚠️ Deep call tracing enabled - this adds significant overhead", err=True)
|
||||
|
||||
# Create unified execution request
|
||||
request = ExecutionRequest(
|
||||
prompt=prompt,
|
||||
agent_name="ProfiledAgent",
|
||||
model=model,
|
||||
stream=stream,
|
||||
)
|
||||
|
||||
# Create unified profiler config
|
||||
config = UnifiedProfilerConfig(
|
||||
layer=2 if deep else 1,
|
||||
limit=limit,
|
||||
sort_by=sort,
|
||||
show_callers=show_callers,
|
||||
show_callees=show_callees,
|
||||
output_format=output_format,
|
||||
save_path=save,
|
||||
)
|
||||
|
||||
# Run profiler
|
||||
typer.echo("🔬 Starting profiled execution...", err=True)
|
||||
|
||||
try:
|
||||
profiler = Profiler(config)
|
||||
result, report = profiler.profile_sync(request, invocation_method="profile_command")
|
||||
except ImportError as e:
|
||||
typer.echo(f"Error: {e}", err=True)
|
||||
typer.echo("Install praisonaiagents: pip install praisonaiagents", err=True)
|
||||
raise typer.Exit(1)
|
||||
except Exception as e:
|
||||
typer.echo(f"Error during profiling: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Output results
|
||||
if output_format == "json":
|
||||
typer.echo(report.to_json())
|
||||
else:
|
||||
typer.echo(report.to_text())
|
||||
|
||||
# Save artifacts if requested
|
||||
if save:
|
||||
try:
|
||||
import os
|
||||
os.makedirs(save, exist_ok=True)
|
||||
|
||||
# Save JSON report
|
||||
json_path = os.path.join(save, "profile_report.json")
|
||||
with open(json_path, 'w') as f:
|
||||
f.write(report.to_json())
|
||||
|
||||
# Save text report
|
||||
txt_path = os.path.join(save, "profile_report.txt")
|
||||
with open(txt_path, 'w') as f:
|
||||
f.write(report.to_text())
|
||||
|
||||
typer.echo("\n✅ Artifacts saved:", err=True)
|
||||
typer.echo(f" {json_path}", err=True)
|
||||
typer.echo(f" {txt_path}", err=True)
|
||||
except Exception as e:
|
||||
typer.echo(f"Warning: Failed to save artifacts: {e}", err=True)
|
||||
|
||||
|
||||
@app.command("imports")
|
||||
def profile_imports():
|
||||
"""
|
||||
Profile module import times.
|
||||
|
||||
Shows which modules take longest to import, useful for optimizing startup time.
|
||||
"""
|
||||
import subprocess
|
||||
import re
|
||||
|
||||
typer.echo("🔬 Profiling import times...", err=True)
|
||||
|
||||
try:
|
||||
result = subprocess.run(
|
||||
[sys.executable, "-X", "importtime", "-c", "import praisonaiagents"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=60,
|
||||
)
|
||||
|
||||
# Parse import times
|
||||
import_times = []
|
||||
for line in result.stderr.split('\n'):
|
||||
if 'import time:' in line:
|
||||
match = re.search(r'import time:\s+(\d+)\s+\|\s+(\d+)\s+\|\s+(.+)', line)
|
||||
if match:
|
||||
self_time = int(match.group(1))
|
||||
cumulative = int(match.group(2))
|
||||
module = match.group(3).strip()
|
||||
import_times.append((module, self_time, cumulative))
|
||||
|
||||
# Sort by cumulative time
|
||||
import_times.sort(key=lambda x: x[2], reverse=True)
|
||||
|
||||
# Display
|
||||
typer.echo("\n" + "=" * 70)
|
||||
typer.echo("Import Time Analysis")
|
||||
typer.echo("=" * 70)
|
||||
typer.echo(f"{'Module':<45} {'Self (μs)':>10} {'Cumul (μs)':>12}")
|
||||
typer.echo("-" * 70)
|
||||
|
||||
for module, self_time, cumulative in import_times[:30]:
|
||||
module_name = module
|
||||
if len(module_name) > 43:
|
||||
module_name = "..." + module_name[-40:]
|
||||
typer.echo(f"{module_name:<45} {self_time:>10} {cumulative:>12}")
|
||||
|
||||
typer.echo("-" * 70)
|
||||
|
||||
if import_times:
|
||||
total_time = max(t[2] for t in import_times)
|
||||
typer.echo(f"Total import time: {total_time / 1000:.2f} ms")
|
||||
|
||||
except subprocess.TimeoutExpired:
|
||||
typer.echo("Error: Import profiling timed out", err=True)
|
||||
raise typer.Exit(1)
|
||||
except Exception as e:
|
||||
typer.echo(f"Error: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@app.command("startup")
|
||||
def profile_startup():
|
||||
"""
|
||||
Profile CLI startup time.
|
||||
|
||||
Measures time from CLI invocation to ready state.
|
||||
"""
|
||||
import time
|
||||
import subprocess
|
||||
|
||||
typer.echo("🔬 Profiling startup time...", err=True)
|
||||
|
||||
# Measure cold start (new process)
|
||||
start = time.perf_counter()
|
||||
subprocess.run(
|
||||
[sys.executable, "-c", "import praisonai; import praisonai.cli"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
)
|
||||
cold_start = (time.perf_counter() - start) * 1000
|
||||
|
||||
# Measure warm start (imports cached)
|
||||
start = time.perf_counter()
|
||||
subprocess.run(
|
||||
[sys.executable, "-c", "import praisonai; import praisonai.cli"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
)
|
||||
warm_start = (time.perf_counter() - start) * 1000
|
||||
|
||||
typer.echo("\n" + "=" * 50)
|
||||
typer.echo("Startup Time Analysis")
|
||||
typer.echo("=" * 50)
|
||||
typer.echo(f"Cold Start: {cold_start:>10.2f} ms")
|
||||
typer.echo(f"Warm Start: {warm_start:>10.2f} ms")
|
||||
typer.echo("=" * 50)
|
||||
|
||||
if cold_start > 1000:
|
||||
typer.echo("\n⚠️ Cold start > 1s - consider lazy imports", err=True)
|
||||
|
||||
|
||||
@app.command("suite")
|
||||
def profile_suite(
|
||||
output_dir: Optional[str] = typer.Option("/tmp/praisonai_profile_suite", "--output", "-o", help="Output directory for results"),
|
||||
iterations: int = typer.Option(3, "--iterations", "-n", help="Iterations per scenario"),
|
||||
quick: bool = typer.Option(False, "--quick", help="Quick mode (fewer iterations)"),
|
||||
):
|
||||
"""
|
||||
Run a comprehensive profiling suite.
|
||||
|
||||
Runs multiple scenarios (streaming/non-streaming, simple/complex prompts)
|
||||
and produces aggregated statistics and reports.
|
||||
|
||||
Examples:
|
||||
praisonai profile suite
|
||||
praisonai profile suite --output ./my_profile_results
|
||||
praisonai profile suite --quick
|
||||
"""
|
||||
try:
|
||||
from ..features.profiler import run_profile_suite, ScenarioConfig
|
||||
except ImportError as e:
|
||||
typer.echo(f"Error: Profiler module not available: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Define scenarios
|
||||
iters = 1 if quick else iterations
|
||||
scenarios = [
|
||||
ScenarioConfig(name="simple_non_stream", prompt="hi", stream=False, iterations=iters, warmup=0 if quick else 1),
|
||||
ScenarioConfig(name="simple_stream", prompt="hi", stream=True, iterations=iters, warmup=0 if quick else 1),
|
||||
]
|
||||
|
||||
if not quick:
|
||||
scenarios.extend([
|
||||
ScenarioConfig(name="medium_non_stream", prompt="Explain Python in 2 sentences", stream=False, iterations=max(1, iters-1)),
|
||||
ScenarioConfig(name="medium_stream", prompt="Explain Python in 2 sentences", stream=True, iterations=max(1, iters-1)),
|
||||
])
|
||||
|
||||
typer.echo("🔬 Running Profile Suite...", err=True)
|
||||
typer.echo(f" Output: {output_dir}", err=True)
|
||||
typer.echo(f" Scenarios: {len(scenarios)}", err=True)
|
||||
typer.echo(f" Iterations: {iterations}", err=True)
|
||||
|
||||
try:
|
||||
result = run_profile_suite(
|
||||
output_dir=output_dir,
|
||||
scenarios=scenarios,
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Print summary
|
||||
typer.echo("\n" + "=" * 60)
|
||||
typer.echo("Profile Suite Summary")
|
||||
typer.echo("=" * 60)
|
||||
typer.echo(f"Startup Cold: {result.startup_cold_ms:.2f}ms")
|
||||
typer.echo(f"Startup Warm: {result.startup_warm_ms:.2f}ms")
|
||||
|
||||
if result.import_analysis:
|
||||
typer.echo(f"\nTop Import: {result.import_analysis[0]['module']}")
|
||||
typer.echo(f" Time: {result.import_analysis[0]['cumulative_ms']:.2f}ms")
|
||||
|
||||
typer.echo("\nScenario Results:")
|
||||
for scenario in result.scenarios:
|
||||
stats = scenario.get_stats(scenario.total_times)
|
||||
typer.echo(f" {scenario.name}: {stats['mean']:.2f}ms (±{stats['stdev']:.2f}ms)")
|
||||
|
||||
typer.echo(f"\n✅ Full results saved to: {output_dir}")
|
||||
|
||||
except Exception as e:
|
||||
typer.echo(f"Error running suite: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@app.command("snapshot")
|
||||
def profile_snapshot(
|
||||
name: str = typer.Argument("current", help="Name for the snapshot"),
|
||||
baseline: bool = typer.Option(False, "--baseline", "-b", help="Save as baseline for comparison"),
|
||||
compare: bool = typer.Option(False, "--compare", "-c", help="Compare against baseline"),
|
||||
output_format: str = typer.Option("text", "--format", "-f", help="Output format: text or json"),
|
||||
):
|
||||
"""
|
||||
Create or compare performance snapshots.
|
||||
|
||||
Snapshots record timing data for baseline comparison.
|
||||
Use --baseline to save a reference point, then --compare to check for regressions.
|
||||
|
||||
Examples:
|
||||
praisonai profile snapshot --baseline
|
||||
praisonai profile snapshot current --compare
|
||||
praisonai profile snapshot v2.0 --format json
|
||||
"""
|
||||
try:
|
||||
from ..features.profiler import (
|
||||
run_profile_suite,
|
||||
ScenarioConfig,
|
||||
PerfSnapshotManager,
|
||||
create_snapshot_from_suite,
|
||||
format_comparison_report,
|
||||
)
|
||||
except ImportError as e:
|
||||
typer.echo(f"Error: Profiler module not available: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
manager = PerfSnapshotManager()
|
||||
|
||||
if compare:
|
||||
# Load baseline and compare
|
||||
baseline_snap = manager.load_baseline()
|
||||
if not baseline_snap:
|
||||
typer.echo("❌ No baseline found. Create one with: praisonai profile snapshot --baseline", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
typer.echo("🔬 Running current profile for comparison...", err=True)
|
||||
|
||||
# Run quick suite
|
||||
scenarios = [
|
||||
ScenarioConfig(name="simple", prompt="hi", stream=False, iterations=2, warmup=1),
|
||||
]
|
||||
result = run_profile_suite(
|
||||
output_dir="/tmp/praisonai_snapshot_compare",
|
||||
scenarios=scenarios,
|
||||
verbose=False,
|
||||
)
|
||||
|
||||
current_snap = create_snapshot_from_suite(result, name)
|
||||
comparison = manager.compare(current_snap)
|
||||
|
||||
if output_format == "json":
|
||||
import json
|
||||
typer.echo(json.dumps(comparison.to_dict(), indent=2))
|
||||
else:
|
||||
typer.echo(format_comparison_report(comparison))
|
||||
|
||||
if comparison.is_regression():
|
||||
raise typer.Exit(1) # Exit with error on regression
|
||||
else:
|
||||
# Create new snapshot
|
||||
typer.echo(f"🔬 Creating performance snapshot '{name}'...", err=True)
|
||||
|
||||
scenarios = [
|
||||
ScenarioConfig(name="simple", prompt="hi", stream=False, iterations=3, warmup=1),
|
||||
ScenarioConfig(name="stream", prompt="hi", stream=True, iterations=2, warmup=1),
|
||||
]
|
||||
result = run_profile_suite(
|
||||
output_dir="/tmp/praisonai_snapshot",
|
||||
scenarios=scenarios,
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
snapshot = create_snapshot_from_suite(result, name)
|
||||
|
||||
if baseline:
|
||||
path = manager.save_baseline(snapshot)
|
||||
typer.echo(f"\n✅ Baseline saved to: {path}")
|
||||
else:
|
||||
path = manager.save(snapshot)
|
||||
typer.echo(f"\n✅ Snapshot saved to: {path}")
|
||||
|
||||
if output_format == "json":
|
||||
import json
|
||||
typer.echo(json.dumps(snapshot.to_dict(), indent=2))
|
||||
else:
|
||||
typer.echo("\nSnapshot Summary:")
|
||||
typer.echo(f" Startup Cold: {snapshot.startup_cold_ms:.2f}ms")
|
||||
typer.echo(f" Import Time: {snapshot.import_time_ms:.2f}ms")
|
||||
typer.echo(f" Query Time: {snapshot.query_time_ms:.2f}ms")
|
||||
|
||||
|
||||
@app.command("optimize")
|
||||
def profile_optimize(
|
||||
prewarm: bool = typer.Option(False, "--prewarm", help="Enable provider pre-warming"),
|
||||
lite: bool = typer.Option(False, "--lite", help="Enable lite mode (skip type validation)"),
|
||||
show_config: bool = typer.Option(False, "--show", help="Show current optimization config"),
|
||||
):
|
||||
"""
|
||||
Configure performance optimizations.
|
||||
|
||||
All optimizations are opt-in and safe by default.
|
||||
|
||||
Examples:
|
||||
praisonai profile optimize --show
|
||||
praisonai profile optimize --prewarm
|
||||
praisonai profile optimize --lite
|
||||
"""
|
||||
try:
|
||||
from ..features.profiler import (
|
||||
PrewarmManager,
|
||||
get_lite_mode_config,
|
||||
get_provider_cache,
|
||||
)
|
||||
except ImportError as e:
|
||||
typer.echo(f"Error: Profiler module not available: {e}", err=True)
|
||||
raise typer.Exit(1)
|
||||
|
||||
if show_config:
|
||||
typer.echo("=" * 50)
|
||||
typer.echo("Performance Optimization Status")
|
||||
typer.echo("=" * 50)
|
||||
|
||||
lite_config = get_lite_mode_config()
|
||||
typer.echo(f"\nLite Mode: {'Enabled' if lite_config.enabled else 'Disabled'}")
|
||||
if lite_config.enabled:
|
||||
typer.echo(f" Skip Type Validation: {lite_config.skip_type_validation}")
|
||||
typer.echo(f" Skip Model Validation: {lite_config.skip_model_validation}")
|
||||
typer.echo(f" Minimal Imports: {lite_config.minimal_imports}")
|
||||
|
||||
typer.echo(f"\nPre-warming: {'Enabled' if PrewarmManager.is_enabled() else 'Disabled'}")
|
||||
|
||||
cache = get_provider_cache()
|
||||
stats = cache.get_stats()
|
||||
typer.echo("\nProvider Cache:")
|
||||
typer.echo(f" Hits: {stats['hits']}")
|
||||
typer.echo(f" Misses: {stats['misses']}")
|
||||
typer.echo(f" Size: {stats['size']}")
|
||||
|
||||
typer.echo("\n" + "=" * 50)
|
||||
typer.echo("\nTo enable optimizations, set environment variables:")
|
||||
typer.echo(" PRAISONAI_LITE_MODE=1")
|
||||
typer.echo(" PRAISONAI_SKIP_TYPE_VALIDATION=1")
|
||||
typer.echo(" PRAISONAI_MINIMAL_IMPORTS=1")
|
||||
return
|
||||
|
||||
if prewarm:
|
||||
typer.echo("🔥 Enabling provider pre-warming...")
|
||||
PrewarmManager.enable()
|
||||
|
||||
import os
|
||||
if os.environ.get('OPENAI_API_KEY'):
|
||||
typer.echo(" Pre-warming OpenAI...")
|
||||
PrewarmManager.prewarm_provider('openai')
|
||||
if os.environ.get('ANTHROPIC_API_KEY'):
|
||||
typer.echo(" Pre-warming Anthropic...")
|
||||
PrewarmManager.prewarm_provider('anthropic')
|
||||
|
||||
typer.echo("✅ Pre-warming initiated (runs in background)")
|
||||
|
||||
if lite:
|
||||
typer.echo("⚡ Lite mode configuration:")
|
||||
typer.echo(" Set these environment variables to enable:")
|
||||
typer.echo(" export PRAISONAI_LITE_MODE=1")
|
||||
typer.echo(" export PRAISONAI_SKIP_TYPE_VALIDATION=1")
|
||||
typer.echo(" export PRAISONAI_MINIMAL_IMPORTS=1")
|
||||
|
||||
if not prewarm and not lite and not show_config:
|
||||
typer.echo("Use --show to see current config, or --prewarm/--lite to enable optimizations")
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def profile_callback(ctx: typer.Context):
|
||||
"""Show profile help if no subcommand."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
typer.echo(ctx.get_help())
|
||||
@@ -0,0 +1,228 @@
|
||||
"""
|
||||
Run command group for PraisonAI CLI.
|
||||
|
||||
Provides agent execution commands.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
from ..state.identifiers import get_current_context
|
||||
|
||||
app = typer.Typer(help="Run agents")
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def run_main(
|
||||
ctx: typer.Context,
|
||||
target: Optional[str] = typer.Argument(None, help="Agent file or prompt"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m", help="LLM model to use"),
|
||||
framework: Optional[str] = typer.Option(None, "--framework", "-f", help="Framework: praisonai, crewai, autogen"),
|
||||
interactive: bool = typer.Option(False, "--interactive", "-i", help="Interactive mode"),
|
||||
verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output"),
|
||||
stream: bool = typer.Option(True, "--stream/--no-stream", help="Stream output"),
|
||||
trace: bool = typer.Option(False, "--trace", help="Enable tracing"),
|
||||
memory: bool = typer.Option(False, "--memory", help="Enable memory"),
|
||||
tools: Optional[str] = typer.Option(None, "--tools", "-t", help="Tools file path"),
|
||||
max_tokens: int = typer.Option(16000, "--max-tokens", help="Maximum output tokens"),
|
||||
):
|
||||
"""
|
||||
Run agents from a file or prompt.
|
||||
|
||||
Examples:
|
||||
praisonai run agents.yaml
|
||||
praisonai run "What is the weather?"
|
||||
praisonai run agents.yaml --interactive
|
||||
"""
|
||||
output = get_output_controller()
|
||||
context = get_current_context()
|
||||
|
||||
if not target:
|
||||
output.print_panel(
|
||||
"Run agents from a file or prompt.\n\n"
|
||||
"Usage:\n"
|
||||
" praisonai run agents.yaml\n"
|
||||
" praisonai run \"What is the weather?\"\n"
|
||||
" praisonai run agents.yaml --interactive\n\n"
|
||||
"Options:\n"
|
||||
" --model, -m LLM model to use\n"
|
||||
" --framework, -f Framework (praisonai, crewai, autogen)\n"
|
||||
" --interactive, -i Interactive mode\n"
|
||||
" --verbose, -v Verbose output\n"
|
||||
" --trace Enable tracing\n"
|
||||
" --memory Enable memory",
|
||||
title="Run Command"
|
||||
)
|
||||
return
|
||||
|
||||
# Emit start event
|
||||
output.emit_start(
|
||||
message=f"Starting run: {target[:50]}..." if len(target) > 50 else f"Starting run: {target}",
|
||||
data={
|
||||
"target": target,
|
||||
"model": model,
|
||||
"framework": framework,
|
||||
}
|
||||
)
|
||||
|
||||
# Check if target is a file or prompt
|
||||
import os
|
||||
is_file = os.path.exists(target) and (target.endswith('.yaml') or target.endswith('.yml'))
|
||||
|
||||
if is_file:
|
||||
# Run from file
|
||||
_run_from_file(
|
||||
target,
|
||||
model=model,
|
||||
framework=framework,
|
||||
interactive=interactive,
|
||||
verbose=verbose,
|
||||
stream=stream,
|
||||
trace=trace,
|
||||
memory=memory,
|
||||
tools=tools,
|
||||
max_tokens=max_tokens,
|
||||
)
|
||||
else:
|
||||
# Run as prompt
|
||||
_run_prompt(
|
||||
target,
|
||||
model=model,
|
||||
verbose=verbose,
|
||||
stream=stream,
|
||||
trace=trace,
|
||||
memory=memory,
|
||||
tools=tools,
|
||||
max_tokens=max_tokens,
|
||||
)
|
||||
|
||||
|
||||
def _run_from_file(
|
||||
file_path: str,
|
||||
model: Optional[str] = None,
|
||||
framework: Optional[str] = None,
|
||||
interactive: bool = False,
|
||||
verbose: bool = False,
|
||||
stream: bool = True,
|
||||
trace: bool = False,
|
||||
memory: bool = False,
|
||||
tools: Optional[str] = None,
|
||||
max_tokens: int = 16000,
|
||||
):
|
||||
"""Run agents from a YAML file."""
|
||||
output = get_output_controller()
|
||||
|
||||
try:
|
||||
# Use existing PraisonAI class
|
||||
from praisonai.cli.main import PraisonAI
|
||||
|
||||
praison = PraisonAI(
|
||||
agent_file=file_path,
|
||||
framework=framework or "praisonai",
|
||||
)
|
||||
|
||||
# Set model if provided
|
||||
if model:
|
||||
praison.config_list[0]['model'] = model
|
||||
|
||||
# Run
|
||||
result = praison.run()
|
||||
|
||||
output.emit_result(
|
||||
message="Run completed",
|
||||
data={"result": str(result) if result else None}
|
||||
)
|
||||
|
||||
if result:
|
||||
if not output.is_json_mode:
|
||||
output.print_success("Run completed")
|
||||
|
||||
except Exception as e:
|
||||
output.emit_error(message=str(e))
|
||||
output.print_error(str(e))
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
def _run_prompt(
|
||||
prompt: str,
|
||||
model: Optional[str] = None,
|
||||
verbose: bool = False,
|
||||
stream: bool = True,
|
||||
trace: bool = False,
|
||||
memory: bool = False,
|
||||
tools: Optional[str] = None,
|
||||
max_tokens: int = 16000,
|
||||
):
|
||||
"""Run a direct prompt."""
|
||||
output = get_output_controller()
|
||||
|
||||
try:
|
||||
# Use existing handle_direct_prompt
|
||||
from praisonai.cli.main import PraisonAI
|
||||
|
||||
praison = PraisonAI()
|
||||
|
||||
if model:
|
||||
praison.config_list[0]['model'] = model
|
||||
|
||||
# Create args-like object for handle_direct_prompt
|
||||
class Args:
|
||||
pass
|
||||
|
||||
args = Args()
|
||||
args.llm = model
|
||||
args.verbose = verbose
|
||||
args.memory = memory
|
||||
args.tools = tools
|
||||
args.max_tokens = max_tokens
|
||||
args.web_search = False
|
||||
args.web_fetch = False
|
||||
args.prompt_caching = False
|
||||
args.planning = False
|
||||
args.planning_tools = None
|
||||
args.planning_reasoning = False
|
||||
args.auto_approve_plan = False
|
||||
args.final_agent = None
|
||||
args.user_id = None
|
||||
args.auto_save = None
|
||||
args.history = None
|
||||
args.include_rules = None
|
||||
args.workflow = None
|
||||
args.workflow_var = None
|
||||
args.claude_memory = False
|
||||
args.guardrail = None
|
||||
args.metrics = False
|
||||
args.image = None
|
||||
args.image_generate = False
|
||||
args.telemetry = False
|
||||
args.mcp = None
|
||||
args.mcp_env = None
|
||||
args.fast_context = None
|
||||
args.handoff = None
|
||||
args.auto_memory = False
|
||||
args.todo = False
|
||||
args.router = False
|
||||
args.router_provider = None
|
||||
args.query_rewrite = False
|
||||
args.rewrite_tools = None
|
||||
args.expand_prompt = False
|
||||
args.expand_tools = None
|
||||
args.no_tools = False
|
||||
|
||||
praison.args = args
|
||||
result = praison.handle_direct_prompt(prompt)
|
||||
|
||||
output.emit_result(
|
||||
message="Prompt completed",
|
||||
data={"result": str(result) if result else None}
|
||||
)
|
||||
|
||||
if result and not output.is_json_mode:
|
||||
print(result)
|
||||
|
||||
except Exception as e:
|
||||
output.emit_error(message=str(e))
|
||||
output.print_error(str(e))
|
||||
raise typer.Exit(1)
|
||||
@@ -0,0 +1,150 @@
|
||||
"""
|
||||
Schedule command group for PraisonAI CLI.
|
||||
|
||||
Provides scheduler management.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Scheduler management")
|
||||
|
||||
|
||||
def _run_schedule(args: list) -> int:
|
||||
"""Run schedule command with args."""
|
||||
try:
|
||||
from ..features.agent_scheduler import AgentSchedulerHandler
|
||||
|
||||
# Parse subcommand
|
||||
if args and args[0] in ['start', 'list', 'stop', 'logs', 'restart', 'delete', 'describe', 'save', 'stop-all', 'stats']:
|
||||
subcommand = args[0]
|
||||
remaining = args[1:] if len(args) > 1 else []
|
||||
|
||||
# Create minimal args namespace
|
||||
class Args:
|
||||
pass
|
||||
|
||||
fake_args = Args()
|
||||
return AgentSchedulerHandler.handle_daemon_command(subcommand, fake_args, remaining)
|
||||
|
||||
return 0
|
||||
except ImportError as e:
|
||||
output = get_output_controller()
|
||||
output.print_error(f"Scheduler module not available: {e}")
|
||||
return 4
|
||||
|
||||
|
||||
@app.command("start")
|
||||
def schedule_start(
|
||||
agents_file: str = typer.Argument("agents.yaml", help="Agents YAML file"),
|
||||
interval: Optional[str] = typer.Option(None, "--interval", "-i", help="Schedule interval (e.g., 'hourly', '*/30m')"),
|
||||
daemon: bool = typer.Option(True, "--daemon/--no-daemon", help="Run as daemon"),
|
||||
name: Optional[str] = typer.Option(None, "--name", "-n", help="Job name"),
|
||||
):
|
||||
"""Start scheduled agent execution."""
|
||||
args = ["start", agents_file]
|
||||
if interval:
|
||||
args.extend(["--interval", interval])
|
||||
if not daemon:
|
||||
args.append("--no-daemon")
|
||||
if name:
|
||||
args.extend(["--name", name])
|
||||
|
||||
raise typer.Exit(_run_schedule(args))
|
||||
|
||||
|
||||
@app.command("stop")
|
||||
def schedule_stop(
|
||||
job_id: Optional[str] = typer.Argument(None, help="Job ID to stop (or 'all')"),
|
||||
):
|
||||
"""Stop scheduled job(s)."""
|
||||
if job_id == "all":
|
||||
raise typer.Exit(_run_schedule(["stop-all"]))
|
||||
elif job_id:
|
||||
raise typer.Exit(_run_schedule(["stop", job_id]))
|
||||
else:
|
||||
raise typer.Exit(_run_schedule(["stop"]))
|
||||
|
||||
|
||||
@app.command("list")
|
||||
def schedule_list(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""List scheduled jobs."""
|
||||
args = ["list"]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_schedule(args))
|
||||
|
||||
|
||||
@app.command("logs")
|
||||
def schedule_logs(
|
||||
job_id: Optional[str] = typer.Argument(None, help="Job ID"),
|
||||
tail: int = typer.Option(50, "--tail", "-n", help="Number of lines"),
|
||||
follow: bool = typer.Option(False, "--follow", "-f", help="Follow log output"),
|
||||
):
|
||||
"""View scheduler logs."""
|
||||
args = ["logs"]
|
||||
if job_id:
|
||||
args.append(job_id)
|
||||
args.extend(["--tail", str(tail)])
|
||||
if follow:
|
||||
args.append("--follow")
|
||||
raise typer.Exit(_run_schedule(args))
|
||||
|
||||
|
||||
@app.command("restart")
|
||||
def schedule_restart(
|
||||
job_id: str = typer.Argument(..., help="Job ID to restart"),
|
||||
):
|
||||
"""Restart a scheduled job."""
|
||||
raise typer.Exit(_run_schedule(["restart", job_id]))
|
||||
|
||||
|
||||
@app.command("delete")
|
||||
def schedule_delete(
|
||||
job_id: str = typer.Argument(..., help="Job ID to delete"),
|
||||
confirm: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
|
||||
):
|
||||
"""Delete a scheduled job."""
|
||||
if not confirm:
|
||||
confirmed = typer.confirm(f"Delete job {job_id}?")
|
||||
if not confirmed:
|
||||
output = get_output_controller()
|
||||
output.print_info("Cancelled")
|
||||
raise typer.Exit(0)
|
||||
|
||||
raise typer.Exit(_run_schedule(["delete", job_id]))
|
||||
|
||||
|
||||
@app.command("describe")
|
||||
def schedule_describe(
|
||||
job_id: str = typer.Argument(..., help="Job ID"),
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Show job details."""
|
||||
args = ["describe", job_id]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_schedule(args))
|
||||
|
||||
|
||||
@app.command("stats")
|
||||
def schedule_stats(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Show scheduler statistics."""
|
||||
args = ["stats"]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
raise typer.Exit(_run_schedule(args))
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def schedule_callback(ctx: typer.Context):
|
||||
"""Show schedule help or list jobs."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
schedule_list(json_output=False)
|
||||
@@ -0,0 +1,97 @@
|
||||
"""
|
||||
Serve command group for PraisonAI CLI.
|
||||
|
||||
Provides API server management.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="API server management")
|
||||
|
||||
|
||||
@app.command("start")
|
||||
def serve_start(
|
||||
host: str = typer.Option("0.0.0.0", "--host", "-h", help="Host to bind to"),
|
||||
port: int = typer.Option(8000, "--port", "-p", help="Port to bind to"),
|
||||
agents_file: Optional[str] = typer.Option(None, "--agents", "-a", help="Agents YAML file"),
|
||||
reload: bool = typer.Option(False, "--reload", help="Enable auto-reload"),
|
||||
workers: int = typer.Option(1, "--workers", "-w", help="Number of workers"),
|
||||
):
|
||||
"""Start API server."""
|
||||
output = get_output_controller()
|
||||
|
||||
# Build args for existing handler
|
||||
args = [
|
||||
"start",
|
||||
"--host", host,
|
||||
"--port", str(port),
|
||||
"--workers", str(workers),
|
||||
]
|
||||
|
||||
if agents_file:
|
||||
args.extend(["--agents", agents_file])
|
||||
if reload:
|
||||
args.append("--reload")
|
||||
|
||||
try:
|
||||
from ..features.serve import handle_serve_command
|
||||
exit_code = handle_serve_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output.print_error(f"Serve module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("stop")
|
||||
def serve_stop():
|
||||
"""Stop API server."""
|
||||
output = get_output_controller()
|
||||
|
||||
try:
|
||||
from ..features.serve import handle_serve_command
|
||||
exit_code = handle_serve_command(["stop"])
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output.print_error(f"Serve module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.command("status")
|
||||
def serve_status(
|
||||
json_output: bool = typer.Option(False, "--json", help="Output JSON"),
|
||||
):
|
||||
"""Show server status."""
|
||||
output = get_output_controller()
|
||||
|
||||
args = ["status"]
|
||||
if json_output:
|
||||
args.append("--json")
|
||||
|
||||
try:
|
||||
from ..features.serve import handle_serve_command
|
||||
exit_code = handle_serve_command(args)
|
||||
raise typer.Exit(exit_code)
|
||||
except ImportError as e:
|
||||
output.print_error(f"Serve module not available: {e}")
|
||||
raise typer.Exit(4)
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def serve_callback(ctx: typer.Context):
|
||||
"""Show serve help or start server."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
output = get_output_controller()
|
||||
output.print_panel(
|
||||
"API server management.\n\n"
|
||||
"Commands:\n"
|
||||
" start Start API server\n"
|
||||
" stop Stop API server\n"
|
||||
" status Show server status\n\n"
|
||||
"Quick start:\n"
|
||||
" praisonai serve start --agents agents.yaml",
|
||||
title="Serve Commands"
|
||||
)
|
||||
@@ -0,0 +1,212 @@
|
||||
"""
|
||||
Session command group for PraisonAI CLI.
|
||||
|
||||
Provides session management:
|
||||
- session list: List all sessions
|
||||
- session resume: Resume a session
|
||||
- session delete: Delete a session
|
||||
- session export: Export a session
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
from ..state.sessions import get_session_manager
|
||||
|
||||
app = typer.Typer(help="Session management")
|
||||
|
||||
|
||||
@app.command("list")
|
||||
def session_list(
|
||||
limit: int = typer.Option(
|
||||
20,
|
||||
"--limit",
|
||||
"-n",
|
||||
help="Maximum number of sessions to show",
|
||||
),
|
||||
):
|
||||
"""List all sessions."""
|
||||
output = get_output_controller()
|
||||
manager = get_session_manager()
|
||||
|
||||
sessions = manager.list(limit=limit)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"sessions": [s.to_dict() for s in sessions]
|
||||
})
|
||||
return
|
||||
|
||||
if not sessions:
|
||||
output.print_info("No sessions found")
|
||||
return
|
||||
|
||||
headers = ["ID", "Name", "Status", "Events", "Updated"]
|
||||
rows = []
|
||||
for s in sessions:
|
||||
rows.append([
|
||||
s.session_id[:20] + "..." if len(s.session_id) > 20 else s.session_id,
|
||||
s.name or "-",
|
||||
s.status,
|
||||
str(s.event_count),
|
||||
s.updated_at.strftime("%Y-%m-%d %H:%M"),
|
||||
])
|
||||
|
||||
output.print_table(headers, rows, title="Sessions")
|
||||
|
||||
|
||||
@app.command("resume")
|
||||
def session_resume(
|
||||
session_id: str = typer.Argument(..., help="Session ID to resume"),
|
||||
):
|
||||
"""Resume a session."""
|
||||
output = get_output_controller()
|
||||
manager = get_session_manager()
|
||||
|
||||
session = manager.get(session_id)
|
||||
|
||||
if not session:
|
||||
output.print_error(
|
||||
f"Session not found: {session_id}",
|
||||
remediation="Use 'praisonai session list' to see available sessions"
|
||||
)
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Load session events
|
||||
events = manager.get_events(session_id)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"session": session.to_dict(),
|
||||
"events": events,
|
||||
"message": "Session loaded. True resume not supported - showing transcript.",
|
||||
})
|
||||
return
|
||||
|
||||
output.print_panel(
|
||||
f"Session: {session.name or session.session_id}\n"
|
||||
f"Run ID: {session.run_id}\n"
|
||||
f"Trace ID: {session.trace_id}\n"
|
||||
f"Events: {session.event_count}\n"
|
||||
f"Status: {session.status}",
|
||||
title="Session Loaded"
|
||||
)
|
||||
|
||||
output.print_warning(
|
||||
"True session resume is not yet supported. "
|
||||
"Showing session transcript instead."
|
||||
)
|
||||
|
||||
# Show recent events
|
||||
if events:
|
||||
output.print("\n--- Recent Events ---\n")
|
||||
for event in events[-10:]:
|
||||
event_type = event.get("event", "unknown")
|
||||
message = event.get("message", "")
|
||||
output.print(f"[{event_type}] {message}")
|
||||
|
||||
|
||||
@app.command("delete")
|
||||
def session_delete(
|
||||
session_id: str = typer.Argument(..., help="Session ID to delete"),
|
||||
confirm: bool = typer.Option(
|
||||
False,
|
||||
"--yes",
|
||||
"-y",
|
||||
help="Skip confirmation",
|
||||
),
|
||||
):
|
||||
"""Delete a session."""
|
||||
output = get_output_controller()
|
||||
manager = get_session_manager()
|
||||
|
||||
session = manager.get(session_id)
|
||||
|
||||
if not session:
|
||||
output.print_error(f"Session not found: {session_id}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if not confirm:
|
||||
confirmed = typer.confirm(f"Delete session {session_id}?")
|
||||
if not confirmed:
|
||||
output.print_info("Cancelled")
|
||||
raise typer.Exit(0)
|
||||
|
||||
deleted = manager.delete(session_id)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"deleted": deleted, "session_id": session_id})
|
||||
else:
|
||||
if deleted:
|
||||
output.print_success(f"Deleted session: {session_id}")
|
||||
else:
|
||||
output.print_error(f"Failed to delete session: {session_id}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@app.command("export")
|
||||
def session_export(
|
||||
session_id: str = typer.Argument(..., help="Session ID to export"),
|
||||
format: str = typer.Option(
|
||||
"md",
|
||||
"--format",
|
||||
"-f",
|
||||
help="Export format: md or json",
|
||||
),
|
||||
output_file: Optional[str] = typer.Option(
|
||||
None,
|
||||
"--output",
|
||||
"-o",
|
||||
help="Output file path",
|
||||
),
|
||||
):
|
||||
"""Export a session."""
|
||||
output = get_output_controller()
|
||||
manager = get_session_manager()
|
||||
|
||||
content = manager.export(session_id, format=format)
|
||||
|
||||
if content is None:
|
||||
output.print_error(f"Session not found: {session_id}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if output_file:
|
||||
with open(output_file, "w", encoding="utf-8") as f:
|
||||
f.write(content)
|
||||
output.print_success(f"Exported to: {output_file}")
|
||||
else:
|
||||
print(content)
|
||||
|
||||
|
||||
@app.command("show")
|
||||
def session_show(
|
||||
session_id: str = typer.Argument(..., help="Session ID to show"),
|
||||
):
|
||||
"""Show session details."""
|
||||
output = get_output_controller()
|
||||
manager = get_session_manager()
|
||||
|
||||
session = manager.get(session_id)
|
||||
|
||||
if not session:
|
||||
output.print_error(f"Session not found: {session_id}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json(session.to_dict())
|
||||
return
|
||||
|
||||
output.print_panel(
|
||||
f"Session ID: {session.session_id}\n"
|
||||
f"Name: {session.name or '-'}\n"
|
||||
f"Run ID: {session.run_id}\n"
|
||||
f"Trace ID: {session.trace_id}\n"
|
||||
f"Created: {session.created_at.isoformat()}\n"
|
||||
f"Updated: {session.updated_at.isoformat()}\n"
|
||||
f"Status: {session.status}\n"
|
||||
f"Events: {session.event_count}\n"
|
||||
f"Workspace: {session.workspace or '-'}",
|
||||
title="Session Details"
|
||||
)
|
||||
@@ -0,0 +1,145 @@
|
||||
"""
|
||||
Traces command group for PraisonAI CLI.
|
||||
|
||||
Provides trace collection management:
|
||||
- traces enable: Enable trace collection
|
||||
- traces disable: Disable trace collection
|
||||
- traces status: Show current status
|
||||
- traces list: List recent traces
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
import typer
|
||||
|
||||
from ..configuration.loader import get_config_loader
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Trace collection management")
|
||||
|
||||
|
||||
@app.command("enable")
|
||||
def traces_enable(
|
||||
endpoint: Optional[str] = typer.Option(
|
||||
None,
|
||||
"--endpoint",
|
||||
"-e",
|
||||
help="Trace endpoint URL",
|
||||
),
|
||||
sample_rate: float = typer.Option(
|
||||
1.0,
|
||||
"--sample-rate",
|
||||
"-r",
|
||||
help="Sample rate (0.0 to 1.0)",
|
||||
),
|
||||
):
|
||||
"""Enable trace collection."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
loader.set("traces.enabled", True)
|
||||
if endpoint:
|
||||
loader.set("traces.endpoint", endpoint)
|
||||
if sample_rate != 1.0:
|
||||
loader.set("traces.sample_rate", sample_rate)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"traces_enabled": True,
|
||||
"endpoint": endpoint,
|
||||
"sample_rate": sample_rate,
|
||||
})
|
||||
else:
|
||||
output.print_success("Trace collection enabled")
|
||||
if endpoint:
|
||||
output.print(f" Endpoint: {endpoint}")
|
||||
output.print(f" Sample rate: {sample_rate}")
|
||||
|
||||
|
||||
@app.command("disable")
|
||||
def traces_disable():
|
||||
"""Disable trace collection."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
loader.set("traces.enabled", False)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"traces_enabled": False})
|
||||
else:
|
||||
output.print_success("Trace collection disabled")
|
||||
|
||||
|
||||
@app.command("status")
|
||||
def traces_status():
|
||||
"""Show trace collection status."""
|
||||
output = get_output_controller()
|
||||
loader = get_config_loader()
|
||||
|
||||
enabled = loader.get("traces.enabled", False)
|
||||
endpoint = loader.get("traces.endpoint")
|
||||
sample_rate = loader.get("traces.sample_rate", 1.0)
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"enabled": enabled,
|
||||
"endpoint": endpoint,
|
||||
"sample_rate": sample_rate,
|
||||
})
|
||||
else:
|
||||
status = "✅ Enabled" if enabled else "❌ Disabled"
|
||||
output.print_panel(
|
||||
f"Status: {status}\n"
|
||||
f"Endpoint: {endpoint or 'Not configured'}\n"
|
||||
f"Sample Rate: {sample_rate}",
|
||||
title="Trace Collection Status"
|
||||
)
|
||||
|
||||
|
||||
@app.command("list")
|
||||
def traces_list(
|
||||
limit: int = typer.Option(
|
||||
20,
|
||||
"--limit",
|
||||
"-n",
|
||||
help="Maximum number of traces to show",
|
||||
),
|
||||
):
|
||||
"""List recent traces."""
|
||||
output = get_output_controller()
|
||||
|
||||
from ..configuration.paths import get_traces_dir
|
||||
|
||||
traces_dir = get_traces_dir()
|
||||
|
||||
if not traces_dir.exists():
|
||||
if output.is_json_mode:
|
||||
output.print_json({"traces": []})
|
||||
else:
|
||||
output.print_info("No traces found")
|
||||
return
|
||||
|
||||
traces = []
|
||||
for trace_file in sorted(traces_dir.iterdir(), reverse=True)[:limit]:
|
||||
if trace_file.is_file() and trace_file.suffix == ".json":
|
||||
traces.append({
|
||||
"name": trace_file.stem,
|
||||
"size": trace_file.stat().st_size,
|
||||
"modified": trace_file.stat().st_mtime,
|
||||
})
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({"traces": traces})
|
||||
else:
|
||||
if not traces:
|
||||
output.print_info("No traces found")
|
||||
return
|
||||
|
||||
headers = ["Name", "Size", "Modified"]
|
||||
rows = []
|
||||
for t in traces:
|
||||
from datetime import datetime
|
||||
modified = datetime.fromtimestamp(t["modified"]).strftime("%Y-%m-%d %H:%M")
|
||||
rows.append([t["name"], f"{t['size']} bytes", modified])
|
||||
|
||||
output.print_table(headers, rows, title="Recent Traces")
|
||||
@@ -0,0 +1,101 @@
|
||||
"""
|
||||
Version command group for PraisonAI CLI.
|
||||
|
||||
Provides version information:
|
||||
- version show: Show version
|
||||
- version check: Check for updates
|
||||
"""
|
||||
|
||||
import typer
|
||||
|
||||
from ..output.console import get_output_controller
|
||||
|
||||
app = typer.Typer(help="Version information")
|
||||
|
||||
|
||||
@app.command("show")
|
||||
def version_show():
|
||||
"""Show version information."""
|
||||
output = get_output_controller()
|
||||
|
||||
from praisonai.version import __version__
|
||||
|
||||
# Try to get additional version info
|
||||
versions = {
|
||||
"praisonai": __version__,
|
||||
}
|
||||
|
||||
# Check praisonaiagents version
|
||||
try:
|
||||
import praisonaiagents
|
||||
versions["praisonaiagents"] = getattr(praisonaiagents, "__version__", "unknown")
|
||||
except ImportError:
|
||||
versions["praisonaiagents"] = "not installed"
|
||||
|
||||
# Check Python version
|
||||
import sys
|
||||
versions["python"] = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json(versions)
|
||||
return
|
||||
|
||||
output.print_panel(
|
||||
f"PraisonAI: {versions['praisonai']}\n"
|
||||
f"PraisonAI Agents: {versions['praisonaiagents']}\n"
|
||||
f"Python: {versions['python']}",
|
||||
title="Version Information"
|
||||
)
|
||||
|
||||
|
||||
@app.command("check")
|
||||
def version_check():
|
||||
"""Check for updates."""
|
||||
output = get_output_controller()
|
||||
|
||||
from praisonai.version import __version__
|
||||
|
||||
output.print_info("Checking for updates...")
|
||||
|
||||
try:
|
||||
import urllib.request
|
||||
import json
|
||||
|
||||
url = "https://pypi.org/pypi/praisonai/json"
|
||||
with urllib.request.urlopen(url, timeout=5) as response:
|
||||
data = json.loads(response.read().decode())
|
||||
latest = data["info"]["version"]
|
||||
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"current": __version__,
|
||||
"latest": latest,
|
||||
"update_available": latest != __version__,
|
||||
})
|
||||
return
|
||||
|
||||
if latest != __version__:
|
||||
output.print_warning(
|
||||
f"Update available: {__version__} → {latest}\n"
|
||||
f"Run: pip install --upgrade praisonai"
|
||||
)
|
||||
else:
|
||||
output.print_success(f"You are using the latest version ({__version__})")
|
||||
|
||||
except Exception as e:
|
||||
if output.is_json_mode:
|
||||
output.print_json({
|
||||
"current": __version__,
|
||||
"latest": None,
|
||||
"error": str(e),
|
||||
})
|
||||
else:
|
||||
output.print_error(f"Failed to check for updates: {e}")
|
||||
output.print(f"Current version: {__version__}")
|
||||
|
||||
|
||||
@app.callback(invoke_without_command=True)
|
||||
def version_callback(ctx: typer.Context):
|
||||
"""Show version (default behavior)."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
version_show()
|
||||
@@ -0,0 +1,18 @@
|
||||
"""
|
||||
PraisonAI CLI Configuration Module.
|
||||
|
||||
Provides configuration management with TOML support and precedence handling.
|
||||
"""
|
||||
|
||||
from .loader import ConfigLoader, get_config
|
||||
from .schema import ConfigSchema
|
||||
from .paths import get_config_paths, get_user_config_path, get_project_config_path
|
||||
|
||||
__all__ = [
|
||||
'ConfigLoader',
|
||||
'ConfigSchema',
|
||||
'get_config',
|
||||
'get_config_paths',
|
||||
'get_user_config_path',
|
||||
'get_project_config_path',
|
||||
]
|
||||
@@ -0,0 +1,353 @@
|
||||
"""
|
||||
Configuration loader for PraisonAI CLI.
|
||||
|
||||
Handles loading, merging, and saving configuration with precedence.
|
||||
"""
|
||||
|
||||
import os
|
||||
import threading
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
from .paths import (
|
||||
get_config_paths,
|
||||
get_user_config_path,
|
||||
get_project_config_path,
|
||||
get_env_prefix,
|
||||
ensure_config_dirs,
|
||||
)
|
||||
from .schema import ConfigSchema, DEFAULT_CONFIG
|
||||
|
||||
|
||||
# Thread-safe config cache
|
||||
_config_lock = threading.Lock()
|
||||
_config_cache: Optional[ConfigSchema] = None
|
||||
|
||||
|
||||
def _load_toml(path: Path) -> Dict[str, Any]:
|
||||
"""Load a TOML file."""
|
||||
try:
|
||||
# Try tomllib (Python 3.11+) first
|
||||
import tomllib
|
||||
with open(path, "rb") as f:
|
||||
return tomllib.load(f)
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
try:
|
||||
# Fall back to tomli
|
||||
import tomli
|
||||
with open(path, "rb") as f:
|
||||
return tomli.load(f)
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
# Last resort: basic TOML parsing
|
||||
return _basic_toml_parse(path)
|
||||
|
||||
|
||||
def _basic_toml_parse(path: Path) -> Dict[str, Any]:
|
||||
"""Basic TOML parser for simple configs."""
|
||||
result: Dict[str, Any] = {}
|
||||
current_section: Optional[str] = None
|
||||
|
||||
with open(path, "r", encoding="utf-8") as f:
|
||||
for line in f:
|
||||
line = line.strip()
|
||||
if not line or line.startswith("#"):
|
||||
continue
|
||||
|
||||
if line.startswith("[") and line.endswith("]"):
|
||||
current_section = line[1:-1]
|
||||
if current_section not in result:
|
||||
result[current_section] = {}
|
||||
elif "=" in line:
|
||||
key, value = line.split("=", 1)
|
||||
key = key.strip()
|
||||
value = value.strip()
|
||||
|
||||
# Parse value
|
||||
if value.lower() == "true":
|
||||
parsed_value = True
|
||||
elif value.lower() == "false":
|
||||
parsed_value = False
|
||||
elif value.startswith('"') and value.endswith('"'):
|
||||
parsed_value = value[1:-1]
|
||||
elif value.startswith("'") and value.endswith("'"):
|
||||
parsed_value = value[1:-1]
|
||||
else:
|
||||
try:
|
||||
parsed_value = int(value)
|
||||
except ValueError:
|
||||
try:
|
||||
parsed_value = float(value)
|
||||
except ValueError:
|
||||
parsed_value = value
|
||||
|
||||
if current_section:
|
||||
result[current_section][key] = parsed_value
|
||||
else:
|
||||
result[key] = parsed_value
|
||||
|
||||
return result
|
||||
|
||||
|
||||
def _save_toml(path: Path, data: Dict[str, Any]) -> None:
|
||||
"""Save data to a TOML file."""
|
||||
try:
|
||||
import tomli_w
|
||||
with open(path, "wb") as f:
|
||||
tomli_w.dump(data, f)
|
||||
return
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
# Fall back to basic TOML writing
|
||||
_basic_toml_write(path, data)
|
||||
|
||||
|
||||
def _basic_toml_write(path: Path, data: Dict[str, Any]) -> None:
|
||||
"""Basic TOML writer."""
|
||||
lines = []
|
||||
|
||||
# Write top-level keys first
|
||||
for key, value in data.items():
|
||||
if not isinstance(value, dict):
|
||||
lines.append(f"{key} = {_format_toml_value(value)}")
|
||||
|
||||
# Write sections
|
||||
for key, value in data.items():
|
||||
if isinstance(value, dict):
|
||||
lines.append(f"\n[{key}]")
|
||||
for sub_key, sub_value in value.items():
|
||||
if not isinstance(sub_value, dict):
|
||||
lines.append(f"{sub_key} = {_format_toml_value(sub_value)}")
|
||||
else:
|
||||
# Nested section
|
||||
lines.append(f"\n[{key}.{sub_key}]")
|
||||
for nested_key, nested_value in sub_value.items():
|
||||
lines.append(f"{nested_key} = {_format_toml_value(nested_value)}")
|
||||
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
with open(path, "w", encoding="utf-8") as f:
|
||||
f.write("\n".join(lines) + "\n")
|
||||
|
||||
|
||||
def _format_toml_value(value: Any) -> str:
|
||||
"""Format a value for TOML."""
|
||||
if isinstance(value, bool):
|
||||
return "true" if value else "false"
|
||||
elif isinstance(value, str):
|
||||
return f'"{value}"'
|
||||
elif isinstance(value, (int, float)):
|
||||
return str(value)
|
||||
elif isinstance(value, list):
|
||||
items = ", ".join(_format_toml_value(v) for v in value)
|
||||
return f"[{items}]"
|
||||
else:
|
||||
return f'"{value}"'
|
||||
|
||||
|
||||
def _merge_dicts(base: Dict[str, Any], override: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Deep merge two dictionaries."""
|
||||
result = base.copy()
|
||||
for key, value in override.items():
|
||||
if key in result and isinstance(result[key], dict) and isinstance(value, dict):
|
||||
result[key] = _merge_dicts(result[key], value)
|
||||
else:
|
||||
result[key] = value
|
||||
return result
|
||||
|
||||
|
||||
def _get_env_overrides() -> Dict[str, Any]:
|
||||
"""Get configuration overrides from environment variables."""
|
||||
prefix = get_env_prefix()
|
||||
overrides: Dict[str, Any] = {}
|
||||
|
||||
for key, value in os.environ.items():
|
||||
if not key.startswith(prefix):
|
||||
continue
|
||||
|
||||
# Convert PRAISONAI_OUTPUT_FORMAT to output.format
|
||||
config_key = key[len(prefix):].lower()
|
||||
parts = config_key.split("_")
|
||||
|
||||
# Parse value
|
||||
if value.lower() == "true":
|
||||
parsed_value = True
|
||||
elif value.lower() == "false":
|
||||
parsed_value = False
|
||||
else:
|
||||
try:
|
||||
parsed_value = int(value)
|
||||
except ValueError:
|
||||
try:
|
||||
parsed_value = float(value)
|
||||
except ValueError:
|
||||
parsed_value = value
|
||||
|
||||
# Build nested dict
|
||||
if len(parts) >= 2:
|
||||
section = parts[0]
|
||||
sub_key = "_".join(parts[1:])
|
||||
if section not in overrides:
|
||||
overrides[section] = {}
|
||||
overrides[section][sub_key] = parsed_value
|
||||
else:
|
||||
overrides[config_key] = parsed_value
|
||||
|
||||
return overrides
|
||||
|
||||
|
||||
def _get_dotted_value(data: Dict[str, Any], key: str) -> Any:
|
||||
"""Get a value using dotted key notation."""
|
||||
parts = key.split(".")
|
||||
current = data
|
||||
for part in parts:
|
||||
if isinstance(current, dict) and part in current:
|
||||
current = current[part]
|
||||
else:
|
||||
return None
|
||||
return current
|
||||
|
||||
|
||||
def _set_dotted_value(data: Dict[str, Any], key: str, value: Any) -> None:
|
||||
"""Set a value using dotted key notation."""
|
||||
parts = key.split(".")
|
||||
current = data
|
||||
for part in parts[:-1]:
|
||||
if part not in current:
|
||||
current[part] = {}
|
||||
current = current[part]
|
||||
current[parts[-1]] = value
|
||||
|
||||
|
||||
class ConfigLoader:
|
||||
"""
|
||||
Configuration loader with precedence handling.
|
||||
|
||||
Precedence (highest to lowest):
|
||||
1. CLI flags (not handled here)
|
||||
2. Environment variables (PRAISONAI_*)
|
||||
3. Project config (.praison/config.toml)
|
||||
4. User config (~/.praison/config.toml)
|
||||
5. Defaults
|
||||
"""
|
||||
|
||||
def __init__(self, project_root: Optional[Path] = None):
|
||||
self.project_root = project_root or Path.cwd()
|
||||
self._config: Optional[ConfigSchema] = None
|
||||
self._raw_config: Dict[str, Any] = {}
|
||||
|
||||
def load(self, force_reload: bool = False) -> ConfigSchema:
|
||||
"""Load configuration with precedence."""
|
||||
if self._config is not None and not force_reload:
|
||||
return self._config
|
||||
|
||||
# Start with defaults
|
||||
merged = DEFAULT_CONFIG.to_dict()
|
||||
|
||||
# Load config files in reverse precedence order
|
||||
config_paths = get_config_paths(self.project_root)
|
||||
for path in reversed(config_paths):
|
||||
try:
|
||||
file_config = _load_toml(path)
|
||||
merged = _merge_dicts(merged, file_config)
|
||||
except Exception:
|
||||
pass # Skip invalid files
|
||||
|
||||
# Apply environment overrides
|
||||
env_overrides = _get_env_overrides()
|
||||
merged = _merge_dicts(merged, env_overrides)
|
||||
|
||||
self._raw_config = merged
|
||||
self._config = ConfigSchema.from_dict(merged)
|
||||
return self._config
|
||||
|
||||
def get(self, key: str, default: Any = None) -> Any:
|
||||
"""Get a configuration value using dotted key notation."""
|
||||
self.load()
|
||||
value = _get_dotted_value(self._raw_config, key)
|
||||
return value if value is not None else default
|
||||
|
||||
def set(self, key: str, value: Any, scope: str = "user") -> None:
|
||||
"""
|
||||
Set a configuration value.
|
||||
|
||||
Args:
|
||||
key: Dotted key notation (e.g., "output.format")
|
||||
value: Value to set
|
||||
scope: "user" or "project"
|
||||
"""
|
||||
if scope == "project":
|
||||
config_path = get_project_config_path(self.project_root)
|
||||
else:
|
||||
config_path = get_user_config_path()
|
||||
|
||||
# Load existing config or create empty
|
||||
if config_path.exists():
|
||||
try:
|
||||
existing = _load_toml(config_path)
|
||||
except Exception:
|
||||
existing = {}
|
||||
else:
|
||||
existing = {}
|
||||
|
||||
# Set the value
|
||||
_set_dotted_value(existing, key, value)
|
||||
|
||||
# Ensure directory exists
|
||||
ensure_config_dirs()
|
||||
if scope == "project":
|
||||
config_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Save
|
||||
_save_toml(config_path, existing)
|
||||
|
||||
# Reload
|
||||
self.load(force_reload=True)
|
||||
|
||||
def reset(self, scope: str = "user") -> None:
|
||||
"""Reset configuration to defaults."""
|
||||
if scope == "project":
|
||||
config_path = get_project_config_path(self.project_root)
|
||||
else:
|
||||
config_path = get_user_config_path()
|
||||
|
||||
if config_path.exists():
|
||||
config_path.unlink()
|
||||
|
||||
self.load(force_reload=True)
|
||||
|
||||
def list_all(self) -> Dict[str, Any]:
|
||||
"""List all configuration values."""
|
||||
self.load()
|
||||
return self._raw_config.copy()
|
||||
|
||||
|
||||
# Global config loader
|
||||
_global_loader: Optional[ConfigLoader] = None
|
||||
|
||||
|
||||
def get_config(project_root: Optional[Path] = None) -> ConfigSchema:
|
||||
"""Get the global configuration."""
|
||||
global _global_loader, _config_cache
|
||||
|
||||
with _config_lock:
|
||||
if _global_loader is None or project_root is not None:
|
||||
_global_loader = ConfigLoader(project_root)
|
||||
|
||||
if _config_cache is None:
|
||||
_config_cache = _global_loader.load()
|
||||
|
||||
return _config_cache
|
||||
|
||||
|
||||
def get_config_loader(project_root: Optional[Path] = None) -> ConfigLoader:
|
||||
"""Get the global config loader."""
|
||||
global _global_loader
|
||||
|
||||
with _config_lock:
|
||||
if _global_loader is None or project_root is not None:
|
||||
_global_loader = ConfigLoader(project_root)
|
||||
return _global_loader
|
||||
@@ -0,0 +1,114 @@
|
||||
"""
|
||||
Configuration paths for PraisonAI CLI.
|
||||
|
||||
Defines standard locations for configuration files.
|
||||
"""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import List, Optional
|
||||
|
||||
|
||||
def get_user_config_dir() -> Path:
|
||||
"""Get user configuration directory (~/.praison/)."""
|
||||
return Path.home() / ".praison"
|
||||
|
||||
|
||||
def get_user_config_path() -> Path:
|
||||
"""Get user configuration file path (~/.praison/config.toml)."""
|
||||
return get_user_config_dir() / "config.toml"
|
||||
|
||||
|
||||
def get_project_config_dir(project_root: Optional[Path] = None) -> Path:
|
||||
"""Get project configuration directory (.praison/)."""
|
||||
root = project_root or Path.cwd()
|
||||
return root / ".praison"
|
||||
|
||||
|
||||
def get_project_config_path(project_root: Optional[Path] = None) -> Path:
|
||||
"""Get project configuration file path (.praison/config.toml)."""
|
||||
return get_project_config_dir(project_root) / "config.toml"
|
||||
|
||||
|
||||
def get_sessions_dir() -> Path:
|
||||
"""Get sessions directory (~/.praison/sessions/)."""
|
||||
return get_user_config_dir() / "sessions"
|
||||
|
||||
|
||||
def get_traces_dir() -> Path:
|
||||
"""Get traces directory (~/.praison/traces/)."""
|
||||
return get_user_config_dir() / "traces"
|
||||
|
||||
|
||||
def get_logs_dir() -> Path:
|
||||
"""Get logs directory (~/.praison/logs/)."""
|
||||
return get_user_config_dir() / "logs"
|
||||
|
||||
|
||||
def get_cache_dir() -> Path:
|
||||
"""Get cache directory (~/.praison/cache/)."""
|
||||
return get_user_config_dir() / "cache"
|
||||
|
||||
|
||||
def get_config_paths(project_root: Optional[Path] = None) -> List[Path]:
|
||||
"""
|
||||
Get all configuration file paths in precedence order (highest first).
|
||||
|
||||
Precedence:
|
||||
1. Project config: .praison/config.toml
|
||||
2. User config: ~/.praison/config.toml
|
||||
|
||||
Returns:
|
||||
List of paths in precedence order
|
||||
"""
|
||||
paths = []
|
||||
|
||||
# Project config (highest precedence)
|
||||
project_config = get_project_config_path(project_root)
|
||||
if project_config.exists():
|
||||
paths.append(project_config)
|
||||
|
||||
# User config
|
||||
user_config = get_user_config_path()
|
||||
if user_config.exists():
|
||||
paths.append(user_config)
|
||||
|
||||
return paths
|
||||
|
||||
|
||||
def ensure_config_dirs() -> None:
|
||||
"""Ensure all configuration directories exist."""
|
||||
dirs = [
|
||||
get_user_config_dir(),
|
||||
get_sessions_dir(),
|
||||
get_traces_dir(),
|
||||
get_logs_dir(),
|
||||
get_cache_dir(),
|
||||
]
|
||||
for d in dirs:
|
||||
d.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
|
||||
def get_env_prefix() -> str:
|
||||
"""Get environment variable prefix."""
|
||||
return "PRAISONAI_"
|
||||
|
||||
|
||||
def env_to_config_key(env_var: str) -> Optional[str]:
|
||||
"""
|
||||
Convert environment variable name to config key.
|
||||
|
||||
Example: PRAISONAI_OUTPUT_FORMAT -> output.format
|
||||
"""
|
||||
prefix = get_env_prefix()
|
||||
if not env_var.startswith(prefix):
|
||||
return None
|
||||
|
||||
key = env_var[len(prefix):].lower()
|
||||
# Convert underscores to dots for nested keys
|
||||
# Single underscore = dot, double underscore = single underscore
|
||||
parts = key.split("__")
|
||||
result_parts = []
|
||||
for part in parts:
|
||||
result_parts.append(part.replace("_", "."))
|
||||
return "_".join(result_parts)
|
||||
@@ -0,0 +1,164 @@
|
||||
"""
|
||||
Configuration schema for PraisonAI CLI.
|
||||
|
||||
Defines the structure and defaults for configuration.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class OutputConfig:
|
||||
"""Output configuration."""
|
||||
format: str = "text" # text, json, stream-json
|
||||
color: bool = True
|
||||
verbose: bool = False
|
||||
quiet: bool = False
|
||||
screen_reader: bool = False
|
||||
|
||||
|
||||
@dataclass
|
||||
class TracesConfig:
|
||||
"""Traces configuration."""
|
||||
enabled: bool = False
|
||||
endpoint: Optional[str] = None
|
||||
sample_rate: float = 1.0
|
||||
|
||||
|
||||
@dataclass
|
||||
class MCPServerConfig:
|
||||
"""MCP server configuration."""
|
||||
command: str = ""
|
||||
args: List[str] = field(default_factory=list)
|
||||
env: Dict[str, str] = field(default_factory=dict)
|
||||
enabled: bool = True
|
||||
|
||||
|
||||
@dataclass
|
||||
class MCPConfig:
|
||||
"""MCP configuration."""
|
||||
servers: Dict[str, MCPServerConfig] = field(default_factory=dict)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ModelConfig:
|
||||
"""Model configuration."""
|
||||
default: str = "gpt-4o-mini"
|
||||
temperature: float = 0.7
|
||||
max_tokens: int = 16000
|
||||
|
||||
|
||||
@dataclass
|
||||
class SessionConfig:
|
||||
"""Session configuration."""
|
||||
auto_save: bool = False
|
||||
history_limit: int = 10
|
||||
|
||||
|
||||
@dataclass
|
||||
class ConfigSchema:
|
||||
"""
|
||||
Complete configuration schema.
|
||||
|
||||
Represents all configurable options for PraisonAI CLI.
|
||||
"""
|
||||
output: OutputConfig = field(default_factory=OutputConfig)
|
||||
traces: TracesConfig = field(default_factory=TracesConfig)
|
||||
mcp: MCPConfig = field(default_factory=MCPConfig)
|
||||
model: ModelConfig = field(default_factory=ModelConfig)
|
||||
session: SessionConfig = field(default_factory=SessionConfig)
|
||||
|
||||
# Additional settings stored as dict for flexibility
|
||||
extra: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"output": {
|
||||
"format": self.output.format,
|
||||
"color": self.output.color,
|
||||
"verbose": self.output.verbose,
|
||||
"quiet": self.output.quiet,
|
||||
"screen_reader": self.output.screen_reader,
|
||||
},
|
||||
"traces": {
|
||||
"enabled": self.traces.enabled,
|
||||
"endpoint": self.traces.endpoint,
|
||||
"sample_rate": self.traces.sample_rate,
|
||||
},
|
||||
"mcp": {
|
||||
"servers": {
|
||||
name: {
|
||||
"command": server.command,
|
||||
"args": server.args,
|
||||
"env": server.env,
|
||||
"enabled": server.enabled,
|
||||
}
|
||||
for name, server in self.mcp.servers.items()
|
||||
}
|
||||
},
|
||||
"model": {
|
||||
"default": self.model.default,
|
||||
"temperature": self.model.temperature,
|
||||
"max_tokens": self.model.max_tokens,
|
||||
},
|
||||
"session": {
|
||||
"auto_save": self.session.auto_save,
|
||||
"history_limit": self.session.history_limit,
|
||||
},
|
||||
**self.extra,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, data: Dict[str, Any]) -> "ConfigSchema":
|
||||
"""Create from dictionary."""
|
||||
output_data = data.get("output", {})
|
||||
traces_data = data.get("traces", {})
|
||||
mcp_data = data.get("mcp", {})
|
||||
model_data = data.get("model", {})
|
||||
session_data = data.get("session", {})
|
||||
|
||||
# Extract known keys
|
||||
known_keys = {"output", "traces", "mcp", "model", "session"}
|
||||
extra = {k: v for k, v in data.items() if k not in known_keys}
|
||||
|
||||
# Parse MCP servers
|
||||
mcp_servers = {}
|
||||
for name, server_data in mcp_data.get("servers", {}).items():
|
||||
mcp_servers[name] = MCPServerConfig(
|
||||
command=server_data.get("command", ""),
|
||||
args=server_data.get("args", []),
|
||||
env=server_data.get("env", {}),
|
||||
enabled=server_data.get("enabled", True),
|
||||
)
|
||||
|
||||
return cls(
|
||||
output=OutputConfig(
|
||||
format=output_data.get("format", "text"),
|
||||
color=output_data.get("color", True),
|
||||
verbose=output_data.get("verbose", False),
|
||||
quiet=output_data.get("quiet", False),
|
||||
screen_reader=output_data.get("screen_reader", False),
|
||||
),
|
||||
traces=TracesConfig(
|
||||
enabled=traces_data.get("enabled", False),
|
||||
endpoint=traces_data.get("endpoint"),
|
||||
sample_rate=traces_data.get("sample_rate", 1.0),
|
||||
),
|
||||
mcp=MCPConfig(servers=mcp_servers),
|
||||
model=ModelConfig(
|
||||
default=model_data.get("default", "gpt-4o-mini"),
|
||||
temperature=model_data.get("temperature", 0.7),
|
||||
max_tokens=model_data.get("max_tokens", 16000),
|
||||
),
|
||||
session=SessionConfig(
|
||||
auto_save=session_data.get("auto_save", False),
|
||||
history_limit=session_data.get("history_limit", 10),
|
||||
),
|
||||
extra=extra,
|
||||
)
|
||||
|
||||
|
||||
# Default configuration
|
||||
DEFAULT_CONFIG = ConfigSchema()
|
||||
@@ -0,0 +1,99 @@
|
||||
"""
|
||||
PraisonAI Unified Execution Module.
|
||||
|
||||
Provides a single, unified execution primitive for all CLI modes:
|
||||
- CLI direct prompt
|
||||
- Profile command
|
||||
- TUI workers
|
||||
|
||||
Design Principles:
|
||||
1. Profiling observes, never alters execution
|
||||
2. Zero overhead when profiling disabled
|
||||
3. Sync and async are first-class citizens
|
||||
4. Fail-safe, not fail-fast
|
||||
5. Bounded resource usage
|
||||
6. Schema stability with versioning
|
||||
"""
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .request import ExecutionRequest
|
||||
from .result import ExecutionResult
|
||||
from .core import execute_sync, execute_async
|
||||
from .profiler import Profiler, ProfilerConfig, ProfileReport
|
||||
|
||||
# Lazy loading to maintain zero-overhead when not used
|
||||
_lazy_cache = {}
|
||||
|
||||
|
||||
def __getattr__(name: str):
|
||||
"""Lazy load execution components."""
|
||||
global _lazy_cache
|
||||
|
||||
if name in _lazy_cache:
|
||||
return _lazy_cache[name]
|
||||
|
||||
if name == "ExecutionRequest":
|
||||
from .request import ExecutionRequest
|
||||
_lazy_cache[name] = ExecutionRequest
|
||||
return ExecutionRequest
|
||||
elif name == "ExecutionResult":
|
||||
from .result import ExecutionResult
|
||||
_lazy_cache[name] = ExecutionResult
|
||||
return ExecutionResult
|
||||
elif name == "execute_sync":
|
||||
from .core import execute_sync
|
||||
_lazy_cache[name] = execute_sync
|
||||
return execute_sync
|
||||
elif name == "execute_async":
|
||||
from .core import execute_async
|
||||
_lazy_cache[name] = execute_async
|
||||
return execute_async
|
||||
elif name == "Profiler":
|
||||
from .profiler import Profiler
|
||||
_lazy_cache[name] = Profiler
|
||||
return Profiler
|
||||
elif name == "ProfilerConfig":
|
||||
from .profiler import ProfilerConfig
|
||||
_lazy_cache[name] = ProfilerConfig
|
||||
return ProfilerConfig
|
||||
elif name == "ProfileReport":
|
||||
from .profiler import ProfileReport
|
||||
_lazy_cache[name] = ProfileReport
|
||||
return ProfileReport
|
||||
elif name == "TimingBreakdown":
|
||||
from .profiler import TimingBreakdown
|
||||
_lazy_cache[name] = TimingBreakdown
|
||||
return TimingBreakdown
|
||||
elif name == "InvocationInfo":
|
||||
from .profiler import InvocationInfo
|
||||
_lazy_cache[name] = InvocationInfo
|
||||
return InvocationInfo
|
||||
elif name == "DecisionTrace":
|
||||
from .profiler import DecisionTrace
|
||||
_lazy_cache[name] = DecisionTrace
|
||||
return DecisionTrace
|
||||
elif name == "ModuleBreakdown":
|
||||
from .profiler import ModuleBreakdown
|
||||
_lazy_cache[name] = ModuleBreakdown
|
||||
return ModuleBreakdown
|
||||
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
|
||||
|
||||
__all__ = [
|
||||
# Core execution
|
||||
"ExecutionRequest",
|
||||
"ExecutionResult",
|
||||
"execute_sync",
|
||||
"execute_async",
|
||||
# Profiling
|
||||
"Profiler",
|
||||
"ProfilerConfig",
|
||||
"ProfileReport",
|
||||
"TimingBreakdown",
|
||||
"InvocationInfo",
|
||||
"DecisionTrace",
|
||||
"ModuleBreakdown",
|
||||
]
|
||||
@@ -0,0 +1,210 @@
|
||||
"""
|
||||
Core Execution Module.
|
||||
|
||||
Provides the unified execution primitives:
|
||||
- _execute_core(): Single implementation shared by all paths
|
||||
- execute_sync(): Synchronous wrapper for CLI
|
||||
- execute_async(): Asynchronous wrapper for TUI workers
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import time
|
||||
import uuid
|
||||
from typing import Optional, AsyncGenerator
|
||||
|
||||
from .request import ExecutionRequest
|
||||
from .result import ExecutionResult
|
||||
|
||||
|
||||
def _generate_run_id() -> str:
|
||||
"""Generate a unique run ID."""
|
||||
return str(uuid.uuid4())[:8]
|
||||
|
||||
|
||||
def _execute_core(
|
||||
request: ExecutionRequest,
|
||||
timing: Optional[dict] = None,
|
||||
) -> ExecutionResult:
|
||||
"""
|
||||
THE SINGLE EXECUTION IMPLEMENTATION.
|
||||
|
||||
All execution modes call this function.
|
||||
Profiler wraps this function, never injects into it.
|
||||
|
||||
Args:
|
||||
request: The execution request
|
||||
timing: Optional dict to record timing phases (for profiling)
|
||||
|
||||
Returns:
|
||||
ExecutionResult with output and metadata
|
||||
"""
|
||||
run_id = _generate_run_id()
|
||||
start_time = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["core_start"] = start_time
|
||||
|
||||
try:
|
||||
# Phase 1: Import (measured inline)
|
||||
import_start = time.perf_counter()
|
||||
from praisonaiagents import Agent
|
||||
import_end = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["imports_ms"] = (import_end - import_start) * 1000
|
||||
|
||||
# Phase 2: Agent Construction
|
||||
agent_start = time.perf_counter()
|
||||
|
||||
agent_config = {
|
||||
"name": request.agent_name,
|
||||
"verbose": False,
|
||||
}
|
||||
|
||||
if request.agent_instructions:
|
||||
agent_config["instructions"] = request.agent_instructions
|
||||
|
||||
if request.model:
|
||||
agent_config["llm"] = request.model
|
||||
|
||||
if request.tools:
|
||||
agent_config["tools"] = list(request.tools)
|
||||
|
||||
agent = Agent(**agent_config)
|
||||
agent_end = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["agent_init_ms"] = (agent_end - agent_start) * 1000
|
||||
|
||||
# Phase 3: Execution
|
||||
exec_start = time.perf_counter()
|
||||
|
||||
if request.stream:
|
||||
# For streaming, collect all chunks
|
||||
chunks = []
|
||||
if hasattr(agent, '_start_stream'):
|
||||
for chunk in agent._start_stream(request.prompt):
|
||||
chunks.append(chunk)
|
||||
else:
|
||||
# Fallback to non-streaming
|
||||
result = agent.start(request.prompt)
|
||||
chunks = [result] if result else []
|
||||
output = "".join(chunks)
|
||||
else:
|
||||
output = agent.start(request.prompt)
|
||||
|
||||
exec_end = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["execution_ms"] = (exec_end - exec_start) * 1000
|
||||
|
||||
end_time = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["total_ms"] = (end_time - start_time) * 1000
|
||||
|
||||
return ExecutionResult(
|
||||
output=output or "",
|
||||
run_id=run_id,
|
||||
success=True,
|
||||
start_time=start_time,
|
||||
end_time=end_time,
|
||||
metadata={
|
||||
"model": request.model,
|
||||
"stream": request.stream,
|
||||
},
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
end_time = time.perf_counter()
|
||||
|
||||
if timing is not None:
|
||||
timing["total_ms"] = (end_time - start_time) * 1000
|
||||
timing["error"] = str(e)
|
||||
|
||||
return ExecutionResult.from_error(
|
||||
error=str(e),
|
||||
run_id=run_id,
|
||||
)
|
||||
|
||||
|
||||
def execute_sync(request: ExecutionRequest) -> ExecutionResult:
|
||||
"""
|
||||
Synchronous execution wrapper.
|
||||
|
||||
Used by:
|
||||
- CLI direct prompt
|
||||
- Profile command
|
||||
|
||||
Args:
|
||||
request: The execution request
|
||||
|
||||
Returns:
|
||||
ExecutionResult with output and metadata
|
||||
"""
|
||||
return _execute_core(request)
|
||||
|
||||
|
||||
async def execute_async(request: ExecutionRequest) -> ExecutionResult:
|
||||
"""
|
||||
Asynchronous execution wrapper.
|
||||
|
||||
Used by:
|
||||
- TUI workers
|
||||
- Queue system
|
||||
|
||||
Args:
|
||||
request: The execution request
|
||||
|
||||
Returns:
|
||||
ExecutionResult with output and metadata
|
||||
"""
|
||||
# Run the synchronous core in a thread pool to avoid blocking
|
||||
loop = asyncio.get_event_loop()
|
||||
return await loop.run_in_executor(None, _execute_core, request, None)
|
||||
|
||||
|
||||
async def execute_async_stream(
|
||||
request: ExecutionRequest,
|
||||
) -> AsyncGenerator[str, None]:
|
||||
"""
|
||||
Asynchronous streaming execution.
|
||||
|
||||
Yields chunks as they arrive.
|
||||
|
||||
Args:
|
||||
request: The execution request (stream=True recommended)
|
||||
|
||||
Yields:
|
||||
String chunks of the response
|
||||
"""
|
||||
try:
|
||||
from praisonaiagents import Agent
|
||||
|
||||
agent_config = {
|
||||
"name": request.agent_name,
|
||||
"verbose": False,
|
||||
}
|
||||
|
||||
if request.agent_instructions:
|
||||
agent_config["instructions"] = request.agent_instructions
|
||||
|
||||
if request.model:
|
||||
agent_config["llm"] = request.model
|
||||
|
||||
if request.tools:
|
||||
agent_config["tools"] = list(request.tools)
|
||||
|
||||
agent = Agent(**agent_config)
|
||||
|
||||
if hasattr(agent, '_start_stream'):
|
||||
for chunk in agent._start_stream(request.prompt):
|
||||
yield chunk
|
||||
await asyncio.sleep(0) # Yield control
|
||||
else:
|
||||
result = agent.start(request.prompt)
|
||||
if result:
|
||||
yield result
|
||||
|
||||
except Exception as e:
|
||||
yield f"Error: {e}"
|
||||
@@ -0,0 +1,814 @@
|
||||
"""
|
||||
Profiler Module.
|
||||
|
||||
Provides external profiling that wraps execution.
|
||||
Execution code has ZERO awareness of profiling.
|
||||
|
||||
Design Principles:
|
||||
1. Profiler wraps execution, does not inject into it
|
||||
2. Layered profiling with explicit overhead
|
||||
3. Bounded resource usage
|
||||
4. Versioned, stable output schema
|
||||
"""
|
||||
|
||||
import cProfile
|
||||
import pstats
|
||||
import time
|
||||
import platform
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
|
||||
from .request import ExecutionRequest
|
||||
from .result import ExecutionResult
|
||||
from .core import _execute_core
|
||||
|
||||
|
||||
# Schema version - MUST be incremented for breaking changes
|
||||
SCHEMA_VERSION = "1.0"
|
||||
|
||||
# Bounds for profile data
|
||||
MAX_FUNCTION_STATS = 1000
|
||||
MAX_CALL_GRAPH_EDGES = 5000
|
||||
MAX_NETWORK_REQUESTS = 100
|
||||
MAX_IMPORT_MODULES = 200
|
||||
|
||||
|
||||
@dataclass
|
||||
class ProfilerConfig:
|
||||
"""
|
||||
Profiler configuration with explicit layer control.
|
||||
|
||||
Layers:
|
||||
- 0: Wall-clock phases only (<1ms overhead)
|
||||
- 1: + cProfile function stats (~5% overhead)
|
||||
- 2: + Call graph callers/callees (~15% overhead)
|
||||
|
||||
Network timing is orthogonal (opt-in via track_network).
|
||||
"""
|
||||
|
||||
# Layer control (0, 1, or 2)
|
||||
layer: int = 1
|
||||
|
||||
# Layer 1+ options
|
||||
limit: int = 30 # Max functions to show
|
||||
sort_by: str = "cumulative" # cumulative, time, calls
|
||||
|
||||
# Layer 2 options
|
||||
show_callers: bool = False
|
||||
show_callees: bool = False
|
||||
|
||||
# Network timing (orthogonal to layers)
|
||||
track_network: bool = False
|
||||
|
||||
# Output options
|
||||
output_format: str = "text" # text, json
|
||||
save_path: Optional[str] = None
|
||||
|
||||
@classmethod
|
||||
def from_flags(
|
||||
cls,
|
||||
profile: bool = False,
|
||||
deep: bool = False,
|
||||
network: bool = False,
|
||||
) -> 'ProfilerConfig':
|
||||
"""Create config from CLI flags."""
|
||||
if deep:
|
||||
return cls(
|
||||
layer=2,
|
||||
show_callers=True,
|
||||
show_callees=True,
|
||||
track_network=network,
|
||||
)
|
||||
elif profile:
|
||||
return cls(layer=1, track_network=network)
|
||||
else:
|
||||
return cls(layer=0, track_network=network)
|
||||
|
||||
|
||||
@dataclass
|
||||
class TimingBreakdown:
|
||||
"""
|
||||
Phase timing breakdown with full timeline visibility.
|
||||
|
||||
All fields in milliseconds.
|
||||
Timeline order: cli_entry -> cli_parse -> routing -> imports -> agent_init ->
|
||||
network_start -> first_token -> first_output -> execution_end
|
||||
"""
|
||||
|
||||
# MANDATORY fields (always present)
|
||||
total_ms: float = 0.0
|
||||
imports_ms: float = 0.0
|
||||
agent_init_ms: float = 0.0
|
||||
execution_ms: float = 0.0
|
||||
|
||||
# TIMELINE PHASES (new - for full visibility)
|
||||
cli_entry_ms: float = 0.0 # Time from ENTER to CLI entry point
|
||||
cli_parse_ms: float = 0.0 # Argparse/Typer routing time
|
||||
routing_ms: float = 0.0 # Command routing time
|
||||
network_start_ms: float = 0.0 # When network request started (relative to start)
|
||||
first_token_ms: float = 0.0 # Time to first token (streaming)
|
||||
first_output_ms: float = 0.0 # Time to First Response (TTFR) - first visible output
|
||||
|
||||
# OPTIONAL fields (may be 0)
|
||||
tool_time_ms: float = 0.0 # If tools were called
|
||||
|
||||
@property
|
||||
def time_to_first_response_ms(self) -> float:
|
||||
"""Time to First Response (TTFR) - the key user-perceived latency metric."""
|
||||
if self.first_output_ms > 0:
|
||||
return self.first_output_ms
|
||||
# Fallback: use execution end if first_output not captured
|
||||
return self.total_ms
|
||||
|
||||
def to_dict(self) -> Dict[str, float]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"total_ms": self.total_ms,
|
||||
"imports_ms": self.imports_ms,
|
||||
"agent_init_ms": self.agent_init_ms,
|
||||
"execution_ms": self.execution_ms,
|
||||
"cli_entry_ms": self.cli_entry_ms,
|
||||
"cli_parse_ms": self.cli_parse_ms,
|
||||
"routing_ms": self.routing_ms,
|
||||
"network_start_ms": self.network_start_ms,
|
||||
"first_token_ms": self.first_token_ms,
|
||||
"first_output_ms": self.first_output_ms,
|
||||
"time_to_first_response_ms": self.time_to_first_response_ms,
|
||||
"tool_time_ms": self.tool_time_ms,
|
||||
}
|
||||
|
||||
def to_timeline(self) -> List[Tuple[str, float, float]]:
|
||||
"""
|
||||
Get ordered timeline of phases.
|
||||
|
||||
Returns list of (phase_name, start_ms, duration_ms) tuples.
|
||||
"""
|
||||
timeline = []
|
||||
cursor = 0.0
|
||||
|
||||
# CLI Entry (if captured)
|
||||
if self.cli_entry_ms > 0:
|
||||
timeline.append(("CLI Entry", 0.0, self.cli_entry_ms))
|
||||
cursor = self.cli_entry_ms
|
||||
|
||||
# CLI Parse
|
||||
if self.cli_parse_ms > 0:
|
||||
timeline.append(("CLI Parse", cursor, self.cli_parse_ms))
|
||||
cursor += self.cli_parse_ms
|
||||
|
||||
# Routing
|
||||
if self.routing_ms > 0:
|
||||
timeline.append(("Routing", cursor, self.routing_ms))
|
||||
cursor += self.routing_ms
|
||||
|
||||
# Imports
|
||||
if self.imports_ms > 0:
|
||||
timeline.append(("Imports", cursor, self.imports_ms))
|
||||
cursor += self.imports_ms
|
||||
|
||||
# Agent Init
|
||||
if self.agent_init_ms > 0:
|
||||
timeline.append(("Agent Init", cursor, self.agent_init_ms))
|
||||
cursor += self.agent_init_ms
|
||||
|
||||
# Network to First Token (if streaming)
|
||||
if self.network_start_ms > 0 and self.first_token_ms > 0:
|
||||
network_duration = self.first_token_ms - self.network_start_ms
|
||||
if network_duration > 0:
|
||||
timeline.append(("Network → First Token", self.network_start_ms, network_duration))
|
||||
|
||||
# Execution
|
||||
if self.execution_ms > 0:
|
||||
timeline.append(("Execution", cursor, self.execution_ms))
|
||||
|
||||
return timeline
|
||||
|
||||
|
||||
@dataclass
|
||||
class FunctionStat:
|
||||
"""Statistics for a single function."""
|
||||
|
||||
name: str
|
||||
file: str
|
||||
line: int
|
||||
calls: int
|
||||
total_time_ms: float
|
||||
cumulative_time_ms: float
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"name": self.name,
|
||||
"file": self.file,
|
||||
"line": self.line,
|
||||
"calls": self.calls,
|
||||
"total_time_ms": self.total_time_ms,
|
||||
"cumulative_time_ms": self.cumulative_time_ms,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class CallGraph:
|
||||
"""Call graph data (callers and callees)."""
|
||||
|
||||
callers: Dict[str, List[str]] = field(default_factory=dict)
|
||||
callees: Dict[str, List[str]] = field(default_factory=dict)
|
||||
|
||||
@property
|
||||
def edges(self) -> List[Tuple[str, str]]:
|
||||
"""Get all edges as (caller, callee) tuples."""
|
||||
edges = []
|
||||
for callee, callers in self.callers.items():
|
||||
for caller in callers:
|
||||
edges.append((caller, callee))
|
||||
return edges
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"callers": self.callers,
|
||||
"callees": self.callees,
|
||||
"edge_count": len(self.edges),
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class RequestTiming:
|
||||
"""Single HTTP request timing."""
|
||||
|
||||
url: str
|
||||
method: str
|
||||
start_time: float
|
||||
first_byte_time: float
|
||||
end_time: float
|
||||
status_code: int
|
||||
|
||||
@property
|
||||
def ttfb_ms(self) -> float:
|
||||
"""Time to first byte in milliseconds."""
|
||||
return (self.first_byte_time - self.start_time) * 1000
|
||||
|
||||
@property
|
||||
def total_ms(self) -> float:
|
||||
"""Total request time in milliseconds."""
|
||||
return (self.end_time - self.start_time) * 1000
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"url": self.url,
|
||||
"method": self.method,
|
||||
"ttfb_ms": self.ttfb_ms,
|
||||
"total_ms": self.total_ms,
|
||||
"status_code": self.status_code,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class InvocationInfo:
|
||||
"""How the profile was invoked."""
|
||||
|
||||
method: str # "cli_direct", "profile_command", "tui"
|
||||
flags: Dict[str, Any] = field(default_factory=dict)
|
||||
praisonai_version: str = ""
|
||||
python_version: str = ""
|
||||
|
||||
def __post_init__(self):
|
||||
"""Set version info if not provided."""
|
||||
if not self.python_version:
|
||||
self.python_version = platform.python_version()
|
||||
if not self.praisonai_version:
|
||||
try:
|
||||
from praisonai.version import __version__
|
||||
self.praisonai_version = __version__
|
||||
except ImportError:
|
||||
self.praisonai_version = "unknown"
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"method": self.method,
|
||||
"flags": self.flags,
|
||||
"praisonai_version": self.praisonai_version,
|
||||
"python_version": self.python_version,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class DecisionTrace:
|
||||
"""
|
||||
Decision trace for deep profile visibility.
|
||||
|
||||
Explains what decisions were made during execution.
|
||||
"""
|
||||
|
||||
agent_config: str = "" # Agent configuration chosen
|
||||
model_selected: str = "" # Model used
|
||||
streaming_mode: bool = False # Streaming vs non-streaming
|
||||
profile_layer: int = 0 # Profile layer (0/1/2)
|
||||
tools_enabled: List[str] = field(default_factory=list)
|
||||
tools_disabled: List[str] = field(default_factory=list)
|
||||
fallbacks_used: List[str] = field(default_factory=list)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"agent_config": self.agent_config,
|
||||
"model_selected": self.model_selected,
|
||||
"streaming_mode": self.streaming_mode,
|
||||
"profile_layer": self.profile_layer,
|
||||
"tools_enabled": self.tools_enabled,
|
||||
"tools_disabled": self.tools_disabled,
|
||||
"fallbacks_used": self.fallbacks_used,
|
||||
}
|
||||
|
||||
def to_text(self) -> str:
|
||||
"""Format as human-readable text."""
|
||||
lines = []
|
||||
lines.append(f" Agent Config: {self.agent_config or 'default'}")
|
||||
lines.append(f" Model: {self.model_selected or 'default'}")
|
||||
lines.append(f" Streaming: {'enabled' if self.streaming_mode else 'disabled'}")
|
||||
lines.append(f" Profile Layer: {self.profile_layer}")
|
||||
if self.tools_enabled:
|
||||
lines.append(f" Tools Enabled: {', '.join(self.tools_enabled)}")
|
||||
if self.tools_disabled:
|
||||
lines.append(f" Tools Disabled: {', '.join(self.tools_disabled)}")
|
||||
if self.fallbacks_used:
|
||||
lines.append(f" Fallbacks: {', '.join(self.fallbacks_used)}")
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ModuleBreakdown:
|
||||
"""
|
||||
Module/file breakdown for deep profile visibility.
|
||||
|
||||
Groups functions by module category.
|
||||
"""
|
||||
|
||||
cli_modules: List[str] = field(default_factory=list)
|
||||
execution_modules: List[str] = field(default_factory=list)
|
||||
agent_modules: List[str] = field(default_factory=list)
|
||||
tool_modules: List[str] = field(default_factory=list)
|
||||
network_modules: List[str] = field(default_factory=list)
|
||||
third_party_modules: List[str] = field(default_factory=list)
|
||||
|
||||
def to_dict(self) -> Dict[str, List[str]]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"cli": self.cli_modules,
|
||||
"execution": self.execution_modules,
|
||||
"agent": self.agent_modules,
|
||||
"tools": self.tool_modules,
|
||||
"network": self.network_modules,
|
||||
"third_party": self.third_party_modules,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class ProfileReport:
|
||||
"""
|
||||
Canonical profile report.
|
||||
|
||||
VERSION 1.0 - Schema is frozen after release.
|
||||
New fields MUST be optional with defaults.
|
||||
"""
|
||||
|
||||
# Schema version (MANDATORY, NEVER CHANGES MEANING)
|
||||
schema_version: str = SCHEMA_VERSION
|
||||
|
||||
# Identity (MANDATORY)
|
||||
run_id: str = ""
|
||||
timestamp: str = "" # ISO 8601
|
||||
|
||||
# Invocation (MANDATORY)
|
||||
invocation: InvocationInfo = field(default_factory=lambda: InvocationInfo(method="unknown"))
|
||||
|
||||
# Timing (MANDATORY)
|
||||
timing: TimingBreakdown = field(default_factory=TimingBreakdown)
|
||||
|
||||
# Function stats (OPTIONAL, present if layer >= 1)
|
||||
functions: Optional[List[FunctionStat]] = None
|
||||
|
||||
# Call graph (OPTIONAL, present if layer >= 2)
|
||||
call_graph: Optional[CallGraph] = None
|
||||
|
||||
# Network (OPTIONAL, present if track_network)
|
||||
network: Optional[List[RequestTiming]] = None
|
||||
|
||||
# Response (MANDATORY but truncated)
|
||||
response_preview: str = "" # Max 500 chars
|
||||
|
||||
# Decision trace (OPTIONAL, present if layer >= 2)
|
||||
decision_trace: Optional[DecisionTrace] = None
|
||||
|
||||
# Module breakdown (OPTIONAL, present if layer >= 2)
|
||||
module_breakdown: Optional[ModuleBreakdown] = None
|
||||
|
||||
def __post_init__(self):
|
||||
"""Set timestamp if not provided."""
|
||||
if not self.timestamp:
|
||||
self.timestamp = datetime.utcnow().isoformat() + "Z"
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary for JSON serialization."""
|
||||
result = {
|
||||
"schema_version": self.schema_version,
|
||||
"run_id": self.run_id,
|
||||
"timestamp": self.timestamp,
|
||||
"invocation": self.invocation.to_dict(),
|
||||
"timing": self.timing.to_dict(),
|
||||
"response_preview": self.response_preview,
|
||||
}
|
||||
|
||||
if self.functions is not None:
|
||||
result["functions"] = [f.to_dict() for f in self.functions]
|
||||
|
||||
if self.call_graph is not None:
|
||||
result["call_graph"] = self.call_graph.to_dict()
|
||||
|
||||
if self.network is not None:
|
||||
result["network"] = [r.to_dict() for r in self.network]
|
||||
|
||||
if self.decision_trace is not None:
|
||||
result["decision_trace"] = self.decision_trace.to_dict()
|
||||
|
||||
if self.module_breakdown is not None:
|
||||
result["module_breakdown"] = self.module_breakdown.to_dict()
|
||||
|
||||
return result
|
||||
|
||||
def to_json(self) -> str:
|
||||
"""Convert to JSON string."""
|
||||
import json
|
||||
return json.dumps(self.to_dict(), indent=2, default=str)
|
||||
|
||||
def to_text(self) -> str:
|
||||
"""Format as human-readable text."""
|
||||
lines = []
|
||||
lines.append("=" * 70)
|
||||
lines.append("PraisonAI Profile Report")
|
||||
lines.append("=" * 70)
|
||||
lines.append("")
|
||||
|
||||
# Identity
|
||||
lines.append(f"Run ID: {self.run_id}")
|
||||
lines.append(f"Timestamp: {self.timestamp}")
|
||||
lines.append(f"Method: {self.invocation.method}")
|
||||
lines.append(f"Version: {self.invocation.praisonai_version}")
|
||||
lines.append("")
|
||||
|
||||
# TIMELINE SECTION (new - shows ENTER → First Response)
|
||||
lines.append("## Execution Timeline")
|
||||
lines.append("-" * 45)
|
||||
timeline = self.timing.to_timeline()
|
||||
if timeline:
|
||||
for phase_name, start_ms, duration_ms in timeline:
|
||||
lines.append(f" {phase_name:<25} : {duration_ms:>8.2f} ms")
|
||||
else:
|
||||
# Fallback to basic phases
|
||||
if self.timing.imports_ms > 0:
|
||||
lines.append(f" {'Imports':<25} : {self.timing.imports_ms:>8.2f} ms")
|
||||
if self.timing.agent_init_ms > 0:
|
||||
lines.append(f" {'Agent Init':<25} : {self.timing.agent_init_ms:>8.2f} ms")
|
||||
if self.timing.execution_ms > 0:
|
||||
lines.append(f" {'Execution':<25} : {self.timing.execution_ms:>8.2f} ms")
|
||||
lines.append(" " + "─" * 43)
|
||||
|
||||
# TIME TO FIRST RESPONSE (TTFR) - the key metric
|
||||
ttfr = self.timing.time_to_first_response_ms
|
||||
lines.append(f" {'⏱ Time to First Response':<25} : {ttfr:>8.2f} ms")
|
||||
lines.append(f" {'TOTAL':<25} : {self.timing.total_ms:>8.2f} ms")
|
||||
lines.append("")
|
||||
|
||||
# Timing breakdown (legacy format for compatibility)
|
||||
lines.append("## Timing Breakdown")
|
||||
lines.append("-" * 40)
|
||||
if self.timing.cli_entry_ms > 0:
|
||||
lines.append(f" CLI Entry: {self.timing.cli_entry_ms:>10.2f} ms")
|
||||
if self.timing.cli_parse_ms > 0:
|
||||
lines.append(f" CLI Parse: {self.timing.cli_parse_ms:>10.2f} ms")
|
||||
if self.timing.routing_ms > 0:
|
||||
lines.append(f" Routing: {self.timing.routing_ms:>10.2f} ms")
|
||||
lines.append(f" Imports: {self.timing.imports_ms:>10.2f} ms")
|
||||
lines.append(f" Agent Init: {self.timing.agent_init_ms:>10.2f} ms")
|
||||
lines.append(f" Execution: {self.timing.execution_ms:>10.2f} ms")
|
||||
if self.timing.network_start_ms > 0:
|
||||
lines.append(f" Network Start: {self.timing.network_start_ms:>10.2f} ms")
|
||||
if self.timing.first_token_ms > 0:
|
||||
lines.append(f" First Token: {self.timing.first_token_ms:>10.2f} ms")
|
||||
if self.timing.first_output_ms > 0:
|
||||
lines.append(f" First Output: {self.timing.first_output_ms:>10.2f} ms")
|
||||
lines.append(" ─────────────────────────────────────")
|
||||
lines.append(f" TOTAL: {self.timing.total_ms:>10.2f} ms")
|
||||
lines.append("")
|
||||
|
||||
# Decision trace (deep profile only)
|
||||
if self.decision_trace:
|
||||
lines.append("## Decision Trace")
|
||||
lines.append("-" * 40)
|
||||
lines.append(self.decision_trace.to_text())
|
||||
lines.append("")
|
||||
|
||||
# Function stats
|
||||
if self.functions:
|
||||
lines.append("## Top Functions by Cumulative Time")
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'Function':<40} {'Calls':>8} {'Cumul (ms)':>12}")
|
||||
lines.append("-" * 70)
|
||||
for func in self.functions[:20]:
|
||||
name = func.name[:38] if len(func.name) > 38 else func.name
|
||||
lines.append(f"{name:<40} {func.calls:>8} {func.cumulative_time_ms:>12.2f}")
|
||||
lines.append("")
|
||||
|
||||
# Module breakdown (deep profile only)
|
||||
if self.module_breakdown:
|
||||
lines.append("## Module Breakdown")
|
||||
lines.append("-" * 40)
|
||||
mb = self.module_breakdown
|
||||
if mb.cli_modules:
|
||||
lines.append(f" CLI: {len(mb.cli_modules)} modules")
|
||||
if mb.execution_modules:
|
||||
lines.append(f" Execution: {len(mb.execution_modules)} modules")
|
||||
if mb.agent_modules:
|
||||
lines.append(f" Agent: {len(mb.agent_modules)} modules")
|
||||
if mb.tool_modules:
|
||||
lines.append(f" Tools: {len(mb.tool_modules)} modules")
|
||||
if mb.network_modules:
|
||||
lines.append(f" Network: {len(mb.network_modules)} modules")
|
||||
if mb.third_party_modules:
|
||||
lines.append(f" Third-party:{len(mb.third_party_modules)} modules")
|
||||
lines.append("")
|
||||
|
||||
# Call graph summary
|
||||
if self.call_graph:
|
||||
lines.append(f"## Call Graph: {len(self.call_graph.edges)} edges")
|
||||
lines.append("")
|
||||
|
||||
# Network timing
|
||||
if self.network:
|
||||
lines.append("## Network Requests")
|
||||
lines.append("-" * 70)
|
||||
for req in self.network[:10]:
|
||||
lines.append(f" {req.method} {req.url[:50]} - {req.total_ms:.2f}ms (TTFB: {req.ttfb_ms:.2f}ms)")
|
||||
lines.append("")
|
||||
|
||||
# Response preview
|
||||
if self.response_preview:
|
||||
lines.append("## Response Preview")
|
||||
lines.append("-" * 40)
|
||||
preview = self.response_preview[:200]
|
||||
if len(self.response_preview) > 200:
|
||||
preview += "..."
|
||||
lines.append(preview)
|
||||
lines.append("")
|
||||
|
||||
lines.append("=" * 70)
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
class Profiler:
|
||||
"""
|
||||
External profiler that wraps execution.
|
||||
|
||||
Execution code has ZERO awareness of profiling.
|
||||
Profiler uses cProfile.runctx() or similar.
|
||||
"""
|
||||
|
||||
def __init__(self, config: ProfilerConfig):
|
||||
self.config = config
|
||||
self._cprofile: Optional[cProfile.Profile] = None
|
||||
self._timing: Dict[str, float] = {}
|
||||
self._network_requests: List[RequestTiming] = []
|
||||
|
||||
def profile_sync(
|
||||
self,
|
||||
request: ExecutionRequest,
|
||||
invocation_method: str = "profile_command",
|
||||
) -> Tuple[ExecutionResult, ProfileReport]:
|
||||
"""
|
||||
Profile synchronous execution.
|
||||
|
||||
Args:
|
||||
request: The execution request
|
||||
invocation_method: How this was invoked (for report)
|
||||
|
||||
Returns:
|
||||
Tuple of (ExecutionResult, ProfileReport)
|
||||
"""
|
||||
timing_dict: Dict[str, float] = {}
|
||||
|
||||
# Layer 0: Wall-clock timing (always)
|
||||
start = time.perf_counter()
|
||||
|
||||
# Layer 1+: cProfile
|
||||
if self.config.layer >= 1:
|
||||
self._cprofile = cProfile.Profile()
|
||||
self._cprofile.enable()
|
||||
|
||||
try:
|
||||
result = _execute_core(request, timing_dict)
|
||||
finally:
|
||||
if self._cprofile:
|
||||
self._cprofile.disable()
|
||||
|
||||
total_ms = (time.perf_counter() - start) * 1000
|
||||
|
||||
# Build report
|
||||
report = self._build_report(
|
||||
request=request,
|
||||
result=result,
|
||||
timing_dict=timing_dict,
|
||||
total_ms=total_ms,
|
||||
invocation_method=invocation_method,
|
||||
)
|
||||
|
||||
return result, report
|
||||
|
||||
def _build_report(
|
||||
self,
|
||||
request: ExecutionRequest,
|
||||
result: ExecutionResult,
|
||||
timing_dict: Dict[str, float],
|
||||
total_ms: float,
|
||||
invocation_method: str,
|
||||
) -> ProfileReport:
|
||||
"""Build the profile report from collected data."""
|
||||
|
||||
# Calculate first_output_ms (TTFR) - time from start to when output is available
|
||||
# This is imports + agent_init + execution (when output becomes available)
|
||||
imports_ms = timing_dict.get("imports_ms", 0.0)
|
||||
agent_init_ms = timing_dict.get("agent_init_ms", 0.0)
|
||||
execution_ms = timing_dict.get("execution_ms", 0.0)
|
||||
first_output_ms = imports_ms + agent_init_ms + execution_ms
|
||||
|
||||
# Timing breakdown with full timeline
|
||||
timing = TimingBreakdown(
|
||||
total_ms=total_ms,
|
||||
imports_ms=imports_ms,
|
||||
agent_init_ms=agent_init_ms,
|
||||
execution_ms=execution_ms,
|
||||
cli_entry_ms=timing_dict.get("cli_entry_ms", 0.0),
|
||||
cli_parse_ms=timing_dict.get("cli_parse_ms", 0.0),
|
||||
routing_ms=timing_dict.get("routing_ms", 0.0),
|
||||
network_start_ms=timing_dict.get("network_start_ms", 0.0),
|
||||
first_token_ms=timing_dict.get("first_token_ms", 0.0),
|
||||
first_output_ms=first_output_ms,
|
||||
)
|
||||
|
||||
# Invocation info
|
||||
invocation = InvocationInfo(
|
||||
method=invocation_method,
|
||||
flags={
|
||||
"layer": self.config.layer,
|
||||
"stream": request.stream,
|
||||
"model": request.model,
|
||||
},
|
||||
)
|
||||
|
||||
# Function stats (layer 1+)
|
||||
functions = None
|
||||
if self.config.layer >= 1 and self._cprofile:
|
||||
functions = self._extract_function_stats()
|
||||
|
||||
# Call graph (layer 2)
|
||||
call_graph = None
|
||||
if self.config.layer >= 2 and self._cprofile:
|
||||
call_graph = self._extract_call_graph()
|
||||
|
||||
# Decision trace (layer 2 - deep profile)
|
||||
decision_trace = None
|
||||
if self.config.layer >= 2:
|
||||
decision_trace = DecisionTrace(
|
||||
agent_config=request.agent_name or "default",
|
||||
model_selected=request.model or "default",
|
||||
streaming_mode=request.stream,
|
||||
profile_layer=self.config.layer,
|
||||
tools_enabled=list(request.tools) if request.tools else [],
|
||||
tools_disabled=[],
|
||||
fallbacks_used=[],
|
||||
)
|
||||
|
||||
# Module breakdown (layer 2 - deep profile)
|
||||
module_breakdown = None
|
||||
if self.config.layer >= 2 and functions:
|
||||
module_breakdown = self._extract_module_breakdown(functions)
|
||||
|
||||
# Response preview (truncated)
|
||||
response_preview = result.output[:500] if result.output else ""
|
||||
|
||||
return ProfileReport(
|
||||
run_id=result.run_id,
|
||||
invocation=invocation,
|
||||
timing=timing,
|
||||
functions=functions,
|
||||
call_graph=call_graph,
|
||||
network=self._network_requests if self._network_requests else None,
|
||||
response_preview=response_preview,
|
||||
decision_trace=decision_trace,
|
||||
module_breakdown=module_breakdown,
|
||||
)
|
||||
|
||||
def _extract_module_breakdown(self, functions: List[FunctionStat]) -> ModuleBreakdown:
|
||||
"""Extract module breakdown from function stats."""
|
||||
cli_modules = set()
|
||||
execution_modules = set()
|
||||
agent_modules = set()
|
||||
tool_modules = set()
|
||||
network_modules = set()
|
||||
third_party_modules = set()
|
||||
|
||||
for func in functions:
|
||||
file_path = func.file.lower()
|
||||
|
||||
if "praisonai/cli" in file_path:
|
||||
cli_modules.add(func.file)
|
||||
elif "praisonai" in file_path and "execution" in file_path:
|
||||
execution_modules.add(func.file)
|
||||
elif "praisonaiagents" in file_path and "agent" in file_path:
|
||||
agent_modules.add(func.file)
|
||||
elif "praisonaiagents" in file_path and "tool" in file_path:
|
||||
tool_modules.add(func.file)
|
||||
elif any(x in file_path for x in ["httpx", "httpcore", "urllib", "requests", "aiohttp"]):
|
||||
network_modules.add(func.file)
|
||||
elif "site-packages" in file_path or not file_path.startswith("/"):
|
||||
third_party_modules.add(func.file)
|
||||
|
||||
return ModuleBreakdown(
|
||||
cli_modules=list(cli_modules)[:20],
|
||||
execution_modules=list(execution_modules)[:20],
|
||||
agent_modules=list(agent_modules)[:20],
|
||||
tool_modules=list(tool_modules)[:20],
|
||||
network_modules=list(network_modules)[:20],
|
||||
third_party_modules=list(third_party_modules)[:20],
|
||||
)
|
||||
|
||||
def _extract_function_stats(self) -> List[FunctionStat]:
|
||||
"""Extract function statistics from cProfile."""
|
||||
if not self._cprofile:
|
||||
return []
|
||||
|
||||
stats = pstats.Stats(self._cprofile)
|
||||
|
||||
# Sort by cumulative time
|
||||
stats.sort_stats(self.config.sort_by)
|
||||
|
||||
# Extract stats
|
||||
function_stats = []
|
||||
for (filename, line, name), (cc, nc, tt, ct, callers) in stats.stats.items():
|
||||
if len(function_stats) >= MAX_FUNCTION_STATS:
|
||||
break
|
||||
|
||||
function_stats.append(FunctionStat(
|
||||
name=name,
|
||||
file=filename,
|
||||
line=line,
|
||||
calls=nc,
|
||||
total_time_ms=tt * 1000,
|
||||
cumulative_time_ms=ct * 1000,
|
||||
))
|
||||
|
||||
# Sort and limit
|
||||
function_stats.sort(key=lambda x: x.cumulative_time_ms, reverse=True)
|
||||
return function_stats[:self.config.limit]
|
||||
|
||||
def _extract_call_graph(self) -> CallGraph:
|
||||
"""Extract call graph from cProfile."""
|
||||
if not self._cprofile:
|
||||
return CallGraph()
|
||||
|
||||
stats = pstats.Stats(self._cprofile)
|
||||
|
||||
callers: Dict[str, List[str]] = {}
|
||||
callees: Dict[str, List[str]] = {}
|
||||
edge_count = 0
|
||||
|
||||
for (filename, line, name), (cc, nc, tt, ct, caller_dict) in stats.stats.items():
|
||||
if edge_count >= MAX_CALL_GRAPH_EDGES:
|
||||
break
|
||||
|
||||
callee_key = f"{name}:{filename}:{line}"
|
||||
|
||||
for (caller_file, caller_line, caller_name), _ in caller_dict.items():
|
||||
if edge_count >= MAX_CALL_GRAPH_EDGES:
|
||||
break
|
||||
|
||||
caller_key = f"{caller_name}:{caller_file}:{caller_line}"
|
||||
|
||||
# Add to callers
|
||||
if callee_key not in callers:
|
||||
callers[callee_key] = []
|
||||
if caller_key not in callers[callee_key]:
|
||||
callers[callee_key].append(caller_key)
|
||||
|
||||
# Add to callees
|
||||
if caller_key not in callees:
|
||||
callees[caller_key] = []
|
||||
if callee_key not in callees[caller_key]:
|
||||
callees[caller_key].append(callee_key)
|
||||
|
||||
edge_count += 1
|
||||
|
||||
return CallGraph(callers=callers, callees=callees)
|
||||
@@ -0,0 +1,85 @@
|
||||
"""
|
||||
ExecutionRequest - Immutable request for execution.
|
||||
|
||||
This is the minimal, immutable request that all execution paths use.
|
||||
CLI/TUI translate their flags into this structure.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass
|
||||
from typing import Callable, Optional, Tuple, Any
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ExecutionRequest:
|
||||
"""
|
||||
Minimal, immutable request for execution.
|
||||
|
||||
NOT a kitchen-sink of all CLI flags.
|
||||
CLI/TUI translate their flags into this.
|
||||
|
||||
Attributes:
|
||||
prompt: The user prompt to execute
|
||||
agent_name: Name of the agent (default: "Assistant")
|
||||
agent_instructions: Custom instructions for the agent
|
||||
model: LLM model to use (None = use default)
|
||||
tools: Tuple of tool callables (immutable)
|
||||
stream: Whether to stream the response
|
||||
|
||||
Note: This is frozen (immutable) to:
|
||||
- Prevent accidental mutation during profiling
|
||||
- Enable safe sharing across threads/coroutines
|
||||
"""
|
||||
|
||||
# Required
|
||||
prompt: str
|
||||
|
||||
# Agent identity (optional, has defaults)
|
||||
agent_name: str = "Assistant"
|
||||
agent_instructions: Optional[str] = None
|
||||
|
||||
# Model (optional, has defaults)
|
||||
model: Optional[str] = None # None = use default
|
||||
|
||||
# Tools (optional) - using tuple for immutability
|
||||
tools: Tuple[Callable[..., Any], ...] = ()
|
||||
|
||||
# Execution mode
|
||||
stream: bool = False
|
||||
|
||||
def __post_init__(self):
|
||||
"""Validate request after initialization."""
|
||||
if not self.prompt:
|
||||
raise ValueError("prompt cannot be empty")
|
||||
|
||||
def with_model(self, model: str) -> 'ExecutionRequest':
|
||||
"""Create a new request with a different model."""
|
||||
return ExecutionRequest(
|
||||
prompt=self.prompt,
|
||||
agent_name=self.agent_name,
|
||||
agent_instructions=self.agent_instructions,
|
||||
model=model,
|
||||
tools=self.tools,
|
||||
stream=self.stream,
|
||||
)
|
||||
|
||||
def with_tools(self, tools: Tuple[Callable[..., Any], ...]) -> 'ExecutionRequest':
|
||||
"""Create a new request with different tools."""
|
||||
return ExecutionRequest(
|
||||
prompt=self.prompt,
|
||||
agent_name=self.agent_name,
|
||||
agent_instructions=self.agent_instructions,
|
||||
model=self.model,
|
||||
tools=tools,
|
||||
stream=self.stream,
|
||||
)
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
"""Convert to dictionary for serialization."""
|
||||
return {
|
||||
"prompt": self.prompt,
|
||||
"agent_name": self.agent_name,
|
||||
"agent_instructions": self.agent_instructions,
|
||||
"model": self.model,
|
||||
"tools_count": len(self.tools),
|
||||
"stream": self.stream,
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
"""
|
||||
ExecutionResult - Result from execution.
|
||||
|
||||
Contains the output and metadata from an execution.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class ExecutionResult:
|
||||
"""
|
||||
Result from executing a request.
|
||||
|
||||
Attributes:
|
||||
output: The text output from the agent
|
||||
run_id: Unique identifier for this execution
|
||||
success: Whether execution completed successfully
|
||||
error: Error message if execution failed
|
||||
metadata: Additional metadata about the execution
|
||||
tool_calls: List of tools that were called
|
||||
start_time: When execution started (perf_counter)
|
||||
end_time: When execution ended (perf_counter)
|
||||
"""
|
||||
|
||||
# Primary output
|
||||
output: str
|
||||
|
||||
# Identity
|
||||
run_id: str = ""
|
||||
|
||||
# Status
|
||||
success: bool = True
|
||||
error: Optional[str] = None
|
||||
|
||||
# Metadata
|
||||
metadata: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
# Tool tracking
|
||||
tool_calls: List[str] = field(default_factory=list)
|
||||
|
||||
# Timing (raw perf_counter values)
|
||||
start_time: float = 0.0
|
||||
end_time: float = 0.0
|
||||
|
||||
@property
|
||||
def duration_ms(self) -> float:
|
||||
"""Duration in milliseconds."""
|
||||
if self.start_time and self.end_time:
|
||||
return (self.end_time - self.start_time) * 1000
|
||||
return 0.0
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary for serialization."""
|
||||
return {
|
||||
"output": self.output,
|
||||
"run_id": self.run_id,
|
||||
"success": self.success,
|
||||
"error": self.error,
|
||||
"metadata": self.metadata,
|
||||
"tool_calls": self.tool_calls,
|
||||
"duration_ms": self.duration_ms,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_error(cls, error: str, run_id: str = "") -> 'ExecutionResult':
|
||||
"""Create a result from an error."""
|
||||
return cls(
|
||||
output="",
|
||||
run_id=run_id,
|
||||
success=False,
|
||||
error=error,
|
||||
)
|
||||
@@ -96,6 +96,17 @@ __all__ = [
|
||||
'PerformanceHandler',
|
||||
# Lite agent (BYO-LLM)
|
||||
'LiteHandler',
|
||||
# Agent-centric tools (LSP/ACP powered)
|
||||
'create_agent_centric_tools',
|
||||
'InteractiveRuntime',
|
||||
'RuntimeConfig',
|
||||
'CodeIntelligenceRouter',
|
||||
'ActionOrchestrator',
|
||||
# Interactive tools provider (canonical source)
|
||||
'get_interactive_tools',
|
||||
'resolve_tool_groups',
|
||||
'ToolConfig',
|
||||
'TOOL_GROUPS',
|
||||
]
|
||||
|
||||
def __getattr__(name):
|
||||
@@ -225,4 +236,33 @@ def __getattr__(name):
|
||||
elif name == 'LiteHandler':
|
||||
from .lite import LiteHandler
|
||||
return LiteHandler
|
||||
# Agent-centric tools (LSP/ACP powered)
|
||||
elif name == 'create_agent_centric_tools':
|
||||
from .agent_tools import create_agent_centric_tools
|
||||
return create_agent_centric_tools
|
||||
elif name == 'InteractiveRuntime':
|
||||
from .interactive_runtime import InteractiveRuntime
|
||||
return InteractiveRuntime
|
||||
elif name == 'RuntimeConfig':
|
||||
from .interactive_runtime import RuntimeConfig
|
||||
return RuntimeConfig
|
||||
elif name == 'CodeIntelligenceRouter':
|
||||
from .code_intelligence import CodeIntelligenceRouter
|
||||
return CodeIntelligenceRouter
|
||||
elif name == 'ActionOrchestrator':
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
return ActionOrchestrator
|
||||
# Interactive tools provider (canonical source)
|
||||
elif name == 'get_interactive_tools':
|
||||
from .interactive_tools import get_interactive_tools
|
||||
return get_interactive_tools
|
||||
elif name == 'resolve_tool_groups':
|
||||
from .interactive_tools import resolve_tool_groups
|
||||
return resolve_tool_groups
|
||||
elif name == 'ToolConfig':
|
||||
from .interactive_tools import ToolConfig
|
||||
return ToolConfig
|
||||
elif name == 'TOOL_GROUPS':
|
||||
from .interactive_tools import TOOL_GROUPS
|
||||
return TOOL_GROUPS
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
@@ -0,0 +1,236 @@
|
||||
"""
|
||||
ACP CLI handler for PraisonAI.
|
||||
|
||||
Provides the `praisonai acp` command for IDE/editor integration.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import logging
|
||||
import sys
|
||||
from typing import Optional
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class ACPHandler:
|
||||
"""Handler for ACP CLI commands."""
|
||||
|
||||
@staticmethod
|
||||
def add_arguments(parser: argparse.ArgumentParser) -> None:
|
||||
"""Add ACP-specific arguments to parser."""
|
||||
parser.add_argument(
|
||||
"-w", "--workspace",
|
||||
type=str,
|
||||
default=".",
|
||||
help="Workspace root directory (default: current directory)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"-a", "--agent",
|
||||
type=str,
|
||||
default="default",
|
||||
help="Agent name or configuration file"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--agents",
|
||||
type=str,
|
||||
help="Multi-agent configuration YAML file"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--router",
|
||||
action="store_true",
|
||||
help="Enable router agent for task delegation"
|
||||
)
|
||||
parser.add_argument(
|
||||
"-m", "--model",
|
||||
type=str,
|
||||
help="LLM model to use"
|
||||
)
|
||||
parser.add_argument(
|
||||
"-r", "--resume",
|
||||
type=str,
|
||||
nargs="?",
|
||||
const="__last__",
|
||||
help="Resume session by ID (or --resume --last for most recent)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--last",
|
||||
action="store_true",
|
||||
help="Resume the last session (use with --resume)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--approve",
|
||||
type=str,
|
||||
choices=["manual", "auto", "scoped"],
|
||||
default="manual",
|
||||
help="Approval mode for actions (default: manual)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--read-only",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Read-only mode (default: enabled)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--allow-write",
|
||||
action="store_true",
|
||||
help="Allow file write operations"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--allow-shell",
|
||||
action="store_true",
|
||||
help="Allow shell command execution"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--allow-network",
|
||||
action="store_true",
|
||||
help="Allow network requests"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--debug",
|
||||
action="store_true",
|
||||
help="Enable debug logging to stderr"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--profile",
|
||||
type=str,
|
||||
help="Use named profile from config"
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def handle(args: argparse.Namespace) -> int:
|
||||
"""
|
||||
Handle ACP command execution.
|
||||
|
||||
Returns:
|
||||
Exit code (0 for success, non-zero for error)
|
||||
"""
|
||||
# Check if ACP SDK is available
|
||||
try:
|
||||
import importlib.util
|
||||
if importlib.util.find_spec("acp") is None:
|
||||
print(
|
||||
"Error: agent-client-protocol package not installed.\n"
|
||||
"Install with: pip install praisonai[acp]\n"
|
||||
"Or: pip install agent-client-protocol",
|
||||
file=sys.stderr
|
||||
)
|
||||
return 1
|
||||
except Exception as e:
|
||||
print(f"Error checking ACP availability: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
# Import ACP module
|
||||
try:
|
||||
from praisonai.acp import serve
|
||||
except ImportError as e:
|
||||
print(f"Error importing ACP module: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
# Determine resume session
|
||||
resume_session: Optional[str] = None
|
||||
resume_last = False
|
||||
|
||||
if args.resume:
|
||||
if args.resume == "__last__" or args.last:
|
||||
resume_last = True
|
||||
else:
|
||||
resume_session = args.resume
|
||||
elif args.last:
|
||||
resume_last = True
|
||||
|
||||
# Determine read-only mode
|
||||
read_only = args.read_only and not args.allow_write
|
||||
|
||||
try:
|
||||
# Start ACP server
|
||||
serve(
|
||||
workspace=args.workspace,
|
||||
agent=args.agent,
|
||||
model=args.model,
|
||||
resume=resume_session,
|
||||
resume_last=resume_last,
|
||||
debug=args.debug,
|
||||
read_only=read_only,
|
||||
allow_write=args.allow_write,
|
||||
allow_shell=args.allow_shell,
|
||||
approval_mode=args.approve,
|
||||
)
|
||||
return 0
|
||||
except KeyboardInterrupt:
|
||||
logger.info("ACP server stopped by user")
|
||||
return 0
|
||||
except Exception as e:
|
||||
logger.exception(f"ACP server error: {e}")
|
||||
print(f"Error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
|
||||
def setup_acp_subparser(subparsers) -> None:
|
||||
"""Set up the ACP subcommand parser."""
|
||||
acp_parser = subparsers.add_parser(
|
||||
"acp",
|
||||
help="Start ACP server for IDE/editor integration",
|
||||
description=(
|
||||
"Start the Agent Client Protocol (ACP) server.\n\n"
|
||||
"This allows IDEs and editors (Zed, JetBrains, VSCode, Toad) "
|
||||
"to connect to PraisonAI agents via JSON-RPC over stdio."
|
||||
),
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
epilog="""
|
||||
Examples:
|
||||
praisonai acp # Start with defaults
|
||||
praisonai acp --debug # Enable debug logging
|
||||
praisonai acp --resume --last # Resume last session
|
||||
praisonai acp --allow-write # Enable file writes
|
||||
praisonai acp -m gpt-4o # Use specific model
|
||||
|
||||
Editor Configuration:
|
||||
|
||||
Zed (~/.config/zed/settings.json):
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
JetBrains (~/.jetbrains/acp.json):
|
||||
{
|
||||
"agent_servers": {
|
||||
"PraisonAI": {
|
||||
"command": "praisonai",
|
||||
"args": ["acp"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Toad:
|
||||
toad acp "praisonai acp"
|
||||
"""
|
||||
)
|
||||
ACPHandler.add_arguments(acp_parser)
|
||||
acp_parser.set_defaults(func=lambda args: ACPHandler.handle(args))
|
||||
|
||||
|
||||
def run_acp_command(args: Optional[list] = None) -> int:
|
||||
"""
|
||||
Run ACP command directly.
|
||||
|
||||
This can be called from the main CLI or as a standalone entry point.
|
||||
"""
|
||||
parser = argparse.ArgumentParser(
|
||||
prog="praisonai acp",
|
||||
description="Start ACP server for IDE/editor integration"
|
||||
)
|
||||
ACPHandler.add_arguments(parser)
|
||||
|
||||
parsed_args = parser.parse_args(args)
|
||||
return ACPHandler.handle(parsed_args)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(run_acp_command())
|
||||
@@ -0,0 +1,546 @@
|
||||
"""
|
||||
Action Orchestrator for PraisonAI.
|
||||
|
||||
Orchestrates code modifications through ACP with plan → approval → apply → verify steps.
|
||||
Enforces read-only mode when ACP is unavailable.
|
||||
"""
|
||||
|
||||
import logging
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .interactive_runtime import InteractiveRuntime
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class ActionType(Enum):
|
||||
"""Types of actions that can be orchestrated."""
|
||||
FILE_CREATE = "file_create"
|
||||
FILE_EDIT = "file_edit"
|
||||
FILE_DELETE = "file_delete"
|
||||
FILE_RENAME = "file_rename"
|
||||
SHELL_COMMAND = "shell_command"
|
||||
REFACTOR = "refactor"
|
||||
UNKNOWN = "unknown"
|
||||
|
||||
|
||||
class ActionStatus(Enum):
|
||||
"""Status of an action."""
|
||||
PENDING = "pending"
|
||||
APPROVED = "approved"
|
||||
REJECTED = "rejected"
|
||||
APPLIED = "applied"
|
||||
FAILED = "failed"
|
||||
VERIFIED = "verified"
|
||||
|
||||
|
||||
@dataclass
|
||||
class ActionStep:
|
||||
"""A single step in an action plan."""
|
||||
id: str
|
||||
action_type: ActionType
|
||||
description: str
|
||||
target: str # File path or command
|
||||
params: Dict[str, Any] = field(default_factory=dict)
|
||||
status: ActionStatus = ActionStatus.PENDING
|
||||
result: Optional[Any] = None
|
||||
error: Optional[str] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class ActionPlan:
|
||||
"""A plan of actions to execute."""
|
||||
id: str
|
||||
prompt: str
|
||||
steps: List[ActionStep] = field(default_factory=list)
|
||||
created_at: float = field(default_factory=time.time)
|
||||
status: ActionStatus = ActionStatus.PENDING
|
||||
approval_mode: str = "manual"
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"id": self.id,
|
||||
"prompt": self.prompt,
|
||||
"steps": [
|
||||
{
|
||||
"id": s.id,
|
||||
"action_type": s.action_type.value,
|
||||
"description": s.description,
|
||||
"target": s.target,
|
||||
"params": s.params,
|
||||
"status": s.status.value,
|
||||
"result": s.result,
|
||||
"error": s.error
|
||||
}
|
||||
for s in self.steps
|
||||
],
|
||||
"created_at": self.created_at,
|
||||
"status": self.status.value,
|
||||
"approval_mode": self.approval_mode
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class ActionResult:
|
||||
"""Result of action orchestration."""
|
||||
success: bool
|
||||
plan: Optional[ActionPlan] = None
|
||||
applied_steps: int = 0
|
||||
failed_steps: int = 0
|
||||
error: Optional[str] = None
|
||||
read_only_blocked: bool = False
|
||||
diff_summary: Optional[str] = None
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"success": self.success,
|
||||
"plan": self.plan.to_dict() if self.plan else None,
|
||||
"applied_steps": self.applied_steps,
|
||||
"failed_steps": self.failed_steps,
|
||||
"error": self.error,
|
||||
"read_only_blocked": self.read_only_blocked,
|
||||
"diff_summary": self.diff_summary
|
||||
}
|
||||
|
||||
|
||||
class ActionOrchestrator:
|
||||
"""
|
||||
Orchestrates code modifications through ACP.
|
||||
|
||||
All edits must go through:
|
||||
1. Plan creation
|
||||
2. Approval (manual, auto, or scoped)
|
||||
3. Application
|
||||
4. Verification
|
||||
|
||||
If ACP is unavailable, runtime is read-only and edits are blocked.
|
||||
"""
|
||||
|
||||
def __init__(self, runtime: "InteractiveRuntime"):
|
||||
"""Initialize with runtime reference."""
|
||||
self.runtime = runtime
|
||||
self._plan_counter = 0
|
||||
|
||||
def _generate_plan_id(self) -> str:
|
||||
"""Generate a unique plan ID."""
|
||||
self._plan_counter += 1
|
||||
return f"plan_{int(time.time())}_{self._plan_counter}"
|
||||
|
||||
def _generate_step_id(self, plan_id: str, index: int) -> str:
|
||||
"""Generate a unique step ID."""
|
||||
return f"{plan_id}_step_{index}"
|
||||
|
||||
async def create_plan(self, prompt: str) -> ActionResult:
|
||||
"""
|
||||
Create an action plan for a modification request.
|
||||
|
||||
Args:
|
||||
prompt: The user's modification request
|
||||
|
||||
Returns:
|
||||
ActionResult with the plan
|
||||
"""
|
||||
if self.runtime.read_only:
|
||||
return ActionResult(
|
||||
success=False,
|
||||
error="Runtime is in read-only mode. ACP is required for modifications.",
|
||||
read_only_blocked=True
|
||||
)
|
||||
|
||||
plan_id = self._generate_plan_id()
|
||||
|
||||
# Always use fallback plan creation (ACP session tracks but doesn't create plans)
|
||||
# In production, this would integrate with an LLM for intelligent planning
|
||||
return await self._create_fallback_plan(prompt, plan_id)
|
||||
|
||||
async def _create_fallback_plan(self, prompt: str, plan_id: str) -> ActionResult:
|
||||
"""Create a fallback plan when ACP is not available for planning."""
|
||||
# This is a simplified fallback - in production, this would use LLM
|
||||
steps = []
|
||||
|
||||
# Analyze prompt for common patterns
|
||||
prompt_lower = prompt.lower()
|
||||
|
||||
if "create" in prompt_lower or "new file" in prompt_lower:
|
||||
# Extract file path if mentioned
|
||||
import re
|
||||
file_match = re.search(r'(?:create|new)\s+(?:a\s+)?(?:file\s+)?(?:called\s+)?([^\s]+\.\w+)', prompt_lower)
|
||||
target = file_match.group(1) if file_match else "new_file.py"
|
||||
|
||||
# Generate default content based on file type
|
||||
if target.endswith('.py'):
|
||||
content = f'"""\n{target} - Auto-generated file\n"""\n\ndef main():\n pass\n\n\nif __name__ == "__main__":\n main()\n'
|
||||
else:
|
||||
content = f"// {target} - Auto-generated file\n"
|
||||
|
||||
steps.append(ActionStep(
|
||||
id=self._generate_step_id(plan_id, 0),
|
||||
action_type=ActionType.FILE_CREATE,
|
||||
description=f"Create file: {target}",
|
||||
target=target,
|
||||
params={"content": content},
|
||||
status=ActionStatus.APPROVED # Auto-approve for fallback
|
||||
))
|
||||
|
||||
elif "edit" in prompt_lower or "modify" in prompt_lower or "change" in prompt_lower:
|
||||
file_match = re.search(r'(?:edit|modify|change)\s+([^\s]+\.\w+)', prompt_lower)
|
||||
target = file_match.group(1) if file_match else ""
|
||||
|
||||
if target:
|
||||
steps.append(ActionStep(
|
||||
id=self._generate_step_id(plan_id, 0),
|
||||
action_type=ActionType.FILE_EDIT,
|
||||
description=f"Edit file: {target}",
|
||||
target=target,
|
||||
params={"changes": prompt}
|
||||
))
|
||||
|
||||
elif "delete" in prompt_lower or "remove" in prompt_lower:
|
||||
file_match = re.search(r'(?:delete|remove)\s+([^\s]+\.\w+)', prompt_lower)
|
||||
target = file_match.group(1) if file_match else ""
|
||||
|
||||
if target:
|
||||
steps.append(ActionStep(
|
||||
id=self._generate_step_id(plan_id, 0),
|
||||
action_type=ActionType.FILE_DELETE,
|
||||
description=f"Delete file: {target}",
|
||||
target=target
|
||||
))
|
||||
|
||||
elif "rename" in prompt_lower:
|
||||
steps.append(ActionStep(
|
||||
id=self._generate_step_id(plan_id, 0),
|
||||
action_type=ActionType.REFACTOR,
|
||||
description="Rename operation",
|
||||
target="",
|
||||
params={"prompt": prompt}
|
||||
))
|
||||
|
||||
elif "run" in prompt_lower or "execute" in prompt_lower:
|
||||
cmd_match = re.search(r'(?:run|execute)\s+[`"\']?([^`"\']+)[`"\']?', prompt_lower)
|
||||
command = cmd_match.group(1) if cmd_match else ""
|
||||
|
||||
if command:
|
||||
steps.append(ActionStep(
|
||||
id=self._generate_step_id(plan_id, 0),
|
||||
action_type=ActionType.SHELL_COMMAND,
|
||||
description=f"Execute: {command}",
|
||||
target=command
|
||||
))
|
||||
|
||||
if not steps:
|
||||
return ActionResult(
|
||||
success=False,
|
||||
error="Could not determine action from prompt. Please be more specific."
|
||||
)
|
||||
|
||||
plan = ActionPlan(
|
||||
id=plan_id,
|
||||
prompt=prompt,
|
||||
steps=steps,
|
||||
approval_mode=self.runtime.config.approval_mode
|
||||
)
|
||||
|
||||
return ActionResult(
|
||||
success=True,
|
||||
plan=plan
|
||||
)
|
||||
|
||||
def _classify_action_type(self, step_data: Dict[str, Any]) -> ActionType:
|
||||
"""Classify the action type from step data."""
|
||||
action = step_data.get("action", "").lower()
|
||||
|
||||
if "create" in action:
|
||||
return ActionType.FILE_CREATE
|
||||
elif "edit" in action or "modify" in action:
|
||||
return ActionType.FILE_EDIT
|
||||
elif "delete" in action or "remove" in action:
|
||||
return ActionType.FILE_DELETE
|
||||
elif "rename" in action:
|
||||
return ActionType.FILE_RENAME
|
||||
elif "shell" in action or "command" in action or "run" in action:
|
||||
return ActionType.SHELL_COMMAND
|
||||
elif "refactor" in action:
|
||||
return ActionType.REFACTOR
|
||||
|
||||
return ActionType.UNKNOWN
|
||||
|
||||
async def approve_plan(self, plan: ActionPlan, auto: bool = False) -> bool:
|
||||
"""
|
||||
Request approval for a plan.
|
||||
|
||||
Args:
|
||||
plan: The plan to approve
|
||||
auto: Whether to auto-approve
|
||||
|
||||
Returns:
|
||||
True if approved, False if rejected
|
||||
"""
|
||||
if self.runtime.read_only:
|
||||
logger.warning("Cannot approve plan in read-only mode")
|
||||
return False
|
||||
|
||||
approval_mode = self.runtime.config.approval_mode
|
||||
|
||||
if approval_mode == "auto" or auto:
|
||||
plan.status = ActionStatus.APPROVED
|
||||
for step in plan.steps:
|
||||
step.status = ActionStatus.APPROVED
|
||||
return True
|
||||
|
||||
elif approval_mode == "scoped":
|
||||
# Auto-approve safe actions, require manual for dangerous ones
|
||||
dangerous_types = {ActionType.FILE_DELETE, ActionType.SHELL_COMMAND}
|
||||
|
||||
for step in plan.steps:
|
||||
if step.action_type in dangerous_types:
|
||||
step.status = ActionStatus.PENDING # Needs manual approval
|
||||
else:
|
||||
step.status = ActionStatus.APPROVED
|
||||
|
||||
# Plan is approved if all steps are approved
|
||||
if all(s.status == ActionStatus.APPROVED for s in plan.steps):
|
||||
plan.status = ActionStatus.APPROVED
|
||||
return True
|
||||
|
||||
return False # Some steps need manual approval
|
||||
|
||||
else: # manual
|
||||
# In manual mode, we return False to indicate approval is needed
|
||||
return False
|
||||
|
||||
async def apply_plan(self, plan: ActionPlan, force: bool = False) -> ActionResult:
|
||||
"""
|
||||
Apply an approved plan.
|
||||
|
||||
Args:
|
||||
plan: The plan to apply
|
||||
force: Force apply even if not fully approved
|
||||
|
||||
Returns:
|
||||
ActionResult with application status
|
||||
"""
|
||||
if self.runtime.read_only:
|
||||
return ActionResult(
|
||||
success=False,
|
||||
plan=plan,
|
||||
error="Runtime is in read-only mode",
|
||||
read_only_blocked=True
|
||||
)
|
||||
|
||||
if plan.status != ActionStatus.APPROVED and not force:
|
||||
return ActionResult(
|
||||
success=False,
|
||||
plan=plan,
|
||||
error="Plan is not approved"
|
||||
)
|
||||
|
||||
applied = 0
|
||||
failed = 0
|
||||
diff_parts = []
|
||||
|
||||
# Track in ACP session if available (but always do manual application)
|
||||
if self.runtime.acp_ready:
|
||||
try:
|
||||
auto_approve = self.runtime.config.approval_mode == "auto"
|
||||
await self.runtime.acp_apply_plan(
|
||||
plan.to_dict(),
|
||||
auto_approve=auto_approve
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"ACP tracking failed: {e}")
|
||||
|
||||
# Manual application (always execute)
|
||||
for step in plan.steps:
|
||||
if step.status not in [ActionStatus.APPROVED, ActionStatus.PENDING]:
|
||||
continue
|
||||
|
||||
try:
|
||||
result = await self._apply_step(step)
|
||||
if result:
|
||||
step.status = ActionStatus.APPLIED
|
||||
step.result = result
|
||||
applied += 1
|
||||
if isinstance(result, dict) and "diff" in result:
|
||||
diff_parts.append(result["diff"])
|
||||
else:
|
||||
step.status = ActionStatus.FAILED
|
||||
failed += 1
|
||||
except Exception as e:
|
||||
step.status = ActionStatus.FAILED
|
||||
step.error = str(e)
|
||||
failed += 1
|
||||
|
||||
plan.status = ActionStatus.APPLIED if failed == 0 else ActionStatus.FAILED
|
||||
|
||||
return ActionResult(
|
||||
success=failed == 0,
|
||||
plan=plan,
|
||||
applied_steps=applied,
|
||||
failed_steps=failed,
|
||||
diff_summary="\n".join(diff_parts) if diff_parts else None
|
||||
)
|
||||
|
||||
async def _apply_step(self, step: ActionStep) -> Optional[Dict[str, Any]]:
|
||||
"""Apply a single step."""
|
||||
workspace = Path(self.runtime.config.workspace)
|
||||
|
||||
if step.action_type == ActionType.FILE_CREATE:
|
||||
target = workspace / step.target
|
||||
target.parent.mkdir(parents=True, exist_ok=True)
|
||||
content = step.params.get("content", "")
|
||||
target.write_text(content)
|
||||
return {"created": str(target), "diff": f"+++ {target}\n+ (new file)"}
|
||||
|
||||
elif step.action_type == ActionType.FILE_EDIT:
|
||||
target = workspace / step.target
|
||||
if not target.exists():
|
||||
return None
|
||||
|
||||
old_content = target.read_text()
|
||||
new_content = step.params.get("new_content", old_content)
|
||||
target.write_text(new_content)
|
||||
|
||||
return {
|
||||
"edited": str(target),
|
||||
"diff": f"--- {target}\n+++ {target}\n(content changed)"
|
||||
}
|
||||
|
||||
elif step.action_type == ActionType.FILE_DELETE:
|
||||
target = workspace / step.target
|
||||
if target.exists():
|
||||
target.unlink()
|
||||
return {"deleted": str(target), "diff": f"--- {target}\n- (deleted)"}
|
||||
return None
|
||||
|
||||
elif step.action_type == ActionType.FILE_RENAME:
|
||||
source = workspace / step.params.get("source", "")
|
||||
dest = workspace / step.params.get("dest", "")
|
||||
if source.exists():
|
||||
source.rename(dest)
|
||||
return {"renamed": f"{source} -> {dest}"}
|
||||
return None
|
||||
|
||||
elif step.action_type == ActionType.SHELL_COMMAND:
|
||||
import subprocess
|
||||
result = subprocess.run(
|
||||
step.target,
|
||||
shell=True,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
cwd=str(workspace),
|
||||
timeout=30
|
||||
)
|
||||
return {
|
||||
"command": step.target,
|
||||
"stdout": result.stdout,
|
||||
"stderr": result.stderr,
|
||||
"returncode": result.returncode
|
||||
}
|
||||
|
||||
return None
|
||||
|
||||
async def verify_plan(self, plan: ActionPlan) -> ActionResult:
|
||||
"""
|
||||
Verify that a plan was applied correctly.
|
||||
|
||||
Args:
|
||||
plan: The plan to verify
|
||||
|
||||
Returns:
|
||||
ActionResult with verification status
|
||||
"""
|
||||
if plan.status != ActionStatus.APPLIED:
|
||||
return ActionResult(
|
||||
success=False,
|
||||
plan=plan,
|
||||
error="Plan was not applied"
|
||||
)
|
||||
|
||||
workspace = Path(self.runtime.config.workspace)
|
||||
verified = 0
|
||||
failed = 0
|
||||
|
||||
for step in plan.steps:
|
||||
if step.status != ActionStatus.APPLIED:
|
||||
continue
|
||||
|
||||
try:
|
||||
if step.action_type == ActionType.FILE_CREATE:
|
||||
target = workspace / step.target
|
||||
if target.exists():
|
||||
step.status = ActionStatus.VERIFIED
|
||||
verified += 1
|
||||
else:
|
||||
step.status = ActionStatus.FAILED
|
||||
step.error = "File was not created"
|
||||
failed += 1
|
||||
|
||||
elif step.action_type == ActionType.FILE_DELETE:
|
||||
target = workspace / step.target
|
||||
if not target.exists():
|
||||
step.status = ActionStatus.VERIFIED
|
||||
verified += 1
|
||||
else:
|
||||
step.status = ActionStatus.FAILED
|
||||
step.error = "File was not deleted"
|
||||
failed += 1
|
||||
|
||||
else:
|
||||
# For other types, assume verified if applied
|
||||
step.status = ActionStatus.VERIFIED
|
||||
verified += 1
|
||||
|
||||
except Exception as e:
|
||||
step.status = ActionStatus.FAILED
|
||||
step.error = str(e)
|
||||
failed += 1
|
||||
|
||||
plan.status = ActionStatus.VERIFIED if failed == 0 else ActionStatus.FAILED
|
||||
|
||||
return ActionResult(
|
||||
success=failed == 0,
|
||||
plan=plan,
|
||||
applied_steps=verified,
|
||||
failed_steps=failed
|
||||
)
|
||||
|
||||
async def execute(self, prompt: str, auto_approve: bool = False) -> ActionResult:
|
||||
"""
|
||||
Execute a full plan → approve → apply → verify cycle.
|
||||
|
||||
Args:
|
||||
prompt: The modification request
|
||||
auto_approve: Whether to auto-approve
|
||||
|
||||
Returns:
|
||||
ActionResult with final status
|
||||
"""
|
||||
# Create plan
|
||||
result = await self.create_plan(prompt)
|
||||
if not result.success:
|
||||
return result
|
||||
|
||||
plan = result.plan
|
||||
|
||||
# Approve
|
||||
approved = await self.approve_plan(plan, auto=auto_approve)
|
||||
if not approved and self.runtime.config.approval_mode == "manual":
|
||||
return ActionResult(
|
||||
success=False,
|
||||
plan=plan,
|
||||
error="Plan requires manual approval"
|
||||
)
|
||||
|
||||
# Apply
|
||||
result = await self.apply_plan(plan)
|
||||
if not result.success:
|
||||
return result
|
||||
|
||||
# Verify
|
||||
return await self.verify_plan(plan)
|
||||
@@ -0,0 +1,474 @@
|
||||
"""
|
||||
Agent-Centric Tools for PraisonAI Interactive Mode.
|
||||
|
||||
These tools route file operations and code intelligence through LSP/ACP,
|
||||
making the Agent the central orchestrator for all actions.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
from typing import Callable, Dict, List, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .interactive_runtime import InteractiveRuntime
|
||||
from .code_intelligence import CodeIntelligenceRouter
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def create_agent_centric_tools(
|
||||
runtime: "InteractiveRuntime",
|
||||
router: "CodeIntelligenceRouter" = None,
|
||||
orchestrator: "ActionOrchestrator" = None
|
||||
) -> List[Callable]:
|
||||
"""
|
||||
Create tools that route through LSP/ACP for agent-centric architecture.
|
||||
|
||||
Args:
|
||||
runtime: The InteractiveRuntime instance
|
||||
router: Optional CodeIntelligenceRouter (created if not provided)
|
||||
orchestrator: Optional ActionOrchestrator (created if not provided)
|
||||
|
||||
Returns:
|
||||
List of tool functions for the Agent
|
||||
"""
|
||||
from .code_intelligence import CodeIntelligenceRouter
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
|
||||
if router is None:
|
||||
router = CodeIntelligenceRouter(runtime)
|
||||
if orchestrator is None:
|
||||
orchestrator = ActionOrchestrator(runtime)
|
||||
|
||||
# Helper to run async functions synchronously
|
||||
def run_async(coro):
|
||||
"""Run async coroutine synchronously."""
|
||||
try:
|
||||
loop = asyncio.get_event_loop()
|
||||
if loop.is_running():
|
||||
# Create a new loop in a thread
|
||||
import concurrent.futures
|
||||
with concurrent.futures.ThreadPoolExecutor() as executor:
|
||||
future = executor.submit(asyncio.run, coro)
|
||||
return future.result(timeout=60)
|
||||
else:
|
||||
return loop.run_until_complete(coro)
|
||||
except RuntimeError:
|
||||
return asyncio.run(coro)
|
||||
|
||||
# =========================================================================
|
||||
# ACP-Powered File Tools
|
||||
# =========================================================================
|
||||
|
||||
def acp_create_file(filepath: str, content: str) -> str:
|
||||
"""
|
||||
Create a file through ACP with plan/approve/apply/verify flow.
|
||||
|
||||
This tool routes file creation through the ActionOrchestrator,
|
||||
ensuring proper tracking, approval, and verification.
|
||||
|
||||
Args:
|
||||
filepath: Path to the file to create (relative to workspace)
|
||||
content: Content to write to the file
|
||||
|
||||
Returns:
|
||||
JSON string with result including plan status and verification
|
||||
"""
|
||||
async def _create():
|
||||
# Build a detailed prompt for the orchestrator
|
||||
prompt = f"create file {filepath}"
|
||||
|
||||
# Create plan
|
||||
result = await orchestrator.create_plan(prompt)
|
||||
if not result.success:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": result.error,
|
||||
"read_only": result.read_only_blocked
|
||||
})
|
||||
|
||||
plan = result.plan
|
||||
|
||||
# Update the plan step with actual content
|
||||
if plan.steps:
|
||||
plan.steps[0].params["content"] = content
|
||||
|
||||
# Approve based on runtime config
|
||||
auto_approve = runtime.config.approval_mode == "auto"
|
||||
approved = await orchestrator.approve_plan(plan, auto=auto_approve)
|
||||
|
||||
if not approved and runtime.config.approval_mode == "manual":
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": "Manual approval required",
|
||||
"plan": plan.to_dict(),
|
||||
"requires_approval": True
|
||||
})
|
||||
|
||||
# Apply the plan
|
||||
result = await orchestrator.apply_plan(plan, force=auto_approve)
|
||||
if not result.success:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": result.error,
|
||||
"plan": plan.to_dict()
|
||||
})
|
||||
|
||||
# Verify
|
||||
result = await orchestrator.verify_plan(plan)
|
||||
|
||||
return json.dumps({
|
||||
"success": result.success,
|
||||
"file_created": filepath,
|
||||
"plan_id": plan.id,
|
||||
"status": plan.status.value,
|
||||
"verified": result.success
|
||||
})
|
||||
|
||||
return run_async(_create())
|
||||
|
||||
def acp_edit_file(filepath: str, new_content: str) -> str:
|
||||
"""
|
||||
Edit a file through ACP with plan/approve/apply/verify flow.
|
||||
|
||||
Args:
|
||||
filepath: Path to the file to edit (relative to workspace)
|
||||
new_content: New content for the file
|
||||
|
||||
Returns:
|
||||
JSON string with result including plan status
|
||||
"""
|
||||
async def _edit():
|
||||
prompt = f"edit file {filepath}"
|
||||
|
||||
result = await orchestrator.create_plan(prompt)
|
||||
if not result.success:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": result.error,
|
||||
"read_only": result.read_only_blocked
|
||||
})
|
||||
|
||||
plan = result.plan
|
||||
|
||||
# Update step with new content
|
||||
if plan.steps:
|
||||
plan.steps[0].params["new_content"] = new_content
|
||||
|
||||
auto_approve = runtime.config.approval_mode == "auto"
|
||||
approved = await orchestrator.approve_plan(plan, auto=auto_approve)
|
||||
|
||||
if not approved and runtime.config.approval_mode == "manual":
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": "Manual approval required",
|
||||
"requires_approval": True
|
||||
})
|
||||
|
||||
result = await orchestrator.apply_plan(plan, force=auto_approve)
|
||||
|
||||
return json.dumps({
|
||||
"success": result.success,
|
||||
"file_edited": filepath,
|
||||
"plan_id": plan.id,
|
||||
"error": result.error
|
||||
})
|
||||
|
||||
return run_async(_edit())
|
||||
|
||||
def acp_delete_file(filepath: str) -> str:
|
||||
"""
|
||||
Delete a file through ACP with plan/approve/apply/verify flow.
|
||||
|
||||
Args:
|
||||
filepath: Path to the file to delete
|
||||
|
||||
Returns:
|
||||
JSON string with result
|
||||
"""
|
||||
async def _delete():
|
||||
prompt = f"delete file {filepath}"
|
||||
|
||||
result = await orchestrator.create_plan(prompt)
|
||||
if not result.success:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": result.error
|
||||
})
|
||||
|
||||
plan = result.plan
|
||||
|
||||
# Delete requires explicit approval even in auto mode
|
||||
auto_approve = runtime.config.approval_mode == "auto"
|
||||
approved = await orchestrator.approve_plan(plan, auto=auto_approve)
|
||||
|
||||
if not approved:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": "Delete requires approval",
|
||||
"requires_approval": True
|
||||
})
|
||||
|
||||
result = await orchestrator.apply_plan(plan)
|
||||
result = await orchestrator.verify_plan(plan)
|
||||
|
||||
return json.dumps({
|
||||
"success": result.success,
|
||||
"file_deleted": filepath,
|
||||
"verified": result.success
|
||||
})
|
||||
|
||||
return run_async(_delete())
|
||||
|
||||
def acp_execute_command(command: str, cwd: str = None) -> str:
|
||||
"""
|
||||
Execute a shell command through ACP with tracking.
|
||||
|
||||
Args:
|
||||
command: The command to execute
|
||||
cwd: Working directory (optional)
|
||||
|
||||
Returns:
|
||||
JSON string with command output
|
||||
"""
|
||||
async def _execute():
|
||||
prompt = f"run command: {command}"
|
||||
|
||||
result = await orchestrator.create_plan(prompt)
|
||||
if not result.success:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": result.error
|
||||
})
|
||||
|
||||
plan = result.plan
|
||||
|
||||
# Commands require approval
|
||||
auto_approve = runtime.config.approval_mode == "auto"
|
||||
approved = await orchestrator.approve_plan(plan, auto=auto_approve)
|
||||
|
||||
if not approved:
|
||||
return json.dumps({
|
||||
"success": False,
|
||||
"error": "Command requires approval",
|
||||
"requires_approval": True
|
||||
})
|
||||
|
||||
result = await orchestrator.apply_plan(plan)
|
||||
|
||||
# Extract command result
|
||||
if plan.steps and plan.steps[0].result:
|
||||
cmd_result = plan.steps[0].result
|
||||
return json.dumps({
|
||||
"success": result.success,
|
||||
"command": command,
|
||||
"stdout": cmd_result.get("stdout", ""),
|
||||
"stderr": cmd_result.get("stderr", ""),
|
||||
"returncode": cmd_result.get("returncode", -1)
|
||||
})
|
||||
|
||||
return json.dumps({
|
||||
"success": result.success,
|
||||
"error": result.error
|
||||
})
|
||||
|
||||
return run_async(_execute())
|
||||
|
||||
# =========================================================================
|
||||
# LSP-Powered Code Intelligence Tools
|
||||
# =========================================================================
|
||||
|
||||
def lsp_list_symbols(file_path: str) -> str:
|
||||
"""
|
||||
List all symbols (functions, classes, methods) in a file using LSP.
|
||||
|
||||
Falls back to regex-based extraction if LSP is unavailable.
|
||||
|
||||
Args:
|
||||
file_path: Path to the file to analyze
|
||||
|
||||
Returns:
|
||||
JSON string with list of symbols and their locations
|
||||
"""
|
||||
async def _list():
|
||||
result = await router.handle_query(
|
||||
f"list all functions and classes in {file_path}",
|
||||
file_path=file_path
|
||||
)
|
||||
return json.dumps(result.to_dict())
|
||||
|
||||
return run_async(_list())
|
||||
|
||||
def lsp_find_definition(symbol: str, file_path: str = None) -> str:
|
||||
"""
|
||||
Find where a symbol is defined using LSP.
|
||||
|
||||
Args:
|
||||
symbol: The symbol name to find
|
||||
file_path: Optional file path for context
|
||||
|
||||
Returns:
|
||||
JSON string with definition location(s)
|
||||
"""
|
||||
async def _find():
|
||||
query = f"where is {symbol} defined"
|
||||
if file_path:
|
||||
query += f" in {file_path}"
|
||||
|
||||
result = await router.handle_query(query, file_path=file_path)
|
||||
return json.dumps(result.to_dict())
|
||||
|
||||
return run_async(_find())
|
||||
|
||||
def lsp_find_references(symbol: str, file_path: str = None) -> str:
|
||||
"""
|
||||
Find all references to a symbol using LSP.
|
||||
|
||||
Args:
|
||||
symbol: The symbol name to find references for
|
||||
file_path: Optional file path for context
|
||||
|
||||
Returns:
|
||||
JSON string with reference locations
|
||||
"""
|
||||
async def _find():
|
||||
query = f"find all references to {symbol}"
|
||||
if file_path:
|
||||
query += f" in {file_path}"
|
||||
|
||||
result = await router.handle_query(query, file_path=file_path)
|
||||
return json.dumps(result.to_dict())
|
||||
|
||||
return run_async(_find())
|
||||
|
||||
def lsp_get_diagnostics(file_path: str = None) -> str:
|
||||
"""
|
||||
Get diagnostics (errors, warnings) for a file using LSP.
|
||||
|
||||
Args:
|
||||
file_path: Path to the file (optional, gets all if not specified)
|
||||
|
||||
Returns:
|
||||
JSON string with diagnostic information
|
||||
"""
|
||||
async def _get():
|
||||
query = "show all errors and warnings"
|
||||
if file_path:
|
||||
query += f" in {file_path}"
|
||||
|
||||
result = await router.handle_query(query, file_path=file_path)
|
||||
return json.dumps(result.to_dict())
|
||||
|
||||
return run_async(_get())
|
||||
|
||||
# =========================================================================
|
||||
# Basic File Tools (for read-only operations)
|
||||
# =========================================================================
|
||||
|
||||
def read_file(filepath: str) -> str:
|
||||
"""
|
||||
Read content from a file.
|
||||
|
||||
This is a read-only operation that doesn't require ACP.
|
||||
|
||||
Args:
|
||||
filepath: Path to the file to read
|
||||
|
||||
Returns:
|
||||
File content or error message
|
||||
"""
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
path = Path(filepath)
|
||||
if not path.is_absolute():
|
||||
path = Path(runtime.config.workspace) / filepath
|
||||
|
||||
if not path.exists():
|
||||
return json.dumps({"error": f"File not found: {filepath}"})
|
||||
|
||||
content = path.read_text()
|
||||
|
||||
# Track in trace if enabled
|
||||
if runtime._trace:
|
||||
runtime._trace.add_entry(
|
||||
category="file",
|
||||
action="read",
|
||||
params={"file": str(path)},
|
||||
result={"size": len(content)}
|
||||
)
|
||||
|
||||
return content
|
||||
|
||||
except Exception as e:
|
||||
return json.dumps({"error": str(e)})
|
||||
|
||||
def list_files(directory: str = ".", pattern: str = "*") -> str:
|
||||
"""
|
||||
List files in a directory.
|
||||
|
||||
Args:
|
||||
directory: Directory to list (relative to workspace)
|
||||
pattern: Glob pattern to filter files
|
||||
|
||||
Returns:
|
||||
JSON string with list of files
|
||||
"""
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
path = Path(directory)
|
||||
if not path.is_absolute():
|
||||
path = Path(runtime.config.workspace) / directory
|
||||
|
||||
if not path.exists():
|
||||
return json.dumps({"error": f"Directory not found: {directory}"})
|
||||
|
||||
files = []
|
||||
for f in path.glob(pattern):
|
||||
files.append({
|
||||
"name": f.name,
|
||||
"path": str(f.relative_to(runtime.config.workspace)),
|
||||
"is_dir": f.is_dir(),
|
||||
"size": f.stat().st_size if f.is_file() else None
|
||||
})
|
||||
|
||||
return json.dumps({"files": files, "count": len(files)})
|
||||
|
||||
except Exception as e:
|
||||
return json.dumps({"error": str(e)})
|
||||
|
||||
# Return all tools
|
||||
return [
|
||||
# ACP-powered file tools
|
||||
acp_create_file,
|
||||
acp_edit_file,
|
||||
acp_delete_file,
|
||||
acp_execute_command,
|
||||
# LSP-powered code intelligence
|
||||
lsp_list_symbols,
|
||||
lsp_find_definition,
|
||||
lsp_find_references,
|
||||
lsp_get_diagnostics,
|
||||
# Basic read-only tools
|
||||
read_file,
|
||||
list_files,
|
||||
]
|
||||
|
||||
|
||||
def get_tool_descriptions() -> Dict[str, str]:
|
||||
"""Get descriptions of all agent-centric tools."""
|
||||
return {
|
||||
"acp_create_file": "Create a file through ACP with plan/approve/apply/verify",
|
||||
"acp_edit_file": "Edit a file through ACP with tracking",
|
||||
"acp_delete_file": "Delete a file through ACP (requires approval)",
|
||||
"acp_execute_command": "Execute a shell command through ACP",
|
||||
"lsp_list_symbols": "List symbols in a file using LSP",
|
||||
"lsp_find_definition": "Find where a symbol is defined",
|
||||
"lsp_find_references": "Find all references to a symbol",
|
||||
"lsp_get_diagnostics": "Get errors and warnings for a file",
|
||||
"read_file": "Read content from a file (read-only)",
|
||||
"list_files": "List files in a directory",
|
||||
}
|
||||
@@ -0,0 +1,652 @@
|
||||
"""
|
||||
Code Intelligence Router for PraisonAI.
|
||||
|
||||
Routes code-related queries to LSP when available, with fallback to grep/file search.
|
||||
"""
|
||||
|
||||
import logging
|
||||
import re
|
||||
from dataclasses import dataclass
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .interactive_runtime import InteractiveRuntime
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class CodeIntent(Enum):
|
||||
"""Classification of code-related intents."""
|
||||
LIST_SYMBOLS = "list_symbols"
|
||||
GO_TO_DEFINITION = "go_to_definition"
|
||||
FIND_REFERENCES = "find_references"
|
||||
GET_DIAGNOSTICS = "get_diagnostics"
|
||||
EXPLAIN_CODE = "explain_code"
|
||||
SEARCH_CODE = "search_code"
|
||||
UNKNOWN = "unknown"
|
||||
|
||||
|
||||
@dataclass
|
||||
class CodeQueryResult:
|
||||
"""Result of a code intelligence query."""
|
||||
intent: CodeIntent
|
||||
success: bool
|
||||
lsp_used: bool
|
||||
data: Any = None
|
||||
citations: List[Dict[str, Any]] = None
|
||||
error: Optional[str] = None
|
||||
fallback_used: bool = False
|
||||
|
||||
def __post_init__(self):
|
||||
if self.citations is None:
|
||||
self.citations = []
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"intent": self.intent.value,
|
||||
"success": self.success,
|
||||
"lsp_used": self.lsp_used,
|
||||
"data": self.data,
|
||||
"citations": self.citations,
|
||||
"error": self.error,
|
||||
"fallback_used": self.fallback_used
|
||||
}
|
||||
|
||||
|
||||
class CodeIntelligenceRouter:
|
||||
"""
|
||||
Routes code intelligence queries to LSP or fallback mechanisms.
|
||||
|
||||
LSP-first approach:
|
||||
- If LSP is available, use it for semantic queries
|
||||
- If LSP fails or unavailable, fall back to grep/file search
|
||||
- Always provide citations with file:line references
|
||||
"""
|
||||
|
||||
# Patterns for intent classification
|
||||
INTENT_PATTERNS = {
|
||||
CodeIntent.LIST_SYMBOLS: [
|
||||
r"list\s+(all\s+)?(functions?|classes?|methods?|symbols?)",
|
||||
r"what\s+(functions?|classes?|methods?)\s+(are|exist)",
|
||||
r"show\s+(me\s+)?(all\s+)?(functions?|classes?|symbols?)",
|
||||
r"find\s+(all\s+)?(functions?|classes?|methods?)",
|
||||
],
|
||||
CodeIntent.GO_TO_DEFINITION: [
|
||||
r"(go\s+to|find|show|where\s+is)\s+(the\s+)?definition",
|
||||
r"where\s+is\s+(\w+)\s+defined",
|
||||
r"definition\s+of\s+(\w+)",
|
||||
r"(\w+)\s+is\s+defined\s+where",
|
||||
],
|
||||
CodeIntent.FIND_REFERENCES: [
|
||||
r"(find|show|list)\s+(all\s+)?references",
|
||||
r"where\s+is\s+(\w+)\s+used",
|
||||
r"usages?\s+of\s+(\w+)",
|
||||
r"who\s+(calls?|uses?)\s+(\w+)",
|
||||
],
|
||||
CodeIntent.GET_DIAGNOSTICS: [
|
||||
r"(show|list|get)\s+(all\s+)?(errors?|warnings?|diagnostics?|problems?)",
|
||||
r"what('s|\s+is)\s+wrong",
|
||||
r"any\s+(errors?|issues?|problems?)",
|
||||
r"check\s+(for\s+)?(errors?|issues?)",
|
||||
],
|
||||
CodeIntent.EXPLAIN_CODE: [
|
||||
r"explain\s+(this|the)\s+code",
|
||||
r"what\s+does\s+(this|the)\s+code\s+do",
|
||||
r"how\s+does\s+(\w+)\s+work",
|
||||
],
|
||||
CodeIntent.SEARCH_CODE: [
|
||||
r"search\s+(for\s+)?",
|
||||
r"find\s+(the\s+)?string",
|
||||
r"grep\s+",
|
||||
],
|
||||
}
|
||||
|
||||
def __init__(self, runtime: "InteractiveRuntime"):
|
||||
"""Initialize with runtime reference."""
|
||||
self.runtime = runtime
|
||||
|
||||
def classify_intent(self, query: str) -> CodeIntent:
|
||||
"""Classify the intent of a code query."""
|
||||
query_lower = query.lower()
|
||||
|
||||
for intent, patterns in self.INTENT_PATTERNS.items():
|
||||
for pattern in patterns:
|
||||
if re.search(pattern, query_lower):
|
||||
return intent
|
||||
|
||||
return CodeIntent.UNKNOWN
|
||||
|
||||
async def handle_query(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""
|
||||
Handle a code intelligence query.
|
||||
|
||||
Args:
|
||||
query: The user's query
|
||||
file_path: Optional file path context
|
||||
|
||||
Returns:
|
||||
CodeQueryResult with data and citations
|
||||
"""
|
||||
intent = self.classify_intent(query)
|
||||
|
||||
if intent == CodeIntent.LIST_SYMBOLS:
|
||||
return await self._handle_list_symbols(query, file_path)
|
||||
elif intent == CodeIntent.GO_TO_DEFINITION:
|
||||
return await self._handle_go_to_definition(query, file_path)
|
||||
elif intent == CodeIntent.FIND_REFERENCES:
|
||||
return await self._handle_find_references(query, file_path)
|
||||
elif intent == CodeIntent.GET_DIAGNOSTICS:
|
||||
return await self._handle_get_diagnostics(query, file_path)
|
||||
elif intent == CodeIntent.SEARCH_CODE:
|
||||
return await self._handle_search_code(query, file_path)
|
||||
else:
|
||||
return CodeQueryResult(
|
||||
intent=intent,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="Could not determine code query intent"
|
||||
)
|
||||
|
||||
async def _handle_list_symbols(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""Handle list symbols query."""
|
||||
if not file_path:
|
||||
# Try to find a file from the query
|
||||
file_path = self._extract_file_from_query(query)
|
||||
|
||||
if not file_path:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.LIST_SYMBOLS,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="No file specified. Please specify a file path."
|
||||
)
|
||||
|
||||
# Try LSP first
|
||||
if self.runtime.lsp_ready:
|
||||
try:
|
||||
symbols = await self.runtime.lsp_get_symbols(file_path)
|
||||
if symbols:
|
||||
citations = [
|
||||
{"file": file_path, "type": "symbols", "count": len(symbols)}
|
||||
]
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.LIST_SYMBOLS,
|
||||
success=True,
|
||||
lsp_used=True,
|
||||
data=symbols,
|
||||
citations=citations
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"LSP symbols failed: {e}")
|
||||
|
||||
# Fallback to regex-based symbol extraction
|
||||
return await self._fallback_list_symbols(file_path)
|
||||
|
||||
async def _fallback_list_symbols(self, file_path: str) -> CodeQueryResult:
|
||||
"""Fallback symbol listing using regex."""
|
||||
try:
|
||||
path = Path(file_path)
|
||||
if not path.exists():
|
||||
path = Path(self.runtime.config.workspace) / file_path
|
||||
|
||||
if not path.exists():
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.LIST_SYMBOLS,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=f"File not found: {file_path}"
|
||||
)
|
||||
|
||||
content = path.read_text()
|
||||
symbols = []
|
||||
|
||||
# Python patterns
|
||||
if path.suffix == ".py":
|
||||
# Functions
|
||||
for match in re.finditer(r'^(async\s+)?def\s+(\w+)\s*\(', content, re.MULTILINE):
|
||||
line_num = content[:match.start()].count('\n') + 1
|
||||
symbols.append({
|
||||
"name": match.group(2),
|
||||
"kind": "function",
|
||||
"line": line_num
|
||||
})
|
||||
# Classes
|
||||
for match in re.finditer(r'^class\s+(\w+)\s*[:\(]', content, re.MULTILINE):
|
||||
line_num = content[:match.start()].count('\n') + 1
|
||||
symbols.append({
|
||||
"name": match.group(1),
|
||||
"kind": "class",
|
||||
"line": line_num
|
||||
})
|
||||
|
||||
# JavaScript/TypeScript patterns
|
||||
elif path.suffix in [".js", ".ts", ".jsx", ".tsx"]:
|
||||
# Functions
|
||||
for match in re.finditer(r'(?:async\s+)?function\s+(\w+)\s*\(', content):
|
||||
line_num = content[:match.start()].count('\n') + 1
|
||||
symbols.append({
|
||||
"name": match.group(1),
|
||||
"kind": "function",
|
||||
"line": line_num
|
||||
})
|
||||
# Arrow functions assigned to const/let/var
|
||||
for match in re.finditer(r'(?:const|let|var)\s+(\w+)\s*=\s*(?:async\s+)?\(', content):
|
||||
line_num = content[:match.start()].count('\n') + 1
|
||||
symbols.append({
|
||||
"name": match.group(1),
|
||||
"kind": "function",
|
||||
"line": line_num
|
||||
})
|
||||
# Classes
|
||||
for match in re.finditer(r'class\s+(\w+)\s*(?:extends|implements|{)', content):
|
||||
line_num = content[:match.start()].count('\n') + 1
|
||||
symbols.append({
|
||||
"name": match.group(1),
|
||||
"kind": "class",
|
||||
"line": line_num
|
||||
})
|
||||
|
||||
citations = [
|
||||
{"file": str(path), "type": "symbols", "count": len(symbols)}
|
||||
]
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.LIST_SYMBOLS,
|
||||
success=True,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
data=symbols,
|
||||
citations=citations
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.LIST_SYMBOLS,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
async def _handle_go_to_definition(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""Handle go to definition query."""
|
||||
# Extract symbol name from query
|
||||
symbol = self._extract_symbol_from_query(query)
|
||||
|
||||
if not symbol:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GO_TO_DEFINITION,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="Could not identify symbol to find definition for"
|
||||
)
|
||||
|
||||
if not file_path:
|
||||
file_path = self._extract_file_from_query(query)
|
||||
|
||||
# Try LSP first
|
||||
if self.runtime.lsp_ready and file_path:
|
||||
try:
|
||||
# Need to find the symbol position first
|
||||
line, col = await self._find_symbol_position(file_path, symbol)
|
||||
if line is not None:
|
||||
definitions = await self.runtime.lsp_get_definition(file_path, line, col)
|
||||
if definitions:
|
||||
citations = [
|
||||
{"file": d.get("uri", "").replace("file://", ""),
|
||||
"line": d.get("range", {}).get("start", {}).get("line", 0) + 1,
|
||||
"type": "definition"}
|
||||
for d in definitions
|
||||
]
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GO_TO_DEFINITION,
|
||||
success=True,
|
||||
lsp_used=True,
|
||||
data={"symbol": symbol, "definitions": definitions},
|
||||
citations=citations
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"LSP definition failed: {e}")
|
||||
|
||||
# Fallback to grep
|
||||
return await self._fallback_find_definition(symbol)
|
||||
|
||||
async def _fallback_find_definition(self, symbol: str) -> CodeQueryResult:
|
||||
"""Fallback definition finding using grep."""
|
||||
try:
|
||||
import subprocess
|
||||
workspace = self.runtime.config.workspace
|
||||
|
||||
# Search for definition patterns
|
||||
patterns = [
|
||||
f"def {symbol}\\s*\\(", # Python function
|
||||
f"class {symbol}\\s*[:\\(]", # Python class
|
||||
f"function {symbol}\\s*\\(", # JS function
|
||||
f"const {symbol}\\s*=", # JS const
|
||||
f"let {symbol}\\s*=", # JS let
|
||||
]
|
||||
|
||||
results = []
|
||||
for pattern in patterns:
|
||||
try:
|
||||
result = subprocess.run(
|
||||
["grep", "-rn", "-E", pattern, workspace],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=5
|
||||
)
|
||||
if result.stdout:
|
||||
for line in result.stdout.strip().split('\n'):
|
||||
if line:
|
||||
parts = line.split(':', 2)
|
||||
if len(parts) >= 2:
|
||||
results.append({
|
||||
"file": parts[0],
|
||||
"line": int(parts[1]),
|
||||
"content": parts[2] if len(parts) > 2 else ""
|
||||
})
|
||||
except subprocess.TimeoutExpired:
|
||||
pass
|
||||
|
||||
if results:
|
||||
citations = [
|
||||
{"file": r["file"], "line": r["line"], "type": "definition"}
|
||||
for r in results
|
||||
]
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GO_TO_DEFINITION,
|
||||
success=True,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
data={"symbol": symbol, "definitions": results},
|
||||
citations=citations
|
||||
)
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GO_TO_DEFINITION,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=f"Definition for '{symbol}' not found"
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GO_TO_DEFINITION,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
async def _handle_find_references(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""Handle find references query."""
|
||||
symbol = self._extract_symbol_from_query(query)
|
||||
|
||||
if not symbol:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.FIND_REFERENCES,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="Could not identify symbol to find references for"
|
||||
)
|
||||
|
||||
if not file_path:
|
||||
file_path = self._extract_file_from_query(query)
|
||||
|
||||
# Try LSP first
|
||||
if self.runtime.lsp_ready and file_path:
|
||||
try:
|
||||
line, col = await self._find_symbol_position(file_path, symbol)
|
||||
if line is not None:
|
||||
references = await self.runtime.lsp_get_references(file_path, line, col)
|
||||
if references:
|
||||
citations = [
|
||||
{"file": r.get("uri", "").replace("file://", ""),
|
||||
"line": r.get("range", {}).get("start", {}).get("line", 0) + 1,
|
||||
"type": "reference"}
|
||||
for r in references
|
||||
]
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.FIND_REFERENCES,
|
||||
success=True,
|
||||
lsp_used=True,
|
||||
data={"symbol": symbol, "references": references},
|
||||
citations=citations
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"LSP references failed: {e}")
|
||||
|
||||
# Fallback to grep
|
||||
return await self._fallback_find_references(symbol)
|
||||
|
||||
async def _fallback_find_references(self, symbol: str) -> CodeQueryResult:
|
||||
"""Fallback reference finding using grep."""
|
||||
try:
|
||||
import subprocess
|
||||
workspace = self.runtime.config.workspace
|
||||
|
||||
result = subprocess.run(
|
||||
["grep", "-rn", "-w", symbol, workspace],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=10
|
||||
)
|
||||
|
||||
results = []
|
||||
if result.stdout:
|
||||
for line in result.stdout.strip().split('\n'):
|
||||
if line:
|
||||
parts = line.split(':', 2)
|
||||
if len(parts) >= 2:
|
||||
results.append({
|
||||
"file": parts[0],
|
||||
"line": int(parts[1]),
|
||||
"content": parts[2] if len(parts) > 2 else ""
|
||||
})
|
||||
|
||||
if results:
|
||||
citations = [
|
||||
{"file": r["file"], "line": r["line"], "type": "reference"}
|
||||
for r in results
|
||||
]
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.FIND_REFERENCES,
|
||||
success=True,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
data={"symbol": symbol, "references": results},
|
||||
citations=citations
|
||||
)
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.FIND_REFERENCES,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=f"No references found for '{symbol}'"
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.FIND_REFERENCES,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
fallback_used=True,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
async def _handle_get_diagnostics(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""Handle get diagnostics query."""
|
||||
if not file_path:
|
||||
file_path = self._extract_file_from_query(query)
|
||||
|
||||
# Try LSP
|
||||
if self.runtime.lsp_ready:
|
||||
try:
|
||||
diagnostics = await self.runtime.lsp_get_diagnostics(file_path)
|
||||
citations = []
|
||||
if diagnostics:
|
||||
for d in diagnostics:
|
||||
if isinstance(d, dict):
|
||||
citations.append({
|
||||
"file": file_path or "workspace",
|
||||
"line": d.get("range", {}).get("start", {}).get("line", 0) + 1,
|
||||
"type": "diagnostic",
|
||||
"severity": d.get("severity", "unknown")
|
||||
})
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GET_DIAGNOSTICS,
|
||||
success=True,
|
||||
lsp_used=True,
|
||||
data=diagnostics,
|
||||
citations=citations
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"LSP diagnostics failed: {e}")
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.GET_DIAGNOSTICS,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="LSP not available for diagnostics"
|
||||
)
|
||||
|
||||
async def _handle_search_code(self, query: str, file_path: str = None) -> CodeQueryResult:
|
||||
"""Handle code search query."""
|
||||
# Extract search term
|
||||
search_term = self._extract_search_term(query)
|
||||
|
||||
if not search_term:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.SEARCH_CODE,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error="Could not identify search term"
|
||||
)
|
||||
|
||||
try:
|
||||
import subprocess
|
||||
workspace = self.runtime.config.workspace
|
||||
|
||||
cmd = ["grep", "-rn", search_term]
|
||||
if file_path:
|
||||
cmd.append(file_path)
|
||||
else:
|
||||
cmd.append(workspace)
|
||||
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=10
|
||||
)
|
||||
|
||||
results = []
|
||||
if result.stdout:
|
||||
for line in result.stdout.strip().split('\n')[:50]: # Limit results
|
||||
if line:
|
||||
parts = line.split(':', 2)
|
||||
if len(parts) >= 2:
|
||||
results.append({
|
||||
"file": parts[0],
|
||||
"line": int(parts[1]),
|
||||
"content": parts[2] if len(parts) > 2 else ""
|
||||
})
|
||||
|
||||
citations = [
|
||||
{"file": r["file"], "line": r["line"], "type": "search_result"}
|
||||
for r in results
|
||||
]
|
||||
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.SEARCH_CODE,
|
||||
success=True,
|
||||
lsp_used=False,
|
||||
data={"search_term": search_term, "results": results},
|
||||
citations=citations
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CodeQueryResult(
|
||||
intent=CodeIntent.SEARCH_CODE,
|
||||
success=False,
|
||||
lsp_used=False,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
def _extract_file_from_query(self, query: str) -> Optional[str]:
|
||||
"""Extract file path from query."""
|
||||
# Look for file patterns
|
||||
patterns = [
|
||||
r'(?:in|from|file)\s+["\']?([^\s"\']+\.\w+)["\']?',
|
||||
r'([^\s]+\.(?:py|js|ts|tsx|jsx|go|rs|java|cpp|c|h))',
|
||||
]
|
||||
|
||||
for pattern in patterns:
|
||||
match = re.search(pattern, query, re.IGNORECASE)
|
||||
if match:
|
||||
return match.group(1)
|
||||
|
||||
return None
|
||||
|
||||
def _extract_symbol_from_query(self, query: str) -> Optional[str]:
|
||||
"""Extract symbol name from query."""
|
||||
# Common patterns for symbol extraction
|
||||
patterns = [
|
||||
r'(?:definition\s+of|where\s+is|find|show)\s+["\']?(\w+)["\']?',
|
||||
r'["\'](\w+)["\']',
|
||||
r'`(\w+)`',
|
||||
r'(\w+)\s+(?:is\s+)?(?:defined|used)',
|
||||
]
|
||||
|
||||
for pattern in patterns:
|
||||
match = re.search(pattern, query, re.IGNORECASE)
|
||||
if match:
|
||||
symbol = match.group(1)
|
||||
# Filter out common words
|
||||
if symbol.lower() not in ['the', 'a', 'an', 'is', 'are', 'in', 'of', 'to', 'for']:
|
||||
return symbol
|
||||
|
||||
return None
|
||||
|
||||
def _extract_search_term(self, query: str) -> Optional[str]:
|
||||
"""Extract search term from query."""
|
||||
patterns = [
|
||||
r'search\s+(?:for\s+)?["\']([^"\']+)["\']',
|
||||
r'find\s+["\']([^"\']+)["\']',
|
||||
r'grep\s+["\']?([^\s"\']+)["\']?',
|
||||
]
|
||||
|
||||
for pattern in patterns:
|
||||
match = re.search(pattern, query, re.IGNORECASE)
|
||||
if match:
|
||||
return match.group(1)
|
||||
|
||||
return None
|
||||
|
||||
async def _find_symbol_position(self, file_path: str, symbol: str) -> tuple:
|
||||
"""Find the position of a symbol in a file."""
|
||||
try:
|
||||
path = Path(file_path)
|
||||
if not path.exists():
|
||||
path = Path(self.runtime.config.workspace) / file_path
|
||||
|
||||
if not path.exists():
|
||||
return None, None
|
||||
|
||||
content = path.read_text()
|
||||
lines = content.split('\n')
|
||||
|
||||
for i, line in enumerate(lines):
|
||||
col = line.find(symbol)
|
||||
if col >= 0:
|
||||
return i, col
|
||||
|
||||
return None, None
|
||||
except Exception:
|
||||
return None, None
|
||||
@@ -0,0 +1,810 @@
|
||||
"""
|
||||
Debug CLI handler for PraisonAI.
|
||||
|
||||
Provides non-interactive debug commands for testing interactive flows:
|
||||
- debug interactive: Run single interactive turn
|
||||
- debug lsp: Direct LSP probes
|
||||
- debug acp: Direct ACP probes
|
||||
- debug trace: Trace record/replay/diff
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import sys
|
||||
import time
|
||||
from typing import Any, Dict, List
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class DebugHandler:
|
||||
"""Handler for debug CLI commands."""
|
||||
|
||||
@staticmethod
|
||||
def setup_subparser(subparsers) -> None:
|
||||
"""Set up the debug subcommand parser."""
|
||||
debug_parser = subparsers.add_parser(
|
||||
"debug",
|
||||
help="Debug and test interactive flows",
|
||||
description="Debug commands for testing interactive coding assistant flows"
|
||||
)
|
||||
|
||||
debug_subparsers = debug_parser.add_subparsers(dest="debug_command", help="Debug subcommands")
|
||||
|
||||
# debug interactive
|
||||
interactive_parser = debug_subparsers.add_parser(
|
||||
"interactive",
|
||||
help="Run single interactive turn non-interactively",
|
||||
description="Execute one interactive turn with full LSP/ACP pipeline"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"-p", "--prompt",
|
||||
type=str,
|
||||
required=True,
|
||||
help="Prompt to execute"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--lsp",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Enable LSP (default: enabled)"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--no-lsp",
|
||||
action="store_true",
|
||||
help="Disable LSP"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--acp",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Enable ACP (default: enabled)"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--no-acp",
|
||||
action="store_true",
|
||||
help="Disable ACP"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--approval",
|
||||
type=str,
|
||||
choices=["manual", "auto", "scoped"],
|
||||
default="auto",
|
||||
help="Approval mode (default: auto for debug)"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--workspace", "-w",
|
||||
type=str,
|
||||
default=".",
|
||||
help="Workspace root directory"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--json",
|
||||
action="store_true",
|
||||
help="Output JSON trace"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--trace-file",
|
||||
type=str,
|
||||
help="Save trace to file"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--timeout",
|
||||
type=float,
|
||||
default=60.0,
|
||||
help="Timeout in seconds"
|
||||
)
|
||||
interactive_parser.add_argument(
|
||||
"--model",
|
||||
type=str,
|
||||
help="LLM model to use"
|
||||
)
|
||||
interactive_parser.set_defaults(func=DebugHandler.handle_interactive)
|
||||
|
||||
# debug lsp
|
||||
lsp_parser = debug_subparsers.add_parser(
|
||||
"lsp",
|
||||
help="Direct LSP probes",
|
||||
description="Probe LSP server directly"
|
||||
)
|
||||
lsp_subparsers = lsp_parser.add_subparsers(dest="lsp_command", help="LSP subcommands")
|
||||
|
||||
# debug lsp status
|
||||
lsp_status = lsp_subparsers.add_parser("status", help="Show LSP status")
|
||||
lsp_status.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_status.add_argument("--json", action="store_true")
|
||||
lsp_status.set_defaults(func=DebugHandler.handle_lsp_status)
|
||||
|
||||
# debug lsp symbols
|
||||
lsp_symbols = lsp_subparsers.add_parser("symbols", help="List symbols in file")
|
||||
lsp_symbols.add_argument("file", type=str, help="File path")
|
||||
lsp_symbols.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_symbols.add_argument("--json", action="store_true")
|
||||
lsp_symbols.set_defaults(func=DebugHandler.handle_lsp_symbols)
|
||||
|
||||
# debug lsp definition
|
||||
lsp_def = lsp_subparsers.add_parser("definition", help="Get definition location")
|
||||
lsp_def.add_argument("location", type=str, help="file:line:col")
|
||||
lsp_def.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_def.add_argument("--json", action="store_true")
|
||||
lsp_def.set_defaults(func=DebugHandler.handle_lsp_definition)
|
||||
|
||||
# debug lsp references
|
||||
lsp_refs = lsp_subparsers.add_parser("references", help="Get references")
|
||||
lsp_refs.add_argument("location", type=str, help="file:line:col")
|
||||
lsp_refs.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_refs.add_argument("--json", action="store_true")
|
||||
lsp_refs.set_defaults(func=DebugHandler.handle_lsp_references)
|
||||
|
||||
# debug lsp diagnostics
|
||||
lsp_diag = lsp_subparsers.add_parser("diagnostics", help="Get diagnostics")
|
||||
lsp_diag.add_argument("file", type=str, nargs="?", help="File path (optional)")
|
||||
lsp_diag.add_argument("--all", action="store_true", help="Get all diagnostics")
|
||||
lsp_diag.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_diag.add_argument("--json", action="store_true")
|
||||
lsp_diag.set_defaults(func=DebugHandler.handle_lsp_diagnostics)
|
||||
|
||||
# debug acp
|
||||
acp_parser = debug_subparsers.add_parser(
|
||||
"acp",
|
||||
help="Direct ACP probes",
|
||||
description="Probe ACP server directly"
|
||||
)
|
||||
acp_subparsers = acp_parser.add_subparsers(dest="acp_command", help="ACP subcommands")
|
||||
|
||||
# debug acp status
|
||||
acp_status = acp_subparsers.add_parser("status", help="Show ACP status")
|
||||
acp_status.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_status.add_argument("--json", action="store_true")
|
||||
acp_status.set_defaults(func=DebugHandler.handle_acp_status)
|
||||
|
||||
# debug acp plan
|
||||
acp_plan = acp_subparsers.add_parser("plan", help="Create action plan")
|
||||
acp_plan.add_argument("-p", "--prompt", type=str, required=True)
|
||||
acp_plan.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_plan.add_argument("--json", action="store_true")
|
||||
acp_plan.set_defaults(func=DebugHandler.handle_acp_plan)
|
||||
|
||||
# debug acp apply
|
||||
acp_apply = acp_subparsers.add_parser("apply", help="Apply action plan")
|
||||
acp_apply.add_argument("-p", "--prompt", type=str, required=True)
|
||||
acp_apply.add_argument("--approval", type=str, choices=["manual", "auto", "scoped"], default="auto")
|
||||
acp_apply.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_apply.add_argument("--json", action="store_true")
|
||||
acp_apply.set_defaults(func=DebugHandler.handle_acp_apply)
|
||||
|
||||
# debug trace
|
||||
trace_parser = debug_subparsers.add_parser(
|
||||
"trace",
|
||||
help="Trace record/replay/diff",
|
||||
description="Manage trace recordings"
|
||||
)
|
||||
trace_subparsers = trace_parser.add_subparsers(dest="trace_command", help="Trace subcommands")
|
||||
|
||||
# debug trace record
|
||||
trace_record = trace_subparsers.add_parser("record", help="Record session trace")
|
||||
trace_record.add_argument("-o", "--output", type=str, required=True, help="Output file")
|
||||
trace_record.set_defaults(func=DebugHandler.handle_trace_record)
|
||||
|
||||
# debug trace replay
|
||||
trace_replay = trace_subparsers.add_parser("replay", help="Replay recorded trace")
|
||||
trace_replay.add_argument("file", type=str, help="Trace file to replay")
|
||||
trace_replay.add_argument("--json", action="store_true")
|
||||
trace_replay.set_defaults(func=DebugHandler.handle_trace_replay)
|
||||
|
||||
# debug trace diff
|
||||
trace_diff = trace_subparsers.add_parser("diff", help="Compare two traces")
|
||||
trace_diff.add_argument("file1", type=str, help="First trace file")
|
||||
trace_diff.add_argument("file2", type=str, help="Second trace file")
|
||||
trace_diff.add_argument("--json", action="store_true")
|
||||
trace_diff.set_defaults(func=DebugHandler.handle_trace_diff)
|
||||
|
||||
@staticmethod
|
||||
def handle_interactive(args: argparse.Namespace) -> int:
|
||||
"""Handle debug interactive command."""
|
||||
return asyncio.run(DebugHandler._run_interactive(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_interactive(args: argparse.Namespace) -> int:
|
||||
"""Run interactive turn asynchronously."""
|
||||
from .interactive_runtime import create_runtime
|
||||
from .code_intelligence import CodeIntelligenceRouter
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
|
||||
start_time = time.time()
|
||||
|
||||
# Create runtime
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=args.lsp and not args.no_lsp,
|
||||
acp=args.acp and not args.no_acp,
|
||||
approval=args.approval,
|
||||
trace=True,
|
||||
trace_file=args.trace_file,
|
||||
json_output=args.json,
|
||||
timeout=args.timeout,
|
||||
model=getattr(args, 'model', None)
|
||||
)
|
||||
|
||||
result = {
|
||||
"prompt": args.prompt,
|
||||
"workspace": args.workspace,
|
||||
"start_time": start_time
|
||||
}
|
||||
|
||||
try:
|
||||
# Start runtime
|
||||
status = await runtime.start()
|
||||
result["runtime_status"] = status
|
||||
|
||||
if not status.get("started"):
|
||||
result["error"] = "Failed to start runtime"
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 1
|
||||
|
||||
# Classify intent
|
||||
code_router = CodeIntelligenceRouter(runtime)
|
||||
action_orchestrator = ActionOrchestrator(runtime)
|
||||
|
||||
prompt = args.prompt.lower()
|
||||
|
||||
# Determine if this is a code query or action
|
||||
is_code_query = any(kw in prompt for kw in [
|
||||
"list", "show", "find", "where", "definition", "reference",
|
||||
"symbol", "function", "class", "diagnostic", "error"
|
||||
])
|
||||
|
||||
is_action = any(kw in prompt for kw in [
|
||||
"create", "edit", "modify", "delete", "rename", "add", "remove",
|
||||
"change", "update", "refactor"
|
||||
])
|
||||
|
||||
if is_code_query:
|
||||
# Route to code intelligence
|
||||
query_result = await code_router.handle_query(args.prompt)
|
||||
result["type"] = "code_query"
|
||||
result["query_result"] = query_result.to_dict()
|
||||
result["lsp_used"] = query_result.lsp_used
|
||||
result["citations"] = query_result.citations
|
||||
|
||||
elif is_action:
|
||||
# Route to action orchestrator
|
||||
action_result = await action_orchestrator.execute(
|
||||
args.prompt,
|
||||
auto_approve=(args.approval == "auto")
|
||||
)
|
||||
result["type"] = "action"
|
||||
result["action_result"] = action_result.to_dict()
|
||||
result["read_only_blocked"] = action_result.read_only_blocked
|
||||
|
||||
else:
|
||||
# General query - just return status
|
||||
result["type"] = "general"
|
||||
result["message"] = "Query processed"
|
||||
|
||||
# Get trace
|
||||
trace = runtime.get_trace()
|
||||
if trace:
|
||||
result["trace"] = trace.to_dict()
|
||||
|
||||
result["success"] = True
|
||||
|
||||
except Exception as e:
|
||||
result["error"] = str(e)
|
||||
result["success"] = False
|
||||
logger.exception("Debug interactive failed")
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
result["end_time"] = time.time()
|
||||
result["duration_ms"] = (result["end_time"] - start_time) * 1000
|
||||
|
||||
# Save trace if requested
|
||||
if args.trace_file and "trace" in result:
|
||||
with open(args.trace_file, "w") as f:
|
||||
json.dump(result["trace"], f, indent=2, default=str)
|
||||
if not args.json:
|
||||
print(f"Trace saved to: {args.trace_file}")
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0 if result.get("success") else 1
|
||||
|
||||
@staticmethod
|
||||
def handle_lsp_status(args: argparse.Namespace) -> int:
|
||||
"""Handle debug lsp status command."""
|
||||
return asyncio.run(DebugHandler._run_lsp_status(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_lsp_status(args: argparse.Namespace) -> int:
|
||||
"""Run LSP status check."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
result = {
|
||||
"lsp_enabled": True,
|
||||
"lsp_ready": runtime.lsp_ready,
|
||||
"lsp_status": runtime._lsp_state.status.value,
|
||||
"lsp_error": runtime._lsp_state.error,
|
||||
"workspace": args.workspace
|
||||
}
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0 if runtime.lsp_ready else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_lsp_symbols(args: argparse.Namespace) -> int:
|
||||
"""Handle debug lsp symbols command."""
|
||||
return asyncio.run(DebugHandler._run_lsp_symbols(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_lsp_symbols(args: argparse.Namespace) -> int:
|
||||
"""Run LSP symbols query."""
|
||||
from .interactive_runtime import create_runtime
|
||||
from .code_intelligence import CodeIntelligenceRouter
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
if not runtime.lsp_ready:
|
||||
# Use fallback
|
||||
router = CodeIntelligenceRouter(runtime)
|
||||
result = await router._fallback_list_symbols(args.file)
|
||||
else:
|
||||
symbols = await runtime.lsp_get_symbols(args.file)
|
||||
result = {
|
||||
"file": args.file,
|
||||
"symbols": symbols,
|
||||
"count": len(symbols) if symbols else 0,
|
||||
"lsp_used": True
|
||||
}
|
||||
|
||||
if hasattr(result, 'to_dict'):
|
||||
result = result.to_dict()
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_lsp_definition(args: argparse.Namespace) -> int:
|
||||
"""Handle debug lsp definition command."""
|
||||
return asyncio.run(DebugHandler._run_lsp_definition(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_lsp_definition(args: argparse.Namespace) -> int:
|
||||
"""Run LSP definition query."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
# Parse location
|
||||
parts = args.location.split(":")
|
||||
if len(parts) != 3:
|
||||
print("Error: Location must be in format file:line:col", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
file_path, line, col = parts[0], int(parts[1]), int(parts[2])
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
definitions = await runtime.lsp_get_definition(file_path, line, col)
|
||||
result = {
|
||||
"file": file_path,
|
||||
"line": line,
|
||||
"col": col,
|
||||
"definitions": definitions,
|
||||
"count": len(definitions) if definitions else 0,
|
||||
"lsp_used": runtime.lsp_ready
|
||||
}
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_lsp_references(args: argparse.Namespace) -> int:
|
||||
"""Handle debug lsp references command."""
|
||||
return asyncio.run(DebugHandler._run_lsp_references(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_lsp_references(args: argparse.Namespace) -> int:
|
||||
"""Run LSP references query."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
# Parse location
|
||||
parts = args.location.split(":")
|
||||
if len(parts) != 3:
|
||||
print("Error: Location must be in format file:line:col", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
file_path, line, col = parts[0], int(parts[1]), int(parts[2])
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
references = await runtime.lsp_get_references(file_path, line, col)
|
||||
result = {
|
||||
"file": file_path,
|
||||
"line": line,
|
||||
"col": col,
|
||||
"references": references,
|
||||
"count": len(references) if references else 0,
|
||||
"lsp_used": runtime.lsp_ready
|
||||
}
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_lsp_diagnostics(args: argparse.Namespace) -> int:
|
||||
"""Handle debug lsp diagnostics command."""
|
||||
return asyncio.run(DebugHandler._run_lsp_diagnostics(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_lsp_diagnostics(args: argparse.Namespace) -> int:
|
||||
"""Run LSP diagnostics query."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
file_path = args.file if not args.all else None
|
||||
diagnostics = await runtime.lsp_get_diagnostics(file_path)
|
||||
|
||||
result = {
|
||||
"file": file_path or "all",
|
||||
"diagnostics": diagnostics,
|
||||
"count": len(diagnostics) if diagnostics else 0,
|
||||
"lsp_used": runtime.lsp_ready
|
||||
}
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_acp_status(args: argparse.Namespace) -> int:
|
||||
"""Handle debug acp status command."""
|
||||
return asyncio.run(DebugHandler._run_acp_status(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_acp_status(args: argparse.Namespace) -> int:
|
||||
"""Run ACP status check."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=False,
|
||||
acp=True
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
result = {
|
||||
"acp_enabled": True,
|
||||
"acp_ready": runtime.acp_ready,
|
||||
"acp_status": runtime._acp_state.status.value,
|
||||
"acp_error": runtime._acp_state.error,
|
||||
"read_only": runtime.read_only,
|
||||
"workspace": args.workspace
|
||||
}
|
||||
|
||||
DebugHandler._output_result(result, args.json)
|
||||
return 0 if runtime.acp_ready else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_acp_plan(args: argparse.Namespace) -> int:
|
||||
"""Handle debug acp plan command."""
|
||||
return asyncio.run(DebugHandler._run_acp_plan(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_acp_plan(args: argparse.Namespace) -> int:
|
||||
"""Run ACP plan creation."""
|
||||
from .interactive_runtime import create_runtime
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=False,
|
||||
acp=True
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
orchestrator = ActionOrchestrator(runtime)
|
||||
result = await orchestrator.create_plan(args.prompt)
|
||||
|
||||
DebugHandler._output_result(result.to_dict(), args.json)
|
||||
return 0 if result.success else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_acp_apply(args: argparse.Namespace) -> int:
|
||||
"""Handle debug acp apply command."""
|
||||
return asyncio.run(DebugHandler._run_acp_apply(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_acp_apply(args: argparse.Namespace) -> int:
|
||||
"""Run ACP plan and apply."""
|
||||
from .interactive_runtime import create_runtime
|
||||
from .action_orchestrator import ActionOrchestrator
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=False,
|
||||
acp=True,
|
||||
approval=args.approval
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
orchestrator = ActionOrchestrator(runtime)
|
||||
result = await orchestrator.execute(
|
||||
args.prompt,
|
||||
auto_approve=(args.approval == "auto")
|
||||
)
|
||||
|
||||
DebugHandler._output_result(result.to_dict(), args.json)
|
||||
return 0 if result.success else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_trace_record(args: argparse.Namespace) -> int:
|
||||
"""Handle debug trace record command."""
|
||||
print(f"Trace recording will be saved to: {args.output}")
|
||||
print("Start an interactive session with --trace-file to record.")
|
||||
return 0
|
||||
|
||||
@staticmethod
|
||||
def handle_trace_replay(args: argparse.Namespace) -> int:
|
||||
"""Handle debug trace replay command."""
|
||||
try:
|
||||
with open(args.file) as f:
|
||||
trace = json.load(f)
|
||||
|
||||
if args.json:
|
||||
print(json.dumps(trace, indent=2))
|
||||
else:
|
||||
print(f"Trace from: {args.file}")
|
||||
print(f"Start time: {trace.get('start_time')}")
|
||||
print(f"End time: {trace.get('end_time')}")
|
||||
print(f"Entries: {len(trace.get('entries', []))}")
|
||||
print("\nEntries:")
|
||||
for entry in trace.get("entries", []):
|
||||
print(f" [{entry.get('category')}] {entry.get('action')}")
|
||||
if entry.get('duration_ms'):
|
||||
print(f" Duration: {entry.get('duration_ms'):.2f}ms")
|
||||
if entry.get('error'):
|
||||
print(f" Error: {entry.get('error')}")
|
||||
|
||||
return 0
|
||||
except Exception as e:
|
||||
print(f"Error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
@staticmethod
|
||||
def handle_trace_diff(args: argparse.Namespace) -> int:
|
||||
"""Handle debug trace diff command."""
|
||||
try:
|
||||
with open(args.file1) as f:
|
||||
trace1 = json.load(f)
|
||||
with open(args.file2) as f:
|
||||
trace2 = json.load(f)
|
||||
|
||||
diff = {
|
||||
"file1": args.file1,
|
||||
"file2": args.file2,
|
||||
"entries_diff": {
|
||||
"file1_count": len(trace1.get("entries", [])),
|
||||
"file2_count": len(trace2.get("entries", []))
|
||||
},
|
||||
"duration_diff": {
|
||||
"file1": trace1.get("end_time", 0) - trace1.get("start_time", 0),
|
||||
"file2": trace2.get("end_time", 0) - trace2.get("start_time", 0)
|
||||
}
|
||||
}
|
||||
|
||||
DebugHandler._output_result(diff, args.json)
|
||||
return 0
|
||||
except Exception as e:
|
||||
print(f"Error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
@staticmethod
|
||||
def _output_result(result: Dict[str, Any], as_json: bool) -> None:
|
||||
"""Output result in appropriate format."""
|
||||
if as_json:
|
||||
print(json.dumps(result, indent=2, default=str))
|
||||
else:
|
||||
for key, value in result.items():
|
||||
if isinstance(value, dict):
|
||||
print(f"{key}:")
|
||||
for k, v in value.items():
|
||||
print(f" {k}: {v}")
|
||||
elif isinstance(value, list):
|
||||
print(f"{key}: ({len(value)} items)")
|
||||
for item in value[:5]: # Show first 5
|
||||
print(f" - {item}")
|
||||
if len(value) > 5:
|
||||
print(f" ... and {len(value) - 5} more")
|
||||
else:
|
||||
print(f"{key}: {value}")
|
||||
|
||||
|
||||
def setup_debug_subparser(subparsers) -> None:
|
||||
"""Set up the debug subcommand parser."""
|
||||
DebugHandler.setup_subparser(subparsers)
|
||||
|
||||
|
||||
def run_debug_command(args: List[str]) -> int:
|
||||
"""Run debug command from CLI."""
|
||||
parser = argparse.ArgumentParser(
|
||||
prog="praisonai debug",
|
||||
description="Debug and test interactive coding assistant flows"
|
||||
)
|
||||
subparsers = parser.add_subparsers(dest="debug_command", help="Debug subcommands")
|
||||
|
||||
# debug interactive
|
||||
interactive_parser = subparsers.add_parser(
|
||||
"interactive",
|
||||
help="Run single interactive turn non-interactively",
|
||||
description="Execute one interactive turn with full LSP/ACP pipeline"
|
||||
)
|
||||
interactive_parser.add_argument("-p", "--prompt", type=str, required=True, help="Prompt to execute")
|
||||
interactive_parser.add_argument("--lsp", action="store_true", default=True, help="Enable LSP (default: enabled)")
|
||||
interactive_parser.add_argument("--no-lsp", action="store_true", help="Disable LSP")
|
||||
interactive_parser.add_argument("--acp", action="store_true", default=True, help="Enable ACP (default: enabled)")
|
||||
interactive_parser.add_argument("--no-acp", action="store_true", help="Disable ACP")
|
||||
interactive_parser.add_argument("--approval", type=str, choices=["manual", "auto", "scoped"], default="auto", help="Approval mode")
|
||||
interactive_parser.add_argument("--workspace", "-w", type=str, default=".", help="Workspace root directory")
|
||||
interactive_parser.add_argument("--json", action="store_true", help="Output JSON trace")
|
||||
interactive_parser.add_argument("--trace-file", type=str, help="Save trace to file")
|
||||
interactive_parser.add_argument("--timeout", type=float, default=60.0, help="Timeout in seconds")
|
||||
interactive_parser.add_argument("--model", type=str, help="LLM model to use")
|
||||
interactive_parser.set_defaults(func=DebugHandler.handle_interactive)
|
||||
|
||||
# debug lsp
|
||||
lsp_parser = subparsers.add_parser("lsp", help="Direct LSP probes")
|
||||
lsp_subparsers = lsp_parser.add_subparsers(dest="lsp_command", help="LSP subcommands")
|
||||
|
||||
# debug lsp status
|
||||
lsp_status = lsp_subparsers.add_parser("status", help="Show LSP status")
|
||||
lsp_status.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_status.add_argument("--json", action="store_true")
|
||||
lsp_status.set_defaults(func=DebugHandler.handle_lsp_status)
|
||||
|
||||
# debug lsp symbols
|
||||
lsp_symbols = lsp_subparsers.add_parser("symbols", help="List symbols in file")
|
||||
lsp_symbols.add_argument("file", type=str, help="File path")
|
||||
lsp_symbols.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_symbols.add_argument("--json", action="store_true")
|
||||
lsp_symbols.set_defaults(func=DebugHandler.handle_lsp_symbols)
|
||||
|
||||
# debug lsp definition
|
||||
lsp_def = lsp_subparsers.add_parser("definition", help="Get definition location")
|
||||
lsp_def.add_argument("location", type=str, help="file:line:col")
|
||||
lsp_def.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_def.add_argument("--json", action="store_true")
|
||||
lsp_def.set_defaults(func=DebugHandler.handle_lsp_definition)
|
||||
|
||||
# debug lsp references
|
||||
lsp_refs = lsp_subparsers.add_parser("references", help="Get references")
|
||||
lsp_refs.add_argument("location", type=str, help="file:line:col")
|
||||
lsp_refs.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_refs.add_argument("--json", action="store_true")
|
||||
lsp_refs.set_defaults(func=DebugHandler.handle_lsp_references)
|
||||
|
||||
# debug lsp diagnostics
|
||||
lsp_diag = lsp_subparsers.add_parser("diagnostics", help="Get diagnostics")
|
||||
lsp_diag.add_argument("file", type=str, nargs="?", help="File path (optional)")
|
||||
lsp_diag.add_argument("--all", action="store_true", help="Get all diagnostics")
|
||||
lsp_diag.add_argument("--workspace", "-w", type=str, default=".")
|
||||
lsp_diag.add_argument("--json", action="store_true")
|
||||
lsp_diag.set_defaults(func=DebugHandler.handle_lsp_diagnostics)
|
||||
|
||||
# debug acp
|
||||
acp_parser = subparsers.add_parser("acp", help="Direct ACP probes")
|
||||
acp_subparsers = acp_parser.add_subparsers(dest="acp_command", help="ACP subcommands")
|
||||
|
||||
# debug acp status
|
||||
acp_status = acp_subparsers.add_parser("status", help="Show ACP status")
|
||||
acp_status.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_status.add_argument("--json", action="store_true")
|
||||
acp_status.set_defaults(func=DebugHandler.handle_acp_status)
|
||||
|
||||
# debug acp plan
|
||||
acp_plan = acp_subparsers.add_parser("plan", help="Create action plan")
|
||||
acp_plan.add_argument("-p", "--prompt", type=str, required=True)
|
||||
acp_plan.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_plan.add_argument("--json", action="store_true")
|
||||
acp_plan.set_defaults(func=DebugHandler.handle_acp_plan)
|
||||
|
||||
# debug acp apply
|
||||
acp_apply = acp_subparsers.add_parser("apply", help="Apply action plan")
|
||||
acp_apply.add_argument("-p", "--prompt", type=str, required=True)
|
||||
acp_apply.add_argument("--approval", type=str, choices=["manual", "auto", "scoped"], default="auto")
|
||||
acp_apply.add_argument("--workspace", "-w", type=str, default=".")
|
||||
acp_apply.add_argument("--json", action="store_true")
|
||||
acp_apply.set_defaults(func=DebugHandler.handle_acp_apply)
|
||||
|
||||
# debug trace
|
||||
trace_parser = subparsers.add_parser("trace", help="Trace record/replay/diff")
|
||||
trace_subparsers = trace_parser.add_subparsers(dest="trace_command", help="Trace subcommands")
|
||||
|
||||
# debug trace record
|
||||
trace_record = trace_subparsers.add_parser("record", help="Record session trace")
|
||||
trace_record.add_argument("-o", "--output", type=str, required=True, help="Output file")
|
||||
trace_record.set_defaults(func=DebugHandler.handle_trace_record)
|
||||
|
||||
# debug trace replay
|
||||
trace_replay = trace_subparsers.add_parser("replay", help="Replay recorded trace")
|
||||
trace_replay.add_argument("file", type=str, help="Trace file to replay")
|
||||
trace_replay.add_argument("--json", action="store_true")
|
||||
trace_replay.set_defaults(func=DebugHandler.handle_trace_replay)
|
||||
|
||||
# debug trace diff
|
||||
trace_diff = trace_subparsers.add_parser("diff", help="Compare two traces")
|
||||
trace_diff.add_argument("file1", type=str, help="First trace file")
|
||||
trace_diff.add_argument("file2", type=str, help="Second trace file")
|
||||
trace_diff.add_argument("--json", action="store_true")
|
||||
trace_diff.set_defaults(func=DebugHandler.handle_trace_diff)
|
||||
|
||||
parsed = parser.parse_args(args)
|
||||
if hasattr(parsed, 'func'):
|
||||
return parsed.func(parsed)
|
||||
else:
|
||||
parser.print_help()
|
||||
return 0
|
||||
@@ -0,0 +1,289 @@
|
||||
"""
|
||||
Diagnostics export CLI handler for PraisonAI.
|
||||
|
||||
Provides diagnostic export functionality:
|
||||
- diag export: Bundle logs, traces, config for bug reports
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
import time
|
||||
import zipfile
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class DiagHandler:
|
||||
"""Handler for diag CLI commands."""
|
||||
|
||||
@staticmethod
|
||||
def setup_subparser(subparsers) -> None:
|
||||
"""Set up the diag subcommand parser."""
|
||||
diag_parser = subparsers.add_parser(
|
||||
"diag",
|
||||
help="Diagnostics export",
|
||||
description="Export diagnostic information for bug reports"
|
||||
)
|
||||
|
||||
diag_subparsers = diag_parser.add_subparsers(dest="diag_command", help="Diag subcommands")
|
||||
|
||||
# diag export
|
||||
export_parser = diag_subparsers.add_parser("export", help="Export diagnostic bundle")
|
||||
export_parser.add_argument(
|
||||
"-o", "--output",
|
||||
type=str,
|
||||
help="Output path (default: praisonai-diag-{timestamp}.zip)"
|
||||
)
|
||||
export_parser.add_argument(
|
||||
"--include-logs",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Include log files (default: true)"
|
||||
)
|
||||
export_parser.add_argument(
|
||||
"--include-config",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Include configuration (default: true)"
|
||||
)
|
||||
export_parser.add_argument(
|
||||
"--include-trace",
|
||||
action="store_true",
|
||||
default=True,
|
||||
help="Include recent traces (default: true)"
|
||||
)
|
||||
export_parser.add_argument(
|
||||
"--workspace", "-w",
|
||||
type=str,
|
||||
default=".",
|
||||
help="Workspace root directory"
|
||||
)
|
||||
export_parser.add_argument("--json", action="store_true", help="Output JSON")
|
||||
export_parser.set_defaults(func=DiagHandler.handle_export)
|
||||
|
||||
@staticmethod
|
||||
def handle_export(args: argparse.Namespace) -> int:
|
||||
"""Handle diag export command."""
|
||||
timestamp = int(time.time())
|
||||
output_path = args.output or f"praisonai-diag-{timestamp}.zip"
|
||||
|
||||
collected_files = []
|
||||
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
tmppath = Path(tmpdir)
|
||||
|
||||
# Collect system info
|
||||
system_info = DiagHandler._collect_system_info()
|
||||
system_file = tmppath / "system_info.json"
|
||||
with open(system_file, "w") as f:
|
||||
json.dump(system_info, f, indent=2, default=str)
|
||||
collected_files.append("system_info.json")
|
||||
|
||||
# Collect config
|
||||
if args.include_config:
|
||||
config_files = DiagHandler._collect_config(args.workspace, tmppath)
|
||||
collected_files.extend(config_files)
|
||||
|
||||
# Collect logs
|
||||
if args.include_logs:
|
||||
log_files = DiagHandler._collect_logs(tmppath)
|
||||
collected_files.extend(log_files)
|
||||
|
||||
# Collect traces
|
||||
if args.include_trace:
|
||||
trace_files = DiagHandler._collect_traces(args.workspace, tmppath)
|
||||
collected_files.extend(trace_files)
|
||||
|
||||
# Create zip
|
||||
with zipfile.ZipFile(output_path, 'w', zipfile.ZIP_DEFLATED) as zf:
|
||||
for file in tmppath.rglob("*"):
|
||||
if file.is_file():
|
||||
arcname = file.relative_to(tmppath)
|
||||
zf.write(file, arcname)
|
||||
|
||||
result = {
|
||||
"action": "export",
|
||||
"output": output_path,
|
||||
"files_collected": collected_files,
|
||||
"count": len(collected_files)
|
||||
}
|
||||
|
||||
DiagHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
@staticmethod
|
||||
def _collect_system_info() -> dict:
|
||||
"""Collect system information."""
|
||||
import platform
|
||||
import sys
|
||||
|
||||
info = {
|
||||
"timestamp": time.time(),
|
||||
"platform": {
|
||||
"system": platform.system(),
|
||||
"release": platform.release(),
|
||||
"version": platform.version(),
|
||||
"machine": platform.machine(),
|
||||
"python_version": sys.version
|
||||
},
|
||||
"praisonai": {}
|
||||
}
|
||||
|
||||
# Get PraisonAI version
|
||||
try:
|
||||
from praisonai.version import __version__
|
||||
info["praisonai"]["version"] = __version__
|
||||
except ImportError:
|
||||
info["praisonai"]["version"] = "unknown"
|
||||
|
||||
# Get praisonaiagents version
|
||||
try:
|
||||
import praisonaiagents
|
||||
info["praisonai"]["agents_version"] = getattr(praisonaiagents, '__version__', 'unknown')
|
||||
except ImportError:
|
||||
info["praisonai"]["agents_version"] = "not installed"
|
||||
|
||||
# Check for optional dependencies
|
||||
info["dependencies"] = {}
|
||||
for dep in ["acp", "litellm", "openai", "anthropic", "google.generativeai"]:
|
||||
try:
|
||||
__import__(dep.split(".")[0])
|
||||
info["dependencies"][dep] = "installed"
|
||||
except ImportError:
|
||||
info["dependencies"][dep] = "not installed"
|
||||
|
||||
# Environment (redacted)
|
||||
env_keys = [
|
||||
"OPENAI_API_KEY", "ANTHROPIC_API_KEY", "GOOGLE_API_KEY",
|
||||
"PRAISONAI_APPROVAL_MODE", "LOGLEVEL"
|
||||
]
|
||||
info["environment"] = {}
|
||||
for key in env_keys:
|
||||
value = os.environ.get(key)
|
||||
if value:
|
||||
if "KEY" in key or "SECRET" in key:
|
||||
info["environment"][key] = f"{value[:4]}...{value[-4:]}" if len(value) > 8 else "***"
|
||||
else:
|
||||
info["environment"][key] = value
|
||||
else:
|
||||
info["environment"][key] = None
|
||||
|
||||
return info
|
||||
|
||||
@staticmethod
|
||||
def _collect_config(workspace: str, tmppath: Path) -> List[str]:
|
||||
"""Collect configuration files."""
|
||||
collected = []
|
||||
workspace_path = Path(workspace)
|
||||
config_dir = tmppath / "config"
|
||||
config_dir.mkdir(exist_ok=True)
|
||||
|
||||
# Look for config files
|
||||
config_patterns = [
|
||||
"agents.yaml",
|
||||
"workflow.yaml",
|
||||
".praisonai.yaml",
|
||||
".env.example", # Not .env to avoid secrets
|
||||
"pyproject.toml",
|
||||
]
|
||||
|
||||
for pattern in config_patterns:
|
||||
for file in workspace_path.glob(pattern):
|
||||
if file.is_file():
|
||||
dest = config_dir / file.name
|
||||
shutil.copy(file, dest)
|
||||
collected.append(f"config/{file.name}")
|
||||
|
||||
return collected
|
||||
|
||||
@staticmethod
|
||||
def _collect_logs(tmppath: Path) -> List[str]:
|
||||
"""Collect log files."""
|
||||
collected = []
|
||||
logs_dir = tmppath / "logs"
|
||||
logs_dir.mkdir(exist_ok=True)
|
||||
|
||||
# Look for log files in common locations
|
||||
log_locations = [
|
||||
Path.home() / ".praison" / "logs",
|
||||
Path.home() / ".praisonai" / "logs",
|
||||
Path("/var/log/praisonai"),
|
||||
]
|
||||
|
||||
for log_dir in log_locations:
|
||||
if log_dir.exists():
|
||||
for log_file in log_dir.glob("*.log"):
|
||||
if log_file.is_file():
|
||||
dest = logs_dir / log_file.name
|
||||
# Only copy last 1000 lines
|
||||
try:
|
||||
with open(log_file) as f:
|
||||
lines = f.readlines()[-1000:]
|
||||
with open(dest, "w") as f:
|
||||
f.writelines(lines)
|
||||
collected.append(f"logs/{log_file.name}")
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return collected
|
||||
|
||||
@staticmethod
|
||||
def _collect_traces(workspace: str, tmppath: Path) -> List[str]:
|
||||
"""Collect trace files."""
|
||||
collected = []
|
||||
traces_dir = tmppath / "traces"
|
||||
traces_dir.mkdir(exist_ok=True)
|
||||
|
||||
workspace_path = Path(workspace)
|
||||
|
||||
# Look for trace files
|
||||
trace_patterns = ["*_trace.json", "praisonai_trace*.json", "*.trace"]
|
||||
|
||||
for pattern in trace_patterns:
|
||||
for trace_file in workspace_path.glob(pattern):
|
||||
if trace_file.is_file():
|
||||
dest = traces_dir / trace_file.name
|
||||
shutil.copy(trace_file, dest)
|
||||
collected.append(f"traces/{trace_file.name}")
|
||||
|
||||
return collected
|
||||
|
||||
@staticmethod
|
||||
def _output_result(result: dict, as_json: bool) -> None:
|
||||
"""Output result in appropriate format."""
|
||||
if as_json:
|
||||
print(json.dumps(result, indent=2, default=str))
|
||||
else:
|
||||
print(f"Diagnostic bundle created: {result['output']}")
|
||||
print(f"Files collected: {result['count']}")
|
||||
for f in result['files_collected']:
|
||||
print(f" - {f}")
|
||||
|
||||
|
||||
def run_diag_command(args: List[str]) -> int:
|
||||
"""Run diag command from CLI."""
|
||||
parser = argparse.ArgumentParser(prog="praisonai diag")
|
||||
subparsers = parser.add_subparsers(dest="diag_command", help="Diag subcommands")
|
||||
|
||||
# diag export
|
||||
export_parser = subparsers.add_parser("export", help="Export diagnostic bundle")
|
||||
export_parser.add_argument("-o", "--output", type=str)
|
||||
export_parser.add_argument("--include-logs", action="store_true", default=True)
|
||||
export_parser.add_argument("--include-config", action="store_true", default=True)
|
||||
export_parser.add_argument("--include-trace", action="store_true", default=True)
|
||||
export_parser.add_argument("--workspace", "-w", type=str, default=".")
|
||||
export_parser.add_argument("--json", action="store_true")
|
||||
export_parser.set_defaults(func=DiagHandler.handle_export)
|
||||
|
||||
parsed = parser.parse_args(args)
|
||||
if hasattr(parsed, 'func'):
|
||||
return parsed.func(parsed)
|
||||
else:
|
||||
parser.print_help()
|
||||
return 0
|
||||
@@ -20,3 +20,5 @@ def register_all_checks():
|
||||
from . import performance_checks
|
||||
from . import selftest_checks
|
||||
from . import serve_checks
|
||||
from . import lsp_checks
|
||||
from . import acp_checks
|
||||
@@ -0,0 +1,240 @@
|
||||
"""
|
||||
ACP health checks for PraisonAI Doctor.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
from ..models import CheckCategory, CheckResult, CheckStatus
|
||||
from ..registry import register_check
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="acp_module",
|
||||
title="ACP Module Available",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if ACP module is installed"
|
||||
)
|
||||
def check_acp_module() -> CheckResult:
|
||||
"""Check if ACP module is available."""
|
||||
try:
|
||||
import importlib.util
|
||||
spec = importlib.util.find_spec("praisonai.acp")
|
||||
|
||||
if spec is not None:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="ACP module is available",
|
||||
details={"module": "praisonai.acp"}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message="ACP module not found",
|
||||
details={"hint": "ACP module should be part of praisonai package"}
|
||||
)
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Error checking ACP module: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="acp_sdk",
|
||||
title="ACP SDK Available",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if agent-client-protocol SDK is installed"
|
||||
)
|
||||
def check_acp_sdk() -> CheckResult:
|
||||
"""Check if ACP SDK is available."""
|
||||
try:
|
||||
import importlib.util
|
||||
spec = importlib.util.find_spec("acp")
|
||||
|
||||
if spec is not None:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="ACP SDK (agent-client-protocol) is installed",
|
||||
details={"package": "agent-client-protocol"}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.INFO,
|
||||
message="ACP SDK not installed (optional)",
|
||||
details={"hint": "Install with: pip install agent-client-protocol"}
|
||||
)
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Error checking ACP SDK: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="acp_server",
|
||||
title="ACP Server Import",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if ACP server can be imported"
|
||||
)
|
||||
def check_acp_server() -> CheckResult:
|
||||
"""Check if ACP server can be imported."""
|
||||
try:
|
||||
from praisonai.acp import ACPServer # noqa: F401
|
||||
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="ACP server can be imported",
|
||||
details={"class": "ACPServer"}
|
||||
)
|
||||
except ImportError as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message=f"ACP server import failed: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Error importing ACP server: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="acp_config",
|
||||
title="ACP Configuration",
|
||||
category=CheckCategory.CONFIG,
|
||||
description="Check ACP configuration"
|
||||
)
|
||||
def check_acp_config() -> CheckResult:
|
||||
"""Check ACP configuration."""
|
||||
import os
|
||||
|
||||
config = {
|
||||
"approval_mode": os.environ.get("PRAISONAI_APPROVAL_MODE", "manual"),
|
||||
"allow_write": os.environ.get("PRAISONAI_ALLOW_WRITE", "false"),
|
||||
"allow_shell": os.environ.get("PRAISONAI_ALLOW_SHELL", "false"),
|
||||
}
|
||||
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message=f"ACP configured with approval_mode={config['approval_mode']}",
|
||||
details=config
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="acp_runtime",
|
||||
title="ACP Runtime Check",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if ACP runtime can start",
|
||||
requires_deep=True
|
||||
)
|
||||
def check_acp_runtime() -> CheckResult:
|
||||
"""Check if ACP runtime can start."""
|
||||
try:
|
||||
from praisonai.cli.features.interactive_runtime import create_runtime
|
||||
|
||||
async def _check():
|
||||
runtime = create_runtime(
|
||||
workspace=".",
|
||||
lsp=False,
|
||||
acp=True
|
||||
)
|
||||
try:
|
||||
await runtime.start()
|
||||
ready = runtime.acp_ready
|
||||
error = runtime._acp_state.error
|
||||
read_only = runtime.read_only
|
||||
return ready, error, read_only
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
ready, error, read_only = asyncio.run(_check())
|
||||
|
||||
if ready:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="ACP runtime started successfully",
|
||||
details={"ready": True, "read_only": read_only}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message=f"ACP runtime failed to start: {error}",
|
||||
details={"ready": False, "error": error, "read_only": read_only}
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"ACP runtime check failed: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="interactive_runtime",
|
||||
title="Interactive Runtime Check",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if full interactive runtime can start",
|
||||
requires_deep=True
|
||||
)
|
||||
def check_interactive_runtime() -> CheckResult:
|
||||
"""Check if full interactive runtime can start."""
|
||||
try:
|
||||
from praisonai.cli.features.interactive_runtime import create_runtime
|
||||
|
||||
async def _check():
|
||||
runtime = create_runtime(
|
||||
workspace=".",
|
||||
lsp=True,
|
||||
acp=True
|
||||
)
|
||||
try:
|
||||
await runtime.start()
|
||||
status = runtime.get_status()
|
||||
return status
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
status = asyncio.run(_check())
|
||||
|
||||
lsp_ready = status.get("lsp", {}).get("ready", False)
|
||||
acp_ready = status.get("acp", {}).get("ready", False)
|
||||
|
||||
if lsp_ready and acp_ready:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="Interactive runtime fully operational",
|
||||
details=status
|
||||
)
|
||||
elif lsp_ready or acp_ready:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message="Interactive runtime partially operational",
|
||||
details=status
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message="Interactive runtime failed to start",
|
||||
details=status
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Interactive runtime check failed: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
def register_acp_checks():
|
||||
"""Register all ACP checks."""
|
||||
pass
|
||||
@@ -0,0 +1,199 @@
|
||||
"""
|
||||
LSP health checks for PraisonAI Doctor.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
from ..models import CheckCategory, CheckResult, CheckStatus
|
||||
from ..registry import register_check
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="lsp_module",
|
||||
title="LSP Module Available",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if LSP module is installed"
|
||||
)
|
||||
def check_lsp_module() -> CheckResult:
|
||||
"""Check if LSP module is available."""
|
||||
try:
|
||||
import importlib.util
|
||||
spec = importlib.util.find_spec("praisonaiagents.lsp")
|
||||
|
||||
if spec is not None:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="LSP module is available",
|
||||
details={"module": "praisonaiagents.lsp"}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message="LSP module not found",
|
||||
details={"hint": "Install praisonaiagents with LSP support"}
|
||||
)
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Error checking LSP module: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="lsp_client",
|
||||
title="LSP Client Import",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if LSP client can be imported"
|
||||
)
|
||||
def check_lsp_client() -> CheckResult:
|
||||
"""Check if LSP client can be imported."""
|
||||
try:
|
||||
from praisonaiagents.lsp import LSPClient # noqa: F401
|
||||
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="LSP client can be imported",
|
||||
details={"class": "LSPClient"}
|
||||
)
|
||||
except ImportError as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message=f"LSP client import failed: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"Error importing LSP client: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="lsp_server_python",
|
||||
title="Python LSP Server",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if Python language server is available"
|
||||
)
|
||||
def check_lsp_server_python() -> CheckResult:
|
||||
"""Check if Python language server is available."""
|
||||
import shutil
|
||||
|
||||
# Check for common Python language servers
|
||||
servers = [
|
||||
("pyright-langserver", "pyright"),
|
||||
("pylsp", "python-lsp-server"),
|
||||
("pyls", "python-language-server"),
|
||||
]
|
||||
|
||||
found = []
|
||||
for cmd, package in servers:
|
||||
if shutil.which(cmd):
|
||||
found.append({"command": cmd, "package": package})
|
||||
|
||||
if found:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message=f"Python LSP server available: {found[0]['command']}",
|
||||
details={"servers": found}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message="No Python LSP server found",
|
||||
details={
|
||||
"hint": "Install with: npm install -g pyright OR pip install python-lsp-server",
|
||||
"checked": [s[0] for s in servers]
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="lsp_server_typescript",
|
||||
title="TypeScript LSP Server",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if TypeScript language server is available"
|
||||
)
|
||||
def check_lsp_server_typescript() -> CheckResult:
|
||||
"""Check if TypeScript language server is available."""
|
||||
import shutil
|
||||
|
||||
# Check for TypeScript language server
|
||||
if shutil.which("typescript-language-server"):
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="TypeScript LSP server available",
|
||||
details={"command": "typescript-language-server"}
|
||||
)
|
||||
elif shutil.which("tsserver"):
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="TypeScript server available (tsserver)",
|
||||
details={"command": "tsserver"}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.INFO,
|
||||
message="TypeScript LSP server not found (optional)",
|
||||
details={
|
||||
"hint": "Install with: npm install -g typescript-language-server typescript"
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@register_check(
|
||||
id="lsp_runtime",
|
||||
title="LSP Runtime Check",
|
||||
category=CheckCategory.TOOLS,
|
||||
description="Check if LSP runtime can start",
|
||||
requires_deep=True
|
||||
)
|
||||
def check_lsp_runtime() -> CheckResult:
|
||||
"""Check if LSP runtime can start."""
|
||||
try:
|
||||
from praisonai.cli.features.interactive_runtime import create_runtime
|
||||
|
||||
async def _check():
|
||||
runtime = create_runtime(
|
||||
workspace=".",
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
try:
|
||||
await runtime.start()
|
||||
ready = runtime.lsp_ready
|
||||
error = runtime._lsp_state.error
|
||||
return ready, error
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
ready, error = asyncio.run(_check())
|
||||
|
||||
if ready:
|
||||
return CheckResult(
|
||||
status=CheckStatus.PASS,
|
||||
message="LSP runtime started successfully",
|
||||
details={"ready": True}
|
||||
)
|
||||
else:
|
||||
return CheckResult(
|
||||
status=CheckStatus.WARN,
|
||||
message=f"LSP runtime failed to start: {error}",
|
||||
details={"ready": False, "error": error}
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
return CheckResult(
|
||||
status=CheckStatus.FAIL,
|
||||
message=f"LSP runtime check failed: {e}",
|
||||
details={"error": str(e)}
|
||||
)
|
||||
|
||||
|
||||
def register_lsp_checks():
|
||||
"""Register all LSP checks."""
|
||||
pass
|
||||
@@ -0,0 +1,585 @@
|
||||
"""
|
||||
Interactive Runtime for PraisonAI.
|
||||
|
||||
Provides the core runtime that powers both TUI interactive mode and debug non-interactive mode.
|
||||
Manages LSP and ACP subsystem lifecycle with graceful degradation.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class SubsystemStatus(Enum):
|
||||
"""Status of a subsystem."""
|
||||
NOT_STARTED = "not_started"
|
||||
STARTING = "starting"
|
||||
READY = "ready"
|
||||
FAILED = "failed"
|
||||
STOPPED = "stopped"
|
||||
|
||||
|
||||
@dataclass
|
||||
class SubsystemState:
|
||||
"""State of a subsystem."""
|
||||
status: SubsystemStatus = SubsystemStatus.NOT_STARTED
|
||||
error: Optional[str] = None
|
||||
start_time: Optional[float] = None
|
||||
ready_time: Optional[float] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class RuntimeConfig:
|
||||
"""Configuration for InteractiveRuntime."""
|
||||
workspace: str = "."
|
||||
lsp_enabled: bool = True
|
||||
acp_enabled: bool = True
|
||||
approval_mode: str = "manual" # manual, auto, scoped
|
||||
trace_enabled: bool = False
|
||||
trace_file: Optional[str] = None
|
||||
json_output: bool = False
|
||||
timeout: float = 60.0
|
||||
model: Optional[str] = None
|
||||
verbose: bool = False
|
||||
|
||||
|
||||
@dataclass
|
||||
class TraceEntry:
|
||||
"""A single trace entry."""
|
||||
timestamp: float
|
||||
category: str # lsp, acp, tool, llm, file
|
||||
action: str
|
||||
params: Dict[str, Any] = field(default_factory=dict)
|
||||
result: Optional[Any] = None
|
||||
duration_ms: Optional[float] = None
|
||||
error: Optional[str] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class RuntimeTrace:
|
||||
"""Trace of a runtime session."""
|
||||
version: str = "1.0"
|
||||
start_time: float = field(default_factory=time.time)
|
||||
end_time: Optional[float] = None
|
||||
config: Optional[RuntimeConfig] = None
|
||||
entries: List[TraceEntry] = field(default_factory=list)
|
||||
|
||||
def add_entry(self, category: str, action: str, params: Dict[str, Any] = None,
|
||||
result: Any = None, duration_ms: float = None, error: str = None):
|
||||
"""Add a trace entry."""
|
||||
self.entries.append(TraceEntry(
|
||||
timestamp=time.time(),
|
||||
category=category,
|
||||
action=action,
|
||||
params=params or {},
|
||||
result=result,
|
||||
duration_ms=duration_ms,
|
||||
error=error
|
||||
))
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert trace to dictionary."""
|
||||
return {
|
||||
"version": self.version,
|
||||
"start_time": self.start_time,
|
||||
"end_time": self.end_time,
|
||||
"config": {
|
||||
"workspace": self.config.workspace if self.config else None,
|
||||
"lsp_enabled": self.config.lsp_enabled if self.config else None,
|
||||
"acp_enabled": self.config.acp_enabled if self.config else None,
|
||||
"approval_mode": self.config.approval_mode if self.config else None,
|
||||
} if self.config else None,
|
||||
"entries": [
|
||||
{
|
||||
"timestamp": e.timestamp,
|
||||
"category": e.category,
|
||||
"action": e.action,
|
||||
"params": e.params,
|
||||
"result": e.result,
|
||||
"duration_ms": e.duration_ms,
|
||||
"error": e.error
|
||||
}
|
||||
for e in self.entries
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
class InteractiveRuntime:
|
||||
"""
|
||||
Core runtime for interactive coding assistant.
|
||||
|
||||
Manages:
|
||||
- LSP subsystem for code intelligence
|
||||
- ACP subsystem for action orchestration
|
||||
- Trace collection for debugging
|
||||
- Graceful degradation when subsystems fail
|
||||
"""
|
||||
|
||||
def __init__(self, config: RuntimeConfig = None):
|
||||
"""Initialize the runtime."""
|
||||
self.config = config or RuntimeConfig()
|
||||
self._lsp_state = SubsystemState()
|
||||
self._acp_state = SubsystemState()
|
||||
self._lsp_client = None
|
||||
self._acp_session = None
|
||||
self._trace = RuntimeTrace(config=self.config) if self.config.trace_enabled else None
|
||||
self._started = False
|
||||
self._read_only = False # Enforced when ACP fails
|
||||
|
||||
@property
|
||||
def lsp_ready(self) -> bool:
|
||||
"""Check if LSP is ready."""
|
||||
return self._lsp_state.status == SubsystemStatus.READY
|
||||
|
||||
@property
|
||||
def acp_ready(self) -> bool:
|
||||
"""Check if ACP is ready."""
|
||||
return self._acp_state.status == SubsystemStatus.READY
|
||||
|
||||
@property
|
||||
def read_only(self) -> bool:
|
||||
"""Check if runtime is in read-only mode."""
|
||||
return self._read_only or not self.acp_ready
|
||||
|
||||
def get_status(self) -> Dict[str, Any]:
|
||||
"""Get runtime status."""
|
||||
return {
|
||||
"started": self._started,
|
||||
"workspace": self.config.workspace,
|
||||
"lsp": {
|
||||
"enabled": self.config.lsp_enabled,
|
||||
"status": self._lsp_state.status.value,
|
||||
"ready": self.lsp_ready,
|
||||
"error": self._lsp_state.error
|
||||
},
|
||||
"acp": {
|
||||
"enabled": self.config.acp_enabled,
|
||||
"status": self._acp_state.status.value,
|
||||
"ready": self.acp_ready,
|
||||
"error": self._acp_state.error
|
||||
},
|
||||
"read_only": self.read_only,
|
||||
"approval_mode": self.config.approval_mode
|
||||
}
|
||||
|
||||
async def start(self) -> Dict[str, Any]:
|
||||
"""
|
||||
Start the runtime and all enabled subsystems.
|
||||
|
||||
Returns status dict with subsystem states.
|
||||
"""
|
||||
if self._started:
|
||||
return self.get_status()
|
||||
|
||||
workspace = Path(self.config.workspace).resolve()
|
||||
if not workspace.exists():
|
||||
workspace.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
self.config.workspace = str(workspace)
|
||||
|
||||
# Start subsystems in parallel
|
||||
tasks = []
|
||||
if self.config.lsp_enabled:
|
||||
tasks.append(self._start_lsp())
|
||||
if self.config.acp_enabled:
|
||||
tasks.append(self._start_acp())
|
||||
|
||||
if tasks:
|
||||
await asyncio.gather(*tasks, return_exceptions=True)
|
||||
|
||||
# Enforce read-only if ACP failed
|
||||
if self.config.acp_enabled and not self.acp_ready:
|
||||
self._read_only = True
|
||||
logger.warning("ACP unavailable - runtime is READ-ONLY")
|
||||
|
||||
self._started = True
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="runtime",
|
||||
action="start",
|
||||
params={"workspace": self.config.workspace},
|
||||
result=self.get_status()
|
||||
)
|
||||
|
||||
return self.get_status()
|
||||
|
||||
async def _start_lsp(self):
|
||||
"""Start LSP subsystem."""
|
||||
self._lsp_state.status = SubsystemStatus.STARTING
|
||||
self._lsp_state.start_time = time.time()
|
||||
|
||||
try:
|
||||
# Lazy import LSP client
|
||||
from praisonaiagents.lsp import LSPClient
|
||||
|
||||
# Detect language from workspace
|
||||
language = self._detect_workspace_language()
|
||||
|
||||
self._lsp_client = LSPClient(
|
||||
language=language,
|
||||
root_uri=f"file://{self.config.workspace}"
|
||||
)
|
||||
await self._lsp_client.start()
|
||||
|
||||
# Wait for initialization
|
||||
if self._lsp_client.is_running:
|
||||
self._lsp_state.status = SubsystemStatus.READY
|
||||
self._lsp_state.ready_time = time.time()
|
||||
logger.info(f"LSP ready for {language}")
|
||||
else:
|
||||
raise RuntimeError("LSP client failed to start")
|
||||
|
||||
except ImportError as e:
|
||||
self._lsp_state.status = SubsystemStatus.FAILED
|
||||
self._lsp_state.error = f"LSP module not available: {e}"
|
||||
logger.warning(self._lsp_state.error)
|
||||
except Exception as e:
|
||||
self._lsp_state.status = SubsystemStatus.FAILED
|
||||
self._lsp_state.error = str(e)
|
||||
logger.warning(f"LSP failed to start: {e}")
|
||||
|
||||
async def _start_acp(self):
|
||||
"""Start ACP subsystem (in-process session)."""
|
||||
self._acp_state.status = SubsystemStatus.STARTING
|
||||
self._acp_state.start_time = time.time()
|
||||
|
||||
try:
|
||||
# Lazy import ACP
|
||||
from praisonai.acp.session import ACPSession
|
||||
from pathlib import Path
|
||||
|
||||
# Create a session for the workspace
|
||||
self._acp_session = ACPSession.create(
|
||||
workspace=Path(self.config.workspace)
|
||||
)
|
||||
self._acp_session.mode = self.config.approval_mode
|
||||
|
||||
self._acp_state.status = SubsystemStatus.READY
|
||||
self._acp_state.ready_time = time.time()
|
||||
logger.info("ACP session ready")
|
||||
|
||||
except ImportError as e:
|
||||
self._acp_state.status = SubsystemStatus.FAILED
|
||||
self._acp_state.error = f"ACP module not available: {e}"
|
||||
logger.warning(self._acp_state.error)
|
||||
except Exception as e:
|
||||
self._acp_state.status = SubsystemStatus.FAILED
|
||||
self._acp_state.error = str(e)
|
||||
logger.warning(f"ACP failed to start: {e}")
|
||||
|
||||
async def stop(self):
|
||||
"""Stop the runtime and all subsystems."""
|
||||
if self._lsp_client:
|
||||
try:
|
||||
await self._lsp_client.stop()
|
||||
except Exception as e:
|
||||
logger.warning(f"Error stopping LSP: {e}")
|
||||
self._lsp_state.status = SubsystemStatus.STOPPED
|
||||
|
||||
if self._acp_session:
|
||||
# ACPSession is a dataclass, no close method needed
|
||||
self._acp_session = None
|
||||
self._acp_state.status = SubsystemStatus.STOPPED
|
||||
|
||||
if self._trace:
|
||||
self._trace.end_time = time.time()
|
||||
self._trace.add_entry(
|
||||
category="runtime",
|
||||
action="stop",
|
||||
result=self.get_status()
|
||||
)
|
||||
|
||||
self._started = False
|
||||
|
||||
def _detect_workspace_language(self) -> str:
|
||||
"""Detect primary language in workspace."""
|
||||
workspace = Path(self.config.workspace)
|
||||
|
||||
# Count files by extension
|
||||
extensions = {}
|
||||
for ext in [".py", ".js", ".ts", ".tsx", ".jsx", ".go", ".rs", ".java"]:
|
||||
count = len(list(workspace.rglob(f"*{ext}")))
|
||||
if count > 0:
|
||||
extensions[ext] = count
|
||||
|
||||
if not extensions:
|
||||
return "python" # Default
|
||||
|
||||
# Map extensions to languages
|
||||
ext_to_lang = {
|
||||
".py": "python",
|
||||
".js": "javascript",
|
||||
".ts": "typescript",
|
||||
".tsx": "typescript",
|
||||
".jsx": "javascript",
|
||||
".go": "go",
|
||||
".rs": "rust",
|
||||
".java": "java"
|
||||
}
|
||||
|
||||
# Return language with most files
|
||||
top_ext = max(extensions, key=extensions.get)
|
||||
return ext_to_lang.get(top_ext, "python")
|
||||
|
||||
# LSP Operations
|
||||
async def lsp_get_symbols(self, file_path: str) -> List[Dict[str, Any]]:
|
||||
"""Get symbols in a file via LSP."""
|
||||
if not self.lsp_ready:
|
||||
return []
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
# Use workspace symbols or document symbols
|
||||
result = await self._lsp_client.get_document_symbols(file_path)
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_symbols",
|
||||
params={"file": file_path},
|
||||
result={"count": len(result) if result else 0},
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return result or []
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_symbols",
|
||||
params={"file": file_path},
|
||||
error=str(e)
|
||||
)
|
||||
return []
|
||||
|
||||
async def lsp_get_definition(self, file_path: str, line: int, col: int) -> List[Dict[str, Any]]:
|
||||
"""Get definition location via LSP."""
|
||||
if not self.lsp_ready:
|
||||
return []
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
result = await self._lsp_client.get_definition(file_path, line, col)
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_definition",
|
||||
params={"file": file_path, "line": line, "col": col},
|
||||
result={"count": len(result) if result else 0},
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return [loc.__dict__ if hasattr(loc, '__dict__') else loc for loc in (result or [])]
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_definition",
|
||||
params={"file": file_path, "line": line, "col": col},
|
||||
error=str(e)
|
||||
)
|
||||
return []
|
||||
|
||||
async def lsp_get_references(self, file_path: str, line: int, col: int) -> List[Dict[str, Any]]:
|
||||
"""Get references via LSP."""
|
||||
if not self.lsp_ready:
|
||||
return []
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
result = await self._lsp_client.get_references(file_path, line, col)
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_references",
|
||||
params={"file": file_path, "line": line, "col": col},
|
||||
result={"count": len(result) if result else 0},
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return [loc.__dict__ if hasattr(loc, '__dict__') else loc for loc in (result or [])]
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_references",
|
||||
params={"file": file_path, "line": line, "col": col},
|
||||
error=str(e)
|
||||
)
|
||||
return []
|
||||
|
||||
async def lsp_get_diagnostics(self, file_path: str = None) -> List[Dict[str, Any]]:
|
||||
"""Get diagnostics via LSP."""
|
||||
if not self.lsp_ready:
|
||||
return []
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
if file_path:
|
||||
result = await self._lsp_client.get_diagnostics(file_path)
|
||||
else:
|
||||
result = self._lsp_client._diagnostics # All cached diagnostics
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_diagnostics",
|
||||
params={"file": file_path},
|
||||
result={"count": len(result) if result else 0},
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return [d.__dict__ if hasattr(d, '__dict__') else d for d in (result or [])]
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="lsp",
|
||||
action="get_diagnostics",
|
||||
params={"file": file_path},
|
||||
error=str(e)
|
||||
)
|
||||
return []
|
||||
|
||||
# ACP Operations
|
||||
async def acp_create_plan(self, prompt: str) -> Dict[str, Any]:
|
||||
"""Create an action plan via ACP session tracking."""
|
||||
if not self.acp_ready:
|
||||
return {"error": "ACP not available", "read_only": True}
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
# ACP session tracks the plan but doesn't create it
|
||||
# Return empty steps - ActionOrchestrator handles actual planning
|
||||
result = {"steps": [], "prompt": prompt}
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="acp",
|
||||
action="create_plan",
|
||||
params={"prompt": prompt[:100]},
|
||||
result=result,
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return result
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="acp",
|
||||
action="create_plan",
|
||||
params={"prompt": prompt[:100]},
|
||||
error=str(e)
|
||||
)
|
||||
return {"error": str(e)}
|
||||
|
||||
async def acp_apply_plan(self, plan: Dict[str, Any], auto_approve: bool = False) -> Dict[str, Any]:
|
||||
"""Apply an action plan via ACP session tracking."""
|
||||
if self.read_only:
|
||||
return {"error": "Runtime is read-only", "applied": False}
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
# Track the action in session
|
||||
if self._acp_session:
|
||||
self._acp_session.add_tool_call(
|
||||
tool_call_id=f"plan_{int(time.time())}",
|
||||
title="apply_plan",
|
||||
status="applied" if auto_approve else "pending"
|
||||
)
|
||||
|
||||
result = {"applied": True, "auto_approve": auto_approve}
|
||||
duration = (time.time() - start) * 1000
|
||||
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="acp",
|
||||
action="apply_plan",
|
||||
params={"plan_id": plan.get("id"), "auto_approve": auto_approve},
|
||||
result=result,
|
||||
duration_ms=duration
|
||||
)
|
||||
|
||||
return result
|
||||
except Exception as e:
|
||||
if self._trace:
|
||||
self._trace.add_entry(
|
||||
category="acp",
|
||||
action="apply_plan",
|
||||
params={"plan_id": plan.get("id")},
|
||||
error=str(e)
|
||||
)
|
||||
return {"error": str(e), "applied": False}
|
||||
|
||||
def get_trace(self) -> Optional[RuntimeTrace]:
|
||||
"""Get the runtime trace."""
|
||||
return self._trace
|
||||
|
||||
def save_trace(self, path: str = None):
|
||||
"""Save trace to file."""
|
||||
if not self._trace:
|
||||
return
|
||||
|
||||
import json
|
||||
path = path or self.config.trace_file or "praisonai_trace.json"
|
||||
with open(path, "w") as f:
|
||||
json.dump(self._trace.to_dict(), f, indent=2, default=str)
|
||||
logger.info(f"Trace saved to {path}")
|
||||
|
||||
|
||||
def create_runtime(
|
||||
workspace: str = ".",
|
||||
lsp: bool = True,
|
||||
acp: bool = True,
|
||||
approval: str = "manual",
|
||||
trace: bool = False,
|
||||
trace_file: str = None,
|
||||
json_output: bool = False,
|
||||
timeout: float = 60.0,
|
||||
model: str = None,
|
||||
verbose: bool = False
|
||||
) -> InteractiveRuntime:
|
||||
"""
|
||||
Factory function to create an InteractiveRuntime.
|
||||
|
||||
Args:
|
||||
workspace: Workspace root directory
|
||||
lsp: Enable LSP subsystem
|
||||
acp: Enable ACP subsystem
|
||||
approval: Approval mode (manual, auto, scoped)
|
||||
trace: Enable trace collection
|
||||
trace_file: Path to save trace
|
||||
json_output: Enable JSON output mode
|
||||
timeout: Operation timeout
|
||||
model: LLM model to use
|
||||
verbose: Enable verbose output
|
||||
|
||||
Returns:
|
||||
Configured InteractiveRuntime instance
|
||||
"""
|
||||
config = RuntimeConfig(
|
||||
workspace=workspace,
|
||||
lsp_enabled=lsp,
|
||||
acp_enabled=acp,
|
||||
approval_mode=approval,
|
||||
trace_enabled=trace,
|
||||
trace_file=trace_file,
|
||||
json_output=json_output,
|
||||
timeout=timeout,
|
||||
model=model,
|
||||
verbose=verbose
|
||||
)
|
||||
return InteractiveRuntime(config)
|
||||
@@ -0,0 +1,380 @@
|
||||
"""
|
||||
Interactive Default Tools Provider for PraisonAI.
|
||||
|
||||
This module provides the canonical source of truth for default tools
|
||||
in interactive modes (TUI and `praison "prompt"`).
|
||||
|
||||
Tool Groups:
|
||||
- `acp`: ACP-powered file operations (create, edit, delete, execute)
|
||||
- `lsp`: LSP-powered code intelligence (symbols, definitions, references)
|
||||
- `basic`: Basic file tools (read, list, search)
|
||||
- `interactive`: Union of all groups (default)
|
||||
|
||||
Usage:
|
||||
from praisonai.cli.features.interactive_tools import (
|
||||
get_interactive_tools,
|
||||
resolve_tool_groups,
|
||||
TOOL_GROUPS,
|
||||
)
|
||||
|
||||
# Get all interactive tools (default)
|
||||
tools = get_interactive_tools()
|
||||
|
||||
# Get specific groups
|
||||
tools = get_interactive_tools(groups=["acp", "basic"])
|
||||
|
||||
# Disable specific groups
|
||||
tools = get_interactive_tools(disable=["lsp"])
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Callable, Dict, List, Optional, Set
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Tool group definitions
|
||||
TOOL_GROUPS = {
|
||||
"acp": [
|
||||
"acp_create_file",
|
||||
"acp_edit_file",
|
||||
"acp_delete_file",
|
||||
"acp_execute_command",
|
||||
],
|
||||
"lsp": [
|
||||
"lsp_list_symbols",
|
||||
"lsp_find_definition",
|
||||
"lsp_find_references",
|
||||
"lsp_get_diagnostics",
|
||||
],
|
||||
"basic": [
|
||||
"read_file",
|
||||
"write_file",
|
||||
"list_files",
|
||||
"execute_command",
|
||||
"internet_search",
|
||||
],
|
||||
}
|
||||
|
||||
# Default interactive group includes all
|
||||
TOOL_GROUPS["interactive"] = (
|
||||
TOOL_GROUPS["acp"] +
|
||||
TOOL_GROUPS["lsp"] +
|
||||
TOOL_GROUPS["basic"]
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ToolConfig:
|
||||
"""Configuration for tool loading."""
|
||||
workspace: str = field(default_factory=os.getcwd)
|
||||
enable_acp: bool = True
|
||||
enable_lsp: bool = True
|
||||
enable_basic: bool = True
|
||||
approval_mode: str = "auto" # auto, manual, scoped
|
||||
lsp_enabled: bool = True
|
||||
acp_enabled: bool = True
|
||||
|
||||
@classmethod
|
||||
def from_env(cls) -> "ToolConfig":
|
||||
"""Create config from environment variables."""
|
||||
config = cls()
|
||||
|
||||
# Check env vars for disabling groups
|
||||
disable_str = os.environ.get("PRAISON_TOOLS_DISABLE", "")
|
||||
if disable_str:
|
||||
disabled = [g.strip().lower() for g in disable_str.split(",")]
|
||||
if "acp" in disabled:
|
||||
config.enable_acp = False
|
||||
if "lsp" in disabled:
|
||||
config.enable_lsp = False
|
||||
if "basic" in disabled:
|
||||
config.enable_basic = False
|
||||
|
||||
# Check for workspace
|
||||
workspace = os.environ.get("PRAISON_WORKSPACE", "")
|
||||
if workspace:
|
||||
config.workspace = workspace
|
||||
|
||||
# Check approval mode
|
||||
approval = os.environ.get("PRAISON_APPROVAL_MODE", "")
|
||||
if approval in ("auto", "manual", "scoped"):
|
||||
config.approval_mode = approval
|
||||
|
||||
return config
|
||||
|
||||
|
||||
def resolve_tool_groups(
|
||||
groups: Optional[List[str]] = None,
|
||||
disable: Optional[List[str]] = None,
|
||||
config: Optional[ToolConfig] = None,
|
||||
) -> Set[str]:
|
||||
"""
|
||||
Resolve which tool names should be included based on groups and config.
|
||||
|
||||
Args:
|
||||
groups: Specific groups to include (None = all enabled)
|
||||
disable: Groups to explicitly disable
|
||||
config: Tool configuration
|
||||
|
||||
Returns:
|
||||
Set of tool names to include
|
||||
"""
|
||||
if config is None:
|
||||
config = ToolConfig.from_env()
|
||||
|
||||
disable = disable or []
|
||||
|
||||
# Start with requested groups or all enabled
|
||||
if groups:
|
||||
tool_names = set()
|
||||
for group in groups:
|
||||
if group in TOOL_GROUPS:
|
||||
tool_names.update(TOOL_GROUPS[group])
|
||||
else:
|
||||
tool_names = set()
|
||||
if config.enable_acp:
|
||||
tool_names.update(TOOL_GROUPS["acp"])
|
||||
if config.enable_lsp:
|
||||
tool_names.update(TOOL_GROUPS["lsp"])
|
||||
if config.enable_basic:
|
||||
tool_names.update(TOOL_GROUPS["basic"])
|
||||
|
||||
# Remove disabled groups
|
||||
for group in disable:
|
||||
if group in TOOL_GROUPS:
|
||||
tool_names -= set(TOOL_GROUPS[group])
|
||||
|
||||
return tool_names
|
||||
|
||||
|
||||
def _load_basic_tools() -> Dict[str, Callable]:
|
||||
"""Lazy load basic tools from praisonaiagents."""
|
||||
tools = {}
|
||||
|
||||
try:
|
||||
from praisonaiagents.tools import read_file
|
||||
tools["read_file"] = read_file
|
||||
except ImportError:
|
||||
logger.debug("read_file not available")
|
||||
|
||||
try:
|
||||
from praisonaiagents.tools import write_file
|
||||
tools["write_file"] = write_file
|
||||
except ImportError:
|
||||
logger.debug("write_file not available")
|
||||
|
||||
try:
|
||||
from praisonaiagents.tools import list_files
|
||||
tools["list_files"] = list_files
|
||||
except ImportError:
|
||||
logger.debug("list_files not available")
|
||||
|
||||
try:
|
||||
from praisonaiagents.tools import execute_command
|
||||
tools["execute_command"] = execute_command
|
||||
except ImportError:
|
||||
logger.debug("execute_command not available")
|
||||
|
||||
try:
|
||||
from praisonaiagents.tools import internet_search
|
||||
tools["internet_search"] = internet_search
|
||||
except ImportError:
|
||||
logger.debug("internet_search not available")
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def _load_acp_tools(config: ToolConfig) -> Dict[str, Callable]:
|
||||
"""Lazy load ACP tools with runtime initialization."""
|
||||
tools = {}
|
||||
|
||||
try:
|
||||
from .interactive_runtime import InteractiveRuntime, RuntimeConfig
|
||||
from .agent_tools import create_agent_centric_tools
|
||||
|
||||
# Create runtime config
|
||||
runtime_config = RuntimeConfig(
|
||||
workspace=config.workspace,
|
||||
lsp_enabled=config.lsp_enabled,
|
||||
acp_enabled=config.acp_enabled,
|
||||
approval_mode=config.approval_mode,
|
||||
)
|
||||
|
||||
# Create runtime (lazy - doesn't start until needed)
|
||||
runtime = InteractiveRuntime(runtime_config)
|
||||
|
||||
# Get all agent-centric tools
|
||||
all_tools = create_agent_centric_tools(runtime)
|
||||
|
||||
# Map by name
|
||||
for tool in all_tools:
|
||||
name = tool.__name__
|
||||
if name.startswith("acp_"):
|
||||
tools[name] = tool
|
||||
|
||||
logger.debug(f"Loaded {len(tools)} ACP tools")
|
||||
|
||||
except ImportError as e:
|
||||
logger.debug(f"ACP tools not available: {e}")
|
||||
except Exception as e:
|
||||
logger.warning(f"Error loading ACP tools: {e}")
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def _load_lsp_tools(config: ToolConfig) -> Dict[str, Callable]:
|
||||
"""Lazy load LSP tools with runtime initialization."""
|
||||
tools = {}
|
||||
|
||||
try:
|
||||
from .interactive_runtime import InteractiveRuntime, RuntimeConfig
|
||||
from .agent_tools import create_agent_centric_tools
|
||||
|
||||
# Create runtime config
|
||||
runtime_config = RuntimeConfig(
|
||||
workspace=config.workspace,
|
||||
lsp_enabled=config.lsp_enabled,
|
||||
acp_enabled=config.acp_enabled,
|
||||
approval_mode=config.approval_mode,
|
||||
)
|
||||
|
||||
# Create runtime
|
||||
runtime = InteractiveRuntime(runtime_config)
|
||||
|
||||
# Get all agent-centric tools
|
||||
all_tools = create_agent_centric_tools(runtime)
|
||||
|
||||
# Map by name
|
||||
for tool in all_tools:
|
||||
name = tool.__name__
|
||||
if name.startswith("lsp_"):
|
||||
tools[name] = tool
|
||||
|
||||
logger.debug(f"Loaded {len(tools)} LSP tools")
|
||||
|
||||
except ImportError as e:
|
||||
logger.debug(f"LSP tools not available: {e}")
|
||||
except Exception as e:
|
||||
logger.warning(f"Error loading LSP tools: {e}")
|
||||
|
||||
return tools
|
||||
|
||||
|
||||
def get_interactive_tools(
|
||||
groups: Optional[List[str]] = None,
|
||||
disable: Optional[List[str]] = None,
|
||||
config: Optional[ToolConfig] = None,
|
||||
workspace: Optional[str] = None,
|
||||
) -> List[Callable]:
|
||||
"""
|
||||
Get the default interactive tools for TUI and prompt modes.
|
||||
|
||||
This is the canonical source of truth for interactive tool defaults.
|
||||
Both `praisonai tui launch` and `praison "prompt"` should use this.
|
||||
|
||||
Args:
|
||||
groups: Specific tool groups to include (default: all enabled)
|
||||
disable: Tool groups to disable (e.g., ["acp", "lsp"])
|
||||
config: Tool configuration (created from env if not provided)
|
||||
workspace: Override workspace path
|
||||
|
||||
Returns:
|
||||
List of tool callables
|
||||
|
||||
Example:
|
||||
# Default (all tools)
|
||||
tools = get_interactive_tools()
|
||||
|
||||
# Disable ACP tools
|
||||
tools = get_interactive_tools(disable=["acp"])
|
||||
|
||||
# Only basic tools
|
||||
tools = get_interactive_tools(groups=["basic"])
|
||||
"""
|
||||
if config is None:
|
||||
config = ToolConfig.from_env()
|
||||
|
||||
if workspace:
|
||||
config.workspace = workspace
|
||||
|
||||
# Resolve which tools to include
|
||||
tool_names = resolve_tool_groups(groups, disable, config)
|
||||
|
||||
# Load tools by group
|
||||
all_tools: Dict[str, Callable] = {}
|
||||
|
||||
# Load basic tools (always available, no runtime needed)
|
||||
if config.enable_basic and not (disable and "basic" in disable):
|
||||
basic_tools = _load_basic_tools()
|
||||
all_tools.update(basic_tools)
|
||||
|
||||
# Load ACP tools (requires runtime)
|
||||
if config.enable_acp and not (disable and "acp" in disable):
|
||||
acp_tools = _load_acp_tools(config)
|
||||
all_tools.update(acp_tools)
|
||||
|
||||
# Load LSP tools (requires runtime)
|
||||
if config.enable_lsp and not (disable and "lsp" in disable):
|
||||
lsp_tools = _load_lsp_tools(config)
|
||||
all_tools.update(lsp_tools)
|
||||
|
||||
# Filter to requested tools
|
||||
result = []
|
||||
for name in sorted(tool_names): # Deterministic ordering
|
||||
if name in all_tools:
|
||||
result.append(all_tools[name])
|
||||
|
||||
logger.debug(f"Loaded {len(result)} interactive tools: {[t.__name__ for t in result]}")
|
||||
|
||||
return result
|
||||
|
||||
|
||||
def merge_tool_overrides(
|
||||
default_tools: List[Callable],
|
||||
add_tools: Optional[List[Callable]] = None,
|
||||
remove_names: Optional[List[str]] = None,
|
||||
) -> List[Callable]:
|
||||
"""
|
||||
Merge tool overrides with default tools.
|
||||
|
||||
Args:
|
||||
default_tools: Base list of tools
|
||||
add_tools: Tools to add
|
||||
remove_names: Tool names to remove
|
||||
|
||||
Returns:
|
||||
Merged tool list
|
||||
"""
|
||||
# Build name -> tool map
|
||||
tool_map = {t.__name__: t for t in default_tools}
|
||||
|
||||
# Remove specified tools
|
||||
if remove_names:
|
||||
for name in remove_names:
|
||||
tool_map.pop(name, None)
|
||||
|
||||
# Add new tools
|
||||
if add_tools:
|
||||
for tool in add_tools:
|
||||
tool_map[tool.__name__] = tool
|
||||
|
||||
return list(tool_map.values())
|
||||
|
||||
|
||||
def get_tool_group_names() -> Dict[str, List[str]]:
|
||||
"""Get available tool groups and their tool names."""
|
||||
return TOOL_GROUPS.copy()
|
||||
|
||||
|
||||
def print_tool_summary(tools: List[Callable]) -> None:
|
||||
"""Print a summary of loaded tools (for debugging)."""
|
||||
acp_count = sum(1 for t in tools if t.__name__.startswith("acp_"))
|
||||
lsp_count = sum(1 for t in tools if t.__name__.startswith("lsp_"))
|
||||
basic_count = len(tools) - acp_count - lsp_count
|
||||
|
||||
print(f"Interactive tools loaded: {len(tools)} total")
|
||||
print(f" - ACP tools: {acp_count}")
|
||||
print(f" - LSP tools: {lsp_count}")
|
||||
print(f" - Basic tools: {basic_count}")
|
||||
@@ -0,0 +1,225 @@
|
||||
"""
|
||||
LSP CLI handler for PraisonAI.
|
||||
|
||||
Provides LSP service lifecycle commands:
|
||||
- lsp start: Start LSP server(s)
|
||||
- lsp stop: Stop LSP server(s)
|
||||
- lsp status: Show status
|
||||
- lsp logs: Show recent logs
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
from typing import List
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class LSPHandler:
|
||||
"""Handler for LSP CLI commands."""
|
||||
|
||||
@staticmethod
|
||||
def setup_subparser(subparsers) -> None:
|
||||
"""Set up the lsp subcommand parser."""
|
||||
lsp_parser = subparsers.add_parser(
|
||||
"lsp",
|
||||
help="LSP service lifecycle management",
|
||||
description="Manage Language Server Protocol servers"
|
||||
)
|
||||
|
||||
lsp_subparsers = lsp_parser.add_subparsers(dest="lsp_command", help="LSP subcommands")
|
||||
|
||||
# lsp start
|
||||
start_parser = lsp_subparsers.add_parser("start", help="Start LSP server(s)")
|
||||
start_parser.add_argument(
|
||||
"--language", "-l",
|
||||
type=str,
|
||||
help="Language to start (default: auto-detect)"
|
||||
)
|
||||
start_parser.add_argument(
|
||||
"--workspace", "-w",
|
||||
type=str,
|
||||
default=".",
|
||||
help="Workspace root directory"
|
||||
)
|
||||
start_parser.add_argument("--json", action="store_true", help="Output JSON")
|
||||
start_parser.set_defaults(func=LSPHandler.handle_start)
|
||||
|
||||
# lsp stop
|
||||
stop_parser = lsp_subparsers.add_parser("stop", help="Stop LSP server(s)")
|
||||
stop_parser.add_argument("--json", action="store_true", help="Output JSON")
|
||||
stop_parser.set_defaults(func=LSPHandler.handle_stop)
|
||||
|
||||
# lsp status
|
||||
status_parser = lsp_subparsers.add_parser("status", help="Show LSP status")
|
||||
status_parser.add_argument(
|
||||
"--workspace", "-w",
|
||||
type=str,
|
||||
default=".",
|
||||
help="Workspace root directory"
|
||||
)
|
||||
status_parser.add_argument("--json", action="store_true", help="Output JSON")
|
||||
status_parser.set_defaults(func=LSPHandler.handle_status)
|
||||
|
||||
# lsp logs
|
||||
logs_parser = lsp_subparsers.add_parser("logs", help="Show recent logs")
|
||||
logs_parser.add_argument(
|
||||
"--tail", "-n",
|
||||
type=int,
|
||||
default=50,
|
||||
help="Number of lines to show"
|
||||
)
|
||||
logs_parser.add_argument("--json", action="store_true", help="Output JSON")
|
||||
logs_parser.set_defaults(func=LSPHandler.handle_logs)
|
||||
|
||||
@staticmethod
|
||||
def handle_start(args: argparse.Namespace) -> int:
|
||||
"""Handle lsp start command."""
|
||||
return asyncio.run(LSPHandler._run_start(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_start(args: argparse.Namespace) -> int:
|
||||
"""Start LSP server."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
result = {
|
||||
"action": "start",
|
||||
"lsp_ready": runtime.lsp_ready,
|
||||
"lsp_status": runtime._lsp_state.status.value,
|
||||
"workspace": args.workspace,
|
||||
"language": getattr(args, 'language', None) or "auto-detected"
|
||||
}
|
||||
|
||||
if runtime._lsp_state.error:
|
||||
result["error"] = runtime._lsp_state.error
|
||||
|
||||
LSPHandler._output_result(result, args.json)
|
||||
|
||||
# Keep running if started successfully
|
||||
if runtime.lsp_ready:
|
||||
if not args.json:
|
||||
print("\nLSP server running. Press Ctrl+C to stop.")
|
||||
try:
|
||||
while True:
|
||||
await asyncio.sleep(1)
|
||||
except KeyboardInterrupt:
|
||||
pass
|
||||
|
||||
return 0 if runtime.lsp_ready else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_stop(args: argparse.Namespace) -> int:
|
||||
"""Handle lsp stop command."""
|
||||
result = {
|
||||
"action": "stop",
|
||||
"message": "LSP servers stopped"
|
||||
}
|
||||
LSPHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
@staticmethod
|
||||
def handle_status(args: argparse.Namespace) -> int:
|
||||
"""Handle lsp status command."""
|
||||
return asyncio.run(LSPHandler._run_status(args))
|
||||
|
||||
@staticmethod
|
||||
async def _run_status(args: argparse.Namespace) -> int:
|
||||
"""Check LSP status."""
|
||||
from .interactive_runtime import create_runtime
|
||||
|
||||
runtime = create_runtime(
|
||||
workspace=args.workspace,
|
||||
lsp=True,
|
||||
acp=False
|
||||
)
|
||||
|
||||
try:
|
||||
await runtime.start()
|
||||
|
||||
result = {
|
||||
"lsp_enabled": True,
|
||||
"lsp_ready": runtime.lsp_ready,
|
||||
"lsp_status": runtime._lsp_state.status.value,
|
||||
"workspace": args.workspace
|
||||
}
|
||||
|
||||
if runtime._lsp_state.error:
|
||||
result["error"] = runtime._lsp_state.error
|
||||
|
||||
LSPHandler._output_result(result, args.json)
|
||||
return 0 if runtime.lsp_ready else 1
|
||||
|
||||
finally:
|
||||
await runtime.stop()
|
||||
|
||||
@staticmethod
|
||||
def handle_logs(args: argparse.Namespace) -> int:
|
||||
"""Handle lsp logs command."""
|
||||
result = {
|
||||
"action": "logs",
|
||||
"tail": args.tail,
|
||||
"logs": [],
|
||||
"message": "LSP logging not yet implemented"
|
||||
}
|
||||
LSPHandler._output_result(result, args.json)
|
||||
return 0
|
||||
|
||||
@staticmethod
|
||||
def _output_result(result: dict, as_json: bool) -> None:
|
||||
"""Output result in appropriate format."""
|
||||
if as_json:
|
||||
print(json.dumps(result, indent=2, default=str))
|
||||
else:
|
||||
for key, value in result.items():
|
||||
print(f"{key}: {value}")
|
||||
|
||||
|
||||
def run_lsp_command(args: List[str]) -> int:
|
||||
"""Run lsp command from CLI."""
|
||||
parser = argparse.ArgumentParser(prog="praisonai lsp")
|
||||
subparsers = parser.add_subparsers(dest="lsp_command", help="LSP subcommands")
|
||||
|
||||
# lsp start
|
||||
start_parser = subparsers.add_parser("start", help="Start LSP server(s)")
|
||||
start_parser.add_argument("--language", "-l", type=str)
|
||||
start_parser.add_argument("--workspace", "-w", type=str, default=".")
|
||||
start_parser.add_argument("--json", action="store_true")
|
||||
start_parser.set_defaults(func=LSPHandler.handle_start)
|
||||
|
||||
# lsp stop
|
||||
stop_parser = subparsers.add_parser("stop", help="Stop LSP server(s)")
|
||||
stop_parser.add_argument("--json", action="store_true")
|
||||
stop_parser.set_defaults(func=LSPHandler.handle_stop)
|
||||
|
||||
# lsp status
|
||||
status_parser = subparsers.add_parser("status", help="Show LSP status")
|
||||
status_parser.add_argument("--workspace", "-w", type=str, default=".")
|
||||
status_parser.add_argument("--json", action="store_true")
|
||||
status_parser.set_defaults(func=LSPHandler.handle_status)
|
||||
|
||||
# lsp logs
|
||||
logs_parser = subparsers.add_parser("logs", help="Show recent logs")
|
||||
logs_parser.add_argument("--tail", "-n", type=int, default=50)
|
||||
logs_parser.add_argument("--json", action="store_true")
|
||||
logs_parser.set_defaults(func=LSPHandler.handle_logs)
|
||||
|
||||
parsed = parser.parse_args(args)
|
||||
if hasattr(parsed, 'func'):
|
||||
return parsed.func(parsed)
|
||||
else:
|
||||
parser.print_help()
|
||||
return 0
|
||||
@@ -0,0 +1,81 @@
|
||||
"""
|
||||
PraisonAI CLI Profiler Module.
|
||||
|
||||
Provides detailed cProfile-based profiling for CLI commands and agent execution.
|
||||
Supports per-file/per-function timing, call graphs, and import time analysis.
|
||||
|
||||
Includes Tier 0/1/2 optimizations:
|
||||
- Tier 0: Lazy imports, provider caching, CLI startup optimization
|
||||
- Tier 1: Connection pooling, prewarm hooks (opt-in)
|
||||
- Tier 2: Lite mode, async init, perf snapshot
|
||||
"""
|
||||
|
||||
from .core import (
|
||||
ProfilerConfig,
|
||||
ProfilerResult,
|
||||
QueryProfiler,
|
||||
run_profiled_query,
|
||||
format_profile_report,
|
||||
)
|
||||
|
||||
from .suite import (
|
||||
ScenarioConfig,
|
||||
ScenarioResult,
|
||||
SuiteResult,
|
||||
ProfileSuiteRunner,
|
||||
run_profile_suite,
|
||||
)
|
||||
|
||||
from .optimizations import (
|
||||
# Tier 0
|
||||
ProviderCache,
|
||||
get_provider_cache,
|
||||
resolve_model_provider,
|
||||
LazyImporter,
|
||||
# Tier 1
|
||||
ClientPool,
|
||||
get_client_pool,
|
||||
PrewarmManager,
|
||||
# Tier 2
|
||||
LiteModeConfig,
|
||||
get_lite_mode_config,
|
||||
is_lite_mode,
|
||||
PerfSnapshot,
|
||||
PerfComparison,
|
||||
PerfSnapshotManager,
|
||||
create_snapshot_from_suite,
|
||||
format_comparison_report,
|
||||
)
|
||||
|
||||
__all__ = [
|
||||
# Core profiler
|
||||
'ProfilerConfig',
|
||||
'ProfilerResult',
|
||||
'QueryProfiler',
|
||||
'run_profiled_query',
|
||||
'format_profile_report',
|
||||
# Suite runner
|
||||
'ScenarioConfig',
|
||||
'ScenarioResult',
|
||||
'SuiteResult',
|
||||
'ProfileSuiteRunner',
|
||||
'run_profile_suite',
|
||||
# Tier 0 optimizations
|
||||
'ProviderCache',
|
||||
'get_provider_cache',
|
||||
'resolve_model_provider',
|
||||
'LazyImporter',
|
||||
# Tier 1 optimizations
|
||||
'ClientPool',
|
||||
'get_client_pool',
|
||||
'PrewarmManager',
|
||||
# Tier 2 optimizations
|
||||
'LiteModeConfig',
|
||||
'get_lite_mode_config',
|
||||
'is_lite_mode',
|
||||
'PerfSnapshot',
|
||||
'PerfComparison',
|
||||
'PerfSnapshotManager',
|
||||
'create_snapshot_from_suite',
|
||||
'format_comparison_report',
|
||||
]
|
||||
@@ -0,0 +1,558 @@
|
||||
"""
|
||||
Core profiler implementation for PraisonAI CLI.
|
||||
|
||||
Provides cProfile-based profiling with detailed per-file/per-function timing,
|
||||
call graphs, and import time analysis.
|
||||
"""
|
||||
|
||||
import cProfile
|
||||
import io
|
||||
import json
|
||||
import os
|
||||
import pstats
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
|
||||
|
||||
# Patterns for secrets to redact
|
||||
SECRET_PATTERNS = [
|
||||
r'sk-[a-zA-Z0-9]{20,}', # OpenAI keys
|
||||
r'sk-ant-[a-zA-Z0-9-]{20,}', # Anthropic keys
|
||||
r'AIza[a-zA-Z0-9_-]{35}', # Google API keys
|
||||
r'tvly-[a-zA-Z0-9-]{20,}', # Tavily keys
|
||||
r'[a-zA-Z0-9_-]{32,}', # Generic long tokens (be careful)
|
||||
]
|
||||
|
||||
|
||||
def redact_secrets(text: str) -> str:
|
||||
"""Redact potential secrets from text."""
|
||||
result = text
|
||||
for pattern in SECRET_PATTERNS[:4]: # Skip generic pattern for safety
|
||||
result = re.sub(pattern, '[REDACTED]', result)
|
||||
return result
|
||||
|
||||
|
||||
@dataclass
|
||||
class ProfilerConfig:
|
||||
"""Configuration for profiler."""
|
||||
deep: bool = False # Enable deep call tracing
|
||||
limit: int = 30 # Top N functions to show
|
||||
sort_by: str = "cumulative" # cumulative or tottime
|
||||
show_files: bool = False # Group by file
|
||||
show_callers: bool = False # Show callers
|
||||
show_callees: bool = False # Show callees
|
||||
importtime: bool = False # Show import timing
|
||||
first_token: bool = False # Track time to first token
|
||||
save_path: Optional[str] = None # Path to save artifacts
|
||||
output_format: str = "text" # text or json
|
||||
stream: bool = False # Streaming mode
|
||||
|
||||
|
||||
@dataclass
|
||||
class TimingBreakdown:
|
||||
"""Timing breakdown for profiling."""
|
||||
cli_parse_ms: float = 0.0
|
||||
imports_ms: float = 0.0
|
||||
agent_construction_ms: float = 0.0
|
||||
model_init_ms: float = 0.0
|
||||
first_token_ms: float = 0.0
|
||||
total_run_ms: float = 0.0
|
||||
|
||||
|
||||
@dataclass
|
||||
class FunctionStats:
|
||||
"""Statistics for a single function."""
|
||||
name: str
|
||||
filename: str
|
||||
lineno: int
|
||||
calls: int
|
||||
tottime: float # Time in function excluding subcalls
|
||||
cumtime: float # Time in function including subcalls
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"name": self.name,
|
||||
"filename": self.filename,
|
||||
"lineno": self.lineno,
|
||||
"calls": self.calls,
|
||||
"tottime_ms": self.tottime * 1000,
|
||||
"cumtime_ms": self.cumtime * 1000,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class FileStats:
|
||||
"""Statistics aggregated by file."""
|
||||
filename: str
|
||||
total_time: float
|
||||
functions: List[FunctionStats] = field(default_factory=list)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"filename": self.filename,
|
||||
"total_time_ms": self.total_time * 1000,
|
||||
"function_count": len(self.functions),
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class ProfilerResult:
|
||||
"""Result from a profiling run."""
|
||||
prompt: str
|
||||
response: str
|
||||
timing: TimingBreakdown
|
||||
function_stats: List[FunctionStats]
|
||||
file_stats: List[FileStats]
|
||||
callers: Dict[str, List[str]] = field(default_factory=dict)
|
||||
callees: Dict[str, List[str]] = field(default_factory=dict)
|
||||
import_times: List[Tuple[str, float]] = field(default_factory=list)
|
||||
metadata: Dict[str, Any] = field(default_factory=dict)
|
||||
timestamp: str = field(default_factory=lambda: datetime.utcnow().isoformat() + "Z")
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"timestamp": self.timestamp,
|
||||
"metadata": self.metadata,
|
||||
"prompt": self.prompt[:200] + "..." if len(self.prompt) > 200 else self.prompt,
|
||||
"response_preview": self.response[:200] + "..." if len(self.response) > 200 else self.response,
|
||||
"timing": {
|
||||
"cli_parse_ms": self.timing.cli_parse_ms,
|
||||
"imports_ms": self.timing.imports_ms,
|
||||
"agent_construction_ms": self.timing.agent_construction_ms,
|
||||
"model_init_ms": self.timing.model_init_ms,
|
||||
"first_token_ms": self.timing.first_token_ms,
|
||||
"total_run_ms": self.timing.total_run_ms,
|
||||
},
|
||||
"top_functions": [f.to_dict() for f in self.function_stats[:20]],
|
||||
"top_files": [f.to_dict() for f in self.file_stats[:10]],
|
||||
}
|
||||
|
||||
|
||||
class QueryProfiler:
|
||||
"""
|
||||
Profiler for query execution.
|
||||
|
||||
Uses cProfile for function-level profiling and optional sys.setprofile
|
||||
for deep call tracing.
|
||||
"""
|
||||
|
||||
def __init__(self, config: Optional[ProfilerConfig] = None):
|
||||
self.config = config or ProfilerConfig()
|
||||
self.profiler = cProfile.Profile()
|
||||
self._first_token_time: Optional[float] = None
|
||||
self._start_time: float = 0.0
|
||||
self._deep_trace_data: Dict[str, Dict] = {}
|
||||
|
||||
def _on_first_token(self):
|
||||
"""Called when first token is received (for streaming)."""
|
||||
if self._first_token_time is None:
|
||||
self._first_token_time = time.perf_counter()
|
||||
|
||||
def _deep_trace_callback(self, frame, event, arg):
|
||||
"""Callback for sys.setprofile deep tracing."""
|
||||
if event not in ('call', 'return'):
|
||||
return
|
||||
|
||||
filename = frame.f_code.co_filename
|
||||
funcname = frame.f_code.co_name
|
||||
lineno = frame.f_lineno
|
||||
|
||||
key = f"{filename}:{funcname}:{lineno}"
|
||||
|
||||
if key not in self._deep_trace_data:
|
||||
self._deep_trace_data[key] = {
|
||||
'filename': filename,
|
||||
'funcname': funcname,
|
||||
'lineno': lineno,
|
||||
'calls': 0,
|
||||
'total_time': 0.0,
|
||||
'start_times': [],
|
||||
}
|
||||
|
||||
if event == 'call':
|
||||
self._deep_trace_data[key]['calls'] += 1
|
||||
self._deep_trace_data[key]['start_times'].append(time.perf_counter())
|
||||
elif event == 'return' and self._deep_trace_data[key]['start_times']:
|
||||
start = self._deep_trace_data[key]['start_times'].pop()
|
||||
self._deep_trace_data[key]['total_time'] += time.perf_counter() - start
|
||||
|
||||
def profile_query(
|
||||
self,
|
||||
prompt: str,
|
||||
model: Optional[str] = None,
|
||||
stream: bool = False,
|
||||
) -> ProfilerResult:
|
||||
"""
|
||||
Profile a query execution.
|
||||
|
||||
Args:
|
||||
prompt: The prompt to execute
|
||||
model: Optional model to use
|
||||
stream: Whether to use streaming mode
|
||||
|
||||
Returns:
|
||||
ProfilerResult with detailed timing and statistics
|
||||
"""
|
||||
timing = TimingBreakdown()
|
||||
response = ""
|
||||
|
||||
# Metadata
|
||||
metadata = self._collect_metadata(model)
|
||||
|
||||
# Time CLI parsing (simulated - actual parsing happens before this)
|
||||
cli_start = time.perf_counter()
|
||||
timing.cli_parse_ms = (time.perf_counter() - cli_start) * 1000
|
||||
|
||||
# Time imports
|
||||
import_start = time.perf_counter()
|
||||
try:
|
||||
from praisonaiagents import Agent
|
||||
except ImportError:
|
||||
raise ImportError("praisonaiagents not installed")
|
||||
timing.imports_ms = (time.perf_counter() - import_start) * 1000
|
||||
|
||||
# Time agent construction
|
||||
construct_start = time.perf_counter()
|
||||
agent_config = {
|
||||
"name": "ProfilerAgent",
|
||||
"role": "Assistant",
|
||||
"goal": "Complete the task",
|
||||
"verbose": False,
|
||||
}
|
||||
if model:
|
||||
agent_config["llm"] = model
|
||||
|
||||
agent = Agent(**agent_config)
|
||||
timing.agent_construction_ms = (time.perf_counter() - construct_start) * 1000
|
||||
|
||||
# Time model initialization (first call)
|
||||
model_init_start = time.perf_counter()
|
||||
timing.model_init_ms = (time.perf_counter() - model_init_start) * 1000
|
||||
|
||||
# Profile the actual execution
|
||||
self._start_time = time.perf_counter()
|
||||
self._first_token_time = None
|
||||
|
||||
if self.config.deep:
|
||||
sys.setprofile(self._deep_trace_callback)
|
||||
|
||||
self.profiler.enable()
|
||||
|
||||
try:
|
||||
if stream and hasattr(agent, '_start_stream'):
|
||||
# Streaming mode with first token tracking
|
||||
chunks = []
|
||||
for chunk in agent._start_stream(prompt):
|
||||
if not chunks:
|
||||
self._on_first_token()
|
||||
chunks.append(chunk)
|
||||
response = ''.join(chunks)
|
||||
else:
|
||||
# Non-streaming mode
|
||||
response = agent.start(prompt)
|
||||
if response is None:
|
||||
response = ""
|
||||
finally:
|
||||
self.profiler.disable()
|
||||
if self.config.deep:
|
||||
sys.setprofile(None)
|
||||
|
||||
end_time = time.perf_counter()
|
||||
timing.total_run_ms = (end_time - self._start_time) * 1000
|
||||
|
||||
if self._first_token_time:
|
||||
timing.first_token_ms = (self._first_token_time - self._start_time) * 1000
|
||||
|
||||
# Extract statistics
|
||||
function_stats = self._extract_function_stats()
|
||||
file_stats = self._extract_file_stats(function_stats)
|
||||
callers, callees = self._extract_call_graph()
|
||||
|
||||
# Get import times if requested
|
||||
import_times = []
|
||||
if self.config.importtime:
|
||||
import_times = self._get_import_times()
|
||||
|
||||
return ProfilerResult(
|
||||
prompt=prompt,
|
||||
response=str(response),
|
||||
timing=timing,
|
||||
function_stats=function_stats,
|
||||
file_stats=file_stats,
|
||||
callers=callers if self.config.show_callers else {},
|
||||
callees=callees if self.config.show_callees else {},
|
||||
import_times=import_times,
|
||||
metadata=metadata,
|
||||
)
|
||||
|
||||
def _collect_metadata(self, model: Optional[str]) -> Dict[str, Any]:
|
||||
"""Collect system metadata."""
|
||||
import platform
|
||||
try:
|
||||
from praisonai.version import __version__ as praisonai_version
|
||||
except ImportError:
|
||||
praisonai_version = "unknown"
|
||||
|
||||
return {
|
||||
"python_version": platform.python_version(),
|
||||
"platform": platform.platform(),
|
||||
"praisonai_version": praisonai_version,
|
||||
"model": model or "default",
|
||||
"timestamp": datetime.utcnow().isoformat() + "Z",
|
||||
}
|
||||
|
||||
def _extract_function_stats(self) -> List[FunctionStats]:
|
||||
"""Extract function statistics from profiler."""
|
||||
stats_stream = io.StringIO()
|
||||
stats = pstats.Stats(self.profiler, stream=stats_stream)
|
||||
|
||||
# Sort by configured key
|
||||
sort_key = pstats.SortKey.CUMULATIVE if self.config.sort_by == "cumulative" else pstats.SortKey.TIME
|
||||
stats.sort_stats(sort_key)
|
||||
|
||||
function_stats = []
|
||||
for (filename, lineno, funcname), (cc, nc, tt, ct, callers) in stats.stats.items():
|
||||
function_stats.append(FunctionStats(
|
||||
name=funcname,
|
||||
filename=filename,
|
||||
lineno=lineno,
|
||||
calls=nc,
|
||||
tottime=tt,
|
||||
cumtime=ct,
|
||||
))
|
||||
|
||||
# Sort and limit
|
||||
if self.config.sort_by == "cumulative":
|
||||
function_stats.sort(key=lambda x: x.cumtime, reverse=True)
|
||||
else:
|
||||
function_stats.sort(key=lambda x: x.tottime, reverse=True)
|
||||
|
||||
return function_stats[:self.config.limit]
|
||||
|
||||
def _extract_file_stats(self, function_stats: List[FunctionStats]) -> List[FileStats]:
|
||||
"""Aggregate statistics by file."""
|
||||
file_map: Dict[str, FileStats] = {}
|
||||
|
||||
for func in function_stats:
|
||||
if func.filename not in file_map:
|
||||
file_map[func.filename] = FileStats(
|
||||
filename=func.filename,
|
||||
total_time=0.0,
|
||||
functions=[],
|
||||
)
|
||||
file_map[func.filename].total_time += func.cumtime
|
||||
file_map[func.filename].functions.append(func)
|
||||
|
||||
file_stats = list(file_map.values())
|
||||
file_stats.sort(key=lambda x: x.total_time, reverse=True)
|
||||
|
||||
return file_stats[:self.config.limit]
|
||||
|
||||
def _extract_call_graph(self) -> Tuple[Dict[str, List[str]], Dict[str, List[str]]]:
|
||||
"""Extract caller/callee relationships."""
|
||||
callers: Dict[str, List[str]] = {}
|
||||
callees: Dict[str, List[str]] = {}
|
||||
|
||||
stats = pstats.Stats(self.profiler)
|
||||
|
||||
for (filename, lineno, funcname), (cc, nc, tt, ct, caller_dict) in stats.stats.items():
|
||||
func_key = f"{funcname} ({os.path.basename(filename)}:{lineno})"
|
||||
|
||||
if caller_dict:
|
||||
callers[func_key] = []
|
||||
for (caller_file, caller_line, caller_name), _ in caller_dict.items():
|
||||
caller_key = f"{caller_name} ({os.path.basename(caller_file)}:{caller_line})"
|
||||
callers[func_key].append(caller_key)
|
||||
|
||||
if caller_key not in callees:
|
||||
callees[caller_key] = []
|
||||
callees[caller_key].append(func_key)
|
||||
|
||||
return callers, callees
|
||||
|
||||
def _get_import_times(self) -> List[Tuple[str, float]]:
|
||||
"""Get import timing by running subprocess with -X importtime."""
|
||||
try:
|
||||
result = subprocess.run(
|
||||
[sys.executable, "-X", "importtime", "-c", "import praisonaiagents"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
import_times = []
|
||||
for line in result.stderr.split('\n'):
|
||||
if 'import time:' in line:
|
||||
# Parse: "import time: 123 | 456 | module_name"
|
||||
match = re.search(r'import time:\s+(\d+)\s+\|\s+(\d+)\s+\|\s+(.+)', line)
|
||||
if match:
|
||||
self_time = int(match.group(1))
|
||||
cumulative = int(match.group(2))
|
||||
module = match.group(3).strip()
|
||||
import_times.append((module, cumulative / 1000000)) # Convert to seconds
|
||||
|
||||
# Sort by time descending
|
||||
import_times.sort(key=lambda x: x[1], reverse=True)
|
||||
return import_times[:20] # Top 20
|
||||
|
||||
except Exception:
|
||||
return []
|
||||
|
||||
def save_artifacts(self, result: ProfilerResult, base_path: str):
|
||||
"""Save profiling artifacts to files."""
|
||||
base = Path(base_path)
|
||||
base.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Save .prof binary
|
||||
prof_path = str(base) + ".prof"
|
||||
self.profiler.dump_stats(prof_path)
|
||||
|
||||
# Save .txt report
|
||||
txt_path = str(base) + ".txt"
|
||||
with open(txt_path, 'w') as f:
|
||||
f.write(format_profile_report(result, self.config))
|
||||
|
||||
# Save .json if requested
|
||||
if self.config.output_format == "json":
|
||||
json_path = str(base) + ".json"
|
||||
with open(json_path, 'w') as f:
|
||||
json.dump(result.to_dict(), f, indent=2, default=str)
|
||||
|
||||
return prof_path, txt_path
|
||||
|
||||
|
||||
def run_profiled_query(
|
||||
prompt: str,
|
||||
config: Optional[ProfilerConfig] = None,
|
||||
model: Optional[str] = None,
|
||||
) -> ProfilerResult:
|
||||
"""
|
||||
Run a profiled query.
|
||||
|
||||
Args:
|
||||
prompt: The prompt to execute
|
||||
config: Profiler configuration
|
||||
model: Optional model to use
|
||||
|
||||
Returns:
|
||||
ProfilerResult with detailed timing and statistics
|
||||
"""
|
||||
profiler = QueryProfiler(config)
|
||||
return profiler.profile_query(prompt, model=model, stream=config.stream if config else False)
|
||||
|
||||
|
||||
def format_profile_report(result: ProfilerResult, config: Optional[ProfilerConfig] = None) -> str:
|
||||
"""
|
||||
Format a profile result as a text report.
|
||||
|
||||
Args:
|
||||
result: ProfilerResult to format
|
||||
config: Optional profiler config
|
||||
|
||||
Returns:
|
||||
Formatted text report
|
||||
"""
|
||||
config = config or ProfilerConfig()
|
||||
lines = []
|
||||
|
||||
# Header
|
||||
lines.append("=" * 70)
|
||||
lines.append("PraisonAI Profile Report")
|
||||
lines.append("=" * 70)
|
||||
lines.append("")
|
||||
|
||||
# Metadata
|
||||
lines.append("## System Information")
|
||||
lines.append(f" Timestamp: {result.timestamp}")
|
||||
lines.append(f" Python Version: {result.metadata.get('python_version', 'N/A')}")
|
||||
lines.append(f" Platform: {result.metadata.get('platform', 'N/A')}")
|
||||
lines.append(f" PraisonAI: {result.metadata.get('praisonai_version', 'N/A')}")
|
||||
lines.append(f" Model: {result.metadata.get('model', 'N/A')}")
|
||||
lines.append("")
|
||||
|
||||
# Timing breakdown
|
||||
lines.append("## Timing Breakdown")
|
||||
lines.append(f" CLI Parse: {result.timing.cli_parse_ms:>10.2f} ms")
|
||||
lines.append(f" Imports: {result.timing.imports_ms:>10.2f} ms")
|
||||
lines.append(f" Agent Construct: {result.timing.agent_construction_ms:>10.2f} ms")
|
||||
lines.append(f" Model Init: {result.timing.model_init_ms:>10.2f} ms")
|
||||
if result.timing.first_token_ms > 0:
|
||||
lines.append(f" First Token: {result.timing.first_token_ms:>10.2f} ms")
|
||||
lines.append(f" Total Run: {result.timing.total_run_ms:>10.2f} ms")
|
||||
lines.append("")
|
||||
|
||||
# Per-file timing (if requested)
|
||||
if config.show_files and result.file_stats:
|
||||
lines.append("## Per-File Timing (Top Files)")
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'File':<50} {'Time (ms)':>15}")
|
||||
lines.append("-" * 70)
|
||||
for fs in result.file_stats[:15]:
|
||||
filename = os.path.basename(fs.filename)
|
||||
if len(filename) > 48:
|
||||
filename = "..." + filename[-45:]
|
||||
lines.append(f"{filename:<50} {fs.total_time * 1000:>15.2f}")
|
||||
lines.append("")
|
||||
|
||||
# Per-function timing
|
||||
lines.append("## Per-Function Timing (Top Functions)")
|
||||
lines.append("-" * 70)
|
||||
sort_label = "Cumulative" if config.sort_by == "cumulative" else "Total"
|
||||
lines.append(f"{'Function':<35} {'Calls':>8} {sort_label + ' (ms)':>12} {'Self (ms)':>12}")
|
||||
lines.append("-" * 70)
|
||||
for fs in result.function_stats[:config.limit]:
|
||||
funcname = fs.name
|
||||
if len(funcname) > 33:
|
||||
funcname = funcname[:30] + "..."
|
||||
lines.append(f"{funcname:<35} {fs.calls:>8} {fs.cumtime * 1000:>12.2f} {fs.tottime * 1000:>12.2f}")
|
||||
lines.append("")
|
||||
|
||||
# Callers (if requested)
|
||||
if config.show_callers and result.callers:
|
||||
lines.append("## Callers (Who called each function)")
|
||||
lines.append("-" * 70)
|
||||
for func, caller_list in list(result.callers.items())[:10]:
|
||||
lines.append(f" {func}:")
|
||||
for caller in caller_list[:5]:
|
||||
lines.append(f" <- {caller}")
|
||||
lines.append("")
|
||||
|
||||
# Callees (if requested)
|
||||
if config.show_callees and result.callees:
|
||||
lines.append("## Callees (What each function called)")
|
||||
lines.append("-" * 70)
|
||||
for func, callee_list in list(result.callees.items())[:10]:
|
||||
lines.append(f" {func}:")
|
||||
for callee in callee_list[:5]:
|
||||
lines.append(f" -> {callee}")
|
||||
lines.append("")
|
||||
|
||||
# Import times (if requested)
|
||||
if config.importtime and result.import_times:
|
||||
lines.append("## Import Times (Top Modules)")
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'Module':<50} {'Time (ms)':>15}")
|
||||
lines.append("-" * 70)
|
||||
for module, time_sec in result.import_times[:15]:
|
||||
module_name = module
|
||||
if len(module_name) > 48:
|
||||
module_name = "..." + module_name[-45:]
|
||||
lines.append(f"{module_name:<50} {time_sec * 1000:>15.2f}")
|
||||
lines.append("")
|
||||
|
||||
# Response preview
|
||||
lines.append("## Response Preview")
|
||||
lines.append("-" * 70)
|
||||
preview = result.response[:500] + "..." if len(result.response) > 500 else result.response
|
||||
lines.append(preview)
|
||||
lines.append("")
|
||||
|
||||
lines.append("=" * 70)
|
||||
|
||||
return "\n".join(lines)
|
||||
@@ -0,0 +1,652 @@
|
||||
"""
|
||||
Performance Optimizations for PraisonAI CLI.
|
||||
|
||||
Implements Tier 0/1/2 optimizations:
|
||||
- Tier 0: Lazy imports, provider caching, CLI startup optimization
|
||||
- Tier 1: Connection pooling, prewarm hooks (opt-in)
|
||||
- Tier 2: Lite mode, async init, perf snapshot
|
||||
|
||||
All optimizations are safe-by-default and opt-in where behavior changes.
|
||||
Multi-agent safe: no global mutable state that affects concurrent runs.
|
||||
"""
|
||||
|
||||
import os
|
||||
import json
|
||||
import threading
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple
|
||||
from functools import lru_cache
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# TIER 0: Safe Fast Wins (No behavior change)
|
||||
# =============================================================================
|
||||
|
||||
class ProviderCache:
|
||||
"""
|
||||
Thread-safe cache for provider/model resolution.
|
||||
|
||||
Caches resolved provider configurations to avoid repeated lookups.
|
||||
Per-process cache with clear invalidation rules.
|
||||
Multi-agent safe: uses thread-local storage for mutable state.
|
||||
"""
|
||||
|
||||
_instance = None
|
||||
_lock = threading.Lock()
|
||||
|
||||
def __new__(cls):
|
||||
if cls._instance is None:
|
||||
with cls._lock:
|
||||
if cls._instance is None:
|
||||
cls._instance = super().__new__(cls)
|
||||
cls._instance._cache = {}
|
||||
cls._instance._cache_lock = threading.Lock()
|
||||
cls._instance._hits = 0
|
||||
cls._instance._misses = 0
|
||||
return cls._instance
|
||||
|
||||
def get(self, key: str) -> Optional[Any]:
|
||||
"""Get cached value (thread-safe)."""
|
||||
with self._cache_lock:
|
||||
if key in self._cache:
|
||||
self._hits += 1
|
||||
return self._cache[key]
|
||||
self._misses += 1
|
||||
return None
|
||||
|
||||
def set(self, key: str, value: Any, ttl_seconds: int = 300) -> None:
|
||||
"""Set cached value with TTL (thread-safe)."""
|
||||
with self._cache_lock:
|
||||
self._cache[key] = {
|
||||
'value': value,
|
||||
'expires': time.time() + ttl_seconds,
|
||||
}
|
||||
|
||||
def invalidate(self, key: Optional[str] = None) -> None:
|
||||
"""Invalidate cache entry or entire cache."""
|
||||
with self._cache_lock:
|
||||
if key:
|
||||
self._cache.pop(key, None)
|
||||
else:
|
||||
self._cache.clear()
|
||||
|
||||
def get_stats(self) -> Dict[str, int]:
|
||||
"""Get cache statistics."""
|
||||
with self._cache_lock:
|
||||
return {
|
||||
'hits': self._hits,
|
||||
'misses': self._misses,
|
||||
'size': len(self._cache),
|
||||
}
|
||||
|
||||
def cleanup_expired(self) -> int:
|
||||
"""Remove expired entries. Returns count of removed entries."""
|
||||
now = time.time()
|
||||
removed = 0
|
||||
with self._cache_lock:
|
||||
expired_keys = [
|
||||
k for k, v in self._cache.items()
|
||||
if isinstance(v, dict) and v.get('expires', float('inf')) < now
|
||||
]
|
||||
for k in expired_keys:
|
||||
del self._cache[k]
|
||||
removed += 1
|
||||
return removed
|
||||
|
||||
|
||||
# Global provider cache instance (singleton, thread-safe)
|
||||
_provider_cache = None
|
||||
|
||||
def get_provider_cache() -> ProviderCache:
|
||||
"""Get the global provider cache instance."""
|
||||
global _provider_cache
|
||||
if _provider_cache is None:
|
||||
_provider_cache = ProviderCache()
|
||||
return _provider_cache
|
||||
|
||||
|
||||
@lru_cache(maxsize=32)
|
||||
def resolve_model_provider(model: str) -> Tuple[str, str]:
|
||||
"""
|
||||
Resolve model string to (provider, model_name) tuple.
|
||||
|
||||
Cached using LRU cache for repeated lookups.
|
||||
"""
|
||||
if '/' in model:
|
||||
parts = model.split('/', 1)
|
||||
return parts[0], parts[1]
|
||||
|
||||
# Default provider mappings
|
||||
if model.startswith('gpt-') or model.startswith('o1-') or model.startswith('o3-'):
|
||||
return 'openai', model
|
||||
elif model.startswith('claude-'):
|
||||
return 'anthropic', model
|
||||
elif model.startswith('gemini-'):
|
||||
return 'google', model
|
||||
elif model.startswith('llama') or model.startswith('mistral'):
|
||||
return 'ollama', model
|
||||
|
||||
return 'openai', model # Default to OpenAI
|
||||
|
||||
|
||||
class LazyImporter:
|
||||
"""
|
||||
Lazy importer for heavy modules.
|
||||
|
||||
Defers import until first use, reducing CLI startup time.
|
||||
Thread-safe and caches imported modules.
|
||||
"""
|
||||
|
||||
_imports: Dict[str, Any] = {}
|
||||
_lock = threading.Lock()
|
||||
|
||||
@classmethod
|
||||
def get(cls, module_path: str, attr: Optional[str] = None) -> Any:
|
||||
"""
|
||||
Lazily import a module or attribute.
|
||||
|
||||
Args:
|
||||
module_path: Full module path (e.g., 'openai.OpenAI')
|
||||
attr: Optional attribute to get from module
|
||||
|
||||
Returns:
|
||||
Imported module or attribute
|
||||
"""
|
||||
cache_key = f"{module_path}.{attr}" if attr else module_path
|
||||
|
||||
with cls._lock:
|
||||
if cache_key in cls._imports:
|
||||
return cls._imports[cache_key]
|
||||
|
||||
# Import outside lock to avoid deadlocks
|
||||
import importlib
|
||||
|
||||
if attr:
|
||||
module = importlib.import_module(module_path)
|
||||
result = getattr(module, attr)
|
||||
else:
|
||||
result = importlib.import_module(module_path)
|
||||
|
||||
with cls._lock:
|
||||
cls._imports[cache_key] = result
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
def clear(cls) -> None:
|
||||
"""Clear import cache."""
|
||||
with cls._lock:
|
||||
cls._imports.clear()
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# TIER 1: Medium Effort (Guarded/opt-in)
|
||||
# =============================================================================
|
||||
|
||||
class ClientPool:
|
||||
"""
|
||||
Connection pool for API clients.
|
||||
|
||||
Reuses client instances for repeated calls to the same provider.
|
||||
Multi-agent safe: clients are isolated by key.
|
||||
Does not leak API keys between different configurations.
|
||||
"""
|
||||
|
||||
def __init__(self, max_size: int = 10):
|
||||
self._pool: Dict[str, Any] = {}
|
||||
self._lock = threading.Lock()
|
||||
self._max_size = max_size
|
||||
self._access_times: Dict[str, float] = {}
|
||||
|
||||
def get_or_create(
|
||||
self,
|
||||
key: str,
|
||||
factory: Callable[[], Any],
|
||||
) -> Any:
|
||||
"""
|
||||
Get existing client or create new one.
|
||||
|
||||
Args:
|
||||
key: Unique key for this client configuration
|
||||
factory: Function to create new client if needed
|
||||
|
||||
Returns:
|
||||
Client instance
|
||||
"""
|
||||
with self._lock:
|
||||
if key in self._pool:
|
||||
self._access_times[key] = time.time()
|
||||
return self._pool[key]
|
||||
|
||||
# Evict oldest if at capacity
|
||||
if len(self._pool) >= self._max_size:
|
||||
oldest_key = min(self._access_times, key=self._access_times.get)
|
||||
del self._pool[oldest_key]
|
||||
del self._access_times[oldest_key]
|
||||
|
||||
# Create outside lock
|
||||
client = factory()
|
||||
|
||||
with self._lock:
|
||||
self._pool[key] = client
|
||||
self._access_times[key] = time.time()
|
||||
|
||||
return client
|
||||
|
||||
def remove(self, key: str) -> None:
|
||||
"""Remove client from pool."""
|
||||
with self._lock:
|
||||
self._pool.pop(key, None)
|
||||
self._access_times.pop(key, None)
|
||||
|
||||
def clear(self) -> None:
|
||||
"""Clear all clients from pool."""
|
||||
with self._lock:
|
||||
self._pool.clear()
|
||||
self._access_times.clear()
|
||||
|
||||
def size(self) -> int:
|
||||
"""Get current pool size."""
|
||||
with self._lock:
|
||||
return len(self._pool)
|
||||
|
||||
|
||||
# Global client pool (opt-in usage)
|
||||
_client_pool: Optional[ClientPool] = None
|
||||
|
||||
def get_client_pool() -> ClientPool:
|
||||
"""Get the global client pool instance."""
|
||||
global _client_pool
|
||||
if _client_pool is None:
|
||||
_client_pool = ClientPool()
|
||||
return _client_pool
|
||||
|
||||
|
||||
class PrewarmManager:
|
||||
"""
|
||||
Manager for pre-warming provider connections.
|
||||
|
||||
OPT-IN ONLY: Must be explicitly enabled.
|
||||
Pre-initializes provider clients in background to reduce first-call latency.
|
||||
"""
|
||||
|
||||
_enabled = False
|
||||
_prewarmed: Dict[str, bool] = {}
|
||||
_lock = threading.Lock()
|
||||
_background_thread: Optional[threading.Thread] = None
|
||||
|
||||
@classmethod
|
||||
def enable(cls) -> None:
|
||||
"""Enable pre-warming (opt-in)."""
|
||||
cls._enabled = True
|
||||
|
||||
@classmethod
|
||||
def disable(cls) -> None:
|
||||
"""Disable pre-warming."""
|
||||
cls._enabled = False
|
||||
|
||||
@classmethod
|
||||
def is_enabled(cls) -> bool:
|
||||
"""Check if pre-warming is enabled."""
|
||||
return cls._enabled
|
||||
|
||||
@classmethod
|
||||
def prewarm_provider(cls, provider: str, api_key: Optional[str] = None) -> None:
|
||||
"""
|
||||
Pre-warm a provider connection in background.
|
||||
|
||||
Only runs if pre-warming is enabled.
|
||||
"""
|
||||
if not cls._enabled:
|
||||
return
|
||||
|
||||
with cls._lock:
|
||||
if provider in cls._prewarmed:
|
||||
return
|
||||
cls._prewarmed[provider] = False
|
||||
|
||||
def _prewarm():
|
||||
try:
|
||||
if provider == 'openai':
|
||||
# Just import and create client - don't make API call
|
||||
from openai import OpenAI
|
||||
key = api_key or os.environ.get('OPENAI_API_KEY')
|
||||
if key:
|
||||
_ = OpenAI(api_key=key)
|
||||
elif provider == 'anthropic':
|
||||
from anthropic import Anthropic
|
||||
key = api_key or os.environ.get('ANTHROPIC_API_KEY')
|
||||
if key:
|
||||
_ = Anthropic(api_key=key)
|
||||
|
||||
with cls._lock:
|
||||
cls._prewarmed[provider] = True
|
||||
except Exception:
|
||||
pass # Silently fail - pre-warming is optional
|
||||
|
||||
# Run in background thread
|
||||
thread = threading.Thread(target=_prewarm, daemon=True)
|
||||
thread.start()
|
||||
|
||||
@classmethod
|
||||
def is_prewarmed(cls, provider: str) -> bool:
|
||||
"""Check if provider is pre-warmed."""
|
||||
with cls._lock:
|
||||
return cls._prewarmed.get(provider, False)
|
||||
|
||||
@classmethod
|
||||
def reset(cls) -> None:
|
||||
"""Reset pre-warm state."""
|
||||
with cls._lock:
|
||||
cls._prewarmed.clear()
|
||||
cls._enabled = False
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# TIER 2: Architectural (Safe and non-breaking)
|
||||
# =============================================================================
|
||||
|
||||
@dataclass
|
||||
class LiteModeConfig:
|
||||
"""
|
||||
Configuration for lite runtime mode.
|
||||
|
||||
OPT-IN ONLY: Defaults to OFF.
|
||||
Avoids expensive type/model loading when not required.
|
||||
"""
|
||||
enabled: bool = False
|
||||
skip_type_validation: bool = False
|
||||
skip_model_validation: bool = False
|
||||
minimal_imports: bool = False
|
||||
|
||||
@classmethod
|
||||
def from_env(cls) -> 'LiteModeConfig':
|
||||
"""Create config from environment variables."""
|
||||
return cls(
|
||||
enabled=os.environ.get('PRAISONAI_LITE_MODE', '').lower() in ('1', 'true', 'yes'),
|
||||
skip_type_validation=os.environ.get('PRAISONAI_SKIP_TYPE_VALIDATION', '').lower() in ('1', 'true'),
|
||||
skip_model_validation=os.environ.get('PRAISONAI_SKIP_MODEL_VALIDATION', '').lower() in ('1', 'true'),
|
||||
minimal_imports=os.environ.get('PRAISONAI_MINIMAL_IMPORTS', '').lower() in ('1', 'true'),
|
||||
)
|
||||
|
||||
|
||||
# Global lite mode config
|
||||
_lite_mode_config: Optional[LiteModeConfig] = None
|
||||
|
||||
def get_lite_mode_config() -> LiteModeConfig:
|
||||
"""Get lite mode configuration."""
|
||||
global _lite_mode_config
|
||||
if _lite_mode_config is None:
|
||||
_lite_mode_config = LiteModeConfig.from_env()
|
||||
return _lite_mode_config
|
||||
|
||||
def is_lite_mode() -> bool:
|
||||
"""Check if lite mode is enabled."""
|
||||
return get_lite_mode_config().enabled
|
||||
|
||||
|
||||
@dataclass
|
||||
class PerfSnapshot:
|
||||
"""
|
||||
Performance snapshot for baseline comparison.
|
||||
|
||||
Records timing data that can be compared against later runs.
|
||||
"""
|
||||
timestamp: str
|
||||
name: str
|
||||
startup_cold_ms: float
|
||||
startup_warm_ms: float
|
||||
import_time_ms: float
|
||||
query_time_ms: float
|
||||
first_token_ms: float
|
||||
metadata: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
'timestamp': self.timestamp,
|
||||
'name': self.name,
|
||||
'startup_cold_ms': self.startup_cold_ms,
|
||||
'startup_warm_ms': self.startup_warm_ms,
|
||||
'import_time_ms': self.import_time_ms,
|
||||
'query_time_ms': self.query_time_ms,
|
||||
'first_token_ms': self.first_token_ms,
|
||||
'metadata': self.metadata,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, data: Dict[str, Any]) -> 'PerfSnapshot':
|
||||
return cls(
|
||||
timestamp=data['timestamp'],
|
||||
name=data['name'],
|
||||
startup_cold_ms=data['startup_cold_ms'],
|
||||
startup_warm_ms=data['startup_warm_ms'],
|
||||
import_time_ms=data['import_time_ms'],
|
||||
query_time_ms=data['query_time_ms'],
|
||||
first_token_ms=data.get('first_token_ms', 0.0),
|
||||
metadata=data.get('metadata', {}),
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class PerfComparison:
|
||||
"""Comparison between two performance snapshots."""
|
||||
baseline: PerfSnapshot
|
||||
current: PerfSnapshot
|
||||
|
||||
@property
|
||||
def startup_cold_diff_ms(self) -> float:
|
||||
return self.current.startup_cold_ms - self.baseline.startup_cold_ms
|
||||
|
||||
@property
|
||||
def startup_cold_diff_pct(self) -> float:
|
||||
if self.baseline.startup_cold_ms == 0:
|
||||
return 0.0
|
||||
return (self.startup_cold_diff_ms / self.baseline.startup_cold_ms) * 100
|
||||
|
||||
@property
|
||||
def import_time_diff_ms(self) -> float:
|
||||
return self.current.import_time_ms - self.baseline.import_time_ms
|
||||
|
||||
@property
|
||||
def import_time_diff_pct(self) -> float:
|
||||
if self.baseline.import_time_ms == 0:
|
||||
return 0.0
|
||||
return (self.import_time_diff_ms / self.baseline.import_time_ms) * 100
|
||||
|
||||
@property
|
||||
def query_time_diff_ms(self) -> float:
|
||||
return self.current.query_time_ms - self.baseline.query_time_ms
|
||||
|
||||
@property
|
||||
def query_time_diff_pct(self) -> float:
|
||||
if self.baseline.query_time_ms == 0:
|
||||
return 0.0
|
||||
return (self.query_time_diff_ms / self.baseline.query_time_ms) * 100
|
||||
|
||||
def is_regression(self, threshold_pct: float = 10.0) -> bool:
|
||||
"""Check if there's a performance regression above threshold."""
|
||||
return (
|
||||
self.startup_cold_diff_pct > threshold_pct or
|
||||
self.import_time_diff_pct > threshold_pct or
|
||||
self.query_time_diff_pct > threshold_pct
|
||||
)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
'baseline': self.baseline.to_dict(),
|
||||
'current': self.current.to_dict(),
|
||||
'diffs': {
|
||||
'startup_cold_ms': self.startup_cold_diff_ms,
|
||||
'startup_cold_pct': self.startup_cold_diff_pct,
|
||||
'import_time_ms': self.import_time_diff_ms,
|
||||
'import_time_pct': self.import_time_diff_pct,
|
||||
'query_time_ms': self.query_time_diff_ms,
|
||||
'query_time_pct': self.query_time_diff_pct,
|
||||
},
|
||||
'is_regression': self.is_regression(),
|
||||
}
|
||||
|
||||
|
||||
class PerfSnapshotManager:
|
||||
"""
|
||||
Manager for performance snapshots.
|
||||
|
||||
Stores snapshots locally for baseline comparison.
|
||||
OPT-IN: User must explicitly invoke snapshot commands.
|
||||
"""
|
||||
|
||||
DEFAULT_DIR = Path.home() / '.praisonai' / 'perf_snapshots'
|
||||
|
||||
def __init__(self, snapshot_dir: Optional[Path] = None):
|
||||
self.snapshot_dir = snapshot_dir or self.DEFAULT_DIR
|
||||
self.snapshot_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def save(self, snapshot: PerfSnapshot) -> Path:
|
||||
"""Save a snapshot to disk."""
|
||||
filename = f"{snapshot.name}_{snapshot.timestamp.replace(':', '-').replace('.', '-')}.json"
|
||||
path = self.snapshot_dir / filename
|
||||
with open(path, 'w') as f:
|
||||
json.dump(snapshot.to_dict(), f, indent=2)
|
||||
return path
|
||||
|
||||
def load(self, name: str) -> Optional[PerfSnapshot]:
|
||||
"""Load the most recent snapshot with given name."""
|
||||
pattern = f"{name}_*.json"
|
||||
files = sorted(self.snapshot_dir.glob(pattern), reverse=True)
|
||||
if not files:
|
||||
return None
|
||||
|
||||
with open(files[0]) as f:
|
||||
data = json.load(f)
|
||||
return PerfSnapshot.from_dict(data)
|
||||
|
||||
def load_baseline(self, name: str = 'baseline') -> Optional[PerfSnapshot]:
|
||||
"""Load the baseline snapshot."""
|
||||
return self.load(name)
|
||||
|
||||
def save_baseline(self, snapshot: PerfSnapshot) -> Path:
|
||||
"""Save as baseline (overwrites previous baseline)."""
|
||||
snapshot.name = 'baseline'
|
||||
# Remove old baselines
|
||||
for f in self.snapshot_dir.glob('baseline_*.json'):
|
||||
f.unlink()
|
||||
return self.save(snapshot)
|
||||
|
||||
def compare(self, current: PerfSnapshot, baseline_name: str = 'baseline') -> Optional[PerfComparison]:
|
||||
"""Compare current snapshot against baseline."""
|
||||
baseline = self.load(baseline_name)
|
||||
if not baseline:
|
||||
return None
|
||||
return PerfComparison(baseline=baseline, current=current)
|
||||
|
||||
def list_snapshots(self) -> List[str]:
|
||||
"""List all saved snapshot names."""
|
||||
files = self.snapshot_dir.glob('*.json')
|
||||
names = set()
|
||||
for f in files:
|
||||
# Extract name from filename (before first underscore)
|
||||
name = f.stem.rsplit('_', 1)[0] if '_' in f.stem else f.stem
|
||||
names.add(name)
|
||||
return sorted(names)
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# Utility Functions
|
||||
# =============================================================================
|
||||
|
||||
def create_snapshot_from_suite(suite_result: Any, name: str = 'current') -> PerfSnapshot:
|
||||
"""
|
||||
Create a PerfSnapshot from a SuiteResult.
|
||||
|
||||
Args:
|
||||
suite_result: SuiteResult from profile suite
|
||||
name: Name for the snapshot
|
||||
|
||||
Returns:
|
||||
PerfSnapshot instance
|
||||
"""
|
||||
# Get average query time from scenarios
|
||||
query_times = []
|
||||
first_token_times = []
|
||||
for scenario in suite_result.scenarios:
|
||||
query_times.extend(scenario.total_times)
|
||||
first_token_times.extend(scenario.first_token_times)
|
||||
|
||||
avg_query_time = sum(query_times) / len(query_times) if query_times else 0.0
|
||||
avg_first_token = sum(first_token_times) / len(first_token_times) if first_token_times else 0.0
|
||||
|
||||
# Get import time from analysis
|
||||
import_time = 0.0
|
||||
if suite_result.import_analysis:
|
||||
import_time = suite_result.import_analysis[0].get('cumulative_ms', 0.0)
|
||||
|
||||
return PerfSnapshot(
|
||||
timestamp=suite_result.timestamp,
|
||||
name=name,
|
||||
startup_cold_ms=suite_result.startup_cold_ms,
|
||||
startup_warm_ms=suite_result.startup_warm_ms,
|
||||
import_time_ms=import_time,
|
||||
query_time_ms=avg_query_time,
|
||||
first_token_ms=avg_first_token,
|
||||
metadata=suite_result.metadata,
|
||||
)
|
||||
|
||||
|
||||
def format_comparison_report(comparison: PerfComparison) -> str:
|
||||
"""Format a comparison report as text."""
|
||||
lines = []
|
||||
lines.append("=" * 70)
|
||||
lines.append("Performance Comparison Report")
|
||||
lines.append("=" * 70)
|
||||
lines.append("")
|
||||
|
||||
lines.append(f"Baseline: {comparison.baseline.name} ({comparison.baseline.timestamp})")
|
||||
lines.append(f"Current: {comparison.current.name} ({comparison.current.timestamp})")
|
||||
lines.append("")
|
||||
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'Metric':<25} {'Baseline':>12} {'Current':>12} {'Diff':>12} {'%':>8}")
|
||||
lines.append("-" * 70)
|
||||
|
||||
def format_row(name: str, baseline: float, current: float, diff: float, pct: float) -> str:
|
||||
sign = '+' if diff > 0 else ''
|
||||
pct_sign = '+' if pct > 0 else ''
|
||||
return f"{name:<25} {baseline:>12.2f} {current:>12.2f} {sign}{diff:>11.2f} {pct_sign}{pct:>7.1f}%"
|
||||
|
||||
lines.append(format_row(
|
||||
"Startup Cold (ms)",
|
||||
comparison.baseline.startup_cold_ms,
|
||||
comparison.current.startup_cold_ms,
|
||||
comparison.startup_cold_diff_ms,
|
||||
comparison.startup_cold_diff_pct,
|
||||
))
|
||||
|
||||
lines.append(format_row(
|
||||
"Import Time (ms)",
|
||||
comparison.baseline.import_time_ms,
|
||||
comparison.current.import_time_ms,
|
||||
comparison.import_time_diff_ms,
|
||||
comparison.import_time_diff_pct,
|
||||
))
|
||||
|
||||
lines.append(format_row(
|
||||
"Query Time (ms)",
|
||||
comparison.baseline.query_time_ms,
|
||||
comparison.current.query_time_ms,
|
||||
comparison.query_time_diff_ms,
|
||||
comparison.query_time_diff_pct,
|
||||
))
|
||||
|
||||
lines.append("-" * 70)
|
||||
lines.append("")
|
||||
|
||||
if comparison.is_regression():
|
||||
lines.append("⚠️ REGRESSION DETECTED (>10% slower)")
|
||||
else:
|
||||
lines.append("✅ No significant regression")
|
||||
|
||||
lines.append("=" * 70)
|
||||
|
||||
return "\n".join(lines)
|
||||
@@ -0,0 +1,386 @@
|
||||
"""
|
||||
Profile Suite Runner for PraisonAI CLI.
|
||||
|
||||
Runs a matrix of profiling scenarios and produces aggregated reports.
|
||||
Supports cold/warm start, streaming/non-streaming, and multiple iterations.
|
||||
"""
|
||||
|
||||
import json
|
||||
import statistics
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
from .core import ProfilerConfig, ProfilerResult, QueryProfiler
|
||||
|
||||
|
||||
@dataclass
|
||||
class ScenarioConfig:
|
||||
"""Configuration for a single profiling scenario."""
|
||||
name: str
|
||||
prompt: str
|
||||
model: Optional[str] = None
|
||||
stream: bool = False
|
||||
iterations: int = 3
|
||||
warmup: int = 1
|
||||
show_files: bool = True
|
||||
limit: int = 20
|
||||
|
||||
|
||||
@dataclass
|
||||
class ScenarioResult:
|
||||
"""Result from running a scenario."""
|
||||
name: str
|
||||
config: ScenarioConfig
|
||||
results: List[ProfilerResult] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def import_times(self) -> List[float]:
|
||||
return [r.timing.imports_ms for r in self.results]
|
||||
|
||||
@property
|
||||
def total_times(self) -> List[float]:
|
||||
return [r.timing.total_run_ms for r in self.results]
|
||||
|
||||
@property
|
||||
def first_token_times(self) -> List[float]:
|
||||
return [r.timing.first_token_ms for r in self.results if r.timing.first_token_ms > 0]
|
||||
|
||||
def get_stats(self, values: List[float]) -> Dict[str, float]:
|
||||
if not values:
|
||||
return {"mean": 0, "min": 0, "max": 0, "stdev": 0, "median": 0}
|
||||
return {
|
||||
"mean": statistics.mean(values),
|
||||
"min": min(values),
|
||||
"max": max(values),
|
||||
"stdev": statistics.stdev(values) if len(values) > 1 else 0,
|
||||
"median": statistics.median(values),
|
||||
}
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"name": self.name,
|
||||
"config": {
|
||||
"prompt": self.config.prompt[:50] + "..." if len(self.config.prompt) > 50 else self.config.prompt,
|
||||
"model": self.config.model or "default",
|
||||
"stream": self.config.stream,
|
||||
"iterations": self.config.iterations,
|
||||
},
|
||||
"import_time_stats": self.get_stats(self.import_times),
|
||||
"total_time_stats": self.get_stats(self.total_times),
|
||||
"first_token_stats": self.get_stats(self.first_token_times) if self.first_token_times else None,
|
||||
"raw_import_times_ms": self.import_times,
|
||||
"raw_total_times_ms": self.total_times,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class SuiteResult:
|
||||
"""Result from running a full profiling suite."""
|
||||
scenarios: List[ScenarioResult] = field(default_factory=list)
|
||||
startup_cold_ms: float = 0.0
|
||||
startup_warm_ms: float = 0.0
|
||||
import_analysis: List[Dict[str, Any]] = field(default_factory=list)
|
||||
timestamp: str = field(default_factory=lambda: datetime.utcnow().isoformat() + "Z")
|
||||
metadata: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
return {
|
||||
"timestamp": self.timestamp,
|
||||
"metadata": self.metadata,
|
||||
"startup": {
|
||||
"cold_ms": self.startup_cold_ms,
|
||||
"warm_ms": self.startup_warm_ms,
|
||||
},
|
||||
"import_analysis": self.import_analysis[:20],
|
||||
"scenarios": [s.to_dict() for s in self.scenarios],
|
||||
}
|
||||
|
||||
|
||||
class ProfileSuiteRunner:
|
||||
"""
|
||||
Runs a suite of profiling scenarios.
|
||||
|
||||
Collects comprehensive timing data across multiple runs and scenarios.
|
||||
"""
|
||||
|
||||
DEFAULT_SCENARIOS = [
|
||||
ScenarioConfig(name="simple_non_stream", prompt="hi", stream=False, iterations=3),
|
||||
ScenarioConfig(name="simple_stream", prompt="hi", stream=True, iterations=3),
|
||||
ScenarioConfig(name="medium_non_stream", prompt="Explain what Python is in 2 sentences", stream=False, iterations=2),
|
||||
ScenarioConfig(name="medium_stream", prompt="Explain what Python is in 2 sentences", stream=True, iterations=2),
|
||||
]
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
scenarios: Optional[List[ScenarioConfig]] = None,
|
||||
output_dir: Optional[str] = None,
|
||||
verbose: bool = False,
|
||||
):
|
||||
self.scenarios = scenarios or self.DEFAULT_SCENARIOS
|
||||
self.output_dir = Path(output_dir) if output_dir else Path("/tmp/praisonai_profile_suite")
|
||||
self.verbose = verbose
|
||||
|
||||
def run(self) -> SuiteResult:
|
||||
"""Run the full profiling suite."""
|
||||
result = SuiteResult()
|
||||
result.metadata = self._collect_metadata()
|
||||
|
||||
# Create output directory
|
||||
self.output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
if self.verbose:
|
||||
print("🔬 Starting Profile Suite...")
|
||||
print(f" Output: {self.output_dir}")
|
||||
|
||||
# 1. Measure startup times
|
||||
if self.verbose:
|
||||
print("\n📊 Measuring startup times...")
|
||||
result.startup_cold_ms, result.startup_warm_ms = self._measure_startup()
|
||||
if self.verbose:
|
||||
print(f" Cold: {result.startup_cold_ms:.2f}ms, Warm: {result.startup_warm_ms:.2f}ms")
|
||||
|
||||
# 2. Analyze imports
|
||||
if self.verbose:
|
||||
print("\n📊 Analyzing imports...")
|
||||
result.import_analysis = self._analyze_imports()
|
||||
if self.verbose and result.import_analysis:
|
||||
print(f" Top import: {result.import_analysis[0]['module']} ({result.import_analysis[0]['cumulative_ms']:.2f}ms)")
|
||||
|
||||
# 3. Run scenarios
|
||||
for scenario in self.scenarios:
|
||||
if self.verbose:
|
||||
print(f"\n📊 Running scenario: {scenario.name}")
|
||||
scenario_result = self._run_scenario(scenario)
|
||||
result.scenarios.append(scenario_result)
|
||||
|
||||
if self.verbose:
|
||||
stats = scenario_result.get_stats(scenario_result.total_times)
|
||||
print(f" Total time: {stats['mean']:.2f}ms (±{stats['stdev']:.2f}ms)")
|
||||
|
||||
# 4. Save results
|
||||
self._save_results(result)
|
||||
|
||||
if self.verbose:
|
||||
print(f"\n✅ Suite complete. Results saved to {self.output_dir}")
|
||||
|
||||
return result
|
||||
|
||||
def _collect_metadata(self) -> Dict[str, Any]:
|
||||
"""Collect system metadata."""
|
||||
import platform
|
||||
try:
|
||||
from praisonai.version import __version__ as praisonai_version
|
||||
except ImportError:
|
||||
praisonai_version = "unknown"
|
||||
|
||||
return {
|
||||
"python_version": platform.python_version(),
|
||||
"platform": platform.platform(),
|
||||
"praisonai_version": praisonai_version,
|
||||
"timestamp": datetime.utcnow().isoformat() + "Z",
|
||||
}
|
||||
|
||||
def _measure_startup(self) -> tuple:
|
||||
"""Measure cold and warm startup times."""
|
||||
# Cold start
|
||||
start = time.perf_counter()
|
||||
subprocess.run(
|
||||
[sys.executable, "-c", "import praisonai; import praisonai.cli"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
)
|
||||
cold_ms = (time.perf_counter() - start) * 1000
|
||||
|
||||
# Warm start
|
||||
start = time.perf_counter()
|
||||
subprocess.run(
|
||||
[sys.executable, "-c", "import praisonai; import praisonai.cli"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
)
|
||||
warm_ms = (time.perf_counter() - start) * 1000
|
||||
|
||||
return cold_ms, warm_ms
|
||||
|
||||
def _analyze_imports(self) -> List[Dict[str, Any]]:
|
||||
"""Analyze import times."""
|
||||
import re
|
||||
|
||||
try:
|
||||
result = subprocess.run(
|
||||
[sys.executable, "-X", "importtime", "-c", "import praisonaiagents"],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=60,
|
||||
)
|
||||
|
||||
import_times = []
|
||||
for line in result.stderr.split('\n'):
|
||||
if 'import time:' in line:
|
||||
match = re.search(r'import time:\s+(\d+)\s+\|\s+(\d+)\s+\|\s+(.+)', line)
|
||||
if match:
|
||||
self_time = int(match.group(1))
|
||||
cumulative = int(match.group(2))
|
||||
module = match.group(3).strip()
|
||||
import_times.append({
|
||||
"module": module,
|
||||
"self_us": self_time,
|
||||
"cumulative_us": cumulative,
|
||||
"self_ms": self_time / 1000,
|
||||
"cumulative_ms": cumulative / 1000,
|
||||
})
|
||||
|
||||
import_times.sort(key=lambda x: x["cumulative_us"], reverse=True)
|
||||
return import_times[:30]
|
||||
|
||||
except Exception:
|
||||
return []
|
||||
|
||||
def _run_scenario(self, scenario: ScenarioConfig) -> ScenarioResult:
|
||||
"""Run a single scenario with multiple iterations."""
|
||||
result = ScenarioResult(name=scenario.name, config=scenario)
|
||||
|
||||
config = ProfilerConfig(
|
||||
stream=scenario.stream,
|
||||
show_files=scenario.show_files,
|
||||
limit=scenario.limit,
|
||||
first_token=scenario.stream,
|
||||
)
|
||||
|
||||
# Warmup runs (discarded)
|
||||
for _ in range(scenario.warmup):
|
||||
try:
|
||||
profiler = QueryProfiler(config)
|
||||
profiler.profile_query(scenario.prompt, model=scenario.model, stream=scenario.stream)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Actual runs
|
||||
for i in range(scenario.iterations):
|
||||
try:
|
||||
profiler = QueryProfiler(config)
|
||||
profile_result = profiler.profile_query(
|
||||
scenario.prompt,
|
||||
model=scenario.model,
|
||||
stream=scenario.stream,
|
||||
)
|
||||
result.results.append(profile_result)
|
||||
|
||||
if self.verbose:
|
||||
print(f" Iteration {i+1}: {profile_result.timing.total_run_ms:.2f}ms")
|
||||
|
||||
except Exception as e:
|
||||
if self.verbose:
|
||||
print(f" Iteration {i+1}: ERROR - {e}")
|
||||
|
||||
return result
|
||||
|
||||
def _save_results(self, result: SuiteResult):
|
||||
"""Save results to files."""
|
||||
# Save JSON summary
|
||||
json_path = self.output_dir / "suite_results.json"
|
||||
with open(json_path, 'w') as f:
|
||||
json.dump(result.to_dict(), f, indent=2, default=str)
|
||||
|
||||
# Save human-readable report
|
||||
report_path = self.output_dir / "suite_report.txt"
|
||||
with open(report_path, 'w') as f:
|
||||
f.write(self._format_report(result))
|
||||
|
||||
def _format_report(self, result: SuiteResult) -> str:
|
||||
"""Format a human-readable report."""
|
||||
lines = []
|
||||
lines.append("=" * 70)
|
||||
lines.append("PraisonAI Profile Suite Report")
|
||||
lines.append("=" * 70)
|
||||
lines.append("")
|
||||
|
||||
# Metadata
|
||||
lines.append("## System Information")
|
||||
lines.append(f" Timestamp: {result.timestamp}")
|
||||
lines.append(f" Python Version: {result.metadata.get('python_version', 'N/A')}")
|
||||
lines.append(f" Platform: {result.metadata.get('platform', 'N/A')}")
|
||||
lines.append(f" PraisonAI: {result.metadata.get('praisonai_version', 'N/A')}")
|
||||
lines.append("")
|
||||
|
||||
# Startup times
|
||||
lines.append("## Startup Times")
|
||||
lines.append(f" Cold Start: {result.startup_cold_ms:>10.2f} ms")
|
||||
lines.append(f" Warm Start: {result.startup_warm_ms:>10.2f} ms")
|
||||
lines.append("")
|
||||
|
||||
# Import analysis
|
||||
if result.import_analysis:
|
||||
lines.append("## Top Import Times")
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'Module':<45} {'Self (ms)':>10} {'Cumul (ms)':>12}")
|
||||
lines.append("-" * 70)
|
||||
for imp in result.import_analysis[:15]:
|
||||
module = imp["module"]
|
||||
if len(module) > 43:
|
||||
module = "..." + module[-40:]
|
||||
lines.append(f"{module:<45} {imp['self_ms']:>10.2f} {imp['cumulative_ms']:>12.2f}")
|
||||
lines.append("")
|
||||
|
||||
# Scenario results
|
||||
lines.append("## Scenario Results")
|
||||
lines.append("-" * 70)
|
||||
lines.append(f"{'Scenario':<25} {'Stream':>8} {'Iters':>6} {'Mean (ms)':>12} {'StdDev':>10}")
|
||||
lines.append("-" * 70)
|
||||
|
||||
for scenario in result.scenarios:
|
||||
stats = scenario.get_stats(scenario.total_times)
|
||||
stream_str = "Yes" if scenario.config.stream else "No"
|
||||
lines.append(
|
||||
f"{scenario.name:<25} {stream_str:>8} {len(scenario.results):>6} "
|
||||
f"{stats['mean']:>12.2f} {stats['stdev']:>10.2f}"
|
||||
)
|
||||
lines.append("")
|
||||
|
||||
# Summary statistics
|
||||
all_import_times = []
|
||||
all_total_times = []
|
||||
for scenario in result.scenarios:
|
||||
all_import_times.extend(scenario.import_times)
|
||||
all_total_times.extend(scenario.total_times)
|
||||
|
||||
if all_import_times:
|
||||
lines.append("## Overall Statistics")
|
||||
lines.append(f" Import Time (mean): {statistics.mean(all_import_times):>10.2f} ms")
|
||||
lines.append(f" Total Time (mean): {statistics.mean(all_total_times):>10.2f} ms")
|
||||
if len(all_total_times) > 1:
|
||||
lines.append(f" Total Time (stdev): {statistics.stdev(all_total_times):>10.2f} ms")
|
||||
lines.append("")
|
||||
|
||||
lines.append("=" * 70)
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def run_profile_suite(
|
||||
output_dir: Optional[str] = None,
|
||||
scenarios: Optional[List[ScenarioConfig]] = None,
|
||||
verbose: bool = True,
|
||||
) -> SuiteResult:
|
||||
"""
|
||||
Run a profile suite and return results.
|
||||
|
||||
Args:
|
||||
output_dir: Directory to save results
|
||||
scenarios: Custom scenarios to run
|
||||
verbose: Print progress
|
||||
|
||||
Returns:
|
||||
SuiteResult with all profiling data
|
||||
"""
|
||||
runner = ProfileSuiteRunner(
|
||||
scenarios=scenarios,
|
||||
output_dir=output_dir,
|
||||
verbose=verbose,
|
||||
)
|
||||
return runner.run()
|
||||
@@ -0,0 +1,73 @@
|
||||
"""
|
||||
Queue System for PraisonAI TUI.
|
||||
|
||||
Provides multi-run, multi-agent queueing with priorities, cancel/retry,
|
||||
streaming output, and persistence.
|
||||
|
||||
Lazy-loaded to avoid import overhead when not used.
|
||||
"""
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .models import QueuedRun, RunState, RunPriority, QueueConfig
|
||||
from .scheduler import QueueScheduler
|
||||
from .worker import WorkerPool
|
||||
from .persistence import QueuePersistence
|
||||
|
||||
_lazy_cache = {}
|
||||
|
||||
|
||||
def __getattr__(name: str):
|
||||
"""Lazy load queue components."""
|
||||
global _lazy_cache
|
||||
|
||||
if name in _lazy_cache:
|
||||
return _lazy_cache[name]
|
||||
|
||||
if name == "QueuedRun":
|
||||
from .models import QueuedRun
|
||||
_lazy_cache[name] = QueuedRun
|
||||
return QueuedRun
|
||||
elif name == "RunState":
|
||||
from .models import RunState
|
||||
_lazy_cache[name] = RunState
|
||||
return RunState
|
||||
elif name == "RunPriority":
|
||||
from .models import RunPriority
|
||||
_lazy_cache[name] = RunPriority
|
||||
return RunPriority
|
||||
elif name == "QueueConfig":
|
||||
from .models import QueueConfig
|
||||
_lazy_cache[name] = QueueConfig
|
||||
return QueueConfig
|
||||
elif name == "QueueScheduler":
|
||||
from .scheduler import QueueScheduler
|
||||
_lazy_cache[name] = QueueScheduler
|
||||
return QueueScheduler
|
||||
elif name == "WorkerPool":
|
||||
from .worker import WorkerPool
|
||||
_lazy_cache[name] = WorkerPool
|
||||
return WorkerPool
|
||||
elif name == "QueuePersistence":
|
||||
from .persistence import QueuePersistence
|
||||
_lazy_cache[name] = QueuePersistence
|
||||
return QueuePersistence
|
||||
elif name == "QueueManager":
|
||||
from .manager import QueueManager
|
||||
_lazy_cache[name] = QueueManager
|
||||
return QueueManager
|
||||
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
|
||||
|
||||
__all__ = [
|
||||
"QueuedRun",
|
||||
"RunState",
|
||||
"RunPriority",
|
||||
"QueueConfig",
|
||||
"QueueScheduler",
|
||||
"WorkerPool",
|
||||
"QueuePersistence",
|
||||
"QueueManager",
|
||||
]
|
||||
@@ -0,0 +1,431 @@
|
||||
"""
|
||||
Queue Manager for PraisonAI.
|
||||
|
||||
High-level interface that coordinates scheduler, workers, and persistence.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import os
|
||||
import time
|
||||
from typing import Any, Callable, Coroutine, Dict, List, Optional
|
||||
|
||||
from .models import QueuedRun, RunState, RunPriority, QueueConfig, QueueStats, QueueEvent
|
||||
from .scheduler import QueueScheduler, QueueFullError
|
||||
from .worker import WorkerPool
|
||||
from .persistence import QueuePersistence
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class QueueManager:
|
||||
"""
|
||||
High-level queue manager that coordinates all queue components.
|
||||
|
||||
Provides a unified interface for:
|
||||
- Submitting and managing runs
|
||||
- Starting/stopping workers
|
||||
- Persistence and crash recovery
|
||||
- Event handling
|
||||
"""
|
||||
|
||||
# Runtime tools registry - stores tools that can't be serialized to JSON
|
||||
# Key: run_id or "default", Value: list of tool callables
|
||||
_tools_registry: Dict[str, list] = {}
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
config: Optional[QueueConfig] = None,
|
||||
on_output: Optional[Callable[[str, str], Coroutine[Any, Any, None]]] = None,
|
||||
on_complete: Optional[Callable[[str, QueuedRun], Coroutine[Any, Any, None]]] = None,
|
||||
on_error: Optional[Callable[[str, Exception], Coroutine[Any, Any, None]]] = None,
|
||||
on_event: Optional[Callable[[QueueEvent], Coroutine[Any, Any, None]]] = None,
|
||||
default_tools: Optional[list] = None,
|
||||
):
|
||||
"""
|
||||
Initialize queue manager.
|
||||
|
||||
Args:
|
||||
config: Queue configuration.
|
||||
on_output: Callback for streaming output.
|
||||
on_complete: Callback when run completes.
|
||||
on_error: Callback when run fails.
|
||||
on_event: Callback for queue events.
|
||||
default_tools: Default tools to use for all runs (stored in runtime registry).
|
||||
"""
|
||||
self.config = config or QueueConfig()
|
||||
|
||||
# Initialize components
|
||||
self.scheduler = QueueScheduler(self.config)
|
||||
self.persistence = QueuePersistence(self.config.db_path) if self.config.enable_persistence else None
|
||||
|
||||
# Store callbacks
|
||||
self._on_output = on_output
|
||||
self._on_complete = on_complete
|
||||
self._on_error = on_error
|
||||
self._on_event = on_event
|
||||
|
||||
# Worker pool (created on start)
|
||||
self.workers: Optional[WorkerPool] = None
|
||||
|
||||
# Autosave task
|
||||
self._autosave_task: Optional[asyncio.Task] = None
|
||||
|
||||
# Running state
|
||||
self._running = False
|
||||
|
||||
# Session tracking
|
||||
self._current_session_id: Optional[str] = None
|
||||
|
||||
# Store default tools in registry
|
||||
if default_tools:
|
||||
QueueManager._tools_registry["default"] = default_tools
|
||||
|
||||
async def start(self, recover: bool = True) -> None:
|
||||
"""
|
||||
Start the queue manager.
|
||||
|
||||
Args:
|
||||
recover: If True, recover pending runs from persistence.
|
||||
"""
|
||||
if self._running:
|
||||
return
|
||||
|
||||
logger.info("Starting queue manager")
|
||||
|
||||
# Initialize persistence
|
||||
if self.persistence:
|
||||
self.persistence.initialize()
|
||||
|
||||
if recover:
|
||||
await self._recover_runs()
|
||||
|
||||
# Create and start worker pool
|
||||
self.workers = WorkerPool(
|
||||
scheduler=self.scheduler,
|
||||
on_output=self._on_output,
|
||||
on_complete=self._wrap_complete_callback(),
|
||||
on_error=self._wrap_error_callback(),
|
||||
on_event=self._on_event,
|
||||
max_workers=self.config.max_concurrent_global,
|
||||
poll_interval=self.config.worker_poll_interval,
|
||||
stream_buffer_size=self.config.stream_buffer_size,
|
||||
)
|
||||
|
||||
await self.workers.start()
|
||||
|
||||
# Start autosave
|
||||
if self.persistence and self.config.autosave_interval_seconds > 0:
|
||||
self._autosave_task = asyncio.create_task(
|
||||
self._autosave_loop(),
|
||||
name="queue-autosave"
|
||||
)
|
||||
|
||||
self._running = True
|
||||
logger.info("Queue manager started")
|
||||
|
||||
async def stop(self, timeout: float = 10.0) -> None:
|
||||
"""
|
||||
Stop the queue manager gracefully.
|
||||
|
||||
Args:
|
||||
timeout: Seconds to wait for workers to finish.
|
||||
"""
|
||||
if not self._running:
|
||||
return
|
||||
|
||||
logger.info("Stopping queue manager")
|
||||
|
||||
# Stop autosave
|
||||
if self._autosave_task:
|
||||
self._autosave_task.cancel()
|
||||
try:
|
||||
await self._autosave_task
|
||||
except asyncio.CancelledError:
|
||||
pass
|
||||
self._autosave_task = None
|
||||
|
||||
# Stop workers
|
||||
if self.workers:
|
||||
await self.workers.stop(timeout=timeout)
|
||||
self.workers = None
|
||||
|
||||
# Final save
|
||||
if self.persistence:
|
||||
await self._save_all_runs()
|
||||
self.persistence.close()
|
||||
|
||||
self._running = False
|
||||
logger.info("Queue manager stopped")
|
||||
|
||||
async def submit(
|
||||
self,
|
||||
input_content: str,
|
||||
agent_name: str = "Assistant",
|
||||
priority: RunPriority = RunPriority.NORMAL,
|
||||
session_id: Optional[str] = None,
|
||||
workspace: Optional[str] = None,
|
||||
config: Optional[Dict[str, Any]] = None,
|
||||
run_id: Optional[str] = None,
|
||||
chat_history: Optional[List[Dict[str, str]]] = None,
|
||||
) -> str:
|
||||
"""
|
||||
Submit a new run to the queue.
|
||||
|
||||
Args:
|
||||
input_content: The input/prompt for the agent.
|
||||
agent_name: Name of the agent to use.
|
||||
priority: Run priority.
|
||||
session_id: Session ID for grouping.
|
||||
workspace: Workspace path.
|
||||
config: Additional configuration.
|
||||
run_id: Optional specific run ID.
|
||||
chat_history: Previous chat messages for context continuity.
|
||||
|
||||
Returns:
|
||||
The run ID.
|
||||
"""
|
||||
run = QueuedRun(
|
||||
agent_name=agent_name,
|
||||
input_content=input_content,
|
||||
priority=priority,
|
||||
session_id=session_id or self._current_session_id,
|
||||
workspace=workspace or os.getcwd(),
|
||||
config=config or {},
|
||||
max_retries=self.config.default_max_retries,
|
||||
chat_history=chat_history or [],
|
||||
)
|
||||
|
||||
if run_id:
|
||||
run.run_id = run_id
|
||||
|
||||
# Submit to scheduler
|
||||
result_id = await self.scheduler.submit(run)
|
||||
|
||||
# Persist
|
||||
if self.persistence:
|
||||
self.persistence.save_run(run)
|
||||
|
||||
return result_id
|
||||
|
||||
async def cancel(self, run_id: str) -> bool:
|
||||
"""Cancel a run."""
|
||||
result = await self.scheduler.cancel(run_id)
|
||||
|
||||
if result and self.persistence:
|
||||
run = self.scheduler.get_run(run_id)
|
||||
if run:
|
||||
self.persistence.save_run(run)
|
||||
|
||||
return result
|
||||
|
||||
async def retry(self, run_id: str) -> Optional[str]:
|
||||
"""Retry a failed run."""
|
||||
new_id = await self.scheduler.retry(run_id)
|
||||
|
||||
if new_id and self.persistence:
|
||||
run = self.scheduler.get_run(new_id)
|
||||
if run:
|
||||
self.persistence.save_run(run)
|
||||
|
||||
return new_id
|
||||
|
||||
async def pause(self, run_id: str) -> bool:
|
||||
"""Pause a running run."""
|
||||
return await self.scheduler.pause(run_id)
|
||||
|
||||
async def resume(self, run_id: str) -> bool:
|
||||
"""Resume a paused run."""
|
||||
return await self.scheduler.resume(run_id)
|
||||
|
||||
async def update_input(self, run_id: str, new_input: str) -> bool:
|
||||
"""Update the input content of a queued run."""
|
||||
return await self.scheduler.update_input(run_id, new_input)
|
||||
|
||||
def get_run(self, run_id: str) -> Optional[QueuedRun]:
|
||||
"""Get a run by ID."""
|
||||
return self.scheduler.get_run(run_id)
|
||||
|
||||
def get_queued(self) -> List[QueuedRun]:
|
||||
"""Get all queued runs."""
|
||||
return self.scheduler.get_queued()
|
||||
|
||||
def get_running(self) -> List[QueuedRun]:
|
||||
"""Get all running runs."""
|
||||
return self.scheduler.get_running()
|
||||
|
||||
def list_runs(
|
||||
self,
|
||||
state: Optional[RunState] = None,
|
||||
session_id: Optional[str] = None,
|
||||
limit: int = 100,
|
||||
) -> List[QueuedRun]:
|
||||
"""
|
||||
List runs with optional filters.
|
||||
|
||||
For active runs, uses scheduler. For historical, uses persistence.
|
||||
"""
|
||||
if state and state.is_terminal() and self.persistence:
|
||||
return self.persistence.list_runs(
|
||||
state=state,
|
||||
session_id=session_id,
|
||||
limit=limit,
|
||||
)
|
||||
|
||||
# Get from scheduler
|
||||
runs = self.scheduler.get_all()
|
||||
|
||||
if state:
|
||||
runs = [r for r in runs if r.state == state]
|
||||
if session_id:
|
||||
runs = [r for r in runs if r.session_id == session_id]
|
||||
|
||||
return runs[:limit]
|
||||
|
||||
async def clear_queue(self) -> int:
|
||||
"""Clear all queued runs."""
|
||||
count = await self.scheduler.clear_queue()
|
||||
return count
|
||||
|
||||
def get_stats(self) -> QueueStats:
|
||||
"""Get queue statistics."""
|
||||
if self.persistence:
|
||||
return self.persistence.get_stats(self._current_session_id)
|
||||
|
||||
# Calculate from scheduler
|
||||
queued = self.scheduler.get_queued()
|
||||
running = self.scheduler.get_running()
|
||||
|
||||
return QueueStats(
|
||||
queued_count=len(queued),
|
||||
running_count=len(running),
|
||||
)
|
||||
|
||||
# Session management
|
||||
|
||||
def set_session(self, session_id: str) -> None:
|
||||
"""Set the current session ID."""
|
||||
self._current_session_id = session_id
|
||||
|
||||
def save_session_state(self, state: Dict[str, Any]) -> None:
|
||||
"""Save session state."""
|
||||
if self.persistence and self._current_session_id:
|
||||
self.persistence.save_session(
|
||||
self._current_session_id,
|
||||
state=state,
|
||||
)
|
||||
|
||||
def load_session_state(self, session_id: str) -> Optional[Dict[str, Any]]:
|
||||
"""Load session state."""
|
||||
if self.persistence:
|
||||
return self.persistence.load_session(session_id)
|
||||
return None
|
||||
|
||||
def list_sessions(self, limit: int = 50) -> List[Dict[str, Any]]:
|
||||
"""List recent sessions."""
|
||||
if self.persistence:
|
||||
return self.persistence.list_sessions(limit)
|
||||
return []
|
||||
|
||||
# Internal methods
|
||||
|
||||
async def _recover_runs(self) -> None:
|
||||
"""Recover pending runs from persistence."""
|
||||
if not self.persistence:
|
||||
return
|
||||
|
||||
# Mark interrupted runs as failed
|
||||
interrupted = self.persistence.mark_interrupted_as_failed()
|
||||
if interrupted:
|
||||
logger.warning(f"Marked {interrupted} interrupted runs as failed")
|
||||
|
||||
# Load pending runs
|
||||
pending = self.persistence.load_pending_runs()
|
||||
if pending:
|
||||
logger.info(f"Recovering {len(pending)} pending runs")
|
||||
self.scheduler.load_runs(pending)
|
||||
|
||||
for run in pending:
|
||||
self.persistence.mark_recovered(run.run_id)
|
||||
|
||||
async def _save_all_runs(self) -> None:
|
||||
"""Save all active runs to persistence."""
|
||||
if not self.persistence:
|
||||
return
|
||||
|
||||
for run in self.scheduler.get_all():
|
||||
self.persistence.save_run(run)
|
||||
|
||||
async def _autosave_loop(self) -> None:
|
||||
"""Periodically save runs to persistence."""
|
||||
while True:
|
||||
try:
|
||||
await asyncio.sleep(self.config.autosave_interval_seconds)
|
||||
await self._save_all_runs()
|
||||
logger.debug("Autosaved queue state")
|
||||
except asyncio.CancelledError:
|
||||
break
|
||||
except Exception as e:
|
||||
logger.error(f"Autosave error: {e}")
|
||||
|
||||
def _wrap_complete_callback(self):
|
||||
"""Wrap complete callback to include persistence."""
|
||||
async def wrapper(run_id: str, run: QueuedRun):
|
||||
# Persist
|
||||
if self.persistence:
|
||||
self.persistence.save_run(run)
|
||||
|
||||
# Call user callback
|
||||
if self._on_complete:
|
||||
await self._on_complete(run_id, run)
|
||||
|
||||
return wrapper
|
||||
|
||||
def _wrap_error_callback(self):
|
||||
"""Wrap error callback to include persistence."""
|
||||
async def wrapper(run_id: str, error: Exception):
|
||||
# Persist
|
||||
if self.persistence:
|
||||
run = self.scheduler.get_run(run_id)
|
||||
if run:
|
||||
self.persistence.save_run(run)
|
||||
|
||||
# Call user callback
|
||||
if self._on_error:
|
||||
await self._on_error(run_id, error)
|
||||
|
||||
return wrapper
|
||||
|
||||
@property
|
||||
def is_running(self) -> bool:
|
||||
"""Whether the queue manager is running."""
|
||||
return self._running
|
||||
|
||||
@property
|
||||
def queued_count(self) -> int:
|
||||
"""Number of queued runs."""
|
||||
return self.scheduler.queued_count
|
||||
|
||||
@property
|
||||
def running_count(self) -> int:
|
||||
"""Number of running runs."""
|
||||
return self.scheduler.running_count
|
||||
|
||||
@classmethod
|
||||
def get_tools_for_run(cls, run_id: str) -> list:
|
||||
"""
|
||||
Get tools for a specific run from the registry.
|
||||
|
||||
Falls back to default tools if no run-specific tools are registered.
|
||||
"""
|
||||
return cls._tools_registry.get(run_id) or cls._tools_registry.get("default", [])
|
||||
|
||||
@classmethod
|
||||
def register_tools(cls, run_id: str, tools: list) -> None:
|
||||
"""Register tools for a specific run."""
|
||||
cls._tools_registry[run_id] = tools
|
||||
|
||||
@classmethod
|
||||
def unregister_tools(cls, run_id: str) -> None:
|
||||
"""Unregister tools for a specific run."""
|
||||
cls._tools_registry.pop(run_id, None)
|
||||
@@ -0,0 +1,289 @@
|
||||
"""
|
||||
Data models for the PraisonAI Queue System.
|
||||
|
||||
Defines QueuedRun, RunState, RunPriority, and QueueConfig.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum, IntEnum
|
||||
from typing import Any, Dict, List, Optional
|
||||
import time
|
||||
import uuid
|
||||
|
||||
|
||||
class RunState(str, Enum):
|
||||
"""State of a queued run."""
|
||||
QUEUED = "queued"
|
||||
RUNNING = "running"
|
||||
PAUSED = "paused"
|
||||
SUCCEEDED = "succeeded"
|
||||
FAILED = "failed"
|
||||
CANCELLED = "cancelled"
|
||||
|
||||
def is_terminal(self) -> bool:
|
||||
"""Check if this is a terminal state."""
|
||||
return self in (RunState.SUCCEEDED, RunState.FAILED, RunState.CANCELLED)
|
||||
|
||||
def is_active(self) -> bool:
|
||||
"""Check if this is an active (non-terminal) state."""
|
||||
return not self.is_terminal()
|
||||
|
||||
|
||||
class RunPriority(IntEnum):
|
||||
"""Priority levels for queued runs. Higher value = higher priority."""
|
||||
LOW = 0
|
||||
NORMAL = 1
|
||||
HIGH = 2
|
||||
URGENT = 3
|
||||
|
||||
@classmethod
|
||||
def from_string(cls, s: str) -> "RunPriority":
|
||||
"""Parse priority from string."""
|
||||
mapping = {
|
||||
"low": cls.LOW,
|
||||
"normal": cls.NORMAL,
|
||||
"high": cls.HIGH,
|
||||
"urgent": cls.URGENT,
|
||||
}
|
||||
return mapping.get(s.lower(), cls.NORMAL)
|
||||
|
||||
|
||||
@dataclass
|
||||
class QueuedRun:
|
||||
"""A single queued agent run."""
|
||||
|
||||
# Identity
|
||||
run_id: str = field(default_factory=lambda: str(uuid.uuid4())[:8])
|
||||
agent_name: str = ""
|
||||
input_content: str = ""
|
||||
|
||||
# State
|
||||
state: RunState = RunState.QUEUED
|
||||
priority: RunPriority = RunPriority.NORMAL
|
||||
|
||||
# Attribution / tracing
|
||||
session_id: Optional[str] = None
|
||||
trace_id: Optional[str] = None
|
||||
workspace: Optional[str] = None
|
||||
user_id: Optional[str] = None
|
||||
|
||||
# Timing
|
||||
created_at: float = field(default_factory=time.time)
|
||||
started_at: Optional[float] = None
|
||||
ended_at: Optional[float] = None
|
||||
|
||||
# Results
|
||||
output_content: Optional[str] = None
|
||||
error: Optional[str] = None
|
||||
metrics: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
# Retry tracking
|
||||
retry_count: int = 0
|
||||
max_retries: int = 3
|
||||
parent_run_id: Optional[str] = None # Link to original run if this is a retry
|
||||
|
||||
# Configuration
|
||||
config: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
# Chat history for session continuity
|
||||
chat_history: List[Dict[str, str]] = field(default_factory=list)
|
||||
|
||||
# Streaming state
|
||||
output_chunks: List[str] = field(default_factory=list)
|
||||
|
||||
def __post_init__(self):
|
||||
"""Ensure proper types after initialization."""
|
||||
if isinstance(self.state, str):
|
||||
self.state = RunState(self.state)
|
||||
if isinstance(self.priority, int) and not isinstance(self.priority, RunPriority):
|
||||
self.priority = RunPriority(self.priority)
|
||||
|
||||
@property
|
||||
def duration_seconds(self) -> Optional[float]:
|
||||
"""Get run duration in seconds."""
|
||||
if self.started_at is None:
|
||||
return None
|
||||
end = self.ended_at or time.time()
|
||||
return end - self.started_at
|
||||
|
||||
@property
|
||||
def wait_seconds(self) -> float:
|
||||
"""Get time spent waiting in queue."""
|
||||
start = self.started_at or time.time()
|
||||
return start - self.created_at
|
||||
|
||||
def can_retry(self) -> bool:
|
||||
"""Check if this run can be retried."""
|
||||
return (
|
||||
self.state == RunState.FAILED and
|
||||
self.retry_count < self.max_retries
|
||||
)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary for persistence."""
|
||||
return {
|
||||
"run_id": self.run_id,
|
||||
"agent_name": self.agent_name,
|
||||
"input_content": self.input_content,
|
||||
"state": self.state.value,
|
||||
"priority": int(self.priority),
|
||||
"session_id": self.session_id,
|
||||
"trace_id": self.trace_id,
|
||||
"workspace": self.workspace,
|
||||
"user_id": self.user_id,
|
||||
"created_at": self.created_at,
|
||||
"started_at": self.started_at,
|
||||
"ended_at": self.ended_at,
|
||||
"output_content": self.output_content,
|
||||
"error": self.error,
|
||||
"metrics": self.metrics,
|
||||
"retry_count": self.retry_count,
|
||||
"max_retries": self.max_retries,
|
||||
"parent_run_id": self.parent_run_id,
|
||||
"config": self.config,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, data: Dict[str, Any]) -> "QueuedRun":
|
||||
"""Create from dictionary."""
|
||||
# Handle state conversion
|
||||
state = data.get("state", "queued")
|
||||
if isinstance(state, str):
|
||||
state = RunState(state)
|
||||
|
||||
# Handle priority conversion
|
||||
priority = data.get("priority", 1)
|
||||
if isinstance(priority, int):
|
||||
priority = RunPriority(priority)
|
||||
|
||||
return cls(
|
||||
run_id=data.get("run_id", str(uuid.uuid4())[:8]),
|
||||
agent_name=data.get("agent_name", ""),
|
||||
input_content=data.get("input_content", ""),
|
||||
state=state,
|
||||
priority=priority,
|
||||
session_id=data.get("session_id"),
|
||||
trace_id=data.get("trace_id"),
|
||||
workspace=data.get("workspace"),
|
||||
user_id=data.get("user_id"),
|
||||
created_at=data.get("created_at", time.time()),
|
||||
started_at=data.get("started_at"),
|
||||
ended_at=data.get("ended_at"),
|
||||
output_content=data.get("output_content"),
|
||||
error=data.get("error"),
|
||||
metrics=data.get("metrics", {}),
|
||||
retry_count=data.get("retry_count", 0),
|
||||
max_retries=data.get("max_retries", 3),
|
||||
parent_run_id=data.get("parent_run_id"),
|
||||
config=data.get("config", {}),
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class QueueConfig:
|
||||
"""Configuration for the queue system."""
|
||||
|
||||
# Concurrency limits
|
||||
max_concurrent_global: int = 4
|
||||
max_concurrent_per_agent: int = 2
|
||||
max_concurrent_per_workspace: int = 4
|
||||
|
||||
# Queue limits
|
||||
max_queue_size: int = 100
|
||||
|
||||
# Defaults
|
||||
default_priority: RunPriority = RunPriority.NORMAL
|
||||
default_max_retries: int = 3
|
||||
|
||||
# Persistence
|
||||
enable_persistence: bool = True
|
||||
db_path: str = ".praison/queue.db"
|
||||
|
||||
# Autosave
|
||||
autosave_interval_seconds: float = 30.0
|
||||
|
||||
# Backpressure
|
||||
stream_buffer_size: int = 1000
|
||||
drop_strategy: str = "oldest" # "oldest" or "newest"
|
||||
|
||||
# Timeouts
|
||||
run_timeout_seconds: Optional[float] = None # None = no timeout
|
||||
worker_poll_interval: float = 0.1
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary."""
|
||||
return {
|
||||
"max_concurrent_global": self.max_concurrent_global,
|
||||
"max_concurrent_per_agent": self.max_concurrent_per_agent,
|
||||
"max_concurrent_per_workspace": self.max_concurrent_per_workspace,
|
||||
"max_queue_size": self.max_queue_size,
|
||||
"default_priority": int(self.default_priority),
|
||||
"default_max_retries": self.default_max_retries,
|
||||
"enable_persistence": self.enable_persistence,
|
||||
"db_path": self.db_path,
|
||||
"autosave_interval_seconds": self.autosave_interval_seconds,
|
||||
"stream_buffer_size": self.stream_buffer_size,
|
||||
"drop_strategy": self.drop_strategy,
|
||||
"run_timeout_seconds": self.run_timeout_seconds,
|
||||
"worker_poll_interval": self.worker_poll_interval,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, data: Dict[str, Any]) -> "QueueConfig":
|
||||
"""Create from dictionary."""
|
||||
priority = data.get("default_priority", 1)
|
||||
if isinstance(priority, int):
|
||||
priority = RunPriority(priority)
|
||||
|
||||
return cls(
|
||||
max_concurrent_global=data.get("max_concurrent_global", 4),
|
||||
max_concurrent_per_agent=data.get("max_concurrent_per_agent", 2),
|
||||
max_concurrent_per_workspace=data.get("max_concurrent_per_workspace", 4),
|
||||
max_queue_size=data.get("max_queue_size", 100),
|
||||
default_priority=priority,
|
||||
default_max_retries=data.get("default_max_retries", 3),
|
||||
enable_persistence=data.get("enable_persistence", True),
|
||||
db_path=data.get("db_path", ".praison/queue.db"),
|
||||
autosave_interval_seconds=data.get("autosave_interval_seconds", 30.0),
|
||||
stream_buffer_size=data.get("stream_buffer_size", 1000),
|
||||
drop_strategy=data.get("drop_strategy", "oldest"),
|
||||
run_timeout_seconds=data.get("run_timeout_seconds"),
|
||||
worker_poll_interval=data.get("worker_poll_interval", 0.1),
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class QueueStats:
|
||||
"""Statistics about the queue."""
|
||||
queued_count: int = 0
|
||||
running_count: int = 0
|
||||
succeeded_count: int = 0
|
||||
failed_count: int = 0
|
||||
cancelled_count: int = 0
|
||||
total_runs: int = 0
|
||||
avg_wait_seconds: float = 0.0
|
||||
avg_duration_seconds: float = 0.0
|
||||
|
||||
@property
|
||||
def active_count(self) -> int:
|
||||
"""Count of active (non-terminal) runs."""
|
||||
return self.queued_count + self.running_count
|
||||
|
||||
|
||||
@dataclass
|
||||
class StreamChunk:
|
||||
"""A chunk of streaming output."""
|
||||
run_id: str
|
||||
content: str
|
||||
timestamp: float = field(default_factory=time.time)
|
||||
chunk_index: int = 0
|
||||
is_final: bool = False
|
||||
|
||||
|
||||
@dataclass
|
||||
class QueueEvent:
|
||||
"""An event from the queue system."""
|
||||
event_type: str # "run_started", "run_completed", "run_failed", "output_chunk", "state_changed"
|
||||
run_id: str
|
||||
timestamp: float = field(default_factory=time.time)
|
||||
data: Dict[str, Any] = field(default_factory=dict)
|
||||
@@ -0,0 +1,564 @@
|
||||
"""
|
||||
SQLite persistence layer for the PraisonAI Queue System.
|
||||
|
||||
Provides crash recovery, session persistence, and run history.
|
||||
"""
|
||||
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import sqlite3
|
||||
import threading
|
||||
import time
|
||||
from contextlib import contextmanager
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
from .models import QueuedRun, RunState, RunPriority, QueueStats
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
SCHEMA_VERSION = "1.0"
|
||||
|
||||
SCHEMA_SQL = """
|
||||
-- Schema version tracking
|
||||
CREATE TABLE IF NOT EXISTS schema_version (
|
||||
version TEXT PRIMARY KEY,
|
||||
applied_at REAL NOT NULL
|
||||
);
|
||||
|
||||
-- Queue runs
|
||||
CREATE TABLE IF NOT EXISTS runs (
|
||||
run_id TEXT PRIMARY KEY,
|
||||
agent_name TEXT NOT NULL,
|
||||
input_content TEXT,
|
||||
output_content TEXT,
|
||||
state TEXT NOT NULL DEFAULT 'queued',
|
||||
priority INTEGER NOT NULL DEFAULT 1,
|
||||
session_id TEXT,
|
||||
trace_id TEXT,
|
||||
workspace TEXT,
|
||||
user_id TEXT,
|
||||
created_at REAL NOT NULL,
|
||||
started_at REAL,
|
||||
ended_at REAL,
|
||||
error TEXT,
|
||||
retry_count INTEGER DEFAULT 0,
|
||||
max_retries INTEGER DEFAULT 3,
|
||||
parent_run_id TEXT,
|
||||
config TEXT,
|
||||
metrics TEXT,
|
||||
recovered INTEGER DEFAULT 0
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_runs_state ON runs(state);
|
||||
CREATE INDEX IF NOT EXISTS idx_runs_session ON runs(session_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_runs_priority_created ON runs(priority DESC, created_at ASC);
|
||||
CREATE INDEX IF NOT EXISTS idx_runs_workspace ON runs(workspace);
|
||||
|
||||
-- Messages (chat history per run)
|
||||
CREATE TABLE IF NOT EXISTS messages (
|
||||
message_id TEXT PRIMARY KEY,
|
||||
run_id TEXT REFERENCES runs(run_id),
|
||||
role TEXT NOT NULL,
|
||||
content TEXT NOT NULL,
|
||||
timestamp REAL NOT NULL,
|
||||
metadata TEXT
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_messages_run ON messages(run_id);
|
||||
|
||||
-- Tool calls
|
||||
CREATE TABLE IF NOT EXISTS tool_calls (
|
||||
call_id TEXT PRIMARY KEY,
|
||||
run_id TEXT REFERENCES runs(run_id),
|
||||
tool_name TEXT NOT NULL,
|
||||
args TEXT,
|
||||
result TEXT,
|
||||
started_at REAL NOT NULL,
|
||||
ended_at REAL,
|
||||
error TEXT
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_tool_calls_run ON tool_calls(run_id);
|
||||
|
||||
-- Sessions
|
||||
CREATE TABLE IF NOT EXISTS sessions (
|
||||
session_id TEXT PRIMARY KEY,
|
||||
user_id TEXT,
|
||||
created_at REAL NOT NULL,
|
||||
updated_at REAL NOT NULL,
|
||||
state TEXT,
|
||||
config TEXT
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_sessions_user ON sessions(user_id);
|
||||
"""
|
||||
|
||||
|
||||
class QueuePersistence:
|
||||
"""SQLite-backed persistence for the queue system."""
|
||||
|
||||
def __init__(self, db_path: str = ".praison/queue.db"):
|
||||
"""
|
||||
Initialize persistence layer.
|
||||
|
||||
Args:
|
||||
db_path: Path to SQLite database file.
|
||||
"""
|
||||
self.db_path = db_path
|
||||
self._conn: Optional[sqlite3.Connection] = None
|
||||
self._lock = threading.Lock()
|
||||
self._initialized = False
|
||||
|
||||
def _ensure_dir(self) -> None:
|
||||
"""Ensure database directory exists."""
|
||||
db_dir = os.path.dirname(self.db_path)
|
||||
if db_dir:
|
||||
os.makedirs(db_dir, exist_ok=True)
|
||||
|
||||
def _get_connection(self) -> sqlite3.Connection:
|
||||
"""Get or create database connection."""
|
||||
if self._conn is None:
|
||||
self._ensure_dir()
|
||||
self._conn = sqlite3.connect(
|
||||
self.db_path,
|
||||
check_same_thread=False,
|
||||
timeout=30.0
|
||||
)
|
||||
self._conn.row_factory = sqlite3.Row
|
||||
# Enable WAL mode for better concurrency
|
||||
self._conn.execute("PRAGMA journal_mode=WAL")
|
||||
self._conn.execute("PRAGMA synchronous=NORMAL")
|
||||
return self._conn
|
||||
|
||||
@contextmanager
|
||||
def _transaction(self):
|
||||
"""Context manager for database transactions."""
|
||||
conn = self._get_connection()
|
||||
with self._lock:
|
||||
try:
|
||||
yield conn
|
||||
conn.commit()
|
||||
except Exception:
|
||||
conn.rollback()
|
||||
raise
|
||||
|
||||
def initialize(self) -> None:
|
||||
"""Initialize database schema."""
|
||||
if self._initialized:
|
||||
return
|
||||
|
||||
with self._transaction() as conn:
|
||||
conn.executescript(SCHEMA_SQL)
|
||||
|
||||
# Check/set schema version
|
||||
cursor = conn.execute(
|
||||
"SELECT version FROM schema_version ORDER BY applied_at DESC LIMIT 1"
|
||||
)
|
||||
row = cursor.fetchone()
|
||||
|
||||
if row is None:
|
||||
conn.execute(
|
||||
"INSERT INTO schema_version (version, applied_at) VALUES (?, ?)",
|
||||
(SCHEMA_VERSION, time.time())
|
||||
)
|
||||
elif row["version"] != SCHEMA_VERSION:
|
||||
# Future: handle migrations
|
||||
logger.warning(
|
||||
f"Schema version mismatch: {row['version']} vs {SCHEMA_VERSION}"
|
||||
)
|
||||
|
||||
self._initialized = True
|
||||
|
||||
def close(self) -> None:
|
||||
"""Close database connection."""
|
||||
if self._conn is not None:
|
||||
self._conn.close()
|
||||
self._conn = None
|
||||
self._initialized = False
|
||||
|
||||
# Run operations
|
||||
|
||||
def save_run(self, run: QueuedRun) -> None:
|
||||
"""Save or update a run."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
conn.execute("""
|
||||
INSERT OR REPLACE INTO runs (
|
||||
run_id, agent_name, input_content, output_content,
|
||||
state, priority, session_id, trace_id, workspace, user_id,
|
||||
created_at, started_at, ended_at, error,
|
||||
retry_count, max_retries, parent_run_id,
|
||||
config, metrics
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
""", (
|
||||
run.run_id,
|
||||
run.agent_name,
|
||||
run.input_content,
|
||||
run.output_content,
|
||||
run.state.value,
|
||||
int(run.priority),
|
||||
run.session_id,
|
||||
run.trace_id,
|
||||
run.workspace,
|
||||
run.user_id,
|
||||
run.created_at,
|
||||
run.started_at,
|
||||
run.ended_at,
|
||||
run.error,
|
||||
run.retry_count,
|
||||
run.max_retries,
|
||||
run.parent_run_id,
|
||||
json.dumps(run.config) if run.config else None,
|
||||
json.dumps(run.metrics) if run.metrics else None,
|
||||
))
|
||||
|
||||
def load_run(self, run_id: str) -> Optional[QueuedRun]:
|
||||
"""Load a run by ID."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute(
|
||||
"SELECT * FROM runs WHERE run_id = ?",
|
||||
(run_id,)
|
||||
)
|
||||
row = cursor.fetchone()
|
||||
|
||||
if row is None:
|
||||
return None
|
||||
|
||||
return self._row_to_run(row)
|
||||
|
||||
def list_runs(
|
||||
self,
|
||||
state: Optional[RunState] = None,
|
||||
session_id: Optional[str] = None,
|
||||
workspace: Optional[str] = None,
|
||||
limit: int = 100,
|
||||
offset: int = 0,
|
||||
) -> List[QueuedRun]:
|
||||
"""List runs with optional filters."""
|
||||
self.initialize()
|
||||
|
||||
query = "SELECT * FROM runs WHERE 1=1"
|
||||
params: List[Any] = []
|
||||
|
||||
if state is not None:
|
||||
query += " AND state = ?"
|
||||
params.append(state.value)
|
||||
|
||||
if session_id is not None:
|
||||
query += " AND session_id = ?"
|
||||
params.append(session_id)
|
||||
|
||||
if workspace is not None:
|
||||
query += " AND workspace = ?"
|
||||
params.append(workspace)
|
||||
|
||||
query += " ORDER BY priority DESC, created_at ASC LIMIT ? OFFSET ?"
|
||||
params.extend([limit, offset])
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute(query, params)
|
||||
return [self._row_to_run(row) for row in cursor.fetchall()]
|
||||
|
||||
def delete_run(self, run_id: str) -> bool:
|
||||
"""Delete a run and its related data."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
# Delete related data first
|
||||
conn.execute("DELETE FROM messages WHERE run_id = ?", (run_id,))
|
||||
conn.execute("DELETE FROM tool_calls WHERE run_id = ?", (run_id,))
|
||||
|
||||
cursor = conn.execute("DELETE FROM runs WHERE run_id = ?", (run_id,))
|
||||
return cursor.rowcount > 0
|
||||
|
||||
def update_run_state(
|
||||
self,
|
||||
run_id: str,
|
||||
state: RunState,
|
||||
error: Optional[str] = None,
|
||||
output: Optional[str] = None,
|
||||
) -> bool:
|
||||
"""Update run state."""
|
||||
self.initialize()
|
||||
|
||||
updates = ["state = ?"]
|
||||
params: List[Any] = [state.value]
|
||||
|
||||
if state == RunState.RUNNING:
|
||||
updates.append("started_at = ?")
|
||||
params.append(time.time())
|
||||
elif state.is_terminal():
|
||||
updates.append("ended_at = ?")
|
||||
params.append(time.time())
|
||||
|
||||
if error is not None:
|
||||
updates.append("error = ?")
|
||||
params.append(error)
|
||||
|
||||
if output is not None:
|
||||
updates.append("output_content = ?")
|
||||
params.append(output)
|
||||
|
||||
params.append(run_id)
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute(
|
||||
f"UPDATE runs SET {', '.join(updates)} WHERE run_id = ?",
|
||||
params
|
||||
)
|
||||
return cursor.rowcount > 0
|
||||
|
||||
# Crash recovery
|
||||
|
||||
def load_pending_runs(self) -> List[QueuedRun]:
|
||||
"""Load runs that were QUEUED or RUNNING at crash."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT * FROM runs
|
||||
WHERE state IN ('queued', 'running')
|
||||
ORDER BY priority DESC, created_at ASC
|
||||
""")
|
||||
return [self._row_to_run(row) for row in cursor.fetchall()]
|
||||
|
||||
def mark_recovered(self, run_id: str) -> None:
|
||||
"""Mark a run as recovered after restart."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
conn.execute(
|
||||
"UPDATE runs SET recovered = 1 WHERE run_id = ?",
|
||||
(run_id,)
|
||||
)
|
||||
|
||||
def mark_interrupted_as_failed(self) -> int:
|
||||
"""Mark all RUNNING runs as FAILED (for crash recovery)."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute("""
|
||||
UPDATE runs
|
||||
SET state = 'failed',
|
||||
error = 'Interrupted by crash/restart',
|
||||
ended_at = ?
|
||||
WHERE state = 'running'
|
||||
""", (time.time(),))
|
||||
return cursor.rowcount
|
||||
|
||||
# Statistics
|
||||
|
||||
def get_stats(self, session_id: Optional[str] = None) -> QueueStats:
|
||||
"""Get queue statistics."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
where = ""
|
||||
params: List[Any] = []
|
||||
if session_id:
|
||||
where = "WHERE session_id = ?"
|
||||
params = [session_id]
|
||||
|
||||
# Count by state
|
||||
cursor = conn.execute(f"""
|
||||
SELECT state, COUNT(*) as count
|
||||
FROM runs {where}
|
||||
GROUP BY state
|
||||
""", params)
|
||||
|
||||
counts = {row["state"]: row["count"] for row in cursor.fetchall()}
|
||||
|
||||
# Average wait time
|
||||
cursor = conn.execute(f"""
|
||||
SELECT AVG(started_at - created_at) as avg_wait
|
||||
FROM runs
|
||||
{where + ' AND' if where else 'WHERE'} started_at IS NOT NULL
|
||||
""", params)
|
||||
row = cursor.fetchone()
|
||||
avg_wait = row["avg_wait"] or 0.0
|
||||
|
||||
# Average duration
|
||||
cursor = conn.execute(f"""
|
||||
SELECT AVG(ended_at - started_at) as avg_duration
|
||||
FROM runs
|
||||
{where + ' AND' if where else 'WHERE'} ended_at IS NOT NULL AND started_at IS NOT NULL
|
||||
""", params)
|
||||
row = cursor.fetchone()
|
||||
avg_duration = row["avg_duration"] or 0.0
|
||||
|
||||
return QueueStats(
|
||||
queued_count=counts.get("queued", 0),
|
||||
running_count=counts.get("running", 0),
|
||||
succeeded_count=counts.get("succeeded", 0),
|
||||
failed_count=counts.get("failed", 0),
|
||||
cancelled_count=counts.get("cancelled", 0),
|
||||
total_runs=sum(counts.values()),
|
||||
avg_wait_seconds=avg_wait,
|
||||
avg_duration_seconds=avg_duration,
|
||||
)
|
||||
|
||||
# Session operations
|
||||
|
||||
def save_session(
|
||||
self,
|
||||
session_id: str,
|
||||
user_id: Optional[str] = None,
|
||||
state: Optional[Dict[str, Any]] = None,
|
||||
config: Optional[Dict[str, Any]] = None,
|
||||
) -> None:
|
||||
"""Save or update a session."""
|
||||
self.initialize()
|
||||
|
||||
now = time.time()
|
||||
|
||||
with self._transaction() as conn:
|
||||
# Check if exists
|
||||
cursor = conn.execute(
|
||||
"SELECT session_id FROM sessions WHERE session_id = ?",
|
||||
(session_id,)
|
||||
)
|
||||
exists = cursor.fetchone() is not None
|
||||
|
||||
if exists:
|
||||
conn.execute("""
|
||||
UPDATE sessions SET
|
||||
user_id = COALESCE(?, user_id),
|
||||
updated_at = ?,
|
||||
state = COALESCE(?, state),
|
||||
config = COALESCE(?, config)
|
||||
WHERE session_id = ?
|
||||
""", (
|
||||
user_id,
|
||||
now,
|
||||
json.dumps(state) if state else None,
|
||||
json.dumps(config) if config else None,
|
||||
session_id,
|
||||
))
|
||||
else:
|
||||
conn.execute("""
|
||||
INSERT INTO sessions (session_id, user_id, created_at, updated_at, state, config)
|
||||
VALUES (?, ?, ?, ?, ?, ?)
|
||||
""", (
|
||||
session_id,
|
||||
user_id,
|
||||
now,
|
||||
now,
|
||||
json.dumps(state) if state else None,
|
||||
json.dumps(config) if config else None,
|
||||
))
|
||||
|
||||
def load_session(self, session_id: str) -> Optional[Dict[str, Any]]:
|
||||
"""Load a session."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute(
|
||||
"SELECT * FROM sessions WHERE session_id = ?",
|
||||
(session_id,)
|
||||
)
|
||||
row = cursor.fetchone()
|
||||
|
||||
if row is None:
|
||||
return None
|
||||
|
||||
return {
|
||||
"session_id": row["session_id"],
|
||||
"user_id": row["user_id"],
|
||||
"created_at": row["created_at"],
|
||||
"updated_at": row["updated_at"],
|
||||
"state": json.loads(row["state"]) if row["state"] else None,
|
||||
"config": json.loads(row["config"]) if row["config"] else None,
|
||||
}
|
||||
|
||||
def list_sessions(self, limit: int = 50) -> List[Dict[str, Any]]:
|
||||
"""List recent sessions."""
|
||||
self.initialize()
|
||||
|
||||
with self._transaction() as conn:
|
||||
cursor = conn.execute("""
|
||||
SELECT * FROM sessions
|
||||
ORDER BY updated_at DESC
|
||||
LIMIT ?
|
||||
""", (limit,))
|
||||
|
||||
return [
|
||||
{
|
||||
"session_id": row["session_id"],
|
||||
"user_id": row["user_id"],
|
||||
"created_at": row["created_at"],
|
||||
"updated_at": row["updated_at"],
|
||||
"state": json.loads(row["state"]) if row["state"] else None,
|
||||
"config": json.loads(row["config"]) if row["config"] else None,
|
||||
}
|
||||
for row in cursor.fetchall()
|
||||
]
|
||||
|
||||
# Helper methods
|
||||
|
||||
def _row_to_run(self, row: sqlite3.Row) -> QueuedRun:
|
||||
"""Convert database row to QueuedRun."""
|
||||
return QueuedRun(
|
||||
run_id=row["run_id"],
|
||||
agent_name=row["agent_name"],
|
||||
input_content=row["input_content"] or "",
|
||||
output_content=row["output_content"],
|
||||
state=RunState(row["state"]),
|
||||
priority=RunPriority(row["priority"]),
|
||||
session_id=row["session_id"],
|
||||
trace_id=row["trace_id"],
|
||||
workspace=row["workspace"],
|
||||
user_id=row["user_id"],
|
||||
created_at=row["created_at"],
|
||||
started_at=row["started_at"],
|
||||
ended_at=row["ended_at"],
|
||||
error=row["error"],
|
||||
retry_count=row["retry_count"] or 0,
|
||||
max_retries=row["max_retries"] or 3,
|
||||
parent_run_id=row["parent_run_id"],
|
||||
config=json.loads(row["config"]) if row["config"] else {},
|
||||
metrics=json.loads(row["metrics"]) if row["metrics"] else {},
|
||||
)
|
||||
|
||||
# Cleanup
|
||||
|
||||
def cleanup_old_runs(self, days: int = 30) -> int:
|
||||
"""Delete runs older than specified days."""
|
||||
self.initialize()
|
||||
|
||||
cutoff = time.time() - (days * 24 * 60 * 60)
|
||||
|
||||
with self._transaction() as conn:
|
||||
# Get run IDs to delete
|
||||
cursor = conn.execute("""
|
||||
SELECT run_id FROM runs
|
||||
WHERE created_at < ? AND state IN ('succeeded', 'failed', 'cancelled')
|
||||
""", (cutoff,))
|
||||
run_ids = [row["run_id"] for row in cursor.fetchall()]
|
||||
|
||||
if not run_ids:
|
||||
return 0
|
||||
|
||||
placeholders = ",".join("?" * len(run_ids))
|
||||
|
||||
# Delete related data
|
||||
conn.execute(
|
||||
f"DELETE FROM messages WHERE run_id IN ({placeholders})",
|
||||
run_ids
|
||||
)
|
||||
conn.execute(
|
||||
f"DELETE FROM tool_calls WHERE run_id IN ({placeholders})",
|
||||
run_ids
|
||||
)
|
||||
|
||||
# Delete runs
|
||||
cursor = conn.execute(
|
||||
f"DELETE FROM runs WHERE run_id IN ({placeholders})",
|
||||
run_ids
|
||||
)
|
||||
|
||||
return cursor.rowcount
|
||||
@@ -0,0 +1,518 @@
|
||||
"""
|
||||
Queue Scheduler for PraisonAI.
|
||||
|
||||
Priority-based FIFO scheduler with concurrency limits.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import time
|
||||
import uuid
|
||||
from collections import defaultdict
|
||||
from typing import Any, Callable, Dict, List, Optional, Set
|
||||
|
||||
from .models import QueuedRun, RunState, RunPriority, QueueConfig, QueueEvent
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class QueueFullError(Exception):
|
||||
"""Raised when queue is at capacity."""
|
||||
pass
|
||||
|
||||
|
||||
class RunNotFoundError(Exception):
|
||||
"""Raised when a run is not found."""
|
||||
pass
|
||||
|
||||
|
||||
class QueueScheduler:
|
||||
"""
|
||||
Priority-based FIFO scheduler with concurrency limits.
|
||||
|
||||
Runs are organized by priority (URGENT > HIGH > NORMAL > LOW),
|
||||
with FIFO ordering within each priority level.
|
||||
"""
|
||||
|
||||
def __init__(self, config: Optional[QueueConfig] = None):
|
||||
"""
|
||||
Initialize scheduler.
|
||||
|
||||
Args:
|
||||
config: Queue configuration. Uses defaults if not provided.
|
||||
"""
|
||||
self.config = config or QueueConfig()
|
||||
|
||||
# Priority queues: priority -> list of runs (FIFO order)
|
||||
self._queues: Dict[RunPriority, List[QueuedRun]] = {
|
||||
p: [] for p in RunPriority
|
||||
}
|
||||
|
||||
# Running runs: run_id -> run
|
||||
self._running: Dict[str, QueuedRun] = {}
|
||||
|
||||
# All runs by ID for quick lookup
|
||||
self._all_runs: Dict[str, QueuedRun] = {}
|
||||
|
||||
# Lock for thread safety
|
||||
self._lock = asyncio.Lock()
|
||||
|
||||
# Event callbacks
|
||||
self._event_callbacks: List[Callable[[QueueEvent], None]] = []
|
||||
|
||||
# Cancellation tokens
|
||||
self._cancel_tokens: Set[str] = set()
|
||||
|
||||
def add_event_callback(self, callback: Callable[[QueueEvent], None]) -> None:
|
||||
"""Add a callback for queue events."""
|
||||
self._event_callbacks.append(callback)
|
||||
|
||||
def remove_event_callback(self, callback: Callable[[QueueEvent], None]) -> None:
|
||||
"""Remove an event callback."""
|
||||
if callback in self._event_callbacks:
|
||||
self._event_callbacks.remove(callback)
|
||||
|
||||
def _emit_event(self, event: QueueEvent) -> None:
|
||||
"""Emit an event to all callbacks."""
|
||||
for callback in self._event_callbacks:
|
||||
try:
|
||||
callback(event)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in event callback: {e}")
|
||||
|
||||
async def submit(
|
||||
self,
|
||||
run: QueuedRun,
|
||||
check_duplicate: bool = True,
|
||||
) -> str:
|
||||
"""
|
||||
Submit a run to the queue.
|
||||
|
||||
Args:
|
||||
run: The run to submit.
|
||||
check_duplicate: If True, reject duplicate run_ids.
|
||||
|
||||
Returns:
|
||||
The run_id.
|
||||
|
||||
Raises:
|
||||
QueueFullError: If queue is at capacity.
|
||||
ValueError: If run_id already exists (when check_duplicate=True).
|
||||
"""
|
||||
async with self._lock:
|
||||
# Check for duplicates
|
||||
if check_duplicate and run.run_id in self._all_runs:
|
||||
raise ValueError(f"Run {run.run_id} already exists")
|
||||
|
||||
# Check queue capacity
|
||||
total_queued = sum(len(q) for q in self._queues.values())
|
||||
if total_queued >= self.config.max_queue_size:
|
||||
raise QueueFullError(
|
||||
f"Queue is full ({total_queued}/{self.config.max_queue_size})"
|
||||
)
|
||||
|
||||
# Ensure state is QUEUED
|
||||
run.state = RunState.QUEUED
|
||||
|
||||
# Add to appropriate priority queue
|
||||
self._queues[run.priority].append(run)
|
||||
self._all_runs[run.run_id] = run
|
||||
|
||||
logger.debug(f"Submitted run {run.run_id} with priority {run.priority.name}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_submitted",
|
||||
run_id=run.run_id,
|
||||
data={"priority": run.priority.name, "agent": run.agent_name}
|
||||
))
|
||||
|
||||
return run.run_id
|
||||
|
||||
async def next(self) -> Optional[QueuedRun]:
|
||||
"""
|
||||
Get the next run to execute, respecting priority and concurrency limits.
|
||||
|
||||
Returns:
|
||||
The next run, or None if no run is available.
|
||||
"""
|
||||
async with self._lock:
|
||||
if not self._can_start_new():
|
||||
return None
|
||||
|
||||
# Check priorities in order (URGENT first = highest value)
|
||||
for priority in reversed(list(RunPriority)):
|
||||
queue = self._queues[priority]
|
||||
|
||||
for i, run in enumerate(queue):
|
||||
if self._can_run(run):
|
||||
# Remove from queue
|
||||
queue.pop(i)
|
||||
|
||||
# Update state
|
||||
run.state = RunState.RUNNING
|
||||
run.started_at = time.time()
|
||||
|
||||
# Add to running
|
||||
self._running[run.run_id] = run
|
||||
|
||||
logger.debug(f"Starting run {run.run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_started",
|
||||
run_id=run.run_id,
|
||||
data={"agent": run.agent_name}
|
||||
))
|
||||
|
||||
return run
|
||||
|
||||
return None
|
||||
|
||||
async def complete(
|
||||
self,
|
||||
run_id: str,
|
||||
output: Optional[str] = None,
|
||||
metrics: Optional[Dict[str, Any]] = None,
|
||||
) -> Optional[QueuedRun]:
|
||||
"""
|
||||
Mark a run as completed successfully.
|
||||
|
||||
Args:
|
||||
run_id: The run ID.
|
||||
output: The output content.
|
||||
metrics: Optional metrics.
|
||||
|
||||
Returns:
|
||||
The completed run, or None if not found.
|
||||
"""
|
||||
async with self._lock:
|
||||
run = self._running.pop(run_id, None)
|
||||
if run is None:
|
||||
logger.warning(f"Run {run_id} not found in running")
|
||||
return None
|
||||
|
||||
run.state = RunState.SUCCEEDED
|
||||
run.ended_at = time.time()
|
||||
run.output_content = output
|
||||
if metrics:
|
||||
run.metrics.update(metrics)
|
||||
|
||||
logger.debug(f"Completed run {run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_completed",
|
||||
run_id=run_id,
|
||||
data={"duration": run.duration_seconds}
|
||||
))
|
||||
|
||||
return run
|
||||
|
||||
async def fail(
|
||||
self,
|
||||
run_id: str,
|
||||
error: str,
|
||||
metrics: Optional[Dict[str, Any]] = None,
|
||||
) -> Optional[QueuedRun]:
|
||||
"""
|
||||
Mark a run as failed.
|
||||
|
||||
Args:
|
||||
run_id: The run ID.
|
||||
error: The error message.
|
||||
metrics: Optional metrics.
|
||||
|
||||
Returns:
|
||||
The failed run, or None if not found.
|
||||
"""
|
||||
async with self._lock:
|
||||
run = self._running.pop(run_id, None)
|
||||
if run is None:
|
||||
logger.warning(f"Run {run_id} not found in running")
|
||||
return None
|
||||
|
||||
run.state = RunState.FAILED
|
||||
run.ended_at = time.time()
|
||||
run.error = error
|
||||
if metrics:
|
||||
run.metrics.update(metrics)
|
||||
|
||||
logger.debug(f"Failed run {run_id}: {error}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_failed",
|
||||
run_id=run_id,
|
||||
data={"error": error}
|
||||
))
|
||||
|
||||
return run
|
||||
|
||||
async def cancel(self, run_id: str) -> bool:
|
||||
"""
|
||||
Cancel a queued or running run.
|
||||
|
||||
Args:
|
||||
run_id: The run ID to cancel.
|
||||
|
||||
Returns:
|
||||
True if cancelled, False if not found.
|
||||
"""
|
||||
async with self._lock:
|
||||
# Check if running
|
||||
if run_id in self._running:
|
||||
run = self._running.pop(run_id)
|
||||
run.state = RunState.CANCELLED
|
||||
run.ended_at = time.time()
|
||||
self._cancel_tokens.add(run_id)
|
||||
|
||||
logger.debug(f"Cancelled running run {run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_cancelled",
|
||||
run_id=run_id,
|
||||
data={"was_running": True}
|
||||
))
|
||||
|
||||
return True
|
||||
|
||||
# Check if queued
|
||||
for priority in RunPriority:
|
||||
queue = self._queues[priority]
|
||||
for i, run in enumerate(queue):
|
||||
if run.run_id == run_id:
|
||||
queue.pop(i)
|
||||
run.state = RunState.CANCELLED
|
||||
run.ended_at = time.time()
|
||||
|
||||
logger.debug(f"Cancelled queued run {run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_cancelled",
|
||||
run_id=run_id,
|
||||
data={"was_running": False}
|
||||
))
|
||||
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
def is_cancelled(self, run_id: str) -> bool:
|
||||
"""Check if a run has been cancelled."""
|
||||
return run_id in self._cancel_tokens
|
||||
|
||||
def clear_cancel_token(self, run_id: str) -> None:
|
||||
"""Clear a cancellation token."""
|
||||
self._cancel_tokens.discard(run_id)
|
||||
|
||||
async def update_input(self, run_id: str, new_input: str) -> bool:
|
||||
"""
|
||||
Update the input content of a queued run.
|
||||
|
||||
Only works for runs in QUEUED state.
|
||||
|
||||
Args:
|
||||
run_id: The run ID to update.
|
||||
new_input: The new input content.
|
||||
|
||||
Returns:
|
||||
True if updated, False if not found or not editable.
|
||||
"""
|
||||
async with self._lock:
|
||||
run = self._all_runs.get(run_id)
|
||||
if run is None:
|
||||
return False
|
||||
|
||||
if run.state != RunState.QUEUED:
|
||||
logger.warning(f"Cannot edit run {run_id} in state {run.state}")
|
||||
return False
|
||||
|
||||
run.input_content = new_input
|
||||
|
||||
logger.debug(f"Updated input for run {run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_updated",
|
||||
run_id=run_id,
|
||||
data={"new_input": new_input[:50]}
|
||||
))
|
||||
|
||||
return True
|
||||
|
||||
async def retry(self, run_id: str) -> Optional[str]:
|
||||
"""
|
||||
Retry a failed run.
|
||||
|
||||
Creates a new run with incremented retry count and link to parent.
|
||||
|
||||
Args:
|
||||
run_id: The run ID to retry.
|
||||
|
||||
Returns:
|
||||
The new run_id, or None if retry not allowed.
|
||||
"""
|
||||
async with self._lock:
|
||||
# Find the original run
|
||||
original = self._all_runs.get(run_id)
|
||||
if original is None:
|
||||
logger.warning(f"Run {run_id} not found for retry")
|
||||
return None
|
||||
|
||||
if not original.can_retry():
|
||||
logger.warning(
|
||||
f"Run {run_id} cannot be retried "
|
||||
f"(state={original.state}, retries={original.retry_count}/{original.max_retries})"
|
||||
)
|
||||
return None
|
||||
|
||||
# Create new run
|
||||
new_run = QueuedRun(
|
||||
run_id=str(uuid.uuid4())[:8],
|
||||
agent_name=original.agent_name,
|
||||
input_content=original.input_content,
|
||||
state=RunState.QUEUED,
|
||||
priority=original.priority,
|
||||
session_id=original.session_id,
|
||||
trace_id=original.trace_id,
|
||||
workspace=original.workspace,
|
||||
user_id=original.user_id,
|
||||
retry_count=original.retry_count + 1,
|
||||
max_retries=original.max_retries,
|
||||
parent_run_id=original.run_id,
|
||||
config=original.config.copy(),
|
||||
)
|
||||
|
||||
# Submit outside lock to avoid deadlock
|
||||
await self.submit(new_run, check_duplicate=True)
|
||||
|
||||
logger.debug(f"Retrying run {run_id} as {new_run.run_id}")
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_retried",
|
||||
run_id=new_run.run_id,
|
||||
data={"parent_run_id": run_id, "retry_count": new_run.retry_count}
|
||||
))
|
||||
|
||||
return new_run.run_id
|
||||
|
||||
async def pause(self, run_id: str) -> bool:
|
||||
"""
|
||||
Pause a running run.
|
||||
|
||||
Note: The worker must check for pause state and handle accordingly.
|
||||
"""
|
||||
async with self._lock:
|
||||
if run_id not in self._running:
|
||||
return False
|
||||
|
||||
run = self._running[run_id]
|
||||
run.state = RunState.PAUSED
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_paused",
|
||||
run_id=run_id,
|
||||
))
|
||||
|
||||
return True
|
||||
|
||||
async def resume(self, run_id: str) -> bool:
|
||||
"""Resume a paused run."""
|
||||
async with self._lock:
|
||||
if run_id not in self._running:
|
||||
return False
|
||||
|
||||
run = self._running[run_id]
|
||||
if run.state != RunState.PAUSED:
|
||||
return False
|
||||
|
||||
run.state = RunState.RUNNING
|
||||
|
||||
self._emit_event(QueueEvent(
|
||||
event_type="run_resumed",
|
||||
run_id=run_id,
|
||||
))
|
||||
|
||||
return True
|
||||
|
||||
def get_run(self, run_id: str) -> Optional[QueuedRun]:
|
||||
"""Get a run by ID."""
|
||||
return self._all_runs.get(run_id)
|
||||
|
||||
def get_queued(self) -> List[QueuedRun]:
|
||||
"""Get all queued runs in priority order."""
|
||||
result = []
|
||||
for priority in reversed(list(RunPriority)):
|
||||
result.extend(self._queues[priority])
|
||||
return result
|
||||
|
||||
def get_running(self) -> List[QueuedRun]:
|
||||
"""Get all running runs."""
|
||||
return list(self._running.values())
|
||||
|
||||
def get_all(self) -> List[QueuedRun]:
|
||||
"""Get all runs."""
|
||||
return list(self._all_runs.values())
|
||||
|
||||
@property
|
||||
def queued_count(self) -> int:
|
||||
"""Number of queued runs."""
|
||||
return sum(len(q) for q in self._queues.values())
|
||||
|
||||
@property
|
||||
def running_count(self) -> int:
|
||||
"""Number of running runs."""
|
||||
return len(self._running)
|
||||
|
||||
def _can_start_new(self) -> bool:
|
||||
"""Check if we can start a new run (global limit)."""
|
||||
return len(self._running) < self.config.max_concurrent_global
|
||||
|
||||
def _can_run(self, run: QueuedRun) -> bool:
|
||||
"""Check if a specific run can start (per-agent and per-workspace limits)."""
|
||||
# Count running by agent
|
||||
agent_count = sum(
|
||||
1 for r in self._running.values()
|
||||
if r.agent_name == run.agent_name
|
||||
)
|
||||
if agent_count >= self.config.max_concurrent_per_agent:
|
||||
return False
|
||||
|
||||
# Count running by workspace
|
||||
if run.workspace:
|
||||
workspace_count = sum(
|
||||
1 for r in self._running.values()
|
||||
if r.workspace == run.workspace
|
||||
)
|
||||
if workspace_count >= self.config.max_concurrent_per_workspace:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
async def clear_queue(self) -> int:
|
||||
"""Clear all queued (not running) runs."""
|
||||
async with self._lock:
|
||||
count = 0
|
||||
for priority in RunPriority:
|
||||
count += len(self._queues[priority])
|
||||
for run in self._queues[priority]:
|
||||
run.state = RunState.CANCELLED
|
||||
del self._all_runs[run.run_id]
|
||||
self._queues[priority] = []
|
||||
|
||||
return count
|
||||
|
||||
def load_runs(self, runs: List[QueuedRun]) -> None:
|
||||
"""
|
||||
Load runs (e.g., from persistence after restart).
|
||||
|
||||
Queued runs are added to queues, running runs are re-queued.
|
||||
"""
|
||||
for run in runs:
|
||||
if run.state == RunState.RUNNING:
|
||||
# Re-queue running runs (they were interrupted)
|
||||
run.state = RunState.QUEUED
|
||||
run.started_at = None
|
||||
|
||||
if run.state == RunState.QUEUED:
|
||||
self._queues[run.priority].append(run)
|
||||
|
||||
self._all_runs[run.run_id] = run
|
||||
|
||||
logger.info(f"Loaded {len(runs)} runs from persistence")
|
||||
@@ -0,0 +1,383 @@
|
||||
"""
|
||||
Worker Pool for PraisonAI Queue System.
|
||||
|
||||
Manages async workers that execute queued runs.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import time
|
||||
from collections import deque
|
||||
from typing import Any, Callable, Coroutine, Dict, List, Optional, Set
|
||||
|
||||
from .models import QueuedRun, RunState, StreamChunk, QueueEvent
|
||||
from .scheduler import QueueScheduler
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class StreamBuffer:
|
||||
"""Bounded buffer with backpressure for streaming output."""
|
||||
|
||||
def __init__(self, max_size: int = 1000, drop_strategy: str = "oldest"):
|
||||
"""
|
||||
Initialize stream buffer.
|
||||
|
||||
Args:
|
||||
max_size: Maximum number of chunks to buffer.
|
||||
drop_strategy: "oldest" to drop oldest, "newest" to reject new.
|
||||
"""
|
||||
self._buffer: deque = deque(maxlen=max_size)
|
||||
self._lock = asyncio.Lock()
|
||||
self._drop_strategy = drop_strategy
|
||||
self._dropped_count = 0
|
||||
self._max_size = max_size
|
||||
|
||||
async def push(self, chunk: StreamChunk) -> bool:
|
||||
"""
|
||||
Push a chunk to the buffer.
|
||||
|
||||
Returns:
|
||||
True if added, False if dropped.
|
||||
"""
|
||||
async with self._lock:
|
||||
if len(self._buffer) >= self._max_size:
|
||||
if self._drop_strategy == "oldest":
|
||||
self._buffer.popleft()
|
||||
self._dropped_count += 1
|
||||
elif self._drop_strategy == "newest":
|
||||
self._dropped_count += 1
|
||||
return False
|
||||
self._buffer.append(chunk)
|
||||
return True
|
||||
|
||||
async def drain(self, batch_size: int = 50) -> List[StreamChunk]:
|
||||
"""Drain up to batch_size chunks."""
|
||||
async with self._lock:
|
||||
result = []
|
||||
for _ in range(min(batch_size, len(self._buffer))):
|
||||
result.append(self._buffer.popleft())
|
||||
return result
|
||||
|
||||
async def drain_all(self) -> List[StreamChunk]:
|
||||
"""Drain all chunks."""
|
||||
async with self._lock:
|
||||
result = list(self._buffer)
|
||||
self._buffer.clear()
|
||||
return result
|
||||
|
||||
@property
|
||||
def size(self) -> int:
|
||||
"""Current buffer size."""
|
||||
return len(self._buffer)
|
||||
|
||||
@property
|
||||
def dropped_count(self) -> int:
|
||||
"""Number of dropped chunks."""
|
||||
return self._dropped_count
|
||||
|
||||
|
||||
class WorkerPool:
|
||||
"""
|
||||
Manages worker tasks for executing queued runs.
|
||||
|
||||
Workers poll the scheduler for runs and execute them with streaming output.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
scheduler: QueueScheduler,
|
||||
on_output: Optional[Callable[[str, str], Coroutine[Any, Any, None]]] = None,
|
||||
on_complete: Optional[Callable[[str, QueuedRun], Coroutine[Any, Any, None]]] = None,
|
||||
on_error: Optional[Callable[[str, Exception], Coroutine[Any, Any, None]]] = None,
|
||||
on_event: Optional[Callable[[QueueEvent], Coroutine[Any, Any, None]]] = None,
|
||||
max_workers: int = 4,
|
||||
poll_interval: float = 0.1,
|
||||
stream_buffer_size: int = 1000,
|
||||
):
|
||||
"""
|
||||
Initialize worker pool.
|
||||
|
||||
Args:
|
||||
scheduler: The queue scheduler.
|
||||
on_output: Callback for streaming output (run_id, chunk).
|
||||
on_complete: Callback when run completes (run_id, run).
|
||||
on_error: Callback when run fails (run_id, exception).
|
||||
on_event: Callback for queue events.
|
||||
max_workers: Maximum number of concurrent workers.
|
||||
poll_interval: Seconds between scheduler polls.
|
||||
stream_buffer_size: Size of stream buffer per run.
|
||||
"""
|
||||
self.scheduler = scheduler
|
||||
self.on_output = on_output
|
||||
self.on_complete = on_complete
|
||||
self.on_error = on_error
|
||||
self.on_event = on_event
|
||||
self.max_workers = max_workers
|
||||
self.poll_interval = poll_interval
|
||||
self.stream_buffer_size = stream_buffer_size
|
||||
|
||||
self._workers: List[asyncio.Task] = []
|
||||
self._running = False
|
||||
self._stream_buffers: Dict[str, StreamBuffer] = {}
|
||||
self._active_runs: Set[str] = set()
|
||||
|
||||
async def start(self) -> None:
|
||||
"""Start the worker pool."""
|
||||
if self._running:
|
||||
return
|
||||
|
||||
self._running = True
|
||||
|
||||
for i in range(self.max_workers):
|
||||
task = asyncio.create_task(
|
||||
self._worker_loop(i),
|
||||
name=f"queue-worker-{i}"
|
||||
)
|
||||
self._workers.append(task)
|
||||
|
||||
logger.info(f"Started {self.max_workers} queue workers")
|
||||
|
||||
async def stop(self, timeout: float = 5.0) -> None:
|
||||
"""
|
||||
Stop all workers gracefully.
|
||||
|
||||
Args:
|
||||
timeout: Seconds to wait for workers to finish.
|
||||
"""
|
||||
self._running = False
|
||||
|
||||
if not self._workers:
|
||||
return
|
||||
|
||||
# Wait for workers to finish current work
|
||||
try:
|
||||
await asyncio.wait_for(
|
||||
asyncio.gather(*self._workers, return_exceptions=True),
|
||||
timeout=timeout
|
||||
)
|
||||
except asyncio.TimeoutError:
|
||||
# Cancel remaining workers
|
||||
for task in self._workers:
|
||||
if not task.done():
|
||||
task.cancel()
|
||||
|
||||
await asyncio.gather(*self._workers, return_exceptions=True)
|
||||
|
||||
self._workers.clear()
|
||||
logger.info("Stopped queue workers")
|
||||
|
||||
async def _worker_loop(self, worker_id: int) -> None:
|
||||
"""Main worker loop."""
|
||||
logger.debug(f"Worker {worker_id} started")
|
||||
|
||||
while self._running:
|
||||
try:
|
||||
# Get next run from scheduler
|
||||
run = await self.scheduler.next()
|
||||
|
||||
if run is None:
|
||||
# No work available, wait and retry
|
||||
await asyncio.sleep(self.poll_interval)
|
||||
continue
|
||||
|
||||
# Execute the run
|
||||
self._active_runs.add(run.run_id)
|
||||
try:
|
||||
await self._execute_run(run, worker_id)
|
||||
finally:
|
||||
self._active_runs.discard(run.run_id)
|
||||
|
||||
except asyncio.CancelledError:
|
||||
logger.debug(f"Worker {worker_id} cancelled")
|
||||
break
|
||||
except Exception as e:
|
||||
logger.error(f"Worker {worker_id} error: {e}", exc_info=True)
|
||||
await asyncio.sleep(self.poll_interval)
|
||||
|
||||
logger.debug(f"Worker {worker_id} stopped")
|
||||
|
||||
async def _execute_run(self, run: QueuedRun, worker_id: int) -> None:
|
||||
"""Execute a single run with streaming output."""
|
||||
logger.debug(f"Worker {worker_id} executing run {run.run_id}")
|
||||
|
||||
# Create stream buffer for this run
|
||||
buffer = StreamBuffer(max_size=self.stream_buffer_size)
|
||||
self._stream_buffers[run.run_id] = buffer
|
||||
|
||||
output_chunks: List[str] = []
|
||||
|
||||
try:
|
||||
# Import agent lazily to avoid circular imports
|
||||
from praisonaiagents import Agent
|
||||
from .manager import QueueManager
|
||||
|
||||
# Get agent configuration
|
||||
agent_config = run.config.get("agent_config", {})
|
||||
agent_name = run.agent_name or agent_config.get("name", "Assistant")
|
||||
|
||||
# Get tools from runtime registry (not from config, as functions can't be serialized)
|
||||
tools = QueueManager.get_tools_for_run(run.run_id)
|
||||
|
||||
# Create agent with session_id for history persistence
|
||||
# Note: Agent uses 'llm' parameter, not 'model'
|
||||
agent = Agent(
|
||||
name=agent_name,
|
||||
instructions=agent_config.get("instructions", "You are a helpful assistant."),
|
||||
llm=agent_config.get("model"),
|
||||
tools=tools,
|
||||
verbose=agent_config.get("verbose", False),
|
||||
session_id=agent_config.get("session_id") or run.session_id, # Use session for history
|
||||
)
|
||||
|
||||
# Inject chat history from session store for context continuity
|
||||
if run.chat_history:
|
||||
agent.chat_history = list(run.chat_history)
|
||||
logger.debug(f"Injected {len(run.chat_history)} messages from session history")
|
||||
|
||||
# Check for cancellation before starting
|
||||
if self.scheduler.is_cancelled(run.run_id):
|
||||
logger.debug(f"Run {run.run_id} was cancelled before execution")
|
||||
return
|
||||
|
||||
# Execute with streaming if available
|
||||
chunk_index = 0
|
||||
|
||||
# Try streaming first
|
||||
try:
|
||||
async for chunk in self._stream_agent(agent, run.input_content):
|
||||
# Check for cancellation
|
||||
if self.scheduler.is_cancelled(run.run_id):
|
||||
logger.debug(f"Run {run.run_id} cancelled during execution")
|
||||
self.scheduler.clear_cancel_token(run.run_id)
|
||||
return
|
||||
|
||||
# Check for pause
|
||||
while run.state == RunState.PAUSED:
|
||||
await asyncio.sleep(0.1)
|
||||
if self.scheduler.is_cancelled(run.run_id):
|
||||
return
|
||||
|
||||
output_chunks.append(chunk)
|
||||
|
||||
# Buffer the chunk
|
||||
stream_chunk = StreamChunk(
|
||||
run_id=run.run_id,
|
||||
content=chunk,
|
||||
chunk_index=chunk_index,
|
||||
)
|
||||
await buffer.push(stream_chunk)
|
||||
chunk_index += 1
|
||||
|
||||
# Emit output callback
|
||||
if self.on_output:
|
||||
try:
|
||||
await self.on_output(run.run_id, chunk)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in output callback: {e}")
|
||||
|
||||
except Exception as stream_error:
|
||||
# Fallback to non-streaming
|
||||
logger.debug(f"Streaming failed, falling back to sync: {stream_error}")
|
||||
result = agent.chat(run.input_content)
|
||||
output_chunks = [result]
|
||||
|
||||
if self.on_output:
|
||||
try:
|
||||
await self.on_output(run.run_id, result)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in output callback: {e}")
|
||||
|
||||
# Combine output
|
||||
full_output = "".join(output_chunks)
|
||||
|
||||
# Mark final chunk
|
||||
final_chunk = StreamChunk(
|
||||
run_id=run.run_id,
|
||||
content="",
|
||||
chunk_index=chunk_index,
|
||||
is_final=True,
|
||||
)
|
||||
await buffer.push(final_chunk)
|
||||
|
||||
# Complete the run
|
||||
completed_run = await self.scheduler.complete(
|
||||
run.run_id,
|
||||
output=full_output,
|
||||
metrics={
|
||||
"chunks": chunk_index,
|
||||
"output_length": len(full_output),
|
||||
}
|
||||
)
|
||||
|
||||
if completed_run and self.on_complete:
|
||||
try:
|
||||
await self.on_complete(run.run_id, completed_run)
|
||||
except Exception as e:
|
||||
logger.error(f"Error in complete callback: {e}")
|
||||
|
||||
except asyncio.CancelledError:
|
||||
# Worker was cancelled
|
||||
await self.scheduler.cancel(run.run_id)
|
||||
raise
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Run {run.run_id} failed: {e}", exc_info=True)
|
||||
|
||||
# Mark as failed
|
||||
failed_run = await self.scheduler.fail(run.run_id, str(e))
|
||||
|
||||
if self.on_error:
|
||||
try:
|
||||
await self.on_error(run.run_id, e)
|
||||
except Exception as callback_error:
|
||||
logger.error(f"Error in error callback: {callback_error}")
|
||||
|
||||
finally:
|
||||
# Cleanup buffer
|
||||
self._stream_buffers.pop(run.run_id, None)
|
||||
|
||||
async def _stream_agent(self, agent, input_content: str):
|
||||
"""
|
||||
Stream output from agent.
|
||||
|
||||
Yields chunks of output text.
|
||||
"""
|
||||
# Try to use agent's async streaming if available
|
||||
if hasattr(agent, 'astream'):
|
||||
async for chunk in agent.astream(input_content):
|
||||
yield chunk
|
||||
elif hasattr(agent, 'stream'):
|
||||
# Wrap sync stream in async
|
||||
for chunk in agent.stream(input_content):
|
||||
yield chunk
|
||||
await asyncio.sleep(0) # Yield control
|
||||
else:
|
||||
# Fallback: get full response and yield in chunks
|
||||
result = agent.chat(input_content)
|
||||
|
||||
# Simulate streaming by yielding words
|
||||
words = result.split()
|
||||
chunk_size = 3 # Words per chunk
|
||||
|
||||
for i in range(0, len(words), chunk_size):
|
||||
chunk_words = words[i:i + chunk_size]
|
||||
chunk = " ".join(chunk_words)
|
||||
if i + chunk_size < len(words):
|
||||
chunk += " "
|
||||
yield chunk
|
||||
await asyncio.sleep(0.05) # Small delay for streaming effect
|
||||
|
||||
def get_stream_buffer(self, run_id: str) -> Optional[StreamBuffer]:
|
||||
"""Get the stream buffer for a run."""
|
||||
return self._stream_buffers.get(run_id)
|
||||
|
||||
@property
|
||||
def active_run_count(self) -> int:
|
||||
"""Number of currently executing runs."""
|
||||
return len(self._active_runs)
|
||||
|
||||
@property
|
||||
def is_running(self) -> bool:
|
||||
"""Whether the worker pool is running."""
|
||||
return self._running
|
||||
@@ -0,0 +1,83 @@
|
||||
"""
|
||||
TUI (Terminal User Interface) for PraisonAI.
|
||||
|
||||
Provides an app-like interactive experience with:
|
||||
- Event-loop driven async UI
|
||||
- Multi-pane layout (chat, tools, queue, status)
|
||||
- Streaming output
|
||||
- Queue management
|
||||
- Session persistence
|
||||
- Headless simulation mode for CI/testing
|
||||
|
||||
Requires the [tui] extra: pip install praisonai[tui]
|
||||
"""
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .app import TUIApp
|
||||
from .events import TUIEvent, TUIEventType
|
||||
from .orchestrator import TuiOrchestrator, UIStateModel, SimulationRunner
|
||||
from .mock_provider import MockProvider, MockProviderConfig
|
||||
|
||||
_lazy_cache = {}
|
||||
|
||||
|
||||
def __getattr__(name: str):
|
||||
"""Lazy load TUI components."""
|
||||
global _lazy_cache
|
||||
|
||||
if name in _lazy_cache:
|
||||
return _lazy_cache[name]
|
||||
|
||||
if name == "TUIApp":
|
||||
from .app import TUIApp
|
||||
_lazy_cache[name] = TUIApp
|
||||
return TUIApp
|
||||
elif name == "TUIEvent":
|
||||
from .events import TUIEvent
|
||||
_lazy_cache[name] = TUIEvent
|
||||
return TUIEvent
|
||||
elif name == "TUIEventType":
|
||||
from .events import TUIEventType
|
||||
_lazy_cache[name] = TUIEventType
|
||||
return TUIEventType
|
||||
elif name == "run_tui":
|
||||
from .app import run_tui
|
||||
_lazy_cache[name] = run_tui
|
||||
return run_tui
|
||||
elif name == "TuiOrchestrator":
|
||||
from .orchestrator import TuiOrchestrator
|
||||
_lazy_cache[name] = TuiOrchestrator
|
||||
return TuiOrchestrator
|
||||
elif name == "UIStateModel":
|
||||
from .orchestrator import UIStateModel
|
||||
_lazy_cache[name] = UIStateModel
|
||||
return UIStateModel
|
||||
elif name == "SimulationRunner":
|
||||
from .orchestrator import SimulationRunner
|
||||
_lazy_cache[name] = SimulationRunner
|
||||
return SimulationRunner
|
||||
elif name == "MockProvider":
|
||||
from .mock_provider import MockProvider
|
||||
_lazy_cache[name] = MockProvider
|
||||
return MockProvider
|
||||
elif name == "MockProviderConfig":
|
||||
from .mock_provider import MockProviderConfig
|
||||
_lazy_cache[name] = MockProviderConfig
|
||||
return MockProviderConfig
|
||||
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
|
||||
|
||||
__all__ = [
|
||||
"TUIApp",
|
||||
"TUIEvent",
|
||||
"TUIEventType",
|
||||
"run_tui",
|
||||
"TuiOrchestrator",
|
||||
"UIStateModel",
|
||||
"SimulationRunner",
|
||||
"MockProvider",
|
||||
"MockProviderConfig",
|
||||
]
|
||||
@@ -0,0 +1,812 @@
|
||||
"""
|
||||
Main TUI Application for PraisonAI.
|
||||
|
||||
Event-loop driven async TUI with multi-pane layout.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import os
|
||||
import uuid
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
try:
|
||||
from textual.app import App, ComposeResult
|
||||
from textual.binding import Binding
|
||||
from textual import work
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
App = object
|
||||
work = None
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
from .screens.main import MainScreen
|
||||
from .screens.queue import QueueScreen
|
||||
from .screens.settings import SettingsScreen
|
||||
from .screens.session import SessionScreen
|
||||
from .screens.help import HelpScreen
|
||||
from .widgets.chat import ChatMessage
|
||||
from .widgets.status import StatusInfo
|
||||
from .widgets.queue_panel import QueueItem
|
||||
from ..queue import QueueManager, QueueConfig, QueuedRun, RunPriority
|
||||
from .session_store import SessionStore, get_session_store
|
||||
|
||||
class TUIApp(App):
|
||||
"""
|
||||
PraisonAI Terminal User Interface Application.
|
||||
|
||||
Features:
|
||||
- Event-loop driven async UI
|
||||
- Multi-pane layout (chat, tools, queue, status)
|
||||
- Streaming output
|
||||
- Queue management
|
||||
- Session persistence
|
||||
"""
|
||||
|
||||
TITLE = "PraisonAI"
|
||||
SUB_TITLE = "AI Agent Terminal"
|
||||
|
||||
CSS = """
|
||||
Screen {
|
||||
background: $surface;
|
||||
}
|
||||
"""
|
||||
|
||||
# Safe default bindings - Ctrl keys only at app level for emergency exit
|
||||
# MainScreen handles all other bindings with safe defaults
|
||||
BINDINGS = [
|
||||
# Emergency quit - kept at app level for reliability
|
||||
Binding("ctrl+q", "quit", "Quit", show=False, priority=True),
|
||||
Binding("ctrl+c", "cancel", "Cancel", show=False),
|
||||
]
|
||||
|
||||
SCREENS = {
|
||||
"main": MainScreen,
|
||||
"queue": QueueScreen,
|
||||
"settings": SettingsScreen,
|
||||
"sessions": SessionScreen,
|
||||
"help": HelpScreen,
|
||||
}
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
workspace: Optional[str] = None,
|
||||
session_id: Optional[str] = None,
|
||||
model: Optional[str] = None,
|
||||
agent_config: Optional[Dict[str, Any]] = None,
|
||||
queue_config: Optional[QueueConfig] = None,
|
||||
enable_acp: bool = True,
|
||||
enable_lsp: bool = True,
|
||||
):
|
||||
super().__init__()
|
||||
|
||||
self.workspace = workspace or os.getcwd()
|
||||
self.session_id = session_id or str(uuid.uuid4())[:8]
|
||||
self.model = model or os.environ.get("OPENAI_MODEL", "gpt-4o-mini")
|
||||
self.agent_config = agent_config or {}
|
||||
self.enable_acp = enable_acp
|
||||
self.enable_lsp = enable_lsp
|
||||
|
||||
# Load default interactive tools (ACP + LSP) if not provided
|
||||
if "tools" not in self.agent_config or not self.agent_config["tools"]:
|
||||
self.agent_config["tools"] = self._load_default_tools()
|
||||
|
||||
# Queue manager
|
||||
self.queue_config = queue_config or QueueConfig()
|
||||
self.queue_manager: Optional[QueueManager] = None
|
||||
|
||||
# Session store for chat history persistence
|
||||
self.session_store = get_session_store()
|
||||
|
||||
# State
|
||||
self._current_run_id: Optional[str] = None
|
||||
self._streaming_content: str = ""
|
||||
self._total_tokens: int = 0
|
||||
self._total_cost: float = 0.0
|
||||
|
||||
# Slash command handlers
|
||||
self._command_handlers: Dict[str, callable] = {}
|
||||
self._setup_commands()
|
||||
|
||||
def _load_default_tools(self) -> list:
|
||||
"""
|
||||
Load default interactive tools (ACP + LSP) for TUI.
|
||||
|
||||
Uses the canonical interactive_tools provider.
|
||||
"""
|
||||
try:
|
||||
from ..interactive_tools import get_interactive_tools, ToolConfig
|
||||
|
||||
# Build disable list based on flags
|
||||
disable = []
|
||||
if not self.enable_acp:
|
||||
disable.append('acp')
|
||||
if not self.enable_lsp:
|
||||
disable.append('lsp')
|
||||
|
||||
config = ToolConfig(
|
||||
workspace=self.workspace,
|
||||
enable_acp=self.enable_acp,
|
||||
enable_lsp=self.enable_lsp,
|
||||
)
|
||||
|
||||
tools = get_interactive_tools(
|
||||
config=config,
|
||||
disable=disable if disable else None,
|
||||
)
|
||||
|
||||
logger.info(f"TUI loaded {len(tools)} default tools (ACP: {self.enable_acp}, LSP: {self.enable_lsp})")
|
||||
return tools
|
||||
|
||||
except ImportError as e:
|
||||
logger.warning(f"Could not load interactive tools: {e}")
|
||||
return []
|
||||
except Exception as e:
|
||||
logger.error(f"Error loading default tools: {e}")
|
||||
return []
|
||||
|
||||
def _setup_commands(self) -> None:
|
||||
"""Setup slash command handlers."""
|
||||
self._command_handlers = {
|
||||
"help": self._cmd_help,
|
||||
"clear": self._cmd_clear,
|
||||
"model": self._cmd_model,
|
||||
"queue": self._cmd_queue,
|
||||
"cancel": self._cmd_cancel,
|
||||
"retry": self._cmd_retry,
|
||||
"settings": self._cmd_settings,
|
||||
"sessions": self._cmd_sessions,
|
||||
"cost": self._cmd_cost,
|
||||
"exit": self._cmd_exit,
|
||||
"quit": self._cmd_exit,
|
||||
# Additional commands
|
||||
"tokens": self._cmd_tokens,
|
||||
"plan": self._cmd_plan,
|
||||
"map": self._cmd_map,
|
||||
"undo": self._cmd_undo,
|
||||
"diff": self._cmd_diff,
|
||||
"commit": self._cmd_commit,
|
||||
"tools": self._cmd_tools,
|
||||
}
|
||||
|
||||
async def on_mount(self) -> None:
|
||||
"""Handle app mount."""
|
||||
# Initialize queue manager with default tools (stored in runtime registry)
|
||||
self.queue_manager = QueueManager(
|
||||
config=self.queue_config,
|
||||
on_output=self._handle_output,
|
||||
on_complete=self._handle_complete,
|
||||
on_error=self._handle_error,
|
||||
default_tools=self.agent_config.get("tools", []),
|
||||
)
|
||||
|
||||
await self.queue_manager.start(recover=True)
|
||||
self.queue_manager.set_session(self.session_id)
|
||||
|
||||
# Push main screen
|
||||
await self.push_screen("main")
|
||||
|
||||
# Update tools panel with available tools
|
||||
self._update_tools_panel()
|
||||
|
||||
# Update status
|
||||
self._update_status()
|
||||
|
||||
async def on_unmount(self) -> None:
|
||||
"""Handle app unmount."""
|
||||
if self.queue_manager:
|
||||
await self.queue_manager.stop()
|
||||
|
||||
def compose(self) -> ComposeResult:
|
||||
"""Compose the app."""
|
||||
yield from ()
|
||||
|
||||
# Event handlers
|
||||
|
||||
def on_main_screen_message_submitted(
|
||||
self, event: MainScreen.MessageSubmitted
|
||||
) -> None:
|
||||
"""Handle message submission - dispatch to worker for non-blocking execution."""
|
||||
# Use run_worker to avoid blocking the UI
|
||||
self.run_worker(
|
||||
self._process_message_submission(event.content),
|
||||
exclusive=False, # Allow multiple messages to queue
|
||||
exit_on_error=False,
|
||||
)
|
||||
|
||||
@work(exclusive=False, exit_on_error=False)
|
||||
async def _process_message_submission(self, content: str) -> None:
|
||||
"""Process message submission in background worker.
|
||||
|
||||
Using @work decorator ensures the UI remains responsive.
|
||||
User can type while agent is processing.
|
||||
"""
|
||||
# Add user message to chat display
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_user_message(content)
|
||||
main_screen.set_processing(True)
|
||||
|
||||
# Add user message to session store for history persistence
|
||||
self.session_store.add_user_message(self.session_id, content)
|
||||
|
||||
# Get chat history for context continuity
|
||||
chat_history = self.session_store.get_chat_history(self.session_id, max_messages=50)
|
||||
|
||||
# Submit to queue with chat history
|
||||
# Note: tools are NOT included in config (they can't be JSON serialized)
|
||||
# Instead, they are stored in QueueManager._tools_registry and retrieved by worker
|
||||
try:
|
||||
run_id = await self.queue_manager.submit(
|
||||
input_content=content,
|
||||
agent_name=self.agent_config.get("name", "Assistant"),
|
||||
session_id=self.session_id, # Pass session_id for history
|
||||
chat_history=chat_history, # Pass previous messages for context
|
||||
config={
|
||||
"agent_config": {
|
||||
"name": self.agent_config.get("name", "Assistant"),
|
||||
"instructions": self.agent_config.get(
|
||||
"instructions",
|
||||
"You are a helpful AI assistant."
|
||||
),
|
||||
"model": self.model,
|
||||
"verbose": False,
|
||||
"session_id": self.session_id, # Pass to agent for history
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
self._current_run_id = run_id
|
||||
self._streaming_content = ""
|
||||
|
||||
# IMMEDIATELY update queue panel - increment the moment message is queued
|
||||
self._update_queue_panel_live()
|
||||
|
||||
# Add streaming placeholder
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(
|
||||
content="",
|
||||
run_id=run_id,
|
||||
agent_name=self.agent_config.get("name", "Assistant"),
|
||||
streaming=True,
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to submit: {e}")
|
||||
if isinstance(main_screen, MainScreen):
|
||||
main_screen.set_processing(False)
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Error: {e}",
|
||||
agent_name="System",
|
||||
)
|
||||
|
||||
self._update_status()
|
||||
self._update_queue_panel_live()
|
||||
|
||||
async def on_main_screen_command_executed(
|
||||
self, event: MainScreen.CommandExecuted
|
||||
) -> None:
|
||||
"""Handle command execution."""
|
||||
command = event.command.lower()
|
||||
args = event.args
|
||||
|
||||
handler = self._command_handlers.get(command)
|
||||
if handler:
|
||||
await handler(args)
|
||||
else:
|
||||
# Unknown command
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Unknown command: /{command}\nType /help for available commands.",
|
||||
agent_name="System",
|
||||
)
|
||||
|
||||
async def on_main_screen_cancel_requested(
|
||||
self, event: MainScreen.CancelRequested
|
||||
) -> None:
|
||||
"""Handle cancel request."""
|
||||
if self._current_run_id:
|
||||
await self.queue_manager.cancel(self._current_run_id)
|
||||
self._current_run_id = None
|
||||
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
main_screen.set_processing(False)
|
||||
await main_screen.add_assistant_message(
|
||||
content="Operation cancelled.",
|
||||
agent_name="System",
|
||||
)
|
||||
|
||||
self._update_status()
|
||||
|
||||
async def on_queue_screen_run_cancelled(
|
||||
self, event: QueueScreen.RunCancelled
|
||||
) -> None:
|
||||
"""Handle run cancellation from queue screen."""
|
||||
await self.queue_manager.cancel(event.run_id)
|
||||
self._update_queue_screen()
|
||||
|
||||
async def on_queue_screen_run_retried(
|
||||
self, event: QueueScreen.RunRetried
|
||||
) -> None:
|
||||
"""Handle run retry from queue screen."""
|
||||
await self.queue_manager.retry(event.run_id)
|
||||
self._update_queue_screen()
|
||||
|
||||
async def on_queue_screen_queue_cleared(
|
||||
self, event: QueueScreen.QueueCleared
|
||||
) -> None:
|
||||
"""Handle queue clear."""
|
||||
await self.queue_manager.clear_queue()
|
||||
self._update_queue_screen()
|
||||
|
||||
async def on_settings_screen_settings_saved(
|
||||
self, event: SettingsScreen.SettingsSaved
|
||||
) -> None:
|
||||
"""Handle settings save."""
|
||||
settings = event.settings
|
||||
|
||||
if "model" in settings:
|
||||
self.model = settings["model"]
|
||||
|
||||
if "max_concurrent" in settings:
|
||||
self.queue_config.max_concurrent_global = settings["max_concurrent"]
|
||||
|
||||
if "autosave_interval" in settings:
|
||||
self.queue_config.autosave_interval_seconds = settings["autosave_interval"]
|
||||
|
||||
self._update_status()
|
||||
|
||||
async def on_session_screen_session_selected(
|
||||
self, event: SessionScreen.SessionSelected
|
||||
) -> None:
|
||||
"""Handle session selection."""
|
||||
self.session_id = event.session_id
|
||||
self.queue_manager.set_session(self.session_id)
|
||||
self._update_status()
|
||||
|
||||
async def on_queue_panel_widget_edit_requested(
|
||||
self, event
|
||||
) -> None:
|
||||
"""Handle queue item edit request."""
|
||||
from .widgets.queue_panel import QueuePanelWidget
|
||||
if isinstance(event, QueuePanelWidget.EditRequested):
|
||||
success = await self.queue_manager.update_input(event.run_id, event.new_content)
|
||||
if success:
|
||||
self._update_queue_panel_live()
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Updated queue item {event.run_id[:8]}",
|
||||
agent_name="System",
|
||||
)
|
||||
|
||||
# Queue callbacks
|
||||
|
||||
async def _handle_output(self, run_id: str, chunk: str) -> None:
|
||||
"""Handle streaming output."""
|
||||
if run_id != self._current_run_id:
|
||||
return
|
||||
|
||||
self._streaming_content += chunk
|
||||
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.update_streaming(run_id, self._streaming_content)
|
||||
|
||||
async def _handle_complete(self, run_id: str, run: QueuedRun) -> None:
|
||||
"""Handle run completion."""
|
||||
output_content = run.output_content or self._streaming_content
|
||||
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.complete_streaming(run_id, output_content)
|
||||
main_screen.set_processing(False)
|
||||
|
||||
# Store assistant response in session store for history persistence
|
||||
if output_content and run.session_id:
|
||||
self.session_store.add_assistant_message(run.session_id, output_content, run_id)
|
||||
|
||||
# Update metrics
|
||||
if run.metrics:
|
||||
self._total_tokens += run.metrics.get("tokens", 0)
|
||||
self._total_cost += run.metrics.get("cost", 0.0)
|
||||
|
||||
if run_id == self._current_run_id:
|
||||
self._current_run_id = None
|
||||
self._streaming_content = ""
|
||||
|
||||
self._update_status()
|
||||
self._update_queue_panel_live()
|
||||
|
||||
async def _handle_error(self, run_id: str, error: Exception) -> None:
|
||||
"""Handle run error."""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.complete_streaming(run_id, f"Error: {error}")
|
||||
main_screen.set_processing(False)
|
||||
|
||||
if run_id == self._current_run_id:
|
||||
self._current_run_id = None
|
||||
self._streaming_content = ""
|
||||
|
||||
self._update_status()
|
||||
self._update_queue_panel_live()
|
||||
|
||||
# Command handlers
|
||||
|
||||
async def _cmd_help(self, args: str) -> None:
|
||||
"""Show help."""
|
||||
help_text = """
|
||||
**Available Commands:**
|
||||
|
||||
- `/help` - Show this help
|
||||
- `/clear` - Clear chat history
|
||||
- `/model [name]` - Show or set model
|
||||
- `/queue` - Show queue screen
|
||||
- `/cancel [run_id]` - Cancel a run
|
||||
- `/retry [run_id]` - Retry a failed run
|
||||
- `/settings` - Show settings
|
||||
- `/sessions` - Browse sessions
|
||||
- `/cost` - Show cost summary
|
||||
- `/exit` or `/quit` - Exit TUI
|
||||
|
||||
**Keyboard Shortcuts (Safe Defaults):**
|
||||
|
||||
- `Enter` - Send message
|
||||
- `Shift+Enter` - New line
|
||||
- `q` - Quit (when not typing)
|
||||
- `:` - Command mode
|
||||
- `?` - Help
|
||||
- `Esc` - Cancel/close
|
||||
|
||||
**Command Mode:**
|
||||
|
||||
Press `:` then type a command:
|
||||
- `:quit` or `:q` - Quit
|
||||
- `:clear` or `:cl` - Clear chat
|
||||
- `:help` or `:h` - Help
|
||||
- `:tools` or `:t` - Toggle tools
|
||||
- `:queue` or `:qu` - Toggle queue
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(
|
||||
content=help_text,
|
||||
agent_name="Help",
|
||||
)
|
||||
|
||||
async def _cmd_clear(self, args: str) -> None:
|
||||
"""Clear chat."""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.query_one("#chat-widget").clear()
|
||||
|
||||
async def _cmd_model(self, args: str) -> None:
|
||||
"""Show or set model."""
|
||||
main_screen = self.screen
|
||||
if args:
|
||||
self.model = args.strip()
|
||||
msg = f"Model set to: {self.model}"
|
||||
else:
|
||||
msg = f"Current model: {self.model}"
|
||||
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
self._update_status()
|
||||
|
||||
async def _cmd_queue(self, args: str) -> None:
|
||||
"""Show queue screen."""
|
||||
await self.push_screen("queue")
|
||||
self._update_queue_screen()
|
||||
|
||||
async def _cmd_cancel(self, args: str) -> None:
|
||||
"""Cancel a run."""
|
||||
run_id = args.strip() if args else self._current_run_id
|
||||
if run_id:
|
||||
await self.queue_manager.cancel(run_id)
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Cancelled run: {run_id}",
|
||||
agent_name="System",
|
||||
)
|
||||
self._update_status()
|
||||
|
||||
async def _cmd_retry(self, args: str) -> None:
|
||||
"""Retry a failed run."""
|
||||
run_id = args.strip()
|
||||
if run_id:
|
||||
new_id = await self.queue_manager.retry(run_id)
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
if new_id:
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Retrying run {run_id} as {new_id}",
|
||||
agent_name="System",
|
||||
)
|
||||
else:
|
||||
await main_screen.add_assistant_message(
|
||||
content=f"Cannot retry run: {run_id}",
|
||||
agent_name="System",
|
||||
)
|
||||
self._update_status()
|
||||
|
||||
async def _cmd_settings(self, args: str) -> None:
|
||||
"""Show settings."""
|
||||
await self.push_screen(SettingsScreen(current_settings={
|
||||
"model": self.model,
|
||||
"max_concurrent": self.queue_config.max_concurrent_global,
|
||||
"autosave_interval": int(self.queue_config.autosave_interval_seconds),
|
||||
}))
|
||||
|
||||
async def _cmd_sessions(self, args: str) -> None:
|
||||
"""Show sessions."""
|
||||
await self.push_screen("sessions")
|
||||
# Load and display sessions
|
||||
await self._update_sessions_screen()
|
||||
|
||||
async def _cmd_cost(self, args: str) -> None:
|
||||
"""Show cost summary."""
|
||||
msg = f"""
|
||||
**Cost Summary:**
|
||||
|
||||
- Total Tokens: {self._total_tokens:,}
|
||||
- Total Cost: ${self._total_cost:.4f}
|
||||
- Session: {self.session_id}
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_exit(self, args: str) -> None:
|
||||
"""Exit TUI."""
|
||||
self.exit()
|
||||
|
||||
async def _cmd_tokens(self, args: str) -> None:
|
||||
"""Show token usage breakdown."""
|
||||
msg = f"""
|
||||
**Token Usage:**
|
||||
|
||||
- Total Tokens: {self._total_tokens:,}
|
||||
- Estimated Cost: ${self._total_cost:.4f}
|
||||
- Session: {self.session_id}
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_plan(self, args: str) -> None:
|
||||
"""Show or create a plan."""
|
||||
msg = """
|
||||
**Plan Command:**
|
||||
|
||||
The /plan command is used to create or view task plans.
|
||||
Currently, plans are managed through the agent's task execution.
|
||||
|
||||
Usage:
|
||||
- `/plan` - View current plan
|
||||
- `/plan <task>` - Create a plan for a task
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_map(self, args: str) -> None:
|
||||
"""Show repository map."""
|
||||
msg = """
|
||||
**Repository Map:**
|
||||
|
||||
The /map command shows a map of the repository structure.
|
||||
Use the file tools to explore the codebase.
|
||||
|
||||
Available tools:
|
||||
- `acp_list_files` - List files in a directory
|
||||
- `acp_read_file` - Read file contents
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_undo(self, args: str) -> None:
|
||||
"""Undo last change."""
|
||||
msg = """
|
||||
**Undo:**
|
||||
|
||||
The /undo command reverts the last file change.
|
||||
Use git commands or the agent to manage file changes.
|
||||
|
||||
Tip: Ask the agent to "undo the last change" or use git.
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_diff(self, args: str) -> None:
|
||||
"""Show diff of changes."""
|
||||
msg = """
|
||||
**Diff:**
|
||||
|
||||
The /diff command shows changes made to files.
|
||||
Use git diff or ask the agent to show changes.
|
||||
|
||||
Tip: Ask the agent "show me the diff" or use `git diff`.
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_commit(self, args: str) -> None:
|
||||
"""Commit changes."""
|
||||
msg = """
|
||||
**Commit:**
|
||||
|
||||
The /commit command creates a git commit.
|
||||
Use git commands or ask the agent to commit changes.
|
||||
|
||||
Tip: Ask the agent to "commit the changes with message X".
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
async def _cmd_tools(self, args: str) -> None:
|
||||
"""Show available tools."""
|
||||
tools = self.agent_config.get("tools", [])
|
||||
tool_names = []
|
||||
for tool in tools:
|
||||
if hasattr(tool, '__name__'):
|
||||
tool_names.append(tool.__name__)
|
||||
elif hasattr(tool, 'name'):
|
||||
tool_names.append(tool.name)
|
||||
else:
|
||||
tool_names.append(str(tool)[:30])
|
||||
|
||||
msg = f"""
|
||||
**Available Tools ({len(tools)}):**
|
||||
|
||||
{chr(10).join(f'- {name}' for name in tool_names[:20])}
|
||||
{"..." if len(tool_names) > 20 else ""}
|
||||
"""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
await main_screen.add_assistant_message(content=msg, agent_name="System")
|
||||
|
||||
# Helper methods
|
||||
|
||||
def _update_status(self) -> None:
|
||||
"""Update status bar."""
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
main_screen.update_status(StatusInfo(
|
||||
session_id=self.session_id,
|
||||
model=self.model,
|
||||
total_tokens=self._total_tokens,
|
||||
total_cost=self._total_cost,
|
||||
queued_count=self.queue_manager.queued_count if self.queue_manager else 0,
|
||||
running_count=self.queue_manager.running_count if self.queue_manager else 0,
|
||||
is_processing=self._current_run_id is not None,
|
||||
))
|
||||
|
||||
def _update_queue_panel_live(self) -> None:
|
||||
"""Update queue panel on MainScreen with live counts."""
|
||||
from .widgets.queue_panel import QueuePanelWidget
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
try:
|
||||
queue_panel = main_screen.query_one("#queue-panel", QueuePanelWidget)
|
||||
# Update counts immediately
|
||||
queue_panel.queued_count = self.queue_manager.queued_count if self.queue_manager else 0
|
||||
queue_panel.running_count = self.queue_manager.running_count if self.queue_manager else 0
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def _update_queue_screen(self) -> None:
|
||||
"""Update queue screen if visible."""
|
||||
if isinstance(self.screen, QueueScreen):
|
||||
runs = self.queue_manager.list_runs(limit=100)
|
||||
self.screen.update_runs([
|
||||
{
|
||||
"run_id": r.run_id,
|
||||
"agent_name": r.agent_name,
|
||||
"input": r.input_content,
|
||||
"state": r.state.value,
|
||||
"priority": r.priority.name.lower(),
|
||||
"wait_time": f"{r.wait_seconds:.1f}s" if r.wait_seconds else "-",
|
||||
"duration": f"{r.duration_seconds:.1f}s" if r.duration_seconds else "-",
|
||||
}
|
||||
for r in runs
|
||||
])
|
||||
|
||||
async def _update_sessions_screen(self) -> None:
|
||||
"""Update sessions screen with session list."""
|
||||
if isinstance(self.screen, SessionScreen):
|
||||
# Get sessions from queue manager or session store
|
||||
sessions = []
|
||||
if self.queue_manager:
|
||||
try:
|
||||
# Try to get sessions from the persistence layer
|
||||
from ..queue.persistence import QueuePersistence
|
||||
persistence = QueuePersistence()
|
||||
sessions = persistence.list_sessions(limit=50)
|
||||
except Exception as e:
|
||||
logger.debug(f"Could not load sessions: {e}")
|
||||
# Fallback: show current session only
|
||||
sessions = [{
|
||||
"session_id": self.session_id,
|
||||
"created_at": "-",
|
||||
"updated_at": "-",
|
||||
"run_count": self.queue_manager.queued_count + self.queue_manager.running_count,
|
||||
}]
|
||||
|
||||
self.screen.update_sessions(sessions)
|
||||
|
||||
def _update_tools_panel(self) -> None:
|
||||
"""Update tools panel with available tools."""
|
||||
from .widgets.tool_panel import ToolPanelWidget
|
||||
main_screen = self.screen
|
||||
if isinstance(main_screen, MainScreen):
|
||||
try:
|
||||
tool_panel = main_screen.query_one("#tool-panel", ToolPanelWidget)
|
||||
tools = self.agent_config.get("tools", [])
|
||||
tool_panel.set_available_tools(tools)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def action_quit(self) -> None:
|
||||
"""Quit the application."""
|
||||
self.exit()
|
||||
|
||||
def action_cancel(self) -> None:
|
||||
"""Cancel current operation."""
|
||||
if self._current_run_id and self.queue_manager:
|
||||
asyncio.create_task(self.queue_manager.cancel(self._current_run_id))
|
||||
|
||||
else:
|
||||
class TUIApp:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
|
||||
|
||||
def run_tui(
|
||||
workspace: Optional[str] = None,
|
||||
session_id: Optional[str] = None,
|
||||
model: Optional[str] = None,
|
||||
agent_config: Optional[Dict[str, Any]] = None,
|
||||
enable_acp: bool = True,
|
||||
enable_lsp: bool = True,
|
||||
) -> None:
|
||||
"""
|
||||
Run the PraisonAI TUI.
|
||||
|
||||
Args:
|
||||
workspace: Working directory.
|
||||
session_id: Session ID to resume.
|
||||
model: Default model.
|
||||
agent_config: Agent configuration.
|
||||
enable_acp: Enable ACP tools (default: True).
|
||||
enable_lsp: Enable LSP tools (default: True).
|
||||
"""
|
||||
if not TEXTUAL_AVAILABLE:
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
|
||||
app = TUIApp(
|
||||
workspace=workspace,
|
||||
session_id=session_id,
|
||||
model=model,
|
||||
agent_config=agent_config,
|
||||
enable_acp=enable_acp,
|
||||
enable_lsp=enable_lsp,
|
||||
)
|
||||
app.run()
|
||||
@@ -0,0 +1,566 @@
|
||||
"""
|
||||
CLI Commands for PraisonAI TUI and Queue.
|
||||
|
||||
Provides Typer-based CLI commands for:
|
||||
- praison tui - Launch interactive TUI
|
||||
- praison run - Execute single task
|
||||
- praison queue ls/cancel/retry/clear
|
||||
- praison session ls/resume
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from typing import Optional
|
||||
|
||||
try:
|
||||
import typer
|
||||
from rich.console import Console
|
||||
from rich.table import Table
|
||||
from rich.panel import Panel
|
||||
TYPER_AVAILABLE = True
|
||||
except ImportError:
|
||||
TYPER_AVAILABLE = False
|
||||
typer = None
|
||||
|
||||
console = Console() if TYPER_AVAILABLE else None
|
||||
|
||||
|
||||
def create_tui_app():
|
||||
"""Create the TUI CLI app."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
app = typer.Typer(
|
||||
name="tui",
|
||||
help="PraisonAI TUI and Queue commands",
|
||||
no_args_is_help=True,
|
||||
)
|
||||
|
||||
@app.command("launch")
|
||||
def tui_launch(
|
||||
workspace: Optional[str] = typer.Option(
|
||||
None, "--workspace", "-w",
|
||||
help="Workspace directory"
|
||||
),
|
||||
session: Optional[str] = typer.Option(
|
||||
None, "--session", "-s",
|
||||
help="Resume session ID"
|
||||
),
|
||||
model: Optional[str] = typer.Option(
|
||||
None, "--model", "-m",
|
||||
help="Default model"
|
||||
),
|
||||
agent: Optional[str] = typer.Option(
|
||||
None, "--agent", "-a",
|
||||
help="Agent config file (YAML)"
|
||||
),
|
||||
no_acp: bool = typer.Option(
|
||||
False, "--no-acp",
|
||||
help="Disable ACP tools (file operations with plan/approve/apply)"
|
||||
),
|
||||
no_lsp: bool = typer.Option(
|
||||
False, "--no-lsp",
|
||||
help="Disable LSP tools (code intelligence: symbols, definitions)"
|
||||
),
|
||||
):
|
||||
"""Launch the interactive TUI with ACP + LSP tools enabled by default."""
|
||||
try:
|
||||
from .app import run_tui
|
||||
except ImportError:
|
||||
console.print(
|
||||
"[red]Textual is required for TUI. Install with:[/red]\n"
|
||||
" pip install praisonai[tui]"
|
||||
)
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Load agent config if provided
|
||||
agent_config = {}
|
||||
if agent:
|
||||
import yaml
|
||||
with open(agent, "r") as f:
|
||||
agent_config = yaml.safe_load(f)
|
||||
|
||||
run_tui(
|
||||
workspace=workspace,
|
||||
session_id=session,
|
||||
model=model,
|
||||
agent_config=agent_config,
|
||||
enable_acp=not no_acp,
|
||||
enable_lsp=not no_lsp,
|
||||
)
|
||||
|
||||
return app
|
||||
|
||||
|
||||
def create_queue_app():
|
||||
"""Create the queue CLI app."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
app = typer.Typer(
|
||||
name="queue",
|
||||
help="Queue management commands",
|
||||
no_args_is_help=True,
|
||||
)
|
||||
|
||||
@app.command("ls")
|
||||
def queue_ls(
|
||||
state: Optional[str] = typer.Option(
|
||||
None, "--state", "-s",
|
||||
help="Filter by state (queued, running, succeeded, failed, cancelled)"
|
||||
),
|
||||
session: Optional[str] = typer.Option(
|
||||
None, "--session",
|
||||
help="Filter by session ID"
|
||||
),
|
||||
limit: int = typer.Option(
|
||||
20, "--limit", "-n",
|
||||
help="Maximum number of results"
|
||||
),
|
||||
json_output: bool = typer.Option(
|
||||
False, "--json", "-j",
|
||||
help="Output as JSON"
|
||||
),
|
||||
):
|
||||
"""List queued runs."""
|
||||
from ..queue import QueuePersistence, RunState
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Parse state filter
|
||||
state_filter = None
|
||||
if state:
|
||||
try:
|
||||
state_filter = RunState(state.lower())
|
||||
except ValueError:
|
||||
console.print(f"[red]Invalid state: {state}[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
runs = persistence.list_runs(
|
||||
state=state_filter,
|
||||
session_id=session,
|
||||
limit=limit,
|
||||
)
|
||||
|
||||
if json_output:
|
||||
output = [r.to_dict() for r in runs]
|
||||
console.print(json.dumps(output, indent=2, default=str))
|
||||
return
|
||||
|
||||
if not runs:
|
||||
console.print("[dim]No runs found.[/dim]")
|
||||
return
|
||||
|
||||
# Create table
|
||||
table = Table(title="Queue Runs")
|
||||
table.add_column("ID", style="cyan")
|
||||
table.add_column("Agent", style="green")
|
||||
table.add_column("Input", max_width=30)
|
||||
table.add_column("State", style="yellow")
|
||||
table.add_column("Priority")
|
||||
table.add_column("Wait", style="dim")
|
||||
table.add_column("Duration", style="dim")
|
||||
|
||||
for run in runs:
|
||||
state_style = {
|
||||
"queued": "yellow",
|
||||
"running": "green",
|
||||
"succeeded": "cyan",
|
||||
"failed": "red",
|
||||
"cancelled": "dim",
|
||||
}.get(run.state.value, "")
|
||||
|
||||
input_preview = run.input_content[:27] + "..." if len(run.input_content) > 30 else run.input_content
|
||||
|
||||
table.add_row(
|
||||
run.run_id[:8],
|
||||
run.agent_name,
|
||||
input_preview,
|
||||
f"[{state_style}]{run.state.value}[/{state_style}]",
|
||||
run.priority.name.lower(),
|
||||
f"{run.wait_seconds:.1f}s" if run.wait_seconds else "-",
|
||||
f"{run.duration_seconds:.1f}s" if run.duration_seconds else "-",
|
||||
)
|
||||
|
||||
console.print(table)
|
||||
persistence.close()
|
||||
|
||||
@app.command("cancel")
|
||||
def queue_cancel(
|
||||
run_id: str = typer.Argument(..., help="Run ID to cancel"),
|
||||
):
|
||||
"""Cancel a queued or running run."""
|
||||
from ..queue import QueuePersistence, RunState
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Find the run
|
||||
run = persistence.load_run(run_id)
|
||||
if not run:
|
||||
# Try partial match
|
||||
runs = persistence.list_runs(limit=100)
|
||||
matches = [r for r in runs if r.run_id.startswith(run_id)]
|
||||
if len(matches) == 1:
|
||||
run = matches[0]
|
||||
elif len(matches) > 1:
|
||||
console.print(f"[yellow]Multiple matches for '{run_id}':[/yellow]")
|
||||
for r in matches:
|
||||
console.print(f" {r.run_id}")
|
||||
raise typer.Exit(1)
|
||||
else:
|
||||
console.print(f"[red]Run not found: {run_id}[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if run.state.is_terminal():
|
||||
console.print(f"[yellow]Run {run.run_id[:8]} is already {run.state.value}[/yellow]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Update state
|
||||
persistence.update_run_state(run.run_id, RunState.CANCELLED)
|
||||
console.print(f"[green]Cancelled run: {run.run_id[:8]}[/green]")
|
||||
persistence.close()
|
||||
|
||||
@app.command("retry")
|
||||
def queue_retry(
|
||||
run_id: str = typer.Argument(..., help="Run ID to retry"),
|
||||
):
|
||||
"""Retry a failed run."""
|
||||
from ..queue import QueuePersistence, QueuedRun, RunState
|
||||
import uuid
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Find the run
|
||||
run = persistence.load_run(run_id)
|
||||
if not run:
|
||||
runs = persistence.list_runs(limit=100)
|
||||
matches = [r for r in runs if r.run_id.startswith(run_id)]
|
||||
if len(matches) == 1:
|
||||
run = matches[0]
|
||||
else:
|
||||
console.print(f"[red]Run not found: {run_id}[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if run.state != RunState.FAILED:
|
||||
console.print(f"[yellow]Can only retry failed runs (current: {run.state.value})[/yellow]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if run.retry_count >= run.max_retries:
|
||||
console.print(f"[yellow]Max retries reached ({run.retry_count}/{run.max_retries})[/yellow]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Create new run
|
||||
new_run = QueuedRun(
|
||||
run_id=str(uuid.uuid4())[:8],
|
||||
agent_name=run.agent_name,
|
||||
input_content=run.input_content,
|
||||
state=RunState.QUEUED,
|
||||
priority=run.priority,
|
||||
session_id=run.session_id,
|
||||
workspace=run.workspace,
|
||||
retry_count=run.retry_count + 1,
|
||||
max_retries=run.max_retries,
|
||||
parent_run_id=run.run_id,
|
||||
config=run.config,
|
||||
)
|
||||
|
||||
persistence.save_run(new_run)
|
||||
console.print(f"[green]Created retry run: {new_run.run_id} (from {run.run_id[:8]})[/green]")
|
||||
persistence.close()
|
||||
|
||||
@app.command("clear")
|
||||
def queue_clear(
|
||||
force: bool = typer.Option(
|
||||
False, "--force", "-f",
|
||||
help="Skip confirmation"
|
||||
),
|
||||
):
|
||||
"""Clear all queued runs."""
|
||||
from ..queue import QueuePersistence, RunState
|
||||
|
||||
if not force:
|
||||
confirm = typer.confirm("Clear all queued runs?")
|
||||
if not confirm:
|
||||
raise typer.Abort()
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Get queued runs
|
||||
runs = persistence.list_runs(state=RunState.QUEUED, limit=1000)
|
||||
|
||||
count = 0
|
||||
for run in runs:
|
||||
persistence.update_run_state(run.run_id, RunState.CANCELLED)
|
||||
count += 1
|
||||
|
||||
console.print(f"[green]Cleared {count} queued runs[/green]")
|
||||
persistence.close()
|
||||
|
||||
@app.command("stats")
|
||||
def queue_stats(
|
||||
session: Optional[str] = typer.Option(
|
||||
None, "--session",
|
||||
help="Filter by session ID"
|
||||
),
|
||||
):
|
||||
"""Show queue statistics."""
|
||||
from ..queue import QueuePersistence
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
stats = persistence.get_stats(session)
|
||||
|
||||
console.print(Panel(
|
||||
f"""
|
||||
[bold]Queue Statistics[/bold]
|
||||
|
||||
Queued: {stats.queued_count}
|
||||
Running: {stats.running_count}
|
||||
Succeeded: {stats.succeeded_count}
|
||||
Failed: {stats.failed_count}
|
||||
Cancelled: {stats.cancelled_count}
|
||||
|
||||
Total Runs: {stats.total_runs}
|
||||
Avg Wait: {stats.avg_wait_seconds:.1f}s
|
||||
Avg Duration: {stats.avg_duration_seconds:.1f}s
|
||||
""",
|
||||
title="Queue Stats"
|
||||
))
|
||||
persistence.close()
|
||||
|
||||
return app
|
||||
|
||||
|
||||
def create_session_app():
|
||||
"""Create the session CLI app."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
app = typer.Typer(
|
||||
name="session",
|
||||
help="Session management commands",
|
||||
no_args_is_help=True,
|
||||
)
|
||||
|
||||
@app.command("ls")
|
||||
def session_ls(
|
||||
limit: int = typer.Option(
|
||||
20, "--limit", "-n",
|
||||
help="Maximum number of results"
|
||||
),
|
||||
):
|
||||
"""List recent sessions."""
|
||||
from ..queue import QueuePersistence
|
||||
from datetime import datetime
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
sessions = persistence.list_sessions(limit=limit)
|
||||
|
||||
if not sessions:
|
||||
console.print("[dim]No sessions found.[/dim]")
|
||||
return
|
||||
|
||||
table = Table(title="Sessions")
|
||||
table.add_column("ID", style="cyan")
|
||||
table.add_column("User")
|
||||
table.add_column("Created", style="dim")
|
||||
table.add_column("Updated", style="dim")
|
||||
|
||||
for session in sessions:
|
||||
created = datetime.fromtimestamp(session["created_at"]).strftime("%Y-%m-%d %H:%M")
|
||||
updated = datetime.fromtimestamp(session["updated_at"]).strftime("%Y-%m-%d %H:%M")
|
||||
|
||||
table.add_row(
|
||||
session["session_id"][:8],
|
||||
session.get("user_id", "-"),
|
||||
created,
|
||||
updated,
|
||||
)
|
||||
|
||||
console.print(table)
|
||||
persistence.close()
|
||||
|
||||
@app.command("resume")
|
||||
def session_resume(
|
||||
session_id: str = typer.Argument(..., help="Session ID to resume"),
|
||||
):
|
||||
"""Resume a session in TUI."""
|
||||
try:
|
||||
from .app import run_tui
|
||||
except ImportError:
|
||||
console.print(
|
||||
"[red]Textual is required for TUI. Install with:[/red]\n"
|
||||
" pip install praisonai[tui]"
|
||||
)
|
||||
raise typer.Exit(1)
|
||||
|
||||
run_tui(session_id=session_id)
|
||||
|
||||
return app
|
||||
|
||||
|
||||
def create_run_command():
|
||||
"""Create the run command."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
def run_command(
|
||||
prompt: str = typer.Argument(..., help="Prompt to execute"),
|
||||
agent: Optional[str] = typer.Option(
|
||||
None, "--agent", "-a",
|
||||
help="Agent config file (YAML)"
|
||||
),
|
||||
model: Optional[str] = typer.Option(
|
||||
None, "--model", "-m",
|
||||
help="Model to use"
|
||||
),
|
||||
stream: bool = typer.Option(
|
||||
True, "--stream/--no-stream",
|
||||
help="Stream output"
|
||||
),
|
||||
priority: str = typer.Option(
|
||||
"normal", "--priority", "-p",
|
||||
help="Run priority (low, normal, high, urgent)"
|
||||
),
|
||||
):
|
||||
"""Run a single agent task."""
|
||||
from ..queue import QueueManager, QueueConfig, RunPriority
|
||||
|
||||
# Parse priority
|
||||
try:
|
||||
run_priority = RunPriority.from_string(priority)
|
||||
except (ValueError, KeyError):
|
||||
console.print(f"[red]Invalid priority: {priority}[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Load agent config
|
||||
agent_config = {}
|
||||
if agent:
|
||||
import yaml
|
||||
with open(agent, "r") as f:
|
||||
agent_config = yaml.safe_load(f)
|
||||
|
||||
# Set model
|
||||
if model:
|
||||
agent_config["model"] = model
|
||||
|
||||
async def execute():
|
||||
output_chunks = []
|
||||
|
||||
async def on_output(run_id: str, chunk: str):
|
||||
output_chunks.append(chunk)
|
||||
if stream:
|
||||
console.print(chunk, end="")
|
||||
|
||||
async def on_complete(run_id: str, run):
|
||||
if not stream:
|
||||
console.print(run.output_content or "".join(output_chunks))
|
||||
|
||||
async def on_error(run_id: str, error: Exception):
|
||||
console.print(f"\n[red]Error: {error}[/red]")
|
||||
|
||||
config = QueueConfig(enable_persistence=False)
|
||||
manager = QueueManager(
|
||||
config=config,
|
||||
on_output=on_output,
|
||||
on_complete=on_complete,
|
||||
on_error=on_error,
|
||||
)
|
||||
|
||||
await manager.start(recover=False)
|
||||
|
||||
try:
|
||||
run_id = await manager.submit(
|
||||
input_content=prompt,
|
||||
agent_name=agent_config.get("name", "Assistant"),
|
||||
priority=run_priority,
|
||||
config={"agent_config": agent_config},
|
||||
)
|
||||
|
||||
# Wait for completion
|
||||
while True:
|
||||
run = manager.get_run(run_id)
|
||||
if run and run.state.is_terminal():
|
||||
break
|
||||
await asyncio.sleep(0.1)
|
||||
|
||||
if stream:
|
||||
console.print() # Newline after streaming
|
||||
|
||||
finally:
|
||||
await manager.stop()
|
||||
|
||||
asyncio.run(execute())
|
||||
|
||||
return run_command
|
||||
|
||||
|
||||
# Main CLI integration
|
||||
def register_tui_commands(app):
|
||||
"""Register TUI commands with the main CLI app."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return
|
||||
|
||||
tui_app = create_tui_app()
|
||||
queue_app = create_queue_app()
|
||||
session_app = create_session_app()
|
||||
run_cmd = create_run_command()
|
||||
|
||||
if tui_app:
|
||||
app.add_typer(tui_app, name="tui")
|
||||
if queue_app:
|
||||
app.add_typer(queue_app, name="queue")
|
||||
if session_app:
|
||||
app.add_typer(session_app, name="session")
|
||||
if run_cmd:
|
||||
app.command("run")(run_cmd)
|
||||
|
||||
|
||||
# Standalone entry point
|
||||
def main():
|
||||
"""Main entry point for TUI CLI."""
|
||||
if not TYPER_AVAILABLE:
|
||||
print("Typer is required. Install with: pip install typer")
|
||||
sys.exit(1)
|
||||
|
||||
app = typer.Typer(
|
||||
name="praison-tui",
|
||||
help="PraisonAI TUI and Queue CLI",
|
||||
)
|
||||
|
||||
register_tui_commands(app)
|
||||
|
||||
# Add direct tui command
|
||||
@app.callback(invoke_without_command=True)
|
||||
def default(
|
||||
ctx: typer.Context,
|
||||
workspace: Optional[str] = typer.Option(None, "--workspace", "-w"),
|
||||
session: Optional[str] = typer.Option(None, "--session", "-s"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m"),
|
||||
):
|
||||
"""Launch TUI if no subcommand given."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
try:
|
||||
from .app import run_tui
|
||||
run_tui(workspace=workspace, session_id=session, model=model)
|
||||
except ImportError:
|
||||
console.print(
|
||||
"[red]Textual is required for TUI. Install with:[/red]\n"
|
||||
" pip install praisonai[tui]"
|
||||
)
|
||||
raise typer.Exit(1)
|
||||
|
||||
app()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,150 @@
|
||||
"""
|
||||
TUI Configuration for PraisonAI.
|
||||
|
||||
Handles keyboard shortcuts and display settings with safe defaults.
|
||||
"""
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class TUIConfig:
|
||||
"""
|
||||
Configuration for TUI behavior.
|
||||
|
||||
Safe defaults:
|
||||
- Ctrl keys disabled by default (conflict with IDEs/terminals)
|
||||
- Function keys disabled by default (conflict with IDEs/OS)
|
||||
- Single-character shortcuts enabled by default
|
||||
- Command mode (:) enabled by default
|
||||
"""
|
||||
|
||||
# Keyboard configuration
|
||||
enable_ctrl_keys: bool = False # Ctrl+Q, Ctrl+L, etc.
|
||||
enable_fn_keys: bool = False # F1-F12
|
||||
enable_single_char: bool = True # q, l, etc. (when not in input)
|
||||
enable_command_mode: bool = True # :quit, :clear, etc.
|
||||
leader_key: str = ":" # Command mode prefix
|
||||
|
||||
# Display configuration
|
||||
auto_scroll: bool = True
|
||||
show_tools_panel: bool = True
|
||||
show_queue_panel: bool = True
|
||||
|
||||
@classmethod
|
||||
def from_env(cls) -> "TUIConfig":
|
||||
"""Create config from environment variables."""
|
||||
config = cls()
|
||||
|
||||
# Check env vars for enabling Ctrl keys (opt-in)
|
||||
if os.environ.get("PRAISONAI_TUI_CTRL_KEYS", "").lower() in ("1", "true", "yes"):
|
||||
config.enable_ctrl_keys = True
|
||||
|
||||
# Check env vars for enabling Function keys (opt-in)
|
||||
if os.environ.get("PRAISONAI_TUI_FN_KEYS", "").lower() in ("1", "true", "yes"):
|
||||
config.enable_fn_keys = True
|
||||
|
||||
# Check for disabling single-char shortcuts
|
||||
if os.environ.get("PRAISONAI_TUI_NO_SINGLE_CHAR", "").lower() in ("1", "true", "yes"):
|
||||
config.enable_single_char = False
|
||||
|
||||
# Check for custom leader key
|
||||
leader = os.environ.get("PRAISONAI_TUI_LEADER", "")
|
||||
if leader and len(leader) == 1:
|
||||
config.leader_key = leader
|
||||
|
||||
return config
|
||||
|
||||
@classmethod
|
||||
def from_cli_args(
|
||||
cls,
|
||||
enable_ctrl_keys: bool = False,
|
||||
enable_fn_keys: bool = False,
|
||||
leader_key: Optional[str] = None,
|
||||
) -> "TUIConfig":
|
||||
"""Create config from CLI arguments, merged with env."""
|
||||
config = cls.from_env()
|
||||
|
||||
# CLI args override env
|
||||
if enable_ctrl_keys:
|
||||
config.enable_ctrl_keys = True
|
||||
if enable_fn_keys:
|
||||
config.enable_fn_keys = True
|
||||
if leader_key and len(leader_key) == 1:
|
||||
config.leader_key = leader_key
|
||||
|
||||
return config
|
||||
|
||||
|
||||
# Command mode commands
|
||||
COMMANDS = {
|
||||
"quit": {"aliases": ["q", "exit"], "description": "Quit the TUI"},
|
||||
"clear": {"aliases": ["cl"], "description": "Clear the chat history"},
|
||||
"help": {"aliases": ["h", "?"], "description": "Show help"},
|
||||
"tools": {"aliases": ["t"], "description": "Toggle tools panel"},
|
||||
"queue": {"aliases": ["qu"], "description": "Toggle queue panel"},
|
||||
"settings": {"aliases": ["set"], "description": "Open settings"},
|
||||
"cancel": {"aliases": ["c"], "description": "Cancel current operation"},
|
||||
"sessions": {"aliases": ["sess"], "description": "Manage sessions"},
|
||||
}
|
||||
|
||||
|
||||
def get_command(input_str: str) -> Optional[str]:
|
||||
"""
|
||||
Parse command input and return the canonical command name.
|
||||
|
||||
Args:
|
||||
input_str: The command string (without leader key)
|
||||
|
||||
Returns:
|
||||
Canonical command name or None if not found
|
||||
"""
|
||||
input_str = input_str.strip().lower()
|
||||
|
||||
# Check direct match
|
||||
if input_str in COMMANDS:
|
||||
return input_str
|
||||
|
||||
# Check aliases
|
||||
for cmd, info in COMMANDS.items():
|
||||
if input_str in info.get("aliases", []):
|
||||
return cmd
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def get_help_text() -> str:
|
||||
"""Get formatted help text for all commands."""
|
||||
lines = [
|
||||
"PraisonAI TUI Commands",
|
||||
"=" * 40,
|
||||
"",
|
||||
"Command Mode (press : to enter):",
|
||||
]
|
||||
|
||||
for cmd, info in COMMANDS.items():
|
||||
aliases = ", ".join(info.get("aliases", []))
|
||||
desc = info.get("description", "")
|
||||
if aliases:
|
||||
lines.append(f" :{cmd} (or :{aliases}) - {desc}")
|
||||
else:
|
||||
lines.append(f" :{cmd} - {desc}")
|
||||
|
||||
lines.extend([
|
||||
"",
|
||||
"Single-key shortcuts (when not typing):",
|
||||
" q - Quit",
|
||||
" l - Clear screen",
|
||||
" ? - Help",
|
||||
" / - Search/filter",
|
||||
"",
|
||||
"Input shortcuts:",
|
||||
" Enter - Send message",
|
||||
" Shift+Enter - New line",
|
||||
" Escape - Cancel",
|
||||
" Up/Down - History navigation",
|
||||
])
|
||||
|
||||
return "\n".join(lines)
|
||||
@@ -0,0 +1,511 @@
|
||||
"""
|
||||
Debug and Simulation CLI Commands for PraisonAI TUI.
|
||||
|
||||
Provides headless TUI simulation, tracing, and debugging capabilities.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import sys
|
||||
import time
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
try:
|
||||
import typer
|
||||
from rich.console import Console
|
||||
from rich.table import Table
|
||||
from rich.panel import Panel
|
||||
from rich.live import Live
|
||||
from rich.text import Text
|
||||
TYPER_AVAILABLE = True
|
||||
except ImportError:
|
||||
TYPER_AVAILABLE = False
|
||||
typer = None
|
||||
|
||||
console = Console() if TYPER_AVAILABLE else None
|
||||
|
||||
|
||||
def create_debug_app():
|
||||
"""Create the debug CLI app with simulation commands."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
app = typer.Typer(
|
||||
name="tui",
|
||||
help="TUI and simulation commands",
|
||||
no_args_is_help=True,
|
||||
)
|
||||
|
||||
@app.command("launch")
|
||||
def tui_launch(
|
||||
workspace: Optional[str] = typer.Option(None, "--workspace", "-w"),
|
||||
session: Optional[str] = typer.Option(None, "--session", "-s"),
|
||||
model: Optional[str] = typer.Option(None, "--model", "-m"),
|
||||
debug: bool = typer.Option(False, "--debug", "-d", help="Enable debug overlays"),
|
||||
log_jsonl: Optional[str] = typer.Option(None, "--log-jsonl", help="Write events to JSONL file"),
|
||||
profile: bool = typer.Option(False, "--profile", help="Enable performance profiling"),
|
||||
):
|
||||
"""Launch the interactive TUI."""
|
||||
try:
|
||||
from .app import run_tui
|
||||
except ImportError:
|
||||
console.print("[red]Textual is required for TUI. Install with:[/red]\n pip install praisonai[tui]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Set debug environment
|
||||
if debug:
|
||||
import os
|
||||
os.environ["PRAISONAI_TUI_DEBUG"] = "1"
|
||||
|
||||
if log_jsonl:
|
||||
import os
|
||||
os.environ["PRAISONAI_TUI_JSONL"] = log_jsonl
|
||||
|
||||
run_tui(workspace=workspace, session_id=session, model=model)
|
||||
|
||||
@app.command("simulate")
|
||||
def tui_simulate(
|
||||
script: str = typer.Argument(..., help="Path to simulation script (YAML/JSON)"),
|
||||
mock: bool = typer.Option(True, "--mock/--real-llm", help="Use mock provider"),
|
||||
pretty: bool = typer.Option(True, "--pretty/--jsonl", help="Output format"),
|
||||
assert_mode: bool = typer.Option(False, "--assert", help="Validate expected outcomes"),
|
||||
timeout: float = typer.Option(60.0, "--timeout", help="Max execution time"),
|
||||
):
|
||||
"""Run a headless TUI simulation script."""
|
||||
import os
|
||||
|
||||
# Safety gate for real LLM
|
||||
if not mock:
|
||||
if not os.environ.get("PRAISONAI_REAL_LLM"):
|
||||
console.print("[red]Real LLM mode requires PRAISONAI_REAL_LLM=1 environment variable[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Load script
|
||||
script_path = Path(script)
|
||||
if not script_path.exists():
|
||||
console.print(f"[red]Script not found: {script}[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
with open(script_path) as f:
|
||||
if script_path.suffix in (".yaml", ".yml"):
|
||||
import yaml
|
||||
script_data = yaml.safe_load(f)
|
||||
else:
|
||||
script_data = json.load(f)
|
||||
|
||||
# Run simulation
|
||||
from .orchestrator import TuiOrchestrator, SimulationRunner, OutputMode
|
||||
from ..queue import QueueConfig
|
||||
|
||||
output_mode = OutputMode.PRETTY if pretty else OutputMode.JSONL
|
||||
|
||||
config = QueueConfig(enable_persistence=not mock)
|
||||
orchestrator = TuiOrchestrator(
|
||||
queue_config=config,
|
||||
output_mode=output_mode,
|
||||
debug=True,
|
||||
)
|
||||
|
||||
runner = SimulationRunner(orchestrator, assert_mode=assert_mode)
|
||||
|
||||
async def run():
|
||||
return await asyncio.wait_for(
|
||||
runner.run_script(script_data),
|
||||
timeout=timeout
|
||||
)
|
||||
|
||||
try:
|
||||
success = asyncio.run(run())
|
||||
except asyncio.TimeoutError:
|
||||
console.print(f"[red]Simulation timed out after {timeout}s[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Print summary
|
||||
summary = runner.get_summary()
|
||||
if assert_mode:
|
||||
console.print(Panel(
|
||||
f"Passed: {summary['assertions_passed']}\n"
|
||||
f"Failed: {summary['assertions_failed']}\n"
|
||||
f"Errors: {len(summary['errors'])}",
|
||||
title="Simulation Results"
|
||||
))
|
||||
|
||||
if summary['errors']:
|
||||
for error in summary['errors']:
|
||||
console.print(f"[red] ✗ {error}[/red]")
|
||||
|
||||
if not success:
|
||||
raise typer.Exit(1)
|
||||
|
||||
@app.command("snapshot")
|
||||
def tui_snapshot(
|
||||
session: Optional[str] = typer.Option(None, "--session", "-s"),
|
||||
run_id: Optional[str] = typer.Option(None, "--run", "-r"),
|
||||
json_output: bool = typer.Option(False, "--json", "-j"),
|
||||
):
|
||||
"""Print a TUI-like snapshot of current state."""
|
||||
from ..queue import QueuePersistence, RunState
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Build snapshot
|
||||
snapshot = {
|
||||
"timestamp": time.time(),
|
||||
"session_id": session,
|
||||
}
|
||||
|
||||
# Get runs
|
||||
runs = persistence.list_runs(session_id=session, limit=100)
|
||||
|
||||
queued = [r for r in runs if r.state == RunState.QUEUED]
|
||||
running = [r for r in runs if r.state == RunState.RUNNING]
|
||||
recent = [r for r in runs if r.state.is_terminal()][-5:]
|
||||
|
||||
snapshot["queued_count"] = len(queued)
|
||||
snapshot["running_count"] = len(running)
|
||||
snapshot["recent_runs"] = [
|
||||
{
|
||||
"run_id": r.run_id[:8],
|
||||
"agent": r.agent_name,
|
||||
"state": r.state.value,
|
||||
"input": r.input_content[:50],
|
||||
}
|
||||
for r in recent
|
||||
]
|
||||
|
||||
# Get specific run if requested
|
||||
if run_id:
|
||||
run = persistence.load_run(run_id)
|
||||
if run:
|
||||
snapshot["run"] = run.to_dict()
|
||||
|
||||
# Get session info
|
||||
if session:
|
||||
session_data = persistence.load_session(session)
|
||||
if session_data:
|
||||
snapshot["session"] = session_data
|
||||
|
||||
persistence.close()
|
||||
|
||||
if json_output:
|
||||
console.print(json.dumps(snapshot, indent=2, default=str))
|
||||
else:
|
||||
# Pretty print
|
||||
console.print("─" * 60)
|
||||
console.print(f"◉ PraisonAI Snapshot │ {time.strftime('%Y-%m-%d %H:%M:%S')}")
|
||||
console.print("─" * 60)
|
||||
|
||||
console.print(f"\n[bold]Queue Status[/bold]")
|
||||
console.print(f" Queued: {snapshot['queued_count']} │ Running: {snapshot['running_count']}")
|
||||
|
||||
if snapshot["recent_runs"]:
|
||||
console.print(f"\n[bold]Recent Runs[/bold]")
|
||||
for r in snapshot["recent_runs"]:
|
||||
state_color = {
|
||||
"succeeded": "green",
|
||||
"failed": "red",
|
||||
"cancelled": "dim",
|
||||
}.get(r["state"], "yellow")
|
||||
console.print(f" [{state_color}]{r['run_id']}[/{state_color}] {r['agent']}: {r['input'][:30]}...")
|
||||
|
||||
if "run" in snapshot:
|
||||
console.print(f"\n[bold]Run Details[/bold]")
|
||||
run = snapshot["run"]
|
||||
console.print(f" ID: {run.get('run_id', 'N/A')}")
|
||||
console.print(f" State: {run.get('state', 'N/A')}")
|
||||
console.print(f" Agent: {run.get('agent_name', 'N/A')}")
|
||||
|
||||
console.print("─" * 60)
|
||||
|
||||
@app.command("trace")
|
||||
def tui_trace(
|
||||
id: str = typer.Argument(..., help="Session or run ID to trace"),
|
||||
follow: bool = typer.Option(False, "--follow", "-f", help="Follow new events"),
|
||||
limit: int = typer.Option(50, "--limit", "-n", help="Max events to show"),
|
||||
):
|
||||
"""Replay events from persistence like a timeline."""
|
||||
from ..queue import QueuePersistence
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
# Try to find as session or run
|
||||
session = persistence.load_session(id)
|
||||
run = persistence.load_run(id)
|
||||
|
||||
if not session and not run:
|
||||
# Try partial match
|
||||
runs = persistence.list_runs(limit=100)
|
||||
matches = [r for r in runs if r.run_id.startswith(id) or r.session_id.startswith(id)]
|
||||
if matches:
|
||||
run = matches[0]
|
||||
|
||||
if not session and not run:
|
||||
console.print(f"[red]No session or run found for: {id}[/red]")
|
||||
persistence.close()
|
||||
raise typer.Exit(1)
|
||||
|
||||
# Get runs for timeline
|
||||
if session:
|
||||
runs = persistence.list_runs(session_id=id, limit=limit)
|
||||
else:
|
||||
runs = [run] if run else []
|
||||
|
||||
# Build timeline
|
||||
events = []
|
||||
for r in runs:
|
||||
events.append({
|
||||
"timestamp": r.created_at,
|
||||
"type": "run_created",
|
||||
"run_id": r.run_id[:8],
|
||||
"agent": r.agent_name,
|
||||
"input": r.input_content[:50],
|
||||
})
|
||||
if r.started_at:
|
||||
events.append({
|
||||
"timestamp": r.started_at,
|
||||
"type": "run_started",
|
||||
"run_id": r.run_id[:8],
|
||||
})
|
||||
if r.ended_at:
|
||||
events.append({
|
||||
"timestamp": r.ended_at,
|
||||
"type": f"run_{r.state.value}",
|
||||
"run_id": r.run_id[:8],
|
||||
})
|
||||
|
||||
# Sort by timestamp
|
||||
events.sort(key=lambda e: e["timestamp"])
|
||||
|
||||
persistence.close()
|
||||
|
||||
# Print timeline
|
||||
console.print(f"\n[bold]Event Timeline for {id[:8]}[/bold]\n")
|
||||
|
||||
for event in events[-limit:]:
|
||||
ts = time.strftime("%H:%M:%S", time.localtime(event["timestamp"]))
|
||||
event_type = event["type"]
|
||||
|
||||
type_colors = {
|
||||
"run_created": "cyan",
|
||||
"run_started": "yellow",
|
||||
"run_succeeded": "green",
|
||||
"run_failed": "red",
|
||||
"run_cancelled": "dim",
|
||||
}
|
||||
color = type_colors.get(event_type, "white")
|
||||
|
||||
line = f"[dim]{ts}[/dim] [{color}]{event_type:15}[/{color}]"
|
||||
if "run_id" in event:
|
||||
line += f" run={event['run_id']}"
|
||||
if "agent" in event:
|
||||
line += f" agent={event['agent']}"
|
||||
if "input" in event:
|
||||
line += f" \"{event['input']}...\""
|
||||
|
||||
console.print(line)
|
||||
|
||||
if follow:
|
||||
console.print("\n[dim]Following... (Ctrl+C to stop)[/dim]")
|
||||
# In a real implementation, this would poll for new events
|
||||
|
||||
return app
|
||||
|
||||
|
||||
def create_queue_watch_command():
|
||||
"""Create the queue watch command."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
def queue_watch(
|
||||
state: Optional[str] = typer.Option(None, "--state", "-s"),
|
||||
agent: Optional[str] = typer.Option(None, "--agent", "-a"),
|
||||
run_id: Optional[str] = typer.Option(None, "--run", "-r"),
|
||||
jsonl: bool = typer.Option(False, "--jsonl", "-j"),
|
||||
interval: float = typer.Option(1.0, "--interval", "-i"),
|
||||
):
|
||||
"""Watch queue events in real time."""
|
||||
from ..queue import QueuePersistence, RunState
|
||||
|
||||
persistence = QueuePersistence()
|
||||
persistence.initialize()
|
||||
|
||||
last_seen = {}
|
||||
|
||||
try:
|
||||
while True:
|
||||
runs = persistence.list_runs(limit=100)
|
||||
|
||||
# Filter
|
||||
if state:
|
||||
try:
|
||||
state_filter = RunState(state.lower())
|
||||
runs = [r for r in runs if r.state == state_filter]
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
if agent:
|
||||
runs = [r for r in runs if agent.lower() in r.agent_name.lower()]
|
||||
|
||||
if run_id:
|
||||
runs = [r for r in runs if r.run_id.startswith(run_id)]
|
||||
|
||||
# Check for changes
|
||||
for run in runs:
|
||||
key = run.run_id
|
||||
current_state = run.state.value
|
||||
|
||||
if key not in last_seen or last_seen[key] != current_state:
|
||||
last_seen[key] = current_state
|
||||
|
||||
if jsonl:
|
||||
event = {
|
||||
"timestamp": time.time(),
|
||||
"run_id": run.run_id,
|
||||
"agent": run.agent_name,
|
||||
"state": current_state,
|
||||
}
|
||||
print(json.dumps(event))
|
||||
else:
|
||||
ts = time.strftime("%H:%M:%S")
|
||||
state_colors = {
|
||||
"queued": "yellow",
|
||||
"running": "cyan",
|
||||
"succeeded": "green",
|
||||
"failed": "red",
|
||||
"cancelled": "dim",
|
||||
}
|
||||
color = state_colors.get(current_state, "white")
|
||||
console.print(
|
||||
f"[dim]{ts}[/dim] [{color}]{current_state:10}[/{color}] "
|
||||
f"{run.run_id[:8]} {run.agent_name}"
|
||||
)
|
||||
|
||||
time.sleep(interval)
|
||||
|
||||
except KeyboardInterrupt:
|
||||
console.print("\n[dim]Stopped watching[/dim]")
|
||||
finally:
|
||||
persistence.close()
|
||||
|
||||
return queue_watch
|
||||
|
||||
|
||||
def create_doctor_command():
|
||||
"""Create the doctor command for TUI diagnostics."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return None
|
||||
|
||||
def doctor_tui():
|
||||
"""Validate TUI dependencies, DB schema, and wiring."""
|
||||
checks = []
|
||||
|
||||
# Check Textual
|
||||
try:
|
||||
import textual
|
||||
checks.append(("Textual", "✓", f"v{textual.__version__}", "green"))
|
||||
except ImportError:
|
||||
checks.append(("Textual", "✗", "Not installed", "red"))
|
||||
|
||||
# Check Rich
|
||||
try:
|
||||
import rich
|
||||
checks.append(("Rich", "✓", f"v{rich.__version__}", "green"))
|
||||
except ImportError:
|
||||
checks.append(("Rich", "✗", "Not installed", "red"))
|
||||
|
||||
# Check Typer
|
||||
try:
|
||||
import typer
|
||||
checks.append(("Typer", "✓", f"v{typer.__version__}", "green"))
|
||||
except ImportError:
|
||||
checks.append(("Typer", "✗", "Not installed", "red"))
|
||||
|
||||
# Check queue modules
|
||||
try:
|
||||
from ..queue import QueueManager, QueueScheduler, QueuePersistence
|
||||
checks.append(("Queue System", "✓", "All modules loaded", "green"))
|
||||
except ImportError as e:
|
||||
checks.append(("Queue System", "✗", str(e), "red"))
|
||||
|
||||
# Check TUI modules
|
||||
try:
|
||||
from .orchestrator import TuiOrchestrator
|
||||
checks.append(("TUI Orchestrator", "✓", "Loaded", "green"))
|
||||
except ImportError as e:
|
||||
checks.append(("TUI Orchestrator", "✗", str(e), "red"))
|
||||
|
||||
# Check events
|
||||
try:
|
||||
from .events import TUIEvent, TUIEventType
|
||||
event_count = len(TUIEventType)
|
||||
checks.append(("TUI Events", "✓", f"{event_count} event types", "green"))
|
||||
except ImportError as e:
|
||||
checks.append(("TUI Events", "✗", str(e), "red"))
|
||||
|
||||
# Check DB
|
||||
try:
|
||||
from ..queue import QueuePersistence
|
||||
p = QueuePersistence()
|
||||
p.initialize()
|
||||
stats = p.get_stats()
|
||||
p.close()
|
||||
checks.append(("Database", "✓", f"{stats.total_runs} runs in DB", "green"))
|
||||
except Exception as e:
|
||||
checks.append(("Database", "✗", str(e), "red"))
|
||||
|
||||
# Check slash commands
|
||||
try:
|
||||
from ..slash_commands import SlashCommandRegistry
|
||||
registry = SlashCommandRegistry()
|
||||
cmd_count = len(registry.commands)
|
||||
checks.append(("Slash Commands", "✓", f"{cmd_count} commands", "green"))
|
||||
except Exception as e:
|
||||
checks.append(("Slash Commands", "⚠", str(e), "yellow"))
|
||||
|
||||
# Print results
|
||||
console.print("\n[bold]PraisonAI TUI Diagnostics[/bold]\n")
|
||||
|
||||
table = Table(show_header=True)
|
||||
table.add_column("Component")
|
||||
table.add_column("Status")
|
||||
table.add_column("Details")
|
||||
|
||||
all_ok = True
|
||||
for name, status, details, color in checks:
|
||||
table.add_row(name, f"[{color}]{status}[/{color}]", details)
|
||||
if status == "✗":
|
||||
all_ok = False
|
||||
|
||||
console.print(table)
|
||||
|
||||
if all_ok:
|
||||
console.print("\n[green]All checks passed![/green]")
|
||||
else:
|
||||
console.print("\n[red]Some checks failed. Run 'pip install praisonai[tui]' to install missing dependencies.[/red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
return doctor_tui
|
||||
|
||||
|
||||
def register_debug_commands(app):
|
||||
"""Register debug commands with the main CLI app."""
|
||||
if not TYPER_AVAILABLE:
|
||||
return
|
||||
|
||||
debug_app = create_debug_app()
|
||||
watch_cmd = create_queue_watch_command()
|
||||
doctor_cmd = create_doctor_command()
|
||||
|
||||
if debug_app:
|
||||
app.add_typer(debug_app, name="tui")
|
||||
|
||||
if watch_cmd:
|
||||
# Add to queue subcommand
|
||||
pass # Will be added via queue app
|
||||
|
||||
if doctor_cmd:
|
||||
# Add doctor --tui option
|
||||
pass # Will be added via main app
|
||||
@@ -0,0 +1,99 @@
|
||||
"""
|
||||
Custom events for PraisonAI TUI.
|
||||
|
||||
Defines event types for communication between TUI components.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from typing import Any, Dict, Optional
|
||||
import time
|
||||
|
||||
|
||||
class TUIEventType(str, Enum):
|
||||
"""Types of TUI events."""
|
||||
# User input events
|
||||
MESSAGE_SUBMITTED = "message_submitted"
|
||||
COMMAND_EXECUTED = "command_executed"
|
||||
|
||||
# Queue events
|
||||
RUN_QUEUED = "run_queued"
|
||||
RUN_STARTED = "run_started"
|
||||
RUN_COMPLETED = "run_completed"
|
||||
RUN_FAILED = "run_failed"
|
||||
RUN_CANCELLED = "run_cancelled"
|
||||
|
||||
# Output events
|
||||
OUTPUT_CHUNK = "output_chunk"
|
||||
OUTPUT_COMPLETE = "output_complete"
|
||||
|
||||
# Tool events
|
||||
TOOL_CALL_STARTED = "tool_call_started"
|
||||
TOOL_CALL_COMPLETED = "tool_call_completed"
|
||||
TOOL_APPROVAL_REQUIRED = "tool_approval_required"
|
||||
|
||||
# Session events
|
||||
SESSION_STARTED = "session_started"
|
||||
SESSION_SAVED = "session_saved"
|
||||
SESSION_LOADED = "session_loaded"
|
||||
|
||||
# UI events
|
||||
SCREEN_CHANGED = "screen_changed"
|
||||
FOCUS_CHANGED = "focus_changed"
|
||||
ERROR_OCCURRED = "error_occurred"
|
||||
STATUS_UPDATED = "status_updated"
|
||||
|
||||
|
||||
@dataclass
|
||||
class TUIEvent:
|
||||
"""A TUI event."""
|
||||
event_type: TUIEventType
|
||||
timestamp: float = field(default_factory=time.time)
|
||||
data: Dict[str, Any] = field(default_factory=dict)
|
||||
|
||||
# Optional identifiers
|
||||
run_id: Optional[str] = None
|
||||
session_id: Optional[str] = None
|
||||
agent_name: Optional[str] = None
|
||||
|
||||
@classmethod
|
||||
def message_submitted(cls, content: str, **kwargs) -> "TUIEvent":
|
||||
"""Create a message submitted event."""
|
||||
return cls(
|
||||
event_type=TUIEventType.MESSAGE_SUBMITTED,
|
||||
data={"content": content, **kwargs}
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def output_chunk(cls, run_id: str, content: str, **kwargs) -> "TUIEvent":
|
||||
"""Create an output chunk event."""
|
||||
return cls(
|
||||
event_type=TUIEventType.OUTPUT_CHUNK,
|
||||
run_id=run_id,
|
||||
data={"content": content, **kwargs}
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def run_completed(cls, run_id: str, output: str, **kwargs) -> "TUIEvent":
|
||||
"""Create a run completed event."""
|
||||
return cls(
|
||||
event_type=TUIEventType.RUN_COMPLETED,
|
||||
run_id=run_id,
|
||||
data={"output": output, **kwargs}
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def error(cls, message: str, **kwargs) -> "TUIEvent":
|
||||
"""Create an error event."""
|
||||
return cls(
|
||||
event_type=TUIEventType.ERROR_OCCURRED,
|
||||
data={"message": message, **kwargs}
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def status_update(cls, status: str, **kwargs) -> "TUIEvent":
|
||||
"""Create a status update event."""
|
||||
return cls(
|
||||
event_type=TUIEventType.STATUS_UPDATED,
|
||||
data={"status": status, **kwargs}
|
||||
)
|
||||
@@ -0,0 +1,328 @@
|
||||
"""
|
||||
Mock Provider for PraisonAI TUI Testing.
|
||||
|
||||
Provides deterministic, replayable responses for CI and headless testing.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import hashlib
|
||||
import json
|
||||
import random
|
||||
import time
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, AsyncIterator, Callable, Dict, List, Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class MockResponse:
|
||||
"""A mock response configuration."""
|
||||
content: str
|
||||
chunks: List[str] = field(default_factory=list)
|
||||
delay_per_chunk: float = 0.05
|
||||
tool_calls: List[Dict[str, Any]] = field(default_factory=list)
|
||||
error: Optional[str] = None
|
||||
tokens: int = 0
|
||||
cost: float = 0.0
|
||||
|
||||
def __post_init__(self):
|
||||
if not self.chunks and self.content:
|
||||
# Split content into word chunks
|
||||
words = self.content.split()
|
||||
self.chunks = []
|
||||
for i in range(0, len(words), 3):
|
||||
chunk = " ".join(words[i:i+3])
|
||||
if i > 0:
|
||||
chunk = " " + chunk
|
||||
self.chunks.append(chunk)
|
||||
|
||||
if not self.tokens:
|
||||
self.tokens = len(self.content.split()) * 2 # Rough estimate
|
||||
|
||||
|
||||
@dataclass
|
||||
class MockProviderConfig:
|
||||
"""Configuration for mock provider."""
|
||||
seed: int = 42
|
||||
default_delay: float = 0.05
|
||||
simulate_errors: bool = False
|
||||
error_rate: float = 0.1
|
||||
record_mode: bool = False
|
||||
playback_file: Optional[str] = None
|
||||
|
||||
# Canned responses by input pattern
|
||||
responses: Dict[str, MockResponse] = field(default_factory=dict)
|
||||
|
||||
# Default response if no pattern matches
|
||||
default_response: Optional[MockResponse] = None
|
||||
|
||||
|
||||
class MockProvider:
|
||||
"""
|
||||
Mock LLM provider for testing.
|
||||
|
||||
Features:
|
||||
- Deterministic responses based on seed
|
||||
- Streaming simulation
|
||||
- Tool call simulation
|
||||
- Error injection
|
||||
- Record/playback mode
|
||||
"""
|
||||
|
||||
def __init__(self, config: Optional[MockProviderConfig] = None):
|
||||
self.config = config or MockProviderConfig()
|
||||
self._rng = random.Random(self.config.seed)
|
||||
self._recordings: List[Dict[str, Any]] = []
|
||||
self._playback_index = 0
|
||||
|
||||
# Load playback file if specified
|
||||
if self.config.playback_file:
|
||||
self._load_playback()
|
||||
|
||||
# Setup default responses
|
||||
self._setup_defaults()
|
||||
|
||||
def _setup_defaults(self) -> None:
|
||||
"""Setup default canned responses."""
|
||||
defaults = {
|
||||
"hello": MockResponse(
|
||||
content="Hello! I'm a mock AI assistant. How can I help you today?",
|
||||
tokens=20,
|
||||
cost=0.0001,
|
||||
),
|
||||
"help": MockResponse(
|
||||
content="I can help you with various tasks. Just ask me anything!",
|
||||
tokens=15,
|
||||
cost=0.00008,
|
||||
),
|
||||
"test": MockResponse(
|
||||
content="This is a test response. Everything is working correctly.",
|
||||
tokens=12,
|
||||
cost=0.00006,
|
||||
),
|
||||
"error": MockResponse(
|
||||
content="",
|
||||
error="Simulated error for testing",
|
||||
),
|
||||
"tool": MockResponse(
|
||||
content="I'll use a tool to help with that.",
|
||||
tool_calls=[{
|
||||
"id": "call_mock_001",
|
||||
"name": "mock_tool",
|
||||
"arguments": {"query": "test"},
|
||||
}],
|
||||
tokens=25,
|
||||
cost=0.00012,
|
||||
),
|
||||
}
|
||||
|
||||
for pattern, response in defaults.items():
|
||||
if pattern not in self.config.responses:
|
||||
self.config.responses[pattern] = response
|
||||
|
||||
if not self.config.default_response:
|
||||
self.config.default_response = MockResponse(
|
||||
content="I understand your request. Here's a mock response for testing purposes. "
|
||||
"This response is generated deterministically based on the input.",
|
||||
tokens=30,
|
||||
cost=0.00015,
|
||||
)
|
||||
|
||||
def _load_playback(self) -> None:
|
||||
"""Load recordings for playback."""
|
||||
if not self.config.playback_file:
|
||||
return
|
||||
|
||||
path = Path(self.config.playback_file)
|
||||
if path.exists():
|
||||
with open(path) as f:
|
||||
for line in f:
|
||||
self._recordings.append(json.loads(line))
|
||||
|
||||
def _save_recording(self, input_content: str, response: MockResponse) -> None:
|
||||
"""Save a recording."""
|
||||
if not self.config.record_mode or not self.config.playback_file:
|
||||
return
|
||||
|
||||
record = {
|
||||
"timestamp": time.time(),
|
||||
"input": input_content,
|
||||
"response": {
|
||||
"content": response.content,
|
||||
"chunks": response.chunks,
|
||||
"tool_calls": response.tool_calls,
|
||||
"tokens": response.tokens,
|
||||
"cost": response.cost,
|
||||
}
|
||||
}
|
||||
|
||||
path = Path(self.config.playback_file)
|
||||
with open(path, "a") as f:
|
||||
f.write(json.dumps(record) + "\n")
|
||||
|
||||
def _get_response(self, input_content: str) -> MockResponse:
|
||||
"""Get response for input."""
|
||||
# Check playback mode
|
||||
if self._recordings and self._playback_index < len(self._recordings):
|
||||
record = self._recordings[self._playback_index]
|
||||
self._playback_index += 1
|
||||
return MockResponse(**record["response"])
|
||||
|
||||
# Check for pattern match
|
||||
input_lower = input_content.lower()
|
||||
for pattern, response in self.config.responses.items():
|
||||
if pattern in input_lower:
|
||||
return response
|
||||
|
||||
# Simulate random error
|
||||
if self.config.simulate_errors and self._rng.random() < self.config.error_rate:
|
||||
return MockResponse(content="", error="Random simulated error")
|
||||
|
||||
# Generate deterministic response based on input hash
|
||||
input_hash = hashlib.md5(input_content.encode()).hexdigest()
|
||||
seed = int(input_hash[:8], 16)
|
||||
rng = random.Random(seed)
|
||||
|
||||
# Generate varied response
|
||||
templates = [
|
||||
"I've processed your request about '{topic}'. Here's what I found...",
|
||||
"Regarding '{topic}', I can provide the following information...",
|
||||
"Thank you for asking about '{topic}'. Let me explain...",
|
||||
"Based on your query about '{topic}', here's my response...",
|
||||
]
|
||||
|
||||
topic = input_content[:30] if len(input_content) > 30 else input_content
|
||||
template = rng.choice(templates)
|
||||
content = template.format(topic=topic)
|
||||
|
||||
# Add some mock content
|
||||
content += " This is a deterministic mock response generated for testing. "
|
||||
content += f"Input hash: {input_hash[:8]}. "
|
||||
content += "The response is reproducible given the same input."
|
||||
|
||||
return MockResponse(
|
||||
content=content,
|
||||
tokens=len(content.split()) * 2,
|
||||
cost=len(content) * 0.000001,
|
||||
)
|
||||
|
||||
async def generate(
|
||||
self,
|
||||
input_content: str,
|
||||
model: str = "mock-model",
|
||||
stream: bool = True,
|
||||
on_chunk: Optional[Callable[[str], None]] = None,
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Generate a mock response.
|
||||
|
||||
Args:
|
||||
input_content: The input prompt
|
||||
model: Model name (ignored for mock)
|
||||
stream: Whether to stream the response
|
||||
on_chunk: Callback for streaming chunks
|
||||
|
||||
Returns:
|
||||
Response dict with content, tokens, cost
|
||||
"""
|
||||
response = self._get_response(input_content)
|
||||
|
||||
# Record if in record mode
|
||||
if self.config.record_mode:
|
||||
self._save_recording(input_content, response)
|
||||
|
||||
# Check for error
|
||||
if response.error:
|
||||
raise Exception(response.error)
|
||||
|
||||
# Stream chunks
|
||||
if stream and on_chunk:
|
||||
for chunk in response.chunks:
|
||||
await asyncio.sleep(response.delay_per_chunk)
|
||||
on_chunk(chunk)
|
||||
else:
|
||||
# Non-streaming delay
|
||||
await asyncio.sleep(len(response.chunks) * response.delay_per_chunk)
|
||||
|
||||
return {
|
||||
"content": response.content,
|
||||
"tokens": response.tokens,
|
||||
"cost": response.cost,
|
||||
"tool_calls": response.tool_calls,
|
||||
"model": model,
|
||||
}
|
||||
|
||||
async def stream(
|
||||
self,
|
||||
input_content: str,
|
||||
model: str = "mock-model",
|
||||
) -> AsyncIterator[str]:
|
||||
"""
|
||||
Stream a mock response.
|
||||
|
||||
Yields chunks of the response.
|
||||
"""
|
||||
response = self._get_response(input_content)
|
||||
|
||||
if response.error:
|
||||
raise Exception(response.error)
|
||||
|
||||
for chunk in response.chunks:
|
||||
await asyncio.sleep(response.delay_per_chunk)
|
||||
yield chunk
|
||||
|
||||
def reset(self) -> None:
|
||||
"""Reset provider state."""
|
||||
self._rng = random.Random(self.config.seed)
|
||||
self._playback_index = 0
|
||||
|
||||
|
||||
class MockExecutor:
|
||||
"""
|
||||
Mock executor for queue worker testing.
|
||||
|
||||
Simulates agent execution with configurable behavior.
|
||||
"""
|
||||
|
||||
def __init__(self, provider: Optional[MockProvider] = None):
|
||||
self.provider = provider or MockProvider()
|
||||
|
||||
async def execute(
|
||||
self,
|
||||
input_content: str,
|
||||
agent_config: Dict[str, Any],
|
||||
on_output: Optional[Callable[[str], None]] = None,
|
||||
) -> Dict[str, Any]:
|
||||
"""Execute a mock agent run."""
|
||||
model = agent_config.get("model", "mock-model")
|
||||
|
||||
result = await self.provider.generate(
|
||||
input_content=input_content,
|
||||
model=model,
|
||||
stream=True,
|
||||
on_chunk=on_output,
|
||||
)
|
||||
|
||||
return {
|
||||
"output": result["content"],
|
||||
"metrics": {
|
||||
"tokens": result["tokens"],
|
||||
"cost": result["cost"],
|
||||
},
|
||||
"tool_calls": result.get("tool_calls", []),
|
||||
}
|
||||
|
||||
|
||||
# Convenience function for tests
|
||||
def create_mock_provider(
|
||||
seed: int = 42,
|
||||
responses: Optional[Dict[str, str]] = None,
|
||||
) -> MockProvider:
|
||||
"""Create a mock provider with optional custom responses."""
|
||||
config = MockProviderConfig(seed=seed)
|
||||
|
||||
if responses:
|
||||
for pattern, content in responses.items():
|
||||
config.responses[pattern] = MockResponse(content=content)
|
||||
|
||||
return MockProvider(config)
|
||||
@@ -0,0 +1,652 @@
|
||||
"""
|
||||
TUI Orchestrator for PraisonAI.
|
||||
|
||||
Provides unified event handling for both interactive TUI and headless simulation modes.
|
||||
Inspired by gemini-cli's event-driven architecture and codex-cli's state management.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import time
|
||||
import uuid
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from typing import Any, Callable, Dict, List, Optional, TextIO
|
||||
import sys
|
||||
|
||||
from .events import TUIEvent, TUIEventType
|
||||
from ..queue import QueueManager, QueueConfig, QueuedRun, RunState
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class OutputMode(str, Enum):
|
||||
"""Output mode for headless simulation."""
|
||||
PRETTY = "pretty"
|
||||
JSONL = "jsonl"
|
||||
SILENT = "silent"
|
||||
|
||||
|
||||
@dataclass
|
||||
class UIStateModel:
|
||||
"""
|
||||
In-memory UI state model.
|
||||
|
||||
Mirrors the state that would be displayed in the TUI,
|
||||
enabling headless simulation and snapshot generation.
|
||||
"""
|
||||
# Session info
|
||||
session_id: str = ""
|
||||
workspace: str = ""
|
||||
|
||||
# Model/config
|
||||
model: str = "gpt-4o-mini"
|
||||
|
||||
# Chat history
|
||||
messages: List[Dict[str, Any]] = field(default_factory=list)
|
||||
max_messages: int = 1000
|
||||
|
||||
# Current streaming state
|
||||
current_run_id: Optional[str] = None
|
||||
streaming_content: str = ""
|
||||
is_processing: bool = False
|
||||
|
||||
# Queue state
|
||||
queued_runs: List[Dict[str, Any]] = field(default_factory=list)
|
||||
running_runs: List[Dict[str, Any]] = field(default_factory=list)
|
||||
|
||||
# Tool calls
|
||||
pending_tool_calls: List[Dict[str, Any]] = field(default_factory=list)
|
||||
recent_tool_calls: List[Dict[str, Any]] = field(default_factory=list)
|
||||
|
||||
# Metrics
|
||||
total_tokens: int = 0
|
||||
total_cost: float = 0.0
|
||||
|
||||
# Focus/screen state (for simulation)
|
||||
current_screen: str = "main"
|
||||
focused_widget: str = "composer"
|
||||
|
||||
# Events log (for trace/replay)
|
||||
events: List[Dict[str, Any]] = field(default_factory=list)
|
||||
max_events: int = 10000
|
||||
|
||||
def add_message(self, role: str, content: str, **kwargs) -> None:
|
||||
"""Add a message to history."""
|
||||
msg = {
|
||||
"role": role,
|
||||
"content": content,
|
||||
"timestamp": time.time(),
|
||||
**kwargs
|
||||
}
|
||||
self.messages.append(msg)
|
||||
if len(self.messages) > self.max_messages:
|
||||
self.messages = self.messages[-self.max_messages:]
|
||||
|
||||
def add_event(self, event: TUIEvent) -> None:
|
||||
"""Add an event to the log."""
|
||||
evt = {
|
||||
"type": event.event_type.value,
|
||||
"timestamp": event.timestamp,
|
||||
"run_id": event.run_id,
|
||||
"session_id": event.session_id,
|
||||
"agent_name": event.agent_name,
|
||||
"data": event.data,
|
||||
}
|
||||
self.events.append(evt)
|
||||
if len(self.events) > self.max_events:
|
||||
self.events = self.events[-self.max_events:]
|
||||
|
||||
def to_snapshot(self) -> Dict[str, Any]:
|
||||
"""Generate a snapshot of current state."""
|
||||
return {
|
||||
"session_id": self.session_id,
|
||||
"model": self.model,
|
||||
"current_screen": self.current_screen,
|
||||
"focused_widget": self.focused_widget,
|
||||
"is_processing": self.is_processing,
|
||||
"current_run_id": self.current_run_id,
|
||||
"streaming_content_length": len(self.streaming_content),
|
||||
"message_count": len(self.messages),
|
||||
"last_messages": self.messages[-5:] if self.messages else [],
|
||||
"queued_count": len(self.queued_runs),
|
||||
"running_count": len(self.running_runs),
|
||||
"pending_tool_calls": len(self.pending_tool_calls),
|
||||
"total_tokens": self.total_tokens,
|
||||
"total_cost": self.total_cost,
|
||||
}
|
||||
|
||||
def render_snapshot_pretty(self) -> str:
|
||||
"""Render a pretty text snapshot like TUI would show."""
|
||||
lines = []
|
||||
|
||||
# Status bar
|
||||
status = f"◉ PraisonAI │ Session: {self.session_id[:8] if self.session_id else 'new'}"
|
||||
status += f" │ Model: {self.model}"
|
||||
if self.total_tokens > 0:
|
||||
status += f" │ Tokens: {self.total_tokens:,}"
|
||||
if self.total_cost > 0:
|
||||
status += f" │ ${self.total_cost:.4f}"
|
||||
if self.is_processing:
|
||||
status += " │ ⟳ Processing..."
|
||||
lines.append("─" * 60)
|
||||
lines.append(status)
|
||||
lines.append("─" * 60)
|
||||
|
||||
# Chat messages (last 5)
|
||||
lines.append("\n[Chat History]")
|
||||
for msg in self.messages[-5:]:
|
||||
role = msg.get("role", "unknown")
|
||||
content = msg.get("content", "")[:100]
|
||||
if len(msg.get("content", "")) > 100:
|
||||
content += "..."
|
||||
lines.append(f" {role.upper()}: {content}")
|
||||
|
||||
# Streaming content
|
||||
if self.streaming_content:
|
||||
lines.append(f"\n[Streaming] ({len(self.streaming_content)} chars)")
|
||||
preview = self.streaming_content[-200:]
|
||||
if len(self.streaming_content) > 200:
|
||||
preview = "..." + preview
|
||||
lines.append(f" {preview}")
|
||||
|
||||
# Queue status
|
||||
lines.append(f"\n[Queue] Queued: {len(self.queued_runs)} │ Running: {len(self.running_runs)}")
|
||||
|
||||
# Tool calls
|
||||
if self.pending_tool_calls:
|
||||
lines.append(f"\n[Pending Approvals] {len(self.pending_tool_calls)}")
|
||||
for tc in self.pending_tool_calls[:3]:
|
||||
lines.append(f" ⚠ {tc.get('tool_name', 'unknown')}")
|
||||
|
||||
# Screen/focus
|
||||
lines.append(f"\n[UI] Screen: {self.current_screen} │ Focus: {self.focused_widget}")
|
||||
lines.append("─" * 60)
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
class TuiOrchestrator:
|
||||
"""
|
||||
Unified orchestrator for TUI and headless modes.
|
||||
|
||||
Subscribes to the event bus and maintains an in-memory UI state model.
|
||||
Can drive Textual widgets (interactive) or output snapshots (headless).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
queue_manager: Optional[QueueManager] = None,
|
||||
queue_config: Optional[QueueConfig] = None,
|
||||
output_mode: OutputMode = OutputMode.PRETTY,
|
||||
output_stream: Optional[TextIO] = None,
|
||||
jsonl_path: Optional[str] = None,
|
||||
debug: bool = False,
|
||||
):
|
||||
self.queue_config = queue_config or QueueConfig()
|
||||
self.queue_manager = queue_manager
|
||||
self.output_mode = output_mode
|
||||
self.output_stream = output_stream or sys.stdout
|
||||
self.jsonl_path = jsonl_path
|
||||
self.debug = debug
|
||||
|
||||
# State
|
||||
self.state = UIStateModel()
|
||||
self._event_callbacks: List[Callable[[TUIEvent], None]] = []
|
||||
self._jsonl_file: Optional[TextIO] = None
|
||||
self._running = False
|
||||
|
||||
# Trace ID for this orchestrator session
|
||||
self.trace_id = str(uuid.uuid4())[:8]
|
||||
|
||||
async def start(self, session_id: Optional[str] = None, recover: bool = True) -> None:
|
||||
"""Start the orchestrator."""
|
||||
self.state.session_id = session_id or str(uuid.uuid4())[:8]
|
||||
self._running = True
|
||||
|
||||
# Open JSONL file if specified
|
||||
if self.jsonl_path:
|
||||
self._jsonl_file = open(self.jsonl_path, "a")
|
||||
|
||||
# Initialize queue manager if not provided
|
||||
if not self.queue_manager:
|
||||
self.queue_manager = QueueManager(
|
||||
config=self.queue_config,
|
||||
on_output=self._handle_output,
|
||||
on_complete=self._handle_complete,
|
||||
on_error=self._handle_error,
|
||||
)
|
||||
await self.queue_manager.start(recover=recover)
|
||||
self.queue_manager.set_session(self.state.session_id)
|
||||
|
||||
self._emit_event(TUIEvent(
|
||||
event_type=TUIEventType.SESSION_STARTED,
|
||||
session_id=self.state.session_id,
|
||||
data={"trace_id": self.trace_id}
|
||||
))
|
||||
|
||||
if self.debug:
|
||||
self._log_debug(f"Orchestrator started: session={self.state.session_id}, trace={self.trace_id}")
|
||||
|
||||
async def stop(self) -> None:
|
||||
"""Stop the orchestrator."""
|
||||
self._running = False
|
||||
|
||||
if self.queue_manager:
|
||||
await self.queue_manager.stop()
|
||||
|
||||
if self._jsonl_file:
|
||||
self._jsonl_file.close()
|
||||
self._jsonl_file = None
|
||||
|
||||
if self.debug:
|
||||
self._log_debug("Orchestrator stopped")
|
||||
|
||||
def add_event_callback(self, callback: Callable[[TUIEvent], None]) -> None:
|
||||
"""Add an event callback."""
|
||||
self._event_callbacks.append(callback)
|
||||
|
||||
def _emit_event(self, event: TUIEvent) -> None:
|
||||
"""Emit an event to all listeners."""
|
||||
# Add to state log
|
||||
self.state.add_event(event)
|
||||
|
||||
# Write to JSONL if enabled
|
||||
if self._jsonl_file:
|
||||
self._write_jsonl(event)
|
||||
|
||||
# Call callbacks
|
||||
for callback in self._event_callbacks:
|
||||
try:
|
||||
callback(event)
|
||||
except Exception as e:
|
||||
logger.error(f"Event callback error: {e}")
|
||||
|
||||
# Output based on mode
|
||||
if self.output_mode == OutputMode.JSONL:
|
||||
self._print_jsonl(event)
|
||||
elif self.output_mode == OutputMode.PRETTY and self.debug:
|
||||
self._print_event_pretty(event)
|
||||
|
||||
def _write_jsonl(self, event: TUIEvent) -> None:
|
||||
"""Write event to JSONL file."""
|
||||
if not self._jsonl_file:
|
||||
return
|
||||
|
||||
record = {
|
||||
"timestamp": event.timestamp,
|
||||
"trace_id": self.trace_id,
|
||||
"session_id": event.session_id or self.state.session_id,
|
||||
"event_type": event.event_type.value,
|
||||
"run_id": event.run_id,
|
||||
"agent_name": event.agent_name,
|
||||
"data": event.data,
|
||||
}
|
||||
self._jsonl_file.write(json.dumps(record, default=str) + "\n")
|
||||
self._jsonl_file.flush()
|
||||
|
||||
def _print_jsonl(self, event: TUIEvent) -> None:
|
||||
"""Print event as JSONL to output stream."""
|
||||
record = {
|
||||
"timestamp": event.timestamp,
|
||||
"event_type": event.event_type.value,
|
||||
"run_id": event.run_id,
|
||||
"data": event.data,
|
||||
}
|
||||
print(json.dumps(record, default=str), file=self.output_stream)
|
||||
|
||||
def _print_event_pretty(self, event: TUIEvent) -> None:
|
||||
"""Print event in pretty format."""
|
||||
ts = time.strftime("%H:%M:%S", time.localtime(event.timestamp))
|
||||
print(f"[{ts}] {event.event_type.value}", end="", file=self.output_stream)
|
||||
if event.run_id:
|
||||
print(f" run={event.run_id[:8]}", end="", file=self.output_stream)
|
||||
if event.data:
|
||||
data_preview = str(event.data)[:50]
|
||||
print(f" {data_preview}", end="", file=self.output_stream)
|
||||
print(file=self.output_stream)
|
||||
|
||||
def _log_debug(self, message: str) -> None:
|
||||
"""Log debug message."""
|
||||
if self.debug:
|
||||
ts = time.strftime("%H:%M:%S")
|
||||
print(f"[DEBUG {ts}] {message}", file=self.output_stream)
|
||||
|
||||
# Queue callbacks
|
||||
|
||||
async def _handle_output(self, run_id: str, chunk: str) -> None:
|
||||
"""Handle streaming output."""
|
||||
if run_id == self.state.current_run_id:
|
||||
self.state.streaming_content += chunk
|
||||
|
||||
self._emit_event(TUIEvent.output_chunk(run_id, chunk))
|
||||
|
||||
async def _handle_complete(self, run_id: str, run: QueuedRun) -> None:
|
||||
"""Handle run completion."""
|
||||
if run_id == self.state.current_run_id:
|
||||
# Add assistant message
|
||||
self.state.add_message(
|
||||
"assistant",
|
||||
run.output_content or self.state.streaming_content,
|
||||
run_id=run_id,
|
||||
agent_name=run.agent_name,
|
||||
)
|
||||
|
||||
# Update metrics
|
||||
if run.metrics:
|
||||
self.state.total_tokens += run.metrics.get("tokens", 0)
|
||||
self.state.total_cost += run.metrics.get("cost", 0.0)
|
||||
|
||||
# Clear streaming state
|
||||
self.state.current_run_id = None
|
||||
self.state.streaming_content = ""
|
||||
self.state.is_processing = False
|
||||
|
||||
# Update queue state
|
||||
self._update_queue_state()
|
||||
|
||||
self._emit_event(TUIEvent.run_completed(
|
||||
run_id,
|
||||
run.output_content or "",
|
||||
agent_name=run.agent_name,
|
||||
))
|
||||
|
||||
async def _handle_error(self, run_id: str, error: Exception) -> None:
|
||||
"""Handle run error."""
|
||||
if run_id == self.state.current_run_id:
|
||||
self.state.add_message(
|
||||
"system",
|
||||
f"Error: {error}",
|
||||
run_id=run_id,
|
||||
)
|
||||
self.state.current_run_id = None
|
||||
self.state.streaming_content = ""
|
||||
self.state.is_processing = False
|
||||
|
||||
self._update_queue_state()
|
||||
|
||||
self._emit_event(TUIEvent.error(str(error), run_id=run_id))
|
||||
|
||||
def _update_queue_state(self) -> None:
|
||||
"""Update queue state from manager."""
|
||||
if not self.queue_manager:
|
||||
return
|
||||
|
||||
runs = self.queue_manager.list_runs(limit=100)
|
||||
self.state.queued_runs = [
|
||||
r.to_dict() for r in runs if r.state == RunState.QUEUED
|
||||
]
|
||||
self.state.running_runs = [
|
||||
r.to_dict() for r in runs if r.state == RunState.RUNNING
|
||||
]
|
||||
|
||||
# Public API
|
||||
|
||||
async def submit_message(self, content: str, agent_name: str = "Assistant") -> str:
|
||||
"""Submit a message for processing."""
|
||||
# Add user message
|
||||
self.state.add_message("user", content)
|
||||
self.state.is_processing = True
|
||||
|
||||
self._emit_event(TUIEvent.message_submitted(content))
|
||||
|
||||
# Submit to queue
|
||||
run_id = await self.queue_manager.submit(
|
||||
input_content=content,
|
||||
agent_name=agent_name,
|
||||
config={"agent_config": {"name": agent_name, "model": self.state.model}}
|
||||
)
|
||||
|
||||
self.state.current_run_id = run_id
|
||||
self.state.streaming_content = ""
|
||||
|
||||
# Add placeholder for streaming
|
||||
self.state.add_message(
|
||||
"assistant",
|
||||
"",
|
||||
run_id=run_id,
|
||||
agent_name=agent_name,
|
||||
is_streaming=True,
|
||||
)
|
||||
|
||||
self._update_queue_state()
|
||||
|
||||
return run_id
|
||||
|
||||
async def cancel_run(self, run_id: Optional[str] = None) -> bool:
|
||||
"""Cancel a run."""
|
||||
target_id = run_id or self.state.current_run_id
|
||||
if not target_id:
|
||||
return False
|
||||
|
||||
result = await self.queue_manager.cancel(target_id)
|
||||
|
||||
if target_id == self.state.current_run_id:
|
||||
self.state.current_run_id = None
|
||||
self.state.streaming_content = ""
|
||||
self.state.is_processing = False
|
||||
|
||||
self._update_queue_state()
|
||||
|
||||
self._emit_event(TUIEvent(
|
||||
event_type=TUIEventType.RUN_CANCELLED,
|
||||
run_id=target_id,
|
||||
))
|
||||
|
||||
return result
|
||||
|
||||
async def retry_run(self, run_id: str) -> Optional[str]:
|
||||
"""Retry a failed run."""
|
||||
new_id = await self.queue_manager.retry(run_id)
|
||||
self._update_queue_state()
|
||||
return new_id
|
||||
|
||||
def set_model(self, model: str) -> None:
|
||||
"""Set the current model."""
|
||||
self.state.model = model
|
||||
self._emit_event(TUIEvent.status_update(f"Model set to {model}"))
|
||||
|
||||
def navigate_screen(self, screen: str) -> None:
|
||||
"""Navigate to a screen (for simulation)."""
|
||||
self.state.current_screen = screen
|
||||
self._emit_event(TUIEvent(
|
||||
event_type=TUIEventType.SCREEN_CHANGED,
|
||||
data={"screen": screen}
|
||||
))
|
||||
|
||||
def set_focus(self, widget: str) -> None:
|
||||
"""Set focus to a widget (for simulation)."""
|
||||
self.state.focused_widget = widget
|
||||
self._emit_event(TUIEvent(
|
||||
event_type=TUIEventType.FOCUS_CHANGED,
|
||||
data={"widget": widget}
|
||||
))
|
||||
|
||||
def get_snapshot(self) -> Dict[str, Any]:
|
||||
"""Get current state snapshot."""
|
||||
return self.state.to_snapshot()
|
||||
|
||||
def render_snapshot(self) -> str:
|
||||
"""Render pretty snapshot."""
|
||||
return self.state.render_snapshot_pretty()
|
||||
|
||||
async def wait_for_idle(self, timeout: float = 60.0) -> bool:
|
||||
"""Wait until no runs are processing."""
|
||||
start = time.time()
|
||||
while time.time() - start < timeout:
|
||||
if not self.state.is_processing and not self.state.running_runs:
|
||||
return True
|
||||
await asyncio.sleep(0.1)
|
||||
return False
|
||||
|
||||
async def wait_for_run(self, run_id: str, timeout: float = 60.0) -> bool:
|
||||
"""Wait for a specific run to complete."""
|
||||
start = time.time()
|
||||
while time.time() - start < timeout:
|
||||
run = self.queue_manager.get_run(run_id)
|
||||
if run and run.state.is_terminal():
|
||||
return True
|
||||
await asyncio.sleep(0.1)
|
||||
return False
|
||||
|
||||
|
||||
@dataclass
|
||||
class SimulationStep:
|
||||
"""A step in a simulation script."""
|
||||
action: str # "submit", "cancel", "retry", "navigate", "focus", "wait", "approve", "deny"
|
||||
args: Dict[str, Any] = field(default_factory=dict)
|
||||
expected: Optional[Dict[str, Any]] = None # For assertion mode
|
||||
|
||||
|
||||
class SimulationRunner:
|
||||
"""
|
||||
Runs simulation scripts for headless TUI testing.
|
||||
|
||||
Script format (YAML):
|
||||
```yaml
|
||||
session_id: test-session
|
||||
model: gpt-4o-mini
|
||||
steps:
|
||||
- action: submit
|
||||
args:
|
||||
content: "Hello, world!"
|
||||
- action: wait
|
||||
args:
|
||||
condition: idle
|
||||
timeout: 30
|
||||
- action: navigate
|
||||
args:
|
||||
screen: queue
|
||||
- action: cancel
|
||||
args:
|
||||
run_id: current
|
||||
```
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
orchestrator: TuiOrchestrator,
|
||||
assert_mode: bool = False,
|
||||
):
|
||||
self.orchestrator = orchestrator
|
||||
self.assert_mode = assert_mode
|
||||
self.assertions_passed = 0
|
||||
self.assertions_failed = 0
|
||||
self.errors: List[str] = []
|
||||
|
||||
async def run_script(self, script: Dict[str, Any]) -> bool:
|
||||
"""Run a simulation script."""
|
||||
# Initialize session
|
||||
session_id = script.get("session_id")
|
||||
await self.orchestrator.start(session_id=session_id)
|
||||
|
||||
if "model" in script:
|
||||
self.orchestrator.set_model(script["model"])
|
||||
|
||||
# Run steps
|
||||
steps = script.get("steps", [])
|
||||
for i, step_data in enumerate(steps):
|
||||
step = SimulationStep(
|
||||
action=step_data.get("action", ""),
|
||||
args=step_data.get("args", {}),
|
||||
expected=step_data.get("expected"),
|
||||
)
|
||||
|
||||
try:
|
||||
await self._run_step(step, i)
|
||||
except Exception as e:
|
||||
self.errors.append(f"Step {i} ({step.action}): {e}")
|
||||
if self.assert_mode:
|
||||
break
|
||||
|
||||
await self.orchestrator.stop()
|
||||
|
||||
return len(self.errors) == 0
|
||||
|
||||
async def _run_step(self, step: SimulationStep, index: int) -> None:
|
||||
"""Run a single simulation step."""
|
||||
action = step.action.lower()
|
||||
args = step.args
|
||||
|
||||
if action == "submit":
|
||||
content = args.get("content", "")
|
||||
agent = args.get("agent", "Assistant")
|
||||
await self.orchestrator.submit_message(content, agent)
|
||||
|
||||
elif action == "cancel":
|
||||
run_id = args.get("run_id")
|
||||
if run_id == "current":
|
||||
run_id = None
|
||||
await self.orchestrator.cancel_run(run_id)
|
||||
|
||||
elif action == "retry":
|
||||
run_id = args.get("run_id", "")
|
||||
await self.orchestrator.retry_run(run_id)
|
||||
|
||||
elif action == "navigate":
|
||||
screen = args.get("screen", "main")
|
||||
self.orchestrator.navigate_screen(screen)
|
||||
|
||||
elif action == "focus":
|
||||
widget = args.get("widget", "composer")
|
||||
self.orchestrator.set_focus(widget)
|
||||
|
||||
elif action == "wait":
|
||||
condition = args.get("condition", "idle")
|
||||
timeout = args.get("timeout", 30.0)
|
||||
|
||||
if condition == "idle":
|
||||
success = await self.orchestrator.wait_for_idle(timeout)
|
||||
elif condition == "run":
|
||||
run_id = args.get("run_id", "")
|
||||
success = await self.orchestrator.wait_for_run(run_id, timeout)
|
||||
else:
|
||||
await asyncio.sleep(timeout)
|
||||
success = True
|
||||
|
||||
if not success and self.assert_mode:
|
||||
raise TimeoutError(f"Wait condition '{condition}' timed out")
|
||||
|
||||
elif action == "model":
|
||||
model = args.get("model", "gpt-4o-mini")
|
||||
self.orchestrator.set_model(model)
|
||||
|
||||
elif action == "snapshot":
|
||||
snapshot = self.orchestrator.render_snapshot()
|
||||
print(snapshot)
|
||||
|
||||
elif action == "sleep":
|
||||
duration = args.get("seconds", 1.0)
|
||||
await asyncio.sleep(duration)
|
||||
|
||||
else:
|
||||
raise ValueError(f"Unknown action: {action}")
|
||||
|
||||
# Check assertions
|
||||
if self.assert_mode and step.expected:
|
||||
self._check_assertions(step.expected, index)
|
||||
|
||||
def _check_assertions(self, expected: Dict[str, Any], step_index: int) -> None:
|
||||
"""Check assertions against current state."""
|
||||
snapshot = self.orchestrator.get_snapshot()
|
||||
|
||||
for key, expected_value in expected.items():
|
||||
actual_value = snapshot.get(key)
|
||||
|
||||
if actual_value != expected_value:
|
||||
self.assertions_failed += 1
|
||||
self.errors.append(
|
||||
f"Step {step_index}: Expected {key}={expected_value}, got {actual_value}"
|
||||
)
|
||||
else:
|
||||
self.assertions_passed += 1
|
||||
|
||||
def get_summary(self) -> Dict[str, Any]:
|
||||
"""Get simulation summary."""
|
||||
return {
|
||||
"assertions_passed": self.assertions_passed,
|
||||
"assertions_failed": self.assertions_failed,
|
||||
"errors": self.errors,
|
||||
"success": len(self.errors) == 0,
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
"""
|
||||
TUI Screens for PraisonAI.
|
||||
|
||||
Screen definitions for different views in the TUI application.
|
||||
"""
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .main import MainScreen
|
||||
from .queue import QueueScreen
|
||||
from .settings import SettingsScreen
|
||||
from .session import SessionScreen
|
||||
|
||||
_lazy_cache = {}
|
||||
|
||||
|
||||
def __getattr__(name: str):
|
||||
"""Lazy load screens."""
|
||||
global _lazy_cache
|
||||
|
||||
if name in _lazy_cache:
|
||||
return _lazy_cache[name]
|
||||
|
||||
if name == "MainScreen":
|
||||
from .main import MainScreen
|
||||
_lazy_cache[name] = MainScreen
|
||||
return MainScreen
|
||||
elif name == "QueueScreen":
|
||||
from .queue import QueueScreen
|
||||
_lazy_cache[name] = QueueScreen
|
||||
return QueueScreen
|
||||
elif name == "SettingsScreen":
|
||||
from .settings import SettingsScreen
|
||||
_lazy_cache[name] = SettingsScreen
|
||||
return SettingsScreen
|
||||
elif name == "SessionScreen":
|
||||
from .session import SessionScreen
|
||||
_lazy_cache[name] = SessionScreen
|
||||
return SessionScreen
|
||||
|
||||
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
||||
|
||||
|
||||
__all__ = [
|
||||
"MainScreen",
|
||||
"QueueScreen",
|
||||
"SettingsScreen",
|
||||
"SessionScreen",
|
||||
]
|
||||
@@ -0,0 +1,157 @@
|
||||
"""
|
||||
Help Screen for PraisonAI TUI.
|
||||
|
||||
Displays keyboard shortcuts and usage information.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
try:
|
||||
from textual.screen import Screen
|
||||
from textual.containers import Vertical, Container
|
||||
from textual.widgets import Static, Footer, Button
|
||||
from textual.binding import Binding
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
Screen = object
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
from rich.text import Text
|
||||
from rich.panel import Panel
|
||||
from rich.table import Table
|
||||
|
||||
class HelpScreen(Screen):
|
||||
"""
|
||||
Help screen showing keyboard shortcuts and usage.
|
||||
"""
|
||||
|
||||
BINDINGS = [
|
||||
Binding("escape", "dismiss", "Close", show=True),
|
||||
Binding("q", "dismiss", "Close", show=True),
|
||||
]
|
||||
|
||||
DEFAULT_CSS = """
|
||||
HelpScreen {
|
||||
align: center middle;
|
||||
}
|
||||
|
||||
HelpScreen #help-container {
|
||||
width: 80;
|
||||
height: auto;
|
||||
max-height: 90%;
|
||||
background: $surface;
|
||||
border: solid $primary;
|
||||
padding: 1 2;
|
||||
}
|
||||
|
||||
HelpScreen #help-title {
|
||||
text-align: center;
|
||||
text-style: bold;
|
||||
margin-bottom: 1;
|
||||
}
|
||||
|
||||
HelpScreen #close-button {
|
||||
margin-top: 1;
|
||||
width: 100%;
|
||||
}
|
||||
"""
|
||||
|
||||
def compose(self):
|
||||
"""Compose the help screen."""
|
||||
with Container(id="help-container"):
|
||||
yield Static("PraisonAI TUI Help", id="help-title")
|
||||
yield Static(self._build_help_content())
|
||||
yield Button("Close (Esc)", id="close-button", variant="primary")
|
||||
|
||||
def _build_help_content(self) -> Text:
|
||||
"""Build the help content."""
|
||||
content = Text()
|
||||
|
||||
# Safe keyboard shortcuts section
|
||||
content.append("\n📋 Keyboard Shortcuts (Safe Defaults)\n", style="bold cyan")
|
||||
content.append("─" * 40 + "\n", style="dim")
|
||||
|
||||
shortcuts = [
|
||||
("\\", "Show command popup"),
|
||||
("@path", "Reference file (type freely)"),
|
||||
("/", "Show command discovery"),
|
||||
("Enter", "Send message"),
|
||||
("Shift+Enter", "New line in message"),
|
||||
("q", "Quit (when not typing)"),
|
||||
("?", "Show this help"),
|
||||
(":", "Enter command mode"),
|
||||
("Escape", "Cancel/Close/Dismiss"),
|
||||
("Tab", "Focus next element"),
|
||||
("Up/Down", "Navigate history"),
|
||||
]
|
||||
|
||||
for key, desc in shortcuts:
|
||||
content.append(f" {key:<15}", style="yellow")
|
||||
content.append(f" {desc}\n")
|
||||
|
||||
# Command mode section
|
||||
content.append("\n⌨️ Command Mode (: prefix)\n", style="bold cyan")
|
||||
content.append("─" * 40 + "\n", style="dim")
|
||||
|
||||
colon_cmds = [
|
||||
(":quit, :q", "Quit application"),
|
||||
(":clear, :cl", "Clear chat history"),
|
||||
(":help, :h", "Show help"),
|
||||
(":tools, :t", "Toggle tools panel"),
|
||||
(":queue, :qu", "Toggle queue panel"),
|
||||
(":settings", "Open settings"),
|
||||
(":cancel", "Cancel current operation"),
|
||||
]
|
||||
|
||||
for cmd, desc in colon_cmds:
|
||||
content.append(f" {cmd:<15}", style="green")
|
||||
content.append(f" {desc}\n")
|
||||
|
||||
# Slash commands section
|
||||
content.append("\n💬 Slash Commands (/ prefix)\n", style="bold cyan")
|
||||
content.append("─" * 40 + "\n", style="dim")
|
||||
|
||||
commands = [
|
||||
("/help", "Show help"),
|
||||
("/clear", "Clear chat"),
|
||||
("/model", "Show/change model"),
|
||||
("/queue", "Show queue status"),
|
||||
("/cancel", "Cancel current run"),
|
||||
("/cost", "Show cost summary"),
|
||||
("/settings", "Open settings"),
|
||||
("/sessions", "Manage sessions"),
|
||||
("/exit", "Exit TUI"),
|
||||
]
|
||||
|
||||
for cmd, desc in commands:
|
||||
content.append(f" {cmd:<15}", style="green")
|
||||
content.append(f" {desc}\n")
|
||||
|
||||
# Optional keys note
|
||||
content.append("\n⚙️ Optional Keys (disabled by default)\n", style="bold cyan")
|
||||
content.append("─" * 40 + "\n", style="dim")
|
||||
content.append(" Ctrl keys: ", style="dim")
|
||||
content.append("PRAISONAI_TUI_CTRL_KEYS=1\n", style="yellow")
|
||||
content.append(" Fn keys: ", style="dim")
|
||||
content.append("PRAISONAI_TUI_FN_KEYS=1\n", style="yellow")
|
||||
|
||||
return content
|
||||
|
||||
def on_button_pressed(self, event: Button.Pressed) -> None:
|
||||
"""Handle button press."""
|
||||
if event.button.id == "close-button":
|
||||
self.dismiss()
|
||||
|
||||
def action_dismiss(self) -> None:
|
||||
"""Dismiss the help screen."""
|
||||
self.dismiss()
|
||||
|
||||
else:
|
||||
class HelpScreen:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
@@ -0,0 +1,503 @@
|
||||
"""
|
||||
Main Screen for PraisonAI TUI.
|
||||
|
||||
The primary chat interface screen.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
try:
|
||||
from textual.screen import Screen
|
||||
from textual.containers import Horizontal, Vertical, Container
|
||||
from textual.widgets import Static, Footer, Header
|
||||
from textual.binding import Binding
|
||||
from textual.message import Message
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
Screen = object
|
||||
Message = object
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
from ..widgets.chat import ChatWidget, ChatMessage
|
||||
from ..widgets.composer import ComposerWidget
|
||||
from ..widgets.status import StatusWidget, StatusInfo
|
||||
from ..widgets.queue_panel import QueuePanelWidget
|
||||
from ..widgets.tool_panel import ToolPanelWidget
|
||||
from ..widgets.command_popup import CommandPopupWidget, get_default_commands
|
||||
from ..widgets.file_popup import FilePopupWidget
|
||||
from ..config import TUIConfig, get_command
|
||||
|
||||
class MainScreen(Screen):
|
||||
"""
|
||||
Main chat screen.
|
||||
|
||||
Layout:
|
||||
- Status bar (top)
|
||||
- Chat history (main area)
|
||||
- Tools panel (right sidebar)
|
||||
- Queue panel (right sidebar)
|
||||
- Composer (bottom)
|
||||
- Footer with keybindings
|
||||
"""
|
||||
|
||||
# Safe default bindings - no Ctrl or Fn keys by default
|
||||
# These work in VS Code, Windsurf, tmux, and plain terminals
|
||||
BINDINGS = [
|
||||
# Single-character shortcuts (safe defaults)
|
||||
Binding("q", "quit", "Quit", show=True, priority=True),
|
||||
Binding("question_mark", "help", "Help", show=True),
|
||||
Binding("backslash", "show_commands", "\\cmds", show=True),
|
||||
Binding("colon", "command_mode", ":cmd", show=False),
|
||||
Binding("slash", "search", "/search", show=False),
|
||||
# Navigation
|
||||
Binding("tab", "focus_next", "Next", show=False),
|
||||
Binding("escape", "cancel_or_dismiss", "Cancel", show=True),
|
||||
]
|
||||
|
||||
DEFAULT_CSS = """
|
||||
MainScreen {
|
||||
layout: grid;
|
||||
grid-size: 2;
|
||||
grid-columns: 3fr 1fr;
|
||||
grid-rows: 1 1fr auto 1;
|
||||
layers: base popup;
|
||||
}
|
||||
|
||||
MainScreen #status-bar {
|
||||
column-span: 2;
|
||||
}
|
||||
|
||||
MainScreen #main-area {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
MainScreen #sidebar {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
MainScreen #composer-area {
|
||||
column-span: 2;
|
||||
height: auto;
|
||||
max-height: 10;
|
||||
}
|
||||
|
||||
MainScreen Footer {
|
||||
column-span: 2;
|
||||
}
|
||||
|
||||
MainScreen .sidebar-panel {
|
||||
height: 1fr;
|
||||
}
|
||||
|
||||
MainScreen #command-popup {
|
||||
layer: popup;
|
||||
dock: bottom;
|
||||
margin: 0 2 2 2;
|
||||
}
|
||||
|
||||
MainScreen #file-popup {
|
||||
layer: popup;
|
||||
dock: bottom;
|
||||
margin: 0 2 2 2;
|
||||
}
|
||||
"""
|
||||
|
||||
class MessageSubmitted(Message):
|
||||
"""Event when a message is submitted."""
|
||||
def __init__(self, content: str):
|
||||
self.content = content
|
||||
super().__init__()
|
||||
|
||||
class CommandExecuted(Message):
|
||||
"""Event when a command is executed."""
|
||||
def __init__(self, command: str, args: str):
|
||||
self.command = command
|
||||
self.args = args
|
||||
super().__init__()
|
||||
|
||||
class CancelRequested(Message):
|
||||
"""Event when cancel is requested."""
|
||||
pass
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
show_queue: bool = True,
|
||||
show_tools: bool = True,
|
||||
config: Optional[TUIConfig] = None,
|
||||
name: Optional[str] = None,
|
||||
id: Optional[str] = None,
|
||||
classes: Optional[str] = None,
|
||||
):
|
||||
super().__init__(name=name, id=id, classes=classes)
|
||||
self._show_queue = show_queue
|
||||
self._show_tools = show_tools
|
||||
self._config = config or TUIConfig.from_env()
|
||||
self._command_mode = False
|
||||
self._command_buffer = ""
|
||||
self._command_popup_visible = False
|
||||
self._file_popup_visible = False
|
||||
self._workspace = None
|
||||
|
||||
# Dynamically add Ctrl/Fn bindings if enabled
|
||||
self._setup_optional_bindings()
|
||||
|
||||
def compose(self):
|
||||
"""Compose the screen."""
|
||||
yield StatusWidget(id="status-bar")
|
||||
|
||||
yield ChatWidget(id="chat-widget")
|
||||
|
||||
with Vertical(id="sidebar"):
|
||||
if self._show_tools:
|
||||
yield ToolPanelWidget(id="tool-panel", classes="sidebar-panel")
|
||||
if self._show_queue:
|
||||
yield QueuePanelWidget(id="queue-panel", classes="sidebar-panel")
|
||||
|
||||
yield ComposerWidget(id="composer")
|
||||
|
||||
yield Footer()
|
||||
|
||||
def _setup_optional_bindings(self) -> None:
|
||||
"""Setup optional Ctrl/Fn key bindings based on config."""
|
||||
if self._config.enable_ctrl_keys:
|
||||
# Add Ctrl key bindings (opt-in)
|
||||
self._bindings.bind("ctrl+q", "quit", "^Q Quit", show=True)
|
||||
self._bindings.bind("ctrl+c", "cancel", "^C Cancel", show=True)
|
||||
self._bindings.bind("ctrl+l", "clear_chat", "^L Clear", show=True)
|
||||
|
||||
if self._config.enable_fn_keys:
|
||||
# Add Function key bindings (opt-in)
|
||||
self._bindings.bind("f1", "help", "F1 Help", show=True)
|
||||
self._bindings.bind("f2", "toggle_queue", "F2 Queue", show=True)
|
||||
self._bindings.bind("f3", "settings", "F3 Settings", show=True)
|
||||
self._bindings.bind("f5", "clear_chat", "F5 Clear", show=True)
|
||||
|
||||
def on_mount(self) -> None:
|
||||
"""Handle mount."""
|
||||
# Focus composer
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.focus_input()
|
||||
|
||||
def on_composer_widget_submitted(self, event: ComposerWidget.Submitted) -> None:
|
||||
"""Handle message submission."""
|
||||
if event.is_command:
|
||||
# Parse command (supports both / and : prefix)
|
||||
content = event.content
|
||||
if content.startswith("/") or content.startswith(":"):
|
||||
content = content[1:] # Remove prefix
|
||||
|
||||
parts = content.split(maxsplit=1)
|
||||
command = parts[0] if parts else ""
|
||||
args = parts[1] if len(parts) > 1 else ""
|
||||
|
||||
# Handle local screen commands first
|
||||
if self._handle_local_command(command, args):
|
||||
return
|
||||
|
||||
# Forward to app for other commands
|
||||
self.post_message(self.CommandExecuted(command, args))
|
||||
else:
|
||||
self.post_message(self.MessageSubmitted(event.content))
|
||||
|
||||
def _handle_local_command(self, command: str, args: str) -> bool:
|
||||
"""Handle commands that can be processed locally without app involvement."""
|
||||
cmd = get_command(command)
|
||||
|
||||
if cmd == "quit":
|
||||
self.app.exit()
|
||||
return True
|
||||
elif cmd == "clear":
|
||||
self.action_clear_chat()
|
||||
return True
|
||||
elif cmd == "help":
|
||||
self.action_help()
|
||||
return True
|
||||
elif cmd == "tools":
|
||||
self.action_toggle_tools()
|
||||
return True
|
||||
elif cmd == "queue":
|
||||
self.action_toggle_queue()
|
||||
return True
|
||||
elif cmd == "settings":
|
||||
self.action_settings()
|
||||
return True
|
||||
elif cmd == "cancel":
|
||||
self.action_cancel()
|
||||
return True
|
||||
|
||||
return False # Not handled locally
|
||||
|
||||
def action_quit(self) -> None:
|
||||
"""Quit the application."""
|
||||
self.app.exit()
|
||||
|
||||
def action_cancel(self) -> None:
|
||||
"""Cancel current operation."""
|
||||
self.post_message(self.CancelRequested())
|
||||
|
||||
def action_clear(self) -> None:
|
||||
"""Clear screen."""
|
||||
pass
|
||||
|
||||
def action_help(self) -> None:
|
||||
"""Show help."""
|
||||
self.app.push_screen("help")
|
||||
|
||||
def action_toggle_queue(self) -> None:
|
||||
"""Toggle queue panel visibility."""
|
||||
try:
|
||||
queue_panel = self.query_one("#queue-panel", QueuePanelWidget)
|
||||
queue_panel.display = not queue_panel.display
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def action_settings(self) -> None:
|
||||
"""Show settings."""
|
||||
self.app.push_screen("settings")
|
||||
|
||||
def action_clear_chat(self) -> None:
|
||||
"""Clear chat history."""
|
||||
chat = self.query_one("#chat-widget", ChatWidget)
|
||||
self.app.call_later(chat.clear)
|
||||
|
||||
def action_cancel_input(self) -> None:
|
||||
"""Cancel current input."""
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.action_cancel()
|
||||
|
||||
def action_command_mode(self) -> None:
|
||||
"""Enter command mode - focus composer with : prefix."""
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.focus_input()
|
||||
composer.set_text(":")
|
||||
|
||||
def action_search(self) -> None:
|
||||
"""Enter search mode - focus composer with / prefix."""
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.focus_input()
|
||||
composer.set_text("/")
|
||||
|
||||
def action_toggle_tools(self) -> None:
|
||||
"""Toggle tools panel visibility."""
|
||||
try:
|
||||
tool_panel = self.query_one("#tool-panel", ToolPanelWidget)
|
||||
tool_panel.display = not tool_panel.display
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def action_show_commands(self) -> None:
|
||||
"""Show command popup (triggered by backslash)."""
|
||||
if self._command_popup_visible:
|
||||
return
|
||||
|
||||
self._command_popup_visible = True
|
||||
|
||||
# Create and mount command popup
|
||||
popup = CommandPopupWidget(
|
||||
commands=get_default_commands(),
|
||||
id="command-popup",
|
||||
)
|
||||
self.mount(popup)
|
||||
popup.focus_search()
|
||||
|
||||
def action_cancel_or_dismiss(self) -> None:
|
||||
"""Cancel input or dismiss popup."""
|
||||
if self._command_popup_visible:
|
||||
self._dismiss_command_popup()
|
||||
else:
|
||||
self.action_cancel_input()
|
||||
|
||||
def _dismiss_command_popup(self) -> None:
|
||||
"""Dismiss the command popup."""
|
||||
if not self._command_popup_visible:
|
||||
return
|
||||
|
||||
try:
|
||||
popup = self.query_one("#command-popup", CommandPopupWidget)
|
||||
popup.remove()
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
self._command_popup_visible = False
|
||||
|
||||
# Return focus to composer
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.focus_input()
|
||||
|
||||
def on_command_popup_widget_command_selected(
|
||||
self, event: CommandPopupWidget.CommandSelected
|
||||
) -> None:
|
||||
"""Handle command selection from popup."""
|
||||
self._dismiss_command_popup()
|
||||
|
||||
# Execute the selected command
|
||||
if self._handle_local_command(event.command, event.args):
|
||||
return
|
||||
|
||||
# Forward to app for other commands
|
||||
self.post_message(self.CommandExecuted(event.command, event.args))
|
||||
|
||||
def on_command_popup_widget_dismissed(
|
||||
self, event: CommandPopupWidget.Dismissed
|
||||
) -> None:
|
||||
"""Handle popup dismissal."""
|
||||
self._dismiss_command_popup()
|
||||
|
||||
# Auto-trigger event handlers from ComposerWidget
|
||||
|
||||
def on_composer_widget_backslash_typed(
|
||||
self, event: ComposerWidget.BackslashTyped
|
||||
) -> None:
|
||||
"""Handle backslash typed - auto-show command popup."""
|
||||
# Clear the backslash from composer and show popup
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.set_text("")
|
||||
self.action_show_commands()
|
||||
|
||||
def on_composer_widget_at_typed(
|
||||
self, event: ComposerWidget.AtTyped
|
||||
) -> None:
|
||||
"""Handle @ typed - DO NOT block typing.
|
||||
|
||||
MINIMUM VIABLE UX: User can freely type @path/to/file.
|
||||
The popup is optional and must NOT steal focus or block input.
|
||||
For now, we simply allow typing to continue uninterrupted.
|
||||
"""
|
||||
# DO NOT show popup that blocks typing
|
||||
# User can manually type: @README.md, @src/main.py, etc.
|
||||
pass
|
||||
|
||||
def on_composer_widget_slash_typed(
|
||||
self, event: ComposerWidget.SlashTyped
|
||||
) -> None:
|
||||
"""Handle / typed - auto-show command popup with filter."""
|
||||
if not self._command_popup_visible:
|
||||
self._command_popup_visible = True
|
||||
popup = CommandPopupWidget(
|
||||
commands=get_default_commands(),
|
||||
id="command-popup",
|
||||
)
|
||||
self.mount(popup)
|
||||
# Set filter to current query
|
||||
popup.filter_text = event.query
|
||||
|
||||
def _show_file_popup(self, query: str, at_pos: int) -> None:
|
||||
"""Show file autocomplete popup."""
|
||||
if self._file_popup_visible:
|
||||
# Update existing popup
|
||||
try:
|
||||
popup = self.query_one("#file-popup", FilePopupWidget)
|
||||
popup.set_query(query, at_pos)
|
||||
except Exception:
|
||||
pass
|
||||
return
|
||||
|
||||
self._file_popup_visible = True
|
||||
|
||||
# Create and mount file popup
|
||||
import os
|
||||
popup = FilePopupWidget(
|
||||
root_dir=self._workspace or os.getcwd(),
|
||||
at_pos=at_pos,
|
||||
id="file-popup",
|
||||
)
|
||||
self.mount(popup)
|
||||
popup.set_query(query, at_pos)
|
||||
|
||||
def _dismiss_file_popup(self) -> None:
|
||||
"""Dismiss the file popup."""
|
||||
if not self._file_popup_visible:
|
||||
return
|
||||
|
||||
try:
|
||||
popup = self.query_one("#file-popup", FilePopupWidget)
|
||||
popup.remove()
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
self._file_popup_visible = False
|
||||
|
||||
# Return focus to composer
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.focus_input()
|
||||
|
||||
def on_file_popup_widget_file_selected(
|
||||
self, event: FilePopupWidget.FileSelected
|
||||
) -> None:
|
||||
"""Handle file selection from popup."""
|
||||
self._dismiss_file_popup()
|
||||
|
||||
# Insert the file path into composer
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
current_text = composer.text
|
||||
|
||||
# Replace from @ position to end with selected path
|
||||
new_text = current_text[:event.at_pos] + "@" + event.path
|
||||
composer.set_text(new_text)
|
||||
composer.focus_input()
|
||||
|
||||
def on_file_popup_widget_dismissed(
|
||||
self, event: FilePopupWidget.Dismissed
|
||||
) -> None:
|
||||
"""Handle file popup dismissal."""
|
||||
self._dismiss_file_popup()
|
||||
|
||||
# Public methods for updating UI
|
||||
|
||||
async def add_user_message(self, content: str) -> None:
|
||||
"""Add a user message to chat."""
|
||||
chat = self.query_one("#chat-widget", ChatWidget)
|
||||
await chat.add_message(ChatMessage(
|
||||
role="user",
|
||||
content=content,
|
||||
))
|
||||
|
||||
async def add_assistant_message(
|
||||
self,
|
||||
content: str,
|
||||
run_id: Optional[str] = None,
|
||||
agent_name: Optional[str] = None,
|
||||
streaming: bool = False,
|
||||
) -> None:
|
||||
"""Add an assistant message to chat."""
|
||||
chat = self.query_one("#chat-widget", ChatWidget)
|
||||
await chat.add_message(ChatMessage(
|
||||
role="assistant",
|
||||
content=content,
|
||||
run_id=run_id,
|
||||
agent_name=agent_name,
|
||||
is_streaming=streaming,
|
||||
))
|
||||
|
||||
async def update_streaming(self, run_id: str, content: str) -> None:
|
||||
"""Update streaming message."""
|
||||
chat = self.query_one("#chat-widget", ChatWidget)
|
||||
await chat.update_streaming(run_id, content)
|
||||
|
||||
async def complete_streaming(self, run_id: str, content: str) -> None:
|
||||
"""Complete streaming message."""
|
||||
chat = self.query_one("#chat-widget", ChatWidget)
|
||||
await chat.complete_streaming(run_id, content)
|
||||
|
||||
def update_status(self, info: StatusInfo) -> None:
|
||||
"""Update status bar."""
|
||||
status = self.query_one("#status-bar", StatusWidget)
|
||||
status.update_info(info)
|
||||
|
||||
def set_processing(self, processing: bool) -> None:
|
||||
"""Set processing state."""
|
||||
composer = self.query_one("#composer", ComposerWidget)
|
||||
composer.set_processing(processing)
|
||||
|
||||
status = self.query_one("#status-bar", StatusWidget)
|
||||
status.is_processing = processing
|
||||
|
||||
else:
|
||||
class MainScreen:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
@@ -0,0 +1,174 @@
|
||||
"""
|
||||
Queue Screen for PraisonAI TUI.
|
||||
|
||||
Queue management interface.
|
||||
"""
|
||||
|
||||
from typing import Optional, List
|
||||
|
||||
try:
|
||||
from textual.screen import Screen
|
||||
from textual.containers import Vertical, Horizontal
|
||||
from textual.widgets import Static, Footer, DataTable, Button
|
||||
from textual.binding import Binding
|
||||
from textual.message import Message
|
||||
from rich.text import Text
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
Screen = object
|
||||
Message = object
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
class QueueScreen(Screen):
|
||||
"""
|
||||
Queue management screen.
|
||||
|
||||
Displays full queue with management options.
|
||||
"""
|
||||
|
||||
BINDINGS = [
|
||||
Binding("escape", "back", "Back", show=True),
|
||||
Binding("c", "cancel", "Cancel", show=True),
|
||||
Binding("r", "retry", "Retry", show=True),
|
||||
Binding("x", "clear", "Clear Queue", show=True),
|
||||
Binding("enter", "select", "Select", show=False),
|
||||
]
|
||||
|
||||
DEFAULT_CSS = """
|
||||
QueueScreen {
|
||||
background: $surface;
|
||||
}
|
||||
|
||||
QueueScreen #queue-header {
|
||||
height: 3;
|
||||
background: $primary;
|
||||
padding: 1;
|
||||
}
|
||||
|
||||
QueueScreen DataTable {
|
||||
height: 1fr;
|
||||
}
|
||||
|
||||
QueueScreen #queue-actions {
|
||||
height: 3;
|
||||
padding: 1;
|
||||
}
|
||||
"""
|
||||
|
||||
class RunCancelled(Message):
|
||||
def __init__(self, run_id: str):
|
||||
self.run_id = run_id
|
||||
super().__init__()
|
||||
|
||||
class RunRetried(Message):
|
||||
def __init__(self, run_id: str):
|
||||
self.run_id = run_id
|
||||
super().__init__()
|
||||
|
||||
class QueueCleared(Message):
|
||||
pass
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name: Optional[str] = None,
|
||||
id: Optional[str] = None,
|
||||
classes: Optional[str] = None,
|
||||
):
|
||||
super().__init__(name=name, id=id, classes=classes)
|
||||
self._selected_run_id: Optional[str] = None
|
||||
|
||||
def compose(self):
|
||||
"""Compose the screen."""
|
||||
yield Static("Queue Management", id="queue-header")
|
||||
yield DataTable(id="queue-table")
|
||||
with Horizontal(id="queue-actions"):
|
||||
yield Button("Cancel [C]", id="btn-cancel", variant="error")
|
||||
yield Button("Retry [R]", id="btn-retry", variant="warning")
|
||||
yield Button("Clear [X]", id="btn-clear", variant="default")
|
||||
yield Button("Back [Esc]", id="btn-back", variant="primary")
|
||||
yield Footer()
|
||||
|
||||
def on_mount(self) -> None:
|
||||
"""Handle mount."""
|
||||
table = self.query_one("#queue-table", DataTable)
|
||||
table.add_columns(
|
||||
"ID", "Agent", "Input", "State", "Priority",
|
||||
"Wait Time", "Duration"
|
||||
)
|
||||
table.cursor_type = "row"
|
||||
|
||||
def update_runs(self, runs: List[dict]) -> None:
|
||||
"""Update the runs display."""
|
||||
table = self.query_one("#queue-table", DataTable)
|
||||
table.clear()
|
||||
|
||||
for run in runs:
|
||||
state = run.get("state", "unknown")
|
||||
state_style = {
|
||||
"queued": "yellow",
|
||||
"running": "green",
|
||||
"succeeded": "cyan",
|
||||
"failed": "red",
|
||||
"cancelled": "dim",
|
||||
}.get(state, "")
|
||||
|
||||
state_text = Text(state, style=state_style)
|
||||
|
||||
input_preview = run.get("input", "")[:40]
|
||||
if len(run.get("input", "")) > 40:
|
||||
input_preview += "..."
|
||||
|
||||
table.add_row(
|
||||
run.get("run_id", "")[:8],
|
||||
run.get("agent_name", ""),
|
||||
input_preview,
|
||||
state_text,
|
||||
run.get("priority", "normal"),
|
||||
run.get("wait_time", "-"),
|
||||
run.get("duration", "-"),
|
||||
key=run.get("run_id"),
|
||||
)
|
||||
|
||||
def on_data_table_row_selected(self, event: DataTable.RowSelected) -> None:
|
||||
"""Handle row selection."""
|
||||
if event.row_key:
|
||||
self._selected_run_id = str(event.row_key.value)
|
||||
|
||||
def on_button_pressed(self, event: Button.Pressed) -> None:
|
||||
"""Handle button press."""
|
||||
if event.button.id == "btn-cancel":
|
||||
self.action_cancel()
|
||||
elif event.button.id == "btn-retry":
|
||||
self.action_retry()
|
||||
elif event.button.id == "btn-clear":
|
||||
self.action_clear()
|
||||
elif event.button.id == "btn-back":
|
||||
self.action_back()
|
||||
|
||||
def action_back(self) -> None:
|
||||
"""Go back to main screen."""
|
||||
self.app.pop_screen()
|
||||
|
||||
def action_cancel(self) -> None:
|
||||
"""Cancel selected run."""
|
||||
if self._selected_run_id:
|
||||
self.post_message(self.RunCancelled(self._selected_run_id))
|
||||
|
||||
def action_retry(self) -> None:
|
||||
"""Retry selected run."""
|
||||
if self._selected_run_id:
|
||||
self.post_message(self.RunRetried(self._selected_run_id))
|
||||
|
||||
def action_clear(self) -> None:
|
||||
"""Clear the queue."""
|
||||
self.post_message(self.QueueCleared())
|
||||
|
||||
else:
|
||||
class QueueScreen:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
@@ -0,0 +1,124 @@
|
||||
"""
|
||||
Session Screen for PraisonAI TUI.
|
||||
|
||||
Session browser and management.
|
||||
"""
|
||||
|
||||
from typing import Optional, List
|
||||
|
||||
try:
|
||||
from textual.screen import Screen
|
||||
from textual.containers import Vertical
|
||||
from textual.widgets import Static, Footer, DataTable, Button
|
||||
from textual.binding import Binding
|
||||
from textual.message import Message
|
||||
from rich.text import Text
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
Screen = object
|
||||
Message = object
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
class SessionScreen(Screen):
|
||||
"""
|
||||
Session browser screen.
|
||||
|
||||
Displays recent sessions and allows resuming.
|
||||
"""
|
||||
|
||||
BINDINGS = [
|
||||
Binding("escape", "back", "Back", show=True),
|
||||
Binding("enter", "resume", "Resume", show=True),
|
||||
Binding("d", "delete", "Delete", show=True),
|
||||
]
|
||||
|
||||
DEFAULT_CSS = """
|
||||
SessionScreen {
|
||||
background: $surface;
|
||||
}
|
||||
|
||||
SessionScreen #session-header {
|
||||
height: 3;
|
||||
background: $primary;
|
||||
padding: 1;
|
||||
}
|
||||
|
||||
SessionScreen DataTable {
|
||||
height: 1fr;
|
||||
}
|
||||
"""
|
||||
|
||||
class SessionSelected(Message):
|
||||
def __init__(self, session_id: str):
|
||||
self.session_id = session_id
|
||||
super().__init__()
|
||||
|
||||
class SessionDeleted(Message):
|
||||
def __init__(self, session_id: str):
|
||||
self.session_id = session_id
|
||||
super().__init__()
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name: Optional[str] = None,
|
||||
id: Optional[str] = None,
|
||||
classes: Optional[str] = None,
|
||||
):
|
||||
super().__init__(name=name, id=id, classes=classes)
|
||||
self._selected_session_id: Optional[str] = None
|
||||
|
||||
def compose(self):
|
||||
"""Compose the screen."""
|
||||
yield Static("Sessions", id="session-header")
|
||||
yield DataTable(id="session-table")
|
||||
yield Footer()
|
||||
|
||||
def on_mount(self) -> None:
|
||||
"""Handle mount."""
|
||||
table = self.query_one("#session-table", DataTable)
|
||||
table.add_columns("ID", "Created", "Updated", "Runs")
|
||||
table.cursor_type = "row"
|
||||
|
||||
def update_sessions(self, sessions: List[dict]) -> None:
|
||||
"""Update the sessions display."""
|
||||
table = self.query_one("#session-table", DataTable)
|
||||
table.clear()
|
||||
|
||||
for session in sessions:
|
||||
table.add_row(
|
||||
session.get("session_id", "")[:8],
|
||||
session.get("created_at", "-"),
|
||||
session.get("updated_at", "-"),
|
||||
str(session.get("run_count", 0)),
|
||||
key=session.get("session_id"),
|
||||
)
|
||||
|
||||
def on_data_table_row_selected(self, event: DataTable.RowSelected) -> None:
|
||||
"""Handle row selection."""
|
||||
if event.row_key:
|
||||
self._selected_session_id = str(event.row_key.value)
|
||||
|
||||
def action_back(self) -> None:
|
||||
"""Go back."""
|
||||
self.app.pop_screen()
|
||||
|
||||
def action_resume(self) -> None:
|
||||
"""Resume selected session."""
|
||||
if self._selected_session_id:
|
||||
self.post_message(self.SessionSelected(self._selected_session_id))
|
||||
self.app.pop_screen()
|
||||
|
||||
def action_delete(self) -> None:
|
||||
"""Delete selected session."""
|
||||
if self._selected_session_id:
|
||||
self.post_message(self.SessionDeleted(self._selected_session_id))
|
||||
|
||||
else:
|
||||
class SessionScreen:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
@@ -0,0 +1,148 @@
|
||||
"""
|
||||
Settings Screen for PraisonAI TUI.
|
||||
|
||||
Configuration interface.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
|
||||
try:
|
||||
from textual.screen import Screen
|
||||
from textual.containers import Vertical
|
||||
from textual.widgets import Static, Footer, Input, Select, Switch, Button
|
||||
from textual.binding import Binding
|
||||
from textual.message import Message
|
||||
TEXTUAL_AVAILABLE = True
|
||||
except ImportError:
|
||||
TEXTUAL_AVAILABLE = False
|
||||
Screen = object
|
||||
Message = object
|
||||
|
||||
|
||||
if TEXTUAL_AVAILABLE:
|
||||
class SettingsScreen(Screen):
|
||||
"""
|
||||
Settings screen.
|
||||
|
||||
Allows configuration of:
|
||||
- Model selection
|
||||
- Queue settings
|
||||
- Display preferences
|
||||
"""
|
||||
|
||||
BINDINGS = [
|
||||
Binding("escape", "back", "Back", show=True),
|
||||
Binding("s", "save", "Save", show=True),
|
||||
]
|
||||
|
||||
DEFAULT_CSS = """
|
||||
SettingsScreen {
|
||||
background: $surface;
|
||||
}
|
||||
|
||||
SettingsScreen #settings-header {
|
||||
height: 3;
|
||||
background: $primary;
|
||||
padding: 1;
|
||||
}
|
||||
|
||||
SettingsScreen .setting-row {
|
||||
height: 3;
|
||||
padding: 0 1;
|
||||
}
|
||||
|
||||
SettingsScreen .setting-label {
|
||||
width: 20;
|
||||
}
|
||||
|
||||
SettingsScreen Input {
|
||||
width: 40;
|
||||
}
|
||||
"""
|
||||
|
||||
class SettingsSaved(Message):
|
||||
def __init__(self, settings: dict):
|
||||
self.settings = settings
|
||||
super().__init__()
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
current_settings: Optional[dict] = None,
|
||||
name: Optional[str] = None,
|
||||
id: Optional[str] = None,
|
||||
classes: Optional[str] = None,
|
||||
):
|
||||
super().__init__(name=name, id=id, classes=classes)
|
||||
self._settings = current_settings or {}
|
||||
|
||||
def compose(self):
|
||||
"""Compose the screen."""
|
||||
yield Static("Settings", id="settings-header")
|
||||
|
||||
with Vertical(id="settings-form"):
|
||||
# Model setting
|
||||
yield Static("Model:", classes="setting-label")
|
||||
yield Input(
|
||||
value=self._settings.get("model", "gpt-4o-mini"),
|
||||
id="setting-model",
|
||||
placeholder="Model name"
|
||||
)
|
||||
|
||||
# Max concurrent runs
|
||||
yield Static("Max Concurrent:", classes="setting-label")
|
||||
yield Input(
|
||||
value=str(self._settings.get("max_concurrent", 4)),
|
||||
id="setting-max-concurrent",
|
||||
placeholder="4"
|
||||
)
|
||||
|
||||
# Auto-save interval
|
||||
yield Static("Autosave (sec):", classes="setting-label")
|
||||
yield Input(
|
||||
value=str(self._settings.get("autosave_interval", 30)),
|
||||
id="setting-autosave",
|
||||
placeholder="30"
|
||||
)
|
||||
|
||||
# Buttons
|
||||
yield Button("Save", id="btn-save", variant="primary")
|
||||
yield Button("Cancel", id="btn-cancel", variant="default")
|
||||
|
||||
yield Footer()
|
||||
|
||||
def on_button_pressed(self, event: Button.Pressed) -> None:
|
||||
"""Handle button press."""
|
||||
if event.button.id == "btn-save":
|
||||
self.action_save()
|
||||
elif event.button.id == "btn-cancel":
|
||||
self.action_back()
|
||||
|
||||
def action_back(self) -> None:
|
||||
"""Go back."""
|
||||
self.app.pop_screen()
|
||||
|
||||
def action_save(self) -> None:
|
||||
"""Save settings."""
|
||||
try:
|
||||
model_input = self.query_one("#setting-model", Input)
|
||||
max_concurrent_input = self.query_one("#setting-max-concurrent", Input)
|
||||
autosave_input = self.query_one("#setting-autosave", Input)
|
||||
|
||||
settings = {
|
||||
"model": model_input.value,
|
||||
"max_concurrent": int(max_concurrent_input.value or "4"),
|
||||
"autosave_interval": int(autosave_input.value or "30"),
|
||||
}
|
||||
|
||||
self.post_message(self.SettingsSaved(settings))
|
||||
self.app.pop_screen()
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
else:
|
||||
class SettingsScreen:
|
||||
"""Placeholder when Textual is not available."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
raise ImportError(
|
||||
"Textual is required for TUI. Install with: pip install praisonai[tui]"
|
||||
)
|
||||
@@ -0,0 +1,181 @@
|
||||
"""
|
||||
Session Store for PraisonAI TUI.
|
||||
|
||||
Maintains chat history in memory for session persistence.
|
||||
This allows the AI to remember previous messages within a session.
|
||||
"""
|
||||
|
||||
import logging
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Dict, List, Optional
|
||||
from datetime import datetime
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ChatMessage:
|
||||
"""A single chat message."""
|
||||
role: str # "user" or "assistant"
|
||||
content: str
|
||||
timestamp: datetime = field(default_factory=datetime.now)
|
||||
run_id: Optional[str] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class Session:
|
||||
"""A chat session with history."""
|
||||
session_id: str
|
||||
messages: List[ChatMessage] = field(default_factory=list)
|
||||
created_at: datetime = field(default_factory=datetime.now)
|
||||
updated_at: datetime = field(default_factory=datetime.now)
|
||||
|
||||
def add_message(self, role: str, content: str, run_id: Optional[str] = None) -> None:
|
||||
"""Add a message to the session."""
|
||||
self.messages.append(ChatMessage(
|
||||
role=role,
|
||||
content=content,
|
||||
run_id=run_id,
|
||||
))
|
||||
self.updated_at = datetime.now()
|
||||
|
||||
def get_history_for_llm(self, max_messages: int = 50) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Get chat history in LLM-compatible format.
|
||||
|
||||
Returns list of {"role": "user/assistant", "content": "..."} dicts.
|
||||
"""
|
||||
# Get last N messages
|
||||
recent = self.messages[-max_messages:] if len(self.messages) > max_messages else self.messages
|
||||
return [{"role": msg.role, "content": msg.content} for msg in recent]
|
||||
|
||||
@property
|
||||
def run_count(self) -> int:
|
||||
"""Number of user messages (runs) in this session."""
|
||||
return sum(1 for msg in self.messages if msg.role == "user")
|
||||
|
||||
|
||||
class SessionStore:
|
||||
"""
|
||||
In-memory session store for TUI.
|
||||
|
||||
Maintains chat history across agent runs within a session.
|
||||
"""
|
||||
|
||||
def __init__(self, max_sessions: int = 100, max_messages_per_session: int = 1000):
|
||||
"""
|
||||
Initialize session store.
|
||||
|
||||
Args:
|
||||
max_sessions: Maximum number of sessions to keep in memory.
|
||||
max_messages_per_session: Maximum messages per session.
|
||||
"""
|
||||
self._sessions: Dict[str, Session] = {}
|
||||
self._max_sessions = max_sessions
|
||||
self._max_messages = max_messages_per_session
|
||||
|
||||
def get_or_create_session(self, session_id: str) -> Session:
|
||||
"""Get existing session or create new one."""
|
||||
if session_id not in self._sessions:
|
||||
self._sessions[session_id] = Session(session_id=session_id)
|
||||
self._cleanup_old_sessions()
|
||||
logger.debug(f"Created new session: {session_id}")
|
||||
return self._sessions[session_id]
|
||||
|
||||
def add_user_message(self, session_id: str, content: str, run_id: Optional[str] = None) -> None:
|
||||
"""Add a user message to the session."""
|
||||
session = self.get_or_create_session(session_id)
|
||||
session.add_message("user", content, run_id)
|
||||
self._trim_session(session)
|
||||
logger.debug(f"Added user message to session {session_id}: {content[:50]}...")
|
||||
|
||||
def add_assistant_message(self, session_id: str, content: str, run_id: Optional[str] = None) -> None:
|
||||
"""Add an assistant message to the session."""
|
||||
session = self.get_or_create_session(session_id)
|
||||
session.add_message("assistant", content, run_id)
|
||||
self._trim_session(session)
|
||||
logger.debug(f"Added assistant message to session {session_id}: {content[:50]}...")
|
||||
|
||||
def get_chat_history(self, session_id: str, max_messages: int = 50) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Get chat history for a session in LLM-compatible format.
|
||||
|
||||
Args:
|
||||
session_id: The session ID.
|
||||
max_messages: Maximum number of messages to return.
|
||||
|
||||
Returns:
|
||||
List of {"role": "user/assistant", "content": "..."} dicts.
|
||||
"""
|
||||
if session_id not in self._sessions:
|
||||
return []
|
||||
return self._sessions[session_id].get_history_for_llm(max_messages)
|
||||
|
||||
def get_session(self, session_id: str) -> Optional[Session]:
|
||||
"""Get a session by ID."""
|
||||
return self._sessions.get(session_id)
|
||||
|
||||
def list_sessions(self, limit: int = 50) -> List[Dict]:
|
||||
"""List all sessions with metadata."""
|
||||
sessions = sorted(
|
||||
self._sessions.values(),
|
||||
key=lambda s: s.updated_at,
|
||||
reverse=True
|
||||
)[:limit]
|
||||
|
||||
return [
|
||||
{
|
||||
"session_id": s.session_id,
|
||||
"created_at": s.created_at.strftime("%Y-%m-%d %H:%M"),
|
||||
"updated_at": s.updated_at.strftime("%Y-%m-%d %H:%M"),
|
||||
"run_count": s.run_count,
|
||||
}
|
||||
for s in sessions
|
||||
]
|
||||
|
||||
def delete_session(self, session_id: str) -> bool:
|
||||
"""Delete a session."""
|
||||
if session_id in self._sessions:
|
||||
del self._sessions[session_id]
|
||||
logger.debug(f"Deleted session: {session_id}")
|
||||
return True
|
||||
return False
|
||||
|
||||
def clear_session(self, session_id: str) -> None:
|
||||
"""Clear all messages from a session."""
|
||||
if session_id in self._sessions:
|
||||
self._sessions[session_id].messages.clear()
|
||||
self._sessions[session_id].updated_at = datetime.now()
|
||||
logger.debug(f"Cleared session: {session_id}")
|
||||
|
||||
def _trim_session(self, session: Session) -> None:
|
||||
"""Trim session to max messages."""
|
||||
if len(session.messages) > self._max_messages:
|
||||
# Keep the most recent messages
|
||||
session.messages = session.messages[-self._max_messages:]
|
||||
|
||||
def _cleanup_old_sessions(self) -> None:
|
||||
"""Remove oldest sessions if over limit."""
|
||||
if len(self._sessions) > self._max_sessions:
|
||||
# Sort by updated_at and remove oldest
|
||||
sorted_sessions = sorted(
|
||||
self._sessions.items(),
|
||||
key=lambda x: x[1].updated_at
|
||||
)
|
||||
# Remove oldest sessions
|
||||
to_remove = len(self._sessions) - self._max_sessions
|
||||
for session_id, _ in sorted_sessions[:to_remove]:
|
||||
del self._sessions[session_id]
|
||||
logger.debug(f"Removed old session: {session_id}")
|
||||
|
||||
|
||||
# Global session store instance for TUI
|
||||
_session_store: Optional[SessionStore] = None
|
||||
|
||||
|
||||
def get_session_store() -> SessionStore:
|
||||
"""Get the global session store instance."""
|
||||
global _session_store
|
||||
if _session_store is None:
|
||||
_session_store = SessionStore()
|
||||
return _session_store
|
||||
Loaded 100 of 144 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user