dycw-actions 0.8.5__py3-none-any.whl → 0.8.11__py3-none-any.whl

actions/pre_commit/utilities.py

@@ -12,12 +12,12 @@ from libcst import Module, parse_module
 from rich.pretty import pretty_repr
 from tomlkit import TOMLDocument, aot, array, document, string, table
 from tomlkit.items import AoT, Array, Table
-from utilities.functions import ensure_class, ensure_str
+from utilities.functions import ensure_class, ensure_str, get_func_name
 from utilities.iterables import OneEmptyError, OneNonUniqueError, one
 from utilities.packaging import Requirement
 from utilities.types import PathLike, StrDict
 
-from actions.constants import YAML_INSTANCE
+from actions.constants import PATH_CACHE, YAML_INSTANCE
 from actions.logging import LOGGER
 from actions.utilities import are_equal_modulo_new_line, write_text, yaml_dump
 
@@ -222,76 +222,10 @@ class PyProjectDependencies:
 ##
 
 
-@contextmanager
-def yield_json_dict(
-    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
-) -> Iterator[StrDict]:
-    with yield_mutable_write_context(
-        path, json.loads, dict, json.dumps, modifications=modifications
-    ) as dict_:
-        yield dict_
-
-
-##
-
-
-@contextmanager
-def yield_python_file(
-    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
-) -> Iterator[WriteContext[Module]]:
-    with yield_immutable_write_context(
-        path,
-        parse_module,
-        lambda: Module(body=[]),
-        lambda module: module.code,
-        modifications=modifications,
-    ) as context:
-        yield context
-
-
-##
-
-
-@contextmanager
-def yield_text_file(
-    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
-) -> Iterator[WriteContext[str]]:
-    with yield_immutable_write_context(
-        path, str, lambda: "", str, modifications=modifications
-    ) as context:
-        yield context
-
-
-##
-
-
-@contextmanager
-def yield_toml_doc(
-    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
-) -> Iterator[TOMLDocument]:
-    with yield_mutable_write_context(
-        path, tomlkit.parse, document, tomlkit.dumps, modifications=modifications
-    ) as doc:
-        yield doc
-
-
-##
-
-
-@contextmanager
-def yield_mutable_write_context[T](
-    path: PathLike,
-    loads: Callable[[str], T],
-    get_default: Callable[[], T],
-    dumps: Callable[[T], str],
-    /,
-    *,
-    modifications: MutableSet[Path] | None = None,
-) -> Iterator[T]:
-    with yield_immutable_write_context(
-        path, loads, get_default, dumps, modifications=modifications
-    ) as context:
-        yield context.output
+def path_throttle_cache(func: Callable[..., Any]) -> Path:
+    func_name = get_func_name(func)
+    cwd_name = Path.cwd().name
+    return PATH_CACHE / "throttle" / f"{func_name}--{cwd_name}"
 
 
 ##
