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

actions/conformalize_repo/settings.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+from typed_settings import load_settings, option, settings
+
+from actions.conformalize_repo.constants import RUN_VERSION_BUMP
+from actions.utilities import LOADER
+
+
+@settings
+class Settings:
+    coverage: bool = option(default=False, help="Set up '.coveragerc.toml'")
+    description: str | None = option(default=None, help="Repo description")
+    envrc: bool = option(default=False, help="Set up '.envrc'")
+    envrc__uv: bool = option(default=False, help="Set up '.envrc' with uv")
+    envrc__uv__native_tls: bool = option(
+        default=False, help="Set up '.envrc' with uv native TLS"
+    )
+    github__pull_request__pre_commit: bool = option(
+        default=False, help="Set up 'pull-request.yaml' pre-commit"
+    )
+    github__pull_request__pre_commit__gitea: bool = option(
+        default=False, help="Set up 'pull-request.yaml' for Gitea"
+    )
+    github__pull_request__pyright: bool = option(
+        default=False, help="Set up 'pull-request.yaml' pyright"
+    )
+    github__pull_request__pytest__macos: bool = option(
+        default=False, help="Set up 'pull-request.yaml' pytest with MacOS"
+    )
+    github__pull_request__pytest__ubuntu: bool = option(
+        default=False, help="Set up 'pull-request.yaml' pytest with Ubuntu"
+    )
+    github__pull_request__pytest__windows: bool = option(
+        default=False, help="Set up 'pull-request.yaml' pytest with Windows"
+    )
+    github__pull_request__ruff: bool = option(
+        default=False, help="Set up 'pull-request.yaml' ruff"
+    )
+    github__push__publish: bool = option(
+        default=False, help="Set up 'push.yaml' publishing"
+    )
+    github__push__tag: bool = option(default=False, help="Set up 'push.yaml' tagging")
+    github__push__tag__major: bool = option(
+        default=False, help="Set up 'push.yaml' with the 'major' tag"
+    )
+    github__push__tag__major_minor: bool = option(
+        default=False, help="Set up 'push.yaml' with the 'major.minor' tag"
+    )
+    github__push__tag__latest: bool = option(
+        default=False, help="Set up 'push.yaml' tagging"
+    )
+    gitignore: bool = option(default=False, help="Set up '.gitignore'")
+    package_name: str | None = option(default=None, help="Package name")
+    pre_commit__dockerfmt: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' dockerfmt"
+    )
+    pre_commit__prettier: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' prettier"
+    )
+    pre_commit__python: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' python"
+    )
+    pre_commit__ruff: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' ruff"
+    )
+    pre_commit__shell: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' shell"
+    )
+    pre_commit__taplo: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' taplo"
+    )
+    pre_commit__uv: bool = option(
+        default=False, help="Set up '.pre-commit-config.yaml' uv"
+    )
+    pre_commit__uv__script: str | None = option(
+        default=None, help="Set up '.pre-commit-config.yaml' uv lock script"
+    )
+    pyproject: bool = option(default=False, help="Set up 'pyproject.toml'")
+    pyproject__project__optional_dependencies__scripts: bool = option(
+        default=False,
+        help="Set up 'pyproject.toml' [project.optional-dependencies.scripts]",
+    )
+    pyproject__tool__uv__indexes: list[tuple[str, str]] = option(
+        factory=list, help="Set up 'pyproject.toml' [[uv.tool.index]]"
+    )
+    pyright: bool = option(default=False, help="Set up 'pyrightconfig.json'")
+    pytest: bool = option(default=False, help="Set up 'pytest.toml'")
+    pytest__asyncio: bool = option(default=False, help="Set up 'pytest.toml' asyncio_*")
+    pytest__ignore_warnings: bool = option(
+        default=False, help="Set up 'pytest.toml' filterwarnings"
+    )
+    pytest__timeout: int | None = option(
+        default=None, help="Set up 'pytest.toml' timeout"
+    )
+    python_package_name: str | None = option(
+        default=None, help="Python package name override"
+    )
+    python_version: str = option(default="3.14", help="Python version")
+    readme: bool = option(default=False, help="Set up 'README.md'")
+    repo_name: str | None = option(default=None, help="Repo name")
+    ruff: bool = option(default=False, help="Set up 'ruff.toml'")
+    run_version_bump: bool = option(default=RUN_VERSION_BUMP, help="Run version bump")
+    script: str | None = option(
+        default=None, help="Set up a script instead of a package"
+    )
+
+    @property
+    def python_package_name_use(self) -> str | None:
+        if self.python_package_name is not None:
+            return self.python_package_name
+        if self.package_name is not None:
+            return self.package_name.replace("-", "_")
+        return None
+
+
+SETTINGS = load_settings(Settings, [LOADER])
+
+
+__all__ = ["SETTINGS", "Settings"]

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/format_requirements/__init__.py

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

