litestar-vite 0.13.2__py3-none-any.whl → 0.14.0__py3-none-any.whl

litestar_vite/commands.py

@@ -4,18 +4,22 @@ from collections.abc import MutableMapping
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional, Union
 
+from litestar_vite.config import JINJA_INSTALLED
+from litestar_vite.exceptions import MissingDependencyError
+
 if TYPE_CHECKING:
     from collections.abc import MutableMapping
 
     from jinja2 import Environment, Template
     from litestar import Litestar
 
+
 VITE_INIT_TEMPLATES: "set[str]" = {"package.json.j2", "tsconfig.json.j2", "vite.config.ts.j2"}
 DEFAULT_RESOURCES: "set[str]" = {"styles.css.j2", "main.ts.j2"}
 DEFAULT_DEV_DEPENDENCIES: "dict[str, str]" = {
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
-    "litestar-vite-plugin": "^0.13.2",
+    "litestar-vite-plugin": "^0.14.0",
     "@types/node": "^22.15.3",
 }
 DEFAULT_DEPENDENCIES: "dict[str, str]" = {"axios": "^1.9.0"}
@@ -60,11 +64,17 @@ def init_vite(
         vite_port: Port for Vite dev server.
         hot_file: Path to hot reload manifest.
         litestar_port: Port for Litestar server.
+
+    Raises:
+        MissingDependencyError: If required dependencies are not installed.
     """
-    from jinja2 import Environment, FileSystemLoader, select_autoescape
     from litestar.cli._utils import console  # pyright: ignore[reportPrivateImportUsage]
     from litestar.utils import module_loader
 
+    if not JINJA_INSTALLED:
+        raise MissingDependencyError(package="jinja2", install_package="jinja")
+    from jinja2 import Environment, FileSystemLoader, select_autoescape
+
     template_path = module_loader.module_to_os_path("litestar_vite.templates")
     vite_template_env = Environment(
         loader=FileSystemLoader([template_path]),
@@ -128,6 +138,23 @@ def get_template(
     parent: "Optional[str]" = None,
     globals: "Optional[MutableMapping[str, Any]]" = None,  # noqa: A002
 ) -> "Template":
+    """Get a template from the Jinja environment.
+
+    Args:
+        environment: The Jinja :class:`jinja2.Environment`.
+        name: Template name or :class:`jinja2.Template` object.
+        parent: Parent template name.
+        globals: Global variables for the template.
+
+    Returns:
+        The :class:`jinja2.Template` object.
+
+    Raises:
+        MissingDependencyError: If Jinja2 is not available.
+    """
+    if not JINJA_INSTALLED:
+        raise MissingDependencyError(package="jinja2", install_package="jinja")
+
     return environment.get_template(name=name, parent=parent, globals=globals)
 
 

litestar_vite/config.py

@@ -1,10 +1,13 @@
 import os
 from dataclasses import dataclass, field
+from importlib.util import find_spec
 from pathlib import Path
 from typing import Union
 
-__all__ = ("ViteConfig",)
+__all__ = ("JINJA_INSTALLED", "ViteConfig")
+
 TRUE_VALUES = {"True", "true", "1", "yes", "Y", "T"}
+JINJA_INSTALLED = bool(find_spec("jinja2"))
 
 
 @dataclass

litestar_vite/exceptions.py

@@ -0,0 +1,26 @@
+"""Litestar-Vite exception classes."""
+
+from __future__ import annotations
+
+__all__ = ["LitestarViteError", "MissingDependencyError"]
+
+
+class LitestarViteError(Exception):
+    """Base exception for Litestar-Vite related errors."""
+
+
+class MissingDependencyError(LitestarViteError, ImportError):
+    """Raised when a package is not installed but required."""
+
+    def __init__(self, package: str, install_package: str | None = None) -> None:
+        """Initialize the exception.
+
+        Args:
+            package: The name of the missing package.
+            install_package: Optional alternative package name for installation.
+        """
+        super().__init__(
+            f"Package {package!r} is not installed but required. You can install it by running "
+            f"'pip install litestar-vite[{install_package or package}]' to install litestar-vite with the required extra "
+            f"or 'pip install {install_package or package}' to install the package separately"
+        )

litestar_vite/plugin.py

@@ -9,10 +9,11 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional, Union
 
 from litestar.cli._utils import console  # pyright: ignore[reportPrivateImportUsage]
-from litestar.contrib.jinja import JinjaTemplateEngine
 from litestar.plugins import CLIPlugin, InitPluginProtocol
 from litestar.static_files import create_static_files_router  # pyright: ignore[reportUnknownVariableType]
 
+from litestar_vite.config import JINJA_INSTALLED
+
 if TYPE_CHECKING:
     from collections.abc import Iterator, Sequence
 
@@ -163,15 +164,21 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
         """
         from litestar_vite.loader import render_asset_tag, render_hmr_client
 
-        if app_config.template_config and isinstance(app_config.template_config.engine_instance, JinjaTemplateEngine):  # pyright: ignore[reportUnknownMemberType]
-            app_config.template_config.engine_instance.register_template_callable(  # pyright: ignore[reportUnknownMemberType]
-                key="vite_hmr",
-                template_callable=render_hmr_client,
-            )
-            app_config.template_config.engine_instance.register_template_callable(  # pyright: ignore[reportUnknownMemberType]
-                key="vite",
-                template_callable=render_asset_tag,
-            )
+        if JINJA_INSTALLED:
+            from litestar.contrib.jinja import JinjaTemplateEngine
+
+            if (
+                app_config.template_config  # pyright: ignore[reportUnknownMemberType]
+                and isinstance(app_config.template_config.engine_instance, JinjaTemplateEngine)  # pyright: ignore[reportUnknownMemberType]
+            ):
+                app_config.template_config.engine_instance.register_template_callable(  # pyright: ignore[reportUnknownMemberType]
+                    key="vite_hmr",
+                    template_callable=render_hmr_client,
+                )
+                app_config.template_config.engine_instance.register_template_callable(  # pyright: ignore[reportUnknownMemberType]
+                    key="vite",
+                    template_callable=render_asset_tag,
+                )
         if self._config.set_static_folders:
             static_dirs = [Path(self._config.bundle_dir), Path(self._config.resource_dir)]
             if Path(self._config.public_dir).exists() and self._config.public_dir != self._config.bundle_dir:

{litestar_vite-0.13.2.dist-info → litestar_vite-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litestar-vite
-Version: 0.13.2
+Version: 0.14.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -29,7 +29,9 @@ Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
-Requires-Dist: litestar[jinja]>=2.7.0
+Requires-Dist: litestar>=2.7.0
+Provides-Extra: jinja
+Requires-Dist: jinja2; extra == 'jinja'
 Provides-Extra: nodeenv
 Requires-Dist: nodeenv; extra == 'nodeenv'
 Description-Content-Type: text/markdown
@@ -73,7 +75,7 @@ app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[
 
 ```
 
-Create a template to serve the application in `./templates/index.html.h2`:
+Create a template to serve the application in `./templates/index.html.j2`:
 
 ```html
 <!DOCTYPE html>

{litestar_vite-0.13.2.dist-info → litestar_vite-0.14.0.dist-info}/RECORD

@@ -1,10 +1,11 @@
 litestar_vite/__init__.py,sha256=QykOZjCNHyDZJNIF84fa-6ze-lajDAGcoi18LxeV-0E,241
 litestar_vite/__metadata__.py,sha256=dMGIPS6M11LcmiEfnMJJrbSPH8Lf00pU8crIIUsIBPw,478
 litestar_vite/cli.py,sha256=W3bpXZSt_ne0pdDZQCGi_naMEakp7MA-oD_r1BJI0cQ,11058
-litestar_vite/commands.py,sha256=XrQ6vIbcJYEANrO1nJwawb3DYOXt-1GGVYfJYWsYc6c,5385
-litestar_vite/config.py,sha256=K3C3uhfcllINGAkOUS4tTah-mhhx74GYwNF4ME92eOA,4592
+litestar_vite/commands.py,sha256=aHubdOrSim0RFtJX5zg9UkfXyQN53Q_PB058quGlUfw,6218
+litestar_vite/config.py,sha256=gWnXhWw4XggC82bWQEa2BtqxzR_AdhqZeRuLYvYy3N4,4692
+litestar_vite/exceptions.py,sha256=E37ficSm9V8iMYTPThtLX0Dm0gsK80rV8a0IT8I0MGo,991
 litestar_vite/loader.py,sha256=opF-YJh0fnu1cpH2uJ4aLmK9PZpsREa4yEEajYV9yVs,11802
-litestar_vite/plugin.py,sha256=uyGlJZBl46DpKoHmxkdkNUvZ2SyYI0Q3MXcDwYytweo,9132
+litestar_vite/plugin.py,sha256=4b3I9yc73YAZcnnT_1jvCzN_5s-jFlzS0tHBZwLHyHg,9351
 litestar_vite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 litestar_vite/inertia/__init__.py,sha256=KGvxCZhnOw06Pqx5_qjUxj0WWsCR3BR0cVnuNMT7sKQ,1136
 litestar_vite/inertia/_utils.py,sha256=HZOedWduCu3fCMniuFvstEcXzP2FA1IBwPZ3E2XNBEo,2529
@@ -24,7 +25,7 @@ litestar_vite/templates/package.json.j2,sha256=0JWgdTuaSZ25EmCltF_zbqDdpxfvCLeYu
 litestar_vite/templates/styles.css.j2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 litestar_vite/templates/tsconfig.json.j2,sha256=q1REIuVyXUHCy4Zi2kgTkmrhdT98vyY89k-WTrImOj8,843
 litestar_vite/templates/vite.config.ts.j2,sha256=bF5kOPFafYMkhhV0VkIwetN-_zoVMGVM1jEMX_wKoNc,1037
-litestar_vite-0.13.2.dist-info/METADATA,sha256=jeyo7erxAdorX651z6CrIaFTF5xwRiCwvVM8Gx5HgjU,6245
-litestar_vite-0.13.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-litestar_vite-0.13.2.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
-litestar_vite-0.13.2.dist-info/RECORD,,
+litestar_vite-0.14.0.dist-info/METADATA,sha256=nuE0TkAISpQ4HgWkAR44A--wBbRsNwSO9-7l_DjkxgA,6300
+litestar_vite-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+litestar_vite-0.14.0.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.14.0.dist-info/RECORD,,