duty 1.6.0__py3-none-any.whl → 1.6.2__py3-none-any.whl

duty/__init__.py

@@ -5,6 +5,53 @@ A simple task runner.
 
 from __future__ import annotations
 
-from duty.decorator import duty
+from failprint import lazy
 
-__all__: list[str] = ["duty"]
+from duty._internal.cli import (
+    empty,
+    get_duty_parser,
+    get_parser,
+    main,
+    parse_args,
+    parse_commands,
+    parse_options,
+    print_help,
+    specified_options,
+    split_args,
+)
+from duty._internal.collection import Collection, Duty, DutyListType, default_duties_file
+from duty._internal.context import CmdType, Context
+from duty._internal.decorator import create_duty, duty
+from duty._internal.exceptions import DutyFailure
+from duty._internal.tools._base import LazyStderr, LazyStdout, Tool
+from duty._internal.validation import ParamsCaster, cast_arg, to_bool, validate
+
+__all__: list[str] = [
+    "CmdType",
+    "Collection",
+    "Context",
+    "Duty",
+    "DutyFailure",
+    "DutyListType",
+    "LazyStderr",
+    "LazyStdout",
+    "ParamsCaster",
+    "Tool",
+    "cast_arg",
+    "create_duty",
+    "default_duties_file",
+    "duty",
+    "empty",
+    "get_duty_parser",
+    "get_parser",
+    "lazy",
+    "main",
+    "parse_args",
+    "parse_commands",
+    "parse_options",
+    "print_help",
+    "specified_options",
+    "split_args",
+    "to_bool",
+    "validate",
+]

duty/__main__.py

@@ -8,7 +8,7 @@ Why does this file exist, and why `__main__`? For more info, read:
 
 import sys
 
-from duty.cli import main
+from duty._internal.cli import main
 
 if __name__ == "__main__":
     sys.exit(main(sys.argv[1:]))

duty/_internal/callables/__init__.py

@@ -0,0 +1,34 @@
+# YORE: Bump 2: Remove file.
+
+from __future__ import annotations
+
+import warnings
+
+from duty._internal.callables import (
+    autoflake,  # noqa: F401
+    black,  # noqa: F401
+    blacken_docs,  # noqa: F401
+    build,  # noqa: F401
+    coverage,  # noqa: F401
+    flake8,  # noqa: F401
+    git_changelog,  # noqa: F401
+    griffe,  # noqa: F401
+    interrogate,  # noqa: F401
+    isort,  # noqa: F401
+    mkdocs,  # noqa: F401
+    mypy,  # noqa: F401
+    pytest,  # noqa: F401
+    ruff,  # noqa: F401
+    safety,  # noqa: F401
+    ssort,  # noqa: F401
+    twine,  # noqa: F401
+)
+
+warnings.warn(
+    "Callables are deprecated in favor of our new `duty.tools`. "
+    "They are easier to use and provide more functionality "
+    "like automatically computing `command` values in `ctx.run()` calls. "
+    "Old callables will be removed in a future version.",
+    DeprecationWarning,
+    stacklevel=1,
+)

duty/{callables → _internal/callables}/_io.py

@@ -1,6 +1,8 @@
 import sys
 from io import StringIO
 
+# YORE: Bump 2: Remove file.
+
 
 class _LazyStdout(StringIO):
     def write(self, value: str) -> int:

duty/_internal/callables/autoflake.py