actions/format_requirements/cli.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+from click import argument
+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.format_requirements.lib import format_requirements
+from actions.logging import LOGGER
+
+
+@argument(
+    "paths",
+    nargs=-1,
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+)
+def format_requirements_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        format_requirements.__name__,
+        __version__,
+        paths,
+    )
+    format_requirements(*paths)
+
+
+__all__ = ["format_requirements_sub_cmd"]

actions/format_requirements/lib.py

@@ -0,0 +1,121 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, override
+
+from packaging._tokenizer import ParserSyntaxError
+from packaging.requirements import InvalidRequirement, Requirement, _parse_requirement
+from packaging.specifiers import Specifier, SpecifierSet
+from tomlkit import TOMLDocument, array, dumps, loads, string
+from tomlkit.items import Array, Table
+from utilities.text import repr_str, strip_and_dedent
+
+from actions import __version__
+from actions.logging import LOGGER
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from utilities.types import PathLike
+
+
+_MODIFICATIONS: set[Path] = set()
+
+
+def format_requirements(*paths: PathLike) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        format_requirements.__name__,
+        __version__,
+        paths,
+    )
+    for path in paths:
+        _format_path(path)
+    if len(_MODIFICATIONS) >= 1:
+        LOGGER.info(
+            "Exiting due to modifications: %s",
+            ", ".join(map(repr_str, sorted(_MODIFICATIONS))),
+        )
+        sys.exit(1)
+
+
+def _format_path(path: PathLike, /) -> None:
+    path = Path(path)
+    current = loads(path.read_text())
+    expected = _get_formatted(path)
+    is_equal = current == expected  # tomlkit cannot handle !=
+    if not is_equal:
+        _ = path.write_text(dumps(expected).rstrip("\n") + "\n")
+        _MODIFICATIONS.add(path)
+
+
+def _get_formatted(path: PathLike, /) -> TOMLDocument:
+    path = Path(path)
+    doc = loads(path.read_text())
+    if isinstance(dep_grps := doc.get("dependency-groups"), Table):
+        for key, value in dep_grps.items():
+            if isinstance(value, Array):
+                dep_grps[key] = _format_array(value)
+    if isinstance(project := doc["project"], Table):
+        if isinstance(deps := project["dependencies"], Array):
+            project["dependencies"] = _format_array(deps)
+        if isinstance(optional := project.get("optional-dependencies"), Table):
+            for key, value in optional.items():
+                if isinstance(value, Array):
+                    optional[key] = _format_array(value)
+    return doc
+
+
+def _format_array(dependencies: Array, /) -> Array:
+    new = array().multiline(multiline=True)
+    new.extend(map(_format_item, dependencies))
+    return new
+
+
+def _format_item(item: Any, /) -> Any:
+    if not isinstance(item, str):
+        return item
+    return string(str(_CustomRequirement(item)))
+
+
+class _CustomRequirement(Requirement):
+    @override
+    def __init__(self, requirement_string: str) -> None:
+        super().__init__(requirement_string)
+        try:
+            parsed = _parse_requirement(requirement_string)
+        except ParserSyntaxError as e:
+            raise InvalidRequirement(str(e)) from e
+        self.specifier = _CustomSpecifierSet(parsed.specifier)
+
+    @override
+    def _iter_parts(self, name: str) -> Iterator[str]:
+        yield name
+        if self.extras:
+            formatted_extras = ",".join(sorted(self.extras))
+            yield f"[{formatted_extras}]"
+        if self.specifier:
+            yield f" {self.specifier}"
+        if self.url:
+            yield f"@ {self.url}"
+            if self.marker:
+                yield " "
+        if self.marker:
+            yield f"; {self.marker}"
+
+
+class _CustomSpecifierSet(SpecifierSet):
+    @override
+    def __str__(self) -> str:
+        specs = sorted(self._specs, key=self._key)
+        return ", ".join(map(str, specs))
+
+    def _key(self, spec: Specifier, /) -> int:
+        return [">=", "<"].index(spec.operator)
+
+
+__all__ = ["format_requirements"]

