dycw-utilities 0.166.34__tar.gz → 0.166.35__tar.gz

{dycw_utilities-0.166.34 → dycw_utilities-0.166.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.166.34
+Version: 0.166.35
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.166.34 → dycw_utilities-0.166.35}/pyproject.toml

@@ -249,7 +249,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.34"
+version = "0.166.35"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -282,7 +282,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.34"
+current_version = "0.166.35"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.166.35/src/tests/test_jinja2.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from jinja2 import DictLoader
+
+from utilities.jinja2 import EnhancedEnvironment, TemplateJob
+from utilities.text import strip_and_dedent
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class TestEnhancedTemplate:
+    def test_main(self) -> None:
+        env = EnhancedEnvironment(
+            loader=DictLoader({
+                "test.j2": strip_and_dedent("""
+                    text   = '{{ text }}'
+                    pascal = '{{ text | pascal }}'
+                    snake  = '{{ text | snake }}'
+                """)
+            })
+        )
+        result = env.get_template("test.j2").render(text="multi-word string")
+        expected = strip_and_dedent("""
+            text   = 'multi-word string'
+            pascal = 'MultiWordString'
+            snake  = 'multi_word_string'
+        """)
+        assert result == expected
+
+
+class TestTemplateJob:
+    def test_main(self, *, tmp_path: Path) -> None:
+        path_template = tmp_path.joinpath("template.j2")
+        _ = path_template.write_text(
+            strip_and_dedent("""
+                text = '{{ text }}'
+            """)
+        )
+        path_target = tmp_path.joinpath("target.txt")
+        job = TemplateJob(
+            template=path_template, kwargs={"text": "example text"}, target=path_target
+        )
+        expected = strip_and_dedent("""
+            text = 'example text'
+        """)
+        assert job.rendered == expected
+        assert not path_target.exists()
+        job.run()
+        assert path_target.exists()
+        assert path_target.read_text() == expected
+
+    def test_append(self, *, tmp_path: Path) -> None:
+        path_template = tmp_path.joinpath("template.j2")
+        _ = path_template.write_text(
+            strip_and_dedent(
+                """
+                new = '{{ text }}'
+                """,
+                trailing=True,
+            )
+        )
+        path_target = tmp_path.joinpath("target.txt")
+        _ = path_target.write_text(
+            strip_and_dedent(
+                """
+                old = 'old text'
+                """,
+                trailing=True,
+            )
+        )
+        job = TemplateJob(
+            template=path_template,
+            kwargs={"text": "new text"},
+            target=path_target,
+            mode="append",
+        )
+        job.run()
+        assert path_target.exists()
+        assert path_target.read_text() == strip_and_dedent("""
+            old = 'old text'
+            new = 'new text'
+        """)

{dycw_utilities-0.166.34 → dycw_utilities-0.166.35}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.34"
+__version__ = "0.166.35"

{dycw_utilities-0.166.34 → dycw_utilities-0.166.35}/src/utilities/jinja2.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Literal, override
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any, Literal, assert_never, override
 
-from jinja2 import BaseLoader, BytecodeCache, Environment, Undefined
+from jinja2 import BaseLoader, BytecodeCache, Environment, FileSystemLoader, Undefined
 from jinja2.defaults import (
     BLOCK_END_STRING,
     BLOCK_START_STRING,
@@ -18,13 +19,17 @@ from jinja2.defaults import (
     VARIABLE_START_STRING,
 )
 
+from utilities.atomicwrites import writer
 from utilities.text import pascal_case, snake_case
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Sequence
+    from pathlib import Path
 
     from jinja2.ext import Extension
 
+    from utilities.types import StrMapping
+
 
 class EnhancedEnvironment(Environment):
     """Environment with enhanced features."""
@@ -83,4 +88,32 @@ class EnhancedEnvironment(Environment):
         self.filters["pascal"] = pascal_case
 
 
-__all__ = ["EnhancedEnvironment"]
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class TemplateJob:
+    """A template with an associated rendering job."""
+
+    template: Path
+    kwargs: StrMapping
+    target: Path
+    mode: Literal["write", "append"] = "write"
+
+    def run(self) -> None:
+        """Run the job."""
+        match self.mode:
+            case "write":
+                with writer(self.target, overwrite=True) as temp:
+                    _ = temp.write_text(self.rendered)
+            case "append":
+                with self.target.open(mode="a") as fh:
+                    _ = fh.write(self.rendered)
+            case never:
+                assert_never(never)
+
+    @property
+    def rendered(self) -> str:
+        """The template, rendered."""
+        env = EnhancedEnvironment(loader=FileSystemLoader(self.template.parent))
+        return env.get_template(self.template.name).render(self.kwargs)
+
+
+__all__ = ["EnhancedEnvironment", "TemplateJob"]

dycw_utilities-0.166.34/src/tests/test_jinja2.py

@@ -1,26 +0,0 @@
-from __future__ import annotations
-
-from jinja2 import DictLoader
-
-from utilities.jinja2 import EnhancedEnvironment
-from utilities.text import strip_and_dedent
-
-
-class TestEnhancedTemplate:
-    def test_main(self) -> None:
-        env = EnhancedEnvironment(
-            loader=DictLoader({
-                "test.j2": strip_and_dedent("""
-                    text   = '{{ text }}'
-                    pascal = '{{ text | pascal }}'
-                    snake  = '{{ text | snake }}'
-                """)
-            })
-        )
-        result = env.get_template("test.j2").render(text="multi-word string")
-        expected = strip_and_dedent("""
-            text   = 'multi-word string'
-            pascal = 'MultiWordString'
-            snake  = 'multi_word_string'
-        """)
-        assert result == expected