dycw-utilities 0.166.36__tar.gz → 0.167.0__tar.gz

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.166.36
+Version: 0.167.0
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -12,7 +12,7 @@ Provides-Extra: logging
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
 Provides-Extra: test
 Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
-Requires-Dist: hypothesis<6.140,>=6.139.1; extra == 'test'
+Requires-Dist: hypothesis<6.140,>=6.139.2; extra == 'test'
 Requires-Dist: pytest-asyncio<1.3,>=1.2.0; extra == 'test'
 Requires-Dist: pytest-cov<7.1,>=7.0.0; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/pyproject.toml

@@ -71,7 +71,7 @@ http-test = [
   "orjson",
 ]
 hypothesis = [
-  "hypothesis >=6.139.1, <6.140",
+  "hypothesis >=6.139.2, <6.140",
 ]
 hypothesis-test = [
   "libcst",
@@ -249,7 +249,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.36"
+version = "0.167.0"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -261,7 +261,7 @@ logging = [
 ]
 test = [
   "dycw-pytest-only >=2.1.1, <2.2",
-  "hypothesis >=6.139.1, <6.140",
+  "hypothesis >=6.139.2, <6.140",
   "pytest >=8.4.2, <8.5",
   "pytest-asyncio >=1.2.0, <1.3",
   "pytest-cov >=7.0.0, <7.1",
@@ -282,7 +282,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.36"
+current_version = "0.167.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.167.0/src/tests/test_docker.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from utilities.docker import docker_exec
+
+
+class TestDockerExec:
+    def test_main(self) -> None:
+        result = docker_exec("container", "pg_dump")
+        expected = ["docker", "exec", "--interactive", "container", "pg_dump"]
+        assert result == expected
+
+    def test_env(self) -> None:
+        result = docker_exec("container", "pg_dump", KEY="value")
+        expected = [
+            "docker",
+            "exec",
+            "--env=KEY=value",
+            "--interactive",
+            "container",
+            "pg_dump",
+        ]
+        assert result == expected

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/src/tests/test_jinja2.py

@@ -3,8 +3,14 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from jinja2 import DictLoader
+from pytest import raises
 
-from utilities.jinja2 import EnhancedEnvironment, TemplateJob
+from utilities.jinja2 import (
+    EnhancedEnvironment,
+    TemplateJob,
+    _TemplateJobTargetDoesNotExistError,
+    _TemplateJobTemplateDoesNotExistError,
+)
 from utilities.text import strip_and_dedent
 
 if TYPE_CHECKING:
@@ -85,3 +91,23 @@ class TestTemplateJob:
             old = 'old text'
             new = 'new text'
         """)
+
+    def test_error_template(self, *, tmp_path: Path) -> None:
+        path_template = tmp_path.joinpath("template.j2")
+        path_target = tmp_path.joinpath("target.txt")
+        with raises(
+            _TemplateJobTemplateDoesNotExistError,
+            match=r"^Template '.*' does not exist$",
+        ):
+            _ = TemplateJob(template=path_template, kwargs={}, target=path_target)
+
+    def test_error_target(self, *, tmp_path: Path) -> None:
+        path_template = tmp_path.joinpath("template.j2")
+        path_template.touch()
+        path_target = tmp_path.joinpath("target.txt")
+        with raises(
+            _TemplateJobTargetDoesNotExistError, match=r"^Target '.*' does not exist$"
+        ):
+            _ = TemplateJob(
+                template=path_template, kwargs={}, target=path_target, mode="append"
+            )

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/src/tests/test_postgres.py

@@ -56,7 +56,7 @@ class TestPGDump:
         inserts=booleans(),
         on_conflict_do_nothing=booleans(),
         role=text_ascii(min_size=1) | none(),
-        docker=text_ascii(min_size=1) | none(),
+        docker_container=text_ascii(min_size=1) | none(),
     )
     def test_build(
         self,
@@ -75,7 +75,7 @@ class TestPGDump:
         inserts: bool,
         on_conflict_do_nothing: bool,
         role: str | None,
-        docker: str | None,
+        docker_container: str | None,
     ) -> None:
         _ = _build_pg_dump(
             url,
@@ -92,7 +92,7 @@ class TestPGDump:
             inserts=inserts,
             on_conflict_do_nothing=on_conflict_do_nothing,
             role=role,
-            docker=docker,
+            docker_container=docker_container,
         )
 
     @given(path=temp_paths(), format_=sampled_from(get_literal_elements(_PGDumpFormat)))
@@ -132,7 +132,7 @@ class TestRestore:
         schema_exc=lists(text_ascii(min_size=1)) | none(),
         table=tables() | none(),
         role=text_ascii(min_size=1) | none(),
-        docker=text_ascii(min_size=1) | none(),
+        docker_container=text_ascii(min_size=1) | none(),
     )
     def test_build(
         self,
@@ -146,7 +146,7 @@ class TestRestore:
         schema_exc: list[str] | None,
         table: list[Table | str] | None,
         role: str | None,
-        docker: str | None,
+        docker_container: str | None,
     ) -> None:
         _ = _build_pg_restore_or_psql(
             url,
@@ -158,5 +158,5 @@ class TestRestore:
             schema_exc=schema_exc,
             table=table,
             role=role,
-            docker=docker,
+            docker_container=docker_container,
         )

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.36"
+__version__ = "0.167.0"

dycw_utilities-0.167.0/src/utilities/docker.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+
+def docker_exec(
+    container: str,
+    /,
+    *cmd: str,
+    env: Mapping[str, str] | None = None,
+    **env_kwargs: str | None,
+) -> list[str]:
+    """Run a command through `docker exec`."""
+    full = ["docker", "exec"]
+    mapping: dict[str, str | None] = ({} if env is None else dict(env)) | env_kwargs
+    for key, value in mapping.items():
+        full.append(f"--env={key}={value}")
+    return [*full, "--interactive", container, *cmd]
+
+
+__all__ = ["docker_exec"]

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/src/utilities/jinja2.py

@@ -98,6 +98,12 @@ class TemplateJob:
     target: Path
     mode: Literal["write", "append"] = "write"
 
+    def __post_init__(self) -> None:
+        if not self.template.exists():
+            raise _TemplateJobTemplateDoesNotExistError(path=self.template)
+        if (self.mode == "append") and not self.target.exists():
+            raise _TemplateJobTargetDoesNotExistError(path=self.template)
+
     def run(self) -> None:
         """Run the job."""
         match self.mode:
@@ -117,4 +123,26 @@ class TemplateJob:
         return env.get_template(self.template.name).render(self.kwargs)
 
 
-__all__ = ["EnhancedEnvironment", "TemplateJob"]
+@dataclass(kw_only=True, slots=True)
+class TemplateJobError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _TemplateJobTemplateDoesNotExistError(TemplateJobError):
+    path: Path
+
+    @override
+    def __str__(self) -> str:
+        return f"Template {str(self.path)!r} does not exist"
+
+
+@dataclass(kw_only=True, slots=True)
+class _TemplateJobTargetDoesNotExistError(TemplateJobError):
+    path: Path
+
+    @override
+    def __str__(self) -> str:
+        return f"Target {str(self.path)!r} does not exist"
+
+
+__all__ = ["EnhancedEnvironment", "TemplateJob", "TemplateJobError"]

{dycw_utilities-0.166.36 → dycw_utilities-0.167.0}/src/utilities/postgres.py

@@ -9,6 +9,7 @@ from sqlalchemy import Table
 from sqlalchemy.orm import DeclarativeBase
 
 from utilities.asyncio import stream_command
+from utilities.docker import docker_exec
 from utilities.iterables import always_iterable
 from utilities.logging import to_logger
 from utilities.os import temp_environ
@@ -37,6 +38,7 @@ async def pg_dump(
     path: PathLike,
     /,
     *,
+    docker_container: str | None = None,
     format_: _PGDumpFormat = "plain",
     jobs: int | None = None,
     data_only: bool = False,
@@ -51,7 +53,6 @@ async def pg_dump(
     inserts: bool = False,
     on_conflict_do_nothing: bool = False,
     role: str | None = None,
-    docker: str | None = None,
     dry_run: bool = False,
     logger: LoggerLike | None = None,
 ) -> bool:
@@ -61,6 +62,7 @@ async def pg_dump(
     cmd = _build_pg_dump(
         url,
         path,
+        docker_container=docker_container,
         format_=format_,
         jobs=jobs,
         data_only=data_only,
@@ -75,7 +77,6 @@ async def pg_dump(
         inserts=inserts,
         on_conflict_do_nothing=on_conflict_do_nothing,
         role=role,
-        docker=docker,
     )
     if dry_run:
         if logger is not None:
@@ -111,6 +112,7 @@ def _build_pg_dump(
     path: PathLike,
     /,
     *,
+    docker_container: str | None = None,
     format_: _PGDumpFormat = "plain",
     jobs: int | None = None,
     data_only: bool = False,
@@ -125,12 +127,13 @@ def _build_pg_dump(
     inserts: bool = False,
     on_conflict_do_nothing: bool = False,
     role: str | None = None,
-    docker: str | None = None,
 ) -> str:
     extracted = extract_url(url)
     path = _path_pg_dump(path, format_=format_)
-    parts: list[str] = [
-        "pg_dump",
+    parts: list[str] = ["pg_dump"]
+    if docker_container is not None:
+        parts = docker_exec(docker_container, *parts, PGPASSWORD=extracted.password)
+    parts.extend([
         # general options
         f"--file={str(path)!r}",
         f"--format={format_}",
@@ -146,7 +149,7 @@ def _build_pg_dump(
         f"--port={extracted.port}",
         f"--username={extracted.username}",
         "--no-password",
-    ]
+    ])
     if (format_ == "directory") and (jobs is not None):
         parts.append(f"--jobs={jobs}")
     if create:
@@ -173,8 +176,6 @@ def _build_pg_dump(
         parts.append("--on-conflict-do-nothing")
     if role is not None:
         parts.append(f"--role={role}")
-    if docker is not None:
-        parts = _wrap_docker(parts, docker)
     return " ".join(parts)
 
 
@@ -213,7 +214,7 @@ async def restore(
     schema_exc: MaybeCollectionStr | None = None,
     table: MaybeCollection[TableOrORMInstOrClass | str] | None = None,
     role: str | None = None,
-    docker: str | None = None,
+    docker_container: str | None = None,
     dry_run: bool = False,
     logger: LoggerLike | None = None,
 ) -> bool:
@@ -230,7 +231,7 @@ async def restore(
         schema_exc=schema_exc,
         table=table,
         role=role,
-        docker=docker,
+        docker_container=docker_container,
     )
     if dry_run:
         if logger is not None:
@@ -276,11 +277,11 @@ def _build_pg_restore_or_psql(
     schema_exc: MaybeCollectionStr | None = None,
     table: MaybeCollection[TableOrORMInstOrClass | str] | None = None,
     role: str | None = None,
-    docker: str | None = None,
+    docker_container: str | None = None,
 ) -> str:
     path = Path(path)
     if (path.suffix == ".sql") or psql:
-        return _build_psql(url, path, docker=docker)
+        return _build_psql(url, path, docker_container=docker_container)
     return _build_pg_restore(
         url,
         path,
@@ -292,7 +293,7 @@ def _build_pg_restore_or_psql(
         schemas_exc=schema_exc,
         tables=table,
         role=role,
-        docker=docker,
+        docker_container=docker_container,
     )
 
 
@@ -309,12 +310,14 @@ def _build_pg_restore(
     schemas_exc: MaybeCollectionStr | None = None,
     tables: MaybeCollection[TableOrORMInstOrClass | str] | None = None,
     role: str | None = None,
-    docker: str | None = None,
+    docker_container: str | None = None,
 ) -> str:
     """Run `pg_restore`."""
     extracted = extract_url(url)
-    parts: list[str] = [
-        "pg_restore",
+    parts: list[str] = ["pg_restore"]
+    if docker_container is not None:
+        parts = docker_exec(docker_container, *parts, PGPASSWORD=extracted.password)
+    parts.extend([
         # general options
         "--verbose",
         # restore options
@@ -328,7 +331,7 @@ def _build_pg_restore(
         f"--username={extracted.username}",
         f"--dbname={extracted.database}",
         "--no-password",
-    ]
+    ])
     if create:
         parts.append("--create")
     if jobs is not None:
@@ -341,17 +344,19 @@ def _build_pg_restore(
         parts.extend([f"--table={_get_table_name(t)}" for t in always_iterable(tables)])
     if role is not None:
         parts.append(f"--role={role}")
-    if docker is not None:
-        parts = _wrap_docker(parts, docker)
     parts.append(str(path))
     return " ".join(parts)
 
 
-def _build_psql(url: URL, path: PathLike, /, *, docker: str | None = None) -> str:
+def _build_psql(
+    url: URL, path: PathLike, /, *, docker_container: str | None = None
+) -> str:
     """Run `psql`."""
     extracted = extract_url(url)
-    parts: list[str] = [
-        "psql",
+    parts: list[str] = ["psql"]
+    if docker_container is not None:
+        parts = docker_exec(docker_container, *parts, PGPASSWORD=extracted.password)
+    parts.extend([
         # general options
         f"--dbname={extracted.database}",
         f"--file={str(path)!r}",
@@ -360,9 +365,7 @@ def _build_psql(url: URL, path: PathLike, /, *, docker: str | None = None) -> st
         f"--port={extracted.port}",
         f"--username={extracted.username}",
         "--no-password",
-    ]
-    if docker is not None:
-        parts = _wrap_docker(parts, docker)
+    ])
     return " ".join(parts)
 
 
@@ -402,8 +405,4 @@ class _ResolveDataOnlyAndCleanError(Exception):
         return "Cannot use '--data-only' and '--clean' together"
 
 
-def _wrap_docker(parts: list[str], container: str, /) -> list[str]:
-    return ["docker", "exec", "-it", container, *parts]
-
-
 __all__ = ["pg_dump", "restore"]