dycw-actions 0.3.2__py3-none-any.whl → 0.7.1__py3-none-any.whl

actions/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.3.2"
+__version__ = "0.7.1"

actions/action_dicts/constants.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+GITHUB_TOKEN = "${{github.token}}"  # noqa: S105
+PRERELEASE = "disallow"
+RESOLUTION = "highest"
+
+
+__all__ = ["GITHUB_TOKEN", "PRERELEASE", "RESOLUTION"]

actions/action_dicts/lib.py

@@ -0,0 +1,186 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+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
+
+
+def run_action_pre_commit_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    submodules: str | None = None,
+    repos: Any | None = None,
+    hooks: Any | None = None,
+    sleep: int = 1,
+    gitea: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_item(dict_, "submodules", value=submodules)
+    _add_item(dict_, "repos", value=repos)
+    _add_item(dict_, "hooks", value=hooks)
+    dict_["sleep"] = sleep
+    return {
+        "if": f"{_runner(gitea=gitea)}.event_name == 'pull_request'",
+        "name": RUN_HOOKS_DOCSTRING,
+        "uses": "dycw/action-run-hooks@latest",
+        "with": dict_,
+    }
+
+
+def run_action_publish_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    username: str | None = None,
+    password: str | None = None,
+    publish_url: str | None = None,
+    trusted_publishing: bool = False,
+    native_tls: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_item(dict_, "username", value=username)
+    _add_item(dict_, "password", value=password)
+    _add_item(dict_, "publish-url", value=publish_url)
+    _add_boolean(dict_, "trusted-publishing", value=trusted_publishing)
+    _add_native_tls(dict_, native_tls=native_tls)
+    return {
+        "name": PUBLISH_PACKAGE_DOCSTRING,
+        "uses": "dycw/action-publish-package@latest",
+        "with": dict_,
+    }
+
+
+def run_action_pyright_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    python_version: str | None = None,
+    resolution: str = RESOLUTION,
+    prerelease: str = PRERELEASE,
+    native_tls: bool = False,
+    with_requirements: str | None = None,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_python_version(dict_, python_version=python_version)
+    dict_["resolution"] = resolution
+    dict_["prerelease"] = prerelease
+    _add_native_tls(dict_, native_tls=native_tls)
+    _add_with_requirements(dict_, with_requirements=with_requirements)
+    return {
+        "name": "Run 'pyright'",
+        "uses": "dycw/action-pyright@latest",
+        "with": dict_,
+    }
+
+
+def run_action_pytest_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    python_version: str | None = None,
+    sops_age_key: str | None = None,
+    resolution: str = RESOLUTION,
+    prerelease: str = PRERELEASE,
+    native_tls: bool = False,
+    with_requirements: str | None = None,
+) -> StrDict:
+    dict_: StrDict = {"token": token}
+    _add_python_version(dict_, python_version=python_version)
+    _add_item(dict_, "sops-age-key", value=sops_age_key)
+    dict_["resolution"] = resolution
+    dict_["prerelease"] = prerelease
+    _add_native_tls(dict_, native_tls=native_tls)
+    _add_with_requirements(dict_, with_requirements=with_requirements)
+    return {"name": "Run 'pytest'", "uses": "dycw/action-pytest@latest", "with": dict_}
+
+
+def run_action_random_sleep_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    min: int = 0,  # noqa: A002
+    max: int = 3600,  # noqa: A002
+    step: int = 1,
+    log_freq: int = 1,
+) -> StrDict:
+    dict_: StrDict = {
+        "token": token,
+        "min": min,
+        "max": max,
+        "step": step,
+        "log-freq": log_freq,
+    }
+    return {
+        "name": RANDOM_SLEEP_DOCSTRING,
+        "uses": "dycw/action-random-sleep@latest",
+        "with": dict_,
+    }
+
+
+def run_action_ruff_dict(*, token: str = GITHUB_TOKEN) -> StrDict:
+    dict_: StrDict = {"token": token}
+    return {"name": "Run 'ruff'", "uses": "dycw/action-ruff@latest", "with": dict_}
+
+
+def run_action_tag_dict(
+    *,
+    token: str = GITHUB_TOKEN,
+    user_name: str = "github-actions-bot",
+    user_email: str = "noreply@github.com",
+    major_minor: bool = False,
+    major: bool = False,
+    latest: bool = False,
+) -> StrDict:
+    dict_: StrDict = {"token": token, "user-name": user_name, "user-email": user_email}
+    _add_boolean(dict_, "major-minor", value=major_minor)
+    _add_boolean(dict_, "major", value=major)
+    _add_boolean(dict_, "latest", value=latest)
+    return {
+        "name": TAG_COMMIT_DOCSTRING,
+        "uses": "dycw/action-tag-commit@latest",
+        "with": dict_,
+    }
+
+
+def _add_boolean(dict_: StrDict, key: str, /, *, value: bool = False) -> None:
+    if value:
+        dict_[key] = value
+
+
+def _add_item(dict_: StrDict, key: str, /, *, value: Any | None = None) -> None:
+    if value is not None:
+        dict_[key] = value
+
+
+def _add_native_tls(dict_: StrDict, /, *, native_tls: bool = False) -> None:
+    _add_boolean(dict_, "native-tls", value=native_tls)
+
+
+def _add_python_version(
+    dict_: StrDict, /, *, python_version: str | None = None
+) -> None:
+    _add_item(dict_, "python-version", value=python_version)
+
+
+def _add_with_requirements(
+    dict_: StrDict, /, *, with_requirements: str | None = None
+) -> None:
+    _add_item(dict_, "with-requirements", value=with_requirements)
+
+
+def _runner(*, gitea: bool = False) -> str:
+    return "gitea" if gitea else "github"
+
+
+__all__ = [
+    "run_action_pre_commit_dict",
+    "run_action_publish_dict",
+    "run_action_pyright_dict",
+    "run_action_pytest_dict",
+    "run_action_random_sleep_dict",
+    "run_action_ruff_dict",
+    "run_action_tag_dict",
+]