@@ -0,0 +1,132 @@
+# YORE: Bump 2: Remove file.
+
+from __future__ import annotations
+
+from failprint import lazy
+
+from duty._internal.callables import _io
+
+
+@lazy(name="autoflake")
+def run(
+    *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,
+) -> int:
+    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.
+    """
+    from autoflake import _main as autoflake  # noqa: PLC0415
+
+    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")
+
+    return autoflake(
+        cli_args,
+        standard_out=_io._LazyStdout(),
+        standard_error=_io._LazyStderr(),
+    )

duty/_internal/callables/black.py

@@ -0,0 +1,176 @@
+# YORE: Bump 2: Remove file.
+
+from __future__ import annotations
+
+from failprint import lazy
+
+
+@lazy(name="black")
+def run(
+    *src: str,
+    config: str | None = None,
+    code: str | None = None,
+    line_length: int | None = None,
+    target_version: str | None = None,
+    check: bool | None = None,
+    diff: bool | None = None,
+    color: bool | None = None,
+    fast: bool | None = None,
+    pyi: bool | None = None,
+    ipynb: bool | None = None,
+    python_cell_magics: str | None = None,
+    skip_source_first_line: bool | None = None,
+    skip_string_normalization: bool | None = None,
+    skip_magic_trailing_comma: bool | None = None,
+    experimental_string_processing: bool | None = None,
+    preview: bool | None = None,
+    quiet: bool | None = None,
+    verbose: bool | None = None,
+    required_version: str | None = None,
+    include: str | None = None,
+    exclude: str | None = None,
+    extend_exclude: str | None = None,
+    force_exclude: str | None = None,
+    stdin_filename: str | None = None,
+    workers: int | None = None,
+) -> None:
+    r"""Run `black`.
+
+    Parameters:
+        src: Format the directories and file paths.
+        config: Read configuration from this file path.
+        code: Format the code passed in as a string.
+        line_length: How many characters per line to allow [default: 120].
+        target_version: Python versions that should be supported by Black's output.
+            By default, Black will try to infer this from the project metadata in pyproject.toml.
+            If this does not yield conclusive results, Black will use per-file auto-detection.
+        check: Don't write the files back, just return the status. Return code 0 means nothing would change.
+            Return code 1 means some files would be reformatted. Return code 123 means there was an internal error.
+        diff: Don't write the files back, just output a diff for each file on stdout.
+        color: Show colored diff. Only applies when `--diff` is given.
+        fast: If --fast given, skip temporary sanity checks. [default: --safe]
+        pyi: Format all input files like typing stubs regardless of file extension
+            (useful when piping source on standard input).
+        ipynb: Format all input files like Jupyter Notebooks regardless of file extension
+            (useful when piping source on standard input).
+        python_cell_magics: When processing Jupyter Notebooks, add the given magic to the list of known python-magics
+            (capture, prun, pypy, python, python3, time, timeit). Useful for formatting cells with custom python magics.
+        skip_source_first_line: Skip the first line of the source code.
+        skip_string_normalization: Don't normalize string quotes or prefixes.
+        skip_magic_trailing_comma: Don't use trailing commas as a reason to split lines.
+        preview: Enable potentially disruptive style changes that may be added
+            to Black's main functionality in the next major release.
+        quiet: Don't emit non-error messages to stderr. Errors are still emitted; silence those with 2>/dev/null.
+        verbose: Also emit messages to stderr about files that were not changed or were ignored due to exclusion patterns.
+        required_version: Require a specific version of Black to be running (useful for unifying results
+            across many environments e.g. with a pyproject.toml file).
+            It can be either a major version number or an exact version.
+        include: A regular expression that matches files and directories that should be included on recursive searches.
+            An empty value means all files are included regardless of the name. Use forward slashes for directories
+            on all platforms (Windows, too). Exclusions are calculated first, inclusions later [default: (\.pyi?|\.ipynb)$].
+        exclude: A regular expression that matches files and directories that should be excluded on recursive searches.
+            An empty value means no paths are excluded. Use forward slashes for directories on all platforms (Windows, too).
+            Exclusions are calculated first, inclusions later [default: /(\.direnv|\.eggs|\.git|\.hg|\.mypy_cache|\.nox|
+            \.tox|\.venv|venv|\.svn|\.ipynb_checkpoints|_build|buck-out|build|dist|__pypackages__)/].
+        extend_exclude: Like --exclude, but adds additional files and directories on top of the excluded ones
+            (useful if you simply want to add to the default).
+        force_exclude: Like --exclude, but files and directories matching this regex will be excluded
+            even when they are passed explicitly as arguments.
+        stdin_filename: The name of the file when passing it through stdin. Useful to make sure Black will respect
+            --force-exclude option on some editors that rely on using stdin.
+        workers: Number of parallel workers [default: number CPUs in the system].
+    """
+    from black import main as black  # noqa: PLC0415
+
+    cli_args = list(src)
+
+    if config:
+        cli_args.append("--config")
+        cli_args.append(config)
+
+    if code:
+        cli_args.append("--code")
+        cli_args.append(code)
+
+    if line_length:
+        cli_args.append("--line-length")
+        cli_args.append(str(line_length))
+
+    if target_version:
+        cli_args.append("--target-version")
+        cli_args.append(target_version)
+
+    if check:
+        cli_args.append("--check")
+
+    if diff:
+        cli_args.append("--diff")
+
+    if color is True:
+        cli_args.append("--color")
+    elif color is False:
+        cli_args.append("--no-color")
+
+    if fast:
+        cli_args.append("--fast")
+
+    if pyi:
+        cli_args.append("--pyi")
+
+    if ipynb:
+        cli_args.append("--ipynb")
+
+    if python_cell_magics:
+        cli_args.append("--python-cell-magics")
+        cli_args.append(python_cell_magics)
+
+    if skip_source_first_line:
+        cli_args.append("--skip_source_first_line")
+
+    if skip_string_normalization:
+        cli_args.append("--skip_string_normalization")
+
+    if skip_magic_trailing_comma:
+        cli_args.append("--skip_magic_trailing_comma")
+
+    if experimental_string_processing:
+        cli_args.append("--experimental_string_processing")
+
+    if preview:
+        cli_args.append("--preview")
+
+    if quiet:
+        cli_args.append("--quiet")
+
+    if verbose:
+        cli_args.append("--verbose")
+
+    if required_version:
+        cli_args.append("--required-version")
+        cli_args.append(required_version)
+
+    if include:
+        cli_args.append("--include")
+        cli_args.append(include)
+
+    if exclude:
+        cli_args.append("--exclude")
+        cli_args.append(exclude)
+
+    if extend_exclude:
+        cli_args.append("--extend-exclude")
+        cli_args.append(extend_exclude)
+
+    if force_exclude:
+        cli_args.append("--force-exclude")
+        cli_args.append(force_exclude)
+
+    if stdin_filename:
+        cli_args.append("--stdin-filename")
+        cli_args.append(stdin_filename)
+
+    if workers:
+        cli_args.append("--workers")
+        cli_args.append(str(workers))
+
+    return black(cli_args, prog_name="black")

duty/_internal/callables/blacken_docs.py

@@ -0,0 +1,92 @@
+# YORE: Bump 2: Remove file.
+
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from re import Pattern
+from typing import TYPE_CHECKING
+
+from failprint import lazy
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+
+@lazy(name="blacken_docs")
+def run(
+    *paths: str | Path,
+    exts: Sequence[str] | None = None,
+    exclude: Sequence[str | Pattern] | None = None,
+    skip_errors: bool = False,
+    rst_literal_blocks: bool = False,
+    line_length: int | None = None,
+    string_normalization: bool = True,
+    is_pyi: bool = False,
+    is_ipynb: bool = False,
+    skip_source_first_line: bool = False,
+    magic_trailing_comma: bool = True,
+    python_cell_magics: set[str] | None = None,
+    preview: bool = False,
+    check_only: bool = False,
+) -> int:
+    """Run `blacken-docs`.
+
+    Parameters:
+        *paths: Directories and files to format.
+        exts: List of extensions to select files with.
+        exclude: List of regular expressions to exclude files.
+        skip_errors: Don't exit non-zero for errors from Black (normally syntax errors).
+        rst_literal_blocks: Also format literal blocks in reStructuredText files (more below).
+        line_length: How many characters per line to allow.
+        string_normalization: Normalize string quotes or prefixes.
+        is_pyi: Format all input files like typing stubs regardless of file extension.
+        is_ipynb: Format all input files like Jupyter Notebooks regardless of file extension.
+        skip_source_first_line: Skip the first line of the source code.
+        magic_trailing_comma: Use trailing commas as a reason to split lines.
+        python_cell_magics: When processing Jupyter Notebooks, add the given magic to the list
+            of known python-magics (capture, prun, pypy, python, python3, time, timeit).
+            Useful for formatting cells with custom python magics.
+        preview: Enable potentially disruptive style changes that may be added
+            to Black's main functionality in the next major release.
+        check_only: Don't modify files but indicate when changes are necessary
+            with a message and non-zero return code.
+
+    Returns:
+        Success/failure.
+    """
+    import black  # noqa: PLC0415
+    from blacken_docs import format_file  # noqa: PLC0415
+
+    exts = ("md", "py") if exts is None else tuple(ext.lstrip(".") for ext in exts)
+    if exclude:
+        exclude = tuple(re.compile(regex, re.I) if isinstance(regex, str) else regex for regex in exclude)
+    filepaths = set()
+    for path in paths:
+        path = Path(path)  # noqa: PLW2901
+        if path.is_file():
+            filepaths.add(path.as_posix())
+        else:
+            for ext in exts:
+                filepaths |= {filepath.as_posix() for filepath in path.rglob(f"*.{ext}")}
+
+    black_mode = black.Mode(
+        line_length=line_length or black.DEFAULT_LINE_LENGTH,
+        string_normalization=string_normalization,
+        is_pyi=is_pyi,
+        is_ipynb=is_ipynb,
+        skip_source_first_line=skip_source_first_line,
+        magic_trailing_comma=magic_trailing_comma,
+        python_cell_magics=python_cell_magics or set(),
+        preview=preview,
+    )
+    retv = 0
+    for filepath in sorted(filepaths):
+        retv |= format_file(
+            filepath,
+            black_mode,
+            skip_errors=skip_errors,
+            rst_literal_blocks=rst_literal_blocks,
+            check_only=check_only,
+        )
+    return retv

duty/_internal/callables/build.py

@@ -0,0 +1,76 @@
+# YORE: Bump 2: Remove file.
+
+from __future__ import annotations
+
+from typing import Literal
+
+from failprint import lazy
+
+
+@lazy(name="build")
+def run(
+    srcdir: str | None = None,
+    *,
+    version: bool = False,
+    verbose: bool = False,
+    sdist: bool = False,
+    wheel: bool = False,
+    outdir: str | None = None,
+    skip_dependency_check: bool = False,
+    no_isolation: bool = False,
+    installer: Literal["pip", "uv"] | None = None,
+    config_setting: list[str] | None = None,
+) -> None:
+    """Run `build`.
+
+    Parameters:
+        srcdir: Source directory (defaults to current directory).
+        version: Show program's version number and exit.
+        verbose: Increase verbosity
+        sdist: Build a source distribution (disables the default behavior).
+        wheel: Build a wheel (disables the default behavior).
+        outdir: Output directory (defaults to `{srcdir}/dist`).
+        skip_dependency_check: Do not check that build dependencies are installed.
+        no_isolation: Disable building the project in an isolated virtual environment.
+            Build dependencies must be installed separately when this option is used.
+        installer: Python package installer to use (defaults to pip).
+        config_setting: Settings to pass to the backend. Multiple settings can be provided.
+    """
+    from build.__main__ import main as build  # noqa: PLC0415
+
+    cli_args = []
+
+    if srcdir:
+        cli_args.append(srcdir)
+
+    if version:
+        cli_args.append("--version")
+
+    if verbose:
+        cli_args.append("--verbose")
+
+    if sdist:
+        cli_args.append("--sdist")
+
+    if wheel:
+        cli_args.append("--wheel")
+
+    if outdir:
+        cli_args.append("--outdir")
+        cli_args.append(outdir)
+
+    if skip_dependency_check:
+        cli_args.append("--skip-dependency-check")
+
+    if no_isolation:
+        cli_args.append("--no-isolation")
+
+    if installer:
+        cli_args.append("--installer")
+        cli_args.append(installer)
+
+    if config_setting:
+        for setting in config_setting:
+            cli_args.append(f"--config-setting={setting}")
+
+    build(cli_args)