duty 1.5.0__py3-none-any.whl → 1.6.1__py3-none-any.whl

duty/callables/flake8.py

@@ -1,222 +1,17 @@
-"""Callable for [Flake8](https://github.com/PyCQA/flake8)."""
+"""Deprecated. Use [`duty.tools.flake8`][] instead."""
 
-from __future__ import annotations
+# YORE: Bump 2: Remove file.
 
-import sys
-from typing import Literal
+import warnings
+from typing import Any
 
-from failprint.lazy import lazy
+from duty._internal.callables import flake8 as _flake8
 
 
-@lazy(name="flake8")
-def run(
-    *paths: str,
-    config: str | None = None,
-    verbose: bool | None = None,
-    output_file: str | None = None,
-    append_config: str | None = None,
-    isolated: bool | None = None,
-    enable_extensions: list[str] | None = None,
-    require_plugins: list[str] | None = None,
-    quiet: bool | None = None,
-    color: Literal["auto", "always", "never"] | None = None,
-    count: bool | None = None,
-    exclude: list[str] | None = None,
-    extend_exclude: list[str] | None = None,
-    filename: list[str] | None = None,
-    stdin_display_name: str | None = None,
-    error_format: str | None = None,
-    hang_closing: bool | None = None,
-    ignore: list[str] | None = None,
-    extend_ignore: list[str] | None = None,
-    per_file_ignores: dict[str, list[str]] | None = None,
-    max_line_length: int | None = None,
-    max_doc_length: int | None = None,
-    indent_size: int | None = None,
-    select: list[str] | None = None,
-    extend_select: list[str] | None = None,
-    disable_noqa: bool | None = None,
-    show_source: bool | None = None,
-    no_show_source: bool | None = None,
-    statistics: bool | None = None,
-    exit_zero: bool | None = None,
-    jobs: int | None = None,
-    tee: bool | None = None,
-    benchmark: bool | None = None,
-    bug_report: bool | None = None,
-) -> int:
-    """Run `flake8`.
-
-    Parameters:
-        *paths: Paths to check.
-        config: Path to the config file that will be the authoritative config source.
-            This will cause Flake8 to ignore all other configuration files.
-        verbose: Print more information about what is happening in flake8.
-            This option is repeatable and will increase verbosity each time it is repeated.
-        output_file: Redirect report to a file.
-        append_config: Provide extra config files to parse in addition to the files found by Flake8 by default.
-            These files are the last ones read and so they take the highest precedence when multiple files provide the same option.
-        isolated: Ignore all configuration files.
-        enable_extensions: Enable plugins and extensions that are otherwise disabled by default.
-        require_plugins: Require specific plugins to be installed before running.
-        quiet: Report only file names, or nothing. This option is repeatable.
-        color: Whether to use color in output. Defaults to `auto`.
-        count: Print total number of errors to standard output and set the exit code to 1 if total is not empty.
-        exclude: Comma-separated list of files or directories to exclude (default: ['.svn', 'CVS', '.bzr', '.hg', '.git', '__pycache__', '.tox', '.nox', '.eggs', '*.egg']).
-        extend_exclude: Comma-separated list of files or directories to add to the list of excluded ones.
-        filename: Only check for filenames matching the patterns in this comma-separated list (default: ['*.py']).
-        stdin_display_name: The name used when reporting errors from code passed via stdin. This is useful for editors piping the file contents to flake8 (default: stdin).
-        error_format: Format errors according to the chosen formatter.
-        hang_closing: Hang closing bracket instead of matching indentation of opening bracket's line.
-        ignore: Comma-separated list of error codes to ignore (or skip). For example, ``--ignore=E4,E51,W234`` (default: E121,E123,E126,E226,E24,E704,W503,W504).
-        extend_ignore: Comma-separated list of error codes to add to the list of ignored ones. For example, ``--extend-ignore=E4,E51,W234``.
-        per_file_ignores: A pairing of filenames and violation codes that defines which violations to ignore in a particular file. The filenames can be specified in a manner similar to the ``--exclude`` option and the violations work similarly to the ``--ignore`` and ``--select`` options.
-        max_line_length: Maximum allowed line length for the entirety of this run (default: 79).
-        max_doc_length: Maximum allowed doc line length for the entirety of this run (default: None).
-        indent_size: Number of spaces used for indentation (default: 4).
-        select: Comma-separated list of error codes to enable. For example, ``--select=E4,E51,W234`` (default: E,F,W,C90).
-        extend_select: Comma-separated list of error codes to add to the list of selected ones. For example, ``--extend-select=E4,E51,W234``.
-        disable_noqa: Disable the effect of "# noqa". This will report errors on lines with "# noqa" at the end.
-        show_source: Show the source generate each error or warning.
-        no_show_source: Negate --show-source.
-        statistics: Count errors.
-        exit_zero: Exit with status code "0" even if there are errors.
-        jobs: Number of subprocesses to use to run checks in parallel. This is ignored on Windows. The default, "auto", will auto-detect the number of processors available to use (default: auto).
-        tee: Write to stdout and output-file.
-        benchmark: Print benchmark information about this run of Flake8.
-        bug_report: Print information necessary when preparing a bug report.
-
-    Returns:
-        Success/failure.
-    """
-    from flake8.main import main as flake8
-
-    cli_args = list(paths)
-
-    if verbose:
-        cli_args.append("--verbose")
-
-    if output_file:
-        cli_args.append("--output-file")
-        cli_args.append(output_file)
-
-    if append_config:
-        cli_args.append("--append-config")
-        cli_args.append(append_config)
-
-    if config:
-        cli_args.append("--config")
-        cli_args.append(config)
-
-    if isolated:
-        cli_args.append("--isolated")
-
-    if enable_extensions:
-        cli_args.append("--enable-extensions")
-        cli_args.append(",".join(enable_extensions))
-
-    if require_plugins:
-        cli_args.append("--require-plugins")
-        cli_args.append(",".join(require_plugins))
-
-    if quiet:
-        cli_args.append("--quiet")
-
-    if color:
-        cli_args.append("--color")
-        cli_args.append(color)
-
-    if count:
-        cli_args.append("--count")
-
-    if exclude:
-        cli_args.append("--exclude")
-        cli_args.append(",".join(exclude))
-
-    if extend_exclude:
-        cli_args.append("--extend-exclude")
-        cli_args.append(",".join(extend_exclude))
-
-    if filename:
-        cli_args.append("--filename")
-        cli_args.append(",".join(filename))
-
-    if stdin_display_name:
-        cli_args.append("--stdin-display-name")
-        cli_args.append(stdin_display_name)
-
-    if error_format:
-        cli_args.append("--format")
-        cli_args.append(error_format)
-
-    if hang_closing:
-        cli_args.append("--hang-closing")
-
-    if ignore:
-        cli_args.append("--ignore")
-        cli_args.append(",".join(ignore))
-
-    if extend_ignore:
-        cli_args.append("--extend-ignore")
-        cli_args.append(",".join(extend_ignore))
-
-    if per_file_ignores:
-        cli_args.append("--per-file-ignores")
-        cli_args.append(
-            " ".join(f"{path}:{','.join(codes)}" for path, codes in per_file_ignores.items()),
-        )
-
-    if max_line_length:
-        cli_args.append("--max-line-length")
-        cli_args.append(str(max_line_length))
-
-    if max_doc_length:
-        cli_args.append("--max-doc-length")
-        cli_args.append(str(max_doc_length))
-
-    if indent_size:
-        cli_args.append("--indent-size")
-        cli_args.append(str(indent_size))
-
-    if select:
-        cli_args.append("--select")
-        cli_args.append(",".join(select))
-
-    if extend_select:
-        cli_args.append("--extend-select")
-        cli_args.append(",".join(extend_select))
-
-    if disable_noqa:
-        cli_args.append("--disable-noqa")
-
-    if show_source:
-        cli_args.append("--show-source")
-
-    if no_show_source:
-        cli_args.append("--no-show-source")
-
-    if statistics:
-        cli_args.append("--statistics")
-
-    if exit_zero:
-        cli_args.append("--exit-zero")
-
-    if jobs:
-        cli_args.append("--jobs")
-        cli_args.append(str(jobs))
-
-    if tee:
-        cli_args.append("--tee")
-
-    if benchmark:
-        cli_args.append("--benchmark")
-
-    if bug_report:
-        cli_args.append("--bug-report")
-
-    old_sys_argv = sys.argv
-    sys.argv = ["flake*", *cli_args]
-    try:
-        return flake8()
-    finally:
-        sys.argv = old_sys_argv
+def __getattr__(name: str) -> Any:
+    warnings.warn(
+        "Callables are deprecated in favor of tools, use `duty.tools.flake8` instead of `duty.callables.flake8`.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return getattr(_flake8, name)

duty/callables/git_changelog.py

@@ -1,178 +1,17 @@
-"""Callable for [git-changelog](https://github.com/pawamoy/git-changelog)."""
+"""Deprecated. Use [`duty.tools.git_changelog`][] instead."""
 
-from __future__ import annotations
+# YORE: Bump 2: Remove file.
 
-from typing import Literal
+import warnings
+from typing import Any
 
-from failprint.lazy import lazy
+from duty._internal.callables import git_changelog as _git_changelog
 
 
-@lazy(name="git_changelog")
-def run(
-    repository: str | None = None,
-    *,
-    config_file: str | None = None,
-    bump: str | None = None,
-    versioning: Literal["semver", "pep440"] | None = None,
-    in_place: bool = False,
-    version_regex: str | None = None,
-    marker_line: str | None = None,
-    output: str | None = None,
-    provider: Literal["github", "gitlab", "bitbucket"] | None = None,
-    parse_refs: bool = False,
-    release_notes: bool = False,
-    input: str | None = None,  # noqa: A002
-    convention: Literal["basic", "angular", "conventional"] | None = None,
-    sections: list[str] | None = None,
-    template: str | None = None,
-    git_trailers: bool = False,
-    omit_empty_versions: bool = False,
-    no_zerover: bool = False,
-    filter_commits: str | None = None,
-    jinja_context: list[str] | None = None,
-    version: bool = False,
-    debug_info: bool = False,
-) -> None:
-    r"""Run `git-changelog`.
-
-    Parameters:
-        repository: The repository path, relative or absolute. Default: current working directory.
-        config_file: Configuration file(s).
-        bump: Specify the bump from latest version for the set of unreleased commits.
-            Can be one of `auto`, `major`, `minor`, `patch` or a valid SemVer version (eg. 1.2.3).
-            For both SemVer and PEP 440 versioning schemes (see -n), `auto` will bump the major number
-            if a commit contains breaking changes (or the minor number for 0.x versions, see -Z),
-            else the minor number if there are new features, else the patch number. Default: unset (false).
-        versioning: Versioning scheme to use when bumping and comparing versions.
-            The selected scheme will impact the values accepted by the `--bump` option.
-            Supported: `pep440`, `semver`.
-
-            PEP 440 provides the following bump strategies: `auto`, `epoch`, `release`, `major`, `minor`, `micro`, `patch`,
-            `pre`, `alpha`, `beta`, `candidate`, `post`, `dev`.
-            Values `auto`, `major`, `minor`, `micro` can be suffixed with one of `+alpha`, `+beta`, `+candidate`, and/or `+dev`.
-            Values `alpha`, `beta` and `candidate` can be suffixed with `+dev`.
-            Examples: `auto+alpha`, `major+beta+dev`, `micro+dev`, `candidate+dev`, etc..
-
-            SemVer provides the following bump strategies: `auto`, `major`, `minor`, `patch`, `release`.
-            See the docs for more information. Default: unset (`semver`).
-        in_place: Insert new entries (versions missing from changelog) in-place.
-            An output file must be specified. With custom templates, you can pass two additional
-            arguments: `--version-regex` and `--marker-line`.
-            When writing in-place, an `in_place` variable will be injected in the Jinja context,
-            allowing to adapt the generated contents (for example to skip changelog headers or footers).
-            Default: unset (false).
-        version_regex: A regular expression to match versions in the existing changelog
-            (used to find the latest release) when writing in-place.
-            The regular expression must be a Python regex with a `version` named group.
-            Default: `^## \[(?P<version>v?[^\]]+)`.
-        marker_line: A marker line at which to insert new entries (versions missing from changelog).
-            If two marker lines are present in the changelog, the contents between those two lines
-            will be overwritten (useful to update an 'Unreleased' entry for example). Default: `<!-- insertion marker -->`.
-        output: Output to given file. Default: standard output.
-        provider: Explicitly specify the repository provider. Default: unset.
-        parse_refs: Parse provider-specific references in commit messages (GitHub/GitLab/Bitbucket issues, PRs, etc.).
-            Default: unset (false).
-        release_notes: Output release notes to stdout based on the last entry in the changelog. Default: unset (false).
-        input: Read from given file when creating release notes. Default: `CHANGELOG.md`.
-        convention: The commit convention to match against. Default: `basic`.
-        sections: A comma-separated list of sections to render.
-            See the available sections for each supported convention in the description. Default: unset (None).
-        template: The Jinja2 template to use.
-            Prefix it with `path:` to specify the path to a Jinja templated file. Default: `keepachangelog`.
-        git_trailers: Parse Git trailers in the commit message.
-            See https://git-scm.com/docs/git-interpret-trailers. Default: unset (false).
-        omit_empty_versions: Omit empty versions from the output. Default: unset (false).
-        no_zerover: By default, breaking changes on a 0.x don't bump the major version, maintaining it at 0.
-            With this option, a breaking change will bump a 0.x version to 1.0.
-        filter_commits: The Git revision-range filter to use (e.g. `v1.2.0..`). Default: no filter.
-        jinja_context: Pass additional key/value pairs to the template.
-            Option can be used multiple times.
-            The key/value pairs are accessible as 'jinja_context' in the template.
-        version: Show the current version of the program and exit.
-        debug_info: Print debug information.
-    """
-    from git_changelog.cli import main as git_changelog
-
-    cli_args = []
-
-    if repository:
-        cli_args.append(repository)
-
-    if config_file:
-        cli_args.append("--config-file")
-        cli_args.append(config_file)
-
-    if bump:
-        cli_args.append("--bump")
-        cli_args.append(bump)
-
-    if versioning:
-        cli_args.append("--versioning")
-        cli_args.append(versioning)
-
-    if in_place:
-        cli_args.append("--in-place")
-
-    if version_regex:
-        cli_args.append("--version-regex")
-        cli_args.append(version_regex)
-
-    if marker_line:
-        cli_args.append("--marker-line")
-        cli_args.append(marker_line)
-
-    if output:
-        cli_args.append("--output")
-        cli_args.append(output)
-
-    if provider:
-        cli_args.append("--provider")
-        cli_args.append(provider)
-
-    if parse_refs:
-        cli_args.append("--parse-refs")
-
-    if release_notes:
-        cli_args.append("--release-notes")
-
-    if input:
-        cli_args.append("--input")
-        cli_args.append(input)
-
-    if convention:
-        cli_args.append("--convention")
-        cli_args.append(convention)
-
-    if sections:
-        cli_args.append("--sections")
-        cli_args.append(",".join(sections))
-
-    if template:
-        cli_args.append("--template")
-        cli_args.append(template)
-
-    if git_trailers:
-        cli_args.append("--git-trailers")
-
-    if omit_empty_versions:
-        cli_args.append("--omit-empty-versions")
-
-    if no_zerover:
-        cli_args.append("--no-zerover")
-
-    if filter_commits:
-        cli_args.append("--filter-commits")
-        cli_args.append(filter_commits)
-
-    if jinja_context:
-        for key_value in jinja_context:
-            cli_args.append("--jinja-context")
-            cli_args.append(key_value)
-
-    if version:
-        cli_args.append("--version")
-
-    if debug_info:
-        cli_args.append("--debug-info")
-
-    git_changelog(cli_args)
+def __getattr__(name: str) -> Any:
+    warnings.warn(
+        "Callables are deprecated in favor of tools, use `duty.tools.git_changelog` instead of `duty.callables.git_changelog`.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return getattr(_git_changelog, name)

duty/callables/griffe.py

@@ -1,227 +1,17 @@
-"""Callable for [Griffe](https://github.com/mkdocstrings/griffe)."""
+"""Deprecated. Use [`duty.tools.griffe`][] instead."""
 
-from __future__ import annotations
+# YORE: Bump 2: Remove file.
 
-from typing import Literal
+import warnings
+from typing import Any
 
-from failprint.lazy import lazy
+from duty._internal.callables import griffe as _griffe
 
 
-def run(*args: str, version: bool = False, debug_info: bool = False) -> None:
-    """Run `griffe`.
-
-    Parameters:
-        *args: CLI arguments.
-        version: Show program's version number and exit.
-        debug_info: Print debug information.
-    """
-    from griffe.cli import main as griffe
-
-    cli_args = []
-
-    # --version and --debug-info must appear first.
-    if version:
-        cli_args.append("--version")
-
-    if debug_info:
-        cli_args.append("--debug-info")
-
-    cli_args.extend(args)
-
-    griffe(cli_args)
-
-
-@lazy(name="griffe.check")
-def check(
-    package: str,
-    *,
-    against: str | None = None,
-    base_ref: str | None = None,
-    color: bool = False,
-    verbose: bool = False,
-    format: Literal["oneline", "verbose", "markdown", "github"] | None = None,  # noqa: A002
-    search: list[str] | None = None,
-    sys_path: bool = False,
-    find_stubs_packages: bool = False,
-    extensions: str | list[str] | None = None,
-    inspection: bool | None = None,
-    log_level: Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] | None = None,
-    version: bool = False,
-    debug_info: bool = False,
-) -> None:
-    """Check for API breakages or possible improvements.
-
-    Parameters:
-        package: Package to find, load and check, as path.
-        against: Older Git reference (commit, branch, tag) to check against. Default: load latest tag.
-        base_ref: Git reference (commit, branch, tag) to check. Default: load current code.
-        color: Force enable/disable colors in the output.
-        verbose: Verbose output.
-        format: Output format.
-        search: Paths to search packages into.
-        sys_path: Whether to append `sys.path` to search paths specified with `-s`.
-        find_stubs_packages: Whether to look for stubs-only packages and merge them with concrete ones.
-        extensions: A comma-separated list or a JSON list of extensions to load.
-        inspection: Whether to disallow or force inspection (dynamic analysis).
-            By default, Griffe tries to use static analysis and falls back to dynamic analysis when it can't.
-        log_level: Set the log level: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.
-        version: Show program's version number and exit.
-        debug_info: Print debug information.
-    """
-    cli_args = []
-
-    if package:
-        cli_args.append(package)
-
-    if against:
-        cli_args.append("--against")
-        cli_args.append(against)
-
-    if base_ref:
-        cli_args.append("--base-ref")
-        cli_args.append(base_ref)
-
-    if color is True:
-        cli_args.append("--color")
-    elif color is False:
-        cli_args.append("--no-color")
-
-    if verbose:
-        cli_args.append("--verbose")
-
-    if format:
-        cli_args.append("--format")
-        cli_args.append(format)
-
-    if search:
-        for path in search:
-            cli_args.append("--search")
-            cli_args.append(path)
-
-    if sys_path:
-        cli_args.append("--sys-path")
-
-    if find_stubs_packages:
-        cli_args.append("--find-stubs-packages")
-
-    if extensions:
-        cli_args.append("--extensions")
-        if isinstance(extensions, str):
-            cli_args.append(extensions)
-        else:
-            cli_args.append(",".join(extensions))
-
-    if inspection is True:
-        cli_args.append("--force-inspection")
-    elif inspection is False:
-        cli_args.append("--no-inspection")
-
-    if log_level:
-        cli_args.append("--log-level")
-        cli_args.append(log_level)
-
-    run("check", *cli_args, version=version, debug_info=debug_info)
-
-
-@lazy(name="griffe.dump")
-def dump(
-    *packages: str,
-    full: bool = False,
-    output: str | None = None,
-    docstyle: str | None = None,
-    docopts: str | None = None,
-    resolve_aliases: bool = False,
-    resolve_implicit: bool = False,
-    resolve_external: bool | None = None,
-    stats: bool = False,
-    search: list[str] | None = None,
-    sys_path: bool = False,
-    find_stubs_packages: bool = False,
-    extensions: str | list[str] | None = None,
-    inspection: bool | None = None,
-    log_level: Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] | None = None,
-    version: bool = False,
-    debug_info: bool = False,
-) -> None:
-    """Load package-signatures and dump them as JSON.
-
-    Parameters:
-        packages: Packages to find, load and dump.
-        full: Whether to dump full data in JSON.
-        output: Output file. Supports templating to output each package in its own file, with `{package}`.
-        docstyle: The docstring style to parse.
-        docopts: The options for the docstring parser.
-        resolve_aliases: Whether to resolve aliases.
-        resolve_implicit: Whether to resolve implicitely exported aliases as well. Aliases are explicitely exported when defined in `__all__`.
-        resolve_external: Whether to resolve aliases pointing to external/unknown modules (not loaded directly).
-            Default is to resolve only from one module to its private sibling (`ast` -> `_ast`).
-        stats: Show statistics at the end.
-        search: Paths to search packages into.
-        sys_path: Whether to append `sys.path` to search paths specified with `-s`.
-        find_stubs_packages: Whether to look for stubs-only packages and merge them with concrete ones.
-        extensions: A comma-separated list or a JSON list of extensions to load.
-        inspection: Whether to disallow or force inspection (dynamic analysis).
-            By default, Griffe tries to use static analysis and falls back to dynamic analysis when it can't.
-        log_level: Set the log level: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.
-        version: Show program's version number and exit.
-        debug_info: Print debug information.
-    """
-    cli_args = list(packages)
-
-    if full:
-        cli_args.append("--full")
-
-    if output:
-        cli_args.append("--output")
-        cli_args.append(output)
-
-    if docstyle:
-        cli_args.append("--docstyle")
-        cli_args.append(docstyle)
-
-    if docopts:
-        cli_args.append("--docopts")
-        cli_args.append(docopts)
-
-    if resolve_aliases:
-        cli_args.append("--resolve-aliases")
-
-    if resolve_implicit:
-        cli_args.append("--resolve-implicit")
-
-    if resolve_external is True:
-        cli_args.append("--resolve-external")
-    elif resolve_external is False:
-        cli_args.append("--no-resolve-external")
-
-    if stats:
-        cli_args.append("--stats")
-
-    if search:
-        for path in search:
-            cli_args.append("--search")
-            cli_args.append(path)
-
-    if sys_path:
-        cli_args.append("--sys-path")
-
-    if find_stubs_packages:
-        cli_args.append("--find-stubs-packages")
-
-    if extensions:
-        cli_args.append("--extensions")
-        if isinstance(extensions, str):
-            cli_args.append(extensions)
-        else:
-            cli_args.append(",".join(extensions))
-
-    if inspection is True:
-        cli_args.append("--force-inspection")
-    elif inspection is False:
-        cli_args.append("--no-inspection")
-
-    if log_level:
-        cli_args.append("--log-level")
-        cli_args.append(log_level)
-
-    run("check", *cli_args, version=version, debug_info=debug_info)
+def __getattr__(name: str) -> Any:
+    warnings.warn(
+        "Callables are deprecated in favor of tools, use `duty.tools.griffe` instead of `duty.callables.griffe`.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return getattr(_griffe, name)