duty 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

duty/callables/twine.py

@@ -0,0 +1,284 @@
+"""Callable for [Twine](https://github.com/pypa/twine)."""
+
+from __future__ import annotations
+
+from failprint.lazy import lazy
+
+
+def run(*args: str, version: bool = False, no_color: bool = False) -> None:
+    """Run `twine`.
+
+    Parameters:
+        *args: CLI arguments.
+        version: Show program's version number and exit.
+        no_color: Disable colored output.
+    """
+    from twine.cli import dispatch as twine
+
+    cli_args = []
+
+    # --version and --no-color must appear first.
+    if version:
+        cli_args.append("--version")
+
+    if no_color:
+        cli_args.append("--no-color")
+
+    cli_args.extend(args)
+
+    twine(cli_args)
+
+
+@lazy(name="twine.check")
+def check(
+    *dists: str,
+    strict: bool = False,
+    version: bool = False,
+    no_color: bool = False,
+) -> None:
+    """Checks whether your distribution's long description will render correctly on PyPI.
+
+    Parameters:
+        dists: The distribution files to check, usually `dist/*`.
+        strict: Fail on warnings.
+        version: Show program's version number and exit.
+        no_color: Disable colored output.
+    """
+    cli_args = list(dists)
+
+    if strict is True:
+        cli_args.append("--strict")
+
+    run("check", *cli_args, version=version, no_color=no_color)
+
+
+@lazy(name="twine.register")
+def register(
+    package: str,
+    *,
+    repository: str = "pypi",
+    repository_url: str | None = None,
+    attestations: bool = False,
+    sign: bool = False,
+    sign_with: str | None = None,
+    identity: str | None = None,
+    username: str | None = None,
+    password: str | None = None,
+    non_interactive: bool = False,
+    comment: str | None = None,
+    config_file: str | None = None,
+    skip_existing: bool = False,
+    cert: str | None = None,
+    client_cert: str | None = None,
+    verbose: bool = False,
+    disable_progress_bar: bool = False,
+    version: bool = False,
+    no_color: bool = False,
+) -> None:
+    """Pre-register a name with a repository before uploading a distribution.
+
+    Pre-registration is not supported on PyPI, so the register command
+    is only necessary if you are using a different repository that requires it.
+
+    Parameters:
+        package: File from which we read the package metadata.
+        repository: The repository (package index) to upload the package to.
+            Should be a section in the config file (default: `pypi`).
+            Can also be set via `TWINE_REPOSITORY` environment variable.
+        repository_url: The repository (package index) URL to upload the package to. This overrides `--repository`.
+            Can also be set via `TWINE_REPOSITORY_URL` environment variable.
+        attestations: Upload each file's associated attestations.
+        sign: Sign files to upload using GPG.
+        sign_with: GPG program used to sign uploads (default: `gpg`).
+        identity: GPG identity used to sign files.
+        username: The username to authenticate to the repository (package index) as.
+            Can also be set via `TWINE_USERNAME` environment variable.
+        password: The password to authenticate to the repository (package index) with.
+            Can also be set via `TWINE_PASSWORD` environment variable.
+        non_interactive: Do not interactively prompt for username/password if the required credentials are missing.
+            Can also be set via `TWINE_NON_INTERACTIVE` environment variable.
+        comment: The comment to include with the distribution file.
+        config_file: The `.pypirc` config file to use.
+        skip_existing: Continue uploading files if one already exists.
+            Only valid when uploading to PyPI. Other implementations may not support this.
+        cert: Path to alternate CA bundle (can also be set via `TWINE_CERT` environment variable).
+        client_cert: Path to SSL client certificate, a single file containing the private key and the certificate in PEM format.
+        verbose: Show verbose output.
+        disable_progress_bar: Disable the progress bar.
+        version: Show program's version number and exit.
+        no_color: Disable colored output.
+    """
+    cli_args = [package]
+
+    if repository:
+        cli_args.append("--repository")
+        cli_args.append(repository)
+
+    if repository_url:
+        cli_args.append("--repository-url")
+        cli_args.append(repository_url)
+
+    if attestations:
+        cli_args.append("--attestations")
+
+    if sign:
+        cli_args.append("--sign")
+
+    if sign_with:
+        cli_args.append("--sign-with")
+        cli_args.append(sign_with)
+
+    if identity:
+        cli_args.append("--identity")
+        cli_args.append(identity)
+
+    if username:
+        cli_args.append("--username")
+        cli_args.append(username)
+
+    if password:
+        cli_args.append("--password")
+        cli_args.append(password)
+
+    if non_interactive:
+        cli_args.append("--non-interactive")
+
+    if comment:
+        cli_args.append("--repository")
+
+    if config_file:
+        cli_args.append("--config-file")
+        cli_args.append(config_file)
+
+    if skip_existing:
+        cli_args.append("--skip-existing")
+
+    if cert:
+        cli_args.append("--cert")
+        cli_args.append(cert)
+
+    if client_cert:
+        cli_args.append("--client-cert")
+        cli_args.append(client_cert)
+
+    if verbose:
+        cli_args.append("--verbose")
+
+    if disable_progress_bar:
+        cli_args.append("--disable-progress-bar")
+
+    run("check", *cli_args, version=version, no_color=no_color)
+
+
+@lazy(name="twine.upload")
+def upload(
+    *dists: str,
+    repository: str = "pypi",
+    repository_url: str | None = None,
+    attestations: bool = False,
+    sign: bool = False,
+    sign_with: str | None = None,
+    identity: str | None = None,
+    username: str | None = None,
+    password: str | None = None,
+    non_interactive: bool = False,
+    comment: str | None = None,
+    config_file: str | None = None,
+    skip_existing: bool = False,
+    cert: str | None = None,
+    client_cert: str | None = None,
+    verbose: bool = False,
+    disable_progress_bar: bool = False,
+    version: bool = False,
+    no_color: bool = False,
+) -> None:
+    """Uploads one or more distributions to a repository.
+
+    Parameters:
+        dists: The distribution files to check, usually `dist/*`.
+        repository: The repository (package index) to upload the package to.
+            Should be a section in the config file (default: `pypi`).
+            Can also be set via `TWINE_REPOSITORY` environment variable.
+        repository_url: The repository (package index) URL to upload the package to. This overrides `--repository`.
+            Can also be set via `TWINE_REPOSITORY_URL` environment variable.
+        attestations: Upload each file's associated attestations.
+        sign: Sign files to upload using GPG.
+        sign_with: GPG program used to sign uploads (default: `gpg`).
+        identity: GPG identity used to sign files.
+        username: The username to authenticate to the repository (package index) as.
+            Can also be set via `TWINE_USERNAME` environment variable.
+        password: The password to authenticate to the repository (package index) with.
+            Can also be set via `TWINE_PASSWORD` environment variable.
+        non_interactive: Do not interactively prompt for username/password if the required credentials are missing.
+            Can also be set via `TWINE_NON_INTERACTIVE` environment variable.
+        comment: The comment to include with the distribution file.
+        config_file: The `.pypirc` config file to use.
+        skip_existing: Continue uploading files if one already exists.
+            Only valid when uploading to PyPI. Other implementations may not support this.
+        cert: Path to alternate CA bundle (can also be set via `TWINE_CERT` environment variable).
+        client_cert: Path to SSL client certificate, a single file containing the private key and the certificate in PEM format.
+        verbose: Show verbose output.
+        disable_progress_bar: Disable the progress bar.
+        version: Show program's version number and exit.
+        no_color: Disable colored output.
+    """
+    cli_args = list(dists)
+
+    if repository:
+        cli_args.append("--repository")
+        cli_args.append(repository)
+
+    if repository_url:
+        cli_args.append("--repository-url")
+        cli_args.append(repository_url)
+
+    if attestations:
+        cli_args.append("--attestations")
+
+    if sign:
+        cli_args.append("--sign")
+
+    if sign_with:
+        cli_args.append("--sign-with")
+        cli_args.append(sign_with)
+
+    if identity:
+        cli_args.append("--identity")
+        cli_args.append(identity)
+
+    if username:
+        cli_args.append("--username")
+        cli_args.append(username)
+
+    if password:
+        cli_args.append("--password")
+        cli_args.append(password)
+
+    if non_interactive:
+        cli_args.append("--non-interactive")
+
+    if comment:
+        cli_args.append("--repository")
+
+    if config_file:
+        cli_args.append("--config-file")
+        cli_args.append(config_file)
+
+    if skip_existing:
+        cli_args.append("--skip-existing")
+
+    if cert:
+        cli_args.append("--cert")
+        cli_args.append(cert)
+
+    if client_cert:
+        cli_args.append("--client-cert")
+        cli_args.append(client_cert)
+
+    if verbose:
+        cli_args.append("--verbose")
+
+    if disable_progress_bar:
+        cli_args.append("--disable-progress-bar")
+
+    run("upload", *cli_args, version=version, no_color=no_color)

