dycw-utilities 0.175.18__py3-none-any.whl → 0.175.19__py3-none-any.whl

{dycw_utilities-0.175.18.dist-info → dycw_utilities-0.175.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dycw-utilities
-Version: 0.175.18
+Version: 0.175.19
 Summary: Miscellaneous Python utilities
 Author: Derek Wan
 Author-email: Derek Wan <d.wan@icloud.com>

{dycw_utilities-0.175.18.dist-info → dycw_utilities-0.175.19.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=psCN55v4h2RM9fNitaqX4CE9cRd60bDV0qAa6_nnbEw,61
+utilities/__init__.py,sha256=Icf2ql4qG7C1V1W6jJzw-EbFjcuaZSkx7-OyX1zNNMY,61
 utilities/altair.py,sha256=TLfRFbG9HwG7SLXoJ-v0r-t49ZaGgTQZD82cpjVi4vs,9085
 utilities/asyncio.py,sha256=aJySVxBY0gqsIYnoNmH7-1r8djKuf4vSsU69VCD08t8,16772
 utilities/atomicwrites.py,sha256=tPo6r-Rypd9u99u66B9z86YBPpnLrlHtwox_8Z7T34Y,5790
@@ -80,7 +80,7 @@ utilities/sqlalchemy.py,sha256=HQYpd7LFxdTF5WYVWYtCJeEBI71EJm7ytvCGyAH9B-U,37163
 utilities/sqlalchemy_polars.py,sha256=JCGhB37raSR7fqeWV5dTsciRTMVzIdVT9YSqKT0piT0,13370
 utilities/statsmodels.py,sha256=koyiBHvpMcSiBfh99wFUfSggLNx7cuAw3rwyfAhoKpQ,3410
 utilities/string.py,sha256=shmBK87zZwzGyixuNuXCiUbqzfeZ9xlrFwz6JTaRvDk,582
-utilities/subprocess.py,sha256=ySVxt8V5WcEsrsy6cdqiK4kb15wGfkQxpxePJM_NCe0,43843
+utilities/subprocess.py,sha256=F4sRJq9eNnXwZ46GgYxTQQCT-YUx_ghZ4o91dH4KgW4,45405
 utilities/tempfile.py,sha256=a3_M1QyxGZql_VcGkBOQBeWbbkItjgkfIpVyzU1UAic,3843
 utilities/testbook.py,sha256=j1KmaVbrX9VrbeMgtPh5gk55myAsn3dyRUn7jGbPbRk,1294
 utilities/text.py,sha256=7SvwcSR2l_5cOrm1samGnR4C-ZI6qyFLHLzSpO1zeHQ,13958
@@ -97,7 +97,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=F4ek0-OBWxHYrZdmoZt76N2RnNyKY5KrEHt7rqO4AQE,60183
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=tdIScrTB2-B-LH0ukb1HUXKooLknOfJNwHk10MuMYvA,3619
-dycw_utilities-0.175.18.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
-dycw_utilities-0.175.18.dist-info/entry_points.txt,sha256=cOGtKeJI0KXLSV7MJ8Dhc2G8jPgDcBDm53MVNJU4ycI,136
-dycw_utilities-0.175.18.dist-info/METADATA,sha256=NfSdn67Xz5devAMMKWOQknDOuGRphL-0POujF8Vv8FM,1443
-dycw_utilities-0.175.18.dist-info/RECORD,,
+dycw_utilities-0.175.19.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
+dycw_utilities-0.175.19.dist-info/entry_points.txt,sha256=cOGtKeJI0KXLSV7MJ8Dhc2G8jPgDcBDm53MVNJU4ycI,136
+dycw_utilities-0.175.19.dist-info/METADATA,sha256=-Ng54LQmTd_U_-Vbb0rRL7bAKisLDxfPhIrEkrxtT9U,1443
+dycw_utilities-0.175.19.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.175.18"
+__version__ = "0.175.19"

utilities/subprocess.py

@@ -5,6 +5,7 @@ import sys
 from contextlib import contextmanager
 from dataclasses import dataclass
 from io import StringIO
+from itertools import repeat
 from pathlib import Path
 from re import search
 from shlex import join
@@ -54,11 +55,36 @@ UPDATE_CA_CERTIFICATES: str = "update-ca-certificates"
 ##
 
 
+def append_text(
+    path: PathLike,
+    text: str,
+    /,
+    *,
+    sudo: bool = False,
+    skip_if_present: bool = False,
+    flags: int = 0,
+    blank_lines: int = 1,
+) -> None:
+    """Append text to a file."""
+    try:
+        existing = cat(path, sudo=sudo)
+    except (CalledProcessError, FileNotFoundError):
+        tee(path, text, sudo=sudo, append=True)
+        return
+    if skip_if_present and (search(text, existing, flags=flags) is not None):
+        return
+    full = "".join([*repeat("\n", times=blank_lines), text])
+    tee(path, full, sudo=sudo, append=True)
+
+
+##
+
+
 def apt_install(package: str, /, *, update: bool = False, sudo: bool = False) -> None:
     """Install a package."""
     if update:  # pragma: no cover
         run(*maybe_sudo_cmd(*APT_UPDATE, sudo=sudo))
-    run(*maybe_sudo_cmd(*apt_install_cmd(package), sudo=sudo))
+    run(*maybe_sudo_cmd(*apt_install_cmd(package), sudo=sudo))  # pragma: no cover
 
 
 def apt_install_cmd(package: str, /) -> list[str]:
@@ -69,6 +95,13 @@ def apt_install_cmd(package: str, /) -> list[str]:
 ##
 
 
+def cat(path: PathLike, /, *, sudo: bool = False) -> str:
+    """Concatenate a file."""
+    if sudo:  # pragma: no cover
+        return run(*sudo_cmd(*cat_cmd(path)), return_=True)
+    return Path(path).read_text()
+
+
 def cat_cmd(path: PathLike, /) -> list[str]:
     """Command to use 'cat' to concatenate and print files."""
     return ["cat", str(path)]
@@ -170,6 +203,24 @@ def chpasswd(user_name: str, password: str, /, *, sudo: bool = False) -> None:
 ##
 
 
+def copy_text(
+    src: PathLike,
+    dest: PathLike,
+    /,
+    *,
+    sudo: bool = False,
+    substitutions: StrMapping | None = None,
+) -> None:
+    """Copy the text contents of a file."""
+    text = cat(src, sudo=sudo)
+    if substitutions is not None:
+        text = Template(text).substitute(**substitutions)
+    tee(dest, text, sudo=sudo)
+
+
+##
+
+
 def cp(
     src: PathLike,
     dest: PathLike,
@@ -356,6 +407,20 @@ def mv_cmd(src: PathLike, dest: PathLike, /) -> list[str]:
 ##
 
 
+def replace_text(
+    path: PathLike, /, *replacements: tuple[str, str], sudo: bool = False
+) -> None:
+    """Replace the text in a file."""
+    path = Path(path)
+    text = cat(path, sudo=sudo)
+    for old, new in replacements:
+        text = text.replace(old, new)
+    tee(path, text, sudo=sudo)
+
+
+##
+
+
 def ripgrep(*args: str, path: PathLike = PWD) -> str | None:
     """Search for lines."""
     try:  # skipif-ci
@@ -1260,7 +1325,7 @@ def symlink_cmd(target: PathLike, link: PathLike, /) -> list[str]:
 def tee(
     path: PathLike, text: str, /, *, sudo: bool = False, append: bool = False
 ) -> None:
-    """Use 'tee' to duplicate standard input."""
+    """Duplicate standard input."""
     mkdir(path, sudo=sudo, parent=True)
     if sudo:  # pragma: no cover
         run(*sudo_cmd(*tee_cmd(path, append=append)), input=text)
@@ -1516,14 +1581,17 @@ __all__ = [
     "RsyncCmdError",
     "RsyncCmdNoSourcesError",
     "RsyncCmdSourcesNotFoundError",
+    "append_text",
     "apt_install",
     "apt_install_cmd",
+    "cat",
     "cd_cmd",
     "chmod",
     "chmod_cmd",
     "chown",
     "chown_cmd",
     "chpasswd",
+    "copy_text",
     "cp",
     "cp_cmd",
     "echo_cmd",
@@ -1540,6 +1608,7 @@ __all__ = [
     "mkdir_cmd",
     "mv",
     "mv_cmd",
+    "replace_text",
     "ripgrep",
     "ripgrep_cmd",
     "rm",