@@ -348,6 +282,81 @@ def yield_immutable_write_context[T](
 ##
 
 
+@contextmanager
+def yield_json_dict(
+    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
+) -> Iterator[StrDict]:
+    with yield_mutable_write_context(
+        path, json.loads, dict, json.dumps, modifications=modifications
+    ) as dict_:
+        yield dict_
+
+
+##
+
+
+@contextmanager
+def yield_mutable_write_context[T](
+    path: PathLike,
+    loads: Callable[[str], T],
+    get_default: Callable[[], T],
+    dumps: Callable[[T], str],
+    /,
+    *,
+    modifications: MutableSet[Path] | None = None,
+) -> Iterator[T]:
+    with yield_immutable_write_context(
+        path, loads, get_default, dumps, modifications=modifications
+    ) as context:
+        yield context.output
+
+
+##
+
+
+@contextmanager
+def yield_python_file(
+    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
+) -> Iterator[WriteContext[Module]]:
+    with yield_immutable_write_context(
+        path,
+        parse_module,
+        lambda: Module(body=[]),
+        lambda module: module.code,
+        modifications=modifications,
+    ) as context:
+        yield context
+
+
+##
+
+
+@contextmanager
+def yield_text_file(
+    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
+) -> Iterator[WriteContext[str]]:
+    with yield_immutable_write_context(
+        path, str, lambda: "", str, modifications=modifications
+    ) as context:
+        yield context
+
+
+##
+
+
+@contextmanager
+def yield_toml_doc(
+    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
+) -> Iterator[TOMLDocument]:
+    with yield_mutable_write_context(
+        path, tomlkit.parse, document, tomlkit.dumps, modifications=modifications
+    ) as doc:
+        yield doc
+
+
+##
+
+
 @contextmanager
 def yield_yaml_dict(
     path: PathLike, /, *, modifications: MutableSet[Path] | None = None
@@ -360,6 +369,7 @@ def yield_yaml_dict(
 
 __all__ = [
     "PyProjectDependencies",
+    "WriteContext",
     "ensure_aot_contains",
     "ensure_contains",
     "ensure_contains_partial_dict",
@@ -375,6 +385,7 @@ __all__ = [
     "get_table",
     "is_partial_dict",
     "is_partial_str",
+    "path_throttle_cache",
     "yield_immutable_write_context",
     "yield_json_dict",
     "yield_mutable_write_context",

actions/publish_package/lib.py

@@ -3,12 +3,10 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from utilities.tempfile import TemporaryDirectory
-from utilities.text import strip_and_dedent
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.publish_package.settings import SETTINGS
-from actions.utilities import logged_run
+from actions.utilities import log_func_call, logged_run
 
 if TYPE_CHECKING:
     from typed_settings import Secret
@@ -22,23 +20,14 @@ def publish_package(
     trusted_publishing: bool = SETTINGS.trusted_publishing,
     native_tls: bool = SETTINGS.native_tls,
 ) -> None:
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - username           = %s
-             - password           = %s
-             - publish_url        = %s
-             - trusted_publishing = %s
-             - native_tls         = %s
-        """),
-        publish_package.__name__,
-        __version__,
-        username,
-        password,
-        publish_url,
-        trusted_publishing,
-        native_tls,
-    )
+    variables = [
+        f"{username=}",
+        f"{password=}",
+        f"{publish_url=}",
+        f"{trusted_publishing=}",
+        f"{native_tls=}",
+    ]
+    LOGGER.info(log_func_call(publish_package, *variables))
     with TemporaryDirectory() as temp:
         logged_run("uv", "build", "--out-dir", str(temp), "--wheel", "--clear")
         logged_run(

actions/random_sleep/cli.py

@@ -16,8 +16,8 @@ def random_sleep_sub_cmd(settings: Settings, /) -> None:
         return
     basic_config(obj=LOGGER)
     random_sleep(
-        min_=settings.min,
-        max_=settings.max,
+        min=settings.min,
+        max=settings.max,
         step=settings.step,
         log_freq=settings.log_freq,
     )

actions/random_sleep/lib.py

@@ -4,39 +4,25 @@ from math import ceil, floor
 from random import choice
 from time import sleep
 
-from utilities.text import strip_and_dedent
 from utilities.whenever import get_now
 from whenever import TimeDelta, ZonedDateTime
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.random_sleep.settings import SETTINGS
+from actions.utilities import log_func_call
 
 
 def random_sleep(
     *,
-    min_: int = SETTINGS.min,
-    max_: int = SETTINGS.max,
+    min: int = SETTINGS.min,  # noqa: A002
+    max: int = SETTINGS.max,  # noqa: A002
     step: int = SETTINGS.step,
     log_freq: int = SETTINGS.log_freq,
 ) -> None:
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - min_     = %s
-             - max_     = %s
-             - step     = %s
-             - log_freq = %s
-        """),
-        random_sleep.__name__,
-        __version__,
-        min_,
-        max_,
-        step,
-        log_freq,
-    )
+    variables = [f"{min=}", f"{max=}", f"{step=}", f"{log_freq=}"]
+    LOGGER.info(log_func_call(random_sleep, *variables))
     start = get_now()
-    delta = TimeDelta(seconds=choice(range(min_, max_, step)))
+    delta = TimeDelta(seconds=choice(range(min, max, step)))
     LOGGER.info("Sleeping for %s...", delta)
     end = (start + delta).round(mode="ceil")
     while (now := get_now()) < end:

actions/register_gitea_runner/lib.py

@@ -7,10 +7,8 @@ from typing import TYPE_CHECKING
 
 from requests import get
 from utilities.atomicwrites import writer
-from utilities.subprocess import chmod, ssh
-from utilities.text import strip_and_dedent
+from utilities.subprocess import chmod, rm_cmd, ssh, sudo_cmd
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.register_gitea_runner.constants import (
     PATH_CACHE,
@@ -19,7 +17,7 @@ from actions.register_gitea_runner.constants import (
     URL_WAIT_FOR_IT,
 )
 from actions.register_gitea_runner.settings import SETTINGS
-from actions.utilities import logged_run
+from actions.utilities import log_func_call, logged_run
 
 if TYPE_CHECKING:
     from utilities.types import PathLike
@@ -39,33 +37,19 @@ def register_gitea_runner(
     runner_instance_name: str = SETTINGS.runner_instance_name,
 ) -> None:
     """Register against a remote instance of Gitea."""
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - ssh_user              = %s
-             - ssh_host              = %s
-             - gitea_container_user  = %s
-             - gitea_container_name  = %s
-             - runner_certificate    = %s
-             - runner_capacity       = %d
-             - runner_container_name = %s
-             - gitea_host            = %s
-             - gitea_port            = %d
-             - runner_instance_name  = %s
-        """),
-        register_gitea_runner.__name__,
-        __version__,
-        ssh_user,
-        ssh_host,
-        gitea_container_user,
-        gitea_container_name,
-        runner_certificate,
-        runner_capacity,
-        runner_container_name,
-        gitea_host,
-        gitea_port,
-        runner_instance_name,
-    )
+    variables = [
+        f"{ssh_user=}",
+        f"{ssh_host=}",
+        f"{gitea_container_user=}",
+        f"{gitea_container_name=}",
+        f"{runner_certificate=}",
+        f"{runner_capacity=}",
+        f"{runner_container_name=}",
+        f"{gitea_host=}",
+        f"{gitea_port=}",
+        f"{runner_instance_name=}",
+    ]
+    LOGGER.info(log_func_call(register_gitea_runner, *variables))
     token = ssh(
         ssh_user,
         ssh_host,
@@ -237,7 +221,8 @@ def _start_runner(
     _write_config(token, capacity=runner_capacity, certificate=runner_certificate)
     _write_entrypoint(host=gitea_host, port=gitea_port)
     _write_wait_for_it()
-    logged_run(*_docker_stop_runner_args(name=runner_container_name), print=True)
+    logged_run(*_docker_stop_runner_args(name=runner_container_name))
+    logged_run(*sudo_cmd(*rm_cmd("data")))
     logged_run(
         *_docker_run_act_runner_args(
             token,
@@ -246,8 +231,7 @@ def _start_runner(
             runner_certificate=runner_certificate,
             instance_name=runner_instance_name,
             container_name=runner_container_name,
-        ),
-        print=True,
+        )
     )
 
 

actions/run_hooks/lib.py

@@ -8,14 +8,12 @@ from subprocess import CalledProcessError
 from typing import TYPE_CHECKING, Any
 
 from utilities.functions import ensure_class, ensure_str
-from utilities.text import strip_and_dedent
 from whenever import TimeDelta
 from yaml import safe_load
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.run_hooks.settings import SETTINGS
-from actions.utilities import logged_run
+from actions.utilities import log_func_call, logged_run
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
@@ -28,21 +26,8 @@ def run_hooks(
     hooks_exclude: list[str] | None = SETTINGS.hooks_exclude,
     sleep: int = SETTINGS.sleep,
 ) -> None:
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - repos         = %s
-             - hooks         = %s
-             - hooks_exclude = %s
-             - sleep         = %d
-        """),
-        run_hooks.__name__,
-        __version__,
-        repos,
-        hooks,
-        hooks_exclude,
-        sleep,
-    )
+    variables = [f"{repos=}", f"{hooks=}", f"{hooks_exclude=}", f"{sleep=}"]
+    LOGGER.info(log_func_call(run_hooks, *variables))
     results = {
         hook: _run_hook(hook, sleep=sleep)
         for hook in _yield_hooks(repos=repos, hooks=hooks, hooks_exclude=hooks_exclude)

actions/setup_cronjob/lib.py

@@ -5,12 +5,11 @@ from typing import TYPE_CHECKING
 
 from utilities.platform import SYSTEM
 from utilities.subprocess import chmod, chown, tee
-from utilities.text import strip_and_dedent
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.setup_cronjob.constants import PATH_CONFIGS
 from actions.setup_cronjob.settings import SETTINGS
+from actions.utilities import log_func_call
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -31,31 +30,18 @@ def setup_cronjob(
     logs_keep: int = SETTINGS.logs_keep,
 ) -> None:
     """Set up a cronjob & logrotate."""
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - name         = %s
-             - prepend_path = %s
-             - schedule     = %s
-             - user         = %s
-             - timeout      = %d
-             - kill_after   = %d
-             - command      = %s
-             - args         = %s
-             - logs_keep    = %d
-        """),
-        setup_cronjob.__name__,
-        __version__,
-        name,
-        prepend_path,
-        schedule,
-        user,
-        timeout,
-        kill_after,
-        command,
-        args,
-        logs_keep,
-    )
+    variables = [
+        f"{name=}",
+        f"{prepend_path=}",
+        f"{schedule=}",
+        f"{user=}",
+        f"{timeout=}",
+        f"{kill_after=}",
+        f"{command=}",
+        f"{args=}",
+        f"{logs_keep=}",
+    ]
+    LOGGER.info(log_func_call(setup_cronjob, *variables))
     if SYSTEM != "linux":
         msg = f"System must be 'linux'; got {SYSTEM!r}"
         raise TypeError(msg)

actions/tag_commit/lib.py

@@ -3,13 +3,11 @@ from __future__ import annotations
 from contextlib import suppress
 from subprocess import CalledProcessError
 
-from utilities.text import strip_and_dedent
 from utilities.version import parse_version
 
-from actions import __version__
 from actions.logging import LOGGER
 from actions.tag_commit.settings import SETTINGS
-from actions.utilities import logged_run
+from actions.utilities import log_func_call, logged_run
 
 
 def tag_commit(
@@ -20,23 +18,14 @@ def tag_commit(
     major: bool = SETTINGS.major,
     latest: bool = SETTINGS.latest,
 ) -> None:
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-             - user_name   = %s
-             - user_email  = %s
-             - major_minor = %s
-             - major       = %s
-             - latest      = %s
-        """),
-        tag_commit.__name__,
-        __version__,
-        user_name,
-        user_email,
-        major_minor,
-        major,
-        latest,
-    )
+    variables = [
+        f"{user_name=}",
+        f"{user_email=}",
+        f"{major_minor=}",
+        f"{major=}",
+        f"{latest=}",
+    ]
+    LOGGER.info(log_func_call(tag_commit, *variables))
     logged_run("git", "config", "--global", "user.name", user_name)
     logged_run("git", "config", "--global", "user.email", user_email)
     version = parse_version(

actions/utilities.py

@@ -2,17 +2,22 @@ from __future__ import annotations
 
 from io import StringIO
 from pathlib import Path
+from textwrap import indent
 from typing import TYPE_CHECKING, Any, Literal, assert_never, overload
 
+from tabulate import tabulate
 from typed_settings import EnvLoader, Secret
 from utilities.atomicwrites import writer
+from utilities.functions import get_func_name
 from utilities.subprocess import run
+from utilities.text import split_str
 
+from actions import __version__
 from actions.constants import YAML_INSTANCE
 from actions.logging import LOGGER
 
 if TYPE_CHECKING:
-    from collections.abc import MutableSet
+    from collections.abc import Callable, MutableSet
 
     from utilities.types import PathLike, StrStrMapping
 
@@ -82,6 +87,17 @@ def ensure_new_line(text: str, /) -> str:
     return text.strip("\n") + "\n"
 
 
+def log_func_call(func: Callable[..., Any], /, *variables: str) -> str:
+    name = get_func_name(func)
+    table = tabulate(
+        list(map(split_f_str_equals, variables)), tablefmt="rounded_outline"
+    )
+    indented = indent(table, "  ")
+    return f"""
+Running {name!r} (version {__version__}) with:
+{indented}"""
+
+
 @overload
 def logged_run(
     cmd: SecretLike,
@@ -131,6 +147,11 @@ def logged_run(
     return run(*unwrapped, env=env, print=print, return_=return_, logger=LOGGER)
 
 
+def split_f_str_equals(text: str, /) -> tuple[str, str]:
+    """Split an `f`-string with `=`."""
+    return split_str(text, separator="=", n=2)
+
+
 def write_text(
     path: PathLike, text: str, /, *, modifications: MutableSet[Path] | None = None
 ) -> None:
@@ -159,6 +180,7 @@ __all__ = [
     "copy_text",
     "ensure_new_line",
     "logged_run",
+    "split_f_str_equals",
     "write_text",
     "yaml_dump",
 ]

{dycw_actions-0.8.5.dist-info → dycw_actions-0.8.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dycw-actions
-Version: 0.8.5
+Version: 0.8.11
 Summary: Library of actions
 Requires-Dist: click>=8.3.1,<9
 Requires-Dist: dycw-utilities>=0.179.0,<1
@@ -12,6 +12,7 @@ Requires-Dist: pyyaml>=6.0.3,<7
 Requires-Dist: requests>=2.32.5,<3
 Requires-Dist: rich>=14.2.0,<15
 Requires-Dist: ruamel-yaml>=0.19.1,<1
+Requires-Dist: tabulate>=0.9.0,<1
 Requires-Dist: tomlkit>=0.13.3,<1
 Requires-Dist: typed-settings[attrs,click]>=25.3.0,<26
 Requires-Dist: xdg-base-dirs>=6.0.2,<7