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

actions/pre_commit/conformalize_repo/settings.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+from typed_settings import load_settings, option, settings
+
+from actions.pre_commit.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/pre_commit/constants.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from actions.constants import PATH_ACTIONS
+
+PATH_PRE_COMMIT = PATH_ACTIONS / "pre_commit"
+
+
+__all__ = ["PATH_PRE_COMMIT"]

actions/pre_commit/format_requirements/__init__.py

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

actions/pre_commit/format_requirements/cli.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.pre_commit.click import path_argument
+from actions.pre_commit.format_requirements.lib import format_requirements
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@path_argument
+def format_requirements_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    format_requirements(*paths)
+
+
+__all__ = ["format_requirements_sub_cmd"]

actions/pre_commit/format_requirements/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+FORMAT_REQUIREMENTS_DOCSTRING = "Format a set of requirements"
+FORMAT_REQUIREMENTS_SUB_CMD = "format-requirements"
+
+
+__all__ = ["FORMAT_REQUIREMENTS_DOCSTRING", "FORMAT_REQUIREMENTS_SUB_CMD"]

actions/pre_commit/format_requirements/lib.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+from utilities.text import repr_str, strip_and_dedent
+
+from actions import __version__
+from actions.logging import LOGGER
+from actions.pre_commit.utilities import get_pyproject_dependencies, yield_toml_doc
+
+if TYPE_CHECKING:
+    from collections.abc import MutableSet
+    from pathlib import Path
+
+    from utilities.packaging import Requirement
+    from utilities.types import PathLike
+
+
+def format_requirements(*paths: PathLike) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        format_requirements.__name__,
+        __version__,
+        paths,
+    )
+    modifications: set[Path] = set()
+    for path in paths:
+        _format_path(path, modifications=modifications)
+    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, /, *, modifications: MutableSet[Path] | None = None
+) -> None:
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        get_pyproject_dependencies(doc).apply(_format_req)
+
+
+def _format_req(requirement: Requirement, /) -> Requirement:
+    return requirement
+
+
+__all__ = ["format_requirements"]

actions/pre_commit/replace_sequence_strs/__init__.py

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

actions/pre_commit/replace_sequence_strs/cli.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.pre_commit.click import path_argument
+from actions.pre_commit.replace_sequence_strs.lib import replace_sequence_strs
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@path_argument
+def replace_sequence_strs_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    replace_sequence_strs(*paths)
+
+
+__all__ = ["replace_sequence_strs_sub_cmd"]

actions/pre_commit/replace_sequence_strs/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+REPLACE_SEQUENCE_STRS_DOCSTRING = "Replace 'Sequence[str]' with 'list[str]'"
+REPLACE_SEQUENCE_STRS_SUB_CMD = "replace-sequence-strs"
+
+
+__all__ = ["REPLACE_SEQUENCE_STRS_DOCSTRING", "REPLACE_SEQUENCE_STRS_SUB_CMD"]

actions/pre_commit/replace_sequence_strs/lib.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING, override
+
+from libcst import CSTTransformer, Name, Subscript
+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
+from actions.pre_commit.utilities import yield_python_file
+
+if TYPE_CHECKING:
+    from collections.abc import MutableSet
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+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,
+    )
+    modifications: set[Path] = set()
+    for path in paths:
+        _format_path(path, modifications=modifications)
+    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, /, *, modifications: MutableSet[Path] | None = None
+) -> None:
+    with yield_python_file(path, modifications=modifications) as context:
+        context.output = MetadataWrapper(context.input).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"]

actions/pre_commit/touch_empty_py/__init__.py

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

actions/pre_commit/touch_empty_py/cli.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.pre_commit.click import path_argument
+from actions.pre_commit.touch_empty_py.lib import touch_empty_py
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@path_argument
+def touch_empty_py_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    touch_empty_py(*paths)
+
+
+__all__ = ["touch_empty_py_sub_cmd"]

