dycw-utilities 0.166.36__py3-none-any.whl → 0.167.0__py3-none-any.whl

{dycw_utilities-0.166.36.dist-info → dycw_utilities-0.167.0.dist-info}/METADATA

@@ -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.dist-info → dycw_utilities-0.167.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=VioZbifSCOm0EkGF27DgQtAvEThNI6_JUJQ3jWhqrYI,61
+utilities/__init__.py,sha256=dgiGa6KFuwS9sLQQWHYgtwuRxby-Kwzx_cLKTNpUlIc,60
 utilities/aeventkit.py,sha256=ddoleSwW9zdc2tjX5Ge0pMKtYwV_JMxhHYOxnWX2AGM,12609
 utilities/altair.py,sha256=nHdpWt8ZwdUwRQN970MvHd5bRWokNqzHcZQEdSHKRuE,9033
 utilities/asyncio.py,sha256=60l1IwjnRGeaVphAFiwDIHyfKoZYKY-XGpptUxGiU-M,17034
@@ -12,6 +12,7 @@ utilities/contextvars.py,sha256=J8OhC7jqozAGYOCe2KUWysbPXNGe5JYz3HfaY_mIs08,883
 utilities/cryptography.py,sha256=5PFrzsNUGHay91dFgYnDKwYprXxahrBqztmUqViRzBk,956
 utilities/cvxpy.py,sha256=Rv1-fD-XYerosCavRF8Pohop2DBkU3AlFaGTfD8AEAA,13776
 utilities/dataclasses.py,sha256=xbU3QN1GFy7RC6hIJRZIeUZm7YRlodrgEWmahWG6k2g,32465
+utilities/docker.py,sha256=AahXNwtu4ojdVeTdAa-VBR8h7GWNAE3ChHeVBa0oZAE,603
 utilities/enum.py,sha256=5l6pwZD1cjSlVW4ss-zBPspWvrbrYrdtJWcg6f5_J5w,5781
 utilities/errors.py,sha256=mFlDGSM0LI1jZ1pbqwLAH3ttLZ2JVIxyZLojw8tGVZU,1479
 utilities/fastapi.py,sha256=TqyKvBjiMS594sXPjrz-KRTLMb3l3D3rZ1zAYV7GfOk,1454
@@ -28,7 +29,7 @@ utilities/importlib.py,sha256=mV1xT_O_zt_GnZZ36tl3xOmMaN_3jErDWY54fX39F6Y,429
 utilities/inflect.py,sha256=v7YkOWSu8NAmVghPcf4F3YBZQoJCS47_DLf9jbfWIs0,581
 utilities/ipython.py,sha256=V2oMYHvEKvlNBzxDXdLvKi48oUq2SclRg5xasjaXStw,763
 utilities/iterables.py,sha256=t2TsW-K3rVlS6y4_tqcc1fk9RwJV-bi7G_VwduMABK0,42558
-utilities/jinja2.py,sha256=jk9GI03mfl0lbu3NFJPRbiZ5xTExGd9lIX-i5SZXiMU,3859
+utilities/jinja2.py,sha256=JpNHMcyMJDguX8rBN4wEz-v4En7w6WHXvYJr4Xw-F0o,4691
 utilities/json.py,sha256=-WcGtSsCr9Y42wHZzAMnfvU6ihAfVftylFfRUORaDFo,2102
 utilities/jupyter.py,sha256=ft5JA7fBxXKzP-L9W8f2-wbF0QeYc_2uLQNFDVk4Z-M,2917
 utilities/libcst.py,sha256=ngD4wxnR3Kh-RBVmU5l5ST7cuZLhMZwyMDjHZe5mhTs,5581
@@ -49,7 +50,7 @@ utilities/pickle.py,sha256=MBT2xZCsv0pH868IXLGKnlcqNx2IRVKYNpRcqiQQqxw,653
 utilities/platform.py,sha256=pTn7gw6N4T6LdKrf0virwarof_mze9WtoQlrGMzhGVI,2798
 utilities/polars.py,sha256=qsiYY9p_41fORGnc7HNkA4zhlsycK7sgD74xuigMDAc,87466
 utilities/polars_ols.py,sha256=LNTFNLPuYW7fcAHymlbnams_DhitToblYvib3mhKbwI,5615
-utilities/postgres.py,sha256=ynCTTaF-bVEOSW-KEAR-dlLh_hYjeVVjm__-4pEU8Zk,12269
+utilities/postgres.py,sha256=qQzXJngzs2jyZ4rkzL6uBdhXPwiqpPtYQiIonNcGIwI,12516
 utilities/pottery.py,sha256=nA0SsF9irvfC0tk68YAr08tuL9lGRSlBKihSx7Ibk84,3963
 utilities/pqdm.py,sha256=idv2seRVP2f6NeSfpeEnT5A-tQezaHZKDyeu16g2-0E,3091
 utilities/psutil.py,sha256=KUlu4lrUw9Zg1V7ZGetpWpGb9DB8l_SSDWGbANFNCPU,2104
@@ -92,8 +93,8 @@ utilities/zoneinfo.py,sha256=tdIScrTB2-B-LH0ukb1HUXKooLknOfJNwHk10MuMYvA,3619
 utilities/pytest_plugins/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
 utilities/pytest_plugins/pytest_randomly.py,sha256=B1qYVlExGOxTywq2r1SMi5o7btHLk2PNdY_b1p98dkE,409
 utilities/pytest_plugins/pytest_regressions.py,sha256=mnHYBfdprz50UGVkVzV1bZERZN5CFfoF8YbokGxdFwU,1639
-dycw_utilities-0.166.36.dist-info/METADATA,sha256=Qu3EXmhbVxbw3w5OODwArwNZdxgpLDMEDYf4-VJ24Nw,1699
-dycw_utilities-0.166.36.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.166.36.dist-info/entry_points.txt,sha256=BOD_SoDxwsfJYOLxhrSXhHP_T7iw-HXI9f2WVkzYxvQ,135
-dycw_utilities-0.166.36.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.166.36.dist-info/RECORD,,
+dycw_utilities-0.167.0.dist-info/METADATA,sha256=lNFPf9vIPLLTN5FD1LbxTof59uW1K-d8TriQ0JNAlUU,1698
+dycw_utilities-0.167.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.167.0.dist-info/entry_points.txt,sha256=BOD_SoDxwsfJYOLxhrSXhHP_T7iw-HXI9f2WVkzYxvQ,135
+dycw_utilities-0.167.0.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.167.0.dist-info/RECORD,,

utilities/__init__.py

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

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"]

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"]

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"]