actions/publish_package/__init__.py

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

actions/{publish → publish_package}/cli.py

@@ -8,27 +8,23 @@ from utilities.text import strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
-from actions.publish.lib import publish_package
-from actions.publish.settings import PublishSettings
-from actions.settings import CommonSettings
+from actions.publish_package.lib import publish_package
+from actions.publish_package.settings import Settings
 from actions.utilities import LOADER
 
 
-@click_options(CommonSettings, [LOADER], show_envvars_in_help=True, argname="common")
-@click_options(PublishSettings, [LOADER], show_envvars_in_help=True, argname="publish")
-def publish_sub_cmd(*, common: CommonSettings, publish: PublishSettings) -> None:
+@click_options(Settings, [LOADER], show_envvars_in_help=True, argname="publish")
+def publish_package_sub_cmd(*, publish: Settings) -> None:
     if is_pytest():
         return
     basic_config(obj=LOGGER)
     LOGGER.info(
         strip_and_dedent("""
-            Running '%r' (version %s) with settings:
-            %s
+            Running '%s' (version %s) with settings:
             %s
         """),
         publish_package.__name__,
         __version__,
-        pretty_repr(common),
         pretty_repr(publish),
     )
     publish_package(
@@ -40,4 +36,4 @@ def publish_sub_cmd(*, common: CommonSettings, publish: PublishSettings) -> None
     )
 
 
-__all__ = ["publish_sub_cmd"]
+__all__ = ["publish_package_sub_cmd"]

actions/publish_package/doc.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+DOCSTRING = "Build and publish the package"
+
+
+__all__ = ["DOCSTRING"]

actions/{publish → publish_package}/lib.py

@@ -3,10 +3,11 @@ 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.settings import PUBLISH_SETTINGS
+from actions.publish_package.settings import SETTINGS
 from actions.utilities import log_run
 
 if TYPE_CHECKING:
@@ -15,21 +16,21 @@ if TYPE_CHECKING:
 
 def publish_package(
     *,
-    username: str | None = PUBLISH_SETTINGS.username,
-    password: Secret[str] | None = PUBLISH_SETTINGS.password,
-    publish_url: str | None = PUBLISH_SETTINGS.publish_url,
-    trusted_publishing: bool = PUBLISH_SETTINGS.trusted_publishing,
-    native_tls: bool = PUBLISH_SETTINGS.native_tls,
+    username: str | None = SETTINGS.username,
+    password: Secret[str] | None = SETTINGS.password,
+    publish_url: str | None = SETTINGS.publish_url,
+    trusted_publishing: bool = SETTINGS.trusted_publishing,
+    native_tls: bool = SETTINGS.native_tls,
 ) -> None:
     LOGGER.info(
-        """\
-Running %r (version %s) with settings:
- - username           = %s
- - password           = %s
- - publish_url        = %s
- - trusted_publishing = %s
- - native_tls         = %s
- """,
+        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,
@@ -39,8 +40,8 @@ Running %r (version %s) with settings:
         native_tls,
     )
     with TemporaryDirectory() as temp:
