empathy-framework 5.2.1__py3-none-any.whl → 5.4.0__py3-none-any.whl

empathy_os/prompts/registry.py

@@ -1,313 +0,0 @@
-"""Built-in XML Prompt Templates Registry
-
-Provides pre-configured XML templates for common workflows.
-
-Copyright 2025 Smart-AI-Memory
-Licensed under Fair Source License 0.9
-"""
-
-from __future__ import annotations
-
-from .templates import XmlPromptTemplate
-
-# =============================================================================
-# Response Format Definitions
-# =============================================================================
-
-SECURITY_AUDIT_RESPONSE = """<response>
-  <summary>Brief overall security assessment (1-2 sentences)</summary>
-  <findings>
-    <finding severity="critical|high|medium|low|info">
-      <title>Issue title</title>
-      <location>file:line or component</location>
-      <details>Description of the vulnerability and potential impact</details>
-      <fix>Specific remediation steps with code example if applicable</fix>
-    </finding>
-    <!-- Additional findings... -->
-  </findings>
-  <remediation-checklist>
-    <item>Priority action item 1</item>
-    <item>Priority action item 2</item>
-    <!-- Additional items... -->
-  </remediation-checklist>
-</response>"""
-
-CODE_REVIEW_RESPONSE = """<response>
-  <summary>Brief review summary (1-2 sentences)</summary>
-  <verdict>approve|approve_with_suggestions|request_changes|reject</verdict>
-  <findings>
-    <finding severity="critical|high|medium|low|info">
-      <title>Issue title</title>
-      <location>file:line</location>
-      <details>Description of the issue</details>
-      <fix>Suggested fix or improvement</fix>
-    </finding>
-    <!-- Additional findings... -->
-  </findings>
-  <suggestions>
-    <suggestion>Optional improvement suggestion</suggestion>
-    <!-- Additional suggestions... -->
-  </suggestions>
-  <remediation-checklist>
-    <item>Required change 1</item>
-    <item>Required change 2</item>
-    <!-- Additional items if request_changes... -->
-  </remediation-checklist>
-</response>"""
-
-RESEARCH_RESPONSE = """<response>
-  <summary>Research synthesis summary (2-3 sentences)</summary>
-  <key-insights>
-    <insight>Key insight or finding 1</insight>
-    <insight>Key insight or finding 2</insight>
-    <!-- Additional insights... -->
-  </key-insights>
-  <findings>
-    <finding severity="info">
-      <title>Topic or concept</title>
-      <details>Explanation with context</details>
-    </finding>
-    <!-- Additional topics if needed... -->
-  </findings>
-  <confidence level="high|medium|low">Reasoning for confidence level</confidence>
-  <remediation-checklist>
-    <item>Recommended next step 1</item>
-    <item>Recommended next step 2</item>
-  </remediation-checklist>
-</response>"""
-
-BUG_ANALYSIS_RESPONSE = """<response>
-  <summary>Root cause summary (1-2 sentences)</summary>
-  <findings>
-    <finding severity="critical|high|medium|low">
-      <title>Bug description</title>
-      <location>file:line where issue originates</location>
-      <details>Root cause analysis</details>
-      <fix>Recommended fix with code</fix>
-    </finding>
-  </findings>
-  <remediation-checklist>
-    <item>Fix step 1</item>
-    <item>Verification step</item>
-    <item>Test to add</item>
-  </remediation-checklist>
-</response>"""
-
-PERF_AUDIT_RESPONSE = """<response>
-  <summary>Performance assessment summary (1-2 sentences)</summary>
-  <performance-score>0-100</performance-score>
-  <findings>
-    <finding severity="critical|high|medium|low">
-      <title>Performance issue title</title>
-      <location>file:line or component</location>
-      <details>Description of the bottleneck and its impact</details>
-      <fix>Optimization recommendation with code example</fix>
-    </finding>
-  </findings>
-  <remediation-checklist>
-    <item>Optimization priority 1</item>
-    <item>Optimization priority 2</item>
-  </remediation-checklist>
-</response>"""
-
-REFACTOR_PLAN_RESPONSE = """<response>
-  <summary>Tech debt assessment (1-2 sentences)</summary>
-  <trajectory>increasing|stable|decreasing</trajectory>
-  <findings>
-    <finding severity="high|medium|low">
-      <title>Debt item description</title>
-      <location>file:line</location>
-      <details>Impact and complexity assessment</details>
-      <fix>Refactoring approach</fix>
-    </finding>
-  </findings>
-  <roadmap>
-    <phase priority="1|2|3">
-      <name>Phase name</name>
-      <description>What to accomplish</description>
-      <effort>high|medium|low</effort>
-    </phase>
-  </roadmap>
-  <remediation-checklist>
-    <item>Immediate action 1</item>
-    <item>Immediate action 2</item>
-  </remediation-checklist>
-</response>"""
-
-TEST_GEN_RESPONSE = """<response>
-  <summary>Test generation summary (1-2 sentences)</summary>
-  <coverage-improvement>Estimated coverage improvement</coverage-improvement>
-  <findings>
-    <finding severity="info">
-      <title>Untested area</title>
-      <location>file:function or class</location>
-      <details>Why this needs testing</details>
-      <fix>Test approach recommendation</fix>
-    </finding>
-  </findings>
-  <tests>
-    <test target="function or class name">
-      <type>unit|integration|edge-case</type>
-      <description>What this test verifies</description>
-      <code><![CDATA[
-def test_example():
-    # Test code here
-    pass
-]]></code>
-    </test>
-  </tests>
-  <remediation-checklist>
-    <item>Test to add first</item>
-    <item>Test to add second</item>
-  </remediation-checklist>
-</response>"""
-
-DOC_GEN_RESPONSE = """<response>
-  <summary>Documentation summary (1-2 sentences)</summary>
-  <sections>
-    <section name="Section Title">
-      <content>Section content in markdown</content>
-    </section>
-  </sections>
-  <findings>
-    <finding severity="info">
-      <title>Documentation gap or improvement</title>
-      <details>What needs documentation</details>
-    </finding>
-  </findings>
-  <remediation-checklist>
-    <item>Documentation improvement 1</item>
-    <item>Documentation improvement 2</item>
-  </remediation-checklist>
-</response>"""
-
-RELEASE_PREP_RESPONSE = """<response>
-  <summary>Release readiness assessment (1-2 sentences)</summary>
-  <verdict>approved|blocked|needs-review</verdict>
-  <confidence>high|medium|low</confidence>
-  <findings>
-    <finding severity="blocker|warning|info">
-      <title>Issue title</title>
-      <location>Component or area</location>
-      <details>Description of the issue</details>
-      <fix>Required action before release</fix>
-    </finding>
-  </findings>
-  <checklist>
-    <item status="pass|fail|skip">Check description</item>
-  </checklist>
-  <remediation-checklist>
-    <item>Pre-release action 1</item>
-    <item>Pre-release action 2</item>
-  </remediation-checklist>
-</response>"""
-
-DEPENDENCY_CHECK_RESPONSE = """<response>
-  <summary>Dependency security assessment (1-2 sentences)</summary>
-  <risk-level>critical|high|medium|low</risk-level>
-  <risk-score>0-100</risk-score>
-  <findings>
-    <finding severity="critical|high|medium|low">
-      <title>Vulnerability or issue</title>
-      <location>package@version</location>
-      <details>CVE or issue description</details>
-      <fix>Upgrade or mitigation recommendation</fix>
-    </finding>
-  </findings>
-  <remediation-checklist>
-    <item>Upgrade package X to version Y</item>
-    <item>Review dependency Z</item>
-  </remediation-checklist>
-</response>"""
-
-
-# =============================================================================
-# Built-in Templates
-# =============================================================================
-
-BUILTIN_TEMPLATES: dict[str, XmlPromptTemplate] = {
-    "security-audit": XmlPromptTemplate(
-        name="security-audit",
-        schema_version="1.0",
-        response_format=SECURITY_AUDIT_RESPONSE,
-    ),
-    "code-review": XmlPromptTemplate(
-        name="code-review",
-        schema_version="1.0",
-        response_format=CODE_REVIEW_RESPONSE,
-    ),
-    "research": XmlPromptTemplate(
-        name="research",
-        schema_version="1.0",
-        response_format=RESEARCH_RESPONSE,
-    ),
-    "bug-analysis": XmlPromptTemplate(
-        name="bug-analysis",
-        schema_version="1.0",
-        response_format=BUG_ANALYSIS_RESPONSE,
-    ),
-    "perf-audit": XmlPromptTemplate(
-        name="perf-audit",
-        schema_version="1.0",
-        response_format=PERF_AUDIT_RESPONSE,
-    ),
-    "refactor-plan": XmlPromptTemplate(
-        name="refactor-plan",
-        schema_version="1.0",
-        response_format=REFACTOR_PLAN_RESPONSE,
-    ),
-    "test-gen": XmlPromptTemplate(
-        name="test-gen",
-        schema_version="1.0",
-        response_format=TEST_GEN_RESPONSE,
-    ),
-    "doc-gen": XmlPromptTemplate(
-        name="doc-gen",
-        schema_version="1.0",
-        response_format=DOC_GEN_RESPONSE,
-    ),
-    "release-prep": XmlPromptTemplate(
-        name="release-prep",
-        schema_version="1.0",
-        response_format=RELEASE_PREP_RESPONSE,
-    ),
-    "dependency-check": XmlPromptTemplate(
-        name="dependency-check",
-        schema_version="1.0",
-        response_format=DEPENDENCY_CHECK_RESPONSE,
-    ),
-}
-
-
-def get_template(name: str) -> XmlPromptTemplate | None:
-    """Get a built-in template by name.
-
-    Args:
-        name: Template name (e.g., "security-audit", "code-review").
-
-    Returns:
-        XmlPromptTemplate if found, None otherwise.
-
-    """
-    return BUILTIN_TEMPLATES.get(name)
-
-
-def list_templates() -> list[str]:
-    """List all available built-in template names.
-
-    Returns:
-        List of template names.
-
-    """
-    return list(BUILTIN_TEMPLATES.keys())
-
-
-def register_template(name: str, template: XmlPromptTemplate) -> None:
-    """Register a custom template.
-
-    Args:
-        name: Template name for lookup.
-        template: XmlPromptTemplate instance.
-
-    """
-    BUILTIN_TEMPLATES[name] = template