duty/cli.py

@@ -214,6 +214,8 @@ def parse_commands(arg_lists: list[list[str]], global_opts: dict[str, Any], coll
     for arg_list in arg_lists:
         duty = collection.get(arg_list[0])
         opts, remainder = parse_options(duty, arg_list[1:])
+        if remainder and remainder[0] == "--":
+            remainder = remainder[1:]
         duty.options_override = {**global_opts, **opts}
         commands.append((duty, *parse_args(duty, remainder)))
     return commands

duty/context.py

@@ -3,12 +3,13 @@
 from __future__ import annotations
 
 import os
-from contextlib import contextmanager
+from contextlib import contextmanager, suppress
 from typing import Any, Callable, Iterator, List, Union
 
 from failprint.runners import run as failprint_run
 
 from duty.exceptions import DutyFailure
+from duty.tools import Tool
 
 CmdType = Union[str, List[str], Callable]
 
@@ -67,6 +68,10 @@ class Context:
         final_options = dict(self._options)
         final_options.update(options)
 
+        if "command" not in final_options and isinstance(cmd, Tool):
+            with suppress(ValueError):
+                final_options["command"] = cmd.cli_command
+
         allow_overrides = final_options.pop("allow_overrides", True)
         workdir = final_options.pop("workdir", None)
 

duty/decorator.py

@@ -63,7 +63,7 @@ def create_duty(
 
 
 @overload
-def duty(**kwargs: Any) -> Callable[[Callable], Duty]: ...  # type: ignore[overload-overlap]
+def duty(**kwargs: Any) -> Callable[[Callable], Duty]: ...
 
 
 @overload

duty/tools/__init__.py

@@ -0,0 +1,48 @@
+"""Module containing callables for many tools."""
+
+from __future__ import annotations
+
+from failprint.lazy import lazy
+
+from duty.tools._autoflake import autoflake
+from duty.tools._base import LazyStderr, LazyStdout, Tool
+from duty.tools._black import black
+from duty.tools._blacken_docs import blacken_docs
+from duty.tools._build import build
+from duty.tools._coverage import coverage
+from duty.tools._flake8 import flake8
+from duty.tools._git_changelog import git_changelog
+from duty.tools._griffe import griffe
+from duty.tools._interrogate import interrogate
+from duty.tools._isort import isort
+from duty.tools._mkdocs import mkdocs
+from duty.tools._mypy import mypy
+from duty.tools._pytest import pytest
+from duty.tools._ruff import ruff
+from duty.tools._safety import safety
+from duty.tools._ssort import ssort
+from duty.tools._twine import twine
+
+__all__ = [
+    "Tool",
+    "LazyStdout",
+    "LazyStderr",
+    "lazy",
+    "autoflake",
+    "black",
+    "blacken_docs",
+    "build",
+    "coverage",
+    "flake8",
+    "git_changelog",
+    "griffe",
+    "interrogate",
+    "isort",
+    "mkdocs",
+    "mypy",
+    "pytest",
+    "ruff",
+    "safety",
+    "ssort",
+    "twine",
+]

duty/tools/_autoflake.py

@@ -0,0 +1,138 @@
+"""Callable for [autoflake](https://github.com/PyCQA/autoflake)."""
+
+from __future__ import annotations
+
+from duty.tools._base import LazyStderr, LazyStdout, Tool
+
+
+class autoflake(Tool):  # noqa: N801
+    """Call [autoflake](https://github.com/PyCQA/autoflake)."""
+
+    cli_name = "autoflake"
+
+    def __init__(
+        self,
+        *files: str,
+        config: str | None = None,
+        check: bool | None = None,
+        check_diff: bool | None = None,
+        imports: list[str] | None = None,
+        remove_all_unused_imports: bool | None = None,
+        recursive: bool | None = None,
+        jobs: int | None = None,
+        exclude: list[str] | None = None,
+        expand_star_imports: bool | None = None,
+        ignore_init_module_imports: bool | None = None,
+        remove_duplicate_keys: bool | None = None,
+        remove_unused_variables: bool | None = None,
+        remove_rhs_for_unused_variables: bool | None = None,
+        ignore_pass_statements: bool | None = None,
+        ignore_pass_after_docstring: bool | None = None,
+        quiet: bool | None = None,
+        verbose: bool | None = None,
+        stdin_display_name: str | None = None,
+        in_place: bool | None = None,
+        stdout: bool | None = None,
+    ) -> None:
+        r"""Run `autoflake`.
+
+        Parameters:
+            *files: Files to format.
+            config: Explicitly set the config file instead of auto determining based on file location.
+            check: Return error code if changes are needed.
+            check_diff: Return error code if changes are needed, also display file diffs.
+            imports: By default, only unused standard library imports are removed; specify a comma-separated list of additional modules/packages.
+            remove_all_unused_imports: Remove all unused imports (not just those from the standard library).
+            recursive: Drill down directories recursively.
+            jobs: Number of parallel jobs; match CPU count if value is 0 (default: 0).
+            exclude: Exclude file/directory names that match these comma-separated globs.
+            expand_star_imports: Expand wildcard star imports with undefined names; this only triggers if there is only one star import in the file; this is skipped if there are any uses of `__all__` or `del` in the file.
+            ignore_init_module_imports: Exclude `__init__.py` when removing unused imports.
+            remove_duplicate_keys: Remove all duplicate keys in objects.
+            remove_unused_variables: Remove unused variables.
+            remove_rhs_for_unused_variables: Remove RHS of statements when removing unused variables (unsafe).
+            ignore_pass_statements: Ignore all pass statements.
+            ignore_pass_after_docstring: Ignore pass statements after a newline ending on `\"\"\"`.
+            quiet: Suppress output if there are no issues.
+            verbose: Print more verbose logs (you can repeat `-v` to make it more verbose).
+            stdin_display_name: The name used when processing input from stdin.
+            in_place: Make changes to files instead of printing diffs.
+            stdout: Print changed text to stdout. defaults to true when formatting stdin, or to false otherwise.
+        """
+        cli_args = list(files)
+
+        if check:
+            cli_args.append("--check")
+
+        if check_diff:
+            cli_args.append("--check-diff")
+
+        if imports:
+            cli_args.append("--imports")
+            cli_args.append(",".join(imports))
+
+        if remove_all_unused_imports:
+            cli_args.append("--remove-all-unused-imports")
+
+        if recursive:
+            cli_args.append("--recursive")
+
+        if jobs:
+            cli_args.append("--jobs")
+            cli_args.append(str(jobs))
+
+        if exclude:
+            cli_args.append("--exclude")
+            cli_args.append(",".join(exclude))
+
+        if expand_star_imports:
+            cli_args.append("--expand-star-imports")
+
+        if ignore_init_module_imports:
+            cli_args.append("--ignore-init-module-imports")
+
+        if remove_duplicate_keys:
+            cli_args.append("--remove-duplicate-keys")
+
+        if remove_unused_variables:
+            cli_args.append("--remove-unused-variables")
+
+        if remove_rhs_for_unused_variables:
+            cli_args.append("remove-rhs-for-unused-variables")
+
+        if ignore_pass_statements:
+            cli_args.append("--ignore-pass-statements")
+
+        if ignore_pass_after_docstring:
+            cli_args.append("--ignore-pass-after-docstring")
+
+        if quiet:
+            cli_args.append("--quiet")
+
+        if verbose:
+            cli_args.append("--verbose")
+
+        if stdin_display_name:
+            cli_args.append("--stdin-display-name")
+            cli_args.append(stdin_display_name)
+
+        if config:
+            cli_args.append("--config")
+            cli_args.append(config)
+
+        if in_place:
+            cli_args.append("--in-place")
+
+        if stdout:
+            cli_args.append("--stdout")
+
+        super().__init__(cli_args)
+
+    def __call__(self) -> int:
+        from autoflake import _main as run_autoflake
+
+        return run_autoflake(
+            self.cli_args,
+            standard_out=LazyStdout(),
+            standard_error=LazyStderr(),
+        )

duty/tools/_base.py

@@ -0,0 +1,66 @@
+"""Utilities for creating tools."""
+
+from __future__ import annotations
+
+import shlex
+import sys
+from io import StringIO
+from typing import Any
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+class LazyStdout(StringIO):
+    """Lazy stdout buffer.
+
+    Can be used when tools' main entry-points
+    expect a file-like object for stdout.
+    """
+
+    def write(self, value: str) -> int:
+        return sys.stdout.write(value)
+
+    def __repr__(self) -> str:
+        return "stdout"
+
+
+class LazyStderr(StringIO):
+    """Lazy stderr buffer.
+
+    Can be used when tools' main entry-points
+    expect a file-like object for stderr.
+    """
+
+    def write(self, value: str) -> int:
+        return sys.stderr.write(value)
+
+    def __repr__(self) -> str:
+        return "stderr"
+
+
+class Tool:
+    """Base class for tools."""
+
+    cli_name: str = ""
+
+    def __init__(
+        self,
+        cli_args: list[str] | None = None,
+        py_args: dict[str, Any] | None = None,
+    ) -> None:
+        self.cli_args: list[str] = cli_args or []
+        self.py_args: dict[str, Any] = py_args or {}
+
+    def add_args(self, *args: str) -> Self:
+        """Add arguments."""
+        self.cli_args.extend(args)
+        return self
+
+    @property
+    def cli_command(self) -> str:
+        if not self.cli_name:
+            raise ValueError("This tool does not provide a CLI.")
+        return shlex.join([self.cli_name, *self.cli_args])