Class swarmauri_prompt_j2prompttemplate.J2PromptTemplate.J2PromptTemplate

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

template class-attribute instance-attribute

template = ''

variables class-attribute instance-attribute

variables = {}

templates_dir class-attribute instance-attribute

templates_dir = None

model_config class-attribute instance-attribute

model_config = ConfigDict(
    arbitrary_types_allowed=True, extra="allow"
)

type class-attribute instance-attribute

type = 'J2PromptTemplate'

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

name class-attribute instance-attribute

name = None

resource class-attribute instance-attribute

resource = Field(default=PROMPT.value, frozen=True)

version class-attribute instance-attribute

version = '0.1.0'

get_env

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

def get_env(self) -> Environment:
    """
    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.
    """
    if self.templates_dir:
        if isinstance(self.templates_dir, str):
            loader = FileSystemLoader([self.templates_dir])
        else:
            loader = FileSystemLoader(self.templates_dir)
    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

set_template

set_template(template)

Sets or updates the template.

• If the provided template is 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

def set_template(self, template: Union[str, FilePath]) -> None:
    """
    Sets or updates the template.

    - If the provided `template` is a literal string, it is stored as-is.
    - If it is a FilePath, the template is loaded via an environment using `get_template()`.
    """
    if type(template) is str:
        self.template = template
    else:
        self._set_template_from_filepath(template)

generate_prompt

generate_prompt(variables=None)

Generates a prompt by rendering the current template with the provided variables.

• If template is 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

def generate_prompt(self, variables: Dict[str, Any] = None) -> str:
    """
    Generates a prompt by rendering the current template with the provided variables.

    - If `template` is a literal string, it is compiled on the fly.
    - If it is already a compiled Template (loaded via FilePath), it is rendered directly.
    """
    variables = variables if variables else self.variables
    return self.fill(variables)

fill

fill(variables=None)

Renders the template with the provided variables.

Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py

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):
        tmpl = self.template
    else:
        tmpl = env.from_string(self.template)
    return tmpl.render(**variables)

split_whitespace staticmethod

split_whitespace(value, delimiter=None)

Splits a string into a list based on whitespace.

Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py

@staticmethod
def split_whitespace(value, delimiter: str = None):
    """
    Splits a string into a list based on whitespace.
    """
    if not isinstance(value, str):
        raise ValueError("Expected a string")
    if delimiter:
        return value.split(delimiter)
    else:
        return value.split()

make_singular 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

@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

make_plural 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

@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

add_filter

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: str
filter_func	The function to be called when the filter is used TYPE: Callable

Source code in swarmauri_prompt_j2prompttemplate/J2PromptTemplate.py

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

register_model 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: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type 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: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

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

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

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

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger

set_variables

set_variables(variables)

Sets or updates the variables to be substituted into the template.

Source code in swarmauri_base/prompt_templates/PromptTemplateBase.py

def set_variables(self, variables: Dict[str, str]) -> None:
    """
    Sets or updates the variables to be substituted into the template.
    """
    self.variables = variables