dycw-utilities 0.125.16__tar.gz → 0.125.17__tar.gz

{dycw_utilities-0.125.16 → dycw_utilities-0.125.17}/PKG-INFO

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

{dycw_utilities-0.125.16 → dycw_utilities-0.125.17}/pyproject.toml

@@ -93,7 +93,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.125.16"
+version = "0.125.17"
 
 [project.optional-dependencies]
 test = [
@@ -334,7 +334,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.125.16"
+current_version = "0.125.17"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.125.17/src/tests/test_string.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, ClassVar
+
+from hypothesis import given
+
+from utilities.hypothesis import temp_paths, text_ascii
+from utilities.os import temp_environ
+from utilities.string import substitute_environ
+from utilities.text import strip_and_dedent
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class TestSubstituteEnviron:
+    template: ClassVar[str] = strip_and_dedent("""
+        This is a template string with:
+         - key = '$TEMPLATE_KEY'
+         - value = '$TEMPLATE_VALUE'
+    """)
+
+    @given(root=temp_paths(), key=text_ascii(), value=text_ascii())
+    def test_file(self, *, root: Path, key: str, value: str) -> None:
+        path = root.joinpath("file.text")
+        with path.open(mode="w") as fh:
+            _ = fh.write(self.template)
+        self._run_test(path, key, value)
+
+    @given(key=text_ascii(), value=text_ascii())
+    def test_text_environ(self, *, key: str, value: str) -> None:
+        self._run_test(self.template, key, value)
+
+    @given(key=text_ascii(), value=text_ascii())
+    def test_text_kwargs(self, *, key: str, value: str) -> None:
+        result = substitute_environ(
+            self.template, TEMPLATE_KEY=key, TEMPLATE_VALUE=value
+        )
+        self._assert_equal(result, key, value)
+
+    def _run_test(self, path_or_text: Path | str, key: str, value: str) -> None:
+        with temp_environ(TEMPLATE_KEY=key, TEMPLATE_VALUE=value):
+            result = substitute_environ(path_or_text)
+        self._assert_equal(result, key, value)
+
+    def _assert_equal(self, text: str, key: str, value: str) -> None:
+        expected = strip_and_dedent(f"""
+            This is a template string with:
+             - key = {key!r}
+             - value = {value!r}
+        """)
+        assert text == expected

{dycw_utilities-0.125.16 → dycw_utilities-0.125.17}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.125.16"
+__version__ = "0.125.17"

dycw_utilities-0.125.17/src/utilities/string.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from os import environ
+from pathlib import Path
+from string import Template
+from typing import Any, assert_never
+
+
+def substitute_environ(path_or_text: Path | str, /, **kwargs: Any) -> str:
+    """Substitute the environment variables in a file."""
+    match path_or_text:
+        case Path() as path:
+            with path.open() as fh:
+                return substitute_environ(fh.read(), **kwargs)
+        case str() as text:
+            return Template(text).substitute(environ, **kwargs)
+        case _ as never:
+            assert_never(never)
+
+
+__all__ = ["substitute_environ"]