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

duty/callables/twine.py

@@ -1,284 +1,17 @@
-"""Callable for [Twine](https://github.com/pypa/twine)."""
+"""Deprecated. Use [`duty.tools.twine`][] instead."""
 
-from __future__ import annotations
+# YORE: Bump 2: Remove file.
 
-from failprint.lazy import lazy
+import warnings
+from typing import Any
 
+from duty._internal.callables import twine as _twine
 
-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)
+def __getattr__(name: str) -> Any:
+    warnings.warn(
+        "Callables are deprecated in favor of tools, use `duty.tools.twine` instead of `duty.callables.twine`.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return getattr(_twine, name)

duty/cli.py

@@ -1,323 +1,17 @@
-"""Module that contains the command line application."""
+"""Deprecated. Import from `duty` directly."""
 
-# Why does this file exist, and why not put this in `__main__`?
-#
-# You might be tempted to import things from `__main__` later,
-# but that will cause problems: the code will get executed twice:
-#
-# - When you run `python -m duty` python will execute
-#   `__main__.py` as a script. That means there won't be any
-#   `duty.__main__` in `sys.modules`.
-# - When you import `__main__` it will get executed again (as a module) because
-#   there's no `duty.__main__` in `sys.modules`.
+# YORE: Bump 2: Remove file.
 
-from __future__ import annotations
-
-import argparse
-import inspect
-import sys
-import textwrap
-from pathlib import Path
+import warnings
 from typing import Any
 
-from failprint.cli import ArgParser, add_flags
-
-from duty import debug
-from duty.collection import Collection, Duty
-from duty.exceptions import DutyFailure
-from duty.validation import validate
-
-empty = inspect.Signature.empty
-
-
-class _DebugInfo(argparse.Action):
-    def __init__(self, nargs: int | str | None = 0, **kwargs: Any) -> None:
-        super().__init__(nargs=nargs, **kwargs)
-
-    def __call__(self, *args: Any, **kwargs: Any) -> None:  # noqa: ARG002
-        debug.print_debug_info()
-        sys.exit(0)
-
-
-def get_parser() -> ArgParser:
-    """Return the CLI argument parser.
-
-    Returns:
-        An argparse parser.
-    """
-    usage = "duty [GLOBAL_OPTS...] [DUTY [DUTY_OPTS...] [DUTY_PARAMS...]...]"
-    description = "A simple task runner."
-    parser = ArgParser(add_help=False, usage=usage, description=description)
-
-    parser.add_argument(
-        "-d",
-        "--duties-file",
-        default="duties.py",
-        help="Python file where the duties are defined.",
-    )
-    parser.add_argument(
-        "-l",
-        "--list",
-        action="store_true",
-        dest="list",
-        help="List the available duties.",
-    )
-    parser.add_argument(
-        "-h",
-        "--help",
-        dest="help",
-        nargs="*",
-        metavar="DUTY",
-        help="Show this help message and exit. Pass duties names to print their help.",
-    )
-    parser.add_argument(
-        "--completion",
-        dest="completion",
-        action="store_true",
-        help=argparse.SUPPRESS,
-    )
-    parser.add_argument(
-        "--complete",
-        dest="complete",
-        action="store_true",
-        help=argparse.SUPPRESS,
-    )
-    parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {debug.get_version()}")
-    parser.add_argument("--debug-info", action=_DebugInfo, help="Print debug information.")
-
-    add_flags(parser, set_defaults=False)
-    parser.add_argument("remainder", nargs=argparse.REMAINDER)
-
-    parser._optionals.title = "Global options"
+from duty._internal import cli
 
-    return parser
 
-
-def split_args(args: list[str], names: list[str]) -> list[list[str]]:
-    """Split command line arguments into duty commands.
-
-    Parameters:
-        args: The CLI arguments.
-        names: The known duty names.
-
-    Raises:
-        ValueError: When a duty name is missing before an argument,
-            or when the duty name is unknown.
-
-    Returns:
-        The split commands.
-    """
-    arg_lists = []
-    current_arg_list: list[str] = []
-
-    for arg in args:
-        if arg in names:
-            # We found a duty name.
-            if current_arg_list:
-                # Append the previous arg list to the result and reset it.
-                arg_lists.append(current_arg_list)
-                current_arg_list = []
-            current_arg_list.append(arg)
-        elif current_arg_list:
-            # We found an argument.
-            current_arg_list.append(arg)
-        else:
-            # We found an argument but no duty name.
-            raise ValueError(f"> Missing duty name before argument '{arg}', or unknown duty name")
-
-    # Don't forget the last arg list.
-    if current_arg_list:
-        arg_lists.append(current_arg_list)
-
-    return arg_lists
-
-
-def get_duty_parser(duty: Duty) -> ArgParser:
-    """Get a duty-specific options parser.
-
-    Parameters:
-        duty: The duty to parse for.
-
-    Returns:
-        A duty-specific parser.
-    """
-    parser = ArgParser(
-        prog=f"duty {duty.name}",
-        add_help=False,
-        description=duty.description,
-        formatter_class=argparse.RawDescriptionHelpFormatter,
+def __getattr__(name: str) -> Any:
+    warnings.warn(
+        "Importing from `duty.cli` is deprecated. Import from `duty` directly.",
+        DeprecationWarning,
+        stacklevel=2,
     )
-    add_flags(parser, set_defaults=False)
-    return parser
-
-
-def specified_options(opts: argparse.Namespace, exclude: set[str] | None = None) -> dict:
-    """Cast an argparse Namespace into a dictionary of options.
-
-    Remove all options that were not specified (equal to None).
-
-    Parameters:
-        opts: The namespace to cast.
-        exclude: Names of options to exclude from the result.
-
-    Returns:
-        A dictionary of specified-only options.
-    """
-    exclude = exclude or set()
-    options = opts.__dict__.items()
-    return {opt: value for opt, value in options if value is not None and opt not in exclude}
-
-
-def parse_options(duty: Duty, args: list[str]) -> tuple[dict, list[str]]:
-    """Parse options for a duty.
-
-    Parameters:
-        duty: The duty to parse for.
-        args: The CLI args passed for this duty.
-
-    Returns:
-        The parsed opts, and the remaining arguments.
-    """
-    parser = get_duty_parser(duty)
-    opts, remainder = parser.parse_known_args(args)
-    return specified_options(opts), remainder
-
-
-def parse_args(duty: Duty, args: list[str]) -> tuple:
-    """Parse the positional and keyword arguments of a duty.
-
-    Parameters:
-        duty: The duty to parse for.
-        args: The list of arguments.
-
-    Returns:
-        The positional and keyword arguments.
-    """
-    posargs = []
-    kwargs = {}
-
-    for arg in args:
-        if "=" in arg:
-            # we found a keyword argument
-            arg_name, arg_value = arg.split("=", 1)
-            kwargs[arg_name] = arg_value
-        else:
-            # we found a positional argument
-            posargs.append(arg)
-
-    return validate(duty.function, *posargs, **kwargs)
-
-
-def parse_commands(arg_lists: list[list[str]], global_opts: dict[str, Any], collection: Collection) -> list[tuple]:
-    """Parse argument lists into ready-to-run duties.
-
-    Parameters:
-        arg_lists: Lists of arguments lists.
-        global_opts: The global options.
-        collection: The duties collection.
-
-    Returns:
-        A list of tuples composed of:
-
-            - a duty
-            - its positional arguments
-            - its keyword arguments
-    """
-    commands = []
-    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
-
-
-def print_help(parser: ArgParser, opts: argparse.Namespace, collection: Collection) -> None:
-    """Print general help or duties help.
-
-    Parameters:
-        parser: The main parser.
-        opts: The main parsed options.
-        collection: A collection of duties.
-    """
-    if opts.help:
-        for duty_name in opts.help:
-            try:
-                duty = collection.get(duty_name)
-            except KeyError:
-                print(f"> Unknown duty '{duty_name}'")
-            else:
-                print(get_duty_parser(duty).format_help())
-    else:
-        print(parser.format_help())
-        print("Available duties:")
-        print(textwrap.indent(collection.format_help(), prefix="  "))
-
-
-def main(args: list[str] | None = None) -> int:
-    """Run the main program.
-
-    This function is executed when you type `duty` or `python -m duty`.
-
-    Parameters:
-        args: Arguments passed from the command line.
-
-    Returns:
-        An exit code.
-    """
-    parser = get_parser()
-    opts = parser.parse_args(args=args)
-    remainder = opts.remainder
-
-    collection = Collection(opts.duties_file)
-    collection.load()
-
-    if opts.completion:
-        print(Path(__file__).parent.joinpath("completions.bash").read_text())
-        return 0
-
-    if opts.complete:
-        words = collection.completion_candidates(remainder)
-        words += sorted(
-            opt for opt, action in parser._option_string_actions.items() if action.help != argparse.SUPPRESS
-        )
-        print(*words, sep="\n")
-        return 0
-
-    if opts.help is not None:
-        print_help(parser, opts, collection)
-        return 0
-
-    if opts.list:
-        print(textwrap.indent(collection.format_help(), prefix="  "))
-        return 0
-
-    try:
-        arg_lists = split_args(remainder, collection.names())
-    except ValueError as error:
-        print(error, file=sys.stderr)
-        return 1
-
-    if not arg_lists:
-        print_help(parser, opts, collection)
-        return 1
-
-    global_opts = specified_options(
-        opts,
-        exclude={"duties_file", "list", "help", "remainder", "complete", "completion"},
-    )
-    try:
-        commands = parse_commands(arg_lists, global_opts, collection)
-    except TypeError as error:
-        print(f"> {error}", file=sys.stderr)
-        return 1
-
-    for duty, posargs, kwargs in commands:
-        try:
-            duty.run(*posargs, **kwargs)
-        except DutyFailure as failure:
-            return failure.code
-
-    return 0
+    return getattr(cli, name)