dycw-actions 0.6.4__py3-none-any.whl → 0.7.7__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.6.4"
+__version__ = "0.7.7"

actions/action_dicts/lib.py

@@ -2,11 +2,11 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
-import actions.publish_package.doc
-import actions.random_sleep.doc
-import actions.run_hooks.doc
-import actions.tag_commit.doc
 from actions.action_dicts.constants import GITHUB_TOKEN, PRERELEASE, RESOLUTION
+from actions.publish_package.constants import PUBLISH_PACKAGE_DOCSTRING
+from actions.random_sleep.constants import RANDOM_SLEEP_DOCSTRING
+from actions.run_hooks.constants import RUN_HOOKS_DOCSTRING
+from actions.tag_commit.constants import TAG_COMMIT_DOCSTRING
 
 if TYPE_CHECKING:
     from actions.types import StrDict
@@ -28,7 +28,7 @@ def run_action_pre_commit_dict(
     dict_["sleep"] = sleep
     return {
         "if": f"{_runner(gitea=gitea)}.event_name == 'pull_request'",
-        "name": actions.run_hooks.doc.DOCSTRING,
+        "name": RUN_HOOKS_DOCSTRING,
         "uses": "dycw/action-run-hooks@latest",
         "with": dict_,
     }
@@ -50,7 +50,7 @@ def run_action_publish_dict(
     _add_boolean(dict_, "trusted-publishing", value=trusted_publishing)
     _add_native_tls(dict_, native_tls=native_tls)
     return {
-        "name": actions.publish_package.doc.DOCSTRING,
+        "name": PUBLISH_PACKAGE_DOCSTRING,
         "uses": "dycw/action-publish-package@latest",
         "with": dict_,
     }
@@ -114,7 +114,7 @@ def run_action_random_sleep_dict(
         "log-freq": log_freq,
     }
     return {
-        "name": actions.random_sleep.doc.DOCSTRING,
+        "name": RANDOM_SLEEP_DOCSTRING,
         "uses": "dycw/action-random-sleep@latest",
         "with": dict_,
     }
@@ -139,7 +139,7 @@ def run_action_tag_dict(
     _add_boolean(dict_, "major", value=major)
     _add_boolean(dict_, "latest", value=latest)
     return {
-        "name": actions.tag_commit.doc.DOCSTRING,
+        "name": TAG_COMMIT_DOCSTRING,
         "uses": "dycw/action-tag-commit@latest",
         "with": dict_,
     }

actions/clean_dir/cli.py

@@ -1,12 +1,9 @@
 from __future__ import annotations
 
-from rich.pretty import pretty_repr
 from typed_settings import click_options
 from utilities.logging import basic_config
 from utilities.os import is_pytest
-from utilities.text import strip_and_dedent
 
-from actions import __version__
 from actions.clean_dir.lib import clean_dir
 from actions.clean_dir.settings import Settings
 from actions.logging import LOGGER
@@ -18,15 +15,6 @@ def clean_dir_sub_cmd(settings: Settings, /) -> None:
     if is_pytest():
         return
     basic_config(obj=LOGGER)
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-            %s
-        """),
-        clean_dir.__name__,
-        __version__,
-        pretty_repr(settings),
-    )
     clean_dir(dir_=settings.dir)
 
 

actions/clean_dir/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+CLEAN_DIR_DOCSTRING = "Clean a directory"
+CLEAN_DIR_SUB_CMD = "clean-dir"
+
+
+__all__ = ["CLEAN_DIR_DOCSTRING", "CLEAN_DIR_SUB_CMD"]

actions/clean_dir/lib.py

@@ -17,6 +17,7 @@ if TYPE_CHECKING:
 
 
 def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
+    """Clean a directory."""
     LOGGER.info(
         strip_and_dedent("""
             Running '%s' (version %s) with settings:

actions/cli.py

@@ -3,57 +3,118 @@ from __future__ import annotations
 from click import group
 from utilities.click import CONTEXT_SETTINGS
 
-import actions.publish_package.doc
-import actions.random_sleep.doc
-import actions.run_hooks.doc
-import actions.tag_commit.doc
 from actions.clean_dir.cli import clean_dir_sub_cmd
-from actions.conformalize_repo.cli import conformalize_repo_sub_cmd
-from actions.format_requirements.cli import format_requirements_sub_cmd
+from actions.clean_dir.constants import CLEAN_DIR_SUB_CMD
+from actions.pre_commit.conformalize_repo.cli import conformalize_repo_sub_cmd
+from actions.pre_commit.conformalize_repo.constants import (
+    CONFORMALIZE_REPO_DOCSTRING,
+    CONFORMALIZE_REPO_SUB_CMD,
+)
+from actions.pre_commit.format_requirements.cli import format_requirements_sub_cmd
+from actions.pre_commit.format_requirements.constants import (
+    FORMAT_REQUIREMENTS_DOCSTRING,
+    FORMAT_REQUIREMENTS_SUB_CMD,
+)
+from actions.pre_commit.replace_sequence_strs.cli import replace_sequence_strs_sub_cmd
+from actions.pre_commit.replace_sequence_strs.constants import (
+    REPLACE_SEQUENCE_STRS_DOCSTRING,
+    REPLACE_SEQUENCE_STRS_SUB_CMD,
+)
+from actions.pre_commit.touch_empty_py.cli import touch_empty_py_sub_cmd
+from actions.pre_commit.touch_empty_py.constants import (
+    TOUCH_EMPTY_PY_DOCSTRING,
+    TOUCH_EMPTY_PY_SUB_CMD,
+)
+from actions.pre_commit.touch_py_typed.cli import touch_py_typed_sub_cmd
+from actions.pre_commit.touch_py_typed.constants import (
+    TOUCH_PY_TYPED_DOCSTRING,
+    TOUCH_PY_TYPED_SUB_CMD,
+)
+from actions.pre_commit.update_requirements.cli import update_requirements_sub_cmd
+from actions.pre_commit.update_requirements.constants import (
+    UPDATE_REQUIREMENTS_DOCSTRING,
+    UPDATE_REQUIREMENTS_SUB_CMD,
+)
 from actions.publish_package.cli import publish_package_sub_cmd
+from actions.publish_package.constants import (
+    PUBLISH_PACKAGE_DOCSTRING,
+    PUBLISH_PACKAGE_SUB_CMD,
+)
 from actions.random_sleep.cli import random_sleep_sub_cmd
-from actions.replace_sequence_strs.cli import sequence_strs_sub_cmd
+from actions.random_sleep.constants import RANDOM_SLEEP_DOCSTRING, RANDOM_SLEEP_SUB_CMD
+from actions.register_gitea_runner.cli import register_gitea_runner_sub_cmd
+from actions.register_gitea_runner.constants import (
+    REGISTER_GITEA_RUNNER_DOCSTRING,
+    REGISTER_GITEA_RUNNER_SUB_CMD,
+)
 from actions.run_hooks.cli import run_hooks_sub_cmd
+from actions.run_hooks.constants import RUN_HOOKS_DOCSTRING, RUN_HOOKS_SUB_CMD
 from actions.setup_cronjob.cli import setup_cronjob_sub_cmd
+from actions.setup_cronjob.constants import (
+    SETUP_CRONJOB_DOCSTRING,
+    SETUP_CRONJOB_SUB_CMD,
+)
 from actions.tag_commit.cli import tag_commit_sub_cmd
+from actions.tag_commit.constants import TAG_COMMIT_DOCSTRING, TAG_COMMIT_SUB_CMD
 
 
 @group(**CONTEXT_SETTINGS)
 def _main() -> None: ...
 
 
-_ = _main.command(name="clean-dir", help="Clean a directory", **CONTEXT_SETTINGS)(
+_ = _main.command(name=CLEAN_DIR_SUB_CMD, help=CLEAN_DIR_SUB_CMD, **CONTEXT_SETTINGS)(
     clean_dir_sub_cmd
 )
 _ = _main.command(
-    name="conformalize-repo", help="Conformalize a repo", **CONTEXT_SETTINGS
-)(conformalize_repo_sub_cmd)
-_ = _main.command(
-    name="format-requirements", help="Format a set of requirements", **CONTEXT_SETTINGS
-)(format_requirements_sub_cmd)
-_ = _main.command(
-    name="publish-package",
-    help=actions.publish_package.doc.DOCSTRING,
-    **CONTEXT_SETTINGS,
+    name=PUBLISH_PACKAGE_SUB_CMD, help=PUBLISH_PACKAGE_DOCSTRING, **CONTEXT_SETTINGS
 )(publish_package_sub_cmd)
+_ = _main.command(name=RUN_HOOKS_SUB_CMD, help=RUN_HOOKS_DOCSTRING, **CONTEXT_SETTINGS)(
+    run_hooks_sub_cmd
+)
+_ = _main.command(
+    name=RANDOM_SLEEP_SUB_CMD, help=RANDOM_SLEEP_DOCSTRING, **CONTEXT_SETTINGS
+)(random_sleep_sub_cmd)
 _ = _main.command(
-    name="replace-sequence-strs",
-    help="Replace 'Sequence[str]' with 'list[str]'",
+    name=REGISTER_GITEA_RUNNER_SUB_CMD,
+    help=REGISTER_GITEA_RUNNER_DOCSTRING,
     **CONTEXT_SETTINGS,
-)(sequence_strs_sub_cmd)
+)(register_gitea_runner_sub_cmd)
 _ = _main.command(
-    name="run-hooks", help=actions.run_hooks.doc.DOCSTRING, **CONTEXT_SETTINGS
-)(run_hooks_sub_cmd)
+    name=SETUP_CRONJOB_SUB_CMD, help=SETUP_CRONJOB_DOCSTRING, **CONTEXT_SETTINGS
+)(setup_cronjob_sub_cmd)
 _ = _main.command(
-    name="random-sleep", help=actions.random_sleep.doc.DOCSTRING, **CONTEXT_SETTINGS
-)(random_sleep_sub_cmd)
-_ = _main.command(name="setup-cronjob", help="Setup a cronjob", **CONTEXT_SETTINGS)(
-    setup_cronjob_sub_cmd
-)
-_ = _main.command(
-    name="tag-commit", help=actions.tag_commit.doc.DOCSTRING, **CONTEXT_SETTINGS
+    name=TAG_COMMIT_SUB_CMD, help=TAG_COMMIT_DOCSTRING, **CONTEXT_SETTINGS
 )(tag_commit_sub_cmd)
 
 
+@_main.group(name="pre-commit", help="Pre-commit hooks", **CONTEXT_SETTINGS)
+def pre_commit_sub_cmd() -> None: ...
+
+
+_ = pre_commit_sub_cmd.command(
+    name=CONFORMALIZE_REPO_SUB_CMD, help=CONFORMALIZE_REPO_DOCSTRING, **CONTEXT_SETTINGS
+)(conformalize_repo_sub_cmd)
+_ = pre_commit_sub_cmd.command(
+    name=FORMAT_REQUIREMENTS_SUB_CMD,
+    help=FORMAT_REQUIREMENTS_DOCSTRING,
+    **CONTEXT_SETTINGS,
+)(format_requirements_sub_cmd)
+_ = pre_commit_sub_cmd.command(
+    name=REPLACE_SEQUENCE_STRS_SUB_CMD,
+    help=REPLACE_SEQUENCE_STRS_DOCSTRING,
+    **CONTEXT_SETTINGS,
+)(replace_sequence_strs_sub_cmd)
+_ = pre_commit_sub_cmd.command(
+    name=TOUCH_EMPTY_PY_SUB_CMD, help=TOUCH_EMPTY_PY_DOCSTRING, **CONTEXT_SETTINGS
+)(touch_empty_py_sub_cmd)
+_ = pre_commit_sub_cmd.command(
+    name=TOUCH_PY_TYPED_SUB_CMD, help=TOUCH_PY_TYPED_DOCSTRING, **CONTEXT_SETTINGS
+)(touch_py_typed_sub_cmd)
+_ = pre_commit_sub_cmd.command(
+    name=UPDATE_REQUIREMENTS_SUB_CMD,
+    help=UPDATE_REQUIREMENTS_DOCSTRING,
+    **CONTEXT_SETTINGS,
+)(update_requirements_sub_cmd)
+
 if __name__ == "__main__":
     _main()

actions/constants.py

@@ -2,9 +2,13 @@ from __future__ import annotations
 
 from ruamel.yaml import YAML
 from utilities.importlib import files
+from utilities.pathlib import get_repo_root
+from xdg_base_dirs import xdg_cache_home
 
 PATH_ACTIONS = files(anchor="actions")
+PATH_CACHE = xdg_cache_home() / "actions"
+PATH_THROTTLE_CACHE = PATH_CACHE / "throttle" / get_repo_root().name
 YAML_INSTANCE = YAML()
 
 
-__all__ = ["PATH_ACTIONS", "YAML_INSTANCE"]
+__all__ = ["PATH_ACTIONS", "PATH_CACHE", "PATH_THROTTLE_CACHE", "YAML_INSTANCE"]

actions/pre_commit/click.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+from click import argument
+
+path_argument = argument(
+    "paths",
+    nargs=-1,
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+)
+
+
+__all__ = ["path_argument"]

actions/{conformalize_repo → pre_commit/conformalize_repo}/cli.py

@@ -1,15 +1,12 @@
 from __future__ import annotations
 
-from rich.pretty import pretty_repr
 from typed_settings import click_options
 from utilities.logging import basic_config
 from utilities.os import is_pytest
-from utilities.text import strip_and_dedent
 
-from actions import __version__
-from actions.conformalize_repo.lib import conformalize_repo
-from actions.conformalize_repo.settings import Settings
 from actions.logging import LOGGER
+from actions.pre_commit.conformalize_repo.lib import conformalize_repo
+from actions.pre_commit.conformalize_repo.settings import Settings
 from actions.utilities import LOADER
 
 
@@ -18,15 +15,6 @@ def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
     if is_pytest():
         return
     basic_config(obj=LOGGER)
-    LOGGER.info(
-        strip_and_dedent("""
-            Running '%s' (version %s) with settings:
-            %s
-        """),
-        conformalize_repo.__name__,
-        __version__,
-        pretty_repr(settings),
-    )
     conformalize_repo(
         coverage=settings.coverage,
         description=settings.description,

actions/{conformalize_repo → pre_commit/conformalize_repo}/constants.py

@@ -6,7 +6,7 @@ from re import search
 from utilities.pathlib import get_repo_root
 from utilities.pytest import IS_CI
 
-from actions.constants import PATH_ACTIONS
+from actions.pre_commit.constants import PATH_PRE_COMMIT
 
 ACTIONS_URL = "https://github.com/dycw/actions"
 DOCKERFMT_URL = "https://github.com/reteps/dockerfmt"
@@ -31,6 +31,10 @@ REPO_ROOT = get_repo_root()
 RUFF_TOML = Path("ruff.toml")
 
 
+CONFORMALIZE_REPO_DOCSTRING = "Conformalize a repo"
+CONFORMALIZE_REPO_SUB_CMD = "conformalize-repo"
+
+
 MAX_PYTHON_VERSION = "3.14"
 
 
@@ -40,12 +44,14 @@ RUN_VERSION_BUMP = (search("template", str(REPO_ROOT)) is None) and not IS_CI
 GITHUB_WORKFLOWS = Path(".github/workflows")
 GITHUB_PULL_REQUEST_YAML = GITHUB_WORKFLOWS / "pull-request.yaml"
 GITHUB_PUSH_YAML = GITHUB_WORKFLOWS / "push.yaml"
-PATH_CONFIGS = PATH_ACTIONS / "conformalize_repo/configs"
+PATH_CONFIGS = PATH_PRE_COMMIT / "conformalize_repo/configs"
 
 
 __all__ = [
     "ACTIONS_URL",
     "BUMPVERSION_TOML",
+    "CONFORMALIZE_REPO_DOCSTRING",
+    "CONFORMALIZE_REPO_SUB_CMD",
     "COVERAGERC_TOML",
     "DOCKERFMT_URL",
     "ENVRC",