swarmauri_prompt_j2prompttemplate 0.7.1.dev2__py3-none-any.whl → 0.7.2.dev14__py3-none-any.whl

swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py

@@ -1,8 +1,8 @@
-from typing import Dict, List, Union, Optional, Literal
-from pydantic import ConfigDict, FilePath
-from jinja2 import Environment, FileSystemLoader, Template
 import os
+from typing import Any, Callable, Dict, List, Literal, Optional, Union
 
+from jinja2 import Environment, FileSystemLoader, Template
+from pydantic import ConfigDict, FilePath
 from swarmauri_base.ComponentBase import ComponentBase
 from swarmauri_base.prompt_templates.PromptTemplateBase import PromptTemplateBase
 
@@ -15,16 +15,22 @@ class J2PromptTemplate(PromptTemplateBase):
     The `template` attribute supports either a literal string representing the template content
     or a Pydantic FilePath. When a FilePath is provided, the template is loaded using
     `env.get_template()` and stored in `template`.
+
+    Features:
+    - Support for multiple template directories with fallback mechanism
+    - Built-in filters: split_whitespace, make_singular, make_plural
+    - Template caching for performance
     """
 
     # The template attribute may be a literal string (template content),
     # a FilePath (when provided as input), or a compiled Jinja2 Template (when loaded from file).
     template: Union[str, FilePath, Template] = ""
-    variables: Dict[str, Union[str, int, float]] = {}
+    variables: Dict[str, Union[str, int, float, Any]] = {}
     # Optional templates_dir attribute (can be a single path or a list of paths)
     templates_dir: Optional[Union[str, List[str]]] = None
+    # Whether to enable code generation specific features like linguistic filters
 
-    model_config = ConfigDict(arbitrary_types_allowed=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")
     type: Literal["J2PromptTemplate"] = "J2PromptTemplate"
 
     def get_env(self) -> Environment:
@@ -34,7 +40,7 @@ class J2PromptTemplate(PromptTemplateBase):
         If `templates_dir` is provided, a FileSystemLoader is created with that directory (or directories).
         Otherwise, no loader is set.
 
-        The custom 'split' filter is added before returning the environment.
+        The custom filters are added before returning the environment.
         """
         if self.templates_dir:
             if isinstance(self.templates_dir, str):
@@ -44,7 +50,12 @@ class J2PromptTemplate(PromptTemplateBase):
         else:
             loader = None
         env = Environment(loader=loader, autoescape=False)
+
+        # Add basic filters
         env.filters["split"] = self.split_whitespace
+        env.filters["make_singular"] = self.make_singular
+        env.filters["make_plural"] = self.make_plural
+
         return env
 
     def set_template(self, template: Union[str, FilePath]) -> None:
@@ -55,16 +66,10 @@ class J2PromptTemplate(PromptTemplateBase):
         - If it is a FilePath, the template is loaded via an environment using `get_template()`.
         """
         if type(template) is str:
-            self._set_template_from_str(template)
+            self.template = template
         else:
             self._set_template_from_filepath(template)
 
-    def _set_template_from_str(self, template_str: str) -> None:
-        """
-        Sets the template from a literal string.
-        """
-        self.template = template_str
-
     def _set_template_from_filepath(self, template_path: FilePath) -> None:
         """
         Loads the template from a file specified by a FilePath.
@@ -131,9 +136,12 @@ class J2PromptTemplate(PromptTemplateBase):
             loader=FileSystemLoader([directory]), autoescape=False
         )
         fallback_env.filters["split"] = self.split_whitespace
+        fallback_env.filters["make_singular"] = self.make_singular
+        fallback_env.filters["make_plural"] = self.make_plural
+
         self.template = fallback_env.get_template(template_name)
 
