Class swarmauri_prompt_j2prompttemplate.J2PromptTemplate.J2PromptTemplate
    
              Bases: PromptTemplateBase
A subclass of PromptTemplateBase that uses Jinja2 for template rendering.
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
class-attribute
      instance-attribute
  
template = ''
class-attribute
      instance-attribute
  
variables = {}
class-attribute
      instance-attribute
  
templates_dir = None
class-attribute
      instance-attribute
  
model_config = ConfigDict(
    arbitrary_types_allowed=True, extra="allow"
)
class-attribute
      instance-attribute
  
type = 'J2PromptTemplate'
class-attribute
      instance-attribute
  
id = Field(default_factory=generate_id)
class-attribute
      instance-attribute
  
members = None
class-attribute
      instance-attribute
  
owners = None
class-attribute
      instance-attribute
  
host = None
class-attribute
  
default_logger = None
class-attribute
      instance-attribute
  
logger = None
class-attribute
      instance-attribute
  
name = None
class-attribute
      instance-attribute
  
version = '0.1.0'
get_env()
Constructs and returns a Jinja2 Environment.
If templates_dir is provided, a FileSystemLoader is created with that directory (or directories).
Otherwise, no loader is set.
The custom filters are added before returning the environment.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |  | 
set_template(template)
Sets or updates the template.
- If the provided templateis a literal string, it is stored as-is.
- If it is a FilePath, the template is loaded via an environment using get_template().
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 61 62 63 64 65 66 67 68 69 70 71 |  | 
generate_prompt(variables=None)
Generates a prompt by rendering the current template with the provided variables.
- If templateis a literal string, it is compiled on the fly.
- If it is already a compiled Template (loaded via FilePath), it is rendered directly.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 144 145 146 147 148 149 150 151 152 |  | 
fill(variables=None)
Renders the template with the provided variables.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 161 162 163 164 165 166 167 168 169 170 171 |  | 
staticmethod
  
split_whitespace(value, delimiter=None)
Splits a string into a list based on whitespace.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 173 174 175 176 177 178 179 180 181 182 183 |  | 
staticmethod
  
make_singular(word)
Converts a plural word to singular form. Requires inflect library to be installed.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |  | 
staticmethod
  
make_plural(word)
Converts a singular word to its plural form. Requires inflect library to be installed.
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 202 203 204 205 206 207 208 209 210 211 212 213 214 |  | 
add_filter(name, filter_func)
Adds a custom filter to the Jinja2 environment.
| PARAMETER | DESCRIPTION | 
|---|---|
| name | The name of the filter (used in templates) 
                  
                    TYPE:
                       | 
| filter_func | The function to be called when the filter is used 
                  
                    TYPE:
                       | 
Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py
              | 216 217 218 219 220 221 222 223 224 225 |  | 
classmethod
  
register_model()
Decorator to register a base model in the unified registry.
| RETURNS | DESCRIPTION | 
|---|---|
| Callable | A decorator function that registers the model class. 
                  
                    TYPE:
                       | 
Source code in swarmauri_base/DynamicBase.py
              | 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |  | 
classmethod
  
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
| PARAMETER | DESCRIPTION | 
|---|---|
| resource_type | The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. 
                  
                    TYPE:
                       | 
| type_name | An optional custom type name for the subtype. 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| Callable | A decorator function that registers the subtype. 
                  
                    TYPE:
                       | 
Source code in swarmauri_base/DynamicBase.py
              | 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |  | 
classmethod
  
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
              | 12 13 14 15 16 17 18 19 20 21 22 23 24 |  | 
model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
              | 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |  | 
classmethod
  
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
              | 11 12 13 14 15 16 17 18 19 20 21 22 23 |  | 
model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
              | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |  | 
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
              | 23 24 25 26 27 28 |  | 
set_variables(variables)
Sets or updates the variables to be substituted into the template.
Source code in swarmauri_base/prompt_templates/PromptTemplateBase.py
              | 28 29 30 31 32 |  |