actions/clean_dir/cli.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.clean_dir.lib import clean_dir
+from actions.clean_dir.settings import Settings
+from actions.logging import LOGGER
+from actions.utilities import LOADER
+
+
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def clean_dir_sub_cmd(settings: Settings, /) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    clean_dir(dir_=settings.dir)
+
+
+__all__ = ["clean_dir_sub_cmd"]

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

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from pathlib import Path
+from shutil import rmtree
+from typing import TYPE_CHECKING
+
+from utilities.text import strip_and_dedent
+
+from actions import __version__
+from actions.clean_dir.settings import SETTINGS
+from actions.logging import LOGGER
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from utilities.types import PathLike
+
+
+def clean_dir(*, dir_: PathLike = SETTINGS.dir) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - dir = %s
+        """),
+        clean_dir.__name__,
+        __version__,
+        dir_,
+    )
+    dir_ = Path(dir_)
+    if not dir_.is_dir():
+        msg = f"{str(dir_)!r} is a not a directory"
+        raise NotADirectoryError(msg)
+    while True:
+        files = list(_yield_files(dir_=dir_))
+        if len(files) >= 1:
+            for f in files:
+                f.unlink(missing_ok=True)
+        dirs = list(_yield_dirs(dir_=dir_))
+        if len(dirs) >= 1:
+            for d in dirs:
+                rmtree(d, ignore_errors=True)
+        else:
+            LOGGER.info("Finished cleaning %r", str(dir_))
+            return
+
+
+def _yield_dirs(*, dir_: PathLike = SETTINGS.dir) -> Iterator[Path]:
+    for path in Path(dir_).rglob("**/*"):
+        if path.is_dir() and (len(list(path.iterdir())) == 0):
+            yield path
+
+
+def _yield_files(*, dir_: PathLike = SETTINGS.dir) -> Iterator[Path]:
+    dir_ = Path(dir_)
+    yield from dir_.rglob("**/*.pyc")
+    yield from dir_.rglob("**/*.pyo")
+
+
+__all__ = ["clean_dir"]

actions/clean_dir/settings.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from typed_settings import load_settings, option, settings
+
+from actions.utilities import LOADER
+
+
+@settings
+class Settings:
+    dir: Path = option(default=Path.cwd(), help="The directory to clean")
+
+
+SETTINGS = load_settings(Settings, [LOADER])
+
+
+__all__ = ["SETTINGS", "Settings"]

actions/cli.py

@@ -3,19 +3,108 @@ from __future__ import annotations
 from click import group
 from utilities.click import CONTEXT_SETTINGS
 
-from actions.publish.cli import publish_sub_cmd
-from actions.sleep.cli import sleep_sub_cmd
-from actions.tag.cli import tag_sub_cmd
+from actions.clean_dir.cli import clean_dir_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.random_sleep.constants import RANDOM_SLEEP_DOCSTRING, RANDOM_SLEEP_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="publish", **CONTEXT_SETTINGS)(publish_sub_cmd)
-_ = _main.command(name="sleep", **CONTEXT_SETTINGS)(sleep_sub_cmd)
-_ = _main.command(name="tag", **CONTEXT_SETTINGS)(tag_sub_cmd)
+_ = _main.command(name=CLEAN_DIR_SUB_CMD, help=CLEAN_DIR_SUB_CMD, **CONTEXT_SETTINGS)(
+    clean_dir_sub_cmd
+)
+_ = _main.command(
+    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=SETUP_CRONJOB_SUB_CMD, help=SETUP_CRONJOB_DOCSTRING, **CONTEXT_SETTINGS
+)(setup_cronjob_sub_cmd)
+_ = _main.command(
+    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

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from ruamel.yaml import YAML
+from utilities.importlib import files
+
+PATH_ACTIONS = files(anchor="actions")
+YAML_INSTANCE = YAML()
+
+
+__all__ = ["PATH_ACTIONS", "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/pre_commit/conformalize_repo/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

actions/pre_commit/conformalize_repo/cli.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typed_settings import click_options
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+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
+
+
+@click_options(Settings, [LOADER], show_envvars_in_help=True)
+def conformalize_repo_sub_cmd(settings: Settings, /) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    conformalize_repo(
+        coverage=settings.coverage,
+        description=settings.description,
+        envrc=settings.envrc,
+        envrc__uv=settings.envrc__uv,
+        envrc__uv__native_tls=settings.envrc__uv__native_tls,
+        github__pull_request__pre_commit=settings.github__pull_request__pre_commit,
+        github__pull_request__pre_commit__gitea=settings.github__pull_request__pre_commit__gitea,
+        github__pull_request__pyright=settings.github__pull_request__pyright,
+        github__pull_request__pytest__macos=settings.github__pull_request__pytest__macos,
+        github__pull_request__pytest__ubuntu=settings.github__pull_request__pytest__ubuntu,
+        github__pull_request__pytest__windows=settings.github__pull_request__pytest__windows,
+        github__pull_request__ruff=settings.github__pull_request__ruff,
+        github__push__publish=settings.github__push__publish,
+        github__push__tag=settings.github__push__tag,
+        github__push__tag__major=settings.github__push__tag__major,
+        github__push__tag__major_minor=settings.github__push__tag__major_minor,
+        github__push__tag__latest=settings.github__push__tag__latest,
+        gitignore=settings.gitignore,
+        package_name=settings.package_name,
+        pre_commit__dockerfmt=settings.pre_commit__dockerfmt,
+        pre_commit__prettier=settings.pre_commit__prettier,
+        pre_commit__python=settings.pre_commit__python,
+        pre_commit__ruff=settings.pre_commit__ruff,
+        pre_commit__shell=settings.pre_commit__shell,
+        pre_commit__taplo=settings.pre_commit__taplo,
+        pre_commit__uv=settings.pre_commit__uv,
+        pre_commit__uv__script=settings.pre_commit__uv__script,
+        pyproject=settings.pyproject,
+        pyproject__project__optional_dependencies__scripts=settings.pyproject__project__optional_dependencies__scripts,
+        pyproject__tool__uv__indexes=settings.pyproject__tool__uv__indexes,
+        pyright=settings.pyright,
+        pytest=settings.pytest,
+        pytest__asyncio=settings.pytest__asyncio,
+        pytest__ignore_warnings=settings.pytest__ignore_warnings,
+        pytest__timeout=settings.pytest__timeout,
+        python_package_name=settings.python_package_name,
+        python_version=settings.python_version,
+        readme=settings.readme,
+        repo_name=settings.repo_name,
+        ruff=settings.ruff,
+        run_version_bump=settings.run_version_bump,
+        script=settings.script,
+    )
+
+
+__all__ = ["conformalize_repo_sub_cmd"]