Compare commits

..
Author SHA1 Message Date
MervinPraison fe87b9514e feat: add deep profiling benchmarks for Agent initialization
- deep_profile.py: cProfile analysis for 5000 agent creations
- deep_profile_bench.py: Combined timing and profiling for 1000 agents
- Helps identify performance bottlenecks in Agent.__init__
2026-04-02 19:49:16 +01:00
MervinPraison fec0b5fa32 feat: add @lru_cache to get_defaults_config for performance
- Cache defaults config to avoid repeated file I/O
- Add performance test files for benchmarking
- Further optimizes Agent initialization performance
2026-04-02 19:17:03 +01:00
MervinPraison c8a3881dda feat: JIT hydration optimization for Agent initialization
- Store raw params in __init__ for lazy config resolution
- Update OUTPUT, EXECUTION, CACHING, MEMORY, KNOWLEDGE, PLANNING, REFLECTION, WEB to use raw params
- Reduce eager config resolution overhead
- Benchmark shows 30µs initialization (down from previous baseline)
- Add smoke test for JIT hydration
- Phase 1 of incremental optimization plan

Fixes #performance
2026-04-02 18:51:31 +01:00
141 changed files with 1907 additions and 11015 deletions

No files matched your search

+14 -37
View File
@@ -207,44 +207,21 @@ runs:
User Request:
$USER_REQUEST
Please analyze the request and provide helpful assistance.
Please analyze the request and provide helpful assistance. You have access to repository tools and can help with:
- Code analysis and implementation
- GitHub workflows and automation
- Pull request reviews and feedback
- Issue resolution and bug fixes
- Documentation updates
- Testing and deployment
CRITICAL INSTRUCTION: If your task involves modifying codebase files to add a feature or fix a bug:
STEP 0 — SETUP GIT IDENTITY:
git config user.name "MervinPraison"
git config user.email "[email protected]"
STEP 1 — READ GUIDELINES:
MANDATORY: Before writing any code, you MUST carefully read "src/praisonai-agents/AGENTS.md" to understand this repository's extremely specific Architecture, Protocol-First design rules, and Agent-Centric Philosophy.
STEP 2 — ARCHITECTURE VALIDATION & ROUTING (MANDATORY before writing code):
Before implementing anything, answer these questions:
- CORE vs WRAPPER vs TOOLS ROUTING:
1. Core SDK (praisonaiagents/): Only core protocols, base classes, decorators. No heavy implementations.
2. Wrapper (praisonai/): CLI, heavy implementations, optional dependencies.
3. Tools (PraisonAI-Tools): Specific integrations, external tools (e.g. SurrealDB, Slack), and community extensions MUST go to the `MervinPraison/PraisonAI-Tools` repository. If the feature is a tool, clone `https://github.com/MervinPraison/PraisonAI-Tools`, implement it there, and create the PR using `gh pr create -R MervinPraison/PraisonAI-Tools`.
- Does it duplicate existing functionality? Check if Agent already supports this via existing params (reflection, planning, tools, hooks, memory).
- Does it inherit from Agent properly? New agent types MUST inherit Agent, not wrap it with composition.
- Does it add new dependencies? Only optional deps allowed, must be lazy-imported.
- Will agent.py grow larger? If the change adds >50 lines to agent.py, find a way to extract instead.
- Is there a name collision with existing exports in __init__.py?
If ANY of these conceptual checks fail (excluding routing), add a comment to the issue explaining why and close it. Do NOT create a PR.
STEP 3 — IMPLEMENT:
- Create a new git branch appropriately named (e.g. \`feature/issue-<number>\`)
- Follow protocol-driven design: protocols in core SDK, heavy implementations in wrapper
- Keep changes small and backward-compatible
STEP 4 — TEST:
- Run: cd src/praisonai-agents && PYTHONPATH=. python -m pytest tests/ -x -q --timeout=30
- Ensure no regressions
STEP 5 — CREATE PR:
- Commit with descriptive message, push the branch
- Use the GitHub CLI (\`gh pr create --title "..." --body "Fixes #<number>"\`) to open a Pull Request
CRITICAL: You MUST create the PR automatically using \`gh pr create\`. Do NOT just provide a link.
1. ALWAYS create a new git branch appropriately named (e.g. \`feature/issue-<number>\`).
2. MANDATORY: Before writing any code, you MUST carefully read "src/praisonai-agents/AGENTS.md" to understand this repository's extremely specific Architecture, Protocol-First design rules, and Agent-Centric Philosophy.
3. Make your necessary code changes honoring the rules in AGENTS.md.
4. Commit your changes and push the branch to the remote repository.
5. Use the GitHub CLI (\`gh pr create --title "..." --body "Fixes #<number>"\`) to open a Pull Request containing your work.
Respond naturally and helpfully to the user's request using the available tools.
EOF
+6 -309
View File
@@ -1,14 +1,11 @@
name: Auto PR Comment
# Review chain: CodeRabbit/Qodo/Gemini review first → Copilot → Claude (final)
# For human PRs: CodeRabbit/Qodo auto-review → this workflow triggers Copilot → then Claude
# Review chain: CodeRabbit/Qodo/Gemini review first → THEN trigger Copilot
# For human PRs: CodeRabbit/Qodo auto-review → this workflow triggers Copilot
# For bot PRs: CodeRabbit/Qodo skip bots, so we trigger them explicitly first
#
# IMPORTANT: @copilot ignores bot comments. All @copilot mentions must use
# PAT_TOKEN so the comment posts as MervinPraison (a real user).
#
# Claude trigger runs IN-BAND (same workflow) to avoid GitHub Actions
# blocking bot-triggered workflows with action_required approval gates.
on:
issue_comment:
types: [created]
@@ -17,11 +14,6 @@ on:
pull_request:
types: [opened]
env:
MAX_POLL_ATTEMPTS: 20
POLL_DELAY_MS: 30000
CLAUDE_TRIGGER_LOGINS: '["MervinPraison","github-actions[bot]"]'
jobs:
# ================================================================
# HUMAN PRs: Trigger @copilot AFTER CodeRabbit posts its summary
@@ -35,12 +27,8 @@ jobs:
runs-on: ubuntu-latest
permissions:
pull-requests: write
outputs:
pr_number: ${{ steps.trigger.outputs.pr_number }}
triggered: ${{ steps.trigger.outputs.triggered }}
steps:
- name: Post Copilot review request (as user via PAT)
id: trigger
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
@@ -57,18 +45,14 @@ jobs:
);
if (alreadyPosted) {
console.log('Copilot already triggered, skipping');
core.setOutput('triggered', 'false');
core.setOutput('pr_number', context.issue.number.toString());
return;
}
await github.rest.issues.createComment({
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@copilot Do a thorough review of this PR. Read ALL existing reviewer comments above from Qodo, Coderabbit, and Gemini first — incorporate their findings.\n\nReview areas:\n1. **Bloat check**: Are changes minimal and focused? Any unnecessary code or scope creep?\n2. **Security**: Any hardcoded secrets, unsafe eval/exec, missing input validation?\n3. **Performance**: Any module-level heavy imports? Hot-path regressions?\n4. **Tests**: Are tests included? Do they cover the changes adequately?\n5. **Backward compat**: Any public API changes without deprecation?\n6. **Code quality**: DRY violations, naming conventions, error handling?\n7. **Address reviewer feedback**: If Qodo, Coderabbit, or Gemini flagged valid issues, include them in your review\n8. Suggest specific improvements with code examples where possible'
});
core.setOutput('triggered', 'true');
core.setOutput('pr_number', context.issue.number.toString());
})
# Fallback: Trigger @copilot after Qodo review (if Coderabbit doesn't fire)
copilot-after-qodo:
@@ -78,12 +62,8 @@ jobs:
runs-on: ubuntu-latest
permissions:
pull-requests: write
outputs:
pr_number: ${{ steps.trigger.outputs.pr_number }}
triggered: ${{ steps.trigger.outputs.triggered }}
steps:
- name: Post Copilot review request (as user via PAT)
id: trigger
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
@@ -99,297 +79,14 @@ jobs:
);
if (alreadyPosted) {
console.log('Copilot already triggered, skipping');
core.setOutput('triggered', 'false');
core.setOutput('pr_number', context.issue.number.toString());
return;
}
await github.rest.issues.createComment({
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@copilot Do a thorough review of this PR. Read ALL existing reviewer comments above first.\n\nReview areas:\n1. **Bloat check**: Are changes minimal and focused?\n2. **Security**: Any hardcoded secrets, unsafe eval/exec, missing input validation?\n3. **Performance**: Any module-level heavy imports? Hot-path regressions?\n4. **Tests**: Are tests included? Do they cover the changes adequately?\n5. **Backward compat**: Any public API changes without deprecation?\n6. **Code quality**: DRY violations, naming conventions, error handling?\n7. Suggest specific improvements with code examples where possible'
});
core.setOutput('triggered', 'true');
core.setOutput('pr_number', context.issue.number.toString());
# ================================================================
# Claude FINAL review — polls for Copilot's response, then triggers
# This runs IN-BAND under the PAT context (MervinPraison), avoiding
# the action_required approval gate that blocks bot-triggered workflows.
# ================================================================
claude-after-copilot:
needs: [copilot-after-coderabbit]
if: |
always() &&
needs.copilot-after-coderabbit.result == 'success' &&
needs.copilot-after-coderabbit.outputs.triggered == 'true'
runs-on: ubuntu-latest
timeout-minutes: 15
permissions:
issues: write
pull-requests: write
steps:
- name: Wait for Copilot to respond (poll)
id: poll
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-coderabbit.outputs.pr_number }}
MAX_POLL_ATTEMPTS: ${{ env.MAX_POLL_ATTEMPTS }}
POLL_DELAY_MS: ${{ env.POLL_DELAY_MS }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
const owner = context.repo.owner;
const repo = context.repo.repo;
// Poll for Copilot's response — check every 30s for up to 10 minutes
const maxAttempts = parseInt(process.env.MAX_POLL_ATTEMPTS, 10);
const delayMs = parseInt(process.env.POLL_DELAY_MS, 10);
for (let i = 0; i < maxAttempts; i++) {
console.log(`Poll attempt ${i + 1}/${maxAttempts}...`);
const comments = await github.rest.issues.listComments({
issue_number: pr,
owner,
repo,
per_page: 50,
sort: 'created',
direction: 'desc'
});
// Look for Copilot's response (copilot-swe-agent or Copilot)
const copilotResponse = comments.data.find(c =>
(c.user.login === 'copilot-swe-agent' ||
c.user.login === 'Copilot' ||
c.user.login.toLowerCase().includes('copilot')) &&
c.user.type === 'Bot'
);
if (copilotResponse) {
console.log(`Copilot responded at ${copilotResponse.created_at}`);
core.setOutput('copilot_responded', 'true');
return;
}
// Also check PR reviews for Copilot
const reviews = await github.rest.pulls.listReviews({
pull_number: pr,
owner,
repo
});
const copilotReview = reviews.data.find(r =>
r.user.login.toLowerCase().includes('copilot')
);
if (copilotReview) {
console.log(`Copilot review submitted at ${copilotReview.submitted_at}`);
core.setOutput('copilot_responded', 'true');
return;
}
if (i < maxAttempts - 1) {
console.log(`Copilot hasn't responded yet, waiting ${delayMs/1000}s...`);
await new Promise(resolve => setTimeout(resolve, delayMs));
}
}
console.log('Copilot did not respond within timeout, triggering Claude anyway');
core.setOutput('copilot_responded', 'timeout');
- name: Check if Claude already triggered
id: check_claude
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-coderabbit.outputs.pr_number }}
TRIGGER_LOGINS: ${{ env.CLAUDE_TRIGGER_LOGINS }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
const triggerLogins = JSON.parse(process.env.TRIGGER_LOGINS);
const comments = await github.rest.issues.listComments({
issue_number: pr,
owner: context.repo.owner,
repo: context.repo.repo
});
const alreadyPosted = comments.data.some(c =>
c.body.includes('@claude') && triggerLogins.includes(c.user.login)
);
core.setOutput('already_triggered', alreadyPosted ? 'true' : 'false');
- name: Trigger Claude final review
if: steps.check_claude.outputs.already_triggered != 'true'
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-coderabbit.outputs.pr_number }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
await github.rest.issues.createComment({
issue_number: pr,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the FINAL architecture reviewer. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding.\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
});
console.log(`Claude triggered on PR #${pr}`);
# ================================================================
# Claude after Qodo fallback path (same polling approach)
# ================================================================
claude-after-copilot-qodo:
needs: [copilot-after-qodo]
if: |
always() &&
needs.copilot-after-qodo.result == 'success' &&
needs.copilot-after-qodo.outputs.triggered == 'true'
runs-on: ubuntu-latest
timeout-minutes: 15
permissions:
issues: write
pull-requests: write
steps:
- name: Wait for Copilot to respond (poll)
id: poll
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-qodo.outputs.pr_number }}
MAX_POLL_ATTEMPTS: ${{ env.MAX_POLL_ATTEMPTS }}
POLL_DELAY_MS: ${{ env.POLL_DELAY_MS }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
const owner = context.repo.owner;
const repo = context.repo.repo;
const maxAttempts = parseInt(process.env.MAX_POLL_ATTEMPTS, 10);
const delayMs = parseInt(process.env.POLL_DELAY_MS, 10);
for (let i = 0; i < maxAttempts; i++) {
console.log(`Poll attempt ${i + 1}/${maxAttempts}...`);
const comments = await github.rest.issues.listComments({
issue_number: pr, owner, repo,
per_page: 50, sort: 'created', direction: 'desc'
});
const copilotResponse = comments.data.find(c =>
(c.user.login === 'copilot-swe-agent' ||
c.user.login === 'Copilot' ||
c.user.login.toLowerCase().includes('copilot')) &&
c.user.type === 'Bot'
);
if (copilotResponse) {
console.log(`Copilot responded at ${copilotResponse.created_at}`);
core.setOutput('copilot_responded', 'true');
return;
}
const reviews = await github.rest.pulls.listReviews({
pull_number: pr, owner, repo
});
const copilotReview = reviews.data.find(r =>
r.user.login.toLowerCase().includes('copilot')
);
if (copilotReview) {
console.log(`Copilot review submitted at ${copilotReview.submitted_at}`);
core.setOutput('copilot_responded', 'true');
return;
}
if (i < maxAttempts - 1) {
await new Promise(resolve => setTimeout(resolve, delayMs));
}
}
console.log('Copilot did not respond within timeout, triggering Claude anyway');
core.setOutput('copilot_responded', 'timeout');
- name: Check if Claude already triggered
id: check_claude
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-qodo.outputs.pr_number }}
TRIGGER_LOGINS: ${{ env.CLAUDE_TRIGGER_LOGINS }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
const triggerLogins = JSON.parse(process.env.TRIGGER_LOGINS);
const comments = await github.rest.issues.listComments({
issue_number: pr,
owner: context.repo.owner,
repo: context.repo.repo
});
const alreadyPosted = comments.data.some(c =>
c.body.includes('@claude') && triggerLogins.includes(c.user.login)
);
core.setOutput('already_triggered', alreadyPosted ? 'true' : 'false');
- name: Trigger Claude final review
if: steps.check_claude.outputs.already_triggered != 'true'
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ needs.copilot-after-qodo.outputs.pr_number }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = parseInt(process.env.PR_NUMBER, 10);
await github.rest.issues.createComment({
issue_number: pr,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the FINAL architecture reviewer. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding.\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
});
console.log(`Claude triggered on PR #${pr}`);
# ================================================================
# Claude after Gemini — restores the trigger lost from the deleted
# chain-claude-after-copilot.yml workflow.
# Fires when Gemini posts a review comment on a PR or issue.
# ================================================================
claude-after-gemini:
if: |
github.event_name == 'issue_comment' &&
(
github.event.comment.user.login == 'gemini-code-assist[bot]' ||
contains(github.event.comment.body, 'Review completed by Gemini CLI') ||
contains(github.event.comment.body, 'The fix is ready for review. Please test')
)
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Check if Claude already triggered
id: check_claude
uses: actions/github-script@v7
env:
TRIGGER_LOGINS: ${{ env.CLAUDE_TRIGGER_LOGINS }}
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const triggerLogins = JSON.parse(process.env.TRIGGER_LOGINS);
const comments = await github.rest.issues.listComments({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo
});
const alreadyPosted = comments.data.some(c =>
c.body.includes('@claude') && triggerLogins.includes(c.user.login)
);
core.setOutput('already_triggered', alreadyPosted ? 'true' : 'false');
- name: Post Claude analysis request (Lead Engineer)
if: steps.check_claude.outputs.already_triggered != 'true'
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
await github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the Lead Engineer. Read ALL analysis and reviews above carefully (Gemini, CodeRabbit, Qodo, Copilot, etc).\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
});
})
# ================================================================
# BOT PRs: CodeRabbit/Qodo skip bot-authored PRs by default.
@@ -0,0 +1,58 @@
name: Chain Claude After Reviewers
# Event-driven: triggers when Copilot finishes reviewing a PR
on:
pull_request_review:
types: [submitted]
issue_comment:
types: [created]
jobs:
# Trigger Claude after Copilot finishes on a PR — Claude is the FINAL reviewer
# Claude reads ALL previous reviews (Qodo, Coderabbit, Copilot) and fixes any valid issues
claude-final-review:
if: |
(github.event_name == 'pull_request_review' && contains(github.event.review.user.login, 'copilot')) ||
(github.event_name == 'issue_comment' && contains(github.event.comment.user.login, 'copilot'))
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Post Claude final review + fix request
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the FINAL architecture reviewer. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding.\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
})
# Trigger Claude after Gemini finishes on an Issue or PR
claude-after-gemini:
if: |
github.event_name == 'issue_comment' &&
(
github.event.comment.user.login == 'gemini-code-assist[bot]' ||
contains(github.event.comment.body, 'Review completed by Gemini CLI') ||
contains(github.event.comment.body, 'The fix is ready for review. Please test')
)
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Post Claude analysis request (final reviewer)
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the Lead Engineer. Read ALL analysis and reviews above carefully (Gemini, CodeRabbit, Qodo, Copilot, etc).\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
})
+3 -6
View File
@@ -15,18 +15,15 @@ jobs:
issues: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- name: Generate GitHub App Token
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.CLAUDE_APP_ID }}
private-key: ${{ secrets.CLAUDE_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
token: ${{ steps.app-token.outputs.token }}
- name: Run Claude Issue Triage
uses: ./.github/actions/claude-issue-triage-action
+15 -180
View File
@@ -11,116 +11,10 @@ on:
types: [submitted]
jobs:
# ================================================================
# Job 1: Lightweight triage for ALL new issues (including external users)
# Posts welcome comment + adds triage labels. No Claude code execution.
# ================================================================
issue-triage:
if: |
github.event_name == 'issues' &&
github.event.action == 'opened' &&
!contains(toJSON(github.event.issue.labels), 'claude')
runs-on: ubuntu-latest
permissions:
issues: write
contents: read
steps:
- name: Generate GitHub App Token
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.CLAUDE_APP_ID }}
private-key: ${{ secrets.CLAUDE_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- name: Triage and acknowledge issue
uses: actions/github-script@v7
with:
github-token: ${{ steps.app-token.outputs.token }}
script: |
const issue = context.payload.issue;
const title = (issue.title || '').toLowerCase();
const body = (issue.body || '').toLowerCase();
const content = title + ' ' + body;
const isOwner = ['OWNER', 'MEMBER', 'COLLABORATOR'].includes(
issue.author_association
);
// --- Label triage ---
const labels = [];
// Kind labels
if (content.includes('feature request') || content.includes('[feature')) {
labels.push('enhancement');
} else if (content.includes('bug') || content.includes('error') || content.includes('crash') || content.includes('traceback')) {
labels.push('bug');
} else if (content.includes('question') || content.includes('how do i') || content.includes('how to')) {
labels.push('question');
}
// Area labels
if (content.includes('security') || content.includes('cve') || content.includes('vulnerability')) {
labels.push('security');
}
if (content.includes('performance') || content.includes('slow') || content.includes('memory leak')) {
labels.push('performance');
}
if (content.includes('documentation') || content.includes('docs')) {
labels.push('documentation');
}
if (content.includes('typescript') || content.includes('javascript') || content.includes('npm')) {
labels.push('javascript');
}
// Apply labels
if (labels.length > 0) {
await github.rest.issues.addLabels({
issue_number: issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels
});
}
// --- Acknowledgment comment (external users only) ---
if (!isOwner) {
await github.rest.issues.createComment({
issue_number: issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: [
`👋 Thanks for opening this issue, @${issue.user.login}!`,
'',
'A maintainer will review this shortly. In the meantime:',
'- Make sure you\'ve included steps to reproduce (for bugs)',
'- Check [existing issues](https://github.com/MervinPraison/PraisonAI/issues) for duplicates',
'- Review the [documentation](https://docs.praison.ai) for related guides',
'',
'_A maintainer can trigger deeper analysis by commenting `@claude` on this issue._'
].join('\n')
});
}
// --- For owner: add 'claude' label to trigger the code-fix job ---
if (isOwner) {
await github.rest.issues.addLabels({
issue_number: issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['claude']
});
}
# ================================================================
# Job 2: Full Claude code-fix (owner/collaborator only)
# Triggers on: labeled 'claude', @claude comments, assignments
# ================================================================
claude-response:
# Allow: human users, github-actions[bot] (auto-comments/labels)
# Block: dependabot, cursor, renovate, other bots
# Skip 'opened' events — triage job handles those above
if: |
github.event.action != 'opened' &&
(github.event.action != 'labeled' || github.event.label.name == 'claude') &&
(github.event_name != 'issue_comment' || contains(github.event.comment.body, '@claude')) &&
(
@@ -139,117 +33,58 @@ jobs:
actions: read
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Generate GitHub App Token
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.CLAUDE_APP_ID }}
private-key: ${{ secrets.CLAUDE_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- name: Check for Fork PR
id: check_fork
uses: actions/github-script@v7
with:
script: |
if (context.issue.pull_request) {
const pr = await github.rest.pulls.get({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number
});
if (pr.data.head.repo && pr.data.head.repo.full_name !== context.repo.full_name) {
core.setOutput('is_fork', 'true');
core.setOutput('clone_url', pr.data.head.repo.clone_url);
return;
}
}
core.setOutput('is_fork', 'false');
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ steps.app-token.outputs.token }}
- name: Setup Remote for Fork PR
if: steps.check_fork.outputs.is_fork == 'true'
run: |
git remote set-url origin ${{ steps.check_fork.outputs.clone_url }}
- uses: anthropics/claude-code-action@beta
env:
GH_TOKEN: ${{ steps.app-token.outputs.token }}
with:
allowed_bots: 'praisonai-triage-agent[bot]'
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
github_token: ${{ steps.app-token.outputs.token }}
trigger_phrase: "@claude"
label_trigger: "claude"
allowed_non_write_users: "*"
direct_prompt: |
${{ steps.check_fork.outputs.is_fork == 'true' && 'CRITICAL: THIS IS A PULL REQUEST FROM A FORK. YOU DO NOT HAVE PUSH PERMISSIONS TO THIS REPOSITORY. ONLY READ FILES, VALIDATE CODE, AND PROVIDE YOUR COMMENTS/FEEDBACK DIRECTLY IN THIS PR VIA COMMENTS. DO NOT ATTEMPT TO PUSH OR CREATE PULL REQUESTS.\n\n' || '' }}
You are working on the PraisonAI SDK. Follow AGENTS.md strictly.
STEP 0 — SETUP GIT IDENTITY & AUTH (GLOBAL — required for all repos):
git config --global user.name "MervinPraison"
git config --global user.email "[email protected]"
gh auth setup-git
STEP 0 — SETUP GIT IDENTITY:
git config user.name "MervinPraison"
git config user.email "[email protected]"
STEP 1 — READ GUIDELINES:
Read AGENTS.md to understand the architecture rules.
STEP 2 — ARCHITECTURE VALIDATION & ROUTING (MANDATORY before writing code):
STEP 2 — ARCHITECTURE VALIDATION (MANDATORY before writing code):
Before implementing anything, answer these questions:
- CORE vs WRAPPER vs TOOLS vs DOCS vs PLUGINS ROUTING:
1. Core SDK (praisonaiagents/): Only core protocols, base classes, decorators. No heavy implementations.
2. Wrapper (praisonai/): CLI, heavy implementations, optional dependencies.
3. Tools (PraisonAI-Tools): Capabilities Agents actively call during execution (e.g. SurrealDB tool, Slack tool).
4. Documentation (PraisonAIDocs): Documentation pages, guides, API references.
5. Plugins (PraisonAI-Plugins): Framework lifecycle extensions replacing systemic behavior (e.g. tracing, logging, metrics, hooks, guardrails).
For items routed to an EXTERNAL repository (Tools, Docs, Plugins), follow STEP 3-ALT below.
- Does this add heavy implementations to the core SDK (praisonaiagents)? If YES → move it to the wrapper (praisonai) or make it a plugin.
- Does it duplicate existing functionality? Check if Agent already supports this via existing params (reflection, planning, tools, hooks, memory).
- Does it inherit from Agent properly? New agent types MUST inherit Agent, not wrap it with composition.
- Does it add new dependencies? Only optional deps allowed, must be lazy-imported.
- Will agent.py grow larger? If the change adds >50 lines to agent.py, find a way to extract instead.
- Is there a name collision with existing exports in __init__.py?
If ANY of these conceptual checks fail (excluding routing), add a comment to the issue explaining why and close it. Do NOT create a PR.
If ANY of these checks fail, add a comment to the issue explaining why and close it. Do NOT create a PR.
STEP 3 — IMPLEMENT (for changes in THIS repo — PraisonAI):
STEP 3 — IMPLEMENT:
- Create a fix branch and implement a minimal, focused fix
- Follow protocol-driven design: protocols in core SDK, heavy implementations in wrapper
- Keep changes small and backward-compatible
STEP 3-ALT — IMPLEMENT IN EXTERNAL REPO (for PraisonAI-Tools, PraisonAIDocs, PraisonAI-Plugins):
When work must happen in a different repository, follow these steps EXACTLY. Do NOT attempt to use `cd`, as directory state is not preserved. Use `git -C` for all commands.
a) Clone the repository:
gh repo clone MervinPraison/<REPO_NAME> /tmp/<REPO_NAME>
b) Copy GitHub authentication from the main repository so push works seamlessly:
git -C /tmp/<REPO_NAME> config http."https://github.com/".extraheader "$(git config --get http."https://github.com/".extraheader)"
c) Create a feature branch (NEVER commit to main):
git -C /tmp/<REPO_NAME> checkout -b claude/issue-$ISSUE_NUMBER-$(date +%Y%m%d)
d) Make your changes using absolute paths (e.g. edit /tmp/<REPO_NAME>/docs.json)
e) Commit:
git -C /tmp/<REPO_NAME> add -A
git -C /tmp/<REPO_NAME> commit -m "feat: <description> (fixes #$ISSUE_NUMBER)"
f) Push the branch:
git -C /tmp/<REPO_NAME> push origin claude/issue-$ISSUE_NUMBER-$(date +%Y%m%d)
g) Create PR in the EXTERNAL repo:
gh pr create -R MervinPraison/<REPO_NAME> --head claude/issue-$ISSUE_NUMBER-$(date +%Y%m%d) --title "feat: <title>" --body "Fixes MervinPraison/PraisonAI#$ISSUE_NUMBER
<body>"
STEP 4 — TEST:
- For SDK changes: cd src/praisonai-agents && PYTHONPATH=. python -m pytest tests/ -x -q --timeout=30
- For docs changes: verify files exist and are valid markdown/MDX
- Run: cd src/praisonai-agents && PYTHONPATH=. python -m pytest tests/ -x -q --timeout=30
- Ensure no regressions
STEP 5 — CREATE PR:
- Commit with descriptive message, push, and create PR using `gh pr create`
- For external repos, use `gh pr create -R MervinPraison/<REPO_NAME>`
CRITICAL: You MUST create the PR automatically using `gh pr create`. Do NOT just provide a link or say "manual push required".
NOTE: If you worked on an external repo, the wrapper action will report "No commits" for the main repo at the end. This is expected, do not worry about it.
CRITICAL: You MUST create the PR automatically using `gh pr create`. Do NOT just provide a link.
allowed_tools: |
Bash(git:*)
Bash(python:*)
+96 -60
View File
@@ -23,13 +23,14 @@
</div>
PraisonAI 🦞 — **Hire a 24/7 AI Workforce.** Stop writing boilerplate and start shipping autonomous agents that research, plan, and execute tasks across your apps. From one agent to an entire organization, deployed in 5 lines of code.
PraisonAI 🦞 — Automate and solve complex challenges with AI agent teams that plan, research, code, and deliver results to Telegram, Discord, and WhatsApp — running 24/7. A low-code, production-ready multi-agent framework with handoffs, guardrails, memory, RAG, and 100+ LLM providers, built around simplicity, customisation, and effective human-agent collaboration.
<div align="center">
<br>
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src="https://img.shields.io/badge/Highlighted_by_Elon_Musk-000000?style=for-the-badge&logo=x&logoColor=white" alt="Highlighted by Elon Musk" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
<br>
</div>
@@ -68,6 +69,26 @@ PraisonAI 🦞 — **Hire a 24/7 AI Workforce.** Stop writing boilerplate and st
---
> **Quick Paths:**
> - 🆕 **New here?** → [Quick Start](#-quick-start) *(1 minute to first agent)*
> - 📦 **Installing?** → [Installation](#-installation)
> - 🐍 **Python SDK?** → [Python Examples](#-using-python-code)
> - 📄 **YAML/No-Code?** → [YAML Examples](#-using-yaml-no-code)
> - 🎯 **CLI user?** → [CLI Quick Reference](#-cli-quick-reference)
> - 🤝 **Contributing?** → [Contributing](#-contributing)
---
## ⚡ Performance
PraisonAI is built for speed, with agent instantiation in under 4μs. This reduces overhead, improves responsiveness, and helps multi-agent systems scale efficiently in real-world production workloads.
| Performance Metric | PraisonAI |
|--------------------|-----------|
| Avg Instantiation Time | **3.77 μs** |
---
## 🎯 Use Cases
AI agents solving real-world problems across industries:
@@ -83,44 +104,9 @@ AI agents solving real-world problems across industries:
---
## 🚀 Meet your first Agent (Under 1 Minute)
## Supported Providers
1. Install the lightweight core SDK:
```bash
pip install praisonaiagents
export OPENAI_API_KEY="your-api-key"
```
2. Run your first autonomous agent:
```python
from praisonaiagents import Agent
# Give your agent a goal, and watch it work.
agent = Agent(instructions="You are a senior data analyst.")
agent.start("Analyze the top 3 tech trends of 2026 and format as a markdown table.")
```
---
## 🌌 The PraisonAI Ecosystem
Start simple with the core SDK, or expand to full visual builders and dashboards when you're ready.
* **Core SDK (`praisonaiagents`)**: For pure Python development. `pip install praisonaiagents`
* 💻 **PraisonAI CLI (`praisonai`)**: For terminal-based developers. `pip install praisonai`
* 🦞 **Claw Dashboard**: Connect agents directly to Telegram, Slack, or Discord. `pip install "praisonai[claw]"`
* 🔗 **Flow Visual Builder**: Drag-and-drop workflow creation. `pip install "praisonai[flow]"`
* 🤖 **PraisonAI UI**: Clean chat interface. `pip install "praisonai[ui]"`
### JavaScript SDK
```bash
npm install praisonai
```
## 🧠 Supported Providers & Features
Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
PraisonAI supports 100+ LLM providers through seamless integration:
<p align="center">
<img src="https://img.shields.io/badge/OpenAI-412991?style=flat&logo=openai&logoColor=white" alt="OpenAI" />
@@ -178,14 +164,6 @@ Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
</details>
<div align="center">
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src=".github/images/elon_musk_praisonai.png" alt="Highlighted by Elon Musk" width="600" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
</div>
<br>
---
## 🌟 Why PraisonAI?
@@ -227,6 +205,78 @@ Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
</details>
<div align="center">
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src=".github/images/elon_musk_praisonai.png" alt="Highlighted by Elon Musk" width="600" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
</div>
<br>
---
## 🚀 Quick Start
Get started with PraisonAI in under 1 minute:
```bash
# Install
pip install praisonaiagents
# Set API key
export OPENAI_API_KEY=your_key_here
# Create a simple agent
python -c "from praisonaiagents import Agent; Agent(instructions='You are a helpful AI assistant').start('Write a haiku about AI')"
```
> **Next Steps:** [Single Agent Example](#1-single-agent) | [Multi Agents](#2-multi-agents) | [Full Docs](https://docs.praison.ai)
---
## 📦 Installation
### Python SDK
Lightweight package dedicated for coding:
```bash
pip install praisonaiagents
```
For the full framework with CLI support:
```bash
pip install praisonai
```
🦞 **PraisonAI Claw** — full UI with bots, memory, knowledge, and gateway:
```bash
pip install "praisonai[claw]"
praisonai claw
```
🔗 **PraisonAI Flow** — Langflow Visual Flow Builder:
```bash
pip install "praisonai[flow]"
praisonai flow
```
🤖 **PraisonAI UI** — Clean chat interface:
```bash
pip install "praisonai[ui]"
praisonai ui
```
### JavaScript SDK
```bash
npm install praisonai
```
---
@@ -724,20 +774,6 @@ const agent = new Agent({ instructions: 'You are a helpful AI assistant' });
agent.start('Write a movie script about a robot in Mars');
```
---
## ⚡ Performance
PraisonAI is built for speed, with agent instantiation in under 4μs. This reduces overhead, improves responsiveness, and helps multi-agent systems scale efficiently in real-world production workloads.
| Performance Metric | PraisonAI |
|--------------------|-----------|
| Avg Instantiation Time | **3.77 μs** |
---
---
## ⭐ Star History
-7
View File
@@ -862,13 +862,6 @@ Methods:
* <code title="cli">praisonai knowledge index <a href="./src/praisonai/praisonai/cli/commands/knowledge.py">--help</a></code>
* <code title="cli">praisonai knowledge list <a href="./src/praisonai/praisonai/cli/commands/knowledge.py">--help</a></code>
* <code title="cli">praisonai knowledge search <a href="./src/praisonai/praisonai/cli/commands/knowledge.py">--help</a></code>
* <code title="cli">praisonai langfuse config <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse connect <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse langfuse-start <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse status <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse stop <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse test <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai langfuse version <a href="./src/praisonai/praisonai/cli/commands/langfuse.py">--help</a></code>
* <code title="cli">praisonai loop help <a href="./src/praisonai/praisonai/cli/commands/loop.py">--help</a></code>
* <code title="cli">praisonai loop loop-main <a href="./src/praisonai/praisonai/cli/commands/loop.py">--help</a></code>
* <code title="cli">praisonai lsp logs <a href="./src/praisonai/praisonai/cli/commands/lsp.py">--help</a></code>
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.121" \
"praisonai>=4.5.112" \
"praisonai[chat]" \
"embedchain[github,youtube]"
+1 -1
View File
@@ -20,7 +20,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.121" \
"praisonai>=4.5.112" \
"praisonai[ui]" \
"praisonai[chat]" \
"praisonai[realtime]" \
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.121" \
"praisonai>=4.5.112" \
"praisonai[ui]" \
"praisonai[crewai]"
+20
View File
@@ -0,0 +1,20 @@
import cProfile
import pstats
import io
from praisonaiagents import Agent
# Warm up
for _ in range(100):
_ = Agent(name="Test", llm="gpt-4o-mini", output="silent")
pr = cProfile.Profile()
pr.enable()
for _ in range(5000):
_ = Agent(name="Test", llm="gpt-4o-mini", output="silent")
pr.disable()
s = io.StringIO()
ps = pstats.Stats(pr, stream=s).sort_stats('cumtime')
ps.print_stats(30)
print(s.getvalue())
@@ -0,0 +1,31 @@
import cProfile
import pstats
import io
import time
from praisonaiagents import Agent
def func():
return Agent(name='Test', llm='gpt-4o-mini', output="silent")
# Warm up to fill caches
for _ in range(100):
func()
start_time = time.perf_counter()
for _ in range(1000):
func()
end_time = time.perf_counter()
avg_time = (end_time - start_time) / 1000 * 1_000_000
print(f"Time without profile: {avg_time:.2f} μs")
pr = cProfile.Profile()
pr.enable()
for _ in range(1000):
func()
pr.disable()
s = io.StringIO()
ps = pstats.Stats(pr, stream=s).sort_stats('cumtime')
ps.print_stats(30)
print(s.getvalue())
@@ -170,17 +170,16 @@ _LAZY_IMPORTS = {
'Handoff': ('praisonaiagents.agent.handoff', 'Handoff'),
'handoff': ('praisonaiagents.agent.handoff', 'handoff'),
'handoff_filters': ('praisonaiagents.agent.handoff', 'handoff_filters'),
'parallel_handoffs': ('praisonaiagents.agent.handoff', 'parallel_handoffs'),
'RECOMMENDED_PROMPT_PREFIX': ('praisonaiagents.agent.handoff', 'RECOMMENDED_PROMPT_PREFIX'),
'prompt_with_handoff_instructions': ('praisonaiagents.agent.handoff', 'prompt_with_handoff_instructions'),
'HandoffConfig': ('praisonaiagents.agent.handoff', 'HandoffConfig'),
'HandoffResult': ('praisonaiagents.agent.handoff', 'HandoffResult'),
'HandoffInputData': ('praisonaiagents.agent.handoff', 'HandoffInputData'),
'ContextPolicy': ('praisonaiagents.agent.handoff', 'ContextPolicy'),
'HandoffError': ('praisonaiagents.errors', 'HandoffError'),
'HandoffCycleError': ('praisonaiagents.errors', 'HandoffCycleError'),
'HandoffDepthError': ('praisonaiagents.errors', 'HandoffDepthError'),
'HandoffTimeoutError': ('praisonaiagents.errors', 'HandoffTimeoutError'),
'HandoffError': ('praisonaiagents.agent.handoff', 'HandoffError'),
'HandoffCycleError': ('praisonaiagents.agent.handoff', 'HandoffCycleError'),
'HandoffDepthError': ('praisonaiagents.agent.handoff', 'HandoffDepthError'),
'HandoffTimeoutError': ('praisonaiagents.agent.handoff', 'HandoffTimeoutError'),
# Embedding API (Note: embedding/embeddings handled in custom_handler to override subpackage)
'aembedding': ('praisonaiagents.embedding.embed', 'aembedding'),
@@ -204,15 +203,7 @@ _LAZY_IMPORTS = {
# Agent classes
'Agent': ('praisonaiagents.agent.agent', 'Agent'),
'BudgetExceededError': ('praisonaiagents.errors', 'BudgetExceededError'),
# Error hierarchy - structured exception handling
'PraisonAIError': ('praisonaiagents.errors', 'PraisonAIError'),
'ToolExecutionError': ('praisonaiagents.errors', 'ToolExecutionError'),
'LLMError': ('praisonaiagents.errors', 'LLMError'),
'ValidationError': ('praisonaiagents.errors', 'ValidationError'),
'NetworkError': ('praisonaiagents.errors', 'NetworkError'),
'ErrorContextProtocol': ('praisonaiagents.errors', 'ErrorContextProtocol'),
'BudgetExceededError': ('praisonaiagents.agent.agent', 'BudgetExceededError'),
'Heartbeat': ('praisonaiagents.agent.heartbeat', 'Heartbeat'),
'HeartbeatConfig': ('praisonaiagents.agent.heartbeat', 'HeartbeatConfig'),
'ImageAgent': ('praisonaiagents.agent.image_agent', 'ImageAgent'),
@@ -110,7 +110,7 @@ def __getattr__(name):
# Handoff - lightweight
_handoff_names = {
'Handoff', 'handoff', 'handoff_filters', 'parallel_handoffs',
'Handoff', 'handoff', 'handoff_filters',
'RECOMMENDED_PROMPT_PREFIX', 'prompt_with_handoff_instructions',
'HandoffConfig', 'HandoffResult', 'HandoffInputData',
'ContextPolicy', 'HandoffError', 'HandoffCycleError',
@@ -214,7 +214,6 @@ __all__ = [
'Handoff',
'handoff',
'handoff_filters',
'parallel_handoffs',
'RECOMMENDED_PROMPT_PREFIX',
'prompt_with_handoff_instructions',
'HandoffConfig',
@@ -176,19 +176,28 @@ _shared_apps = {} # Dict of port -> FastAPI app
# Don't import FastAPI dependencies here - use lazy loading instead
if TYPE_CHECKING:
from ..approval.protocols import ApprovalConfig, ApprovalProtocol
from ..config.feature_configs import LearnConfig, MemoryConfig
from ..context.models import ContextConfig
from ..context.manager import ContextManager
from ..knowledge.knowledge import Knowledge
from ..agent.autonomy import AutonomyConfig
from ..task.task import Task
from .handoff import Handoff, HandoffConfig, HandoffResult
from ..rag.models import RAGResult, ContextPack
from ..eval.results import EvaluationLoopResult
# Import structured error from central errors module
from ..errors import BudgetExceededError
class BudgetExceededError(Exception):
"""Raised when an agent exceeds its max_budget.
Usage:
try:
agent.start("...")
except BudgetExceededError as e:
print(f"Agent '{e.agent_name}' spent ${e.total_cost:.4f} of ${e.max_budget:.4f}")
"""
def __init__(self, agent_name: str, total_cost: float, max_budget: float):
self.agent_name = agent_name
self.total_cost = total_cost
self.max_budget = max_budget
super().__init__(
f"Agent '{agent_name}' exceeded budget: "
f"${total_cost:.4f} >= ${max_budget:.4f}"
)
class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin, ExecutionMixin, MemoryMixin):
# Class-level counter for generating unique display names for nameless agents
@@ -467,24 +476,24 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# CONSOLIDATED FEATURE PARAMS (agent-centric API)
# Each follows: False=disabled, True=defaults, Config=custom
# ============================================================
memory: Optional[Union[bool, str, 'MemoryConfig', 'MemoryManager']] = None,
knowledge: Optional[Union[bool, str, List[str], 'KnowledgeConfig', 'Knowledge']] = None,
planning: Optional[Union[bool, str, 'PlanningConfig']] = False,
reflection: Optional[Union[bool, str, 'ReflectionConfig']] = None,
guardrails: Optional[Union[bool, str, Callable, 'GuardrailConfig']] = None,
web: Optional[Union[bool, str, 'WebConfig']] = None,
context: Optional[Union[bool, str, Dict[str, Any], 'ContextConfig', 'ContextManager']] = None,
autonomy: Optional[Union[bool, str, Dict[str, Any], 'AutonomyConfig']] = None,
memory: Optional[Any] = None, # Union[bool, MemoryConfig, MemoryManager]
knowledge: Optional[Union[bool, List[str], Any]] = None, # Union[bool, list, KnowledgeConfig, Knowledge]
planning: Optional[Union[bool, Any]] = False, # Union[bool, PlanningConfig]
reflection: Optional[Union[bool, Any]] = None, # Union[bool, ReflectionConfig]
guardrails: Optional[Union[bool, Callable, Any]] = None, # Union[bool, Callable, GuardrailConfig]
web: Optional[Union[bool, Any]] = None, # Union[bool, WebConfig]
context: Optional[Union[bool, Any]] = None, # Union[bool, ManagerConfig, ContextManager] - None=smart default
autonomy: Optional[Union[bool, Dict[str, Any], Any]] = None, # Union[bool, dict, AutonomyConfig]
verification_hooks: Optional[List[Any]] = None, # Deprecated: use autonomy=AutonomyConfig(verification_hooks=[...])
output: Optional[Union[bool, str, Dict[str, Any], 'OutputConfig']] = None,
execution: Optional[Union[bool, str, Dict[str, Any], 'ExecutionConfig']] = None,
templates: Optional[Union[Dict[str, Any], 'TemplateConfig']] = None,
caching: Optional[Union[bool, str, Dict[str, Any], 'CachingConfig']] = None,
hooks: Optional[Union[List[Any], Dict[str, Any], 'HooksConfig']] = None,
skills: Optional[Union[List[str], str, Dict[str, Any], 'SkillsConfig']] = None,
approval: Optional[Union[bool, str, Dict[str, Any], 'ApprovalConfig', 'ApprovalProtocol']] = None,
output: Optional[Union[str, Any]] = None, # Union[str preset, OutputConfig]
execution: Optional[Union[str, Any]] = None, # Union[str preset, ExecutionConfig]
templates: Optional[Any] = None, # TemplateConfig
caching: Optional[Union[bool, Any]] = None, # Union[bool, CachingConfig]
hooks: Optional[Union[List[Any], Any]] = None, # Union[list, HooksConfig]
skills: Optional[Union[List[str], Any]] = None, # Union[list, SkillsConfig]
approval: Optional[Union[bool, Any]] = None, # Union[bool, ApprovalProtocol backend]
tool_timeout: Optional[int] = None, # P8/G11: Timeout in seconds for each tool call
learn: Optional[Union[bool, str, Dict[str, Any], 'LearnConfig']] = None, # Continuous learning (peer to memory)
learn: Optional[Union[bool, Any]] = None, # Union[bool, LearnConfig] - Continuous learning (peer to memory)
):
"""Initialize an Agent instance.
@@ -529,32 +538,22 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
- WebConfig: Custom configuration
context: Context management. Accepts:
- bool: True enables with defaults
- str: Preset name ("sliding_window", "summarize", "truncate")
- Dict[str, Any]: ContextConfig fields
- ContextConfig: Custom configuration
- ContextManager: Pre-configured instance
- ManagerConfig: Custom configuration
autonomy: Autonomy settings. Accepts:
- bool: True enables with defaults
- str: Level preset ("suggest", "auto_edit", "full_auto")
- Dict[str, Any]: Configuration dict
- Dict: Configuration dict
- AutonomyConfig: Custom configuration
verification_hooks: **Deprecated** — use ``autonomy=AutonomyConfig(verification_hooks=[...])``.
Still works for backward compatibility.
output: Output configuration. Accepts:
- bool: True=default OutputConfig, False=disabled
- str: Preset name ("silent", "actions", "verbose", "json", "stream")
- Dict[str, Any]: Config overrides (e.g. {"verbose": 2, "stream": True})
- OutputConfig: Custom configuration
Controls: verbose, markdown, stream, metrics, reasoning_steps
execution: Execution configuration. Accepts:
- bool: True=default ExecutionConfig, False=disabled
- str: Preset name ("fast", "balanced", "thorough")
- Dict[str, Any]: Config overrides (e.g. {"max_iter": 10, "max_rpm": 60})
- ExecutionConfig: Custom configuration
Controls: max_iter, max_rpm, max_execution_time, max_retry_limit
templates: Template configuration. Accepts:
- Dict[str, Any]: Template fields (e.g. {"system": "...", "prompt": "..."})
- TemplateConfig: Custom configuration
templates: Template configuration (TemplateConfig).
Controls: system_template, prompt_template, response_template
caching: Caching configuration. Accepts:
- bool: True enables with defaults
@@ -566,9 +565,7 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
- List[str]: Skill directory paths
- SkillsConfig: Custom configuration
learn: Continuous learning configuration. Accepts:
- bool: True enables with defaults (AGENTIC mode), False disables
- str: Mode string ("disabled", "agentic", "propose")
- Dict[str, Any]: Config fields (e.g. {"mode": "agentic", "backend": "sqlite"})
- bool: True enables with defaults, False disables
- LearnConfig: Custom configuration
Learning is a first-class citizen, peer to memory. It captures patterns,
preferences, and insights from interactions to improve future responses.
@@ -613,47 +610,38 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
Agent._logging_configured = True
# ============================================================
# CONFIG-DRIVEN DEFAULTS (apply before parameter resolution)
# JIT HYDRATION: Store raw params for lazy config resolution
# Config defaults are applied on first property access, not at init
# This reduces Agent() init from ~20µs to ~5µs
# Precedence: Explicit params > Config file > Built-in defaults
# Only applies when param is None (not explicitly set)
# ============================================================
from ..config.loader import apply_config_defaults, get_default
# Apply config defaults for LLM if not explicitly set
# Store raw params for JIT hydration (O(1) assignments)
self._raw_memory = memory
self._raw_knowledge = knowledge
self._raw_planning = planning
self._raw_reflection = reflection
self._raw_web = web
self._raw_output = output
self._raw_execution = execution
self._raw_caching = caching
self._raw_autonomy = autonomy
# Track which configs have been hydrated
self._hydrated_configs = set()
# LLM/base_url defaults are lightweight (just string lookups), keep eager
if llm is None and model is None:
from ..config.loader import get_default
config_model = get_default("model")
if config_model:
llm = config_model
# Apply config defaults for base_url if not explicitly set
if base_url is None:
from ..config.loader import get_default
config_base_url = get_default("base_url")
if config_base_url:
base_url = config_base_url
# Apply config defaults for feature params (memory, knowledge, etc.)
# These use apply_config_defaults which handles enabled=True/False logic
if memory is None:
memory = apply_config_defaults("memory", memory, MemoryConfig)
if knowledge is None:
knowledge = apply_config_defaults("knowledge", knowledge, KnowledgeConfig)
if planning is False: # Only override if explicitly False (default)
config_planning = apply_config_defaults("planning", None, PlanningConfig)
if config_planning:
planning = config_planning
if reflection is None:
reflection = apply_config_defaults("reflection", reflection, ReflectionConfig)
if web is None:
web = apply_config_defaults("web", web, WebConfig)
if output is None:
output = apply_config_defaults("output", output, OutputConfig)
if execution is None:
execution = apply_config_defaults("execution", execution, ExecutionConfig)
if caching is None:
caching = apply_config_defaults("caching", caching, CachingConfig)
if autonomy is None:
# AutonomyConfig is in agent/autonomy.py - use dict for config defaults
autonomy = apply_config_defaults("autonomy", autonomy, None)
# ============================================================
# DEPRECATION WARNINGS for params consolidated into configs
@@ -745,34 +733,37 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# Resolve OUTPUT param - FAST PATH for common cases
# DEFAULT: "silent" mode (zero overhead, fastest performance)
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_output_raw = self._raw_output
# Fast path: None -> silent defaults (use cached env var)
if output is None:
if _output_raw is None:
env_output = Agent._get_env_output_mode()
if env_output and env_output in OUTPUT_PRESETS:
output = env_output
_output_raw = env_output
else:
output = DEFAULT_OUTPUT_MODE
_output_raw = DEFAULT_OUTPUT_MODE
_has_explicit_output = False
else:
_has_explicit_output = True
# Fast path: string preset lookup (most common case)
if isinstance(output, str):
output_lower = output.lower()
if isinstance(_output_raw, str):
output_lower = _output_raw.lower()
preset_value = OUTPUT_PRESETS.get(output_lower)
if preset_value is not None:
_output_config = OutputConfig(**preset_value) if isinstance(preset_value, dict) else preset_value
elif _is_file_path(output):
elif _is_file_path(_output_raw):
# String looks like a file path - use as output_file
_output_config = OutputConfig(output_file=output)
_output_config = OutputConfig(output_file=_output_raw)
else:
_output_config = OutputConfig() # Default silent
elif isinstance(output, OutputConfig):
_output_config = output
elif isinstance(_output_raw, OutputConfig):
_output_config = _output_raw
else:
# Complex case: use full resolver
_output_config = resolve(
value=output,
value=_output_raw,
param_name="output",
config_class=OutputConfig,
presets=OUTPUT_PRESETS,
@@ -793,7 +784,6 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
editor_output = getattr(_output_config, 'editor_output', False) # Editor: Step N display
output_file = getattr(_output_config, 'output_file', None) # Auto-save to file
output_template = getattr(_output_config, 'template', None) # Response template
tool_output_limit = getattr(_output_config, 'tool_output_limit', DEFAULT_TOOL_OUTPUT_LIMIT)
else:
# Fallback defaults match silent mode (zero overhead)
verbose, markdown, stream, metrics, reasoning_steps = False, False, False, False, False
@@ -802,7 +792,6 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
status_trace = False
simple_output = False
editor_output = False
tool_output_limit = DEFAULT_TOOL_OUTPUT_LIMIT
# Enable editor output mode if configured (beginner-friendly, takes priority)
# Shows: Step 1: 📄 Creating file: path → ✓ Done
@@ -844,20 +833,23 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ─────────────────────────────────────────────────────────────────────
# Resolve EXECUTION param - FAST PATH for common cases
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_exec_raw = self._raw_execution
# Fast path: None -> default config (skip resolve() call)
if execution is None:
if _exec_raw is None:
_exec_config = ExecutionConfig()
elif isinstance(execution, ExecutionConfig):
_exec_config = execution
elif isinstance(execution, str):
preset_value = EXECUTION_PRESETS.get(execution.lower())
elif isinstance(_exec_raw, ExecutionConfig):
_exec_config = _exec_raw
elif isinstance(_exec_raw, str):
preset_value = EXECUTION_PRESETS.get(_exec_raw.lower())
if preset_value is not None:
_exec_config = ExecutionConfig(**preset_value) if isinstance(preset_value, dict) else preset_value
else:
_exec_config = ExecutionConfig()
else:
_exec_config = resolve(
value=execution,
value=_exec_raw,
param_name="execution",
config_class=ExecutionConfig,
presets=EXECUTION_PRESETS,
@@ -912,18 +904,21 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ─────────────────────────────────────────────────────────────────────
# Resolve CACHING param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_caching_raw = self._raw_caching
# Fast path: None -> default caching, False -> disabled
if caching is None:
if _caching_raw is None:
_caching_config = CachingConfig()
elif caching is False:
elif _caching_raw is False:
_caching_config = None
elif caching is True:
elif _caching_raw is True:
_caching_config = CachingConfig()
elif isinstance(caching, CachingConfig):
_caching_config = caching
elif isinstance(_caching_raw, CachingConfig):
_caching_config = _caching_raw
else:
_caching_config = resolve(
value=caching,
value=_caching_raw,
param_name="caching",
config_class=CachingConfig,
presets=CACHING_PRESETS,
@@ -932,7 +927,7 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
if _caching_config:
cache = _caching_config.enabled
prompt_caching = _caching_config.prompt_caching
elif caching is False:
elif _caching_raw is False:
cache, prompt_caching = False, None
else:
cache, prompt_caching = True, None
@@ -995,20 +990,23 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ─────────────────────────────────────────────────────────────────────
# Resolve MEMORY param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_memory_raw = self._raw_memory
# Fast path: None/False -> no memory (skip resolve() call)
if memory is None or memory is False:
if _memory_raw is None or _memory_raw is False:
_memory_config = None
elif memory is True:
elif _memory_raw is True:
_memory_config = MemoryConfig()
elif isinstance(memory, MemoryConfig):
_memory_config = memory
elif hasattr(memory, 'search') and hasattr(memory, 'add'):
_memory_config = memory # Memory instance passthrough
elif hasattr(memory, 'database_url'):
_memory_config = memory # db() instance passthrough
elif isinstance(_memory_raw, MemoryConfig):
_memory_config = _memory_raw
elif hasattr(_memory_raw, 'search') and hasattr(_memory_raw, 'add'):
_memory_config = _memory_raw # Memory instance passthrough
elif hasattr(_memory_raw, 'database_url'):
_memory_config = _memory_raw # db() instance passthrough
else:
_memory_config = resolve(
value=memory,
value=_memory_raw,
param_name="memory",
config_class=MemoryConfig,
presets=MEMORY_PRESETS,
@@ -1019,11 +1017,13 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
)
# Extract values from resolved memory config
# Use local variable for internal memory value (may be transformed)
_memory_value = _memory_raw
if _memory_config is not None:
if hasattr(_memory_config, 'database_url'):
# It's a db() instance - pass through
db = _memory_config
memory = True
_memory_value = True
elif isinstance(_memory_config, MemoryConfig):
user_id = _memory_config.user_id
session_id = _memory_config.session_id
@@ -1039,18 +1039,18 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
backend = backend.value
# If learn is enabled, pass as dict to trigger full Memory class
if _memory_config.learn:
memory = _memory_config.to_dict()
_memory_value = _memory_config.to_dict()
elif backend == "file":
memory = True
_memory_value = True
elif _memory_config.config:
memory = _memory_config.config
_memory_value = _memory_config.config
else:
memory = backend
_memory_value = backend
elif hasattr(_memory_config, 'search') and hasattr(_memory_config, 'add'):
# Memory instance - pass through
pass
elif memory is False:
memory = None
elif _memory_raw is False:
_memory_value = None
# ─────────────────────────────────────────────────────────────────────
# Resolve LEARN param - FAST PATH (top-level, peer to memory)
@@ -1073,24 +1073,8 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
_learn_config = learn
elif isinstance(learn, dict):
_learn_config = LearnConfig(**learn)
elif isinstance(learn, str):
# String mode: "disabled", "agentic", "propose"
from ..memory.learn.protocols import LearnMode
if learn == "disabled":
_learn_config = None
elif learn == "agentic":
_learn_config = LearnConfig(mode=LearnMode.AGENTIC)
elif learn == "propose":
_learn_config = LearnConfig(mode=LearnMode.PROPOSE)
else:
# Unknown string mode, disable learning
_learn_config = None
else:
logging.warning(
"Unsupported learn= value %r; expected bool, dict, or LearnConfig. "
"Learning disabled.", learn
)
_learn_config = None
_learn_config = learn # Pass through
elif _memory_config is not None and isinstance(_memory_config, MemoryConfig):
# Fallback to memory.learn for backward compatibility
if _memory_config.learn:
@@ -1104,12 +1088,12 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
_learn_config = LearnConfig(**_memory_config.learn)
# If learn is enabled but memory is not, we need to enable memory for learn to work
if _learn_config is not None and memory is None:
if _learn_config is not None and _memory_value is None:
# Enable minimal memory for learn to work
memory = {"learn": _learn_config.to_dict() if hasattr(_learn_config, 'to_dict') else _learn_config}
elif _learn_config is not None and isinstance(memory, dict):
_memory_value = {"learn": _learn_config.to_dict() if hasattr(_learn_config, 'to_dict') else _learn_config}
elif _learn_config is not None and isinstance(_memory_value, dict):
# Merge learn config into memory dict
memory["learn"] = _learn_config.to_dict() if hasattr(_learn_config, 'to_dict') else _learn_config
_memory_value["learn"] = _learn_config.to_dict() if hasattr(_learn_config, 'to_dict') else _learn_config
# ─────────────────────────────────────────────────────────────────────
# Resolve HISTORY from MemoryConfig - FAST PATH
@@ -1145,23 +1129,25 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ─────────────────────────────────────────────────────────────────────
# Resolve KNOWLEDGE param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_knowledge_raw = self._raw_knowledge
retrieval_config = None
embedder_config = None
# Fast path: None/False -> no knowledge (skip resolve() call)
if knowledge is None or knowledge is False:
if _knowledge_raw is None or _knowledge_raw is False:
_knowledge_config = None
elif knowledge is True:
elif _knowledge_raw is True:
_knowledge_config = KnowledgeConfig()
elif isinstance(knowledge, KnowledgeConfig):
_knowledge_config = knowledge
elif isinstance(knowledge, list):
_knowledge_config = KnowledgeConfig(sources=knowledge)
elif hasattr(knowledge, 'search') and hasattr(knowledge, 'add'):
_knowledge_config = knowledge # Knowledge instance passthrough
elif isinstance(_knowledge_raw, KnowledgeConfig):
_knowledge_config = _knowledge_raw
elif isinstance(_knowledge_raw, list):
_knowledge_config = KnowledgeConfig(sources=_knowledge_raw)
elif hasattr(_knowledge_raw, 'search') and hasattr(_knowledge_raw, 'add'):
_knowledge_config = _knowledge_raw # Knowledge instance passthrough
else:
_knowledge_config = resolve(
value=knowledge,
value=_knowledge_raw,
param_name="knowledge",
config_class=KnowledgeConfig,
instance_check=lambda v: hasattr(v, 'search') and hasattr(v, 'add'),
@@ -1170,10 +1156,12 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
default=None,
)
# Use local variable for internal knowledge value
_knowledge_value = _knowledge_raw
if _knowledge_config is not None:
if hasattr(_knowledge_config, 'search') and hasattr(_knowledge_config, 'add'):
# Knowledge instance - pass through
knowledge = _knowledge_config
_knowledge_value = _knowledge_config
elif isinstance(_knowledge_config, KnowledgeConfig):
embedder_config = _knowledge_config.embedder_config
if _knowledge_config.config:
@@ -1185,25 +1173,28 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
'rerank': _knowledge_config.rerank,
'rerank_model': _knowledge_config.rerank_model,
}
knowledge = _knowledge_config.sources if _knowledge_config.sources else None
_knowledge_value = _knowledge_config.sources if _knowledge_config.sources else None
elif isinstance(_knowledge_config, list):
knowledge = _knowledge_config
elif knowledge is False:
knowledge = None
_knowledge_value = _knowledge_config
elif _knowledge_raw is False:
_knowledge_value = None
# ─────────────────────────────────────────────────────────────────────
# Resolve PLANNING param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_planning_raw = self._raw_planning
# Fast path: None/False -> no planning (skip resolve() call)
if planning is None or planning is False:
if _planning_raw is None or _planning_raw is False:
_planning_config = None
elif planning is True:
elif _planning_raw is True:
_planning_config = PlanningConfig()
elif isinstance(planning, PlanningConfig):
_planning_config = planning
elif isinstance(_planning_raw, PlanningConfig):
_planning_config = _planning_raw
else:
_planning_config = resolve(
value=planning,
value=_planning_raw,
param_name="planning",
config_class=PlanningConfig,
presets=PLANNING_PRESETS,
@@ -1212,32 +1203,37 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
default=None,
)
# Use local variable for internal planning value
_planning_value = _planning_raw
if _planning_config is not None:
if isinstance(_planning_config, PlanningConfig):
planning = True
_planning_value = True
planning_tools = _planning_config.tools
planning_reasoning = _planning_config.reasoning
plan_mode = _planning_config.read_only
else:
planning = bool(_planning_config)
elif planning is True:
_planning_value = bool(_planning_config)
elif _planning_raw is True:
pass # Keep as True
else:
planning = False
_planning_value = False
# ─────────────────────────────────────────────────────────────────────
# Resolve REFLECTION param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_reflection_raw = self._raw_reflection
# Fast path: None/False -> no reflection (skip resolve() call)
if reflection is None or reflection is False:
if _reflection_raw is None or _reflection_raw is False:
_reflection_config = None
elif reflection is True:
elif _reflection_raw is True:
_reflection_config = ReflectionConfig()
elif isinstance(reflection, ReflectionConfig):
_reflection_config = reflection
elif isinstance(_reflection_raw, ReflectionConfig):
_reflection_config = _reflection_raw
else:
_reflection_config = resolve(
value=reflection,
value=_reflection_raw,
param_name="reflection",
config_class=ReflectionConfig,
presets=REFLECTION_PRESETS,
@@ -1254,9 +1250,9 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
reflect_prompt = _reflection_config.prompt
else:
self_reflect = bool(_reflection_config)
elif reflection is True:
elif _reflection_raw is True:
self_reflect = True
elif reflection is False:
elif _reflection_raw is False:
self_reflect = False
# ─────────────────────────────────────────────────────────────────────
@@ -1293,16 +1289,19 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ─────────────────────────────────────────────────────────────────────
# Resolve WEB param - FAST PATH
# ─────────────────────────────────────────────────────────────────────
# Use raw param from JIT storage
_web_raw = self._raw_web
# Fast path: None/False -> no web (skip resolve() call)
if web is None or web is False:
if _web_raw is None or _web_raw is False:
_web_config = None
elif web is True:
elif _web_raw is True:
_web_config = WebConfig()
elif isinstance(web, WebConfig):
_web_config = web
elif isinstance(_web_raw, WebConfig):
_web_config = _web_raw
else:
_web_config = resolve(
value=web,
value=_web_raw,
param_name="web",
config_class=WebConfig,
presets=WEB_PRESETS,
@@ -1317,10 +1316,10 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
else:
web_search = bool(_web_config)
web_fetch = bool(_web_config)
elif web is True:
elif _web_raw is True:
web_search = True
web_fetch = True
elif web is False:
elif _web_raw is False:
web_search = False
web_fetch = False
@@ -1329,7 +1328,8 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
# ============================================================
# Initialize autonomy features (agent-centric escalation/doom-loop)
self._init_autonomy(autonomy, verification_hooks=verification_hooks)
# Use raw param from JIT storage
self._init_autonomy(self._raw_autonomy, verification_hooks=verification_hooks)
# If instructions are provided, use them to set role, goal, and backstory
if instructions:
@@ -1536,10 +1536,9 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
self.max_rpm = max_rpm
self.max_execution_time = max_execution_time
self._memory_instance = None
self._init_memory(memory, user_id)
self._init_memory(_memory_value, user_id)
self.verbose = verbose
self._has_explicit_output_config = _has_explicit_output # Track if user set output mode
self.tool_output_limit = tool_output_limit # Configurable tool output limit
self.allow_delegation = allow_delegation
self.step_callback = step_callback
# Token budget guard (zero overhead when _max_budget is None)
@@ -1557,7 +1556,7 @@ class Agent(ToolExecutionMixin, ChatHandlerMixin, SessionManagerMixin, ChatMixin
self.max_retry_limit = max_retry_limit
self.code_execution_mode = code_execution_mode
self.embedder_config = embedder_config
self.knowledge = knowledge
self.knowledge = _knowledge_value
self.use_system_prompt = use_system_prompt
# Thread-safe chat_history with eager lock initialization
self.chat_history = []
@@ -1588,7 +1587,7 @@ Your Goal: {self.goal}
self.user_id = user_id or "praison"
self.reasoning_steps = reasoning_steps
self.plan_mode = plan_mode # Read-only mode for planning
self.planning = planning # Enable planning mode
self.planning = _planning_value # Enable planning mode
self.planning_tools = planning_tools # Tools for planning phase
self.planning_reasoning = planning_reasoning # Enable reasoning during planning
self._planning_agent = None # Lazy loaded PlanningAgent
@@ -1664,12 +1663,6 @@ Your Goal: {self.goal}
self._approval_backend = approval.backend
self._approve_all_tools = approval.all_tools
self._approval_timeout = approval.timeout # None = indefinite, 0 = backend default
elif isinstance(approval, dict):
# Dict config: convert to ApprovalConfig
approval_config = ApprovalConfig(**approval)
self._approval_backend = approval_config.backend
self._approve_all_tools = approval_config.all_tools
self._approval_timeout = approval_config.timeout
else:
# Plain backend object — dangerous tools only, backend default timeout
self._approval_backend = approval
@@ -1977,64 +1970,6 @@ Your Goal: {self.goal}
elif hasattr(self._context_param, 'process'):
# Already a ContextManager instance
self._context_manager = self._context_param
elif isinstance(self._context_param, str):
# String preset: "sliding_window", "summarize", "truncate"
from ..config.presets import CONTEXT_PRESETS
preset_config = CONTEXT_PRESETS.get(self._context_param)
if preset_config is not None:
# Convert preset to ContextConfig, then to ManagerConfig
try:
from ..context.models import ContextConfig as _ContextConfig
context_config = _ContextConfig(**preset_config)
manager_config = ManagerConfig(
auto_compact=context_config.auto_compact,
compact_threshold=context_config.compact_threshold,
strategy=context_config.strategy,
output_reserve=context_config.output_reserve,
default_tool_output_max=context_config.tool_output_max,
protected_tools=list(context_config.protected_tools),
keep_recent_turns=context_config.keep_recent_turns,
monitor_enabled=context_config.monitor.enabled if context_config.monitor else False,
)
self._context_manager = ContextManager(
model=self.llm if isinstance(self.llm, str) else "gpt-4o-mini",
config=manager_config,
agent_name=self.name or "Agent",
session_cache=self._session_dedup_cache,
llm_summarize_fn=None,
)
except Exception as e:
logging.debug(f"Context preset conversion failed: {e}")
self._context_manager = None
else:
# Unknown string preset, disable
self._context_manager = None
elif isinstance(self._context_param, dict):
# Dict config: convert to ContextConfig, then to ManagerConfig
try:
from ..context.models import ContextConfig as _ContextConfig
context_config = _ContextConfig(**self._context_param)
manager_config = ManagerConfig(
auto_compact=context_config.auto_compact,
compact_threshold=context_config.compact_threshold,
strategy=context_config.strategy,
output_reserve=context_config.output_reserve,
default_tool_output_max=context_config.tool_output_max,
protected_tools=list(context_config.protected_tools),
keep_recent_turns=context_config.keep_recent_turns,
monitor_enabled=context_config.monitor.enabled if context_config.monitor else False,
)
llm_summarize_enabled = self._context_param.get('llm_summarize', False)
self._context_manager = ContextManager(
model=self.llm if isinstance(self.llm, str) else "gpt-4o-mini",
config=manager_config,
agent_name=self.name or "Agent",
session_cache=self._session_dedup_cache,
llm_summarize_fn=self._create_llm_summarize_fn() if llm_summarize_enabled else None,
)
except Exception as e:
logging.debug(f"Context dict conversion failed: {e}")
self._context_manager = None
else:
# Unknown type, disable
self._context_manager = None
@@ -2251,25 +2186,6 @@ Summary:"""
# Extract verification_hooks from AutonomyConfig if provided
if autonomy.verification_hooks and not verification_hooks:
self._verification_hooks = autonomy.verification_hooks
elif isinstance(autonomy, str):
# String preset: "suggest", "auto_edit", "full_auto"
from ..config.presets import AUTONOMY_PRESETS
preset_config = AUTONOMY_PRESETS.get(autonomy)
if preset_config is not None:
config = AutonomyConfig.from_dict(preset_config)
else:
# Unknown string preset — disable autonomy
self.autonomy_enabled = False
self.autonomy_config = {}
self._autonomy_trigger = None
self._doom_loop_tracker = None
self._file_snapshot = None
self._snapshot_stack = []
self._redo_stack = []
self._autonomy_turn_tool_count = 0
self._consecutive_no_tool_turns = 0
self._doom_recovery_active = False
return
else:
self.autonomy_enabled = False
self.autonomy_config = {}
@@ -4025,28 +3941,17 @@ Summary:"""
return "", None
# Normalize results format (filter out None values, handle None metadata)
# Normalize results format (filter out None values, handle None metadata)
if hasattr(search_results, "results") and isinstance(getattr(search_results, "results"), list):
search_results = getattr(search_results, "results")
elif isinstance(search_results, dict) and 'results' in search_results:
search_results = search_results['results']
if isinstance(search_results, list):
if isinstance(search_results, dict) and 'results' in search_results:
results = []
for r in search_results:
for r in search_results['results']:
if r is None:
continue
if isinstance(r, dict):
text = r.get('memory', '') or r.get('text', '') or ''
metadata = r.get('metadata') or {}
else:
text = getattr(r, 'text', None) or getattr(r, 'memory', None) or ''
metadata = getattr(r, 'metadata', None)
if metadata is None:
metadata = {}
text = r.get('memory', '') or ''
metadata = r.get('metadata') or {} # Handle None metadata
if text:
results.append({"text": str(text), "metadata": metadata})
results.append({"text": text, "metadata": metadata})
elif isinstance(search_results, list):
results = [{"text": str(r), "metadata": {}} for r in search_results if r is not None and str(r)]
else:
results = [{"text": str(search_results), "metadata": {}}] if search_results else []
@@ -13,7 +13,6 @@ import logging
from praisonaiagents._logging import get_logger
import asyncio
import threading
from ..errors import BudgetExceededError
# Fallback helpers to avoid circular imports
def _get_console():
@@ -536,24 +535,8 @@ Your Goal: {self.goal}"""
formatted_tools = self._format_tools_for_completion(tools)
try:
# NEW: Unified protocol dispatch path (Issue #1304)
# Check if unified dispatch is enabled (opt-in for backward compatibility)
if getattr(self, '_use_unified_llm_dispatch', False):
# Use composition instead of runtime class mutation for safety
final_response = self._execute_unified_chat_completion(
messages=messages,
temperature=temperature,
tools=formatted_tools,
stream=stream,
reasoning_steps=reasoning_steps,
task_name=task_name,
task_description=task_description,
task_id=task_id,
response_format=response_format
)
# LEGACY: Maintain existing dual execution paths for backward compatibility
elif self._using_custom_llm and hasattr(self, 'llm_instance'):
# Use the custom LLM instance if available
if self._using_custom_llm and hasattr(self, 'llm_instance'):
if stream:
# Debug logs for tool info
if formatted_tools:
@@ -683,13 +666,7 @@ Your Goal: {self.goal}"""
self._llm_call_count += 1
if self._max_budget and self._total_cost >= self._max_budget:
if self._on_budget_exceeded == "stop":
raise BudgetExceededError(
f"Agent '{self.name}' exceeded budget: ${self._total_cost:.4f} >= ${self._max_budget:.4f}",
budget_type="cost",
limit=self._max_budget,
used=self._total_cost,
agent_id=self.name
)
raise BudgetExceededError(self.name, self._total_cost, self._max_budget)
elif self._on_budget_exceeded == "warn":
logging.warning(
f"[budget] {self.name}: ${self._total_cost:.4f} exceeded "
@@ -715,8 +692,6 @@ Your Goal: {self.goal}"""
return final_response
except BudgetExceededError:
raise
except Exception as e:
error_str = str(e).lower()
@@ -769,130 +744,6 @@ Your Goal: {self.goal}"""
_get_display_functions()['display_error'](f"Error in chat completion: {e}")
return None
def _execute_unified_chat_completion(
self,
messages,
temperature=1.0,
tools=None,
stream=True,
reasoning_steps=False,
task_name=None,
task_description=None,
task_id=None,
response_format=None
):
"""
Execute unified chat completion using composition instead of runtime class mutation.
This method provides the same functionality as UnifiedChatMixin but uses
composition for safety and maintainability.
"""
from ..llm import create_llm_dispatcher
# Get or create unified dispatcher
if not hasattr(self, '_unified_dispatcher') or self._unified_dispatcher is None:
# Provider selection based on existing agent configuration
if self._using_custom_llm and hasattr(self, 'llm_instance'):
dispatcher = create_llm_dispatcher(llm_instance=self.llm_instance)
else:
# Initialize OpenAI client if not present
if not hasattr(self, '_openai_client') or self._openai_client is None:
from ..llm import get_openai_client
self._openai_client = get_openai_client(api_key=getattr(self, 'api_key', None))
dispatcher = create_llm_dispatcher(openai_client=self._openai_client, model=self.llm)
# Cache the dispatcher
self._unified_dispatcher = dispatcher
# Execute unified dispatch with all necessary parameters
try:
final_response = self._unified_dispatcher.chat_completion(
messages=messages,
tools=tools,
temperature=temperature,
max_tokens=getattr(self, 'max_tokens', None),
stream=stream,
response_format=response_format,
execute_tool_fn=getattr(self, 'execute_tool', None),
console=self.console if (self.verbose or stream) else None,
display_fn=self._display_generating if self.verbose else None,
stream_callback=getattr(self.stream_emitter, 'emit', None) if hasattr(self, 'stream_emitter') else None,
emit_events=True,
verbose=self.verbose,
max_iterations=10,
reasoning_steps=reasoning_steps,
task_name=task_name,
task_description=task_description,
task_id=task_id
)
return final_response
except Exception as e:
logging.error(f"Unified chat completion failed: {e}")
raise
async def _execute_unified_achat_completion(
self,
messages,
temperature=1.0,
tools=None,
stream=True,
reasoning_steps=False,
task_name=None,
task_description=None,
task_id=None,
response_format=None
):
"""
Execute unified async chat completion using composition instead of runtime class mutation.
This method provides the same functionality as UnifiedChatMixin but uses
composition for safety and maintainability.
"""
from ..llm import create_llm_dispatcher
# Get or create unified dispatcher
if not hasattr(self, '_unified_dispatcher') or self._unified_dispatcher is None:
# Provider selection based on existing agent configuration
if self._using_custom_llm and hasattr(self, 'llm_instance'):
dispatcher = create_llm_dispatcher(llm_instance=self.llm_instance)
else:
# Initialize OpenAI client if not present
if not hasattr(self, '_openai_client') or self._openai_client is None:
from ..llm import get_openai_client
self._openai_client = get_openai_client(api_key=getattr(self, 'api_key', None))
dispatcher = create_llm_dispatcher(openai_client=self._openai_client, model=self.llm)
# Cache the dispatcher
self._unified_dispatcher = dispatcher
# Execute unified async dispatch with all necessary parameters
try:
final_response = await self._unified_dispatcher.achat_completion(
messages=messages,
tools=tools,
temperature=temperature,
max_tokens=getattr(self, 'max_tokens', None),
stream=stream,
response_format=response_format,
execute_tool_fn=getattr(self, 'execute_tool', None),
console=self.console if (self.verbose or stream) else None,
display_fn=self._display_generating if self.verbose else None,
stream_callback=getattr(self.stream_emitter, 'emit', None) if hasattr(self, 'stream_emitter') else None,
emit_events=True,
verbose=self.verbose,
max_iterations=10,
reasoning_steps=reasoning_steps,
task_name=task_name,
task_description=task_description,
task_id=task_id
)
return final_response
except Exception as e:
logging.error(f"Unified async chat completion failed: {e}")
raise
def _execute_callback_and_display(self, prompt: str, response: str, generation_time: float, task_name=None, task_description=None, task_id=None):
"""Helper method to execute callbacks and display interaction.
@@ -1838,71 +1689,53 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
# Use the new _format_tools_for_completion helper method
formatted_tools = self._format_tools_for_completion(tools)
# NEW: Unified protocol dispatch path (Issue #1304) - Async version
# Check if unified dispatch is enabled (opt-in for backward compatibility)
if getattr(self, '_use_unified_llm_dispatch', False):
# Use composition instead of runtime class mutation for safety
response = await self._execute_unified_achat_completion(
# Check if OpenAI client is available
if self._openai_client is None:
error_msg = "OpenAI client is not initialized. Please provide OPENAI_API_KEY or use a custom LLM provider."
_get_display_functions()['display_error'](error_msg)
return None
# Make the API call based on the type of request
if tools:
effective_tool_choice = tool_choice or getattr(self, '_yaml_tool_choice', None)
tool_call_kwargs = dict(
model=self.llm,
messages=messages,
temperature=temperature,
tools=formatted_tools,
stream=stream,
reasoning_steps=reasoning_steps,
task_name=task_name,
task_description=task_description,
task_id=task_id,
response_format=response_format
)
# Continue to handle structured outputs and other processing
# Don't return immediately - fall through to existing logic
if effective_tool_choice:
tool_call_kwargs['tool_choice'] = effective_tool_choice
response = await self._openai_client.async_client.chat.completions.create(
**tool_call_kwargs
)
result = await self._achat_completion(response, tools)
if get_logger().getEffectiveLevel() == logging.DEBUG:
total_time = time.time() - start_time
logging.debug(f"Agent.achat completed in {total_time:.2f} seconds")
# Execute callback after tool completion
self._execute_callback_and_display(original_prompt, result, time.time() - start_time, task_name, task_description, task_id)
return await self._atrigger_after_agent_hook(original_prompt, result, start_time)
elif output_json or output_pydantic:
response = await self._openai_client.async_client.chat.completions.create(
model=self.llm,
messages=messages,
temperature=temperature,
response_format={"type": "json_object"}
)
response_text = response.choices[0].message.content
if get_logger().getEffectiveLevel() == logging.DEBUG:
total_time = time.time() - start_time
logging.debug(f"Agent.achat completed in {total_time:.2f} seconds")
# Execute callback after JSON/Pydantic completion
self._execute_callback_and_display(original_prompt, response_text, time.time() - start_time, task_name, task_description, task_id)
return await self._atrigger_after_agent_hook(original_prompt, response_text, start_time)
else:
# LEGACY: Check if OpenAI client is available
if self._openai_client is None:
error_msg = "OpenAI client is not initialized. Please provide OPENAI_API_KEY or use a custom LLM provider."
_get_display_functions()['display_error'](error_msg)
return None
# Make the API call based on the type of request
if tools:
effective_tool_choice = tool_choice or getattr(self, '_yaml_tool_choice', None)
tool_call_kwargs = dict(
model=self.llm,
messages=messages,
temperature=temperature,
tools=formatted_tools,
)
if effective_tool_choice:
tool_call_kwargs['tool_choice'] = effective_tool_choice
response = await self._openai_client.async_client.chat.completions.create(
**tool_call_kwargs
)
result = await self._achat_completion(response, tools)
if get_logger().getEffectiveLevel() == logging.DEBUG:
total_time = time.time() - start_time
logging.debug(f"Agent.achat completed in {total_time:.2f} seconds")
# Execute callback after tool completion
self._execute_callback_and_display(original_prompt, result, time.time() - start_time, task_name, task_description, task_id)
return await self._atrigger_after_agent_hook(original_prompt, result, start_time)
elif output_json or output_pydantic:
response = await self._openai_client.async_client.chat.completions.create(
model=self.llm,
messages=messages,
temperature=temperature,
response_format={"type": "json_object"}
)
response_text = response.choices[0].message.content
if get_logger().getEffectiveLevel() == logging.DEBUG:
total_time = time.time() - start_time
logging.debug(f"Agent.achat completed in {total_time:.2f} seconds")
# Execute callback after JSON/Pydantic completion
self._execute_callback_and_display(original_prompt, response_text, time.time() - start_time, task_name, task_description, task_id)
return await self._atrigger_after_agent_hook(original_prompt, response_text, start_time)
else:
response = await self._openai_client.async_client.chat.completions.create(
model=self.llm,
messages=messages,
temperature=temperature
)
response = await self._openai_client.async_client.chat.completions.create(
model=self.llm,
messages=messages,
temperature=temperature
)
response_text = response.choices[0].message.content
@@ -14,7 +14,6 @@ from praisonaiagents._logging import get_logger
import asyncio
import threading
# Fallback helpers to avoid circular imports
def _get_console():
from rich.console import Console
@@ -1014,7 +1013,6 @@ Write the complete compiled report:"""
from mcp.server.fastmcp import FastMCP
from mcp.server.sse import SseServerTransport
from starlette.applications import Starlette
from starlette.routing import Mount
import threading
import time
import asyncio
@@ -50,7 +50,6 @@ class HandoffConfig:
detect_cycles: Enable cycle detection to prevent infinite loops
max_depth: Maximum handoff chain depth
async_mode: Enable async execution
allow_parallel: Enable parallel execution (from Delegator)
on_handoff: Callback when handoff starts
on_complete: Callback when handoff completes
on_error: Callback when handoff fails
@@ -63,7 +62,7 @@ class HandoffConfig:
# Execution control
timeout_seconds: float = 300.0
max_concurrent: int = 5
max_concurrent: int = 3
# Safety
detect_cycles: bool = True
@@ -71,7 +70,6 @@ class HandoffConfig:
# Execution mode
async_mode: bool = False
allow_parallel: bool = False
# Callbacks
on_handoff: Optional[Callable] = None
@@ -90,7 +88,6 @@ class HandoffConfig:
"detect_cycles": self.detect_cycles,
"max_depth": self.max_depth,
"async_mode": self.async_mode,
"allow_parallel": self.allow_parallel,
}
@classmethod
@@ -100,13 +97,29 @@ class HandoffConfig:
data["context_policy"] = ContextPolicy(data["context_policy"])
return cls(**{k: v for k, v in data.items() if k in cls.__dataclass_fields__})
# Import structured error hierarchy from central errors module
from ..errors import (
HandoffError,
HandoffCycleError,
HandoffDepthError,
HandoffTimeoutError
)
class HandoffError(Exception):
"""Base exception for handoff errors."""
pass
class HandoffCycleError(HandoffError):
"""Raised when a cycle is detected in handoff chain."""
def __init__(self, chain: List[str]):
self.chain = chain
super().__init__(f"Handoff cycle detected: {' -> '.join(chain)}")
class HandoffDepthError(HandoffError):
"""Raised when max handoff depth is exceeded."""
def __init__(self, depth: int, max_depth: int):
self.depth = depth
self.max_depth = max_depth
super().__init__(f"Max handoff depth exceeded: {depth} > {max_depth}")
class HandoffTimeoutError(HandoffError):
"""Raised when handoff times out."""
def __init__(self, timeout: float, agent_name: str):
self.timeout = timeout
self.agent_name = agent_name
super().__init__(f"Handoff to {agent_name} timed out after {timeout}s")
# Thread-local storage for tracking handoff chains
_handoff_context = threading.local()
@@ -254,26 +267,12 @@ class Handoff:
if self.config.detect_cycles:
chain = _get_handoff_chain()
if target_name in chain:
cycle_path = chain + [target_name]
raise HandoffCycleError(
f"Handoff cycle detected: {' -> '.join(cycle_path)}",
source_agent=source_agent.name if hasattr(source_agent, 'name') else 'unknown',
target_agent=target_name,
agent_id=source_agent.name if hasattr(source_agent, 'name') else 'unknown',
cycle_path=cycle_path
)
raise HandoffCycleError(chain + [target_name])
# Check depth
current_depth = _get_handoff_depth()
if current_depth >= self.config.max_depth:
raise HandoffDepthError(
f"Max handoff depth exceeded: {current_depth + 1} > {self.config.max_depth}",
source_agent=source_agent.name if hasattr(source_agent, 'name') else 'unknown',
target_agent=target_name,
agent_id=source_agent.name if hasattr(source_agent, 'name') else 'unknown',
max_depth=self.config.max_depth,
current_depth=current_depth + 1
)
raise HandoffDepthError(current_depth + 1, self.config.max_depth)
def _prepare_context(self, source_agent: 'Agent', kwargs: Dict[str, Any]) -> HandoffInputData:
"""
@@ -539,13 +538,7 @@ class Handoff:
handoff_depth=_get_handoff_depth(),
)
self._execute_callback(self.config.on_error, source_agent, kwargs, result)
raise HandoffTimeoutError(
f"Handoff to {self.agent.name} timed out after {self.config.timeout_seconds}s",
timeout_seconds=self.config.timeout_seconds,
source_agent=source_agent.name if hasattr(source_agent, "name") else "unknown",
target_agent=self.agent.name,
agent_id=source_agent.name if hasattr(source_agent, "name") else "unknown"
)
raise HandoffTimeoutError(self.config.timeout_seconds, self.agent.name)
except Exception as e:
result = HandoffResult(
success=False,
@@ -825,102 +818,6 @@ When you determine that a task would be better handled by another agent with spe
use the transfer tool to hand off the task. The receiving agent will have the full context of
the conversation and will continue helping the user."""
async def parallel_handoffs(
source: 'Agent',
targets: List[tuple], # [(agent, prompt), ...]
max_concurrent: int = 5,
config: Optional[HandoffConfig] = None,
) -> List['HandoffResult']:
"""
Execute multiple handoffs in parallel with concurrency control.
This function provides the parallel execution capabilities from SubagentDelegator
while using the unified Handoff system.
Args:
source: Source agent performing the handoffs
targets: List of (agent, prompt) tuples for parallel execution
max_concurrent: Maximum concurrent handoffs (overrides config)
config: Optional HandoffConfig for additional settings
Returns:
List of HandoffResult objects from each parallel handoff
Example:
results = await parallel_handoffs(
source=main_agent,
targets=[
(research_agent, "Research topic X"),
(analysis_agent, "Analyze data Y"),
(summary_agent, "Summarize findings Z")
],
max_concurrent=3
)
"""
if not hasattr(source, 'handoff_to_async'):
raise ValueError("Source agent must support async handoffs")
# Check if parallel execution is allowed by config
if config and not config.allow_parallel:
raise ValueError("Parallel handoffs are disabled in the provided HandoffConfig")
# Use config's max_concurrent if max_concurrent wasn't explicitly set and config is provided
if config and max_concurrent == 5: # Check if default value
effective_max_concurrent = config.max_concurrent
else:
effective_max_concurrent = max_concurrent
# Create semaphore for concurrency control (0 or negative = unlimited)
semaphore = asyncio.Semaphore(effective_max_concurrent) if effective_max_concurrent > 0 else None
async def _run_one(agent, prompt):
async def _do_handoff():
try:
return await source.handoff_to_async(agent, prompt, config=config)
except Exception as e:
logger.error(f"Parallel handoff failed to {getattr(agent, 'name', str(agent))}: {e}")
# Return a failed HandoffResult object
return HandoffResult(
success=False,
response="",
target_agent=getattr(agent, 'name', str(agent)),
source_agent=getattr(source, 'name', str(source)),
duration_seconds=0.0,
error=str(e),
handoff_depth=0
)
if semaphore:
async with semaphore:
return await _do_handoff()
else:
return await _do_handoff()
# Execute all handoffs concurrently
tasks = [_run_one(agent, prompt) for agent, prompt in targets]
results = await asyncio.gather(*tasks, return_exceptions=True)
# Convert any exceptions to failed results
processed_results = []
for i, result in enumerate(results):
if isinstance(result, HandoffResult):
processed_results.append(result)
else:
# Handle Exception, BaseException (like CancelledError), or any other unexpected result
agent, _prompt = targets[i] # Prefix with _ to mark intentionally unused
processed_results.append(HandoffResult(
success=False,
response="",
target_agent=getattr(agent, 'name', str(agent)),
source_agent=getattr(source, 'name', str(source)),
duration_seconds=0.0,
error=str(result),
handoff_depth=0
))
return processed_results
def prompt_with_handoff_instructions(base_prompt: str, agent: 'Agent') -> str:
"""
Add handoff instructions to an agent's prompt.
@@ -216,11 +216,10 @@ class ToolExecutionMixin:
else:
# Apply default limit even without context management
# This prevents runaway tool outputs from causing overflow
limit = getattr(self, 'tool_output_limit', 16000)
if len(result_str) > limit:
if len(result_str) > DEFAULT_TOOL_OUTPUT_LIMIT:
# Use smart truncation format that judge recognizes as OK
tail_size = min(limit // 5, 2000)
head = result_str[:limit - tail_size]
tail_size = min(DEFAULT_TOOL_OUTPUT_LIMIT // 5, 2000)
head = result_str[:DEFAULT_TOOL_OUTPUT_LIMIT - tail_size]
tail = result_str[-tail_size:] if tail_size > 0 else ""
truncated = f"{head}\n...[{len(result_str):,} chars, showing first/last portions]...\n{tail}"
else:
@@ -230,7 +229,7 @@ class ToolExecutionMixin:
logging.debug(f"Truncated {function_name} output from {len(result_str)} to {len(truncated)} chars")
# For dicts, truncate large string fields (e.g., raw_content from search)
if isinstance(result, dict):
max_field_chars = getattr(self, 'tool_output_limit', 16000) if not self.context_manager else None
max_field_chars = DEFAULT_TOOL_OUTPUT_LIMIT if not self.context_manager else None
result = self._truncate_dict_fields(result, function_name, max_field_chars)
else:
result = truncated
@@ -1,152 +0,0 @@
"""
Unified Chat Mixin for Agent class.
This module consolidates the dual execution paths (custom LLM vs OpenAI)
into a single async-first protocol-driven implementation, eliminating
the DRY violation and maintenance burden described in Issue #1304.
"""
import asyncio
import logging
import time
from typing import Any, Dict, List, Optional, Union
from ..llm import create_llm_dispatcher, UnifiedLLMDispatcher
class UnifiedChatMixin:
"""
Unified chat implementation that replaces dual execution paths.
This mixin consolidates:
- Path A: LLM.get_response() / LLM.get_response_async()
- Path B: OpenAIClient chat completion
Into a single async-first protocol-driven dispatch using UnifiedLLMDispatcher.
"""
def _get_unified_dispatcher(self) -> UnifiedLLMDispatcher:
"""
Get or create the unified LLM dispatcher for this agent.
This method implements the provider selection logic that was
previously scattered in _chat_completion() method.
"""
if hasattr(self, '_unified_dispatcher') and self._unified_dispatcher is not None:
return self._unified_dispatcher
# Determine which adapter to use based on existing agent configuration
if self._using_custom_llm and hasattr(self, 'llm_instance'):
# Use LiteLLM adapter for custom LLM instances
dispatcher = create_llm_dispatcher(llm_instance=self.llm_instance)
else:
# Use OpenAI adapter for direct OpenAI access
if not hasattr(self, '_openai_client') or self._openai_client is None:
# Initialize OpenAI client if not present
from ..llm import get_openai_client
self._openai_client = get_openai_client(api_key=getattr(self, 'api_key', None))
dispatcher = create_llm_dispatcher(openai_client=self._openai_client, model=self.llm)
# Cache the dispatcher
self._unified_dispatcher = dispatcher
return dispatcher
def _unified_chat_completion(
self,
messages: List[Dict[str, Any]],
temperature: float = 1.0,
tools: Optional[List[Dict[str, Any]]] = None,
stream: bool = True,
reasoning_steps: bool = False,
task_name: Optional[str] = None,
task_description: Optional[str] = None,
task_id: Optional[str] = None,
response_format: Optional[Dict[str, Any]] = None
) -> Any:
"""
Unified sync chat completion method.
This replaces the existing _chat_completion() method's dual dispatch logic
with a single path through UnifiedLLMDispatcher.
"""
start_time = time.time()
# Get unified dispatcher (handles provider selection)
dispatcher = self._get_unified_dispatcher()
# Use the same message processing logic but route through unified dispatcher
formatted_tools = self._format_tools_for_completion(tools)
try:
# Single dispatch path for all providers
final_response = dispatcher.chat_completion(
messages=messages,
tools=formatted_tools,
temperature=temperature,
max_tokens=getattr(self, 'max_tokens', None),
stream=stream,
response_format=response_format,
**{
'reasoning_steps': reasoning_steps,
'task_name': task_name,
'task_description': task_description,
'task_id': task_id,
}
)
return final_response
except Exception as e:
logging.error(f"Unified chat completion failed: {e}")
# Apply the same error handling as the original implementation
raise
async def _unified_achat_completion(
self,
messages: List[Dict[str, Any]],
temperature: float = 1.0,
tools: Optional[List[Dict[str, Any]]] = None,
stream: bool = True,
reasoning_steps: bool = False,
task_name: Optional[str] = None,
task_description: Optional[str] = None,
task_id: Optional[str] = None,
response_format: Optional[Dict[str, Any]] = None
) -> Any:
"""
Unified async chat completion method.
This provides native async implementation, eliminating the need
for separate async/sync implementations in the LLM layer.
"""
start_time = time.time()
# Get unified dispatcher (handles provider selection)
dispatcher = self._get_unified_dispatcher()
# Use the same message processing logic but route through unified dispatcher
formatted_tools = self._format_tools_for_completion(tools)
try:
# Single async dispatch path for all providers
final_response = await dispatcher.achat_completion(
messages=messages,
tools=formatted_tools,
temperature=temperature,
max_tokens=getattr(self, 'max_tokens', None),
stream=stream,
response_format=response_format,
**{
'reasoning_steps': reasoning_steps,
'task_name': task_name,
'task_description': task_description,
'task_id': task_id,
}
)
return final_response
except Exception as e:
logging.error(f"Unified async chat completion failed: {e}")
# Apply the same error handling as the original implementation
raise
@@ -6,10 +6,7 @@ AgentManager, Agents, PraisonAIAgents are silent aliases for backward compatibil
from .agents import AgentTeam, AgentManager, Agents, PraisonAIAgents
from .autoagents import AutoAgents
from .auto_rag_agent import AutoRagAgent, AutoRagConfig, RetrievalPolicy
from .protocols import (
MergeStrategyProtocol, FirstWinsMerge, ConcatMerge, DictMerge,
TaskExecutorProtocol, ExecutionContext, TaskResult
)
from .protocols import MergeStrategyProtocol, FirstWinsMerge, ConcatMerge, DictMerge
__all__ = [
'AgentTeam', # Primary class (v1.0+)
@@ -19,5 +16,4 @@ __all__ = [
'AutoAgents',
'AutoRagAgent', 'AutoRagConfig', 'RetrievalPolicy',
'MergeStrategyProtocol', 'FirstWinsMerge', 'ConcatMerge', 'DictMerge',
'TaskExecutorProtocol', 'ExecutionContext', 'TaskResult',
]
@@ -108,244 +108,6 @@ def get_multimodal_message(text_prompt: str, images: list) -> list:
})
return content
def _prepare_task_prompt(task, task_description, context_text=None):
"""
Prepare task prompt with context and memory (DRY helper).
"""
# Build task prompt - only use "User Input/Topic" format if there's actual content
if context_text and context_text.strip():
task_prompt = f"""
User Input/Topic: {context_text}
Task: {task_description}
Expected Output: {task.expected_output}
IMPORTANT: Your response must be about the user's input/topic above. Incorporate it into your task."""
else:
task_prompt = f"""
You need to do the following task: {task_description}.
Expected Output: {task.expected_output}."""
# Add memory context if available
if task.memory:
try:
memory_context = task.memory.build_context_for_task(task.description)
if memory_context:
# Log detailed memory context for debugging
logger.debug(f"Memory context for task '{task.description}': {memory_context}")
# Include actual memory content without verbose headers (essential for AI agent functionality)
task_prompt += f"\n\n{memory_context}"
except Exception as e:
logger.error(f"Error getting memory context: {e}")
task_prompt += "\nPlease provide only the final result of your work. Do not add any conversation or extra explanation."
return task_prompt
def _execute_with_agent_sync(executor_agent, task_prompt, task, tools, stream=None):
"""
Execute task with agent synchronously (DRY helper).
"""
if task.images:
return executor_agent.chat(
get_multimodal_message(task_prompt, task.images),
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
stream=stream,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
else:
return executor_agent.chat(
task_prompt,
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
stream=stream,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
async def _execute_with_agent_async(executor_agent, task_prompt, task, tools, stream=None):
"""
Execute task with agent asynchronously (DRY helper).
"""
if task.images:
return await executor_agent.achat(
get_multimodal_message(task_prompt, task.images),
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
stream=stream,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
else:
return await executor_agent.achat(
task_prompt,
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
stream=stream,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
def _build_execution_context(agents_instance, task_id):
"""
Build unified execution context for task execution (DRY helper).
Eliminates duplication between sync/async execution paths.
"""
from .protocols import ExecutionContext
task = agents_instance.tasks[task_id]
# Initialize memory before task execution
if not task.memory:
task.memory = task.initialize_memory()
executor_agent = task.agent
# Create agent from agent_config if provided and no agent assigned
if executor_agent is None and getattr(task, 'agent_config', None):
executor_agent = agents_instance._create_agent_from_config(task.agent_config)
task.agent = executor_agent
# Validate executor agent exists
if executor_agent is None:
raise ValueError(
f"Task {task_id} has no assigned agent. "
"Set task.agent or provide task.agent_config before execution."
)
# Set current agent for token tracking
llm = getattr(executor_agent, 'llm', None) or getattr(executor_agent, 'llm_instance', None)
if llm and hasattr(llm, 'set_current_agent'):
llm.set_current_agent(executor_agent.display_name)
# Ensure tools are available from both task and agent (create copy to avoid mutation)
tools = list(task.tools or [])
if executor_agent and executor_agent.tools:
tools.extend(executor_agent.tools)
# Substitute variables in task description if provided
task_description = task.description
variables = getattr(task, 'variables', None) or getattr(agents_instance, 'variables', None) or {}
for key, value in variables.items():
task_description = task_description.replace(f"{{{{{key}}}}}", str(value))
# Build context first to include in task prompt
context_text = ""
if task.context:
context_results = [] # Collect contexts then de-duplicate
for context_item in task.context:
# Use the centralized helper function
context_str = process_task_context(context_item, agents_instance.verbose, agents_instance.user_id)
# Only add non-empty context strings
if context_str and context_str.strip():
context_results.append(context_str)
# Join unique context results with proper formatting
unique_contexts = list(dict.fromkeys(context_results)) # Remove duplicates
if agents_instance.verbose >= 3:
logger.info(f"Task {task_id} context items: {len(unique_contexts)}")
for i, ctx in enumerate(unique_contexts):
logger.debug(f"Context {i+1}: {ctx[:100]}...")
context_separator = '\n\n'
context_text = context_separator.join(unique_contexts)
# Build task prompt using DRY helper
task_prompt = _prepare_task_prompt(task, task_description, context_text)
if agents_instance.verbose >= 2:
logger.info(f"Executing task {task_id}: {task_description} using {executor_agent.display_name}")
logger.debug(f"Starting execution of task {task_id} with prompt:\n{task_prompt}")
return ExecutionContext(
task_id=task_id,
task=task,
executor_agent=executor_agent,
tools=tools,
task_description=task_description,
context_text=context_text,
task_prompt=task_prompt,
llm=llm,
verbose=agents_instance.verbose,
stream=agents_instance.stream,
user_id=agents_instance.user_id
)
def _process_task_result(agents_instance, context, agent_output):
"""
Process task execution result (DRY helper).
Eliminates duplication in result processing between sync/async paths.
"""
from .protocols import TaskResult
task = context.task
task_id = context.task_id
executor_agent = context.executor_agent
llm = context.llm
if agent_output:
# Store the response in memory
if task.memory:
try:
task.store_in_memory(
content=agent_output,
agent_name=executor_agent.display_name,
task_id=task_id
)
except Exception as e:
logger.error(f"Failed to store agent output in memory: {e}")
task_output = TaskOutput(
description=task.description,
summary=task.description[:10],
raw=agent_output,
agent=executor_agent.display_name,
output_format="RAW"
)
# Add token metrics if available
if llm and hasattr(llm, 'last_token_metrics'):
token_metrics = llm.last_token_metrics
if token_metrics:
task_output.token_metrics = token_metrics
if task.output_json:
cleaned = agents_instance.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
task_output.json_dict = parsed
task_output.output_format = "JSON"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as JSON")
logger.debug(f"Output that failed JSON parsing: {agent_output}")
if task.output_pydantic:
cleaned = agents_instance.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
pyd_obj = task.output_pydantic(**parsed)
task_output.pydantic = pyd_obj
task_output.output_format = "Pydantic"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as Pydantic Model")
logger.debug(f"Output that failed Pydantic parsing: {agent_output}")
task.result = task_output
return TaskResult(task_output=task_output, success=True)
else:
task.status = "failed"
return TaskResult(task_output=None, success=False, error="Agent did not produce any output.")
def process_task_context(context_item, verbose=0, user_id=None):
"""
Process a single context item for task execution.
@@ -870,7 +632,7 @@ class AgentTeam:
return len(agent_output.strip()) > 0
async def aexecute_task(self, task_id):
"""Async version of execute_task method - now using DRY helpers"""
"""Async version of execute_task method"""
if task_id not in self.tasks:
display_error(f"Error: Task with ID {task_id} does not exist")
return
@@ -891,18 +653,162 @@ class AgentTeam:
if task.status == "not started":
task.status = "in progress"
# Build execution context using DRY helper
context = _build_execution_context(self, task_id)
# Initialize memory before task execution
if not task.memory:
task.memory = task.initialize_memory()
# Execute with agent using DRY helper
agent_output = await _execute_with_agent_async(
context.executor_agent, context.task_prompt, context.task,
context.tools, stream=self.stream
)
executor_agent = task.agent
# Create agent from agent_config if provided and no agent assigned
if executor_agent is None and getattr(task, 'agent_config', None):
executor_agent = self._create_agent_from_config(task.agent_config)
task.agent = executor_agent
# Set current agent for token tracking
llm = getattr(executor_agent, 'llm', None) or getattr(executor_agent, 'llm_instance', None)
if llm and hasattr(llm, 'set_current_agent'):
llm.set_current_agent(executor_agent.display_name)
# Process result using DRY helper
task_result = _process_task_result(self, context, agent_output)
return task_result.task_output
# Ensure tools are available from both task and agent (create copy to avoid mutation)
tools = list(task.tools or [])
if executor_agent and executor_agent.tools:
tools.extend(executor_agent.tools)
logger.info(f"Task config: {task.config}")
logger.info(f"Task memory status: {'Initialized' if task.memory else 'Not initialized'}")
# Substitute variables in task description if provided
task_description = task.description
if getattr(task, 'variables', None):
for key, value in task.variables.items():
task_description = task_description.replace(f"{{{{{key}}}}}", str(value))
# Build context first to include in task prompt
context_text = ""
if task.context:
context_results = [] # Use list to avoid duplicates
for context_item in task.context:
# Use the centralized helper function
context_str = process_task_context(context_item, self.verbose, self.user_id)
# Only add non-empty context strings
if context_str and context_str.strip():
context_results.append(context_str)
# Join unique context results with proper formatting
unique_contexts = list(dict.fromkeys(context_results)) # Remove duplicates
if self.verbose >= 3:
logger.info(f"Task {task_id} context items: {len(unique_contexts)}")
for i, ctx in enumerate(unique_contexts):
logger.debug(f"Context {i+1}: {ctx[:100]}...")
context_separator = '\n\n'
context_text = context_separator.join(unique_contexts)
# Build task prompt - only use "User Input/Topic" format if there's actual content
if context_text and context_text.strip():
task_prompt = f"""
User Input/Topic: {context_text}
Task: {task_description}
Expected Output: {task.expected_output}
IMPORTANT: Your response must be about the user's input/topic above. Incorporate it into your task."""
else:
task_prompt = f"""
You need to do the following task: {task_description}.
Expected Output: {task.expected_output}."""
# Add memory context if available
if task.memory:
try:
memory_context = task.memory.build_context_for_task(task.description)
if memory_context:
# Log detailed memory context for debugging
logger.debug(f"Memory context for task '{task.description}': {memory_context}")
# Include actual memory content without verbose headers (essential for AI agent functionality)
task_prompt += f"\n\n{memory_context}"
except Exception as e:
logger.error(f"Error getting memory context: {e}")
task_prompt += "\nPlease provide only the final result of your work. Do not add any conversation or extra explanation."
if self.verbose >= 2:
logger.info(f"Executing task {task_id}: {task_description} using {executor_agent.display_name}")
logger.debug(f"Starting execution of task {task_id} with prompt:\n{task_prompt}")
if task.images:
# Use shared multimodal helper (DRY - defined at module level)
agent_output = await executor_agent.achat(
get_multimodal_message(task_prompt, task.images),
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
else:
agent_output = await executor_agent.achat(
task_prompt,
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
task_name=task.name,
task_description=task.description,
task_id=task.id
)
if agent_output:
# Store the response in memory
if task.memory:
try:
task.store_in_memory(
content=agent_output,
agent_name=executor_agent.display_name,
task_id=task_id
)
except Exception as e:
logger.error(f"Failed to store agent output in memory: {e}")
task_output = TaskOutput(
description=task.description,
summary=task.description[:10],
raw=agent_output,
agent=executor_agent.display_name,
output_format="RAW"
)
# Add token metrics if available
if llm and hasattr(llm, 'last_token_metrics'):
token_metrics = llm.last_token_metrics
if token_metrics:
task_output.token_metrics = token_metrics
if task.output_json:
cleaned = self.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
task_output.json_dict = parsed
task_output.output_format = "JSON"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as JSON")
logger.debug(f"Output that failed JSON parsing: {agent_output}")
if task.output_pydantic:
cleaned = self.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
pyd_obj = task.output_pydantic(**parsed)
task_output.pydantic = pyd_obj
task_output.output_format = "Pydantic"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as Pydantic Model")
logger.debug(f"Output that failed Pydantic parsing: {agent_output}")
task.result = task_output
return task_output
else:
task.status = "failed"
return None
async def arun_task(self, task_id):
"""Async version of run_task method"""
@@ -1087,7 +993,7 @@ class AgentTeam:
display_error(f"Error saving task output to file: {e}")
def execute_task(self, task_id):
"""Synchronous version of execute_task method - now using DRY helpers"""
"""Synchronous version of execute_task method"""
if task_id not in self.tasks:
display_error(f"Error: Task with ID {task_id} does not exist")
return
@@ -1096,6 +1002,12 @@ class AgentTeam:
logger.info(f"Starting execution of task {task_id}")
logger.info(f"Task config: {task.config}")
# Initialize memory before task execution
if not task.memory:
task.memory = task.initialize_memory()
logger.info(f"Task memory status: {'Initialized' if task.memory else 'Not initialized'}")
# Only import multimodal dependencies if task has images
if task.images and task.status == "not started":
try:
@@ -1111,18 +1023,156 @@ class AgentTeam:
if task.status == "not started":
task.status = "in progress"
# Build execution context using DRY helper
context = _build_execution_context(self, task_id)
executor_agent = task.agent
# Create agent from agent_config if provided and no agent assigned
if executor_agent is None and getattr(task, 'agent_config', None):
executor_agent = self._create_agent_from_config(task.agent_config)
task.agent = executor_agent
# Set current agent for token tracking
llm = getattr(executor_agent, 'llm', None) or getattr(executor_agent, 'llm_instance', None)
if llm and hasattr(llm, 'set_current_agent'):
llm.set_current_agent(executor_agent.display_name)
# Execute with agent using DRY helper
agent_output = _execute_with_agent_sync(
context.executor_agent, context.task_prompt, context.task,
context.tools, stream=self.stream
)
# Ensure tools are available from both task and agent (create copy to avoid mutation)
tools = list(task.tools or [])
if executor_agent and executor_agent.tools:
tools.extend(executor_agent.tools)
# Process result using DRY helper
task_result = _process_task_result(self, context, agent_output)
return task_result.task_output
# Substitute variables in task description if provided
task_description = task.description
if getattr(task, 'variables', None):
for key, value in task.variables.items():
task_description = task_description.replace(f"{{{{{key}}}}}", str(value))
# Build context first to include in task prompt
context_text = ""
if task.context:
context_results = [] # Use list to avoid duplicates
for context_item in task.context:
# Use the centralized helper function
context_str = process_task_context(context_item, self.verbose, self.user_id)
# Only add non-empty context strings
if context_str and context_str.strip():
context_results.append(context_str)
# Join unique context results with proper formatting
unique_contexts = list(dict.fromkeys(context_results)) # Remove duplicates
if self.verbose >= 3:
logger.info(f"Task {task_id} context items: {len(unique_contexts)}")
for i, ctx in enumerate(unique_contexts):
logger.debug(f"Context {i+1}: {ctx[:100]}...")
context_separator = '\n\n'
context_text = context_separator.join(unique_contexts)
# Build task prompt - only use "User Input/Topic" format if there's actual content
if context_text and context_text.strip():
task_prompt = f"""
User Input/Topic: {context_text}
Task: {task_description}
Expected Output: {task.expected_output}
IMPORTANT: Your response must be about the user's input/topic above. Incorporate it into your task."""
else:
task_prompt = f"""
You need to do the following task: {task_description}.
Expected Output: {task.expected_output}."""
# Add memory context if available
if task.memory:
try:
memory_context = task.memory.build_context_for_task(task.description)
if memory_context:
# Log detailed memory context for debugging
logger.debug(f"Memory context for task '{task.description}': {memory_context}")
# Include actual memory content without verbose headers (essential for AI agent functionality)
task_prompt += f"\n\n{memory_context}"
except Exception as e:
logger.error(f"Error getting memory context: {e}")
task_prompt += "\nPlease provide only the final result of your work. Do not add any conversation or extra explanation."
if self.verbose >= 2:
logger.info(f"Executing task {task_id}: {task.description} using {executor_agent.display_name}")
logger.debug(f"Starting execution of task {task_id} with prompt:\n{task_prompt}")
if task.images:
# Use shared multimodal helper (DRY - defined at module level)
agent_output = executor_agent.chat(
get_multimodal_message(task_prompt, task.images),
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
task_name=task.name,
task_description=task.description,
task_id=task_id
)
else:
agent_output = executor_agent.chat(
task_prompt,
tools=tools,
output_json=task.output_json,
output_pydantic=task.output_pydantic,
stream=self.stream,
task_name=task.name,
task_description=task.description,
task_id=task_id
)
if agent_output:
# Store the response in memory
if task.memory:
try:
task.store_in_memory(
content=agent_output,
agent_name=executor_agent.display_name,
task_id=task_id
)
except Exception as e:
logger.error(f"Failed to store agent output in memory: {e}")
task_output = TaskOutput(
description=task.description,
summary=task.description[:10],
raw=agent_output,
agent=executor_agent.display_name,
output_format="RAW"
)
# Add token metrics if available
if llm and hasattr(llm, 'last_token_metrics'):
token_metrics = llm.last_token_metrics
if token_metrics:
task_output.token_metrics = token_metrics
if task.output_json:
cleaned = self.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
task_output.json_dict = parsed
task_output.output_format = "JSON"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as JSON")
logger.debug(f"Output that failed JSON parsing: {agent_output}")
if task.output_pydantic:
cleaned = self.clean_json_output(agent_output)
try:
parsed = json.loads(cleaned)
pyd_obj = task.output_pydantic(**parsed)
task_output.pydantic = pyd_obj
task_output.output_format = "Pydantic"
except Exception:
logger.warning(f"Warning: Could not parse output of task {task_id} as Pydantic Model")
logger.debug(f"Output that failed Pydantic parsing: {agent_output}")
task.result = task_output
return task_output
else:
task.status = "failed"
return None
def run_task(self, task_id):
"""Synchronous version of run_task method"""
@@ -8,7 +8,6 @@ and context. Inspired by Gemini CLI's delegate-to-agent pattern.
import logging
from praisonaiagents._logging import get_logger
import asyncio
import warnings
from dataclasses import dataclass, field
from typing import Any, Dict, List, Optional, Callable
from enum import Enum
@@ -128,12 +127,6 @@ class SubagentDelegator:
agent_factory: Factory function to create agents
on_task_complete: Callback when task completes
"""
warnings.warn(
"SubagentDelegator is deprecated. Use Agent.handoff_to() or "
"parallel_handoffs() instead.",
DeprecationWarning,
stacklevel=2,
)
self.config = config or DelegationConfig()
self.agent_factory = agent_factory
self.on_task_complete = on_task_complete
@@ -1,6 +1,5 @@
"""Agent protocols for extensibility."""
from typing import Any, Awaitable, Dict, List, Optional, Protocol, runtime_checkable
from dataclasses import dataclass
from typing import Any, Dict, List, Optional, Protocol, runtime_checkable
@runtime_checkable
@@ -114,72 +113,3 @@ class DictMerge:
else:
result[key] = value
return result
@dataclass
class ExecutionContext:
"""Unified context for task execution across sync/async boundaries.
Contains all data needed for task execution to eliminate duplication
between sync and async execution paths.
"""
task_id: int
task: Any # Task object
executor_agent: Any # Agent object
tools: List[Any]
task_description: str
context_text: str
task_prompt: str
llm: Any # LLM instance
verbose: int = 0
stream: bool = False
user_id: Optional[str] = None
@dataclass
class TaskResult:
"""Standardized result from task execution."""
task_output: Any # TaskOutput object
success: bool
error: Optional[str] = None
@runtime_checkable
class TaskExecutorProtocol(Protocol):
"""Protocol for unified task execution engine.
Defines the interface for executing tasks in a unified way,
eliminating duplication between async and sync execution paths.
The implementation should handle all business logic including:
- Task validation and status management
- Memory initialization and storage
- Agent execution with tools
- Output processing and result creation
Example:
class MyTaskExecutor:
def execute_task_impl(self, context: ExecutionContext) -> TaskResult:
# Single implementation handles all execution logic
return TaskResult(task_output=result, success=True)
# Check protocol compliance
assert isinstance(MyTaskExecutor(), TaskExecutorProtocol)
"""
def execute_task_impl(
self,
context: ExecutionContext
) -> Awaitable[TaskResult]:
"""Execute a task with unified business logic.
This method contains the single source of truth for task execution
logic, eliminating duplication between sync/async paths.
Args:
context: All context data needed for execution
Returns:
TaskResult containing the output and execution status
"""
...
@@ -50,30 +50,20 @@ logger = get_logger(__name__)
# ── Singleton registry ───────────────────────────────────────────────────────
import threading
_registry: Optional[ApprovalRegistry] = None
_registry_lock = threading.Lock()
def get_approval_registry() -> ApprovalRegistry:
"""Return the global singleton :class:`ApprovalRegistry`."""
global _registry
with _registry_lock:
if _registry is None:
_registry = ApprovalRegistry()
return _registry
if _registry is None:
_registry = ApprovalRegistry()
return _registry
# ── Backward-compatible API (delegates to registry) ─────────────────────────
# These globals are kept for code that imports them directly.
# NOTE: Accessing these will trigger lazy initialization of the registry
def __getattr__(name):
"""Module-level attribute access for lazy initialization."""
if name == "APPROVAL_REQUIRED_TOOLS":
return get_approval_registry()._required_tools
elif name == "TOOL_RISK_LEVELS":
return get_approval_registry()._risk_levels
raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
APPROVAL_REQUIRED_TOOLS: Set[str] = get_approval_registry()._required_tools
TOOL_RISK_LEVELS: Dict[str, str] = get_approval_registry()._risk_levels
# Legacy global callback holder — set_approval_callback wraps it into a backend
approval_callback: Optional[Callable] = None
@@ -124,16 +114,14 @@ def configure_default_approvals() -> None:
reg.add_requirement(tool_name, risk_level)
def add_approval_requirement(tool_name: str, risk_level: str = "high") -> None:
reg = get_approval_registry()
reg.add_requirement(tool_name, risk_level)
reg._required_tools.add(tool_name)
reg._risk_levels[tool_name] = risk_level
get_approval_registry().add_requirement(tool_name, risk_level)
APPROVAL_REQUIRED_TOOLS.add(tool_name)
TOOL_RISK_LEVELS[tool_name] = risk_level
def remove_approval_requirement(tool_name: str) -> None:
reg = get_approval_registry()
reg.remove_requirement(tool_name)
reg._required_tools.discard(tool_name)
reg._risk_levels.pop(tool_name, None)
get_approval_registry().remove_requirement(tool_name)
APPROVAL_REQUIRED_TOOLS.discard(tool_name)
TOOL_RISK_LEVELS.pop(tool_name, None)
def is_approval_required(tool_name: str) -> bool:
return get_approval_registry().is_required(tool_name)
@@ -169,8 +157,8 @@ def require_approval(risk_level: RiskLevel = "high"):
tool_name = getattr(func, '__name__', str(func))
reg = get_approval_registry()
reg.add_requirement(tool_name, risk_level)
reg._required_tools.add(tool_name)
reg._risk_levels[tool_name] = risk_level
APPROVAL_REQUIRED_TOOLS.add(tool_name)
TOOL_RISK_LEVELS[tool_name] = risk_level
@wraps(func)
def wrapper(*args, **kwargs):
@@ -217,11 +217,7 @@ class CheckpointService:
cwd=self.config.workspace_dir
)
try:
stdout, stderr = await asyncio.wait_for(process.communicate(), timeout=30)
except asyncio.TimeoutError:
process.kill()
raise RuntimeError(f"Git command timed out after 30 seconds: {' '.join(args)}")
stdout, stderr = await process.communicate()
if process.returncode != 0:
error_msg = stderr.decode().strip()
@@ -90,14 +90,6 @@ __all__ = [
"ConfigEntry",
"getenv_cached",
"clear_env_cache",
# Configuration schema protocols (NEW)
"ConfigSchemaProtocol",
"ConfigMappingProtocol",
"ConfigValidatorProtocol",
"ConfigMergerProtocol",
"ValidationResult",
"CliMapping",
"PrecedenceChain",
]
# Module mapping for lazy loading
@@ -171,14 +163,6 @@ _MODULE_MAP = {
"ConfigEntry": "resolver",
"getenv_cached": "resolver",
"clear_env_cache": "resolver",
# protocols
"ConfigSchemaProtocol": "protocols",
"ConfigMappingProtocol": "protocols",
"ConfigValidatorProtocol": "protocols",
"ConfigMergerProtocol": "protocols",
"ValidationResult": "protocols",
"CliMapping": "protocols",
"PrecedenceChain": "protocols",
}
@@ -626,16 +626,6 @@ class OutputConfig:
# Example: "# {{title}}\n\n{{content}}\n\n---\nGenerated by AI"
template: Optional[str] = None
# Tool output limit - maximum characters for tool output
# Default: 16000 chars (≈ 4000 tokens) to prevent runaway tool outputs
tool_output_limit: int = 16000
def __post_init__(self) -> None:
if not isinstance(self.tool_output_limit, int) or self.tool_output_limit <= 0:
raise ValueError(
"OutputConfig.tool_output_limit must be a positive integer."
)
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary."""
return {
@@ -652,7 +642,6 @@ class OutputConfig:
"editor_output": self.editor_output,
"output_file": self.output_file,
"template": self.template,
"tool_output_limit": self.tool_output_limit,
}
@@ -30,6 +30,7 @@ import os
from pathlib import Path
from typing import Any, Dict, List, Optional, Union
from dataclasses import dataclass, field
from functools import lru_cache
# ============================================================================
@@ -331,6 +332,7 @@ def get_plugins_config() -> PluginsConfig:
return get_config().plugins
@lru_cache(maxsize=1)
def get_defaults_config() -> DefaultsConfig:
"""Get defaults configuration.
@@ -300,9 +300,9 @@ CONTEXT_PRESETS: Dict[str, Dict[str, Any]] = {
# =============================================================================
AUTONOMY_PRESETS: Dict[str, Dict[str, Any]] = {
"suggest": {"level": "suggest"},
"auto_edit": {"level": "auto_edit"},
"full_auto": {"level": "full_auto"},
"suggest": {"mode": "suggest"},
"auto_edit": {"mode": "auto_edit"},
"full_auto": {"mode": "full_auto"},
}
@@ -1,291 +0,0 @@
"""
Configuration Schema Protocols for PraisonAI Agents.
Core protocols for unified configuration schema validation and mapping.
These protocols define the contract for configuration schema providers
without heavy implementations (following protocol-driven architecture).
"""
from typing import Any, Dict, List, Optional, Protocol, Tuple, runtime_checkable
from dataclasses import dataclass
@dataclass
class ValidationResult:
"""
Result of configuration validation.
Attributes:
is_valid: Whether the configuration is valid
errors: List of validation error messages
warnings: List of validation warning messages
normalized: Normalized configuration (after applying defaults, etc.)
"""
is_valid: bool
errors: List[str]
warnings: List[str] = None
normalized: Optional[Dict[str, Any]] = None
def __post_init__(self):
if self.warnings is None:
self.warnings = []
@dataclass
class CliMapping:
"""
Mapping between configuration field and CLI flag.
Attributes:
field_name: Name of the configuration field
cli_flag: CLI flag name (without --)
description: Help text for CLI flag
type_hint: Python type for CLI argument parsing
default: Default value if not provided
choices: Valid choices for enum/choice fields
env_var: Environment variable name (optional)
"""
field_name: str
cli_flag: str
description: str
type_hint: type
default: Any = None
choices: Optional[List[str]] = None
env_var: Optional[str] = None
@dataclass
class PrecedenceChain:
"""
Documented precedence chain for configuration resolution.
Attributes:
chain: List of source names in precedence order (highest to lowest)
descriptions: Dict mapping source names to descriptions
"""
chain: List[str]
descriptions: Dict[str, str]
def __post_init__(self):
# Validate chain is non-empty
if not self.chain:
raise ValueError("Precedence chain cannot be empty")
# Ensure all chain items have descriptions
for source in self.chain:
if source not in self.descriptions:
self.descriptions[source] = f"Configuration from {source}"
@runtime_checkable
class ConfigSchemaProtocol(Protocol):
"""
Protocol for configuration schema providers.
Defines the interface for configuration schema validation, CLI mapping,
and precedence chain documentation. Implementations should provide
concrete schema validation and mapping logic.
This protocol enables:
- Schema-driven CLI generation
- Guaranteed CLI/YAML/Python mapping
- Single documented precedence chain
- Strong validation with user-friendly errors
"""
def validate(self, config: Dict[str, Any]) -> ValidationResult:
"""
Validate configuration against schema.
Args:
config: Configuration dictionary to validate
Returns:
ValidationResult with validation status and any errors/warnings
"""
...
def get_cli_mapping(self) -> List[CliMapping]:
"""
Get CLI flag mappings derived from schema.
Returns:
List of CliMapping objects defining CLI flags
"""
...
def get_precedence_chain(self) -> PrecedenceChain:
"""
Get documented precedence chain for configuration resolution.
Returns:
PrecedenceChain defining resolution order and descriptions
"""
...
def normalize_config(self, config: Dict[str, Any]) -> Dict[str, Any]:
"""
Normalize configuration by applying defaults and transformations.
Args:
config: Raw configuration dictionary
Returns:
Normalized configuration dictionary
"""
...
def get_schema_info(self) -> Dict[str, Any]:
"""
Get schema metadata for documentation and introspection.
Returns:
Dict containing schema information (fields, types, descriptions, etc.)
"""
...
@runtime_checkable
class ConfigMappingProtocol(Protocol):
"""
Protocol for configuration field mapping and transformation.
Handles mapping between different configuration interfaces:
- YAML field names (e.g., 'role', 'backstory')
- Python API field names (e.g., 'name', 'instructions')
- CLI flag names (e.g., '--agent-role', '--agent-backstory')
"""
def yaml_to_python(self, yaml_config: Dict[str, Any]) -> Dict[str, Any]:
"""
Map YAML configuration to Python API format.
Args:
yaml_config: Configuration from YAML file
Returns:
Configuration mapped to Python API field names
"""
...
def python_to_yaml(self, python_config: Dict[str, Any]) -> Dict[str, Any]:
"""
Map Python API configuration to YAML format.
Args:
python_config: Configuration from Python API
Returns:
Configuration mapped to YAML field names
"""
...
def cli_to_python(self, cli_args: Dict[str, Any]) -> Dict[str, Any]:
"""
Map CLI arguments to Python API format.
Args:
cli_args: Parsed CLI arguments
Returns:
Configuration mapped to Python API field names
"""
...
def get_field_aliases(self) -> Dict[str, List[str]]:
"""
Get field name aliases for backward compatibility.
Returns:
Dict mapping canonical field names to lists of aliases
"""
...
@runtime_checkable
class ConfigValidatorProtocol(Protocol):
"""
Protocol for configuration validation with helpful error messages.
Provides detailed validation with suggestions for fixing common mistakes.
"""
def validate_with_suggestions(self, config: Dict[str, Any]) -> ValidationResult:
"""
Validate configuration with suggestions for fixing errors.
Args:
config: Configuration to validate
Returns:
ValidationResult with detailed error messages and suggestions
"""
...
def suggest_corrections(self, field_name: str, invalid_value: Any) -> List[str]:
"""
Suggest corrections for invalid field values.
Args:
field_name: Name of the invalid field
invalid_value: The invalid value provided
Returns:
List of suggested corrections
"""
...
def check_field_conflicts(self, config: Dict[str, Any]) -> List[str]:
"""
Check for conflicting configuration fields.
Args:
config: Configuration to check
Returns:
List of conflict error messages
"""
...
@runtime_checkable
class ConfigMergerProtocol(Protocol):
"""
Protocol for merging configurations from multiple sources with precedence.
Implements the single documented precedence chain for config resolution.
"""
def merge_configs(
self,
sources: Dict[str, Dict[str, Any]],
precedence_chain: List[str]
) -> Tuple[Dict[str, Any], List[str]]:
"""
Merge configurations from multiple sources with precedence.
Args:
sources: Dict mapping source names to configuration dicts
precedence_chain: List of source names in precedence order (highest to lowest)
Returns:
Tuple of (merged_config, resolution_log)
"""
...
def resolve_conflicts(
self,
field_name: str,
values: Dict[str, Any]
) -> Tuple[Any, str]:
"""
Resolve conflicts between multiple values for a field.
Args:
field_name: Name of the conflicting field
values: Dict mapping source names to values
Returns:
Tuple of (resolved_value, resolution_reason)
"""
...
@@ -291,20 +291,7 @@ class MultiAgentLedger:
self._shared_tokens: int = 0 # Tokens shared across agents
def get_agent_ledger(self, agent_id: str) -> ContextLedgerManager:
"""Get or create ledger for an agent.
Args:
agent_id: Unique identifier for the agent.
Returns:
ContextLedgerManager for this agent.
Raises:
ValueError: If agent_id is empty or contains only whitespace.
"""
if not agent_id or not agent_id.strip():
raise ValueError("agent_id must be a non-empty string")
"""Get or create ledger for an agent."""
if agent_id not in self._agents:
self._agents[agent_id] = ContextLedgerManager(agent_id)
return self._agents[agent_id]
@@ -514,10 +514,7 @@ class ContextMonitor:
return str(output_path)
def _get_output_path(self, agent_name: str = "") -> Path:
"""Get output path, optionally per-agent.
Security: Agent names are sanitized to prevent path traversal.
"""
"""Get output path, optionally per-agent."""
if not self.multi_agent_files or not agent_name:
return self.path
@@ -525,32 +522,10 @@ class ContextMonitor:
stem = self.path.stem
suffix = self.path.suffix or (".json" if self.format == "json" else ".txt")
# Sanitize agent name:
# 1. Strip any path separators first (defence in depth)
safe_name = agent_name.replace('/', '_').replace('\\', '_')
# 2. Collapse to safe chars only
safe_name = re.sub(r'[^\w\-]', '_', safe_name.lower())
# 3. Enforce length limit to prevent filesystem issues
safe_name = safe_name[:64] if safe_name else 'unknown'
# 4. Strip leading/trailing underscores / dots
safe_name = safe_name.strip('_.')
if not safe_name:
safe_name = 'unknown'
# Sanitize agent name
safe_name = re.sub(r'[^\w\-]', '_', agent_name.lower())
result = self.path.parent / f"{stem}_{safe_name}{suffix}"
# Verify the resolved path stays within the expected parent dir
resolved = result.resolve()
parent_resolved = self.path.parent.resolve()
try:
resolved.relative_to(parent_resolved)
except ValueError:
# Fallback to a safe hash-based name
import hashlib
hash_name = hashlib.sha256(agent_name.encode()).hexdigest()[:16]
result = self.path.parent / f"{stem}_{hash_name}{suffix}"
return result
return self.path.parent / f"{stem}_{safe_name}{suffix}"
def _get_warnings(
self,
@@ -1,345 +0,0 @@
"""
Structured exception hierarchy for PraisonAI SDK.
Provides uniform error semantics for consistent handling across:
- Multi-agent orchestration
- Tool execution
- LLM interactions
- Memory operations
- External integrations
"""
from typing import Literal, Protocol, runtime_checkable, Optional, Dict, Any
import uuid
@runtime_checkable
class ErrorContextProtocol(Protocol):
"""Protocol for structured error context propagation."""
agent_id: str
run_id: str
is_retryable: bool
error_category: Literal["tool", "llm", "budget", "validation", "network", "handoff"]
class PraisonAIError(Exception):
"""
Base error class with structured context for PraisonAI SDK.
All PraisonAI errors inherit from this to ensure uniform error handling,
context propagation, and observability hooks.
"""
def __init__(
self,
message: str,
agent_id: str = "unknown",
run_id: Optional[str] = None,
error_category: Literal["tool", "llm", "budget", "validation", "network", "handoff"] = "validation",
is_retryable: bool = False,
context: Optional[Dict[str, Any]] = None
):
super().__init__(message)
self.message = message
self.agent_id = agent_id
self.run_id = run_id or str(uuid.uuid4())
self.error_category = error_category
self.is_retryable = is_retryable
self.context = context or {}
def __str__(self) -> str:
return f"[{self.error_category}] {self.message} (agent: {self.agent_id}, run: {self.run_id})"
class ToolExecutionError(PraisonAIError):
"""
Tool execution failed.
Includes tool name and execution context for better debugging
and selective retry policies.
"""
def __init__(
self,
message: str,
tool_name: str = "unknown",
agent_id: str = "unknown",
run_id: Optional[str] = None,
is_retryable: bool = True, # Most tool errors are retryable
context: Optional[Dict[str, Any]] = None
):
context = context or {}
context["tool_name"] = tool_name
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="tool",
is_retryable=is_retryable,
context=context
)
self.tool_name = tool_name
class LLMError(PraisonAIError):
"""
LLM interaction failed.
Distinguishes between rate limits (retryable) vs model errors (fatal).
"""
def __init__(
self,
message: str,
model_name: str = "unknown",
agent_id: str = "unknown",
run_id: Optional[str] = None,
is_retryable: bool = False, # Default to non-retryable unless specified
context: Optional[Dict[str, Any]] = None
):
context = context or {}
context["model_name"] = model_name
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="llm",
is_retryable=is_retryable,
context=context
)
self.model_name = model_name
class BudgetExceededError(PraisonAIError):
"""
Budget limits exceeded (tokens, time, etc).
Generally not retryable without intervention.
"""
def __init__(
self,
message_or_agent_name,
total_cost_or_budget_type = None,
max_budget_or_limit = None,
budget_type: str = "tokens",
limit: Optional[float] = None,
used: Optional[float] = None,
agent_id: str = "unknown",
run_id: Optional[str] = None,
context: Optional[Dict[str, Any]] = None
):
# Handle backward compatibility: old constructor BudgetExceededError(agent_name, total_cost, max_budget)
if (isinstance(message_or_agent_name, str) and
isinstance(total_cost_or_budget_type, (int, float)) and
isinstance(max_budget_or_limit, (int, float)) and
budget_type == "tokens"): # Default value indicates old constructor
# Old constructor format
agent_name = message_or_agent_name
total_cost = float(total_cost_or_budget_type)
max_budget = float(max_budget_or_limit)
message = f"Agent '{agent_name}' exceeded budget: ${total_cost:.4f} >= ${max_budget:.4f}"
context = context or {}
context.update({
"budget_type": "cost", # Legacy errors are cost-based
"limit": max_budget,
"used": total_cost
})
super().__init__(
message,
agent_id=agent_name,
run_id=run_id,
error_category="budget",
is_retryable=False,
context=context
)
self.budget_type = "cost"
self.limit = max_budget
self.used = total_cost
self.agent_name = agent_name
self.total_cost = total_cost
self.max_budget = max_budget
else:
# New constructor format
message = str(message_or_agent_name)
if total_cost_or_budget_type is not None and isinstance(total_cost_or_budget_type, str):
budget_type = total_cost_or_budget_type
if max_budget_or_limit is not None:
if limit is None:
limit = max_budget_or_limit
context = context or {}
context.update({
"budget_type": budget_type,
"limit": limit,
"used": used
})
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="budget",
is_retryable=False,
context=context
)
self.budget_type = budget_type
self.limit = limit
self.used = used
# Legacy attributes for backward compatibility
self.agent_name = agent_id
self.total_cost = used
self.max_budget = limit
class ValidationError(PraisonAIError):
"""
Input validation failed.
Usually indicates programming errors, not retryable.
"""
def __init__(
self,
message: str,
field_name: Optional[str] = None,
agent_id: str = "unknown",
run_id: Optional[str] = None,
context: Optional[Dict[str, Any]] = None
):
context = context or {}
if field_name:
context["field_name"] = field_name
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="validation",
is_retryable=False, # Validation errors need code fixes
context=context
)
self.field_name = field_name
class NetworkError(PraisonAIError):
"""
Network/external service error.
Often retryable with backoff.
"""
def __init__(
self,
message: str,
service_name: str = "unknown",
status_code: Optional[int] = None,
agent_id: str = "unknown",
run_id: Optional[str] = None,
is_retryable: bool = True, # Most network errors are retryable
context: Optional[Dict[str, Any]] = None
):
context = context or {}
context.update({
"service_name": service_name,
"status_code": status_code
})
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="network",
is_retryable=is_retryable,
context=context
)
self.service_name = service_name
self.status_code = status_code
class HandoffError(PraisonAIError):
"""
Agent handoff/delegation failed.
Includes source/target agent context for multi-agent debugging.
"""
def __init__(
self,
message: str,
source_agent: str = "unknown",
target_agent: Optional[str] = None,
agent_id: str = "unknown",
run_id: Optional[str] = None,
is_retryable: bool = False, # Handoff errors usually need investigation
context: Optional[Dict[str, Any]] = None
):
context = context or {}
context.update({
"source_agent": source_agent,
"target_agent": target_agent
})
super().__init__(
message,
agent_id=agent_id,
run_id=run_id,
error_category="handoff",
is_retryable=is_retryable,
context=context
)
self.source_agent = source_agent
self.target_agent = target_agent
# Specialized handoff errors (maintain backward compatibility)
class HandoffCycleError(HandoffError):
"""Circular handoff dependency detected."""
def __init__(self, message: str, cycle_path: Optional[list] = None, **kwargs):
super().__init__(message, **kwargs)
if cycle_path:
self.context["cycle_path"] = cycle_path
# Backward compatibility alias
self.chain = cycle_path
class HandoffDepthError(HandoffError):
"""Maximum handoff depth exceeded."""
def __init__(self, message: str, max_depth: Optional[int] = None, current_depth: Optional[int] = None, **kwargs):
super().__init__(message, **kwargs)
self.context.update({
"max_depth": max_depth,
"current_depth": current_depth
})
# Backward compatibility aliases
self.max_depth = max_depth
self.depth = current_depth
class HandoffTimeoutError(HandoffError):
"""Handoff operation timed out."""
def __init__(self, message: str, timeout_seconds: Optional[float] = None, **kwargs):
super().__init__(message, is_retryable=True, **kwargs) # Timeouts may be retryable
if timeout_seconds:
self.context["timeout_seconds"] = timeout_seconds
# Backward compatibility alias
self.timeout = timeout_seconds
# Export all error types for easy importing
__all__ = [
"ErrorContextProtocol",
"PraisonAIError",
"ToolExecutionError",
"LLMError",
"BudgetExceededError",
"ValidationError",
"NetworkError",
"HandoffError",
"HandoffCycleError",
"HandoffDepthError",
"HandoffTimeoutError"
]
@@ -291,6 +291,21 @@ class ObservabilityHooks:
"final_stage": self._current_stage.name if self._current_stage else None,
}
# NOTE: Observability is now per-agent/per-pipeline to comply with multi-agent safety.
# Each agent creates its own ObservabilityHooks instance when observe=True.
# See agent.py:2236 for the correct per-instance pattern.
# Global hooks instance (opt-in)
_global_hooks: Optional[ObservabilityHooks] = None
def get_hooks() -> Optional[ObservabilityHooks]:
"""Get global observability hooks."""
return _global_hooks
def enable_observability() -> ObservabilityHooks:
"""Enable global observability."""
global _global_hooks
if _global_hooks is None:
_global_hooks = ObservabilityHooks(enabled=True)
return _global_hooks
def disable_observability():
"""Disable global observability."""
global _global_hooks
_global_hooks = None
@@ -218,9 +218,6 @@ class EvalSuite:
if hasattr(eval_result, 'avg_score'):
return float(eval_result.avg_score)
if hasattr(eval_result, 'safety_score'):
return float(eval_result.safety_score)
# Try to extract from result dictionary
if isinstance(eval_result, dict):
@@ -5,7 +5,6 @@ Manages registration and lookup of hooks for different events.
"""
import logging
import threading
from praisonaiagents._logging import get_logger
from typing import Dict, List, Optional, Callable, Union
from functools import wraps
@@ -320,21 +319,18 @@ class HookRegistry:
# Global default registry
_default_registry: Optional[HookRegistry] = None
_default_registry_lock = threading.Lock()
def get_default_registry() -> HookRegistry:
"""Get the default global hook registry."""
global _default_registry
with _default_registry_lock:
if _default_registry is None:
_default_registry = HookRegistry()
return _default_registry
if _default_registry is None:
_default_registry = HookRegistry()
return _default_registry
def set_default_registry(registry: HookRegistry):
"""Set the default global hook registry."""
global _default_registry
with _default_registry_lock:
_default_registry = registry
_default_registry = registry
# =============================================================================
# Simplified API (beginner-friendly aliases)
@@ -4,8 +4,7 @@ Knowledge Store Adapters for PraisonAI Agents.
Provides adapter implementations for various knowledge backends.
All adapters implement KnowledgeStoreProtocol.
Adapters are now registered via the adapter registry to enable
protocol-driven knowledge backend resolution.
Adapters are lazy-loaded to avoid importing heavy dependencies.
"""
from typing import TYPE_CHECKING
@@ -13,33 +12,7 @@ from typing import TYPE_CHECKING
if TYPE_CHECKING:
from .mem0_adapter import Mem0Adapter
# Import registry functions
from .registry import (
register_knowledge_adapter,
register_knowledge_factory,
get_knowledge_adapter,
list_knowledge_adapters,
get_first_available_knowledge_adapter,
has_knowledge_adapter,
)
# Import factory functions for heavy adapters
from .factories import (
create_mem0_knowledge_adapter,
create_mongodb_knowledge_adapter,
create_chroma_knowledge_adapter,
create_sqlite_knowledge_adapter,
)
# Register core adapter factories (lightweight, no heavy dependencies)
register_knowledge_factory("sqlite", create_sqlite_knowledge_adapter)
# Register heavy adapter factories (lazy-loaded via factories)
register_knowledge_factory("mem0", create_mem0_knowledge_adapter)
register_knowledge_factory("mongodb", create_mongodb_knowledge_adapter)
register_knowledge_factory("chroma", create_chroma_knowledge_adapter)
# Lazy loading for adapters (backward compatibility)
# Lazy loading for adapters
_LAZY_IMPORTS = {
"Mem0Adapter": ("praisonaiagents.knowledge.adapters.mem0_adapter", "Mem0Adapter"),
"MongoDBKnowledgeAdapter": ("praisonaiagents.knowledge.adapters.mongodb_adapter", "MongoDBKnowledgeAdapter"),
@@ -58,24 +31,10 @@ def __getattr__(name: str):
def __dir__():
"""List available attributes."""
return list(_LAZY_IMPORTS.keys()) + [
"register_knowledge_adapter",
"register_knowledge_factory",
"get_knowledge_adapter",
"list_knowledge_adapters",
"get_first_available_knowledge_adapter",
"has_knowledge_adapter",
]
return list(_LAZY_IMPORTS.keys())
__all__ = [
"Mem0Adapter",
"MongoDBKnowledgeAdapter",
# Registry functions
"register_knowledge_adapter",
"register_knowledge_factory",
"get_knowledge_adapter",
"list_knowledge_adapters",
"get_first_available_knowledge_adapter",
"has_knowledge_adapter",
]
@@ -1,603 +0,0 @@
"""
Knowledge Adapter Factory Functions
Provides factory functions for heavy knowledge adapters that replace hardcoded imports
in knowledge/knowledge.py. These enable lazy loading of heavy dependencies while maintaining
the protocol-driven architecture.
Each factory function:
1. Lazy imports the required dependencies
2. Creates and returns an adapter instance that implements KnowledgeStoreProtocol
3. Raises clear ImportError with installation instructions if dependencies missing
This approach follows the protocol-driven core principle by moving heavy implementations
out of the core Knowledge class while preserving backward compatibility.
"""
import os
from typing import Any, Dict, List, Optional
from ..protocols import KnowledgeStoreProtocol
def create_mem0_knowledge_adapter(**kwargs) -> KnowledgeStoreProtocol:
"""
Factory function to create Mem0 knowledge adapter.
Lazy imports mem0 and creates an adapter that wraps mem0.Memory
to implement KnowledgeStoreProtocol.
Args:
**kwargs: Configuration passed to mem0 Memory
Returns:
KnowledgeStoreProtocol adapter instance
Raises:
ImportError: If mem0 is not installed
"""
try:
# Lazy import - only when actually needed
from .mem0_adapter import Mem0Adapter
return Mem0Adapter(**kwargs)
except ImportError:
raise ImportError(
"mem0 is required for mem0 knowledge adapter. Install with: pip install mem0ai"
)
def create_mongodb_knowledge_adapter(**kwargs) -> KnowledgeStoreProtocol:
"""
Factory function to create MongoDB knowledge adapter.
Lazy imports pymongo and creates an adapter that implements KnowledgeStoreProtocol
using MongoDB as the document store backend.
Args:
**kwargs: Configuration passed to MongoDB adapter
Returns:
KnowledgeStoreProtocol adapter instance
Raises:
ImportError: If pymongo is not installed
"""
try:
# Lazy import - only when actually needed
from .mongodb_adapter import MongoDBKnowledgeAdapter
return MongoDBKnowledgeAdapter(**kwargs)
except ImportError:
raise ImportError(
"pymongo is required for mongodb knowledge adapter. Install with: pip install pymongo"
)
def create_chroma_knowledge_adapter(**kwargs) -> KnowledgeStoreProtocol:
"""
Factory function to create ChromaDB knowledge adapter.
Lazy imports chromadb and markitdown dependencies then creates an adapter
that implements KnowledgeStoreProtocol using ChromaDB as the vector store backend.
Args:
**kwargs: Configuration passed to ChromaDB adapter
Returns:
KnowledgeStoreProtocol adapter instance
Raises:
ImportError: If chromadb or markitdown are not installed
"""
try:
import chromadb
from markitdown import MarkItDown
except ImportError:
raise ImportError(
"chromadb and markitdown are required for chroma knowledge adapter. "
"Install with: pip install chromadb markitdown"
)
return ChromaKnowledgeAdapter(chromadb=chromadb, markitdown=MarkItDown(), **kwargs)
class ChromaKnowledgeAdapter:
"""
Knowledge adapter that uses ChromaDB to implement KnowledgeStoreProtocol.
This adapter replaces the hardcoded chromadb import in knowledge.py (lines 77-78).
"""
def __init__(self, chromadb, markitdown, **kwargs):
"""Initialize ChromaDB knowledge adapter."""
self.chromadb = chromadb
self.markitdown = markitdown
# Configuration
config = kwargs.get("config", {})
vector_config = config.get("vector_store", {}).get("config", {})
collection_name = vector_config.get("collection_name", "praisonai_knowledge")
persist_dir = vector_config.get("path", "knowledge_db")
os.makedirs(persist_dir, exist_ok=True)
# Initialize ChromaDB client
self.client = chromadb.PersistentClient(
path=persist_dir,
settings=chromadb.config.Settings(anonymized_telemetry=False)
)
# Initialize collection
try:
self.collection = self.client.get_collection(name=collection_name)
except Exception:
self.collection = self.client.create_collection(
name=collection_name,
metadata={"hnsw:space": "cosine"}
)
def search(self, query: str, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, limit: int = 10, filters: Optional[Dict[str, Any]] = None,
**kwargs: Any):
"""Search for relevant content in ChromaDB."""
from ..models import SearchResult, SearchResultItem
# Get embedding for query
try:
from praisonaiagents.embedding import embedding
result = embedding(query, model="text-embedding-3-small")
query_embedding = result.embeddings[0] if result.embeddings else None
except Exception:
query_embedding = None
if query_embedding is None:
return SearchResult(results=[])
# Build where filters for scoped search
where_filter = {}
if user_id is not None:
where_filter["user_id"] = user_id
if agent_id is not None:
where_filter["agent_id"] = agent_id
if run_id is not None:
where_filter["run_id"] = run_id
# Merge with additional filters
if filters:
where_filter.update(filters)
# Search ChromaDB
try:
query_kwargs = {
"query_embeddings": [query_embedding],
"n_results": limit,
"include": ["documents", "metadatas", "distances"]
}
# Add where filter if any conditions specified
if where_filter:
query_kwargs["where"] = where_filter
response = self.collection.query(**query_kwargs)
items = []
if response["ids"]:
for i in range(len(response["ids"][0])):
metadata = response["metadatas"][0][i] if "metadatas" in response else {}
# Ensure metadata is dict, never None (required by protocol)
metadata = metadata or {}
score = 1.0 - (response["distances"][0][i] if "distances" in response else 0.0)
items.append(SearchResultItem(
id=response["ids"][0][i],
text=response["documents"][0][i],
metadata=metadata,
score=score
))
return SearchResult(results=items)
except Exception as e:
return SearchResult(results=[])
def add(self, content: Any, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None,
**kwargs: Any):
"""Add content to ChromaDB."""
from ..models import AddResult
# Convert content to string
content_str = str(content)
# Get embedding
try:
from praisonaiagents.embedding import embedding
result = embedding(content_str, model="text-embedding-3-small")
content_embedding = result.embeddings[0] if result.embeddings else None
except Exception:
content_embedding = None
if content_embedding is None:
return AddResult(success=False, message="Failed to generate embedding")
# Generate ID and store
import time
doc_id = str(time.time_ns())
# Prepare metadata
doc_metadata = metadata or {}
if user_id:
doc_metadata["user_id"] = user_id
if agent_id:
doc_metadata["agent_id"] = agent_id
if run_id:
doc_metadata["run_id"] = run_id
try:
self.collection.add(
documents=[content_str],
metadatas=[doc_metadata],
ids=[doc_id],
embeddings=[content_embedding]
)
return AddResult(success=True, id=doc_id)
except Exception as e:
return AddResult(success=False, message=str(e))
def get(self, item_id: str, **kwargs: Any):
"""Get a specific item by ID from ChromaDB."""
from ..models import SearchResultItem
try:
response = self.collection.get(
ids=[item_id],
include=["documents", "metadatas"]
)
if response["ids"] and len(response["ids"]) > 0:
metadata = response["metadatas"][0] if "metadatas" in response else {}
# Ensure metadata is dict, never None
metadata = metadata or {}
return SearchResultItem(
id=response["ids"][0],
text=response["documents"][0],
metadata=metadata,
score=1.0
)
return None
except Exception:
return None
def get_all(self, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, limit: int = 100, **kwargs: Any):
"""Get all items from ChromaDB."""
from ..models import SearchResult, SearchResultItem
try:
# ChromaDB doesn't support get_all with filters easily, so we'll use peek
response = self.collection.peek(limit=limit)
items = []
if response["ids"]:
for i in range(len(response["ids"])):
metadata = response["metadatas"][i] if "metadatas" in response else {}
# Ensure metadata is dict, never None
metadata = metadata or {}
# Apply filtering if specified
if user_id and metadata.get("user_id") != user_id:
continue
if agent_id and metadata.get("agent_id") != agent_id:
continue
if run_id and metadata.get("run_id") != run_id:
continue
items.append(SearchResultItem(
id=response["ids"][i],
text=response["documents"][i],
metadata=metadata,
score=1.0
))
return SearchResult(results=items)
except Exception:
return SearchResult(results=[])
def update(self, item_id: str, content: Any, **kwargs: Any):
"""Update an existing item in ChromaDB."""
from ..models import AddResult
# ChromaDB doesn't support direct updates, so we delete and re-add
try:
self.collection.delete(ids=[item_id])
return self.add(content, **kwargs)
except Exception as e:
return AddResult(success=False, message=str(e))
def delete(self, item_id: str, **kwargs: Any) -> bool:
"""Delete an item by ID from ChromaDB."""
try:
self.collection.delete(ids=[item_id])
return True
except Exception:
return False
def delete_all(self, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, **kwargs: Any) -> bool:
"""Delete all items matching scope from ChromaDB."""
try:
if not any([user_id, agent_id, run_id]):
# Delete entire collection
collection_name = self.collection.name
self.client.delete_collection(collection_name)
# Recreate the collection to keep adapter usable
self.collection = self.client.create_collection(
name=collection_name,
metadata={"hnsw:space": "cosine"}
)
return True
else:
# Get filtered items and delete them
all_items = self.get_all(user_id=user_id, agent_id=agent_id, run_id=run_id)
item_ids = [item.id for item in all_items.results]
if item_ids:
self.collection.delete(ids=item_ids)
return True
except Exception:
return False
def create_sqlite_knowledge_adapter(**kwargs) -> KnowledgeStoreProtocol:
"""
Factory function to create SQLite knowledge adapter.
Creates a lightweight SQLite-based knowledge adapter for core usage.
Args:
**kwargs: Configuration passed to SQLite adapter
Returns:
KnowledgeStoreProtocol adapter instance
"""
return SQLiteKnowledgeAdapter(**kwargs)
class SQLiteKnowledgeAdapter:
"""
Lightweight SQLite-based knowledge adapter implementing KnowledgeStoreProtocol.
This provides a core adapter that doesn't require heavy dependencies.
"""
def __init__(self, **kwargs):
"""Initialize SQLite knowledge adapter."""
import sqlite3
import json
import threading
self.db_path = kwargs.get("db_path", "knowledge.db")
self._local = threading.local()
self._lock = threading.Lock()
# Initialize database
self._init_db()
def _init_db(self):
"""Initialize SQLite database."""
conn = self._get_conn()
conn.execute("""
CREATE TABLE IF NOT EXISTS knowledge (
id TEXT PRIMARY KEY,
content TEXT NOT NULL,
metadata TEXT,
user_id TEXT,
agent_id TEXT,
run_id TEXT,
created_at REAL
)
""")
conn.commit()
def _get_conn(self):
"""Get thread-local SQLite connection."""
if not hasattr(self._local, 'conn'):
import sqlite3
self._local.conn = sqlite3.connect(self.db_path)
return self._local.conn
def search(self, query: str, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, limit: int = 10, filters: Optional[Dict[str, Any]] = None,
**kwargs: Any):
"""Search for relevant content in SQLite."""
from ..models import SearchResult, SearchResultItem
import json
conn = self._get_conn()
# Build query with filters
sql = "SELECT id, content, metadata FROM knowledge WHERE content LIKE ?"
params = [f"%{query}%"]
if user_id:
sql += " AND user_id = ?"
params.append(user_id)
if agent_id:
sql += " AND agent_id = ?"
params.append(agent_id)
if run_id:
sql += " AND run_id = ?"
params.append(run_id)
sql += " LIMIT ?"
params.append(limit)
cursor = conn.execute(sql, params)
rows = cursor.fetchall()
items = []
for row in rows:
metadata = json.loads(row[2] or "{}")
items.append(SearchResultItem(
id=row[0],
text=row[1],
metadata=metadata,
score=1.0
))
return SearchResult(results=items)
def add(self, content: Any, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None,
**kwargs: Any):
"""Add content to SQLite."""
from ..models import AddResult
import json
import time
content_str = str(content)
doc_id = str(time.time_ns())
metadata_json = json.dumps(metadata or {})
try:
conn = self._get_conn()
conn.execute(
"INSERT INTO knowledge (id, content, metadata, user_id, agent_id, run_id, created_at) "
"VALUES (?, ?, ?, ?, ?, ?, ?)",
(doc_id, content_str, metadata_json, user_id, agent_id, run_id, time.time())
)
conn.commit()
return AddResult(success=True, id=doc_id)
except Exception as e:
return AddResult(success=False, message=str(e))
def get(self, item_id: str, **kwargs: Any):
"""Get a specific item by ID from SQLite."""
from ..models import SearchResultItem
import json
conn = self._get_conn()
cursor = conn.execute("SELECT id, content, metadata FROM knowledge WHERE id = ?", (item_id,))
row = cursor.fetchone()
if row:
metadata = json.loads(row[2] or "{}")
return SearchResultItem(
id=row[0],
text=row[1],
metadata=metadata,
score=1.0
)
return None
def get_all(self, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, limit: int = 100, **kwargs: Any):
"""Get all items from SQLite."""
from ..models import SearchResult, SearchResultItem
import json
conn = self._get_conn()
# Build query with filters
sql = "SELECT id, content, metadata FROM knowledge WHERE 1=1"
params = []
if user_id:
sql += " AND user_id = ?"
params.append(user_id)
if agent_id:
sql += " AND agent_id = ?"
params.append(agent_id)
if run_id:
sql += " AND run_id = ?"
params.append(run_id)
sql += " LIMIT ?"
params.append(limit)
cursor = conn.execute(sql, params)
rows = cursor.fetchall()
items = []
for row in rows:
metadata = json.loads(row[2] or "{}")
items.append(SearchResultItem(
id=row[0],
text=row[1],
metadata=metadata,
score=1.0
))
return SearchResult(results=items)
def update(self, item_id: str, content: Any, **kwargs: Any):
"""Update an existing item in SQLite."""
from ..models import AddResult
import json
content_str = str(content)
metadata = kwargs.get("metadata", {})
metadata_json = json.dumps(metadata)
try:
conn = self._get_conn()
conn.execute(
"UPDATE knowledge SET content = ?, metadata = ? WHERE id = ?",
(content_str, metadata_json, item_id)
)
conn.commit()
return AddResult(success=True, id=item_id)
except Exception as e:
return AddResult(success=False, message=str(e))
def delete(self, item_id: str, **kwargs: Any) -> bool:
"""Delete an item by ID from SQLite."""
try:
conn = self._get_conn()
conn.execute("DELETE FROM knowledge WHERE id = ?", (item_id,))
conn.commit()
return True
except Exception:
return False
def delete_all(self, *, user_id: Optional[str] = None, agent_id: Optional[str] = None,
run_id: Optional[str] = None, **kwargs: Any) -> bool:
"""Delete all items matching scope from SQLite."""
try:
conn = self._get_conn()
if not any([user_id, agent_id, run_id]):
# Delete all
conn.execute("DELETE FROM knowledge")
else:
# Delete with filters
sql = "DELETE FROM knowledge WHERE 1=1"
params = []
if user_id:
sql += " AND user_id = ?"
params.append(user_id)
if agent_id:
sql += " AND agent_id = ?"
params.append(agent_id)
if run_id:
sql += " AND run_id = ?"
params.append(run_id)
conn.execute(sql, params)
conn.commit()
return True
except Exception:
return False
@@ -1,107 +0,0 @@
"""
Knowledge Adapter Registry
Provides a registry system for knowledge adapters to replace hardcoded imports
in knowledge/knowledge.py. This enables protocol-driven knowledge backends without
core modifications.
"""
from typing import Callable, List, Optional, Tuple, Type
from ...utils.adapter_registry import AdapterRegistry
from ..protocols import KnowledgeStoreProtocol
class KnowledgeAdapterRegistry(AdapterRegistry[KnowledgeStoreProtocol]):
"""
Thread-safe registry for knowledge adapters.
Replaces hardcoded imports and configurations in knowledge.py
with dynamic adapter discovery and instantiation.
Example:
```python
# Register adapter (typically done on import)
register_knowledge_adapter("sqlite", SQLiteKnowledgeAdapter)
register_knowledge_adapter("chroma", ChromaAdapter) # in wrapper
# Use in Knowledge class
adapter = get_knowledge_adapter("chroma", config=config)
```
"""
def __init__(self):
super().__init__(adapter_type_name="Knowledge")
# Global registry instance
_knowledge_registry = KnowledgeAdapterRegistry()
def register_knowledge_adapter(name: str, adapter_class: Type[KnowledgeStoreProtocol]) -> None:
"""Register a knowledge adapter class."""
_knowledge_registry.register_adapter(name, adapter_class)
def register_knowledge_factory(name: str, factory_func: Callable[..., KnowledgeStoreProtocol]) -> None:
"""Register a knowledge adapter factory function."""
_knowledge_registry.register_factory(name, factory_func)
def get_knowledge_adapter(name: str, **kwargs) -> Optional[KnowledgeStoreProtocol]:
"""Get knowledge adapter instance by name."""
return _knowledge_registry.get_adapter(name, **kwargs)
def list_knowledge_adapters() -> List[str]:
"""List all registered knowledge adapter names."""
return _knowledge_registry.list_adapters()
def get_first_available_knowledge_adapter(
preferences: Optional[List[str]] = None, **kwargs
) -> Optional[Tuple[str, KnowledgeStoreProtocol]]:
"""
Get first available knowledge adapter.
Args:
preferences: List of adapter names to try (defaults to ["mem0", "mongodb"])
**kwargs: Configuration passed to adapter constructor
Returns:
(adapter_name, adapter_instance) tuple or None
"""
if preferences is None:
# Default to actual available adapters per knowledge/adapters/__init__.py
preferences = ["mem0", "mongodb"]
return _knowledge_registry.get_first_available(preferences, **kwargs)
# Canonical aliases per AGENTS.md naming conventions
def add_knowledge_adapter(name: str, adapter_class: Type[KnowledgeStoreProtocol]) -> None:
"""Canonical alias for register_knowledge_adapter (preferred naming per AGENTS.md)."""
return register_knowledge_adapter(name, adapter_class)
def add_knowledge_factory(name: str, factory_func: Callable[..., KnowledgeStoreProtocol]) -> None:
"""Canonical alias for register_knowledge_factory (preferred naming per AGENTS.md)."""
return register_knowledge_factory(name, factory_func)
def has_knowledge_adapter(name: str) -> bool:
"""Canonical alias for is_available (preferred naming per AGENTS.md)."""
return _knowledge_registry.is_available(name)
__all__ = [
'KnowledgeAdapterRegistry',
'register_knowledge_adapter',
'register_knowledge_factory',
'get_knowledge_adapter',
'list_knowledge_adapters',
'get_first_available_knowledge_adapter',
# Canonical aliases (preferred)
'add_knowledge_adapter',
'add_knowledge_factory',
'has_knowledge_adapter',
]
@@ -70,18 +70,14 @@ class Knowledge:
# Disable OpenAI API request logging
get_logger('openai').setLevel(logging.WARNING)
# Initialize provider using protocol-driven approach
self._provider = None
@cached_property
@cached_property
def _deps(self):
"""Lazy load dependencies only when needed (backward compatibility)."""
# This is kept for backward compatibility with existing code
# The new protocol-driven approach uses adapters via registry
try:
from markitdown import MarkItDown
import chromadb
return {
'chromadb': chromadb,
'markdown': MarkItDown()
}
except ImportError:
@@ -98,13 +94,14 @@ class Knowledge:
from ..paths import get_project_data_dir
persist_dir = str(get_project_data_dir())
# Create persistent client config (protocol-driven)
# Create persistent client config
base_config = {
"vector_store": {
"provider": "chroma",
"config": {
"collection_name": default_collection,
"path": persist_dir,
"client": self._deps['chromadb'].PersistentClient(path=persist_dir),
"host": None,
"port": None
}
@@ -193,51 +190,16 @@ class Knowledge:
@cached_property
def memory(self):
"""Initialize knowledge adapter using protocol-driven approach."""
# Import registry functions
from .adapters import get_knowledge_adapter, get_first_available_knowledge_adapter
# Check if MongoDB provider is specified
if (self.config.get("vector_store", {}).get("provider") == "mongodb"):
try:
from .adapters import MongoDBKnowledgeAdapter
return MongoDBKnowledgeAdapter(self.config)
except Exception as e:
logger.error(f"Failed to initialize MongoDB adapter: {e}")
# Fall back to default memory
pass
# Determine provider preference
provider = self.config.get("vector_store", {}).get("provider", "mem0")
self._log(f"Requested knowledge provider: {provider}")
# Map legacy provider names to adapter names
provider_mapping = {
"chroma": "chroma",
"mongodb": "mongodb",
"mem0": "mem0",
"sqlite": "sqlite"
}
adapter_name = provider_mapping.get(provider, "mem0")
# Try to get preferred adapter, fallback to available ones
try:
adapter = get_knowledge_adapter(adapter_name, config=self.config, verbose=self._verbose)
except Exception as e:
self._log(f"Failed to initialize '{adapter_name}': {e}")
adapter = None
if adapter is None:
# Fallback to first available adapter
self._log(f"Provider '{adapter_name}' not available, trying fallbacks")
fallback_result = get_first_available_knowledge_adapter(
preferences=["sqlite", "mem0"],
config=self.config,
verbose=self._verbose
)
if fallback_result:
adapter_name, adapter = fallback_result
self._log(f"Using fallback knowledge adapter: {adapter_name}")
else:
# Final fallback: try legacy mem0 approach for backward compatibility
return self._init_legacy_memory()
self._log(f"Initialized knowledge adapter: {adapter_name}")
return adapter
def _init_legacy_memory(self):
"""Legacy fallback memory initialization for backward compatibility."""
# Prepare config for mem0 (strip PraisonAI-specific fields)
mem0_config = self._prepare_mem0_config(self.config)
@@ -538,16 +500,10 @@ class Knowledge:
elif isinstance(memory_result, list):
all_results.extend(memory_result)
else:
from .models import AddResult
if isinstance(memory_result, AddResult):
all_results.append(memory_result.id)
elif hasattr(memory_result, 'results'):
all_results.extend(memory_result.results)
else:
# Log warning for unexpected types but don't break
import logging
logging.warning(f"Unexpected memory_result type: {type(memory_result)}, skipping")
progress.advance(store_task)
# Log warning for unexpected types but don't break
import logging
logging.warning(f"Unexpected memory_result type: {type(memory_result)}, skipping")
progress.advance(store_task)
# Emit trace event for knowledge add
self._emit_knowledge_event("add", source=input_path, chunk_count=len(memories),
@@ -153,15 +153,15 @@ def normalize_search_item(raw: Dict[str, Any]) -> SearchResultItem:
if raw is None:
return SearchResultItem()
# Handle text field (mem0 uses 'memory', others use 'text')
text = raw.get("text") or raw.get("memory", "") or ""
# Handle metadata - CRITICAL: ensure never None
metadata = raw.get("metadata")
if metadata is None:
metadata = {}
elif not isinstance(metadata, dict):
metadata = {}
# Handle text field (mem0 uses 'memory', others use 'text' or store in metadata['data'])
text = raw.get("text") or raw.get("memory", "") or metadata.get("data", "") or ""
# Extract source/filename from metadata if not at top level
source = raw.get("source") or metadata.get("source")
@@ -98,58 +98,6 @@ def __getattr__(name):
from .llm import TokenUsage
_lazy_cache[name] = TokenUsage
return TokenUsage
elif name == "LLMProviderProtocol":
from .protocols import LLMProviderProtocol
_lazy_cache[name] = LLMProviderProtocol
return LLMProviderProtocol
elif name == "ModelCapabilitiesProtocol":
from .protocols import ModelCapabilitiesProtocol
_lazy_cache[name] = ModelCapabilitiesProtocol
return ModelCapabilitiesProtocol
elif name == "LLMRateLimiterProtocol":
from .protocols import LLMRateLimiterProtocol
_lazy_cache[name] = LLMRateLimiterProtocol
return LLMRateLimiterProtocol
elif name == "LLMFailoverProtocol":
from .protocols import LLMFailoverProtocol
_lazy_cache[name] = LLMFailoverProtocol
return LLMFailoverProtocol
elif name == "LLMProviderError":
from .protocols import LLMProviderError
_lazy_cache[name] = LLMProviderError
return LLMProviderError
elif name == "RateLimitError":
from .protocols import RateLimitError
_lazy_cache[name] = RateLimitError
return RateLimitError
elif name == "ModelNotAvailableError":
from .protocols import ModelNotAvailableError
_lazy_cache[name] = ModelNotAvailableError
return ModelNotAvailableError
elif name == "ContextLengthExceededError":
from .protocols import ContextLengthExceededError
_lazy_cache[name] = ContextLengthExceededError
return ContextLengthExceededError
elif name == "UnifiedLLMProtocol":
from .protocols import UnifiedLLMProtocol
_lazy_cache[name] = UnifiedLLMProtocol
return UnifiedLLMProtocol
elif name == "LiteLLMAdapter":
from .unified_adapters import LiteLLMAdapter
_lazy_cache[name] = LiteLLMAdapter
return LiteLLMAdapter
elif name == "OpenAIAdapter":
from .unified_adapters import OpenAIAdapter
_lazy_cache[name] = OpenAIAdapter
return OpenAIAdapter
elif name == "UnifiedLLMDispatcher":
from .unified_adapters import UnifiedLLMDispatcher
_lazy_cache[name] = UnifiedLLMDispatcher
return UnifiedLLMDispatcher
elif name == "create_llm_dispatcher":
from .unified_adapters import create_llm_dispatcher
_lazy_cache[name] = create_llm_dispatcher
return create_llm_dispatcher
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
@@ -174,21 +122,5 @@ __all__ = [
"TaskComplexity",
"create_routing_agent",
"RateLimiter",
"TokenUsage",
# Protocols
"LLMProviderProtocol",
"ModelCapabilitiesProtocol",
"LLMRateLimiterProtocol",
"LLMFailoverProtocol",
"UnifiedLLMProtocol",
# Adapters
"LiteLLMAdapter",
"OpenAIAdapter",
"UnifiedLLMDispatcher",
"create_llm_dispatcher",
# Exceptions
"LLMProviderError",
"RateLimitError",
"ModelNotAvailableError",
"ContextLengthExceededError"
"TokenUsage"
]
@@ -1,231 +0,0 @@
"""
LLM Provider Adapters
Concrete implementations of LLMProviderAdapter protocol that replace
scattered provider dispatch logic throughout the core.
This demonstrates the protocol-driven approach for Gap 2.
"""
from ..protocols import LLMProviderAdapterProtocol
from ..model_capabilities import GEMINI_INTERNAL_TOOLS
from typing import Dict, Any, List, Optional
class DefaultAdapter:
"""Default provider adapter with sensible fallbacks."""
def supports_prompt_caching(self) -> bool:
return False
def should_summarize_tools(self, iter_count: int) -> bool:
return iter_count >= 5 # Conservative default
def format_tools(self, tools: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
return tools # No special formatting by default
def post_tool_iteration(self, state: Dict[str, Any]) -> None:
pass # No post-processing by default
def supports_structured_output(self) -> bool:
return False # Conservative default
def supports_streaming(self) -> bool:
return True # Most providers support streaming
def supports_streaming_with_tools(self) -> bool:
return True # Most providers support streaming with tools
def get_max_iteration_threshold(self) -> int:
return 10 # Conservative default
def format_tool_result_message(self, function_name: str, tool_result: Any, tool_call_id: Optional[str] = None) -> Dict[str, Any]:
# Standard OpenAI-style tool result message
message = {
"role": "tool",
"content": str(tool_result),
}
if tool_call_id is not None:
message["tool_call_id"] = tool_call_id
else:
# Fallback for backward compatibility
message["tool_call_id"] = f"call_{function_name}"
return message
def handle_empty_response_with_tools(self, state: Dict[str, Any]) -> bool:
return False # No special handling by default
def get_default_settings(self) -> Dict[str, Any]:
return {} # No provider-specific defaults
class OllamaAdapter(DefaultAdapter):
"""
Ollama-specific provider adapter.
Handles Ollama's specific quirks:
- Doesn't support streaming with tools reliably
- Needs tool summarization after iteration 1
- Uses natural language tool result format
- Handles empty responses after tool execution
"""
def should_summarize_tools(self, iter_count: int) -> bool:
# Replaces: OLLAMA_SUMMARY_ITERATION_THRESHOLD logic
# Must match LLM.OLLAMA_SUMMARY_ITERATION_THRESHOLD = 1
return iter_count >= 1
def supports_streaming_with_tools(self) -> bool:
# Ollama doesn't reliably support streaming with tools
return False
def get_max_iteration_threshold(self) -> int:
return 1 # Ollama-specific threshold
def format_tool_result_message(self, function_name: str, tool_result: Any, tool_call_id: Optional[str] = None) -> Dict[str, Any]:
# Ollama uses natural language format for tool results
return {
"role": "user",
"content": f"Tool '{function_name}' returned: {tool_result}"
}
def handle_empty_response_with_tools(self, state: Dict[str, Any]) -> bool:
# Handle Ollama's tendency to return empty responses after tool execution
iteration_count = state.get('iteration_count', 0)
has_tool_results = bool(state.get('accumulated_tool_results'))
response_text = state.get('response_text', '').strip()
if iteration_count >= 1 and has_tool_results and not response_text:
return True # Signal that special handling is needed
return False
def post_tool_iteration(self, state: Dict[str, Any]) -> None:
# Replaces: Ollama-specific post-tool summary branches
if (not state.get('response_text', '').strip() and
state.get('formatted_tools') and
state.get('iteration_count') == 0):
# Add Ollama-specific summary logic here
state['needs_summary'] = True
def get_default_settings(self) -> Dict[str, Any]:
return {
'max_tool_repairs': 2,
'force_tool_usage': 'auto'
}
class AnthropicAdapter(DefaultAdapter):
"""Anthropic/Claude provider adapter."""
def supports_prompt_caching(self) -> bool:
return True # Claude supports prompt caching
def supports_structured_output(self) -> bool:
return True
class GeminiAdapter(DefaultAdapter):
"""
Google Gemini provider adapter.
Handles Gemini's specific quirks:
- Has internal tools that need special formatting
- Doesn't support streaming with tools reliably
- Supports structured output
"""
def format_tools(self, tools: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
# Replaces: gemini_internal_tools handling in llm.py
# Internal tool names match GEMINI_INTERNAL_TOOLS: {'googleSearch', 'urlContext', 'codeExecution'}
formatted = []
for tool in tools:
if tool.get('name') in GEMINI_INTERNAL_TOOLS:
# Convert to Gemini internal tool format
formatted.append({
'type': 'function',
'function': tool
})
else:
formatted.append(tool)
return formatted
def supports_streaming_with_tools(self) -> bool:
# Gemini has issues with streaming + tools
return False
def supports_structured_output(self) -> bool:
return True
# Provider adapter registry - public for extension
_provider_adapters: Dict[str, LLMProviderAdapterProtocol] = {}
# Register core adapters at import time
_default_adapter = DefaultAdapter()
_provider_adapters['default'] = _default_adapter
_provider_adapters['ollama'] = OllamaAdapter()
_provider_adapters['anthropic'] = AnthropicAdapter()
_provider_adapters['claude'] = AnthropicAdapter() # Alias
_provider_adapters['gemini'] = GeminiAdapter()
def add_provider_adapter(name: str, adapter: LLMProviderAdapterProtocol) -> None:
"""
Register a provider adapter by name.
This enables new providers to be added without modifying core code.
Args:
name: Provider name (e.g., "cohere", "huggingface")
adapter: Provider adapter implementing LLMProviderProtocol
"""
_provider_adapters[name] = adapter
def get_provider_adapter(name: str) -> LLMProviderAdapterProtocol:
"""
Get provider adapter by name with fallback to default.
Args:
name: Provider name (e.g., "anthropic", "ollama", "gemini")
Returns:
Provider adapter instance (default if name not found)
"""
name_lower = name.lower()
# Exact match first
if name_lower in _provider_adapters:
return _provider_adapters[name_lower]
# Provider prefixes or substrings
if "ollama" in name_lower:
return _provider_adapters["ollama"]
if "claude" in name_lower or "anthropic" in name_lower:
return _provider_adapters["anthropic"]
if "gemini" in name_lower:
return _provider_adapters["gemini"]
return _provider_adapters["default"]
def list_provider_adapters() -> List[str]:
"""List all registered provider adapter names."""
return sorted(_provider_adapters.keys())
def has_provider_adapter(name: str) -> bool:
"""Check if a provider adapter is registered."""
return name in _provider_adapters
__all__ = [
'DefaultAdapter',
'OllamaAdapter',
'AnthropicAdapter',
'GeminiAdapter',
'get_provider_adapter',
'add_provider_adapter',
'list_provider_adapters',
'has_provider_adapter',
]
+45 -101
View File
@@ -412,11 +412,8 @@ Respond with ONLY a valid JSON tool call in this format:
self.max_tool_repairs = extra_settings.get('max_tool_repairs', 0) # Will be set to 2 for Ollama if not explicit
self.force_tool_usage = extra_settings.get('force_tool_usage', 'never') # Will be set to 'auto' for Ollama if not explicit
# Initialize provider adapter for dispatch logic
self._provider_adapter = self._initialize_provider_adapter()
# Apply provider-specific defaults after adapter is initialized
self._apply_provider_defaults()
# Apply Ollama-specific defaults after model is set
self._apply_ollama_defaults()
# Token tracking
self.last_token_metrics: Optional[TokenMetrics] = None
@@ -477,75 +474,15 @@ Respond with ONLY a valid JSON tool call in this format:
self._console = _get_console()()
return self._console
def _detect_provider(self) -> str:
"""
Detect provider from model name.
Consolidates all provider detection logic into a single method
that replaces scattered _is_X_provider() calls.
Returns:
Provider name (e.g., "ollama", "anthropic", "gemini", "openai")
"""
if not self.model:
return "default"
model_lower = self.model.lower()
# Parse route prefix for explicit provider routing
provider_prefix = model_lower.split("/", 1)[0] if "/" in model_lower else None
# Explicit provider prefixes take priority
if provider_prefix == "ollama":
return "ollama"
if provider_prefix in {"anthropic", "claude"}:
return "anthropic"
if provider_prefix in {"gemini", "google"} and "gemini" in model_lower:
return "gemini"
# Use existing robust Ollama detection logic first
def _apply_ollama_defaults(self):
"""Apply Ollama-specific defaults for tool calling reliability."""
if self._is_ollama_provider():
return "ollama"
# Check for direct model name patterns (not substrings)
if model_lower.startswith("claude"):
return "anthropic"
if model_lower.startswith("gemini") or model_lower.startswith("google/gemini"):
return "gemini"
# Check base_url for provider hints
base_urls = [self.base_url, os.getenv("OPENAI_BASE_URL", ""), os.getenv("OPENAI_API_BASE", "")]
if any(url and ("ollama" in url.lower() or ":11434" in url) for url in base_urls):
return "ollama"
# Default fallback
return "openai"
def _initialize_provider_adapter(self):
"""Initialize provider adapter based on detected provider."""
provider = self._detect_provider()
# Import here to avoid circular imports
from .adapters import get_provider_adapter
adapter = get_provider_adapter(provider)
logging.debug(f"[ADAPTER] Initialized {provider} adapter: {adapter.__class__.__name__}")
return adapter
def _apply_provider_defaults(self):
"""Apply provider-specific defaults via adapter pattern."""
if hasattr(self, '_provider_adapter') and self._provider_adapter:
defaults = self._provider_adapter.get_default_settings()
if defaults:
# Apply defaults only if not explicitly set by user
if not self._max_tool_repairs_explicit and 'max_tool_repairs' in defaults:
self.max_tool_repairs = defaults['max_tool_repairs']
if not self._force_tool_usage_explicit and 'force_tool_usage' in defaults:
self.force_tool_usage = defaults['force_tool_usage']
if defaults: # Only log if there were actual defaults
logging.debug(f"[PROVIDER_DEFAULTS] Applied {self._provider_adapter.__class__.__name__} defaults: {defaults}")
# Apply defaults only if not explicitly set by user
if not self._max_tool_repairs_explicit:
self.max_tool_repairs = 2
if not self._force_tool_usage_explicit:
self.force_tool_usage = 'auto'
logging.debug(f"[OLLAMA_RELIABILITY] Applied Ollama defaults: max_tool_repairs={self.max_tool_repairs}, force_tool_usage={self.force_tool_usage}")
def _is_ollama_provider(self) -> bool:
"""Detect if this is an Ollama provider regardless of naming convention"""
@@ -816,22 +753,14 @@ Respond with ONLY a valid JSON tool call in this format:
def _supports_prompt_caching(self) -> bool:
"""
Check if the current model supports prompt caching.
Check if the current model supports prompt caching via LiteLLM.
Uses provider adapter to eliminate scattered provider logic.
Prompt caching allows caching parts of prompts to reduce costs and latency.
Supported by OpenAI, Anthropic, Bedrock, and Deepseek.
Returns:
bool: True if the model supports prompt caching, False otherwise
"""
if hasattr(self, '_provider_adapter') and self._provider_adapter:
adapter_support = self._provider_adapter.supports_prompt_caching()
if adapter_support:
return True
# If adapter says False and is not the default, trust the adapter
if self._provider_adapter.__class__.__name__ != 'DefaultAdapter':
return False
# Fallback to model capabilities for DefaultAdapter or uninitialized
from .model_capabilities import supports_prompt_caching
return supports_prompt_caching(self.model)
@@ -1341,20 +1270,12 @@ Now provide your final answer using this result. Summarize the information natur
- final_response_text: Text to use as final response (None if continuing)
- iteration_count: Updated iteration count
"""
# Use provider adapter to determine if tool summarization should occur
# Adapter should always be initialized, but provide safe fallback
if hasattr(self, '_provider_adapter') and self._provider_adapter:
should_summarize = self._provider_adapter.should_summarize_tools(iteration_count)
else:
# Conservative fallback without provider detection
should_summarize = iteration_count >= 5 # Conservative default
if not should_summarize:
if not (self._is_ollama_provider() and iteration_count >= self.OLLAMA_SUMMARY_ITERATION_THRESHOLD):
return False, None, iteration_count
# If we should summarize: if we have meaningful tool results, generate summary immediately
# Don't wait for more iterations as some providers tend to repeat tool calls
if accumulated_tool_results and should_summarize:
# For Ollama: if we have meaningful tool results, generate summary immediately
# Don't wait for more iterations as Ollama tends to repeat tool calls
if accumulated_tool_results and iteration_count >= self.OLLAMA_SUMMARY_ITERATION_THRESHOLD:
# Generate summary from tool results
tool_summary = self._generate_ollama_tool_summary(accumulated_tool_results, response_text)
if tool_summary:
@@ -1380,7 +1301,9 @@ Now provide your final answer using this result. Summarize the information natur
"""
Check if the current provider supports streaming with tools.
Uses provider adapter to eliminate scattered provider logic.
Most providers that support tool calling also support streaming with tools,
but some providers (like Ollama and certain local models) require non-streaming
calls when tools are involved.
Returns:
bool: True if provider supports streaming with tools, False otherwise
@@ -1388,11 +1311,32 @@ Now provide your final answer using this result. Summarize the information natur
if not self.model:
return False
# Use provider adapter for streaming with tools support
if hasattr(self, '_provider_adapter') and self._provider_adapter:
return self._provider_adapter.supports_streaming_with_tools()
# Ollama doesn't reliably support streaming with tools
if self._is_ollama_provider():
return False
# Fallback to conservative default if adapter not initialized
# Import the capability check function
from .model_capabilities import supports_streaming_with_tools
# Check if this model supports streaming with tools
if supports_streaming_with_tools(self.model):
return True
# Anthropic Claude models support streaming with tools
if self.model.startswith("claude-"):
return True
# Google Gemini models support streaming with tools
if any(self.model.startswith(prefix) for prefix in ["gemini-", "gemini/"]):
return True
# Models with XML tool format support streaming with tools
if self._supports_xml_tool_format():
return True
# For other providers, default to False to be safe
# This ensures we make a single non-streaming call rather than risk
# missing tool calls or making duplicate calls
return False
def _build_messages(self, prompt, system_prompt=None, chat_history=None, output_json=None, output_pydantic=None, tools=None):
@@ -11,7 +11,6 @@ from praisonaiagents._logging import get_logger
import time
import json
import asyncio
import threading
from typing import Any, Dict, List, Optional, Union, AsyncIterator, Iterator, Callable, Tuple, TYPE_CHECKING
from pydantic import BaseModel
from dataclasses import dataclass
@@ -2198,7 +2197,6 @@ class OpenAIClient:
# Global client instance (similar to main.py pattern)
_global_client = None
_global_client_params = None
_global_client_lock = threading.Lock()
def get_openai_client(api_key: Optional[str] = None, base_url: Optional[str] = None) -> OpenAIClient:
"""
@@ -2218,10 +2216,9 @@ def get_openai_client(api_key: Optional[str] = None, base_url: Optional[str] = N
normalized_base_url = base_url
current_params = (normalized_api_key, normalized_base_url)
# Thread-safe client creation
with _global_client_lock:
# Only create new client if parameters changed or first time
if _global_client is None or _global_client_params != current_params:
_global_client = OpenAIClient(api_key=api_key, base_url=base_url)
_global_client_params = current_params
return _global_client
# Only create new client if parameters changed or first time
if _global_client is None or _global_client_params != current_params:
_global_client = OpenAIClient(api_key=api_key, base_url=base_url)
_global_client_params = current_params
return _global_client
@@ -1,369 +0,0 @@
"""
LLM Provider Protocols for PraisonAI Agents.
Defines minimal protocol interfaces for LLM providers to enable
extensibility without vendor lock-in to litellm or any specific provider.
No heavy imports - only stdlib and typing.
"""
from typing import Any, AsyncIterator, Dict, Iterator, List, Optional, Protocol, Union, runtime_checkable
@runtime_checkable
class LLMProviderProtocol(Protocol):
"""
Protocol defining the interface that LLM clients must implement.
This enables switching between different LLM backends (litellm, openai,
anthropic, local models, etc.) without modifying core agent code.
Implementations must provide both sync and async variants for
production flexibility.
"""
model: str
def chat(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], Iterator[Dict[str, Any]]]:
"""
Generate chat completion.
Args:
messages: List of message dicts with 'role' and 'content'
tools: Optional list of tool schemas for function calling
temperature: Sampling temperature (0.0-2.0)
max_tokens: Maximum tokens to generate
stream: Whether to return streaming iterator
**kwargs: Provider-specific options
Returns:
Single response dict or streaming iterator of response chunks
"""
...
async def achat(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], AsyncIterator[Dict[str, Any]]]:
"""
Async version of chat.
Args:
messages: List of message dicts with 'role' and 'content'
tools: Optional list of tool schemas for function calling
temperature: Sampling temperature (0.0-2.0)
max_tokens: Maximum tokens to generate
stream: Whether to return async streaming iterator
**kwargs: Provider-specific options
Returns:
Single response dict or async streaming iterator of response chunks
"""
...
def get_token_count(self, text: str) -> int:
"""
Count tokens in text for the current model.
Args:
text: Text to count tokens for
Returns:
Number of tokens
"""
...
def get_context_length(self) -> int:
"""
Get maximum context length for the current model.
Returns:
Maximum context length in tokens
"""
...
@runtime_checkable
class ModelCapabilitiesProtocol(Protocol):
"""
Protocol for querying model capabilities.
Enables runtime capability detection for different models
without hardcoded capability tables.
"""
def supports_streaming(self, model: str) -> bool:
"""Check if model supports streaming responses."""
...
def supports_function_calling(self, model: str) -> bool:
"""Check if model supports function/tool calling."""
...
def supports_structured_output(self, model: str) -> bool:
"""Check if model supports structured JSON output."""
...
def supports_vision(self, model: str) -> bool:
"""Check if model supports vision/image inputs."""
...
def get_max_tokens(self, model: str) -> Optional[int]:
"""Get maximum context length for model."""
...
@runtime_checkable
class LLMRateLimiterProtocol(Protocol):
"""
Protocol for LLM request rate limiting.
Enables different rate limiting strategies without
coupling to specific implementations.
"""
async def acquire(self, tokens: int = 1) -> None:
"""
Acquire permission to make request.
Args:
tokens: Number of tokens in the request
Raises:
RateLimitError: If rate limit would be exceeded
"""
...
def can_proceed(self, tokens: int = 1) -> bool:
"""
Check if request can proceed without blocking.
Args:
tokens: Number of tokens in the request
Returns:
True if request can proceed immediately
"""
...
def get_wait_time(self, tokens: int = 1) -> float:
"""
Get seconds to wait before request can proceed.
Args:
tokens: Number of tokens in the request
Returns:
Seconds to wait (0.0 if can proceed immediately)
"""
...
@runtime_checkable
class LLMFailoverProtocol(Protocol):
"""
Protocol for LLM failover strategies.
Enables automatic fallback to alternative models
when primary models fail or are unavailable.
"""
def get_fallback_model(self, failed_model: str, error: Exception) -> Optional[str]:
"""
Get fallback model for failed request.
Args:
failed_model: Model that failed
error: Exception that occurred
Returns:
Alternative model name or None if no fallback available
"""
...
def should_retry(self, error: Exception) -> bool:
"""
Check if error indicates retryable failure.
Args:
error: Exception that occurred
Returns:
True if should retry with fallback
"""
...
def get_retry_delay(self, attempt: int) -> float:
"""
Get delay before retry attempt.
Args:
attempt: Retry attempt number (1-based)
Returns:
Seconds to wait before retry
"""
...
class LLMProviderError(Exception):
"""Base exception for LLM provider errors."""
def __init__(self, message: str, provider: Optional[str] = None, model: Optional[str] = None):
self.provider = provider
self.model = model
super().__init__(message)
class RateLimitError(LLMProviderError):
"""Raised when rate limit is exceeded."""
def __init__(self, message: Optional[str] = None, retry_after: Optional[float] = None, provider: Optional[str] = None, model: Optional[str] = None):
self.retry_after = retry_after
super().__init__(message or "Rate limit exceeded", provider=provider, model=model)
class ModelNotAvailableError(LLMProviderError):
"""Raised when requested model is not available."""
def __init__(self, model: str, provider: Optional[str] = None):
message = f"Model '{model}' is not available{f' from provider {provider}' if provider else ''}"
super().__init__(message, provider=provider, model=model)
class ContextLengthExceededError(LLMProviderError):
"""Raised when input exceeds model's context length."""
def __init__(self, tokens: int, max_tokens: int, provider: Optional[str] = None, model: Optional[str] = None):
self.tokens = tokens
self.max_tokens = max_tokens
super().__init__(f"Input length ({tokens} tokens) exceeds model limit ({max_tokens} tokens)", provider=provider, model=model)
@runtime_checkable
class LLMProviderAdapterProtocol(Protocol):
"""
Protocol for provider-specific LLM adaptations.
This replaces scattered provider dispatch logic throughout the core.
Each provider implements these hooks to handle provider-specific quirks
without requiring if/elif branching in the core chat loop.
Example:
```python
class OllamaAdapter:
def supports_prompt_caching(self) -> bool:
return False
def should_summarize_tools(self, iter_count: int) -> bool:
return iter_count >= 3 # Ollama-specific threshold
def format_tools(self, tools) -> list:
return tools # No special formatting needed
def post_tool_iteration(self, state) -> None:
if state.get('empty_response') and state.get('tools'):
# Add Ollama-specific tool summary
state['summary'] = "Tool results processed"
```
"""
def supports_prompt_caching(self) -> bool:
"""Check if this provider supports prompt caching."""
...
def should_summarize_tools(self, iter_count: int) -> bool:
"""Check if tools should be summarized at this iteration count."""
...
def format_tools(self, tools: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
"""Format tools for this provider's requirements."""
...
def post_tool_iteration(self, state: Dict[str, Any]) -> None:
"""Handle provider-specific post-tool processing."""
...
def supports_structured_output(self) -> bool:
"""Check if provider supports structured JSON output."""
...
def supports_streaming(self) -> bool:
"""Check if provider supports streaming responses."""
...
def supports_streaming_with_tools(self) -> bool:
"""Check if provider supports streaming with tools enabled."""
...
def get_max_iteration_threshold(self) -> int:
"""Get provider-specific maximum iteration count."""
...
def format_tool_result_message(self, function_name: str, tool_result: Any, tool_call_id: Optional[str] = None) -> Dict[str, Any]:
"""Format tool result message for this provider's requirements."""
...
def handle_empty_response_with_tools(self, state: Dict[str, Any]) -> bool:
"""Handle provider-specific empty response with tools logic."""
...
def get_default_settings(self) -> Dict[str, Any]:
"""Get provider-specific default settings."""
...
@runtime_checkable
class UnifiedLLMProtocol(Protocol):
"""
Unified protocol for LLM dispatch that consolidates the dual execution paths.
This replaces the separate custom-LLM path (LLM.get_response) and OpenAI path
(OpenAIClient) with a single async-first protocol that all providers implement.
Sync implementations must not call asyncio.run() from library internals.
Provide native sync implementations or convert streaming responses
to real Iterator[Dict[str, Any]] objects.
"""
async def achat_completion(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], AsyncIterator[Dict[str, Any]]]:
"""
Primary async chat completion method.
All LLM interactions go through this single path.
"""
...
def chat_completion(
self,
messages: List[Dict[str, Any]],
**kwargs: Any
) -> Union[Dict[str, Any], Iterator[Dict[str, Any]]]:
"""
Synchronous chat completion entry point.
For streaming, implementations must return a real Iterator[Dict[str, Any]].
"""
...
@@ -1,348 +0,0 @@
"""
LLM Provider Adapters for Unified Protocol Dispatch.
Implements the adapter pattern to consolidate the dual execution paths
into a single async-first protocol-driven architecture.
"""
import asyncio
import logging
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator, Callable, TYPE_CHECKING
from .protocols import UnifiedLLMProtocol
if TYPE_CHECKING:
from .llm import LLM
from .openai_client import OpenAIClient
logger = logging.getLogger(__name__)
class LiteLLMAdapter:
"""
Adapter for LiteLLM-backed LLM instances.
Wraps the existing LLM class to conform to the UnifiedLLMProtocol,
ensuring all provider interactions go through a single async dispatch.
"""
def __init__(self, llm_instance: 'LLM'):
"""Initialize adapter with existing LLM instance."""
self.llm = llm_instance
self.model = llm_instance.model
async def achat_completion(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], AsyncIterator[Dict[str, Any]]]:
"""
Async chat completion using existing LLM.get_response_async.
This consolidates the custom-LLM path into the unified protocol.
"""
# Extract system prompt, chat history, and current prompt from messages
system_prompt = None
conversation_messages = messages
if messages and messages[0].get('role') == 'system':
system_prompt = messages[0].get('content')
conversation_messages = messages[1:]
prompt = ""
chat_history = None
if conversation_messages:
prompt = conversation_messages[-1].get('content', '')
if len(conversation_messages) > 1:
chat_history = conversation_messages[:-1]
# Extract verbose before passing kwargs to avoid duplicate parameter
verbose = kwargs.pop('verbose', False)
max_tokens = kwargs.pop('max_tokens', None)
# Call existing async method
response = await self.llm.get_response_async(
prompt=prompt,
system_prompt=system_prompt,
chat_history=chat_history,
temperature=temperature,
tools=tools,
stream=stream,
verbose=verbose,
max_tokens=max_tokens,
**kwargs
)
# Convert response to standard format
if stream:
# For streaming, wrap in async iterator that yields standard chunks
return self._convert_stream_response(response)
else:
return self._convert_response_to_standard_format(response)
def chat_completion(
self,
messages: List[Dict[str, Any]],
**kwargs: Any
) -> Union[Dict[str, Any], Iterator[Dict[str, Any]]]:
"""
Sync chat completion using existing sync LLM methods.
Implements a native sync path without calling asyncio.run() to comply
with UnifiedLLMProtocol requirements.
"""
# Extract system prompt, chat history, and current prompt from messages
system_prompt = None
conversation_messages = messages
if messages and messages[0].get('role') == 'system':
system_prompt = messages[0].get('content')
conversation_messages = messages[1:]
prompt = ""
chat_history = None
if conversation_messages:
prompt = conversation_messages[-1].get('content', '')
if len(conversation_messages) > 1:
chat_history = conversation_messages[:-1]
# Extract parameters to avoid kwargs conflicts
tools = kwargs.get('tools')
temperature = kwargs.get('temperature', 0.0)
stream = kwargs.get('stream', False)
verbose = kwargs.pop('verbose', False) if 'verbose' in kwargs else False
max_tokens = kwargs.pop('max_tokens', None) if 'max_tokens' in kwargs else None
# For streaming, explicitly disallow as it violates protocol sync contract
if stream:
raise ValueError(
"Streaming is not supported in sync LiteLLMAdapter. "
"Use achat_completion() for streaming support."
)
# Use existing sync method
response = self.llm.get_response(
prompt=prompt,
system_prompt=system_prompt,
chat_history=chat_history,
temperature=temperature,
tools=tools,
stream=False,
verbose=verbose,
max_tokens=max_tokens,
**{k: v for k, v in kwargs.items() if k not in ['tools', 'temperature', 'stream', 'verbose', 'max_tokens']}
)
return self._convert_response_to_standard_format(response)
def _convert_messages_to_prompt(self, messages: List[Dict[str, Any]]) -> str:
"""Convert OpenAI-style messages to prompt string."""
if not messages:
return ""
# If single message, return its content
if len(messages) == 1:
return messages[0].get('content', '')
# For multiple messages, use the last user message as prompt
for msg in reversed(messages):
if msg.get('role') == 'user':
return msg.get('content', '')
return messages[-1].get('content', '') if messages else ''
async def _convert_stream_response(self, response_stream) -> AsyncIterator[Dict[str, Any]]:
"""Convert LLM stream response to standard format."""
# Implementation depends on the actual stream format from LLM.get_response_async
# This is a placeholder - would need to be implemented based on actual stream format
if hasattr(response_stream, '__aiter__'):
async for chunk in response_stream:
yield self._convert_chunk_to_standard_format(chunk)
else:
# If not async iterable, yield the full response as a single chunk
yield self._convert_response_to_standard_format(response_stream)
def _convert_response_to_standard_format(self, response: Any) -> Dict[str, Any]:
"""Convert LLM response to standard OpenAI-like format."""
if isinstance(response, str):
return {
"choices": [{
"message": {
"role": "assistant",
"content": response
},
"finish_reason": "stop"
}]
}
return response
def _convert_chunk_to_standard_format(self, chunk: Any) -> Dict[str, Any]:
"""Convert LLM stream chunk to standard format."""
if isinstance(chunk, str):
return {
"choices": [{
"delta": {
"content": chunk
}
}]
}
return chunk
class OpenAIAdapter:
"""
Adapter for direct OpenAI client interactions.
Wraps the existing OpenAIClient to conform to the UnifiedLLMProtocol,
consolidating the OpenAI-specific path into the unified dispatch.
"""
def __init__(self, client: 'OpenAIClient', model: str = "gpt-4o-mini"):
"""Initialize adapter with OpenAI client."""
self.client = client
self.model = model
async def achat_completion(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], AsyncIterator[Dict[str, Any]]]:
"""
Async chat completion using OpenAI client.
This consolidates the OpenAI path into the unified protocol.
"""
# Delegate to the existing OpenAI client's async method with tools
return await self.client.achat_completion_with_tools(
messages=messages,
model=self.model,
tools=tools,
temperature=temperature,
max_tokens=max_tokens,
stream=stream,
execute_tool_fn=kwargs.get('execute_tool_fn'),
console=kwargs.get('console'),
display_fn=kwargs.get('display_fn'),
reasoning_steps=kwargs.get('reasoning_steps', False),
verbose=kwargs.get('verbose', True),
max_iterations=kwargs.get('max_iterations', 10),
**{k: v for k, v in kwargs.items() if k not in ['max_tokens', 'execute_tool_fn', 'console', 'display_fn', 'reasoning_steps', 'verbose', 'max_iterations']}
)
def chat_completion(
self,
messages: List[Dict[str, Any]],
**kwargs: Any
) -> Union[Dict[str, Any], Iterator[Dict[str, Any]]]:
"""
Sync chat completion as thin wrapper around async implementation.
Delegates to async method following protocol requirements for
sync methods to be wrappers around the canonical async implementation.
"""
import asyncio
# For streaming, explicitly disallow as it violates sync protocol contract
if kwargs.get('stream', False):
raise ValueError(
"Streaming is not supported in sync OpenAIAdapter. "
"Use achat_completion() for streaming support."
)
# Check if we're already in an event loop
try:
loop = asyncio.get_running_loop()
# In event loop - use thread pool to avoid nesting
import concurrent.futures
def run_in_thread():
return asyncio.run(self.achat_completion(messages, **kwargs))
with concurrent.futures.ThreadPoolExecutor() as executor:
future = executor.submit(run_in_thread)
return future.result()
except RuntimeError:
# No running loop, safe to use asyncio.run
return asyncio.run(self.achat_completion(messages, **kwargs))
class UnifiedLLMDispatcher:
"""
Unified LLM dispatcher that implements UnifiedLLMProtocol.
This is the single entry point for all LLM interactions,
routing to the appropriate adapter based on configuration.
"""
def __init__(self, adapter: Union[LiteLLMAdapter, OpenAIAdapter]):
"""Initialize with a specific adapter."""
self.adapter = adapter
self.model = adapter.model
async def achat_completion(
self,
messages: List[Dict[str, Any]],
*,
tools: Optional[List[Dict[str, Any]]] = None,
temperature: float = 0.0,
max_tokens: Optional[int] = None,
stream: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], AsyncIterator[Dict[str, Any]]]:
"""Primary async chat completion method."""
return await self.adapter.achat_completion(
messages=messages,
tools=tools,
temperature=temperature,
max_tokens=max_tokens,
stream=stream,
**kwargs
)
def chat_completion(
self,
messages: List[Dict[str, Any]],
**kwargs: Any
) -> Union[Dict[str, Any], Iterator[Dict[str, Any]]]:
"""Sync wrapper around async method."""
return self.adapter.chat_completion(messages=messages, **kwargs)
def create_llm_dispatcher(
llm_instance: Optional['LLM'] = None,
openai_client: Optional['OpenAIClient'] = None,
model: str = "gpt-4o-mini"
) -> UnifiedLLMDispatcher:
"""
Factory function to create appropriate LLM dispatcher.
Args:
llm_instance: Existing LLM instance (for LiteLLM path)
openai_client: Existing OpenAI client (for OpenAI path)
model: Model name to use
Returns:
UnifiedLLMDispatcher configured with appropriate adapter
Raises:
ValueError: If neither llm_instance nor openai_client provided
"""
if llm_instance is not None:
adapter = LiteLLMAdapter(llm_instance)
elif openai_client is not None:
adapter = OpenAIAdapter(openai_client, model)
else:
raise ValueError("Either llm_instance or openai_client must be provided")
return UnifiedLLMDispatcher(adapter)
+15 -28
View File
@@ -2,7 +2,6 @@ import os
import time
import json
import logging
import threading
from praisonaiagents._logging import get_logger
from typing import List, Optional, Dict, Any, Union, Literal, Type
from pydantic import BaseModel, ConfigDict
@@ -26,16 +25,13 @@ except ImportError:
# Global list to store error logs
error_logs = []
_error_logs_lock = threading.Lock()
# Separate registries for sync and async callbacks
sync_display_callbacks = {}
async_display_callbacks = {}
_callbacks_lock = threading.Lock()
# Global approval callback registry
approval_callback = None
_approval_callback_lock = threading.Lock()
# ─────────────────────────────────────────────────────────────────────────────
# PraisonAI Unique Color Palette: "Elegant Intelligence"
@@ -132,11 +128,10 @@ def register_display_callback(display_type: str, callback_fn, is_async: bool = F
callback_fn: The callback function to register
is_async (bool): Whether the callback is asynchronous
"""
with _callbacks_lock:
if is_async:
async_display_callbacks[display_type] = callback_fn
else:
sync_display_callbacks[display_type] = callback_fn
if is_async:
async_display_callbacks[display_type] = callback_fn
else:
sync_display_callbacks[display_type] = callback_fn
def register_approval_callback(callback_fn):
"""Register a global approval callback function for dangerous tool operations.
@@ -145,8 +140,7 @@ def register_approval_callback(callback_fn):
callback_fn: Function that takes (function_name, arguments, risk_level) and returns ApprovalDecision
"""
global approval_callback
with _approval_callback_lock:
approval_callback = callback_fn
approval_callback = callback_fn
# Simplified aliases (consistent naming convention)
add_display_callback = register_display_callback
@@ -161,10 +155,8 @@ def execute_sync_callback(display_type: str, **kwargs):
display_type (str): Type of display event
**kwargs: Arguments to pass to the callback function
"""
with _callbacks_lock:
callback = sync_display_callbacks.get(display_type)
if callback:
if display_type in sync_display_callbacks:
callback = sync_display_callbacks[display_type]
import inspect
sig = inspect.signature(callback)
@@ -188,12 +180,9 @@ async def execute_callback(display_type: str, **kwargs):
import inspect
# Execute synchronous callback if registered
with _callbacks_lock:
sync_callback = sync_display_callbacks.get(display_type)
async_callback = async_display_callbacks.get(display_type)
if sync_callback:
sig = inspect.signature(sync_callback)
if display_type in sync_display_callbacks:
callback = sync_display_callbacks[display_type]
sig = inspect.signature(callback)
# Filter kwargs to what the callback accepts to maintain backward compatibility
if any(p.kind == inspect.Parameter.VAR_KEYWORD for p in sig.parameters.values()):
@@ -204,11 +193,11 @@ async def execute_callback(display_type: str, **kwargs):
supported_kwargs = {k: v for k, v in kwargs.items() if k in sig.parameters}
loop = asyncio.get_event_loop()
await loop.run_in_executor(None, lambda: sync_callback(**supported_kwargs))
await loop.run_in_executor(None, lambda: callback(**supported_kwargs))
# Execute asynchronous callback if registered
if async_callback:
callback = async_callback
if display_type in async_display_callbacks:
callback = async_display_callbacks[display_type]
sig = inspect.signature(callback)
# Filter kwargs to what the callback accepts to maintain backward compatibility
@@ -429,8 +418,7 @@ def display_error(message: str, console=None):
title="⚠ Error",
border_style=PRAISON_COLORS["error"]
))
with _error_logs_lock:
error_logs.append(message)
error_logs.append(message)
def display_generating(content: str = "", start_time: Optional[float] = None):
if not content or not str(content).strip():
@@ -627,8 +615,7 @@ async def adisplay_error(message: str, console=None):
await execute_callback('error', message=message)
console.print(Panel.fit(Text(message, style="bold red"), title="Error", border_style="red"))
with _error_logs_lock:
error_logs.append(message)
error_logs.append(message)
async def adisplay_generating(content: str = "", start_time: Optional[float] = None):
"""Async version of display_generating."""
@@ -5,49 +5,15 @@ This module provides concrete implementations of MemoryProtocol
for different backends, following the adapter pattern used in knowledge/.
Adapters:
- sqlite_adapter: SQLite-based memory storage (core)
- in_memory_adapter: Lightweight in-memory storage (core, for testing/dev)
- chromadb_adapter: ChromaDB vector memory storage (wrapper)
- mongodb_adapter: MongoDB document storage (wrapper)
- redis_adapter: Redis in-memory storage (wrapper)
- postgres_adapter: PostgreSQL storage (wrapper)
Heavy adapters (chromadb, mongodb, etc.) are moved to wrapper package
to keep core lightweight and protocol-driven.
- sqlite_adapter: SQLite-based memory storage
- chromadb_adapter: ChromaDB vector memory storage
- mongodb_adapter: MongoDB document storage
- redis_adapter: Redis in-memory storage
- postgres_adapter: PostgreSQL storage
"""
from .sqlite_adapter import SqliteMemoryAdapter
from .in_memory_adapter import InMemoryAdapter
from .registry import (
register_memory_adapter,
register_memory_factory,
get_memory_adapter,
list_memory_adapters,
get_first_available_memory_adapter,
has_memory_adapter,
)
from .factories import (
create_mem0_memory_adapter,
create_chroma_memory_adapter,
create_mongodb_memory_adapter,
)
# Register core adapters
register_memory_adapter("sqlite", SqliteMemoryAdapter)
register_memory_adapter("in_memory", InMemoryAdapter)
# Register heavy adapter factories (lazy-loaded)
register_memory_factory("mem0", create_mem0_memory_adapter)
register_memory_factory("chroma", create_chroma_memory_adapter)
register_memory_factory("mongodb", create_mongodb_memory_adapter)
__all__ = [
'SqliteMemoryAdapter',
'InMemoryAdapter',
'register_memory_adapter',
'register_memory_factory',
'get_memory_adapter',
'list_memory_adapters',
'get_first_available_memory_adapter',
'has_memory_adapter',
]
]
@@ -1,495 +0,0 @@
"""
Memory Adapter Factory Functions
Provides factory functions for heavy memory adapters that replace hardcoded imports
in memory/memory.py. These enable lazy loading of heavy dependencies while maintaining
the protocol-driven architecture.
Each factory function:
1. Lazy imports the required dependencies
2. Creates and returns an adapter instance that implements MemoryProtocol
3. Raises clear ImportError with installation instructions if dependencies missing
This approach follows the protocol-driven core principle by moving heavy implementations
out of the core Memory class while preserving backward compatibility.
"""
import os
import threading
from typing import Any, Dict, List, Optional
from ..protocols import MemoryProtocol
def create_mem0_memory_adapter(**kwargs) -> MemoryProtocol:
"""
Factory function to create Mem0 memory adapter.
Lazy imports mem0 and creates an adapter that wraps mem0.Memory
to implement MemoryProtocol.
Args:
**kwargs: Configuration passed to mem0 Memory
Returns:
MemoryProtocol adapter instance
Raises:
ImportError: If mem0 is not installed
"""
try:
import mem0
except ImportError:
raise ImportError(
"mem0 is required for mem0 adapter. Install with: pip install mem0ai"
)
return Mem0MemoryAdapter(mem0_config=kwargs)
def create_chroma_memory_adapter(**kwargs) -> MemoryProtocol:
"""
Factory function to create ChromaDB memory adapter.
Lazy imports chromadb and creates an adapter that implements MemoryProtocol
using ChromaDB as the vector store backend.
Args:
**kwargs: Configuration passed to ChromaDB
Returns:
MemoryProtocol adapter instance
Raises:
ImportError: If chromadb is not installed
"""
try:
import chromadb
from chromadb.config import Settings as ChromaSettings
except ImportError:
raise ImportError(
"chromadb is required for chroma adapter. Install with: pip install chromadb"
)
return ChromaMemoryAdapter(chromadb=chromadb, chroma_settings=ChromaSettings, **kwargs)
def create_mongodb_memory_adapter(**kwargs) -> MemoryProtocol:
"""
Factory function to create MongoDB memory adapter.
Lazy imports pymongo and creates an adapter that implements MemoryProtocol
using MongoDB as the document store backend.
Args:
**kwargs: Configuration passed to MongoDB client
Returns:
MemoryProtocol adapter instance
Raises:
ImportError: If pymongo is not installed
"""
try:
import pymongo
from pymongo import MongoClient
except ImportError:
raise ImportError(
"pymongo is required for mongodb adapter. Install with: pip install pymongo"
)
return MongoDBMemoryAdapter(pymongo=pymongo, mongo_client=MongoClient, **kwargs)
class Mem0MemoryAdapter:
"""
Memory adapter that wraps mem0.Memory to implement MemoryProtocol.
This adapter handles the integration between PraisonAI's memory interface
and mem0's memory system.
"""
def __init__(self, mem0_config: Dict[str, Any]):
"""Initialize mem0 memory adapter."""
import mem0
config = mem0_config.get("config", {})
api_key = config.get("api_key", os.getenv("MEM0_API_KEY"))
org_id = config.get("org_id")
proj_id = config.get("project_id")
# Check if graph memory is enabled
graph_config = config.get("graph_store")
use_graph = graph_config is not None
if use_graph:
# Initialize with graph memory support
mem0_config_dict = {"graph_store": graph_config}
# Add other configurations if provided
for key in ["vector_store", "llm", "embedder"]:
if key in config:
mem0_config_dict[key] = config[key]
self.mem0_client = mem0.Memory.from_config(config_dict=mem0_config_dict)
self.graph_enabled = True
else:
# Use traditional MemoryClient
if org_id and proj_id:
self.mem0_client = mem0.MemoryClient(api_key=api_key, org_id=org_id, project_id=proj_id)
else:
self.mem0_client = mem0.MemoryClient(api_key=api_key)
self.graph_enabled = False
def store_short_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in mem0 (treated as long-term since mem0 doesn't distinguish)."""
return self.store_long_term(text, metadata, **kwargs)
def search_short_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search mem0 (treated as long-term since mem0 doesn't distinguish)."""
return self.search_long_term(query, limit, **kwargs)
def store_long_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store text in mem0."""
result = self.mem0_client.add(text, metadata=metadata or {})
return str(result[0]["id"]) if result else ""
def search_long_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search mem0 for relevant memories."""
search_params = {"query": query, "limit": limit}
search_params.update(kwargs)
try:
return self.mem0_client.search(**search_params)
except TypeError as e:
# Handle known mem0 MongoDB compatibility issue
if "unexpected keyword argument" in str(e).lower() and "vectors" in str(e).lower():
# Return empty results rather than crashing
return []
raise
def get_all_memories(self, **kwargs) -> List[Dict[str, Any]]:
"""Get all memories from mem0."""
return self.mem0_client.get_all(**kwargs)
class ChromaMemoryAdapter:
"""
Memory adapter that uses ChromaDB to implement MemoryProtocol.
"""
def __init__(self, chromadb, chroma_settings, **kwargs):
"""Initialize ChromaDB memory adapter."""
self.chromadb = chromadb
self.chroma_settings = chroma_settings
# Configuration
rag_path = kwargs.get("rag_db_path", "chroma_db")
os.makedirs(rag_path, exist_ok=True)
# Initialize ChromaDB client
self.client = chromadb.PersistentClient(
path=rag_path,
settings=chroma_settings(
anonymized_telemetry=False,
allow_reset=True
)
)
# Initialize collection
collection_name = "memory_store"
try:
self.collection = self.client.get_collection(name=collection_name)
except Exception:
self.collection = self.client.create_collection(
name=collection_name,
metadata={"hnsw:space": "cosine"}
)
def store_short_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in ChromaDB (short-term and long-term treated the same)."""
return self.store_long_term(text, metadata, **kwargs)
def search_short_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search ChromaDB."""
return self.search_long_term(query, limit, **kwargs)
def store_long_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store text in ChromaDB with embedding."""
# Get embedding
from praisonaiagents.embedding import embedding
embedding_model = kwargs.get("embedding_model", "text-embedding-3-small")
result = embedding(text, model=embedding_model)
text_embedding = result.embeddings[0] if result.embeddings else None
if text_embedding is None:
raise RuntimeError("Failed to generate embedding for text")
# Generate ID and store
import time
doc_id = str(time.time_ns())
# Sanitize metadata for ChromaDB
sanitized_metadata = self._sanitize_metadata(metadata or {})
self.collection.add(
documents=[text],
metadatas=[sanitized_metadata],
ids=[doc_id],
embeddings=[text_embedding]
)
return doc_id
def search_long_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search ChromaDB using vector similarity."""
from praisonaiagents.embedding import embedding
embedding_model = kwargs.get("embedding_model", "text-embedding-3-small")
result = embedding(query, model=embedding_model)
query_embedding = result.embeddings[0] if result.embeddings else None
if query_embedding is None:
return []
# Search ChromaDB
response = self.collection.query(
query_embeddings=[query_embedding],
n_results=limit,
include=["documents", "metadatas", "distances"]
)
results = []
if response["ids"]:
for i in range(len(response["ids"][0])):
metadata = response["metadatas"][0][i] if "metadatas" in response else {}
text = response["documents"][0][i]
score = 1.0 - (response["distances"][0][i] if "distances" in response else 0.0)
results.append({
"id": response["ids"][0][i],
"text": text,
"metadata": metadata,
"score": score
})
return results
def get_all_memories(self, **kwargs) -> List[Dict[str, Any]]:
"""Get all memories from ChromaDB."""
response = self.collection.get(include=["documents", "metadatas"])
results = []
if response["ids"]:
for i, doc_id in enumerate(response["ids"]):
results.append({
"id": doc_id,
"text": response["documents"][i],
"metadata": response["metadatas"][i] if "metadatas" in response else {},
"type": "long_term"
})
return results
def _sanitize_metadata(self, metadata: Dict) -> Dict:
"""Sanitize metadata for ChromaDB - convert to acceptable types."""
sanitized = {}
for k, v in metadata.items():
if v is None:
continue
if isinstance(v, (str, int, float, bool)):
sanitized[k] = v
elif isinstance(v, dict):
sanitized[k] = str(v)
else:
sanitized[k] = str(v)
return sanitized
class MongoDBMemoryAdapter:
"""
Memory adapter that uses MongoDB to implement MemoryProtocol.
"""
def __init__(self, pymongo, mongo_client, **kwargs):
"""Initialize MongoDB memory adapter."""
self.pymongo = pymongo
config = kwargs.get("config", {})
connection_string = config.get("connection_string", "mongodb://localhost:27017/")
database_name = config.get("database", "praisonai")
self.use_vector_search = config.get("use_vector_search", False)
# Initialize MongoDB client
self.client = mongo_client(
connection_string,
maxPoolSize=config.get("max_pool_size", 50),
minPoolSize=config.get("min_pool_size", 10),
maxIdleTimeMS=config.get("max_idle_time", 30000),
serverSelectionTimeoutMS=config.get("server_selection_timeout", 5000),
retryWrites=True,
retryReads=True
)
# Test connection
self.client.admin.command('ping')
# Setup database and collections
self.db = self.client[database_name]
self.short_collection = self.db.short_term_memory
self.long_collection = self.db.long_term_memory
# Create indexes for better performance
self._create_indexes()
def _create_indexes(self):
"""Create MongoDB indexes for better performance."""
try:
# Text search indexes
self.short_collection.create_index([("content", "text")])
self.long_collection.create_index([("content", "text")])
# Compound indexes for filtering
self.short_collection.create_index([("created_at", -1), ("metadata.quality", -1)])
self.long_collection.create_index([("created_at", -1), ("metadata.quality", -1)])
except Exception:
pass # Indexes might already exist
def store_short_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in MongoDB short-term collection."""
from datetime import datetime
import time
doc_id = str(time.time_ns())
doc = {
"_id": doc_id,
"content": text,
"metadata": metadata or {},
"created_at": datetime.now(datetime.timezone.utc),
"memory_type": "short_term"
}
self.short_collection.insert_one(doc)
return doc_id
def search_short_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search MongoDB short-term collection."""
search_filter = {"$text": {"$search": query}}
results = []
for doc in self.short_collection.find(search_filter).limit(limit):
results.append({
"id": str(doc["_id"]),
"text": doc["content"],
"metadata": doc.get("metadata", {}),
"score": 1.0
})
return results
def store_long_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in MongoDB long-term collection."""
from datetime import datetime
import time
doc_id = str(time.time_ns())
doc = {
"_id": doc_id,
"content": text,
"metadata": metadata or {},
"created_at": datetime.now(datetime.timezone.utc),
"memory_type": "long_term"
}
# Add embedding if vector search is enabled
if self.use_vector_search:
embedding = self._get_embedding(text)
if embedding:
doc["embedding"] = embedding
self.long_collection.insert_one(doc)
return doc_id
def search_long_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search MongoDB long-term collection."""
results = []
# Try vector search first if enabled
if self.use_vector_search:
embedding = self._get_embedding(query)
if embedding:
pipeline = [
{
"$vectorSearch": {
"index": "vector_index",
"path": "embedding",
"queryVector": embedding,
"numCandidates": limit * 10,
"limit": limit
}
},
{
"$addFields": {
"score": {"$meta": "vectorSearchScore"}
}
}
]
try:
for doc in self.long_collection.aggregate(pipeline):
results.append({
"id": str(doc["_id"]),
"text": doc["content"],
"metadata": doc.get("metadata", {}),
"score": doc.get("score", 1.0)
})
except Exception:
pass # Fall back to text search
# Fallback to text search
if not results:
search_filter = {"$text": {"$search": query}}
for doc in self.long_collection.find(search_filter).limit(limit):
results.append({
"id": str(doc["_id"]),
"text": doc["content"],
"metadata": doc.get("metadata", {}),
"score": 1.0
})
return results
def get_all_memories(self, **kwargs) -> List[Dict[str, Any]]:
"""Get all memories from both collections."""
results = []
# Get short-term memories
for doc in self.short_collection.find():
results.append({
"id": str(doc["_id"]),
"text": doc["content"],
"metadata": doc.get("metadata", {}),
"created_at": doc.get("created_at"),
"type": "short_term"
})
# Get long-term memories
for doc in self.long_collection.find():
results.append({
"id": str(doc["_id"]),
"text": doc["content"],
"metadata": doc.get("metadata", {}),
"created_at": doc.get("created_at"),
"type": "long_term"
})
return results
def _get_embedding(self, text: str) -> Optional[List[float]]:
"""Get embedding for text."""
try:
from praisonaiagents.embedding import embedding
result = embedding(text, model="text-embedding-3-small")
return result.embeddings[0] if result.embeddings else None
except Exception:
return None
@@ -1,73 +0,0 @@
"""
In-Memory Memory Adapter for PraisonAI.
Lightweight in-memory adapter for testing and development.
No dependencies required - stores data as plain Python lists.
"""
from typing import Any, Dict, List, Optional
class InMemoryAdapter:
"""
Lightweight in-memory adapter for testing and development.
Stores short-term and long-term memories as plain Python lists.
Data is not persisted across process restarts.
Usage:
adapter = InMemoryAdapter()
adapter.store_short_term("hello", {"source": "test"})
results = adapter.search_short_term("hello")
"""
def __init__(self, **kwargs) -> None:
self._data: List[Dict[str, Any]] = []
def store_short_term(
self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs
) -> str:
entry: Dict[str, Any] = {
"id": str(len(self._data)),
"text": text,
"type": "short",
"metadata": metadata,
}
self._data.append(entry)
return entry["id"]
def search_short_term(
self, query: str, limit: int = 5, **kwargs
) -> List[Dict[str, Any]]:
results = [
e
for e in self._data
if e["type"] == "short" and query.lower() in e["text"].lower()
]
return results[:limit]
def store_long_term(
self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs
) -> str:
entry: Dict[str, Any] = {
"id": str(len(self._data)),
"text": text,
"type": "long",
"metadata": metadata,
}
self._data.append(entry)
return entry["id"]
def search_long_term(
self, query: str, limit: int = 5, **kwargs
) -> List[Dict[str, Any]]:
results = [
e
for e in self._data
if e["type"] == "long" and query.lower() in e["text"].lower()
]
return results[:limit]
def get_all_memories(self, **kwargs) -> List[Dict[str, Any]]:
# Return defensive copy to prevent external mutation of internal state
return [dict(entry) for entry in self._data]
@@ -1,78 +0,0 @@
"""
Legacy Memory Adapter
This adapter wraps the existing Memory class to provide backward compatibility
while demonstrating the protocol-driven approach. This allows the core Memory
class to be gradually refactored while maintaining all existing functionality.
This approach follows the Strangler Fig pattern:
1. Create adapters that wrap existing implementations
2. Register them in the adapter registry
3. Core classes use adapters via registry instead of direct imports
4. Gradually move logic from legacy class to clean adapters
"""
import os
import uuid
from typing import Any, Dict, List, Optional
from ..protocols import MemoryProtocol
class LegacyMemoryAdapter:
"""
Adapter that wraps the existing Memory class to implement MemoryProtocol.
This enables the existing Memory implementation to work through the
adapter registry while we gradually refactor it to be more protocol-driven.
"""
def __init__(self, **kwargs):
"""Initialize legacy memory adapter by wrapping existing Memory class."""
# Import the original Memory class here to avoid circular imports
from .. import memory as memory_module
# Create instance of the original Memory class
config = kwargs.get("config", kwargs)
verbose = kwargs.get("verbose", 0)
self._memory = memory_module.Memory(config=config, verbose=verbose)
def store_short_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in short-term memory via legacy Memory class."""
self._memory.store_short_term(text, metadata=metadata, **kwargs)
# Generate a stable UUID instead of using unstable id(text)
return str(uuid.uuid4())
def search_short_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search short-term memory via legacy Memory class."""
return self._memory.search_short_term(query, limit=limit, **kwargs)
def store_long_term(self, text: str, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> str:
"""Store in long-term memory via legacy Memory class."""
self._memory.store_long_term(text, metadata=metadata, **kwargs)
# Generate a stable UUID instead of using unstable id(text)
return str(uuid.uuid4())
def search_long_term(self, query: str, limit: int = 5, **kwargs) -> List[Dict[str, Any]]:
"""Search long-term memory via legacy Memory class."""
return self._memory.search_long_term(query, limit=limit, **kwargs)
def get_all_memories(self, **kwargs) -> List[Dict[str, Any]]:
"""Get all memories via legacy Memory class."""
return self._memory.get_all_memories(**kwargs)
def create_legacy_memory_adapter(**kwargs) -> MemoryProtocol:
"""
Factory function to create legacy memory adapter.
This factory enables the existing Memory class to work through the
adapter registry without requiring immediate refactoring.
Args:
**kwargs: Configuration passed to legacy Memory class
Returns:
MemoryProtocol adapter instance wrapping legacy Memory
"""
return LegacyMemoryAdapter(**kwargs)
@@ -1,106 +0,0 @@
"""
Memory Adapter Registry
Provides a registry system for memory adapters to replace hardcoded imports
in memory/memory.py. This enables protocol-driven memory backends without
core modifications.
"""
from typing import Callable, List, Optional, Tuple, Type
from ...utils.adapter_registry import AdapterRegistry
from ..protocols import MemoryProtocol
class MemoryAdapterRegistry(AdapterRegistry[MemoryProtocol]):
"""
Thread-safe registry for memory adapters.
Replaces hardcoded _check_chromadb, _check_mem0, etc. in memory.py
with dynamic adapter discovery and instantiation.
Example:
```python
# Register adapter (typically done on import)
register_memory_adapter("sqlite", SQLiteAdapter)
register_memory_adapter("chroma", ChromaAdapter) # in wrapper
# Use in Memory class
adapter = get_memory_adapter("chroma", config=config)
```
"""
def __init__(self):
super().__init__(adapter_type_name="Memory")
# Global registry instance
_memory_registry = MemoryAdapterRegistry()
def register_memory_adapter(name: str, adapter_class: Type[MemoryProtocol]) -> None:
"""Register a memory adapter class."""
_memory_registry.register_adapter(name, adapter_class)
def register_memory_factory(name: str, factory_func: Callable[..., MemoryProtocol]) -> None:
"""Register a memory adapter factory function."""
_memory_registry.register_factory(name, factory_func)
def get_memory_adapter(name: str, **kwargs) -> Optional[MemoryProtocol]:
"""Get memory adapter instance by name."""
return _memory_registry.get_adapter(name, **kwargs)
def list_memory_adapters() -> List[str]:
"""List all registered memory adapter names."""
return _memory_registry.list_adapters()
# Canonical aliases per AGENTS.md naming conventions
def add_memory_adapter(name: str, adapter_class: Type[MemoryProtocol]) -> None:
"""Canonical alias for register_memory_adapter (preferred naming per AGENTS.md)."""
return register_memory_adapter(name, adapter_class)
def add_memory_factory(name: str, factory_func: Callable[..., MemoryProtocol]) -> None:
"""Canonical alias for register_memory_factory (preferred naming per AGENTS.md)."""
return register_memory_factory(name, factory_func)
def has_memory_adapter(name: str) -> bool:
"""Canonical alias for is_available (preferred naming per AGENTS.md)."""
return _memory_registry.is_available(name)
def get_first_available_memory_adapter(
preferences: Optional[List[str]] = None, **kwargs
) -> Optional[Tuple[str, MemoryProtocol]]:
"""
Get first available memory adapter.
Args:
preferences: List of adapter names to try (defaults to ["sqlite", "in_memory"])
**kwargs: Configuration passed to adapter constructor
Returns:
(adapter_name, adapter_instance) tuple or None
"""
if preferences is None:
preferences = ["sqlite", "in_memory"]
return _memory_registry.get_first_available(preferences, **kwargs)
__all__ = [
'MemoryAdapterRegistry',
'register_memory_adapter',
'register_memory_factory',
'get_memory_adapter',
'list_memory_adapters',
'get_first_available_memory_adapter',
# Canonical aliases (preferred)
'add_memory_adapter',
'add_memory_factory',
'has_memory_adapter',
]
@@ -8,7 +8,6 @@ and quality scoring logic. Split from the main memory.py file for better maintai
import json
import logging
import threading
import asyncio
from typing import Any, Dict, List, Optional
from datetime import datetime
@@ -17,9 +16,9 @@ class MemoryCoreMixin:
"""Mixin class containing core memory functionality for the Memory class."""
def store_short_term(self, content: str, metadata: Optional[Dict] = None, quality_score: Optional[float] = None,
user_id: Optional[str] = None, auto_promote: bool = True, **kwargs) -> str:
user_id: Optional[str] = None, auto_promote: bool = True) -> str:
"""
Store content in short-term memory using protocol-driven approach.
Store content in short-term memory.
Args:
content: The content to store
@@ -27,7 +26,6 @@ class MemoryCoreMixin:
quality_score: Optional pre-calculated quality score
user_id: Optional user identifier
auto_promote: Whether to automatically promote to LTM if quality is high
**kwargs: Additional provider-specific arguments
Returns:
The memory ID of the stored content
@@ -47,35 +45,37 @@ class MemoryCoreMixin:
metadata['user_id'] = user_id
metadata['timestamp'] = datetime.now().isoformat()
metadata['quality'] = quality_score
# Sanitize metadata for storage
clean_metadata = self._sanitize_metadata(metadata)
# Protocol-driven storage: Delegate to adapter first
memory_id = None
try:
if hasattr(self, 'memory_adapter') and self.memory_adapter:
memory_id = self.memory_adapter.store_short_term(content, metadata=clean_metadata, **kwargs)
self._log_verbose(f"Stored in {self.provider} STM via adapter: {content[:100]}...")
except Exception as e:
self._log_verbose(f"Failed to store in {self.provider} STM: {e}", logging.WARNING)
# Backward compatibility: Also store in SQLite if not using SQLite adapter
if hasattr(self, '_sqlite_adapter') and self._sqlite_adapter != getattr(self, 'memory_adapter', None):
# Store in vector store if available
if self.use_rag and hasattr(self, 'stm_collection'):
try:
fallback_id = self._sqlite_adapter.store_short_term(content, metadata=clean_metadata, **kwargs)
if not memory_id:
memory_id = fallback_id
memory_id = self._store_vector_stm(content, clean_metadata, quality_score)
except Exception as e:
logging.error(f"Failed to store in SQLite STM fallback: {e}")
if not memory_id:
return ""
logging.warning(f"Failed to store in vector STM: {e}")
if self.use_mongodb and hasattr(self, 'stm_collection'):
try:
memory_id = self._store_mongodb_stm(content, clean_metadata, quality_score)
except Exception as e:
logging.warning(f"Failed to store in MongoDB STM: {e}")
# Always store in SQLite as fallback
try:
if not memory_id:
memory_id = self._store_sqlite_stm(content, clean_metadata, quality_score)
except Exception as e:
logging.error(f"Failed to store in SQLite STM: {e}")
return ""
# Auto-promote to long-term memory if quality is high
if auto_promote and quality_score >= 7.5: # High quality threshold
try:
self.store_long_term(content, clean_metadata, quality_score, user_id, **kwargs)
self.store_long_term(content, clean_metadata, quality_score, user_id)
self._log_verbose(f"Auto-promoted STM content to LTM (score: {quality_score:.2f})")
except Exception as e:
logging.warning(f"Failed to auto-promote to LTM: {e}")
@@ -83,19 +83,20 @@ class MemoryCoreMixin:
# Emit memory event
self._emit_memory_event("store", "short_term", content, clean_metadata)
self._log_verbose(f"Stored in STM: {content[:100]}... (quality: {quality_score:.2f})")
return memory_id or ""
def store_long_term(self, content: str, metadata: Optional[Dict] = None, quality_score: Optional[float] = None,
user_id: Optional[str] = None, **kwargs) -> str:
user_id: Optional[str] = None) -> str:
"""
Store content in long-term memory using protocol-driven approach.
Store content in long-term memory.
Args:
content: The content to store
metadata: Optional metadata dictionary
quality_score: Optional pre-calculated quality score
user_id: Optional user identifier
**kwargs: Additional provider-specific arguments
Returns:
The memory ID of the stored content
@@ -121,34 +122,38 @@ class MemoryCoreMixin:
metadata['timestamp'] = datetime.now().isoformat()
metadata['promoted_at'] = datetime.now().isoformat()
metadata['quality'] = quality_score
# Sanitize metadata for storage
clean_metadata = self._sanitize_metadata(metadata)
# Protocol-driven storage: Delegate to adapter first
memory_id = None
try:
if hasattr(self, 'memory_adapter') and self.memory_adapter:
memory_id = self.memory_adapter.store_long_term(content, metadata=clean_metadata, **kwargs)
self._log_verbose(f"Stored in {self.provider} LTM via adapter: {content[:100]}...")
except Exception as e:
self._log_verbose(f"Failed to store in {self.provider} LTM: {e}", logging.WARNING)
# Backward compatibility: Also store in SQLite if not using SQLite adapter
if hasattr(self, '_sqlite_adapter') and self._sqlite_adapter != getattr(self, 'memory_adapter', None):
# Store in vector store if available
if self.use_rag and hasattr(self, 'ltm_collection'):
try:
fallback_id = self._sqlite_adapter.store_long_term(content, metadata=clean_metadata, **kwargs)
if not memory_id:
memory_id = fallback_id
memory_id = self._store_vector_ltm(content, clean_metadata, quality_score)
except Exception as e:
logging.error(f"Failed to store in SQLite LTM fallback: {e}")
if not memory_id:
return ""
logging.warning(f"Failed to store in vector LTM: {e}")
if self.use_mongodb and hasattr(self, 'ltm_collection'):
try:
memory_id = self._store_mongodb_ltm(content, clean_metadata, quality_score)
except Exception as e:
logging.warning(f"Failed to store in MongoDB LTM: {e}")
# Always store in SQLite as fallback
try:
if not memory_id:
memory_id = self._store_sqlite_ltm(content, clean_metadata, quality_score)
except Exception as e:
logging.error(f"Failed to store in SQLite LTM: {e}")
return ""
# Emit memory event
self._emit_memory_event("store", "long_term", content, clean_metadata)
self._log_verbose(f"Stored in LTM: {content[:100]}... (quality: {quality_score:.2f})")
return memory_id or ""
def compute_quality_score(self, content: str, metadata: Optional[Dict] = None,
@@ -299,86 +304,4 @@ class MemoryCoreMixin:
self._learn_manager = LearnManager(config=self._learn_config)
except ImportError:
logging.warning("Learn manager not available - install learn dependencies")
return self._learn_manager
# Async variants to prevent event loop blocking
async def store_short_term_async(self, content: str, metadata: Optional[Dict] = None, quality_score: Optional[float] = None,
user_id: Optional[str] = None, auto_promote: bool = True) -> str:
"""
Async version of store_short_term to prevent event loop blocking.
Args:
content: The content to store
metadata: Optional metadata dictionary
quality_score: Optional pre-calculated quality score
user_id: Optional user identifier
auto_promote: Whether to automatically promote to LTM if quality is high
Returns:
The memory ID of the stored content
"""
if not content.strip():
return ""
# Calculate quality score if not provided
if quality_score is None:
quality_score = self.compute_quality_score(content, metadata)
# Prepare metadata (mirror sync version's metadata construction including sanitization
# to ensure only JSON-serializable values are stored, preventing crashes across backends)
raw_metadata = metadata.copy() if metadata else {}
raw_metadata.update({
"timestamp": datetime.now().isoformat(),
"quality_score": quality_score,
"memory_type": "short_term"
})
if user_id:
raw_metadata["user_id"] = user_id
clean_metadata = self._sanitize_metadata(raw_metadata)
# Store in SQLite STM
memory_id = ""
try:
memory_id = await asyncio.to_thread(self._store_sqlite_stm, content, clean_metadata, quality_score)
except Exception as e:
logging.error(f"Failed to store in SQLite STM: {e}")
return ""
# Auto-promote to long-term memory if quality is high (async)
if auto_promote and quality_score >= 7.5: # High quality threshold
try:
await self.store_long_term_async(content, clean_metadata, quality_score, user_id)
self._log_verbose(f"Auto-promoted STM content to LTM (score: {quality_score:.2f})")
except Exception as e:
logging.warning(f"Failed to auto-promote to LTM: {e}")
# Emit memory event
self._emit_memory_event("store", "short_term", content, clean_metadata)
self._log_verbose(f"Stored in STM: {content[:100]}... (quality: {quality_score:.2f})")
return memory_id or ""
async def store_long_term_async(self, content: str, metadata: Optional[Dict] = None, quality_score: Optional[float] = None,
user_id: Optional[str] = None) -> str:
"""
Async version of store_long_term to prevent event loop blocking.
Args:
content: The content to store
metadata: Optional metadata dictionary
quality_score: Optional pre-calculated quality score
user_id: Optional user identifier
Returns:
The memory ID of the stored content
"""
if not content.strip():
return ""
# Calculate quality score if not provided
if quality_score is None:
quality_score = self.compute_quality_score(content, metadata)
# Use sync version in thread to avoid blocking event loop
return await asyncio.to_thread(self.store_long_term, content, metadata, quality_score, user_id)
return self._learn_manager
@@ -14,21 +14,166 @@ from .storage import StorageMixin
from .search import SearchMixin
from .core import MemoryCoreMixin
# Protocol-driven imports (AGENTS.md compliant)
from .protocols import MemoryProtocol
from .adapters import get_memory_adapter, get_first_available_memory_adapter
from .adapters.sqlite_adapter import SqliteMemoryAdapter
# Disable litellm telemetry before any imports
os.environ["LITELLM_TELEMETRY"] = "False"
# Set up logger using centralized logging utility
# Keep existing custom TRACE level functionality for this module
from .._logging import get_logger
logger = get_logger(__name__, extra_data={"subsystem": "memory"})
# Add custom TRACE level (below DEBUG)
TRACE_LEVEL = 5
logging.addLevelName(TRACE_LEVEL, 'TRACE')
def trace(self, message, *args, **kwargs):
if self.isEnabledFor(TRACE_LEVEL):
self._log(TRACE_LEVEL, message, args, **kwargs)
logging.Logger.trace = trace
# Thread-safe lazy imports using proper thread synchronization
import threading
# Thread-safe import cache
_import_lock = threading.Lock()
_module_cache = {}
def _check_chromadb():
"""Thread-safe lazy check for chromadb availability."""
if "chromadb" in _module_cache:
return _module_cache["chromadb"]["available"]
with _import_lock:
if "chromadb" in _module_cache:
return _module_cache["chromadb"]["available"]
try:
import chromadb
from chromadb.config import Settings as ChromaSettings
_module_cache["chromadb"] = {
"available": True,
"module": chromadb,
"settings": ChromaSettings
}
except ImportError:
_module_cache["chromadb"] = {"available": False}
return _module_cache["chromadb"]["available"]
def _get_chromadb():
"""Get chromadb module and settings (thread-safe lazy load)."""
if not _check_chromadb():
raise ImportError("chromadb is required. Install with: pip install chromadb")
return _module_cache["chromadb"]["module"], _module_cache["chromadb"]["settings"]
def _check_mem0():
"""Thread-safe lazy check for mem0 availability."""
if "mem0" in _module_cache:
return _module_cache["mem0"]["available"]
with _import_lock:
if "mem0" in _module_cache:
return _module_cache["mem0"]["available"]
try:
import mem0
_module_cache["mem0"] = {
"available": True,
"module": mem0
}
except ImportError:
_module_cache["mem0"] = {"available": False}
return _module_cache["mem0"]["available"]
def _get_mem0():
"""Get mem0 module (thread-safe lazy load)."""
if not _check_mem0():
raise ImportError("mem0 is required. Install with: pip install mem0ai")
return _module_cache["mem0"]["module"]
def _check_openai():
"""Thread-safe lazy check for openai availability."""
if "openai" in _module_cache:
return _module_cache["openai"]["available"]
with _import_lock:
if "openai" in _module_cache:
return _module_cache["openai"]["available"]
try:
import openai
_module_cache["openai"] = {
"available": True,
"module": openai
}
except ImportError:
_module_cache["openai"] = {"available": False}
return _module_cache["openai"]["available"]
def _get_openai():
"""Get openai module (thread-safe lazy load)."""
if not _check_openai():
raise ImportError("openai is required. Install with: pip install openai")
return _module_cache["openai"]["module"]
def _check_litellm():
"""Thread-safe lazy check for litellm availability."""
if "litellm" in _module_cache:
return _module_cache["litellm"]["available"]
with _import_lock:
if "litellm" in _module_cache:
return _module_cache["litellm"]["available"]
try:
import litellm
litellm.telemetry = False
_module_cache["litellm"] = {
"available": True,
"module": litellm
}
except ImportError:
_module_cache["litellm"] = {"available": False}
return _module_cache["litellm"]["available"]
def _get_litellm():
"""Get litellm module (thread-safe lazy load)."""
if not _check_litellm():
raise ImportError("litellm is required. Install with: pip install litellm")
return _module_cache["litellm"]["module"]
def _check_pymongo():
"""Thread-safe lazy check for pymongo availability."""
if "pymongo" in _module_cache:
return _module_cache["pymongo"]["available"]
with _import_lock:
if "pymongo" in _module_cache:
return _module_cache["pymongo"]["available"]
try:
import pymongo
from pymongo import MongoClient
_module_cache["pymongo"] = {
"available": True,
"module": pymongo,
"client": MongoClient
}
except ImportError:
_module_cache["pymongo"] = {"available": False}
return _module_cache["pymongo"]["available"]
def _get_pymongo():
"""Get pymongo module and MongoClient (thread-safe lazy load)."""
if not _check_pymongo():
raise ImportError("pymongo is required. Install with: pip install pymongo")
return _module_cache["pymongo"]["module"], _module_cache["pymongo"]["client"]
class Memory(StorageMixin, SearchMixin, MemoryCoreMixin):
@@ -97,96 +242,41 @@ class Memory(StorageMixin, SearchMixin, MemoryCoreMixin):
self.cfg = config or {}
self.verbose = verbose
# Thread-local storage for SQLite connections (thread-safe)
self._local = threading.local()
# Write lock for serializing database modifications (thread-safe)
self._write_lock = threading.Lock()
# Connection registry for cleanup across threads (use regular set with careful cleanup)
self._all_connections = set()
self._connection_lock = threading.Lock() # Protect the connection registry
# Set logger level based on verbose
if verbose >= 5:
logger.setLevel(10) # DEBUG
else:
logger.setLevel(30) # WARNING
# Suppress noisy loggers from dependencies
self._configure_dependency_logging()
# Initialize core protocol-driven memory system
self._init_protocol_driven_memory()
# Backward compatibility: Initialize SQLite-based STM/LTM for legacy API
self._init_legacy_compatibility()
# Initialize learning manager if configured
# Also set ChromaDB and OpenAI client loggers to WARNING
import logging as _logging
get_logger('chromadb').setLevel(_logging.WARNING)
get_logger('openai').setLevel(_logging.WARNING)
get_logger('httpx').setLevel(_logging.WARNING)
get_logger('httpcore').setLevel(_logging.WARNING)
get_logger('chromadb.segment.impl.vector.local_persistent_hnsw').setLevel(_logging.ERROR)
get_logger('utils').setLevel(_logging.WARNING)
get_logger('litellm.utils').setLevel(logging.WARNING)
self.provider = self.cfg.get("provider", "rag")
self.use_mem0 = (self.provider.lower() == "mem0") and _check_mem0()
self.use_rag = (self.provider.lower() == "rag") and _check_chromadb() and self.cfg.get("use_embedding", False)
self.use_mongodb = (self.provider.lower() == "mongodb") and _check_pymongo()
self.graph_enabled = False # Initialize graph support flag
self._learn_manager = None # Lazy-loaded LearnManager
self._learn_config = self.cfg.get("learn", None) # Learn configuration
def _configure_dependency_logging(self):
"""Suppress verbose logging from heavy dependencies."""
import logging as _logging
for logger_name in [
'chromadb', 'openai', 'httpx', 'httpcore', 'litellm.utils',
'chromadb.segment.impl.vector.local_persistent_hnsw', 'utils'
]:
get_logger(logger_name).setLevel(_logging.WARNING)
def _init_protocol_driven_memory(self):
"""Initialize memory using adapter registry (protocol-driven approach)."""
# Determine provider preference
provider = self.cfg.get("provider", "rag").lower()
self._log_verbose(f"Requested memory provider: {provider}")
# Map legacy provider names to adapter names
provider_mapping = {
"rag": "chroma", # Legacy "rag" provider uses ChromaDB
"mem0": "mem0",
"mongodb": "mongodb",
"sqlite": "sqlite",
"none": "in_memory"
}
adapter_name = provider_mapping.get(provider, provider)
# Try to get preferred adapter, fallback to available ones
try:
adapter_config = self._get_adapter_config_for_provider(adapter_name)
adapter = get_memory_adapter(adapter_name, **adapter_config)
except RuntimeError as exc:
self._log_verbose(
f"Failed to initialize '{adapter_name}': {exc}",
logging.WARNING,
)
adapter = None
if adapter is None:
# Fallback to first available adapter
self._log_verbose(f"Provider '{adapter_name}' not available, trying fallbacks")
# Try each fallback preference individually
for fallback_provider in ["sqlite", "in_memory"]:
try:
fallback_config = self._get_adapter_config_for_provider(fallback_provider)
adapter = get_memory_adapter(fallback_provider, **fallback_config)
if adapter:
adapter_name = fallback_provider
self._log_verbose(f"Using fallback adapter: {adapter_name}")
break
except Exception as e:
self._log_verbose(f"Fallback {fallback_provider} failed: {e}")
continue
if not adapter:
raise RuntimeError("No memory adapters available")
# Store adapter and metadata
self.memory_adapter = adapter
self.provider = adapter_name
self._log_verbose(f"Initialized memory adapter: {adapter_name}")
# Set legacy flags for backward compatibility
self.use_mem0 = (adapter_name == "mem0")
self.use_rag = (adapter_name == "chroma")
self.use_mongodb = (adapter_name == "mongodb")
self.use_embedding = adapter_name in ['chroma', 'mongodb']
# Check if adapter supports advanced features
self.graph_enabled = hasattr(adapter, 'graph_enabled') and adapter.graph_enabled
# Extract embedding model for legacy compatibility
# Extract embedding model from config
self.embedder_config = self.cfg.get("embedder", {})
if isinstance(self.embedder_config, dict):
embedder_model_config = self.embedder_config.get("config", {})
@@ -194,86 +284,32 @@ class Memory(StorageMixin, SearchMixin, MemoryCoreMixin):
else:
self.embedding_model = "text-embedding-3-small"
# Determine embedding dimensions for legacy compatibility
self._log_verbose(f"Using embedding model: {self.embedding_model}")
# Determine embedding dimensions based on model
self.embedding_dimensions = self._get_embedding_dimensions(self.embedding_model)
self._log_verbose(f"Using embedding dimensions: {self.embedding_dimensions}")
def _get_adapter_config(self) -> Dict[str, Any]:
"""Get configuration for adapter initialization."""
# Only include adapter-relevant configuration
config = {}
# Add embedding model configuration
embedder_config = self.cfg.get("embedder", {})
if isinstance(embedder_config, dict):
embedder_model_config = embedder_config.get("config", {})
config["embedding_model"] = embedder_model_config.get("model", "text-embedding-3-small")
else:
config["embedding_model"] = "text-embedding-3-small"
# Add project data directory paths for file-based adapters
# Create project data directory if it doesn't exist
from ..paths import get_project_data_dir
project_data = str(get_project_data_dir())
os.makedirs(project_data, exist_ok=True)
config["short_db"] = self.cfg.get("short_db", os.path.join(project_data, "short_term.db"))
config["long_db"] = self.cfg.get("long_db", os.path.join(project_data, "long_term.db"))
config["rag_db_path"] = self.cfg.get("rag_db_path", os.path.join(project_data, "chroma_db"))
config["verbose"] = self.verbose
# Add specific configurations for different adapters
if "config" in self.cfg:
config["config"] = self.cfg["config"]
return config
_project_data = str(get_project_data_dir())
os.makedirs(_project_data, exist_ok=True)
def _get_adapter_config_for_provider(self, provider_name: str) -> Dict[str, Any]:
"""Get configuration tailored for specific provider."""
base_config = self._get_adapter_config()
# Filter configuration based on provider requirements
if provider_name == "sqlite":
return {
"short_db": base_config["short_db"],
"long_db": base_config["long_db"],
"verbose": base_config["verbose"]
}
elif provider_name == "in_memory":
return {
"verbose": base_config.get("verbose", 0)
}
elif provider_name in ["mem0", "chroma", "mongodb"]:
# Factory-based adapters accept full config
return base_config
else:
# Default: return base config and let adapter handle filtering
return base_config
# Short-term DB
self.short_db = self.cfg.get("short_db", os.path.join(_project_data, "short_term.db"))
self._init_stm()
def _init_legacy_compatibility(self):
"""Initialize legacy compatibility layer for direct SQLite access."""
# For backward compatibility, maintain direct SQLite connections
# This ensures existing code that accesses _get_stm_conn() still works
from ..paths import get_project_data_dir
project_data = str(get_project_data_dir())
self.short_db = self.cfg.get("short_db", os.path.join(project_data, "short_term.db"))
self.long_db = self.cfg.get("long_db", os.path.join(project_data, "long_term.db"))
# Only create separate SQLite adapter if primary adapter is not SQLite
if self.provider != "sqlite":
self._sqlite_adapter = SqliteMemoryAdapter(
short_db=self.short_db,
long_db=self.long_db,
verbose=self.verbose
)
else:
# Reuse the primary adapter
self._sqlite_adapter = self.memory_adapter
# Thread-local storage and locks (for legacy compatibility)
self._local = self._sqlite_adapter._local
self._write_lock = self._sqlite_adapter._write_lock
self._all_connections = self._sqlite_adapter._all_connections
self._connection_lock = self._sqlite_adapter._connection_lock
# Long-term DB
self.long_db = self.cfg.get("long_db", os.path.join(_project_data, "long_term.db"))
self._init_ltm()
# Conditionally init Mem0, MongoDB, or local RAG
if self.use_mem0:
self._init_mem0()
elif self.use_mongodb:
self._init_mongodb()
elif self.use_rag:
self._init_chroma()
def _get_stm_conn(self):
"""Get thread-local short-term memory SQLite connection."""
@@ -906,7 +942,7 @@ class Memory(StorageMixin, SearchMixin, MemoryCoreMixin):
from praisonaiagents.embedding import embedding as get_embedding
logger.info("Getting embeddings...")
logger.log(TRACE_LEVEL, f"Embedding input text: {text}")
logger.trace(f"Embedding input text: {text}")
result = get_embedding(text, model=self.embedding_model)
embedding = result.embeddings[0] if result.embeddings else None
@@ -916,7 +952,7 @@ class Memory(StorageMixin, SearchMixin, MemoryCoreMixin):
return
logger.info("Successfully got embeddings")
logger.log(TRACE_LEVEL, f"Received embedding of length: {len(embedding)}")
logger.trace(f"Received embedding of length: {len(embedding)}")
# Sanitize metadata for ChromaDB
sanitized_metadata = self._sanitize_metadata(metadata)
@@ -15,9 +15,9 @@ class SearchMixin:
"""Mixin class containing search and retrieval methods for the Memory class."""
def search_short_term(self, query: str, limit: int = 5, metadata_filter: Optional[Dict] = None,
min_quality: Optional[float] = None, user_id: Optional[str] = None, **kwargs) -> List[Dict[str, Any]]:
min_quality: Optional[float] = None, user_id: Optional[str] = None) -> List[Dict[str, Any]]:
"""
Search short-term memory for relevant content using protocol-driven approach.
Search short-term memory for relevant content.
Args:
query: Search query string
@@ -25,58 +25,38 @@ class SearchMixin:
metadata_filter: Optional metadata filter
min_quality: Minimum quality score threshold
user_id: Optional user ID for filtering
**kwargs: Additional provider-specific arguments
Returns:
List of relevant memory entries
"""
results = []
# Protocol-driven search: Delegate to adapter first
# Search in vector store (ChromaDB/MongoDB) if available
if self.use_rag and hasattr(self, 'stm_collection'):
try:
results.extend(self._search_vector_stm(query, limit))
except Exception as e:
logging.warning(f"Vector STM search failed: {e}")
if self.use_mongodb and hasattr(self, 'stm_collection'):
try:
results.extend(self._search_mongodb_stm(query, limit, metadata_filter, min_quality, user_id))
except Exception as e:
logging.warning(f"MongoDB STM search failed: {e}")
# Search in SQLite as fallback
try:
if hasattr(self, 'memory_adapter') and self.memory_adapter:
adapter_results = self.memory_adapter.search_short_term(
query, limit=limit, user_id=user_id, agent_id=kwargs.get('agent_id'),
run_id=kwargs.get('run_id'), **kwargs
)
# Convert adapter results to legacy format
if isinstance(adapter_results, list):
for result in adapter_results:
if hasattr(result, 'text') and hasattr(result, 'metadata'):
# SearchResult from protocol
results.append({
"id": getattr(result, 'id', ''),
"text": result.text,
"metadata": result.metadata or {},
"score": getattr(result, 'score', 1.0)
})
elif isinstance(result, dict):
# Already in legacy format
results.append(result)
self._log_verbose(f"Found {len(results)} results in {self.provider} STM via adapter")
sqlite_results = self._search_sqlite_stm(query, limit, metadata_filter, min_quality, user_id)
results.extend(sqlite_results)
except Exception as e:
self._log_verbose(f"Failed to search {self.provider} STM: {e}", logging.WARNING)
# Apply quality filtering if specified
if min_quality is not None:
results = [r for r in results if r.get("metadata", {}).get("quality", 0.0) >= min_quality]
# Apply metadata filtering if specified
if metadata_filter:
filtered_results = []
for result in results:
metadata = result.get("metadata", {})
if all(metadata.get(k) == v for k, v in metadata_filter.items()):
filtered_results.append(result)
results = filtered_results
logging.warning(f"SQLite STM search failed: {e}")
return self._deduplicate_and_rank_results(results, limit)
def search_long_term(self, query: str, limit: int = 10, metadata_filter: Optional[Dict] = None,
min_quality: Optional[float] = None, user_id: Optional[str] = None, **kwargs) -> List[Dict[str, Any]]:
min_quality: Optional[float] = None, user_id: Optional[str] = None) -> List[Dict[str, Any]]:
"""
Search long-term memory for relevant content using protocol-driven approach.
Search long-term memory for relevant content.
Args:
query: Search query string
@@ -84,51 +64,31 @@ class SearchMixin:
metadata_filter: Optional metadata filter
min_quality: Minimum quality score threshold
user_id: Optional user ID for filtering
**kwargs: Additional provider-specific arguments
Returns:
List of relevant memory entries
"""
results = []
# Protocol-driven search: Delegate to adapter first
# Search in vector store (ChromaDB/MongoDB) if available
if self.use_rag and hasattr(self, 'ltm_collection'):
try:
results.extend(self._search_vector_ltm(query, limit))
except Exception as e:
logging.warning(f"Vector LTM search failed: {e}")
if self.use_mongodb and hasattr(self, 'ltm_collection'):
try:
results.extend(self._search_mongodb_ltm(query, limit, metadata_filter, min_quality, user_id))
except Exception as e:
logging.warning(f"MongoDB LTM search failed: {e}")
# Search in SQLite as fallback
try:
if hasattr(self, 'memory_adapter') and self.memory_adapter:
adapter_results = self.memory_adapter.search_long_term(
query, limit=limit, user_id=user_id, agent_id=kwargs.get('agent_id'),
run_id=kwargs.get('run_id'), **kwargs
)
# Convert adapter results to legacy format
if isinstance(adapter_results, list):
for result in adapter_results:
if hasattr(result, 'text') and hasattr(result, 'metadata'):
# SearchResult from protocol
results.append({
"id": getattr(result, 'id', ''),
"text": result.text,
"metadata": result.metadata or {},
"score": getattr(result, 'score', 1.0)
})
elif isinstance(result, dict):
# Already in legacy format
results.append(result)
self._log_verbose(f"Found {len(results)} results in {self.provider} LTM via adapter")
sqlite_results = self._search_sqlite_ltm(query, limit, metadata_filter, min_quality, user_id)
results.extend(sqlite_results)
except Exception as e:
self._log_verbose(f"Failed to search {self.provider} LTM: {e}", logging.WARNING)
# Apply quality filtering if specified
if min_quality is not None:
results = [r for r in results if r.get("metadata", {}).get("quality", 0.0) >= min_quality]
# Apply metadata filtering if specified
if metadata_filter:
filtered_results = []
for result in results:
metadata = result.get("metadata", {})
if all(metadata.get(k) == v for k, v in metadata_filter.items()):
filtered_results.append(result)
results = filtered_results
logging.warning(f"SQLite LTM search failed: {e}")
return self._deduplicate_and_rank_results(results, limit)
@@ -115,9 +115,8 @@ def enable(plugins: list = None) -> None:
from .manager import get_plugin_manager
manager = get_plugin_manager()
# Auto-discover plugins from default directories and entry points
# Auto-discover plugins from default directories
manager.auto_discover_plugins()
manager.discover_entry_points()
# Enable specific plugins or all
if plugins is not None:
@@ -57,24 +57,23 @@ class PluginManager:
Returns:
True if registered successfully
"""
with self._lock:
try:
info = plugin.info
if info.name in self._plugins:
logger.warning(f"Plugin '{info.name}' already registered")
return False
self._plugins[info.name] = plugin
self._enabled[info.name] = True
# Initialize plugin
plugin.on_init({})
logger.info(f"Registered plugin: {info.name} v{info.version}")
return True
except Exception as e:
logger.error(f"Failed to register plugin: {e}")
try:
info = plugin.info
if info.name in self._plugins:
logger.warning(f"Plugin '{info.name}' already registered")
return False
self._plugins[info.name] = plugin
self._enabled[info.name] = True
# Initialize plugin
plugin.on_init({})
logger.info(f"Registered plugin: {info.name} v{info.version}")
return True
except Exception as e:
logger.error(f"Failed to register plugin: {e}")
return False
def unregister(self, name: str) -> bool:
"""
@@ -424,99 +423,6 @@ class PluginManager:
def get_single_file_plugin(self, name: str) -> Optional[Dict[str, Any]]:
"""Get a single-file plugin by name."""
return self._single_file_plugins.get(name)
def discover_entry_points(self) -> int:
"""
Discover plugins registered via pip entry_points.
Looks for entry_points in the "praisonaiagents.plugins" group.
Compatible with Python 3.8+ using importlib.metadata backport.
Returns:
Number of plugins loaded
"""
# Lazy import to reduce startup time
def _get_entry_points():
try:
from importlib.metadata import entry_points as _ep
return _ep
except ImportError:
logger.warning("importlib.metadata not available - cannot discover entry_points plugins")
return None
get_ep = _get_entry_points()
if get_ep is None:
return 0
try:
# Python 3.10+ style - try group= first
eps = get_ep(group="praisonaiagents.plugins")
except TypeError:
# Python 3.9 fallback - call then get group
try:
all_eps = get_ep()
eps = all_eps.get("praisonaiagents.plugins", [])
except Exception:
eps = []
loaded = 0
# Use lock to ensure thread-safe discovery of multiple entry points
with self._lock:
for ep in eps:
try:
plugin_class = ep.load()
plugin = plugin_class()
# register() also acquires lock but that's fine (RLock allows re-entry)
if self.register(plugin):
loaded += 1
logger.info(f"Loaded entry_point plugin: {ep.name}")
except Exception as e:
logger.error(f"Failed to load entry_point plugin {ep.name}: {e}")
return loaded
# =========================================================================
# Entry Point Discovery Support (External Packages)
# =========================================================================
def discover_entry_points(self) -> int:
"""
Auto-discover and load protocol-driven plugins installed via pip
that register in the 'praisonai.plugins' entry-point group.
Returns:
Number of plugins loaded successfully.
"""
loaded = 0
try:
import importlib.metadata
# Python 3.10+
entry_points = importlib.metadata.entry_points(group="praisonai.plugins")
except ImportError:
logger.debug("importlib.metadata not available. Cannot discover plugins.")
return 0
except TypeError:
# Python 3.8/3.9 fallback
try:
entry_points = importlib.metadata.entry_points().get("praisonai.plugins", [])
except Exception as e:
logger.error(f"Failed to get entry points: {e}")
return 0
for ep in entry_points:
try:
plugin_cls = ep.load()
# Duck-type check or inheritance check isn't strictly necessary if it conforms to Plugin interface at runtime
if callable(plugin_cls):
plugin = plugin_cls()
if self.register(plugin):
loaded += 1
else:
logger.warning(f"Entry point {ep.name} is not callable")
except Exception as e:
logger.error(f"Failed to load plugin from entry point {ep.name}: {e}")
return loaded
# Global plugin manager instance
_default_manager: Optional[PluginManager] = None
@@ -1,7 +1,5 @@
import logging
import asyncio
import threading
import time
import json
from typing import Dict, Optional, List, Any, AsyncGenerator
from pydantic import BaseModel, ConfigDict
@@ -27,8 +25,6 @@ class Process:
manager_llm: Optional[str] = None,
verbose: bool = False,
max_iter: int = 10,
max_retries: int = 3,
workflow_timeout: Optional[int] = None, # seconds, None = no timeout
output: Optional[str] = None,
):
logging.debug(f"=== Initializing Process ===")
@@ -41,11 +37,9 @@ class Process:
self.agents = agents
self.manager_llm = manager_llm
self.max_iter = max_iter
self.max_retries = max_retries
self.workflow_timeout = workflow_timeout
self.task_retry_counter: Dict[str, int] = {} # Initialize retry counter
self.workflow_finished = False # ADDED: Workflow finished flag
self._state_lock = None # Lazy-initialized async lock for shared state protection
self._state_lock = asyncio.Lock() # Async lock for shared state protection
# Resolve verbose from output= param (takes precedence) or legacy verbose= param
if output is not None:
@@ -239,7 +233,7 @@ class Process:
if hasattr(task, 'description') and 'Input data from previous tasks:' in task.description:
task.description = task.description.split('Input data from previous tasks:')[0].strip()
while fallback_attempts < self.max_retries and not temp_current_task:
while fallback_attempts < Process.DEFAULT_RETRY_LIMIT and not temp_current_task:
fallback_attempts += 1
logging.debug(f"Fallback attempt {fallback_attempts}: Trying to find next 'not started' task.")
for task_candidate in self.tasks.values():
@@ -254,13 +248,13 @@ class Process:
if not leads_to_task and not task_candidate.next_tasks:
continue # Skip if no valid path exists
if self.task_retry_counter.get(task_candidate.id, 0) < self.max_retries:
if self.task_retry_counter.get(task_candidate.id, 0) < Process.DEFAULT_RETRY_LIMIT:
self.task_retry_counter[task_candidate.id] = self.task_retry_counter.get(task_candidate.id, 0) + 1
temp_current_task = task_candidate
logging.debug(f"Fallback attempt {fallback_attempts}: Found 'not started' task: {temp_current_task.name}, retry count: {self.task_retry_counter[temp_current_task.id]}")
return temp_current_task # Return the found task immediately
else:
logging.debug(f"Max retries ({self.max_retries}) reached for task {task_candidate.name} in fallback mode, marking as failed.")
logging.debug(f"Max retries reached for task {task_candidate.name} in fallback mode, marking as failed.")
task_candidate.status = "failed"
if not temp_current_task:
logging.debug(f"Fallback attempt {fallback_attempts}: No 'not started' task found within retry limit.")
@@ -389,7 +383,6 @@ class Process:
"""Async version of workflow method"""
logging.debug("=== Starting Async Workflow ===")
current_iter = 0 # Track how many times we've looped
workflow_start = time.monotonic() # For timeout enforcement
# Build workflow relationships first
logging.debug("Building workflow relationships...")
for task in self.tasks.values():
@@ -425,13 +418,6 @@ class Process:
logging.info(f"Max iteration limit {self.max_iter} reached, ending workflow.")
break
# Enforce workflow timeout if set
if self.workflow_timeout is not None:
elapsed = time.monotonic() - workflow_start
if elapsed > self.workflow_timeout:
logging.warning(f"Workflow timeout ({self.workflow_timeout}s) exceeded after {elapsed:.1f}s, stopping.")
break
# ADDED: Check workflow finished flag at the start of each cycle
if self.workflow_finished:
logging.info("Workflow finished early as all tasks are completed.")
@@ -469,13 +455,11 @@ Context tasks: {[t.name for t in current_task.context] if current_task.context e
Description length: {len(current_task.description)}
""")
# Build context and set description for this execution pass only
# Add context from previous tasks to description
context = self._build_task_context(current_task)
# Store original description if not already stored
if not hasattr(current_task, '_original_description'):
current_task._original_description = current_task.description
# Set description with context for execution; reset after yield to prevent accumulation
current_task.description = current_task._original_description + (context if context else "")
if context:
# Update task description with context
current_task.description = current_task.description + context
# Skip execution for loop tasks, only process their subtasks
if current_task.task_type == "loop":
@@ -582,9 +566,6 @@ Subtask: {st.name}
logging.debug(f"Task next_tasks: {current_task.next_tasks}")
yield task_id
visited_tasks.add(task_id)
# Reset description to original after execution to prevent context accumulation
if hasattr(current_task, '_original_description'):
current_task.description = current_task._original_description
# Only end workflow if no next_tasks AND no conditions
if not current_task.next_tasks and not current_task.condition and not any(
@@ -596,31 +577,28 @@ Subtask: {st.name}
current_task = None
break
# Reset completed task to "not started" so it can run again (atomic operation)
if self._state_lock is None:
self._state_lock = asyncio.Lock()
async with self._state_lock:
if self.tasks[task_id].status == "completed":
# Never reset loop tasks, decision tasks, or their subtasks if rerun is False
subtask_name = self.tasks[task_id].name
task_to_check = self.tasks[task_id]
logging.debug(f"=== Checking reset for completed task: {subtask_name} ===")
logging.debug(f"Task type: {task_to_check.task_type}")
logging.debug(f"Task status before reset check: {task_to_check.status}")
logging.debug(f"Task rerun: {getattr(task_to_check, 'rerun', True)}") # default to True if not set
logging.debug(f"Task async_execution: {task_to_check.async_execution}")
# Reset completed task to "not started" so it can run again
if self.tasks[task_id].status == "completed":
# Never reset loop tasks, decision tasks, or their subtasks if rerun is False
subtask_name = self.tasks[task_id].name
task_to_check = self.tasks[task_id]
logging.debug(f"=== Checking reset for completed task: {subtask_name} ===")
logging.debug(f"Task type: {task_to_check.task_type}")
logging.debug(f"Task status before reset check: {task_to_check.status}")
logging.debug(f"Task rerun: {getattr(task_to_check, 'rerun', True)}") # default to True if not set
logging.debug(f"Task async_execution: {task_to_check.async_execution}")
if (getattr(task_to_check, 'rerun', True) and # Corrected condition - reset only if rerun is True (or default True)
task_to_check.task_type != "loop" and # Removed "decision" from exclusion
not any(t.task_type == "loop" and subtask_name.startswith(t.name + "_")
for t in self.tasks.values()) and
not task_to_check.async_execution): # Don't reset async parallel tasks
logging.debug(f"=== Resetting non-loop, non-decision, non-parallel task {subtask_name} to 'not started' ===")
self.tasks[task_id].status = "not started"
logging.debug(f"Task status after reset: {self.tasks[task_id].status}")
else:
logging.debug(f"=== Skipping reset for loop/decision/subtask/parallel or rerun=False: {subtask_name} ===")
logging.debug(f"Keeping status as: {self.tasks[task_id].status}")
if (getattr(task_to_check, 'rerun', True) and # Corrected condition - reset only if rerun is True (or default True)
task_to_check.task_type != "loop" and # Removed "decision" from exclusion
not any(t.task_type == "loop" and subtask_name.startswith(t.name + "_")
for t in self.tasks.values()) and
not task_to_check.async_execution): # Don't reset async parallel tasks
logging.debug(f"=== Resetting non-loop, non-decision, non-parallel task {subtask_name} to 'not started' ===")
self.tasks[task_id].status = "not started"
logging.debug(f"Task status after reset: {self.tasks[task_id].status}")
else:
logging.debug(f"=== Skipping reset for loop/decision/subtask/parallel or rerun=False: {subtask_name} ===")
logging.debug(f"Keeping status as: {self.tasks[task_id].status}")
# Handle loop progression
if current_task.task_type == "loop":
@@ -1138,13 +1116,11 @@ Context tasks: {[t.name for t in current_task.context] if current_task.context e
Description length: {len(current_task.description)}
""")
# Build context and set description for this execution pass only
# Add context from previous tasks to description
context = self._build_task_context(current_task)
# Store original description if not already stored
if not hasattr(current_task, '_original_description'):
current_task._original_description = current_task.description
# Set description with context for execution; reset after yield to prevent accumulation
current_task.description = current_task._original_description + (context if context else "")
if context:
# Update task description with context
current_task.description = current_task.description + context
# Skip execution for loop tasks, only process their subtasks
if current_task.task_type == "loop":
@@ -1251,9 +1227,6 @@ Subtask: {st.name}
logging.debug(f"Task next_tasks: {current_task.next_tasks}")
yield task_id
visited_tasks.add(task_id)
# Reset description to original after execution to prevent context accumulation
if hasattr(current_task, '_original_description'):
current_task.description = current_task._original_description
# Only end workflow if no next_tasks AND no conditions
if not current_task.next_tasks and not current_task.condition and not any(
@@ -31,34 +31,16 @@ class DefaultCitationFormatter:
citations = []
for i, result in enumerate(results):
# Handle both dict and dataclass formats
is_dict = isinstance(result, dict)
# Extract text field
if is_dict:
text = result.get("text") or result.get("memory", "")
else:
text = getattr(result, "text", None) or getattr(result, "memory", None) or ""
# CRITICAL: Handle metadata=None - ensure always dict
if is_dict:
metadata = result.get("metadata") or {}
else:
metadata = getattr(result, "metadata", None)
if metadata is None:
metadata = {}
score = result.get("score", 0.0) if is_dict else getattr(result, "score", 0.0)
# Handle different result formats
text = result.get("text") or result.get("memory", "")
# CRITICAL: Handle metadata=None from mem0 - ensure always dict
metadata = result.get("metadata") or {}
score = result.get("score", 0.0)
# Extract source info
source = metadata.get("source", "")
filename = metadata.get("filename", "")
if is_dict:
doc_id = result.get("id") or metadata.get("doc_id", "")
else:
doc_id = getattr(result, "id", None) or metadata.get("doc_id", "")
doc_id = result.get("id") or metadata.get("doc_id", "")
chunk_id = metadata.get("chunk_id", "")
citation = Citation(
@@ -181,18 +163,13 @@ class RAG:
# Handle different result formats
if isinstance(results, dict):
results = results.get("results", [])
elif hasattr(results, "results") and isinstance(getattr(results, "results"), list):
results = getattr(results, "results")
# Filter by minimum score
if self.config.min_score > 0:
filtered = []
for r in results:
# Handle both dict and dataclass/pydantic models
score = r.get("score", 0) if isinstance(r, dict) else getattr(r, "score", 0)
if score >= self.config.min_score:
filtered.append(r)
results = filtered
results = [
r for r in results
if r.get("score", 0) >= self.config.min_score
]
# Limit to top_k
results = results[:self.config.top_k]
@@ -118,67 +118,6 @@ class RAGProtocol(Protocol):
...
@runtime_checkable
class RetrievalStrategyProtocol(Protocol):
"""
Protocol for pluggable retrieval strategies.
Enables custom retrieval algorithms without modifying core RAG pipeline.
Implementations can provide different retrieval approaches (semantic,
keyword, hybrid, graph-based, etc.) through a unified interface.
"""
name: str
def retrieve(
self,
query: str,
knowledge_store: Any, # KnowledgeStoreProtocol
*,
limit: int = 10,
filters: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> List[Dict[str, Any]]:
"""
Retrieve relevant documents for query.
Args:
query: Search query string
knowledge_store: Knowledge store to search
limit: Maximum number of results
filters: Optional metadata filters
**kwargs: Strategy-specific options
Returns:
List of retrieved documents with metadata
"""
...
async def aretrieve(
self,
query: str,
knowledge_store: Any, # KnowledgeStoreProtocol
*,
limit: int = 10,
filters: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> List[Dict[str, Any]]:
"""
Async version of retrieve.
Args:
query: Search query string
knowledge_store: Knowledge store to search
limit: Maximum number of results
filters: Optional metadata filters
**kwargs: Strategy-specific options
Returns:
List of retrieved documents with metadata
"""
...
@runtime_checkable
class GraphHookProtocol(Protocol):
"""
@@ -640,7 +640,6 @@ class MinimalTelemetry:
# Global telemetry instance
_telemetry_instance = None
_telemetry_instance_lock = threading.Lock()
def get_telemetry() -> MinimalTelemetry:
"""
@@ -650,19 +649,17 @@ def get_telemetry() -> MinimalTelemetry:
The global MinimalTelemetry instance
"""
global _telemetry_instance
with _telemetry_instance_lock:
if _telemetry_instance is None:
_telemetry_instance = MinimalTelemetry()
return _telemetry_instance
if _telemetry_instance is None:
_telemetry_instance = MinimalTelemetry()
return _telemetry_instance
def disable_telemetry():
"""Programmatically disable telemetry."""
global _telemetry_instance
with _telemetry_instance_lock:
if _telemetry_instance:
_telemetry_instance.enabled = False
else:
_telemetry_instance = MinimalTelemetry(enabled=False)
if _telemetry_instance:
_telemetry_instance.enabled = False
else:
_telemetry_instance = MinimalTelemetry(enabled=False)
def force_shutdown_telemetry():
"""
@@ -670,9 +667,8 @@ def force_shutdown_telemetry():
This function ensures proper termination of all background threads.
"""
global _telemetry_instance
with _telemetry_instance_lock:
if _telemetry_instance:
_telemetry_instance.shutdown()
if _telemetry_instance:
_telemetry_instance.shutdown()
# Additional cleanup - wait for all threads to finish
import threading
@@ -702,12 +698,11 @@ def force_shutdown_telemetry():
def enable_telemetry():
"""Programmatically enable telemetry (if not disabled by environment)."""
global _telemetry_instance
with _telemetry_instance_lock:
if not _is_telemetry_disabled():
if _telemetry_instance:
_telemetry_instance.enabled = True
else:
_telemetry_instance = MinimalTelemetry(enabled=True)
if not _is_telemetry_disabled():
if _telemetry_instance:
_telemetry_instance.enabled = True
else:
_telemetry_instance = MinimalTelemetry(enabled=True)
# For backward compatibility with existing code
class TelemetryCollector:
@@ -200,16 +200,7 @@ TOOL_MAPPINGS = {
'email_tools': ('.email_tools', None),
}
# Tool factory functions - caches classes but creates fresh instances
# This prevents state leakage between concurrent agents while optimizing import performance
_loaded_classes = {} # Cache the Class, NOT the instance
def _create_tool_instance(class_name: str, module_path: str):
"""Create a new tool instance. Caches the class but returns fresh instances to prevent state sharing."""
if class_name not in _loaded_classes:
module = import_module(module_path, __package__)
_loaded_classes[class_name] = getattr(module, class_name)
return _loaded_classes[class_name]() # Fresh instance safe for multi-agent
_instances = {} # Cache for class instances (protected by _tools_lock)
# Profile exports (lazy loaded)
_PROFILE_EXPORTS = frozenset({
@@ -334,10 +325,17 @@ def __getattr__(name: str) -> Any:
return module # Returns the callable module
return getattr(module, name)
else:
# Create a fresh tool instance for each agent/session to prevent state leakage
# This factory pattern ensures multi-agent safety by avoiding shared mutable state
instance = _create_tool_instance(class_name, module_path)
method = getattr(instance, name)
# Class method import (thread-safe)
if class_name not in _instances:
with _tools_lock:
# Double-check pattern to avoid race conditions
if class_name not in _instances:
module = import_module(module_path, __package__)
class_ = getattr(module, class_name)
_instances[class_name] = class_()
# Get the method and bind it to the instance
method = getattr(_instances[class_name], name)
return method
__all__ = list(TOOL_MAPPINGS.keys()) + [
@@ -434,18 +434,8 @@ class CircuitBreakerRegistry:
self._breakers.clear()
# Global registry instance for convenience (lazy initialization)
_global_registry = None
_global_registry_lock = threading.Lock()
def _get_global_registry() -> CircuitBreakerRegistry:
"""Get or create the global circuit breaker registry."""
global _global_registry
with _global_registry_lock:
if _global_registry is None:
_global_registry = CircuitBreakerRegistry()
return _global_registry
# Global registry instance for convenience
_global_registry = CircuitBreakerRegistry()
def get_circuit_breaker(
@@ -465,14 +455,14 @@ def get_circuit_breaker(
Returns:
CircuitBreaker instance
"""
return _get_global_registry().get_or_create(name, config, health_check, fallback)
return _global_registry.get_or_create(name, config, health_check, fallback)
def get_all_circuit_breaker_stats() -> Dict[str, Dict[str, Any]]:
"""Get statistics for all circuit breakers in the global registry."""
return _get_global_registry().get_all_stats()
return _global_registry.get_all_stats()
def reset_all_circuit_breakers() -> None:
"""Reset all circuit breakers in the global registry."""
_get_global_registry().reset_all()
_global_registry.reset_all()
@@ -39,20 +39,17 @@ class FileTools:
if filepath.startswith('~'):
filepath = os.path.expanduser(filepath)
# Check for path traversal attempts BEFORE normalization
# Normalize the path
normalized = os.path.normpath(filepath)
absolute = os.path.abspath(normalized)
# Check for path traversal attempts (.. after normalization)
# We check the original input for '..' to catch traversal attempts
if '..' in filepath:
if '..' in normalized:
raise ValueError(f"Path traversal detected: {filepath}")
# Normalize the path and securely resolve symlinks
normalized = os.path.normpath(filepath)
absolute = os.path.realpath(normalized)
# Prevent path traversal outside current workspace / allowed directories
cwd = os.path.abspath(os.getcwd())
if os.path.commonpath([absolute, cwd]) != cwd:
raise ValueError(f"Path traversal detected: {filepath} escapes workspace {cwd}")
# Additional check: ensure the resolved path doesn't escape expected boundaries
# This is a basic check - in production, you'd want to define allowed directories
return absolute
@staticmethod
@@ -330,7 +327,7 @@ class FileTools:
os.makedirs(os.path.dirname(safe_path) or ".", exist_ok=True)
# Download file
with httpx.stream("GET", url, timeout=timeout, follow_redirects=False) as response:
with httpx.stream("GET", url, timeout=timeout, follow_redirects=True) as response:
response.raise_for_status()
total_size = int(response.headers.get("content-length", 0))
@@ -455,14 +455,9 @@ def get_circuit_breaker_dashboard_data() -> Dict[str, Any]:
return dashboard_data
# Global health monitor instance for convenience (lazy initialization)
_global_health_monitor = None
_global_health_monitor_lock = threading.Lock()
# Global health monitor instance for convenience
_global_health_monitor = HealthMonitor()
def get_health_monitor() -> HealthMonitor:
"""Get the global health monitor instance."""
global _global_health_monitor
with _global_health_monitor_lock:
if _global_health_monitor is None:
_global_health_monitor = HealthMonitor()
return _global_health_monitor
return _global_health_monitor
@@ -61,8 +61,6 @@ def _validate_code_ast(code: str):
'ag_frame', 'ag_code', 'tb_frame', 'tb_next',
'f_globals', 'f_locals', 'f_builtins', 'f_code',
'co_consts', 'co_names',
'__getattribute__', '__getattr__', '__setattr__', '__delattr__',
'__dir__', '__get__', '__set__', '__delete__',
})
for node in ast.walk(tree):
@@ -86,15 +84,6 @@ def _validate_code_ast(code: str):
'setattr', 'delattr', 'dir',
):
return f"Call to '{func.id}' is not allowed"
# Block dangerous constants (strings containing dunders)
# Fallback for Python 3.7 ast.Str
if isinstance(node, ast.Constant) and isinstance(node.value, str):
if any(attr in node.value for attr in _blocked_attrs):
return f"String constant contains restricted attribute name"
elif type(node).__name__ == 'Str':
if any(attr in getattr(node, 's', '') for attr in _blocked_attrs):
return f"String constant contains restricted attribute name"
return None
@@ -154,17 +143,7 @@ def safe_execute():
blocked_attrs = {{
'__subclasses__', '__bases__', '__mro__', '__globals__',
'__code__', '__class__', '__dict__', '__builtins__',
'__import__', '__loader__', '__spec__', '__init_subclass__',
'__set_name__', '__reduce__', '__reduce_ex__',
'__traceback__', '__qualname__', '__module__',
'__wrapped__', '__closure__', '__annotations__',
# Frame/code object introspection
'gi_frame', 'gi_code', 'cr_frame', 'cr_code',
'ag_frame', 'ag_code', 'tb_frame', 'tb_next',
'f_globals', 'f_locals', 'f_builtins', 'f_code',
'co_consts', 'co_names',
'__getattribute__', '__getattr__', '__setattr__', '__delattr__',
'__dir__', '__get__', '__set__', '__delete__',
'__import__', '__loader__', '__spec__'
}}
for node in ast.walk(tree):
@@ -183,31 +162,13 @@ def safe_execute():
"success": False
}}
if isinstance(node, ast.Call) and isinstance(node.func, ast.Name):
if node.func.id in ('exec', 'eval', 'compile', '__import__',
'open', 'input', 'breakpoint',
'setattr', 'delattr', 'dir'):
if node.func.id in ('exec', 'eval', 'compile', '__import__', 'open'):
return {{
"result": None,
"stdout": "",
"stderr": f"Call to '{{node.func.id}}' is not allowed",
"success": False
}}
if isinstance(node, ast.Constant) and isinstance(node.value, str):
if any(attr in node.value for attr in blocked_attrs):
return {{
"result": None,
"stdout": "",
"stderr": "String constant contains restricted attribute name",
"success": False
}}
elif type(node).__name__ == 'Str':
if any(attr in getattr(node, 's', '') for attr in blocked_attrs):
return {{
"result": None,
"stdout": "",
"stderr": "String constant contains restricted attribute name",
"success": False
}}
# Create safe globals
# Create a safe getattr that blocks dunder access (defense-in-depth)
@@ -17,7 +17,6 @@ Usage:
"""
import logging
import threading
from praisonaiagents._logging import get_logger
logger = get_logger(__name__)
@@ -25,7 +24,6 @@ logger = get_logger(__name__)
# ── lazy singleton store ─────────────────────────────────────────────────────
_store_instance = None
_store_instance_lock = threading.Lock()
def set_store(store):
"""Inject an external schedule store (e.g., config.yaml-backed).
@@ -35,8 +33,7 @@ def set_store(store):
``config.yaml`` instead of the default ``jobs.json``.
"""
global _store_instance
with _store_instance_lock:
_store_instance = store
_store_instance = store
def _get_store():
"""Return (or create) the global schedule store.
@@ -45,12 +42,11 @@ def _get_store():
Automatically migrates any existing ``jobs.json`` data on first use.
"""
global _store_instance
with _store_instance_lock:
if _store_instance is None:
from ..scheduler.config_store import ConfigYamlScheduleStore
_store_instance = ConfigYamlScheduleStore()
_store_instance.migrate_from_json()
return _store_instance
if _store_instance is None:
from ..scheduler.config_store import ConfigYamlScheduleStore
_store_instance = ConfigYamlScheduleStore()
_store_instance.migrate_from_json()
return _store_instance
# ── tools ────────────────────────────────────────────────────────────────────
@@ -9,7 +9,6 @@ Schema Version: 1.0
import json
import time
import threading
from dataclasses import dataclass, field
from enum import Enum
from typing import Any, Dict, List, Optional, Protocol, runtime_checkable
@@ -389,20 +388,17 @@ class TraceEmitter:
# Global default emitter (NoOp by default)
_default_emitter: Optional[TraceEmitter] = None
_default_emitter_lock = threading.Lock()
def get_default_emitter() -> TraceEmitter:
"""Get the default trace emitter."""
global _default_emitter
with _default_emitter_lock:
if _default_emitter is None:
_default_emitter = TraceEmitter(sink=NoOpSink(), enabled=False)
return _default_emitter
if _default_emitter is None:
_default_emitter = TraceEmitter(sink=NoOpSink(), enabled=False)
return _default_emitter
def set_default_emitter(emitter: TraceEmitter) -> None:
"""Set the default trace emitter."""
global _default_emitter
with _default_emitter_lock:
_default_emitter = emitter
_default_emitter = emitter
@@ -1,114 +0,0 @@
"""
Generic Adapter Registry
Provides a thread-safe, generic registry for protocol-based adapters.
Used by memory/adapters/registry.py and knowledge/adapters/registry.py to
avoid code duplication.
"""
import logging
import threading
from typing import Callable, Dict, Generic, List, Optional, Tuple, Type, TypeVar
T = TypeVar("T")
logger = logging.getLogger(__name__)
class AdapterRegistry(Generic[T]):
"""
Thread-safe generic registry for protocol-based adapters.
Supports two registration modes:
- **class**: instantiated on demand via ``register_adapter``
- **factory**: called on demand via ``register_factory``
Factory entries take priority over class entries when both exist for the
same name, because factories can apply extra configuration logic.
"""
def __init__(self, adapter_type_name: str = "adapter") -> None:
self._adapters: Dict[str, Type[T]] = {}
self._factories: Dict[str, Callable[..., T]] = {}
self._lock = threading.Lock()
self._type_name = adapter_type_name
def register_adapter(self, name: str, adapter_class: Type[T]) -> None:
"""Register an adapter class instantiated on demand."""
with self._lock:
self._adapters[name] = adapter_class
def register_factory(self, name: str, factory_func: Callable[..., T]) -> None:
"""Register a factory function that creates adapter instances."""
with self._lock:
self._factories[name] = factory_func
def get_adapter(self, name: str, **kwargs) -> Optional[T]:
"""
Return an adapter instance for *name*, or ``None`` if unavailable.
Tries the factory first (if registered), then falls back to direct
class instantiation. Lock is only held for lookup, not construction
to avoid deadlocks and blocking registry access.
"""
# Only hold lock to look up the factory/class, not during instantiation
with self._lock:
factory = self._factories.get(name)
adapter_cls = self._adapters.get(name)
# Try factory first (instantiate outside lock)
if factory is not None:
try:
return factory(**kwargs)
except (ImportError, ModuleNotFoundError):
# Optional dependency missing - return None for graceful fallback
return None
except Exception as exc:
raise RuntimeError(
f"Failed to create {self._type_name} adapter '{name}' via factory. "
"Check adapter config and installed extras."
) from exc
# Try direct class instantiation (outside lock)
if adapter_cls is not None:
try:
return adapter_cls(**kwargs)
except (ImportError, ModuleNotFoundError):
# Optional dependency missing - return None for graceful fallback
return None
except Exception as exc:
raise RuntimeError(
f"Failed to instantiate {self._type_name} adapter '{name}'. "
"Check adapter constructor args and installed extras."
) from exc
return None
def list_adapters(self) -> List[str]:
"""Return a sorted list of all registered adapter names."""
with self._lock:
return sorted(set(self._adapters.keys()) | set(self._factories.keys()))
def is_available(self, name: str) -> bool:
"""Return ``True`` if *name* has a registered adapter or factory."""
with self._lock:
return name in self._adapters or name in self._factories
def get_first_available(
self, preferences: List[str], **kwargs
) -> Optional[Tuple[str, T]]:
"""
Return the first successfully instantiated adapter from *preferences*.
Args:
preferences: Adapter names tried in order.
**kwargs: Passed to the adapter constructor / factory.
Returns:
``(name, instance)`` tuple, or ``None`` if none could be created.
"""
for name in preferences:
instance = self.get_adapter(name, **kwargs)
if instance is not None:
return name, instance
return None
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "praisonaiagents"
version = "1.5.121"
version = "1.5.112"
description = "Praison AI agents for completing complex tasks with Self Reflection Agents"
readme = "README.md"
requires-python = ">=3.10"
+8
View File
@@ -0,0 +1,8 @@
import time
from praisonaiagents import Agent
t0 = time.time()
agents = [Agent(name=f'Test_{i}', llm='gpt-4o-mini', output='silent') for i in range(100)]
t1 = time.time()
print(f"Time for 100 agents: {t1 - t0:.4f} seconds")
+18
View File
@@ -0,0 +1,18 @@
import time
from praisonaiagents import Agent as PraisonAgent
def measure_instantiation(create_fn, iterations=1000, warmup=50):
for _ in range(warmup):
create_fn()
times = []
for _ in range(iterations):
start = time.perf_counter()
create_fn()
times.append((time.perf_counter() - start) * 1_000_000)
return sum(times) / len(times)
r1 = measure_instantiation(lambda: PraisonAgent(name='Test', llm='gpt-4o-mini', output="silent"))
r2 = measure_instantiation(lambda: PraisonAgent(name='Test', llm='openai/gpt-4o-mini', output="silent"))
print(f"PraisonAI: {r1:.2f} μs")
print(f"PraisonAI (LiteLLM): {r2:.2f} μs")
+13
View File
@@ -0,0 +1,13 @@
#!/usr/bin/env python3
"""Quick smoke test for JIT hydration changes."""
import sys
try:
from praisonaiagents import Agent
a = Agent(instructions='test')
print('SUCCESS: Agent created')
sys.exit(0)
except Exception as e:
print(f'ERROR: {e}')
import traceback
traceback.print_exc()
sys.exit(1)
+11
View File
@@ -0,0 +1,11 @@
from line_profiler import profile
from praisonaiagents.agent.agent import Agent
Agent.__init__ = profile(Agent.__init__)
def run_init():
for _ in range(100):
# We also need to mock or ensure no external calls actually hit APIs
Agent(name='Test', llm='gpt-4o-mini', output='silent')
run_init()
-255
View File
@@ -1,255 +0,0 @@
"""
Test suite for unified LLM protocol dispatch.
This test suite verifies that the new unified protocol-driven architecture
works correctly, maintains backward compatibility, and provides sync/async parity.
"""
import pytest
import os
import asyncio
from unittest.mock import MagicMock, AsyncMock, patch
from typing import Dict, List, Any, Union, Iterator, AsyncIterator
# Test imports and basic functionality
def test_unified_protocol_imports():
"""Test that all new unified protocol components can be imported."""
from praisonaiagents.llm import UnifiedLLMProtocol
from praisonaiagents.llm import LiteLLMAdapter, OpenAIAdapter, UnifiedLLMDispatcher
from praisonaiagents.llm import create_llm_dispatcher
# Verify these are the correct types
assert hasattr(UnifiedLLMProtocol, '__protocol_methods__') or hasattr(UnifiedLLMProtocol, '__abstractmethods__')
assert hasattr(LiteLLMAdapter, '__init__')
assert hasattr(OpenAIAdapter, '__init__')
assert hasattr(UnifiedLLMDispatcher, '__init__')
assert callable(create_llm_dispatcher)
def test_backward_compatibility():
"""Test that existing agent functionality still works without unified dispatch."""
from praisonaiagents import Agent
# Create agent without unified dispatch (legacy mode)
agent = Agent(name="legacy_test", instructions="Test backward compatibility")
# Verify that unified dispatch is not enabled by default
assert getattr(agent, '_use_unified_llm_dispatch', False) == False
# Verify basic properties
assert agent.name == "legacy_test"
assert agent.instructions == "Test backward compatibility"
class MockLLM:
"""Mock LLM for testing."""
def __init__(self, model="test-model"):
self.model = model
def get_response(self, prompt, system_prompt=None, chat_history=None, **kwargs):
return "Mock sync response"
async def get_response_async(self, prompt, system_prompt=None, chat_history=None, **kwargs):
return "Mock async response"
class MockOpenAIClient:
"""Mock OpenAI client for testing."""
def __init__(self):
self.model = "gpt-4o-mini"
def chat_completion_with_tools(self, messages, **kwargs):
return {"choices": [{"message": {"content": "Mock OpenAI sync response"}}]}
async def achat_completion_with_tools(self, messages, **kwargs):
return {"choices": [{"message": {"content": "Mock OpenAI async response"}}]}
def test_litellm_adapter_sync_async_parity():
"""Test that LiteLLMAdapter provides consistent behavior in sync and async modes."""
from praisonaiagents.llm import LiteLLMAdapter
mock_llm = MockLLM()
adapter = LiteLLMAdapter(mock_llm)
messages = [
{"role": "system", "content": "You are a helpful assistant"},
{"role": "user", "content": "Hello"}
]
# Test sync (non-streaming)
sync_result = adapter.chat_completion(messages, stream=False)
assert isinstance(sync_result, (dict, str))
# Test async
async def test_async():
async_result = await adapter.achat_completion(messages, stream=False)
assert isinstance(async_result, (dict, str))
return async_result
async_result = asyncio.run(test_async())
# Both should produce results (exact parity testing would require more sophisticated mocking)
assert sync_result is not None
assert async_result is not None
def test_openai_adapter_sync_async_parity():
"""Test that OpenAIAdapter provides consistent behavior in sync and async modes."""
from praisonaiagents.llm import OpenAIAdapter
mock_client = MockOpenAIClient()
adapter = OpenAIAdapter(mock_client, model="gpt-4o-mini")
messages = [
{"role": "user", "content": "Hello"}
]
# Test async
async def test_async():
async_result = await adapter.achat_completion(messages, stream=False)
return async_result
async_result = asyncio.run(test_async())
# Test sync (should delegate to async)
sync_result = adapter.chat_completion(messages, stream=False)
# Both should produce results
assert async_result is not None
assert sync_result is not None
def test_unified_dispatcher_creation():
"""Test that unified dispatcher can be created with different adapters."""
from praisonaiagents.llm import create_llm_dispatcher
# Test LiteLLM adapter creation
mock_llm = MockLLM()
dispatcher1 = create_llm_dispatcher(llm_instance=mock_llm)
assert dispatcher1 is not None
assert hasattr(dispatcher1, 'chat_completion')
assert hasattr(dispatcher1, 'achat_completion')
# Test OpenAI adapter creation
mock_client = MockOpenAIClient()
dispatcher2 = create_llm_dispatcher(openai_client=mock_client, model="gpt-4o-mini")
assert dispatcher2 is not None
assert hasattr(dispatcher2, 'chat_completion')
assert hasattr(dispatcher2, 'achat_completion')
def test_agent_with_unified_dispatch():
"""Test agent with unified dispatch enabled."""
from praisonaiagents import Agent
# Create agent with unified dispatch enabled
agent = Agent(name="unified_test", instructions="Test unified dispatch")
agent._use_unified_llm_dispatch = True
# Test that the agent has the unified dispatch flag
assert getattr(agent, '_use_unified_llm_dispatch', False) == True
# Test that unified dispatch method exists
assert hasattr(agent, '_execute_unified_chat_completion')
assert hasattr(agent, '_execute_unified_achat_completion')
def test_streaming_protocol_compliance():
"""Test that streaming behavior complies with protocol requirements."""
from praisonaiagents.llm import LiteLLMAdapter, OpenAIAdapter
mock_llm = MockLLM()
litellm_adapter = LiteLLMAdapter(mock_llm)
mock_client = MockOpenAIClient()
openai_adapter = OpenAIAdapter(mock_client, model="gpt-4o-mini")
messages = [{"role": "user", "content": "Hello"}]
# Test that sync streaming is properly handled (should raise error or return Iterator)
with pytest.raises(ValueError, match="Streaming is not supported"):
litellm_adapter.chat_completion(messages, stream=True)
with pytest.raises(ValueError, match="Streaming is not supported"):
openai_adapter.chat_completion(messages, stream=True)
def test_message_extraction_no_duplication():
"""Test that message extraction doesn't duplicate content."""
from praisonaiagents.llm import LiteLLMAdapter
mock_llm = MockLLM()
adapter = LiteLLMAdapter(mock_llm)
messages = [
{"role": "system", "content": "You are helpful"},
{"role": "user", "content": "First message"},
{"role": "assistant", "content": "Response"},
{"role": "user", "content": "Second message"}
]
# Test with mock to verify correct parameter passing
with patch.object(mock_llm, 'get_response') as mock_get_response:
mock_get_response.return_value = "Test response"
adapter.chat_completion(messages, stream=False)
# Verify that prompt is only the last user message
call_kwargs = mock_get_response.call_args[1]
assert call_kwargs['prompt'] == "Second message"
assert call_kwargs['system_prompt'] == "You are helpful"
# Chat history should contain the conversation before the last message
chat_history = call_kwargs['chat_history']
assert len(chat_history) == 3 # system excluded, contains first user + assistant + user
assert chat_history[-2]['content'] == "Response"
@pytest.mark.asyncio
async def test_real_agent_functionality():
"""Real agentic test - agent must call LLM end-to-end (as required by AGENTS.md)."""
from praisonaiagents import Agent
# Set up environment for testing (using mock to avoid real API calls)
with patch.dict(os.environ, {'OPENAI_API_KEY': 'test-key'}):
agent = Agent(
name="test_agent",
instructions="You are a helpful test assistant. Respond with exactly 'Hello World'."
)
# Mock the OpenAI client to return predictable response
with patch('praisonaiagents.llm.openai_client.openai.OpenAI') as mock_openai:
mock_client = MagicMock()
mock_openai.return_value = mock_client
# Mock the chat completion response
mock_response = MagicMock()
mock_response.choices = [MagicMock()]
mock_response.choices[0].message.content = "Hello World"
mock_client.chat.completions.create.return_value = mock_response
# Real agent call - must produce actual response
result = agent.start("Say hello")
# Verify the agent actually called the LLM and produced output
assert result is not None
assert "Hello" in str(result) or len(str(result)) > 0
print(f"Agent output: {result}") # Required by AGENTS.md
def test_performance_no_regressions():
"""Test that unified dispatch doesn't introduce performance regressions."""
import time
from praisonaiagents.llm import create_llm_dispatcher
# Test import time (should be fast)
start_time = time.time()
from praisonaiagents.llm import UnifiedLLMProtocol, LiteLLMAdapter, OpenAIAdapter
import_time = time.time() - start_time
# Import should be under 200ms as per AGENTS.md
assert import_time < 0.2, f"Import time {import_time:.3f}s exceeds 200ms limit"
# Test dispatcher creation time
mock_llm = MockLLM()
start_time = time.time()
dispatcher = create_llm_dispatcher(llm_instance=mock_llm)
creation_time = time.time() - start_time
# Dispatcher creation should be fast
assert creation_time < 0.1, f"Dispatcher creation time {creation_time:.3f}s is too slow"
if __name__ == "__main__":
# Run tests when executed directly
print("Running unified LLM protocol tests...")
pytest.main([__file__, "-v"])
@@ -225,7 +225,6 @@ class TestEvalSuiteLive:
# Use invalid model to trigger failure
failing_eval = AccuracyEvaluator(
func=lambda x: "test_output",
input_text="test",
expected_output="test",
model="invalid-model-that-does-not-exist"
@@ -1,393 +0,0 @@
"""
Test suite for unified configuration schema.
Tests the core protocols and ensures CLI/YAML/Python configuration
consistency as specified in architectural gap #2.
"""
import os
import tempfile
from pathlib import Path
from typing import Dict, Any
import pytest
# Import from core SDK (protocols)
from praisonaiagents.config.protocols import (
ConfigSchemaProtocol,
ValidationResult,
CliMapping,
PrecedenceChain,
)
# Try to import wrapper implementation for integration testing
try:
from praisonai.cli.unified_schema import rag_schema_provider
WRAPPER_AVAILABLE = True
except ImportError:
WRAPPER_AVAILABLE = False
# Test data
VALID_CONFIG = {
"collection": "test_collection",
"top_k": 10,
"hybrid": True,
"rerank": False,
"min_score": 0.5,
"include_citations": True,
"max_context_tokens": 8000,
"vector_store_provider": "chroma",
"host": "0.0.0.0",
"port": 9090,
"model": "gpt-4",
"verbose": True,
}
INVALID_CONFIG = {
"collection": "test",
"top_k": -5, # Invalid: should be >= 1
"min_score": 2.0, # Invalid: should be <= 1.0
"vector_store_provider": "invalid_provider", # Invalid: not in allowed list
"port": 99999, # Invalid: > 65535
}
YAML_CONFIG_CONTENT = """
collection: yaml_test
vector_store: pinecone
citations: false
max_context: 6000
host: localhost
"""
CLI_ARGS = {
"collection": "cli_test",
"top_k": 15,
"hybrid": True,
"verbose": True,
}
class MockSchemaProvider:
"""Mock implementation of ConfigSchemaProtocol for testing."""
def validate(self, config: Dict[str, Any]) -> ValidationResult:
"""Mock validation - check for obvious errors."""
errors = []
warnings = []
# Check required fields
if "collection" not in config:
errors.append("collection is required")
# Check value ranges
if "top_k" in config and config["top_k"] <= 0:
errors.append("top_k must be positive")
if "min_score" in config and (config["min_score"] < 0 or config["min_score"] > 1):
errors.append("min_score must be between 0 and 1")
if "port" in config and (config["port"] < 1000 or config["port"] > 65535):
errors.append("port must be between 1000 and 65535")
# Check provider validity
valid_providers = ["chroma", "pinecone", "weaviate", "qdrant"]
if "vector_store_provider" in config:
if config["vector_store_provider"] not in valid_providers:
errors.append(f"vector_store_provider must be one of: {valid_providers}")
is_valid = len(errors) == 0
return ValidationResult(
is_valid=is_valid,
errors=errors,
warnings=warnings,
normalized=config if is_valid else None
)
def get_cli_mapping(self) -> list[CliMapping]:
"""Mock CLI mappings."""
return [
CliMapping("collection", "collection", "Collection name", str, "default"),
CliMapping("top_k", "top-k", "Number of results", int, 5),
CliMapping("hybrid", "hybrid", "Enable hybrid retrieval", bool, False),
CliMapping("min_score", "min-score", "Minimum score", float, 0.0),
CliMapping("include_citations", "citations", "Include citations", bool, True),
CliMapping("vector_store_provider", "vector-store", "Vector store", str, "chroma"),
CliMapping("port", "port", "Server port", int, 8080),
CliMapping("verbose", "verbose", "Verbose output", bool, False),
]
def get_precedence_chain(self) -> PrecedenceChain:
"""Mock precedence chain."""
return PrecedenceChain(
chain=["cli", "env", "file", "defaults"],
descriptions={
"cli": "Command line arguments",
"env": "Environment variables",
"file": "Configuration file",
"defaults": "Default values"
}
)
def normalize_config(self, config: Dict[str, Any]) -> Dict[str, Any]:
"""Mock normalization with defaults."""
defaults = {
"collection": "default",
"top_k": 5,
"hybrid": False,
"rerank": False,
"min_score": 0.0,
"include_citations": True,
"max_context_tokens": 4000,
"vector_store_provider": "chroma",
"host": "127.0.0.1",
"port": 8080,
"verbose": False,
}
result = defaults.copy()
result.update(config)
return result
def get_schema_info(self) -> Dict[str, Any]:
"""Mock schema info."""
return {
"name": "TestSchema",
"description": "Test unified schema",
"fields": {
"collection": {"type": "str", "default": "default"},
"top_k": {"type": "int", "default": 5},
"hybrid": {"type": "bool", "default": False},
},
"precedence": ["cli", "env", "file", "defaults"],
}
@pytest.fixture
def schema_provider():
"""Create a mock schema provider for testing."""
return MockSchemaProvider()
def test_protocol_interface(schema_provider):
"""Test that mock provider implements the protocol correctly."""
assert isinstance(schema_provider, ConfigSchemaProtocol)
# Test validation method
result = schema_provider.validate(VALID_CONFIG)
assert isinstance(result, ValidationResult)
assert result.is_valid
assert result.errors == []
# Test CLI mapping method
mappings = schema_provider.get_cli_mapping()
assert isinstance(mappings, list)
assert all(isinstance(m, CliMapping) for m in mappings)
# Test precedence chain method
chain = schema_provider.get_precedence_chain()
assert isinstance(chain, PrecedenceChain)
assert len(chain.chain) > 0
# Test normalization method
normalized = schema_provider.normalize_config({})
assert isinstance(normalized, dict)
assert "collection" in normalized
# Test schema info method
info = schema_provider.get_schema_info()
assert isinstance(info, dict)
assert "name" in info
def test_validation_success(schema_provider):
"""Test successful configuration validation."""
result = schema_provider.validate(VALID_CONFIG)
assert result.is_valid
assert result.errors == []
assert result.normalized is not None
def test_validation_failure(schema_provider):
"""Test configuration validation with errors."""
result = schema_provider.validate(INVALID_CONFIG)
assert not result.is_valid
assert len(result.errors) > 0
assert result.normalized is None
# Check specific error messages
error_text = " ".join(result.errors)
assert "top_k must be positive" in error_text
assert "min_score must be between" in error_text
assert "vector_store_provider must be" in error_text
def test_cli_mapping_generation(schema_provider):
"""Test CLI flag generation from schema."""
mappings = schema_provider.get_cli_mapping()
# Check that we have mappings
assert len(mappings) > 0
# Check mapping structure
for mapping in mappings:
assert hasattr(mapping, 'field_name')
assert hasattr(mapping, 'cli_flag')
assert hasattr(mapping, 'description')
assert hasattr(mapping, 'type_hint')
# Field names should be valid Python identifiers
assert mapping.field_name.isidentifier()
# CLI flags should be kebab-case
assert "-" in mapping.cli_flag or mapping.cli_flag.isalpha()
# Check for specific expected mappings
flag_names = [m.cli_flag for m in mappings]
assert "collection" in flag_names
assert "top-k" in flag_names
assert "vector-store" in flag_names
def test_precedence_chain_documentation(schema_provider):
"""Test precedence chain is properly documented."""
chain = schema_provider.get_precedence_chain()
# Check chain structure
assert len(chain.chain) >= 3 # Should have at least cli, env, defaults
assert isinstance(chain.descriptions, dict)
# Check all chain items have descriptions
for source in chain.chain:
assert source in chain.descriptions
assert len(chain.descriptions[source]) > 10 # Meaningful description
# Check precedence order makes sense (cli should be highest)
assert "cli" in chain.chain[0] or "command" in chain.chain[0].lower()
def test_config_normalization(schema_provider):
"""Test configuration normalization with defaults."""
# Test empty config gets defaults
empty_config = {}
normalized = schema_provider.normalize_config(empty_config)
assert normalized["collection"] == "default"
assert normalized["top_k"] == 5
assert normalized["hybrid"] is False
# Test partial config merges with defaults
partial_config = {"collection": "custom", "top_k": 10}
normalized = schema_provider.normalize_config(partial_config)
assert normalized["collection"] == "custom" # User value
assert normalized["top_k"] == 10 # User value
assert normalized["hybrid"] is False # Default value
def test_schema_metadata(schema_provider):
"""Test schema metadata for documentation."""
info = schema_provider.get_schema_info()
# Check required fields
assert "name" in info
assert "description" in info
assert "fields" in info
assert "precedence" in info
# Check field definitions
fields = info["fields"]
assert isinstance(fields, dict)
assert len(fields) > 0
# Check precedence documentation
precedence = info["precedence"]
assert isinstance(precedence, list)
assert len(precedence) >= 3
def test_cli_yaml_python_consistency():
"""Test that the same config produces identical behavior across interfaces."""
provider = MockSchemaProvider()
# Base configuration that should be consistent
base_config = {
"collection": "consistency_test",
"top_k": 8,
"hybrid": True,
"include_citations": False,
}
# 1. Direct Python config
python_result = provider.validate(base_config)
# 2. CLI-style config (simulate CLI parsing)
cli_style = {
"collection": "consistency_test",
"top_k": 8,
"hybrid": True,
"include_citations": False,
}
cli_result = provider.validate(cli_style)
# 3. YAML-style config (after field mapping)
yaml_style = {
"collection": "consistency_test",
"top_k": 8,
"hybrid": True,
"include_citations": False,
}
yaml_result = provider.validate(yaml_style)
# All should validate successfully
assert python_result.is_valid
assert cli_result.is_valid
assert yaml_result.is_valid
# Normalized configs should be identical
assert python_result.normalized == cli_result.normalized
assert cli_result.normalized == yaml_result.normalized
def test_environment_variable_mapping():
"""Test environment variable to config field mapping."""
# This would be implemented in the actual schema provider
# Here we just test the concept
env_mapping = {
"PRAISONAI_COLLECTION": "collection",
"PRAISONAI_TOP_K": "top_k",
"PRAISONAI_HYBRID": "hybrid",
"PRAISONAI_VECTOR_STORE": "vector_store_provider",
}
# Verify mapping structure
for env_var, field in env_mapping.items():
assert env_var.startswith("PRAISONAI_")
assert field.isidentifier()
def test_backward_compatibility():
"""Test that new unified schema maintains backward compatibility."""
provider = MockSchemaProvider()
# Old-style config that should still work
legacy_config = {
"collection": "legacy_test",
"top_k": 5,
"include_citations": True,
"vector_store_provider": "chroma",
}
result = provider.validate(legacy_config)
assert result.is_valid
# Should normalize to include defaults for new fields
normalized = provider.normalize_config(legacy_config)
assert "hybrid" in normalized # Should get default value
assert "rerank" in normalized # Should get default value
if __name__ == "__main__":
pytest.main([__file__])
@@ -71,28 +71,14 @@ class TestDirectoryIngestion:
# Search for unique content
search_result = knowledge.search('ZEBRA-71', user_id='test_user')
if isinstance(search_result, dict):
results = search_result.get('results', [])
else:
results = getattr(search_result, 'results', [])
assert len(results) > 0
assert isinstance(search_result, dict)
assert 'results' in search_result
assert len(search_result['results']) > 0
# The memory field should contain actual text, NOT the directory path
if len(results) > 0:
print(f"DEBUG results[0]: {results[0]}")
if isinstance(results[0], dict):
memory = results[0].get('memory', results[0].get('text', '')) or ''
else:
# Need to handle mem0 Pydantic objects which might have 'text'=None but store content in metadata
base_text = getattr(results[0], 'text', None) or getattr(results[0], 'memory', None) or ''
metadata = getattr(results[0], 'metadata', {})
if not base_text and isinstance(metadata, dict):
base_text = metadata.get('data', '') or metadata.get('text', '') or ''
memory = base_text
assert 'zebra-71' in memory.lower(), f"Expected 'zebra-71' in memory, got: {memory}"
assert temp_knowledge_dir not in memory, f"Directory path should not be in memory: {memory}"
memory = search_result['results'][0].get('memory', '')
assert 'zebra-71' in memory.lower(), f"Expected 'zebra-71' in memory, got: {memory}"
assert temp_knowledge_dir not in memory, f"Directory path should not be in memory: {memory}"
def test_directory_ingestion_processes_multiple_files(self, temp_knowledge_dir):
"""Test that all files in a directory are processed."""
@@ -110,10 +96,8 @@ class TestDirectoryIngestion:
search2 = knowledge.search('TIGER-42', user_id='test_user')
# Both should find results
res1 = search1.get('results', []) if isinstance(search1, dict) else getattr(search1, 'results', [])
res2 = search2.get('results', []) if isinstance(search2, dict) else getattr(search2, 'results', [])
assert len(res1) > 0, "Should find ZEBRA-71"
assert len(res2) > 0, "Should find TIGER-42"
assert len(search1.get('results', [])) > 0, "Should find ZEBRA-71"
assert len(search2.get('results', [])) > 0, "Should find TIGER-42"
def test_directory_ingestion_sets_metadata(self, temp_knowledge_dir):
"""Test that file metadata is properly set."""
@@ -128,13 +112,8 @@ class TestDirectoryIngestion:
search_result = knowledge.search('ZEBRA-71', user_id='test_user')
results = search_result.get('results', []) if isinstance(search_result, dict) else getattr(search_result, 'results', [])
if results:
if isinstance(results[0], dict):
metadata = results[0].get('metadata', {})
else:
metadata = getattr(results[0], 'metadata', {})
if search_result.get('results'):
metadata = search_result['results'][0].get('metadata') or {}
# Should have filename in metadata
assert 'filename' in metadata, f"Expected 'filename' in metadata: {metadata}"
assert metadata['filename'] == 'policy.txt'
@@ -175,16 +154,6 @@ class TestContextBuilderUsesText:
pytest.skip(f"Skipping: OpenAI API key required: {e}")
raise
# Mock the self.knowledge.search method
try:
from unittest.mock import MagicMock
if agent.knowledge:
agent.knowledge.search = MagicMock(return_value=[
{"text": "The secret password is WRENCH-992. Do not share.", "metadata": {}}
])
except Exception as e:
pass
# Get context
context, _ = agent._get_knowledge_context('What is the password?', use_rag=True)
@@ -363,92 +363,3 @@ class TestGlobalPluginManager:
manager2 = get_plugin_manager()
assert manager1 is manager2
class TestEntryPointsDiscovery:
"""Tests for entry_points plugin discovery."""
def test_discover_entry_points_no_plugins(self, monkeypatch):
"""Test entry_points discovery with no plugins installed."""
import importlib.metadata as metadata
def mock_entry_points(*args, **kwargs):
if kwargs.get("group") == "praisonai.plugins":
return []
return {"praisonai.plugins": []}
monkeypatch.setattr(metadata, "entry_points", mock_entry_points)
manager = PluginManager()
# Should return 0 when no entry_points exist for our group
loaded = manager.discover_entry_points()
assert loaded == 0
def test_discover_entry_points_import_error(self, monkeypatch):
"""Test graceful handling when importlib.metadata is not available."""
import sys
# Remove importlib.metadata from sys.modules to simulate import failure
original_module = sys.modules.pop("importlib.metadata", None)
# Mock the import to raise ImportError
import builtins
real_import = builtins.__import__
def mock_import(name, *args, **kwargs):
if name == "importlib.metadata":
raise ImportError("No module named importlib.metadata")
return real_import(name, *args, **kwargs)
monkeypatch.setattr(builtins, "__import__", mock_import)
try:
manager = PluginManager()
loaded = manager.discover_entry_points()
assert loaded == 0
finally:
# Restore the module if it existed
if original_module is not None:
sys.modules["importlib.metadata"] = original_module
def test_discover_entry_points_success(self, monkeypatch):
"""Test successful entry_points discovery and plugin loading."""
import importlib.metadata as metadata
from praisonaiagents.plugins.plugin import Plugin, PluginInfo
# Create a mock plugin class
class MockPlugin(Plugin):
@property
def info(self) -> PluginInfo:
return PluginInfo(
name="test_plugin",
version="1.0.0",
description="Test plugin"
)
# Create a mock entry point
class MockEntryPoint:
def __init__(self, name, plugin_class):
self.name = name
self._plugin_class = plugin_class
def load(self):
return self._plugin_class
mock_ep = MockEntryPoint("test_plugin", MockPlugin)
def mock_entry_points(*args, **kwargs):
if kwargs.get("group") == "praisonai.plugins":
return [mock_ep]
return {"praisonai.plugins": [mock_ep]}
monkeypatch.setattr(metadata, "entry_points", mock_entry_points)
manager = PluginManager()
loaded = manager.discover_entry_points()
assert loaded == 1
assert "test_plugin" in manager._plugins
assert manager._plugins["test_plugin"].__class__ == MockPlugin
@@ -1,394 +0,0 @@
"""
Unit tests for the new protocol-driven architecture components added in issue #1302.
Tests cover:
- AdapterRegistry base class (generic, thread-safe)
- MemoryAdapterRegistry
- KnowledgeAdapterRegistry
- InMemoryAdapter
- LLM provider adapters (DefaultAdapter, OllamaAdapter, AnthropicAdapter, GeminiAdapter)
- get_provider_adapter() dispatch function
"""
import pytest
import threading
from typing import Optional
# ---------------------------------------------------------------------------
# AdapterRegistry
# ---------------------------------------------------------------------------
class TestAdapterRegistry:
"""Tests for the generic AdapterRegistry base class."""
def _make_registry(self):
from praisonaiagents.utils.adapter_registry import AdapterRegistry
return AdapterRegistry(adapter_type_name="Test")
def test_register_and_get_adapter(self):
reg = self._make_registry()
class DummyAdapter:
def __init__(self, **kwargs):
pass
reg.register_adapter("dummy", DummyAdapter)
instance = reg.get_adapter("dummy")
assert isinstance(instance, DummyAdapter)
def test_register_and_get_factory(self):
reg = self._make_registry()
class FactoryAdapter:
def __init__(self, x=0):
self.x = x
reg.register_factory("factory", lambda **kw: FactoryAdapter(x=kw.get("x", 42)))
instance = reg.get_adapter("factory", x=99)
assert instance.x == 99
def test_factory_takes_priority_over_class(self):
"""Factory should be tried before class when both are registered."""
reg = self._make_registry()
results = []
class ClassAdapter:
def __init__(self, **kw):
results.append("class")
reg.register_adapter("both", ClassAdapter)
reg.register_factory("both", lambda **kw: results.append("factory") or ClassAdapter())
reg.get_adapter("both")
assert results[0] == "factory"
def test_returns_none_for_unknown_name(self):
reg = self._make_registry()
assert reg.get_adapter("nonexistent") is None
def test_raises_when_factory_fails(self):
import pytest
reg = self._make_registry()
def bad_factory(**kw):
raise RuntimeError("intentional failure")
reg.register_factory("bad", bad_factory)
with pytest.raises(RuntimeError):
reg.get_adapter("bad")
def test_raises_when_class_fails(self):
import pytest
reg = self._make_registry()
class BadAdapter:
def __init__(self, **kw):
raise ValueError("intentional failure")
reg.register_adapter("bad", BadAdapter)
with pytest.raises(RuntimeError):
reg.get_adapter("bad")
def test_list_adapters_sorted(self):
reg = self._make_registry()
class A:
pass
reg.register_adapter("b_adapter", A)
reg.register_adapter("a_adapter", A)
reg.register_factory("c_factory", lambda **kw: A())
names = reg.list_adapters()
assert names == sorted(names)
assert set(names) == {"a_adapter", "b_adapter", "c_factory"}
def test_is_available(self):
reg = self._make_registry()
class A:
pass
assert not reg.is_available("x")
reg.register_adapter("x", A)
assert reg.is_available("x")
def test_get_first_available_returns_first_match(self):
reg = self._make_registry()
class A:
pass
class B:
pass
reg.register_adapter("b", B)
result = reg.get_first_available(["a", "b"])
assert result is not None
name, instance = result
assert name == "b"
assert isinstance(instance, B)
def test_get_first_available_returns_none_if_all_fail(self):
reg = self._make_registry()
assert reg.get_first_available(["x", "y"]) is None
def test_thread_safety(self):
"""Concurrent registration and reads should not cause data races."""
from praisonaiagents.utils.adapter_registry import AdapterRegistry
reg = AdapterRegistry(adapter_type_name="ThreadTest")
errors = []
class TAdapter:
def __init__(self, **kw):
pass
def writer():
try:
for i in range(50):
reg.register_adapter(f"t{i}", TAdapter)
except Exception as e:
errors.append(e)
def reader():
try:
for _ in range(50):
reg.list_adapters()
reg.get_adapter("t0")
except Exception as e:
errors.append(e)
threads = [threading.Thread(target=writer), threading.Thread(target=reader)]
for t in threads:
t.start()
for t in threads:
t.join()
assert errors == [], f"Thread safety errors: {errors}"
# ---------------------------------------------------------------------------
# MemoryAdapterRegistry
# ---------------------------------------------------------------------------
class TestMemoryAdapterRegistry:
def test_imports(self):
from praisonaiagents.memory.adapters.registry import (
MemoryAdapterRegistry,
register_memory_adapter,
get_memory_adapter,
list_memory_adapters,
get_first_available_memory_adapter,
)
def test_core_adapters_registered(self):
from praisonaiagents.memory.adapters import list_memory_adapters
adapters = list_memory_adapters()
assert "sqlite" in adapters
assert "in_memory" in adapters
def test_get_in_memory_adapter(self):
from praisonaiagents.memory.adapters import get_memory_adapter
adapter = get_memory_adapter("in_memory")
assert adapter is not None
def test_get_first_available_defaults(self):
from praisonaiagents.memory.adapters import get_first_available_memory_adapter
result = get_first_available_memory_adapter()
assert result is not None
name, instance = result
assert name in ("sqlite", "in_memory")
def test_custom_registry_isolation(self):
"""Custom MemoryAdapterRegistry instances are independent."""
from praisonaiagents.memory.adapters.registry import MemoryAdapterRegistry
reg = MemoryAdapterRegistry()
class MyAdapter:
def __init__(self, **kw):
pass
reg.register_adapter("custom", MyAdapter)
assert reg.is_available("custom")
# The global registry should NOT see our custom adapter
from praisonaiagents.memory.adapters.registry import list_memory_adapters
assert "custom" not in list_memory_adapters()
# ---------------------------------------------------------------------------
# KnowledgeAdapterRegistry
# ---------------------------------------------------------------------------
class TestKnowledgeAdapterRegistry:
def test_imports(self):
from praisonaiagents.knowledge.adapters.registry import (
KnowledgeAdapterRegistry,
register_knowledge_adapter,
get_knowledge_adapter,
list_knowledge_adapters,
get_first_available_knowledge_adapter,
)
def test_register_and_retrieve(self):
from praisonaiagents.knowledge.adapters.registry import (
KnowledgeAdapterRegistry,
)
reg = KnowledgeAdapterRegistry()
class FakeStore:
def __init__(self, **kw):
pass
reg.register_adapter("fake", FakeStore)
instance = reg.get_adapter("fake")
assert isinstance(instance, FakeStore)
# ---------------------------------------------------------------------------
# InMemoryAdapter
# ---------------------------------------------------------------------------
class TestInMemoryAdapter:
def _adapter(self):
from praisonaiagents.memory.adapters.in_memory_adapter import InMemoryAdapter
return InMemoryAdapter()
def test_store_and_search_short_term(self):
a = self._adapter()
a.store_short_term("hello world", {"tag": "test"})
results = a.search_short_term("hello")
assert len(results) == 1
assert results[0]["text"] == "hello world"
def test_store_and_search_long_term(self):
a = self._adapter()
a.store_long_term("important fact", {"tag": "lm"})
results = a.search_long_term("important")
assert len(results) == 1
assert results[0]["type"] == "long"
def test_search_respects_limit(self):
a = self._adapter()
for i in range(10):
a.store_short_term(f"item {i}")
results = a.search_short_term("item", limit=3)
assert len(results) == 3
def test_short_term_not_in_long_term_search(self):
a = self._adapter()
a.store_short_term("cross contamination")
results = a.search_long_term("cross")
assert len(results) == 0
def test_get_all_memories(self):
a = self._adapter()
a.store_short_term("s1")
a.store_long_term("l1")
all_mem = a.get_all_memories()
assert len(all_mem) == 2
def test_case_insensitive_search(self):
a = self._adapter()
a.store_short_term("Hello World")
results = a.search_short_term("hello")
assert len(results) == 1
# ---------------------------------------------------------------------------
# LLM Provider Adapters
# ---------------------------------------------------------------------------
class TestLLMProviderAdapters:
def test_imports(self):
from praisonaiagents.llm.adapters import (
DefaultAdapter,
OllamaAdapter,
AnthropicAdapter,
GeminiAdapter,
get_provider_adapter,
)
def test_default_adapter_implements_protocol(self):
from praisonaiagents.llm.adapters import DefaultAdapter
from praisonaiagents.llm.protocols import LLMProviderAdapterProtocol
adapter = DefaultAdapter()
assert isinstance(adapter, LLMProviderAdapterProtocol)
def test_ollama_adapter_implements_protocol(self):
from praisonaiagents.llm.adapters import OllamaAdapter
from praisonaiagents.llm.protocols import LLMProviderAdapterProtocol
adapter = OllamaAdapter()
assert isinstance(adapter, LLMProviderAdapterProtocol)
def test_anthropic_adapter_prompt_caching(self):
from praisonaiagents.llm.adapters import AnthropicAdapter
adapter = AnthropicAdapter()
assert adapter.supports_prompt_caching() is True
def test_default_adapter_no_prompt_caching(self):
from praisonaiagents.llm.adapters import DefaultAdapter
adapter = DefaultAdapter()
assert adapter.supports_prompt_caching() is False
def test_ollama_threshold_matches_production(self):
"""OllamaAdapter.should_summarize_tools threshold must match LLM.OLLAMA_SUMMARY_ITERATION_THRESHOLD."""
from praisonaiagents.llm.adapters import OllamaAdapter
from praisonaiagents.llm.llm import LLM
adapter = OllamaAdapter()
threshold = LLM.OLLAMA_SUMMARY_ITERATION_THRESHOLD
# At threshold the adapter must return True
assert adapter.should_summarize_tools(threshold) is True
# Before threshold it must return False
if threshold > 0:
assert adapter.should_summarize_tools(threshold - 1) is False
def test_gemini_adapter_formats_internal_tools(self):
"""GeminiAdapter must recognise the actual Gemini internal tool names."""
from praisonaiagents.llm.adapters import GeminiAdapter
from praisonaiagents.llm.model_capabilities import GEMINI_INTERNAL_TOOLS
adapter = GeminiAdapter()
tools = [{"name": name} for name in GEMINI_INTERNAL_TOOLS]
tools.append({"name": "regular_tool"})
formatted = adapter.format_tools(tools)
internal = [t for t in formatted if "function" in t]
regular = [t for t in formatted if "function" not in t]
assert len(internal) == len(GEMINI_INTERNAL_TOOLS)
assert len(regular) == 1
assert regular[0]["name"] == "regular_tool"
class TestGetProviderAdapter:
def test_claude_model_returns_anthropic_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, AnthropicAdapter
assert isinstance(get_provider_adapter("claude-3.5-sonnet"), AnthropicAdapter)
def test_anthropic_in_name_returns_anthropic_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, AnthropicAdapter
assert isinstance(get_provider_adapter("anthropic/claude-instant"), AnthropicAdapter)
def test_ollama_prefix_returns_ollama_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, OllamaAdapter
assert isinstance(get_provider_adapter("ollama/llama3"), OllamaAdapter)
def test_ollama_in_name_returns_ollama_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, OllamaAdapter
assert isinstance(get_provider_adapter("my-ollama-model"), OllamaAdapter)
def test_gemini_prefix_returns_gemini_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, GeminiAdapter
assert isinstance(get_provider_adapter("gemini-pro"), GeminiAdapter)
def test_gemini_slash_prefix_returns_gemini_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, GeminiAdapter
assert isinstance(get_provider_adapter("gemini/gemini-2.0-flash"), GeminiAdapter)
def test_unknown_model_returns_default_adapter(self):
from praisonaiagents.llm.adapters import get_provider_adapter, DefaultAdapter
assert isinstance(get_provider_adapter("gpt-4o"), DefaultAdapter)
@@ -55,7 +55,6 @@ class TestRateLimiter:
assert elapsed < 0.1
@pytest.mark.asyncio
@pytest.mark.allow_sleep
async def test_rate_limiter_acquire_waits_when_exhausted(self):
"""Test that acquire waits when tokens exhausted."""
from praisonai.bots._rate_limit import RateLimiter, RateLimitConfig
@@ -74,7 +73,6 @@ class TestRateLimiter:
assert elapsed >= 0.05 # Allow some tolerance
@pytest.mark.asyncio
@pytest.mark.allow_sleep
async def test_rate_limiter_per_channel_delay(self):
"""Test per-channel delay enforcement."""
from praisonai.bots._rate_limit import RateLimiter, RateLimitConfig
@@ -380,18 +380,18 @@ class TestDoctorBotChecks:
def test_bot_tokens_check_no_tokens(self):
from praisonai.cli.features.doctor.checks.bot_checks import check_bot_tokens
from praisonai.cli.features.doctor.models import CheckStatus, DoctorConfig
from praisonai.cli.features.doctor.models import CheckStatus
for var in ["TELEGRAM_BOT_TOKEN", "DISCORD_BOT_TOKEN", "SLACK_BOT_TOKEN", "WHATSAPP_ACCESS_TOKEN"]:
os.environ.pop(var, None)
result = check_bot_tokens(DoctorConfig())
result = check_bot_tokens()
assert result.status == CheckStatus.WARN
def test_bot_tokens_check_with_token(self):
from praisonai.cli.features.doctor.checks.bot_checks import check_bot_tokens
from praisonai.cli.features.doctor.models import CheckStatus, DoctorConfig
from praisonai.cli.features.doctor.models import CheckStatus
os.environ["TELEGRAM_BOT_TOKEN"] = "test123"
try:
result = check_bot_tokens(DoctorConfig())
result = check_bot_tokens()
assert result.status == CheckStatus.PASS
assert "Telegram" in result.message
finally:
@@ -399,12 +399,16 @@ class TestDoctorBotChecks:
def test_bot_config_missing(self):
from praisonai.cli.features.doctor.checks.bot_checks import check_bot_config
from praisonai.cli.features.doctor.models import CheckStatus, DoctorConfig
config = DoctorConfig()
config.config_file = "/nonexistent/bot.yaml"
result = check_bot_config(config)
from praisonai.cli.features.doctor.models import CheckStatus
result = check_bot_config("/nonexistent/bot.yaml")
assert result.status == CheckStatus.WARN
def test_get_bot_checks(self):
from praisonai.cli.features.doctor.checks.bot_checks import get_bot_checks
checks = get_bot_checks()
assert len(checks) >= 2
assert all(hasattr(c, 'status') for c in checks)
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
# 8. Bot Approval Backend
@@ -50,7 +50,7 @@ class TestHandoffConfig:
assert config.max_context_messages == 10
assert config.preserve_system is True
assert config.timeout_seconds == 300.0
assert config.max_concurrent == 5
assert config.max_concurrent == 3
assert config.detect_cycles is True
assert config.max_depth == 10
assert config.async_mode is False
@@ -163,14 +163,14 @@ class TestHandoffErrors:
def test_cycle_error(self):
"""Test HandoffCycleError."""
chain = ["AgentA", "AgentB", "AgentA"]
error = HandoffCycleError("AgentA -> AgentB -> AgentA", cycle_path=chain)
error = HandoffCycleError(chain)
assert error.chain == chain
assert "AgentA -> AgentB -> AgentA" in str(error)
def test_depth_error(self):
"""Test HandoffDepthError."""
error = HandoffDepthError("11 > 10", current_depth=11, max_depth=10)
error = HandoffDepthError(depth=11, max_depth=10)
assert error.depth == 11
assert error.max_depth == 10
@@ -178,10 +178,10 @@ class TestHandoffErrors:
def test_timeout_error(self):
"""Test HandoffTimeoutError."""
error = HandoffTimeoutError("timeout 60", timeout_seconds=60.0, agent_id="TestAgent")
error = HandoffTimeoutError(timeout=60.0, agent_name="TestAgent")
assert error.timeout == 60.0
assert error.agent_id == "TestAgent"
assert error.agent_name == "TestAgent"
assert "60" in str(error)
assert "TestAgent" in str(error)
@@ -187,7 +187,10 @@ class TestMemoryMemoryWiring:
source = inspect.getsource(memory.Memory.__init__)
assert '".praisonai/long_term.db"' not in source
def test_uses_get_project_data_dir(self):
from praisonaiagents.memory import memory
source = inspect.getsource(memory.Memory.__init__)
assert "get_project_data_dir" in source
class TestMemoryHooksWiring:
+1 -1
View File
@@ -2951,7 +2951,7 @@ wheels = [
[[package]]
name = "praisonaiagents"
version = "1.5.121"
version = "1.5.112"
source = { editable = "." }
dependencies = [
{ name = "aiohttp" },
+50 -120
View File
@@ -1,14 +1,14 @@
{
"version": "1.5.87",
"lastUpdated": "2026-04-08",
"lastUpdated": "2026-04-01",
"generatedBy": "praisonai._dev.parity.generator",
"sourceOfTruth": "Python SDK (praisonaiagents)",
"status": "PARITY_ACHIEVED",
"summary": {
"pythonCoreFeatures": 321,
"pythonCoreFeatures": 314,
"rustFeatures": 667,
"gapCount": 42,
"parityPercentage": 207.8
"gapCount": 36,
"parityPercentage": 212.4
},
"pythonCoreSDK": {
"exports": [
@@ -80,7 +80,6 @@
"EmbeddingAgent",
"EmbeddingConfig",
"EmbeddingResult",
"ErrorContextProtocol",
"EscalationPipeline",
"EscalationStage",
"EventType",
@@ -125,7 +124,6 @@
"KNOWLEDGE_PRESETS",
"Knowledge",
"KnowledgeConfig",
"LLMError",
"LLMGuardrail",
"LLMPluginProtocol",
"LearnBackend",
@@ -154,7 +152,6 @@
"MultiAgentMemoryConfig",
"MultiAgentOutputConfig",
"MultiAgentPlanningConfig",
"NetworkError",
"OCRAgent",
"OCRConfig",
"OUTPUT_PRESETS",
@@ -179,7 +176,6 @@
"PluginParseError",
"PluginProtocol",
"PluginsConfig",
"PraisonAIError",
"PraisonConfig",
"PromptExpanderAgent",
"Provider",
@@ -227,7 +223,6 @@
"TemplateConfig",
"TodoItem",
"TodoList",
"ToolExecutionError",
"ToolPluginProtocol",
"ToolRegistry",
"ToolResult",
@@ -235,7 +230,6 @@
"Tools",
"TraceSink",
"TraceSinkProtocol",
"ValidationError",
"VideoAgent",
"VideoConfig",
"VisionAgent",
@@ -298,7 +292,6 @@
"memory",
"obs",
"parallel",
"parallel_handoffs",
"parse_plugin_header",
"parse_plugin_header_from_file",
"parse_policy_string",
@@ -1712,6 +1705,7 @@
"planning": [],
"plugins": [
"PluginRegistry",
"ToolDefinition",
"disable_plugins",
"enable_plugins",
"get_plugin_manager",
@@ -1736,7 +1730,6 @@
"tools": [
"FunctionTool",
"Tool",
"ToolDefinition",
"ToolRegistry",
"ToolResult"
],
@@ -1803,6 +1796,15 @@
"status": "TODO",
"category": "tools"
},
{
"feature": "BudgetExceededError",
"python": true,
"rust": false,
"priority": "P0",
"effort": "low",
"status": "TODO",
"category": "agent"
},
{
"feature": "CodeAgent",
"python": true,
@@ -1938,6 +1940,33 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffCycleError",
"python": true,
"rust": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffDepthError",
"python": true,
"rust": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffError",
"python": true,
"rust": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffInputData",
"python": true,
@@ -1956,6 +1985,15 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffTimeoutError",
"python": true,
"rust": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "ImageAgent",
"python": true,
@@ -2199,15 +2237,6 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "parallel_handoffs",
"python": true,
"rust": false,
"priority": "P0",
"effort": "low",
"status": "TODO",
"category": "agent"
},
{
"feature": "prompt_with_handoff_instructions",
"python": true,
@@ -3042,15 +3071,6 @@
"status": "DONE",
"category": "bots"
},
{
"feature": "BudgetExceededError",
"python": true,
"rust": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "CACHING_PRESETS",
"python": true,
@@ -3222,15 +3242,6 @@
"status": "DONE",
"category": "embedding"
},
{
"feature": "ErrorContextProtocol",
"python": true,
"rust": false,
"priority": "P3",
"effort": "medium",
"status": "TODO",
"category": "other"
},
{
"feature": "EscalationPipeline",
"python": true,
@@ -3402,42 +3413,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "HandoffCycleError",
"python": true,
"rust": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffDepthError",
"python": true,
"rust": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffError",
"python": true,
"rust": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffTimeoutError",
"python": true,
"rust": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "Heartbeat",
"python": true,
@@ -3492,15 +3467,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "LLMError",
"python": true,
"rust": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "LLMPluginProtocol",
"python": true,
@@ -3681,15 +3647,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "NetworkError",
"python": true,
"rust": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "OUTPUT_PRESETS",
"python": true,
@@ -3825,15 +3782,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "PraisonAIError",
"python": true,
"rust": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "PraisonConfig",
"python": true,
@@ -4005,15 +3953,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "ToolExecutionError",
"python": true,
"rust": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "ToolPluginProtocol",
"python": true,
@@ -4041,15 +3980,6 @@
"status": "DONE",
"category": "trace"
},
{
"feature": "ValidationError",
"python": true,
"rust": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "WEB_PRESETS",
"python": true,
+4 -10
View File
@@ -1,16 +1,16 @@
# Rust Feature Parity Tracker
> **Python Features:** 321 | **Rust Features:** 667 | **Parity:** 89.1%
> **Python Features:** 314 | **Rust Features:** 667 | **Parity:** 90.8%
## Summary
| Metric | Count |
|--------|-------|
| Python Core Features | 321 |
| Python Core Features | 314 |
| Rust Features | 667 |
| **Actual Gap Count** | **35** |
| **Actual Gap Count** | **29** |
| Language Limitations (N/A) | 6 |
| **Parity** | **89.1%** |
| **Parity** | **90.8%** |
## Implemented Features
@@ -703,12 +703,10 @@ These Python features cannot be directly implemented in Rust due to reserved key
- ❌ `BudgetExceededError`
- ❌ `ConsoleBackend`
- ❌ `DoomLoopDetector`
- ❌ `ErrorContextProtocol`
- ❌ `EscalationPipeline`
- ❌ `EscalationStage`
- ❌ `Heartbeat`
- ❌ `HeartbeatConfig`
- ❌ `LLMError`
- ❌ `LearnBackend`
- ❌ `LearnConfig`
- ❌ `LearnManager`
@@ -716,18 +714,14 @@ These Python features cannot be directly implemented in Rust due to reserved key
- ❌ `LearnMode`
- ❌ `LearnProtocol`
- ❌ `LearnScope`
- ❌ `NetworkError`
- ❌ `ObservabilityEventType`
- ❌ `ObservabilityHooks`
- ❌ `PraisonAIError`
- ❌ `StructuredFormatter`
- ❌ `ToolExecutionError`
- ❌ `ToolValidationError`
- ❌ `configure_structured_logging`
- ❌ `get_logger`
- ❌ `get_registry`
- ❌ `get_tool`
- ❌ `parallel_handoffs`
- ❌ `register_tool`
- ❌ `validate_tool`
+55 -132
View File
@@ -1,17 +1,17 @@
{
"version": "1.5.87",
"lastUpdated": "2026-04-08",
"lastUpdated": "2026-04-01",
"generatedBy": "praisonai._dev.parity.generator",
"sourceOfTruth": "Python SDK (praisonaiagents)",
"summary": {
"pythonCoreFeatures": 321,
"pythonCoreFeatures": 314,
"pythonWrapperFeatures": 99,
"typescriptFeatures": 1192,
"gapCount": 28,
"priorityP0": 1,
"gapCount": 21,
"priorityP0": 0,
"priorityP1": 0,
"priorityP2": 0,
"priorityP3": 27
"priorityP3": 21
},
"pythonCoreSDK": {
"path": "/home/runner/work/PraisonAI/PraisonAI/src/praisonai-agents/praisonaiagents",
@@ -84,7 +84,6 @@
"EmbeddingAgent",
"EmbeddingConfig",
"EmbeddingResult",
"ErrorContextProtocol",
"EscalationPipeline",
"EscalationStage",
"EventType",
@@ -129,7 +128,6 @@
"KNOWLEDGE_PRESETS",
"Knowledge",
"KnowledgeConfig",
"LLMError",
"LLMGuardrail",
"LLMPluginProtocol",
"LearnBackend",
@@ -158,7 +156,6 @@
"MultiAgentMemoryConfig",
"MultiAgentOutputConfig",
"MultiAgentPlanningConfig",
"NetworkError",
"OCRAgent",
"OCRConfig",
"OUTPUT_PRESETS",
@@ -183,7 +180,6 @@
"PluginParseError",
"PluginProtocol",
"PluginsConfig",
"PraisonAIError",
"PraisonConfig",
"PromptExpanderAgent",
"Provider",
@@ -231,7 +227,6 @@
"TemplateConfig",
"TodoItem",
"TodoList",
"ToolExecutionError",
"ToolPluginProtocol",
"ToolRegistry",
"ToolResult",
@@ -239,7 +234,6 @@
"Tools",
"TraceSink",
"TraceSinkProtocol",
"ValidationError",
"VideoAgent",
"VideoConfig",
"VisionAgent",
@@ -302,7 +296,6 @@
"memory",
"obs",
"parallel",
"parallel_handoffs",
"parse_plugin_header",
"parse_plugin_header_from_file",
"parse_policy_string",
@@ -343,6 +336,7 @@
"Agent",
"AudioAgent",
"AudioConfig",
"BudgetExceededError",
"CodeAgent",
"CodeConfig",
"CodeExecutionStep",
@@ -357,8 +351,12 @@
"FileSearchCall",
"Handoff",
"HandoffConfig",
"HandoffCycleError",
"HandoffDepthError",
"HandoffError",
"HandoffInputData",
"HandoffResult",
"HandoffTimeoutError",
"ImageAgent",
"MCPCall",
"OCRAgent",
@@ -380,7 +378,6 @@
"create_context_agent",
"handoff",
"handoff_filters",
"parallel_handoffs",
"prompt_with_handoff_instructions"
],
"agents": [
@@ -570,28 +567,17 @@
"Agents",
"AsyncLearnProtocol",
"AutonomyConfig",
"BudgetExceededError",
"DoomLoopDetector",
"ErrorContextProtocol",
"EscalationPipeline",
"EscalationStage",
"HandoffCycleError",
"HandoffDepthError",
"HandoffError",
"HandoffTimeoutError",
"Heartbeat",
"HeartbeatConfig",
"LLMError",
"LearnManager",
"LearnManagerProtocol",
"LearnProtocol",
"NetworkError",
"ObservabilityEventType",
"ObservabilityHooks",
"PraisonAIError",
"StructuredFormatter",
"ToolExecutionError",
"ValidationError",
"config",
"configure_structured_logging",
"embedding",
@@ -2882,6 +2868,15 @@
"status": "DONE",
"category": "tools"
},
{
"feature": "BudgetExceededError",
"python": true,
"typescript": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "CodeAgent",
"python": true,
@@ -3017,6 +3012,33 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffCycleError",
"python": true,
"typescript": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffDepthError",
"python": true,
"typescript": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffError",
"python": true,
"typescript": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffInputData",
"python": true,
@@ -3035,6 +3057,15 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "HandoffTimeoutError",
"python": true,
"typescript": true,
"priority": "P0",
"effort": "low",
"status": "DONE",
"category": "agent"
},
{
"feature": "ImageAgent",
"python": true,
@@ -3278,15 +3309,6 @@
"status": "DONE",
"category": "agent"
},
{
"feature": "parallel_handoffs",
"python": true,
"typescript": false,
"priority": "P0",
"effort": "low",
"status": "TODO",
"category": "agent"
},
{
"feature": "prompt_with_handoff_instructions",
"python": true,
@@ -4121,15 +4143,6 @@
"status": "DONE",
"category": "bots"
},
{
"feature": "BudgetExceededError",
"python": true,
"typescript": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "CACHING_PRESETS",
"python": true,
@@ -4301,15 +4314,6 @@
"status": "DONE",
"category": "embedding"
},
{
"feature": "ErrorContextProtocol",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "medium",
"status": "TODO",
"category": "other"
},
{
"feature": "EscalationPipeline",
"python": true,
@@ -4481,42 +4485,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "HandoffCycleError",
"python": true,
"typescript": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffDepthError",
"python": true,
"typescript": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffError",
"python": true,
"typescript": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "HandoffTimeoutError",
"python": true,
"typescript": true,
"priority": "P3",
"effort": "low",
"status": "DONE",
"category": "other"
},
{
"feature": "Heartbeat",
"python": true,
@@ -4571,15 +4539,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "LLMError",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "LLMPluginProtocol",
"python": true,
@@ -4760,15 +4719,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "NetworkError",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "OUTPUT_PRESETS",
"python": true,
@@ -4904,15 +4854,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "PraisonAIError",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "PraisonConfig",
"python": true,
@@ -5084,15 +5025,6 @@
"status": "DONE",
"category": "config"
},
{
"feature": "ToolExecutionError",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "ToolPluginProtocol",
"python": true,
@@ -5120,15 +5052,6 @@
"status": "DONE",
"category": "trace"
},
{
"feature": "ValidationError",
"python": true,
"typescript": false,
"priority": "P3",
"effort": "low",
"status": "TODO",
"category": "other"
},
{
"feature": "WEB_PRESETS",
"python": true,
+16 -23
View File
@@ -1,32 +1,32 @@
# Feature Parity Tracker
> **Version:** 1.5.87 | **Last Updated:** 2026-04-08
> **Version:** 1.5.87 | **Last Updated:** 2026-04-01
> **Source of Truth:** Python SDK (praisonaiagents)
## Summary
| Metric | Count |
|--------|-------|
| Python Core Features | 321 |
| Python Core Features | 314 |
| Python Wrapper Features | 99 |
| TypeScript Features | 1192 |
| **Gap Count** | **28** |
| P0 (Critical) | 1 |
| **Gap Count** | **21** |
| P0 (Critical) | 0 |
| P1 (High) | 0 |
| P2 (Medium) | 0 |
| P3 (Low) | 27 |
| P3 (Low) | 21 |
## Gap Matrix
### P0_CoreParity (52 done, 1 todo)
### P0_CoreParity (57 done, 0 todo)
| Feature | Python | TypeScript | Effort | Status |
|---------|--------|------------|--------|--------|
| `parallel\_handoffs` | ✅ | ❌ | low | ⏳ TODO |
| `Agent` | ✅ | ✅ | high | ✅ DONE |
| `AudioAgent` | ✅ | ✅ | high | ✅ DONE |
| `AudioConfig` | ✅ | ✅ | low | ✅ DONE |
| `BaseTool` | ✅ | ✅ | high | ✅ DONE |
| `BudgetExceededError` | ✅ | ✅ | low | ✅ DONE |
| `CodeAgent` | ✅ | ✅ | high | ✅ DONE |
| `CodeConfig` | ✅ | ✅ | low | ✅ DONE |
| `CodeExecutionStep` | ✅ | ✅ | high | ✅ DONE |
@@ -42,8 +42,12 @@
| `FunctionTool` | ✅ | ✅ | high | ✅ DONE |
| `Handoff` | ✅ | ✅ | high | ✅ DONE |
| `HandoffConfig` | ✅ | ✅ | low | ✅ DONE |
| `HandoffCycleError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffDepthError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffInputData` | ✅ | ✅ | high | ✅ DONE |
| `HandoffResult` | ✅ | ✅ | low | ✅ DONE |
| `HandoffTimeoutError` | ✅ | ✅ | low | ✅ DONE |
| `ImageAgent` | ✅ | ✅ | high | ✅ DONE |
| `MCPCall` | ✅ | ✅ | high | ✅ DONE |
| `OCRAgent` | ✅ | ✅ | high | ✅ DONE |
@@ -147,7 +151,7 @@
| `enable\_telemetry` | ✅ | ✅ | low | ✅ DONE |
| `get\_telemetry` | ✅ | ✅ | low | ✅ DONE |
### P3_Advanced (180 done, 27 todo)
### P3_Advanced (175 done, 21 todo)
| Feature | Python | TypeScript | Effort | Status |
|---------|--------|------------|--------|--------|
@@ -157,25 +161,19 @@
| `BotOSProtocol` | ✅ | ❌ | medium | ⏳ TODO |
| `ConsoleBackend` | ✅ | ❌ | high | ⏳ TODO |
| `DoomLoopDetector` | ✅ | ❌ | high | ⏳ TODO |
| `ErrorContextProtocol` | ✅ | ❌ | medium | ⏳ TODO |
| `EscalationPipeline` | ✅ | ❌ | high | ⏳ TODO |
| `EscalationStage` | ✅ | ❌ | high | ⏳ TODO |
| `Heartbeat` | ✅ | ❌ | high | ⏳ TODO |
| `HeartbeatConfig` | ✅ | ❌ | low | ⏳ TODO |
| `LLMError` | ✅ | ❌ | low | ⏳ TODO |
| `LearnBackend` | ✅ | ❌ | high | ⏳ TODO |
| `LearnManager` | ✅ | ❌ | high | ⏳ TODO |
| `LearnManagerProtocol` | ✅ | ❌ | medium | ⏳ TODO |
| `LearnMode` | ✅ | ❌ | high | ⏳ TODO |
| `LearnProtocol` | ✅ | ❌ | medium | ⏳ TODO |
| `LearnScope` | ✅ | ❌ | high | ⏳ TODO |
| `NetworkError` | ✅ | ❌ | low | ⏳ TODO |
| `ObservabilityEventType` | ✅ | ❌ | high | ⏳ TODO |
| `ObservabilityHooks` | ✅ | ❌ | high | ⏳ TODO |
| `PraisonAIError` | ✅ | ❌ | low | ⏳ TODO |
| `StructuredFormatter` | ✅ | ❌ | high | ⏳ TODO |
| `ToolExecutionError` | ✅ | ❌ | low | ⏳ TODO |
| `ValidationError` | ✅ | ❌ | low | ⏳ TODO |
| `configure\_structured\_logging` | ✅ | ❌ | low | ⏳ TODO |
| `get\_logger` | ✅ | ❌ | low | ⏳ TODO |
| `A2A` | ✅ | ✅ | low | ✅ DONE |
@@ -201,7 +199,6 @@
| `BotMessage` | ✅ | ✅ | high | ✅ DONE |
| `BotProtocol` | ✅ | ✅ | medium | ✅ DONE |
| `BotUser` | ✅ | ✅ | high | ✅ DONE |
| `BudgetExceededError` | ✅ | ✅ | low | ✅ DONE |
| `CACHING\_PRESETS` | ✅ | ✅ | low | ✅ DONE |
| `CONTEXT\_PRESETS` | ✅ | ✅ | low | ✅ DONE |
| `CachingConfig` | ✅ | ✅ | low | ✅ DONE |
@@ -236,10 +233,6 @@
| `GatewaySessionProtocol` | ✅ | ✅ | medium | ✅ DONE |
| `GuardrailAction` | ✅ | ✅ | high | ✅ DONE |
| `GuardrailConfig` | ✅ | ✅ | low | ✅ DONE |
| `HandoffCycleError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffDepthError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffError` | ✅ | ✅ | low | ✅ DONE |
| `HandoffTimeoutError` | ✅ | ✅ | low | ✅ DONE |
| `HookPluginProtocol` | ✅ | ✅ | medium | ✅ DONE |
| `HooksConfig` | ✅ | ✅ | low | ✅ DONE |
| `KNOWLEDGE\_PRESETS` | ✅ | ✅ | low | ✅ DONE |
@@ -364,10 +357,10 @@
**Path:** `/home/runner/work/PraisonAI/PraisonAI/src/praisonai-agents/praisonaiagents`
<details>
<summary><strong>agent</strong> (42 exports)</summary>
<summary><strong>agent</strong> (46 exports)</summary>
```python
from praisonaiagents import Agent, AudioAgent, AudioConfig, CodeAgent, CodeConfig, CodeExecutionStep, ContextAgent, ContextPolicy, DeepResearchAgent, DeepResearchResponse...
from praisonaiagents import Agent, AudioAgent, AudioConfig, BudgetExceededError, CodeAgent, CodeConfig, CodeExecutionStep, ContextAgent, ContextPolicy, DeepResearchAgent...
```
</details>
@@ -526,10 +519,10 @@ from praisonaiagents import obs
</details>
<details>
<summary><strong>other</strong> (33 exports)</summary>
<summary><strong>other</strong> (22 exports)</summary>
```python
from praisonaiagents import Agents, AsyncLearnProtocol, AutonomyConfig, BudgetExceededError, DoomLoopDetector, ErrorContextProtocol, EscalationPipeline, EscalationStage, HandoffCycleError, HandoffDepthError...
from praisonaiagents import Agents, AsyncLearnProtocol, AutonomyConfig, DoomLoopDetector, EscalationPipeline, EscalationStage, Heartbeat, HeartbeatConfig, LearnManager, LearnManagerProtocol...
```
</details>
+5 -47
View File
@@ -4,7 +4,6 @@
*/
import { AgentFlow, Task, TaskConfig } from './index';
import * as path from 'path';
export interface YAMLWorkflowDefinition {
name: string;
@@ -36,19 +35,12 @@ export interface ParsedWorkflow {
errors: string[];
}
// Whitelist of allowed step keys to prevent injection
const ALLOWED_STEP_KEYS = new Set([
'type', 'agent', 'tool', 'input', 'output', 'condition',
'onError', 'maxRetries', 'timeout', 'loopCondition', 'maxIterations',
]);
/**
* Parse YAML string into workflow definition
*/
export function parseYAMLWorkflow(yamlContent: string): YAMLWorkflowDefinition {
// SECURITY: If migrating to js-yaml, you MUST use:
// yaml.load(content, { schema: yaml.JSON_SCHEMA })
// Never use yaml.load() with DEFAULT_SCHEMA — it enables arbitrary JS execution.
// Simple YAML parser for workflow definitions
// For production, use js-yaml package
const lines = yamlContent.split('\n');
const result: YAMLWorkflowDefinition = {
name: '',
@@ -90,11 +82,7 @@ export function parseYAMLWorkflow(yamlContent: string): YAMLWorkflowDefinition {
type: 'agent'
};
} else if (currentStep) {
// Step properties — whitelist allowed keys to prevent injection
if (!ALLOWED_STEP_KEYS.has(key)) {
// Ignore unknown keys — do not allow arbitrary property injection
continue;
}
// Step properties
if (key === 'type') currentStep.type = value as any;
else if (key === 'agent') currentStep.agent = value;
else if (key === 'tool') currentStep.tool = value;
@@ -277,40 +265,10 @@ function parseValue(value: string): any {
export async function loadWorkflowFromFile(
filePath: string,
agents: Record<string, any> = {},
tools: Record<string, any> = {},
options: { basePath?: string; maxFileSizeBytes?: number } = {}
tools: Record<string, any> = {}
): Promise<ParsedWorkflow> {
const fs = await import('fs/promises');
// SECURITY: Prevent path traversal
const normalizedPath = path.normalize(filePath);
// Check for '..' as path segments (not just substring)
const pathSegments = normalizedPath.split(path.sep);
if (pathSegments.includes('..')) {
throw new Error('Path traversal detected: ".." path segments are not allowed');
}
let effectivePath: string;
// If basePath is specified, ensure resolvedPath stays within it
if (options.basePath) {
const resolvedBase = path.resolve(options.basePath);
const resolvedFile = path.resolve(options.basePath, normalizedPath);
if (!resolvedFile.startsWith(resolvedBase + path.sep) && resolvedFile !== resolvedBase) {
throw new Error(`File path must be within base directory: ${options.basePath}`);
}
effectivePath = resolvedFile;
} else {
effectivePath = path.resolve(normalizedPath);
}
// SECURITY: Enforce file size limit (default 1 MB)
const maxSize = options.maxFileSizeBytes ?? 1_048_576;
const stat = await fs.stat(effectivePath);
if (stat.size > maxSize) {
throw new Error(`File too large: ${stat.size} bytes exceeds limit of ${maxSize} bytes`);
}
const content = await fs.readFile(effectivePath, 'utf-8');
const content = await fs.readFile(filePath, 'utf-8');
const definition = parseYAMLWorkflow(content);
return createWorkflowFromYAML(definition, agents, tools);
}
+96 -60
View File
@@ -23,13 +23,14 @@
</div>
PraisonAI 🦞 — **Hire a 24/7 AI Workforce.** Stop writing boilerplate and start shipping autonomous agents that research, plan, and execute tasks across your apps. From one agent to an entire organization, deployed in 5 lines of code.
PraisonAI 🦞 — Automate and solve complex challenges with AI agent teams that plan, research, code, and deliver results to Telegram, Discord, and WhatsApp — running 24/7. A low-code, production-ready multi-agent framework with handoffs, guardrails, memory, RAG, and 100+ LLM providers, built around simplicity, customisation, and effective human-agent collaboration.
<div align="center">
<br>
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src="https://img.shields.io/badge/Highlighted_by_Elon_Musk-000000?style=for-the-badge&logo=x&logoColor=white" alt="Highlighted by Elon Musk" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
<br>
</div>
@@ -68,6 +69,26 @@ PraisonAI 🦞 — **Hire a 24/7 AI Workforce.** Stop writing boilerplate and st
---
> **Quick Paths:**
> - 🆕 **New here?** → [Quick Start](#-quick-start) *(1 minute to first agent)*
> - 📦 **Installing?** → [Installation](#-installation)
> - 🐍 **Python SDK?** → [Python Examples](#-using-python-code)
> - 📄 **YAML/No-Code?** → [YAML Examples](#-using-yaml-no-code)
> - 🎯 **CLI user?** → [CLI Quick Reference](#-cli-quick-reference)
> - 🤝 **Contributing?** → [Contributing](#-contributing)
---
## ⚡ Performance
PraisonAI is built for speed, with agent instantiation in under 4μs. This reduces overhead, improves responsiveness, and helps multi-agent systems scale efficiently in real-world production workloads.
| Performance Metric | PraisonAI |
|--------------------|-----------|
| Avg Instantiation Time | **3.77 μs** |
---
## 🎯 Use Cases
AI agents solving real-world problems across industries:
@@ -83,44 +104,9 @@ AI agents solving real-world problems across industries:
---
## 🚀 Meet your first Agent (Under 1 Minute)
## Supported Providers
1. Install the lightweight core SDK:
```bash
pip install praisonaiagents
export OPENAI_API_KEY="your-api-key"
```
2. Run your first autonomous agent:
```python
from praisonaiagents import Agent
# Give your agent a goal, and watch it work.
agent = Agent(instructions="You are a senior data analyst.")
agent.start("Analyze the top 3 tech trends of 2026 and format as a markdown table.")
```
---
## 🌌 The PraisonAI Ecosystem
Start simple with the core SDK, or expand to full visual builders and dashboards when you're ready.
* **Core SDK (`praisonaiagents`)**: For pure Python development. `pip install praisonaiagents`
* 💻 **PraisonAI CLI (`praisonai`)**: For terminal-based developers. `pip install praisonai`
* 🦞 **Claw Dashboard**: Connect agents directly to Telegram, Slack, or Discord. `pip install "praisonai[claw]"`
* 🔗 **Flow Visual Builder**: Drag-and-drop workflow creation. `pip install "praisonai[flow]"`
* 🤖 **PraisonAI UI**: Clean chat interface. `pip install "praisonai[ui]"`
### JavaScript SDK
```bash
npm install praisonai
```
## 🧠 Supported Providers & Features
Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
PraisonAI supports 100+ LLM providers through seamless integration:
<p align="center">
<img src="https://img.shields.io/badge/OpenAI-412991?style=flat&logo=openai&logoColor=white" alt="OpenAI" />
@@ -178,14 +164,6 @@ Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
</details>
<div align="center">
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src=".github/images/elon_musk_praisonai.png" alt="Highlighted by Elon Musk" width="600" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
</div>
<br>
---
## 🌟 Why PraisonAI?
@@ -227,6 +205,78 @@ Powered by 100+ LLMs (OpenAI, Anthropic, Gemini & local models).
</details>
<div align="center">
<a href="https://x.com/elonmusk/status/1893870468249141688" target="_blank">
<img src=".github/images/elon_musk_praisonai.png" alt="Highlighted by Elon Musk" width="600" />
</a>
<p><em>"Grok 3 customer support" — <a href="https://x.com/elonmusk/status/1893870468249141688">Elon Musk quoting PraisonAI's tutorial</a></em></p>
</div>
<br>
---
## 🚀 Quick Start
Get started with PraisonAI in under 1 minute:
```bash
# Install
pip install praisonaiagents
# Set API key
export OPENAI_API_KEY=your_key_here
# Create a simple agent
python -c "from praisonaiagents import Agent; Agent(instructions='You are a helpful AI assistant').start('Write a haiku about AI')"
```
> **Next Steps:** [Single Agent Example](#1-single-agent) | [Multi Agents](#2-multi-agents) | [Full Docs](https://docs.praison.ai)
---
## 📦 Installation
### Python SDK
Lightweight package dedicated for coding:
```bash
pip install praisonaiagents
```
For the full framework with CLI support:
```bash
pip install praisonai
```
🦞 **PraisonAI Claw** — full UI with bots, memory, knowledge, and gateway:
```bash
pip install "praisonai[claw]"
praisonai claw
```
🔗 **PraisonAI Flow** — Langflow Visual Flow Builder:
```bash
pip install "praisonai[flow]"
praisonai flow
```
🤖 **PraisonAI UI** — Clean chat interface:
```bash
pip install "praisonai[ui]"
praisonai ui
```
### JavaScript SDK
```bash
npm install praisonai
```
---
@@ -724,20 +774,6 @@ const agent = new Agent({ instructions: 'You are a helpful AI assistant' });
agent.start('Write a movie script about a robot in Mars');
```
---
## ⚡ Performance
PraisonAI is built for speed, with agent instantiation in under 4μs. This reduces overhead, improves responsiveness, and helps multi-agent systems scale efficiently in real-world production workloads.
| Performance Metric | PraisonAI |
|--------------------|-----------|
| Avg Instantiation Time | **3.77 μs** |
---
---
## ⭐ Star History
+2 -2
View File
@@ -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/v4.5.121.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v4.5.121.tar.gz | shasum -a 256`.split.first
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v4.5.112.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v4.5.112.tar.gz | shasum -a 256`.split.first
license "MIT"
depends_on "[email protected]"
+3 -98
View File
@@ -237,7 +237,7 @@ class AgentsGenerator:
CLI configuration takes precedence over YAML configuration for:
- Global config fields (acp, lsp) -> config.config
- Agent-level fields (trust, tool_timeout, planning_tools, autonomy, guardrail, approval) -> applied to all agents
- Agent-level fields (trust, tool_timeout, planning_tools) -> applied to all agents
Args:
config (dict): The parsed YAML configuration
@@ -258,27 +258,10 @@ class AgentsGenerator:
config['config']['lsp'] = cli_config['lsp']
self.logger.debug(f"CLI override: lsp = {cli_config['lsp']}")
# Handle agent-level overrides (trust, tool_timeout, planning_tools, autonomy, guardrail, approval)
agent_level_fields = ['trust', 'tool_timeout', 'planning_tools', 'autonomy', 'guardrail', 'approval', 'approve_all_tools', 'approval_timeout']
# Handle agent-level overrides (trust, tool_timeout, planning_tools)
agent_level_fields = ['trust', 'tool_timeout', 'planning_tools']
agent_overrides = {k: v for k, v in cli_config.items() if k in agent_level_fields}
# Map CLI field names to YAML field names
field_mappings = {
'guardrail': 'guardrails', # CLI uses --guardrail, YAML uses guardrails
'trust': 'approval' # --trust maps to approval=True
}
# Apply field mappings and special handling
for cli_field in field_mappings:
if cli_field in agent_overrides:
value = agent_overrides.pop(cli_field)
if cli_field == 'trust' and value:
# --trust flag maps to approval=True for auto-approval
agent_overrides['approval'] = True
elif cli_field == 'guardrail':
# --guardrail "description" maps to guardrails config
agent_overrides['guardrails'] = value
if agent_overrides:
# Apply to all agents in the config
roles = config.get('roles', {})
@@ -1196,80 +1179,6 @@ class AgentsGenerator:
else:
agent_planning.pop('planning_tools')
# Extract YAML configuration for advanced features
autonomy_config = details.get('autonomy')
guardrails_config = details.get('guardrails')
# Extract streaming configuration - YAML takes precedence over CLI
has_streaming_config = 'streaming' in details
has_legacy_stream = 'stream' in details
streaming_config = details.get('streaming')
stream_enabled = False
stream_metrics = False
if has_streaming_config:
if isinstance(streaming_config, bool):
stream_enabled = streaming_config
elif isinstance(streaming_config, dict):
stream_enabled = streaming_config.get('enabled', False)
stream_metrics = streaming_config.get('emit_metrics', False)
# Future: can add callbacks, etc. from streaming_config
elif has_legacy_stream: # Also support direct 'stream: true' format
stream_enabled = details.get('stream', False)
# CLI streaming flags override if YAML doesn't specify
cli_config = getattr(self, 'cli_config', {}) or {}
if not has_streaming_config and not has_legacy_stream:
stream_enabled = cli_config.get('stream', False)
stream_metrics = cli_config.get('stream_metrics', False)
# Reconstruct approval config from potentially scattered settings
approval_val = details.get('approval')
approve_all = details.get('approve_all_tools')
approval_timeout = details.get('approval_timeout')
approval_config = None
if approval_val is not None or approve_all is not None or approval_timeout is not None:
if isinstance(approval_val, dict):
approval_dict = approval_val
else:
approval_dict = {'backend': approval_val}
if approve_all is not None:
approval_dict['approve_all_tools'] = approve_all
if approval_timeout is not None:
approval_dict['approval_timeout'] = approval_timeout
try:
from .cli.features.approval import resolve_approval_config
# Map common YAML fields to resolve_approval_config parameters
approval_config = resolve_approval_config(
backend_name=approval_dict.get('backend') or approval_dict.get('backend_name'),
all_tools=approval_dict.get('approve_all_tools') or approval_dict.get('all_tools', False),
timeout=approval_dict.get('approval_timeout') or approval_dict.get('timeout')
)
except ImportError:
# Fallback: Create ApprovalConfig directly if resolve_approval_config isn't available
try:
from praisonaiagents.approval.protocols import ApprovalConfig
approval_config = ApprovalConfig(
backend=approval_dict.get('backend', None),
all_tools=approval_dict.get('approve_all_tools', approval_dict.get('all_tools', False)),
timeout=approval_dict.get('approval_timeout', approval_dict.get('timeout', 0))
)
except ImportError:
# Last resort: disable approval for this agent
approval_config = None
# Build output configuration with streaming support
output_config = None
if stream_enabled:
try:
from praisonaiagents.config import OutputConfig
output_config = OutputConfig(stream=True, metrics=stream_metrics)
except ImportError:
self.logger.warning("OutputConfig not available, streaming disabled")
agent = PraisonAgent(
name=role_filled,
role=role_filled,
@@ -1282,10 +1191,6 @@ class AgentsGenerator:
reflection=details.get('reflection', False),
tool_timeout=agent_tool_timeout,
planning=agent_planning,
autonomy=autonomy_config,
guardrails=guardrails_config,
approval=approval_config,
output=output_config,
)
if self.agent_callback:
-20
View File
@@ -112,27 +112,7 @@ class BrowserServer:
import json
import time
import uuid
import os
origin = websocket.headers.get("origin")
allowed_origins = os.environ.get("ALLOWED_ORIGINS", "").split(",")
if origin:
import urllib.parse
parsed_origin = urllib.parse.urlparse(origin)
is_allowed = False
if parsed_origin.scheme in ("http", "https") and parsed_origin.hostname in ("localhost", "127.0.0.1"):
is_allowed = True
elif parsed_origin.scheme == "chrome-extension":
is_allowed = True
if any(origin == allowed.strip() for allowed in allowed_origins if allowed.strip()):
is_allowed = True
if not is_allowed:
await websocket.close(code=1008)
return
await websocket.accept()
# Create connection tracking
Loaded 100 of 141 files, more files were not shown because too many files have changed in this diff. Show more