actions/pre_commit/touch_empty_py/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+TOUCH_EMPTY_PY_DOCSTRING = "Touch empty '.py' files"
+TOUCH_EMPTY_PY_SUB_CMD = "touch-empty-py"
+
+
+__all__ = ["TOUCH_EMPTY_PY_DOCSTRING", "TOUCH_EMPTY_PY_SUB_CMD"]

actions/pre_commit/touch_empty_py/lib.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+from libcst import parse_statement
+from utilities.text import repr_str, strip_and_dedent
+
+from actions import __version__
+from actions.logging import LOGGER
+from actions.pre_commit.utilities import yield_python_file
+
+if TYPE_CHECKING:
+    from collections.abc import MutableSet
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+def touch_empty_py(*paths: PathLike) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        touch_empty_py.__name__,
+        __version__,
+        paths,
+    )
+    modifications: set[Path] = set()
+    for path in paths:
+        _format_path(path, modifications=modifications)
+    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, /, *, modifications: MutableSet[Path] | None = None
+) -> None:
+    with yield_python_file(path, modifications=modifications) as context:
+        if len(context.input.body) >= 1:
+            return
+        body = [
+            *context.input.body,
+            parse_statement("from __future__ import annotations"),
+        ]
+        context.output = context.input.with_changes(body=body)
+
+
+__all__ = ["touch_empty_py"]

actions/pre_commit/touch_py_typed/__init__.py

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

actions/pre_commit/touch_py_typed/cli.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.pre_commit.click import path_argument
+from actions.pre_commit.touch_py_typed.lib import touch_py_typed
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@path_argument
+def touch_py_typed_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    touch_py_typed(*paths)
+
+
+__all__ = ["touch_py_typed_sub_cmd"]

actions/pre_commit/touch_py_typed/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+TOUCH_PY_TYPED_DOCSTRING = "Touch 'py.typed'"
+TOUCH_PY_TYPED_SUB_CMD = "touch-py-typed"
+
+
+__all__ = ["TOUCH_PY_TYPED_DOCSTRING", "TOUCH_PY_TYPED_SUB_CMD"]

actions/pre_commit/touch_py_typed/lib.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from utilities.iterables import one
+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 MutableSet
+
+    from utilities.types import PathLike
+
+
+def touch_py_typed(*paths: PathLike) -> None:
+    LOGGER.info(
+        strip_and_dedent("""
+            Running '%s' (version %s) with settings:
+             - paths = %s
+        """),
+        touch_py_typed.__name__,
+        __version__,
+        paths,
+    )
+    modifications: set[Path] = set()
+    for path in paths:
+        _format_path(path, modifications=modifications)
+    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, /, *, modifications: MutableSet[Path] | None = None
+) -> None:
+    path = Path(path)
+    if not path.is_file():
+        msg = f"Expected a file; {str(path)!r} is not"
+        raise FileNotFoundError(msg)
+    if path.name != "pyproject.toml":
+        msg = f"Expected 'pyproject.toml'; got {str(path)!r}"
+        raise TypeError(msg)
+    src = path.parent / "src"
+    if not src.exists():
+        return
+    if not src.is_dir():
+        msg = f"Expected a directory; {str(src)!r} is not"
+        raise NotADirectoryError(msg)
+    non_tests = one(p for p in src.iterdir() if p.name != "tests")
+    py_typed = non_tests / "py.typed"
+    if not py_typed.exists():
+        py_typed.touch()
+        if modifications is not None:
+            modifications.add(py_typed)
+
+
+__all__ = ["touch_py_typed"]

actions/pre_commit/update_requirements/__init__.py

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