-        _ = log_run("uv", "build", "--out-dir", str(temp), "--wheel", "--clear")
-        _ = log_run(
+        log_run("uv", "build", "--out-dir", str(temp), "--wheel", "--clear")
+        log_run(
             "uv",
             "publish",
             *([] if username is None else ["--username", username]),

actions/{publish → publish_package}/settings.py

@@ -2,19 +2,19 @@ from __future__ import annotations
 
 from typed_settings import Secret, load_settings, option, secret, settings
 
-from actions.utilities import LOADER, empty_str_to_none
+from actions.utilities import LOADER, convert_secret_str, convert_str
 
 
 @settings
-class PublishSettings:
+class Settings:
     username: str | None = option(
-        default=None, converter=empty_str_to_none, help="The username of the upload"
+        default=None, converter=convert_str, help="The username of the upload"
     )
     password: Secret[str] | None = secret(
-        default=None, converter=empty_str_to_none, help="The password for the upload"
+        default=None, converter=convert_secret_str, help="The password for the upload"
     )
     publish_url: str | None = option(
-        default=None, converter=empty_str_to_none, help="The URL of the upload endpoint"
+        default=None, converter=convert_str, help="The URL of the upload endpoint"
     )
     trusted_publishing: bool = option(
         default=False, help="Configure trusted publishing"
@@ -25,7 +25,7 @@ class PublishSettings:
     )
 
 
-PUBLISH_SETTINGS = load_settings(PublishSettings, [LOADER])
+SETTINGS = load_settings(Settings, [LOADER])
 
 
-__all__ = ["PUBLISH_SETTINGS", "PublishSettings"]
+__all__ = ["SETTINGS", "Settings"]

actions/random_sleep/__init__.py

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

actions/{sleep → random_sleep}/cli.py

@@ -8,27 +8,23 @@ from utilities.text import strip_and_dedent
 
 from actions import __version__
 from actions.logging import LOGGER
-from actions.settings import CommonSettings
-from actions.sleep.lib import random_sleep
-from actions.sleep.settings import SleepSettings
+from actions.random_sleep.lib import random_sleep
+from actions.random_sleep.settings import Settings
 from actions.utilities import LOADER
 
 
-@click_options(CommonSettings, [LOADER], show_envvars_in_help=True, argname="common")
-@click_options(SleepSettings, [LOADER], show_envvars_in_help=True, argname="sleep")
-def sleep_sub_cmd(*, common: CommonSettings, sleep: SleepSettings) -> None:
+@click_options(Settings, [LOADER], show_envvars_in_help=True, argname="sleep")
+def random_sleep_sub_cmd(*, sleep: Settings) -> None:
     if is_pytest():
         return
     basic_config(obj=LOGGER)
     LOGGER.info(
         strip_and_dedent("""
-            Running '%r' (version %s) with settings:
-            %s
+            Running '%s' (version %s) with settings:
             %s
         """),
         random_sleep.__name__,
         __version__,
-        pretty_repr(common),
         pretty_repr(sleep),
     )
     random_sleep(
@@ -36,4 +32,4 @@ def sleep_sub_cmd(*, common: CommonSettings, sleep: SleepSettings) -> None:
     )
 
 
-__all__ = ["sleep_sub_cmd"]
+__all__ = ["random_sleep_sub_cmd"]

actions/random_sleep/doc.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+DOCSTRING = "Random sleep with logging"
+
+
+__all__ = ["DOCSTRING"]

actions/{sleep → random_sleep}/lib.py

@@ -4,29 +4,30 @@ 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.sleep.settings import SLEEP_SETTINGS
+from actions.random_sleep.settings import SETTINGS
 
 
 def random_sleep(
     *,
-    min_: int = SLEEP_SETTINGS.min,
-    max_: int = SLEEP_SETTINGS.max,
-    step: int = SLEEP_SETTINGS.step,
-    log_freq: int = SLEEP_SETTINGS.log_freq,
+    min_: int = SETTINGS.min,
+    max_: int = SETTINGS.max,
+    step: int = SETTINGS.step,
+    log_freq: int = SETTINGS.log_freq,
 ) -> None:
     LOGGER.info(
-        """\
-Running %r (version %s) with settings:
- - min_     = %s
- - max_     = %s
- - step     = %s
- - log_freq = %s
-""",
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - min_     = %s
+             - max_     = %s
+             - step     = %s
+             - log_freq = %s
+        """),
         random_sleep.__name__,
         __version__,
         min_,
@@ -49,7 +50,7 @@ def _intermediate(
     end: ZonedDateTime,
     /,
     *,
-    log_freq: int = SLEEP_SETTINGS.log_freq,
+    log_freq: int = SETTINGS.log_freq,
 ) -> None:
     elapsed = TimeDelta(seconds=floor((now - start).in_seconds()))
     remaining = TimeDelta(seconds=ceil((end - now).in_seconds()))

actions/{sleep → random_sleep}/settings.py

@@ -6,14 +6,14 @@ from actions.utilities import LOADER
 
 
 @settings
-class SleepSettings:
+class Settings:
     min: int = option(default=0, help="Minimum duration, in seconds")
     max: int = option(default=3600, help="Maximum duration, in seconds")
     step: int = option(default=1, help="Step duration, in seconds")
     log_freq: int = option(default=60, help="Log frequency, in seconds")
 
 
-SLEEP_SETTINGS = load_settings(SleepSettings, [LOADER])
+SETTINGS = load_settings(Settings, [LOADER])
 
 
-__all__ = ["SLEEP_SETTINGS", "SleepSettings"]
+__all__ = ["SETTINGS", "Settings"]

actions/replace_sequence_strs/__init__.py

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

actions/replace_sequence_strs/cli.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+from click import argument
+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.logging import LOGGER
+from actions.replace_sequence_strs.lib import replace_sequence_strs
+
+
+@argument(
+    "paths",
+    nargs=-1,
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+)
+def sequence_strs_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        replace_sequence_strs.__name__,
+        __version__,
+        paths,
+    )
+    replace_sequence_strs(*paths)
+
+
+__all__ = ["sequence_strs_sub_cmd"]

actions/replace_sequence_strs/lib.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import TYPE_CHECKING, override
+
+from libcst import CSTTransformer, Module, Name, Subscript, parse_module
+from libcst.matchers import Index as MIndex
+from libcst.matchers import Name as MName
+from libcst.matchers import Subscript as MSubscript
+from libcst.matchers import SubscriptElement as MSubscriptElement
+from libcst.matchers import matches
+from libcst.metadata import MetadataWrapper
+from utilities.text import repr_str, strip_and_dedent
+
+from actions import __version__
+from actions.logging import LOGGER
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike
+
+
+_MODIFICATIONS: set[Path] = set()
+
+
+def replace_sequence_strs(*paths: PathLike) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        replace_sequence_strs.__name__,
+        __version__,
+        paths,
+    )
+    for path in paths:
+        _format_path(path)
+    if len(_MODIFICATIONS) >= 1:
+        LOGGER.info(
+            "Exiting due to modifications: %s",
+            ", ".join(map(repr_str, sorted(_MODIFICATIONS))),
+        )
+        sys.exit(1)
+
+
+def _format_path(path: PathLike, /) -> None:
+    path = Path(path)
+    current = parse_module(path.read_text())
+    expected = _get_formatted(path)
+    if current.code != expected.code:
+        _ = path.write_text(expected.code.rstrip("\n") + "\n")
+        _MODIFICATIONS.add(path)
+
+
+def _get_formatted(path: PathLike, /) -> Module:
+    path = Path(path)
+    existing = path.read_text()
+    wrapper = MetadataWrapper(parse_module(existing))
+    return wrapper.module.visit(SequenceToListTransformer())
+
+
+class SequenceToListTransformer(CSTTransformer):
+    @override
+    def leave_Subscript(
+        self, original_node: Subscript, updated_node: Subscript
+    ) -> Subscript:
+        _ = original_node
+        if matches(
+            updated_node,
+            MSubscript(
+                value=MName("Sequence"),
+                slice=[MSubscriptElement(slice=MIndex(value=MName("str")))],
+            ),
+        ):
+            return updated_node.with_changes(value=Name("list"))
+        return updated_node
+
+
+__all__ = ["replace_sequence_strs"]