empathy_os/prompts/templates.py

@@ -1,208 +0,0 @@
-"""Prompt Templates
-
-Provides protocol and implementations for prompt templates,
-including XML-structured prompts.
-
-Copyright 2025 Smart-AI-Memory
-Licensed under Fair Source License 0.9
-"""
-
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from typing import Any, Protocol
-
-from .context import PromptContext
-
-
-class PromptTemplate(Protocol):
-    """Protocol for prompt templates."""
-
-    def render(self, context: PromptContext) -> str:
-        """Render the template with given context.
-
-        Args:
-            context: The prompt context containing role, goal, instructions, etc.
-
-        Returns:
-            The rendered prompt string.
-
-        """
-        ...
-
-
-@dataclass
-class PlainTextPromptTemplate:
-    """Simple plain text prompt template.
-
-    Renders prompts in a straightforward text format without XML structure.
-    """
-
-    name: str
-    include_role: bool = True
-    include_constraints: bool = True
-
-    def render(self, context: PromptContext) -> str:
-        """Render as plain text prompt."""
-        parts = []
-
-        if self.include_role:
-            parts.append(f"You are a {context.role}.")
-            parts.append("")
-
-        parts.append(f"Goal: {context.goal}")
-        parts.append("")
-
-        if context.instructions:
-            parts.append("Instructions:")
-            for i, inst in enumerate(context.instructions, 1):
-                parts.append(f"{i}. {inst}")
-            parts.append("")
-
-        if self.include_constraints and context.constraints:
-            parts.append("Guidelines:")
-            for constraint in context.constraints:
-                parts.append(f"- {constraint}")
-            parts.append("")
-
-        if context.input_payload:
-            parts.append(f"Input ({context.input_type}):")
-            parts.append(context.input_payload)
-
-        return "\n".join(parts)
-
-
-@dataclass
-class XmlPromptTemplate:
-    """XML-structured prompt template.
-
-    Renders prompts in XML format for consistent parsing and
-    structured LLM interactions.
-    """
-
-    name: str
-    schema_version: str = "1.0"
-    response_format: str | None = None
-    extra_tags: dict[str, str] = field(default_factory=dict)
-
-    def render(self, context: PromptContext) -> str:
-        """Render XML prompt from context.
-
-        Args:
-            context: The prompt context.
-
-        Returns:
-            XML-formatted prompt string.
-
-        """
-        # Build instructions XML
-        instructions_xml = self._render_instructions(context.instructions)
-
-        # Build constraints XML
-        constraints_xml = self._render_constraints(context.constraints)
-
-        # Build extra context XML if present
-        extra_xml = self._render_extra(context.extra)
-
-        # Build input section with CDATA for safety
-        input_content = self._escape_cdata(context.input_payload)
-
-        prompt = f"""<request schema="{self.schema_version}">
-  <role>{self._escape_xml(context.role)}</role>
-  <goal>{self._escape_xml(context.goal)}</goal>
-  <instructions>
-{instructions_xml}
-  </instructions>
-  <constraints>
-{constraints_xml}
-  </constraints>{extra_xml}
-  <input type="{context.input_type}">
-    <![CDATA[
-{input_content}
-    ]]>
-  </input>
-</request>"""
-
-        # Add response format instructions if specified
-        if self.response_format:
-            prompt += f"\n\n{self._response_instructions()}"
-
-        return prompt
-
-    def _render_instructions(self, instructions: list[str]) -> str:
-        """Render instructions as XML steps."""
-        if not instructions:
-            return "    <!-- No specific instructions -->"
-        lines = []
-        for i, inst in enumerate(instructions, 1):
-            escaped = self._escape_xml(inst)
-            lines.append(f"    <step>{i}. {escaped}</step>")
-        return "\n".join(lines)
-
-    def _render_constraints(self, constraints: list[str]) -> str:
-        """Render constraints as XML rules."""
-        if not constraints:
-            return "    <!-- No specific constraints -->"
-        lines = []
-        for constraint in constraints:
-            escaped = self._escape_xml(constraint)
-            lines.append(f"    <rule>{escaped}</rule>")
-        return "\n".join(lines)
-
-    def _render_extra(self, extra: dict[str, Any]) -> str:
-        """Render extra context as XML if present."""
-        if not extra:
-            return ""
-
-        lines = ["\n  <context>"]
-        for key, value in extra.items():
-            if value:  # Only include non-empty values
-                escaped_key = self._escape_xml(str(key))
-                escaped_value = self._escape_xml(str(value))
-                lines.append(f"    <{escaped_key}>{escaped_value}</{escaped_key}>")
-        lines.append("  </context>")
-
-        return "\n".join(lines)
-
-    def _response_instructions(self) -> str:
-        """Generate response format instructions."""
-        return f"""Please respond using ONLY this XML format (no other text before or after):
-
-{self.response_format}
-
-Important:
-- Use the exact XML structure shown above
-- Include all required tags even if empty
-- Use severity values: critical, high, medium, low, info
-- Wrap code examples in CDATA sections"""
-
-    def _escape_xml(self, text: str) -> str:
-        """Escape special XML characters."""
-        if not text:
-            return ""
-        return (
-            text.replace("&", "&amp;")
-            .replace("<", "&lt;")
-            .replace(">", "&gt;")
-            .replace('"', "&quot;")
-            .replace("'", "&apos;")
-        )
-
-    def _escape_cdata(self, text: str) -> str:
-        """Escape text for use in CDATA section.
-
-        CDATA sections can contain anything except the closing sequence ]]>
-        """
-        if not text:
-            return ""
-        # Replace ]]> with ]]]]><![CDATA[> to escape it
-        return text.replace("]]>", "]]]]><![CDATA[>")
-
-    def with_response_format(self, response_format: str) -> XmlPromptTemplate:
-        """Return a new template with the specified response format."""
-        return XmlPromptTemplate(
-            name=self.name,
-            schema_version=self.schema_version,
-            response_format=response_format,
-            extra_tags=self.extra_tags.copy(),
-        )