actions/pre_commit/update_requirements/classes.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field, replace
+from functools import total_ordering
+from typing import Any, Self, override
+
+from pydantic import BaseModel
+from utilities.version import (
+    ParseVersionError,
+    _VersionEmptySuffixError,
+    _VersionNegativeMajorVersionError,
+    _VersionNegativeMinorVersionError,
+    _VersionZeroError,
+)
+from utilities.version import Version as Version3
+from utilities.version import parse_version as parse_version3
+
+type TwoSidedVersions = tuple[Version2or3 | None, Version1or2 | None]
+type Version1or2 = int | Version2
+type Version2or3 = Version2 | Version3
+type VersionSet = dict[str, Version2or3]
+
+
+class PipListOutdatedOutput(BaseModel):
+    name: str
+    version: str
+    latest_version: str
+    latest_filetype: str
+
+
+##
+
+
+@dataclass(repr=False, frozen=True, slots=True)
+@total_ordering
+class Version2:
+    """A version identifier."""
+
+    major: int = 0
+    minor: int = 0
+    suffix: str | None = field(default=None, kw_only=True)
+
+    def __post_init__(self) -> None:
+        if (self.major == 0) and (self.minor == 0):
+            raise _VersionZeroError(major=self.major, minor=self.minor, patch=0)
+        if self.major < 0:
+            raise _VersionNegativeMajorVersionError(major=self.major)
+        if self.minor < 0:
+            raise _VersionNegativeMinorVersionError(minor=self.minor)
+        if (self.suffix is not None) and (len(self.suffix) == 0):
+            raise _VersionEmptySuffixError(suffix=self.suffix)
+
+    def __le__(self, other: Any, /) -> bool:
+        if not isinstance(other, type(self)):
+            return NotImplemented
+        self_as_tuple = (self.major, self.minor)
+        other_as_tuple = (other.major, other.minor)
+        return self_as_tuple <= other_as_tuple
+
+    @override
+    def __repr__(self) -> str:
+        version = f"{self.major}.{self.minor}"
+        if self.suffix is not None:
+            version = f"{version}-{self.suffix}"
+        return version
+
+    def bump_major(self) -> Self:
+        return type(self)(self.major + 1, 0)
+
+    def bump_minor(self) -> Self:
+        return type(self)(self.major, self.minor + 1)
+
+    def with_suffix(self, *, suffix: str | None = None) -> Self:
+        return replace(self, suffix=suffix)
+
+
+def parse_version1_or_2(version: str, /) -> Version1or2:
+    try:
+        return parse_version2(version)
+    except ParseVersionError:
+        return int(version)
+
+
+def parse_version2_or_3(version: str, /) -> Version2or3:
+    try:
+        return parse_version3(version)
+    except ParseVersionError:
+        return parse_version2(version)
+
+
+def parse_version2(version: str, /) -> Version2:
+    try:
+        ((major, minor, suffix),) = _PARSE_VERSION2_PATTERN.findall(version)
+    except ValueError:
+        raise ParseVersionError(version=version) from None
+    return Version2(int(major), int(minor), suffix=None if suffix == "" else suffix)
+
+
+_PARSE_VERSION2_PATTERN = re.compile(r"^(\d+)\.(\d+)(?:-(\w+))?")
+
+
+_ = PipListOutdatedOutput.model_rebuild()
+
+
+__all__ = [
+    "PipListOutdatedOutput",
+    "TwoSidedVersions",
+    "Version1or2",
+    "Version2",
+    "Version2or3",
+    "Version3",
+    "VersionSet",
+    "parse_version1_or_2",
+    "parse_version2",
+    "parse_version2_or_3",
+]

actions/pre_commit/update_requirements/cli.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from utilities.logging import basic_config
+from utilities.os import is_pytest
+
+from actions.logging import LOGGER
+from actions.pre_commit.click import path_argument
+from actions.pre_commit.update_requirements.lib import update_requirements
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+@path_argument
+def update_requirements_sub_cmd(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    update_requirements(*paths)
+
+
+__all__ = ["update_requirements_sub_cmd"]

actions/pre_commit/update_requirements/constants.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+UPDATE_REQUIREMENTS_DOCSTRING = "Update a set of requirements"
+UPDATE_REQUIREMENTS_SUB_CMD = "update-requirements"
+
+
+__all__ = ["UPDATE_REQUIREMENTS_DOCSTRING", "UPDATE_REQUIREMENTS_SUB_CMD"]