diff --git a/python/pyproject.toml b/python/pyproject.toml index 09e65d71a0a3..6dfc11d6e1b8 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -48,7 +48,6 @@ dependencies = [ "opentelemetry-sdk ~= 1.24", "prance >= 23.6.21,< 26.7.20", # templating - "pybars4 ~= 0.9", "jinja2 ~= 3.1", "nest-asyncio2 >= 1.7.4,< 2", "scipy>=1.15.1", @@ -91,6 +90,9 @@ google = [ "google-cloud-aiplatform>=1.114,<1.134", "google-genai >= 1.51,< 2.30" ] +handlebars = [ + "pybars4 ~= 0.9" +] hugging_face = [ "transformers[torch] >= 5.5.0,< 6.0", "sentence-transformers >= 2.2,< 6.0", diff --git a/python/semantic_kernel/prompt_template/handlebars_prompt_template.py b/python/semantic_kernel/prompt_template/handlebars_prompt_template.py index 30d840bb8cc7..5a499f1212d0 100644 --- a/python/semantic_kernel/prompt_template/handlebars_prompt_template.py +++ b/python/semantic_kernel/prompt_template/handlebars_prompt_template.py @@ -4,9 +4,17 @@ from collections.abc import Callable from typing import TYPE_CHECKING, Any -from pybars import Compiler, PybarsError from pydantic import PrivateAttr, field_validator +try: + from pybars import Compiler, PybarsError +except ImportError: + Compiler = None + + class PybarsError(Exception): # type: ignore + """Placeholder for PybarsError when pybars4 is not installed.""" + + from semantic_kernel.exceptions import HandlebarsTemplateRenderException, HandlebarsTemplateSyntaxError from semantic_kernel.functions.kernel_arguments import KernelArguments from semantic_kernel.prompt_template.const import HANDLEBARS_TEMPLATE_FORMAT_NAME @@ -52,6 +60,11 @@ def validate_template_format(cls, v: "PromptTemplateConfig") -> "PromptTemplateC def model_post_init(self, __context: Any) -> None: """Post init model.""" + if Compiler is None: + raise ImportError( + "pybars4 is not installed. Please install it with `pip install semantic-kernel[handlebars]` " + "to use Handlebars prompt templates." + ) if not self.prompt_template_config.template: self._template_compiler = None return @@ -77,6 +90,11 @@ async def render(self, kernel: "Kernel", arguments: "KernelArguments | None" = N Returns: The prompt template ready to be used for an AI request """ + if Compiler is None: + raise ImportError( + "pybars4 is not installed. Please install it with `pip install semantic-kernel[handlebars]` " + "to use Handlebars prompt templates." + ) if not self._template_compiler: return "" if arguments is None: diff --git a/python/tests/unit/prompt_template/test_handlebars_prompt_template.py b/python/tests/unit/prompt_template/test_handlebars_prompt_template.py index fb255676fc35..93baeaebd224 100644 --- a/python/tests/unit/prompt_template/test_handlebars_prompt_template.py +++ b/python/tests/unit/prompt_template/test_handlebars_prompt_template.py @@ -47,6 +47,31 @@ def test_init_fail(): ) +def test_init_without_pybars(monkeypatch): + import semantic_kernel.prompt_template.handlebars_prompt_template as hpt + + monkeypatch.setattr(hpt, "Compiler", None) + with pytest.raises(ImportError, match="pybars4 is not installed"): + HandlebarsPromptTemplate( + prompt_template_config=PromptTemplateConfig( + name="test", description="test", template="{{input}}", template_format="handlebars" + ) + ) + + +async def test_render_without_pybars(monkeypatch, kernel: Kernel): + import semantic_kernel.prompt_template.handlebars_prompt_template as hpt + + template = HandlebarsPromptTemplate( + prompt_template_config=PromptTemplateConfig( + name="test", description="test", template="{{input}}", template_format="handlebars" + ) + ) + monkeypatch.setattr(hpt, "Compiler", None) + with pytest.raises(ImportError, match="pybars4 is not installed"): + await template.render(kernel, KernelArguments(input="world")) + + def test_init_template_validation_fail(): with pytest.raises(ValueError): HandlebarsPromptTemplate( diff --git a/python/uv.lock b/python/uv.lock index a6ba45985be9..1b6d02ffabc0 100644 --- a/python/uv.lock +++ b/python/uv.lock @@ -5865,7 +5865,6 @@ dependencies = [ { name = "opentelemetry-api", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, { name = "opentelemetry-sdk", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, { name = "prance", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, - { name = "pybars4", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, { name = "pydantic", version = "2.11.10", source = { registry = "https://packagefeedproxy.microsoft.io/pypi/simple/" }, marker = "(python_full_version < '3.14' and sys_platform == 'darwin') or (python_full_version < '3.14' and sys_platform == 'linux') or (python_full_version < '3.14' and sys_platform == 'win32')" }, { name = "pydantic", version = "2.13.4", source = { registry = "https://packagefeedproxy.microsoft.io/pypi/simple/" }, marker = "(python_full_version >= '3.14' and sys_platform == 'darwin') or (python_full_version >= '3.14' and sys_platform == 'linux') or (python_full_version >= '3.14' and sys_platform == 'win32')" }, { name = "pydantic-settings", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, @@ -5904,6 +5903,9 @@ google = [ { name = "google-cloud-aiplatform", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, { name = "google-genai", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, ] +handlebars = [ + { name = "pybars4", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, +] hugging-face = [ { name = "sentence-transformers", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, { name = "torch", marker = "sys_platform == 'darwin' or sys_platform == 'linux' or sys_platform == 'win32'" }, @@ -6031,7 +6033,7 @@ requires-dist = [ { name = "prance", specifier = ">=23.6.21,<26.7.20" }, { name = "psycopg", extras = ["binary", "pool"], marker = "extra == 'postgres'", specifier = "~=3.2" }, { name = "pyarrow", marker = "extra == 'usearch'", specifier = ">=12.0,<26.0" }, - { name = "pybars4", specifier = "~=0.9" }, + { name = "pybars4", marker = "extra == 'handlebars'", specifier = "~=0.9" }, { name = "pydantic", specifier = ">=2.0,!=2.10.0,!=2.10.1,!=2.10.2,!=2.10.3,<2.14" }, { name = "pydantic-settings", specifier = "~=2.0" }, { name = "pymilvus", marker = "extra == 'milvus'", specifier = ">=2.3,<2.7" },