-    def generate_prompt(self, variables: Dict[str, str] = None) -> str:
+    def generate_prompt(self, variables: Dict[str, Any] = None) -> str:
         """
         Generates a prompt by rendering the current template with the provided variables.
 
@@ -143,14 +151,17 @@ class J2PromptTemplate(PromptTemplateBase):
         variables = variables if variables else self.variables
         return self.fill(variables)
 
-    def __call__(self, variables: Optional[Dict[str, str]] = None) -> str:
+    def __call__(self, variables: Optional[Dict[str, Any]] = None) -> str:
         """
         Allows the instance to be called directly to generate a prompt.
         """
         variables = variables if variables else self.variables
         return self.fill(variables)
 
-    def fill(self, variables: Dict[str, str] = None) -> str:
+    def fill(self, variables: Dict[str, Any] = None) -> str:
+        """
+        Renders the template with the provided variables.
+        """
         variables = variables or self.variables
         env = self.get_env()
         if isinstance(self.template, Template):
@@ -170,3 +181,49 @@ class J2PromptTemplate(PromptTemplateBase):
             return value.split(delimiter)
         else:
             return value.split()
+
+    @staticmethod
+    def make_singular(word: str):
+        """
+        Converts a plural word to singular form.
+        Requires inflect library to be installed.
+        """
+        try:
+            import inflect
+
+            # Initialize the engine
+            p = inflect.engine()
+            # Return the singular form of the verb
+            return p.singular_noun(word) if p.singular_noun(word) else word
+        except ImportError:
+            # Return the original if inflect is not available
+            return word
+
+    @staticmethod
+    def make_plural(word: str) -> str:
+        """
+        Converts a singular word to its plural form.
+        Requires inflect library to be installed.
+        """
+        try:
+            import inflect
+
+            p = inflect.engine()
+            return p.plural(word) or word
+        except ImportError:
+            return word
+
+    def add_filter(self, name: str, filter_func: Callable) -> None:
+        """
+        Adds a custom filter to the Jinja2 environment.
+
+        Parameters:
+            name: The name of the filter (used in templates)
+            filter_func: The function to be called when the filter is used
+        """
+        env = self.get_env()
+        env.filters[name] = filter_func
+
+
+# Create a singleton instance for peagen usage with code generation mode enabled
+j2pt = J2PromptTemplate()

swarmauri_prompt_j2prompttemplate/__init__.py

@@ -1,7 +1,7 @@
-from .J2PromptTemplate import J2PromptTemplate
+from .J2PromptTemplate import J2PromptTemplate, j2pt
 
 
-__all__ = ["J2PromptTemplate"]
+__all__ = ["J2PromptTemplate", "j2pt"]
 
 try:
     # For Python 3.8 and newer

{swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info → swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: swarmauri_prompt_j2prompttemplate
-Version: 0.7.1.dev2
+Version: 0.7.2.dev14
 Summary: Jinja2 Prompt Template for Swarmauri.
 License: Apache-2.0
 Author: Jacob Stewart
@@ -10,7 +10,8 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: jinja2 (>=3.0)
+Requires-Dist: inflect (>=7.0.0)
+Requires-Dist: jinja2 (>=3.1.6)
 Requires-Dist: pydantic (>=1.8.2)
 Requires-Dist: swarmauri_base
 Requires-Dist: swarmauri_core
@@ -21,8 +22,8 @@ Description-Content-Type: text/markdown
 <p align="center">
     <a href="https://pypi.org/project/swarmauri_tool_j2prompttemplate/">
         <img src="https://img.shields.io/pypi/dm/swarmauri_tool_j2prompttemplate" alt="PyPI - Downloads"/></a>
-    <a href="https://github.com/swarmauri/swarmauri-sdk/blob/master/pkgs/standards/swarmauri_tool_j2prompttemplate/README.md">
-        <img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/standards/swarmauri_tool_j2prompttemplate/README.md&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" alt="GitHub Hits"/></a>
+    <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_prompt_j2prompttemplate/">
+        <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_prompt_j2prompttemplate.svg"/></a>
     <a href="https://pypi.org/project/swarmauri_tool_j2prompttemplate/">
         <img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_j2prompttemplate" alt="PyPI - Python Version"/></a>
     <a href="https://pypi.org/project/swarmauri_tool_j2prompttemplate/">

swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info/RECORD

@@ -0,0 +1,6 @@
+swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py,sha256=d2BFrMxgM98ZGbQtgbrKLZx59ND5CqI2s564GHVz7rg,9082
+swarmauri_prompt_j2prompttemplate/__init__.py,sha256=UOpZnWj00_QRvvIZy9TfXjuQ2hrDDhbeIu-xvzj_ixY,527
+swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
+swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info/METADATA,sha256=bDus8pqpZG9sOmTmfAD0Metw1oaM59jE1kcP8mSIY9Q,3090
+swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info/RECORD,,

{swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info → swarmauri_prompt_j2prompttemplate-0.7.2.dev14.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info/RECORD

@@ -1,6 +0,0 @@
-swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py,sha256=OHwFoW6FWMngHDczlV8pJyD8fx_xtK0jCvemTyhoYOc,7246
-swarmauri_prompt_j2prompttemplate/__init__.py,sha256=x84YMbfnymTWk9wsDs1Qrk4fx5ceZx3AaCrZO4jIHXw,513
-swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
-swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info/METADATA,sha256=SBMSXNazgBsCgKDSxgE_tVOP3Nvj1U50_qlXMLKFSfw,3193
-swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-swarmauri_prompt_j2prompttemplate-0.7.1.dev2.dist-info/RECORD,,