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

duty/cli.py

@@ -17,6 +17,7 @@ import argparse
 import inspect
 import sys
 import textwrap
+from pathlib import Path
 from typing import Any
 
 from failprint.cli import ArgParser, add_flags
@@ -69,6 +70,18 @@ def get_parser() -> ArgParser:
         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.")
 
@@ -261,6 +274,18 @@ def main(args: list[str] | None = None) -> int:
     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
@@ -279,7 +304,10 @@ def main(args: list[str] | None = None) -> int:
         print_help(parser, opts, collection)
         return 1
 
-    global_opts = specified_options(opts, exclude={"duties_file", "list", "help", "remainder"})
+    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:

duty/collection.py

@@ -143,6 +143,35 @@ class Collection:
         """
         return list(self.duties.keys()) + list(self.aliases.keys())
 
+    def completion_candidates(self, args: tuple[str, ...]) -> list[str]:
+        """Find shell completion candidates within this collection.
+
+        Returns:
+            The list of shell completion candidates, sorted alphabetically.
+        """
+        # Find last duty name in args.
+        name = None
+        names = set(self.names())
+        for arg in reversed(args):
+            if arg in names:
+                name = arg
+                break
+
+        completion_names = sorted(names)
+
+        # If no duty found, return names.
+        if name is None:
+            return completion_names
+
+        params = [
+            f"{param.name}="
+            for param in inspect.signature(self.get(name).function).parameters.values()
+            if param.kind is not param.VAR_POSITIONAL
+        ][1:]
+
+        # If duty found, return names *and* duty parameters.
+        return completion_names + sorted(params)
+
     def get(self, name_or_alias: str) -> Duty:
         """Get a duty by its name or alias.
 

duty/completions.bash

@@ -0,0 +1,30 @@
+# Taken and adapted from pyinvoke:
+# Copyright (c) 2020 Jeff Forcier.
+# All rights reserved.
+
+_complete_duty() {
+    local candidates
+
+    # COMP_WORDS contains the entire command string up til now (including # program name).
+    # We hand it to Invoke so it can figure out the current context:
+    # spit back core options, task names, the current task's options, or some combo.
+    candidates=$(duty --complete -- "${COMP_WORDS[@]}")
+
+    # `compgen -W` takes list of valid options & a partial word & spits back possible matches.
+    # Necessary for any partial word completions
+    # (vs. completions performed when no partial words are present).
+    #
+    # $2 is the current word or token being tabbed on, either empty string or a
+    # partial word, and thus wants to be compgen'd to arrive at some subset of
+    # our candidate list which actually matches.
+    #
+    # COMPREPLY is the list of valid completions handed back to `complete`.
+    COMPREPLY=( $(compgen -W "${candidates}" -- $2) )
+}
+
+
+# Tell shell builtin to use the above for completing our invocations.
+# * -F: use given function name to generate completions.
+# * -o default: when function generates no results, use filenames.
+# * positional args: program names to complete for.
+complete -F _complete_duty -o default duty

duty/tools/__init__.py

@@ -22,12 +22,12 @@ from duty.tools._ruff import ruff
 from duty.tools._safety import safety
 from duty.tools._ssort import ssort
 from duty.tools._twine import twine
+from duty.tools._yore import yore
 
 __all__ = [
-    "Tool",
-    "LazyStdout",
     "LazyStderr",
-    "lazy",
+    "LazyStdout",
+    "Tool",
     "autoflake",
     "black",
     "blacken_docs",
@@ -38,6 +38,7 @@ __all__ = [
     "griffe",
     "interrogate",
     "isort",
+    "lazy",
     "mkdocs",
     "mypy",
     "pytest",
@@ -45,4 +46,5 @@ __all__ = [
     "safety",
     "ssort",
     "twine",
+    "yore",
 ]

duty/tools/_yore.py

@@ -0,0 +1,54 @@
+"""Callable for [Yore](https://github.com/pawamoy/yore)."""
+
+from __future__ import annotations
+
+from duty.tools._base import Tool
+
+
+class yore(Tool):  # noqa: N801
+    """Call [Yore](https://github.com/pawamoy/yore)."""
+
+    cli_name = "yore"
+
+    @classmethod
+    def check(
+        cls,
+        *paths: str,
+        bump: str | None = None,
+        eol_within: str | None = None,
+        bol_within: str | None = None,
+    ) -> yore:
+        """Checks Yore comments against Python EOL dates or the provided next version of your project.
+
+        Parameters:
+            paths: Path to files or directories to check.
+            bump: The next version of your project.
+            eol_within: The time delta to start checking before the End of Life of a Python version.
+                It is provided in a human-readable format, like `2 weeks` or `1 month`.
+                Spaces are optional, and the unit can be shortened to a single letter:
+                `d` for days, `w` for weeks, `m` for months, and `y` for years.
+            bol_within: The time delta to start checking before the Beginning of Life of a Python version.
+                It is provided in a human-readable format, like `2 weeks` or `1 month`.
+                Spaces are optional, and the unit can be shortened to a single letter:
+                `d` for days, `w` for weeks, `m` for months, and `y` for years.
+        """
+        cli_args = ["check", *paths]
+
+        if bump:
+            cli_args.append("--bump")
+            cli_args.append(bump)
+
+        if eol_within:
+            cli_args.append("--eol-within")
+            cli_args.append(eol_within)
+
+        if bol_within:
+            cli_args.append("--bol-within")
+            cli_args.append(bol_within)
+
+        return cls(cli_args)
+
+    def __call__(self) -> int:
+        from yore import main as run_yore
+
+        return run_yore(self.cli_args)

{duty-1.4.3.dist-info → duty-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: duty
-Version: 1.4.3
+Version: 1.6.0
 Summary: A simple task runner.
 Keywords: task-runner,task,runner,cross-platform
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>

{duty-1.4.3.dist-info → duty-1.6.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-duty-1.4.3.dist-info/METADATA,sha256=v58pX-GBakOWoOGNVIUkNkkA66B3UcO1Zbjtm3yazyo,2710
-duty-1.4.3.dist-info/WHEEL,sha256=pM0IBB6ZwH3nkEPhtcp50KvKNX-07jYtnb1g1m6Z4Co,90
-duty-1.4.3.dist-info/entry_points.txt,sha256=XZTh9yTgC9GDFmNoVeOqgKT6BCMifkCToilIj77B9ss,55
-duty-1.4.3.dist-info/licenses/LICENSE,sha256=nQxdYSduhkgEpOTmg4yyIMmFPzcr2qrlUl8Tf9QZPug,754
+duty-1.6.0.dist-info/METADATA,sha256=wUMy0aPyCI_pbGwg8EpYXorgI5-I_hHo9rr6uA1lNdo,2710
+duty-1.6.0.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+duty-1.6.0.dist-info/entry_points.txt,sha256=XZTh9yTgC9GDFmNoVeOqgKT6BCMifkCToilIj77B9ss,55
+duty-1.6.0.dist-info/licenses/LICENSE,sha256=nQxdYSduhkgEpOTmg4yyIMmFPzcr2qrlUl8Tf9QZPug,754
 duty/__init__.py,sha256=2fdBMNEBXYSCnV1GQm56VGe8VuvMp79-Hj3SHrAb5MM,144
 duty/__main__.py,sha256=4YvloGDKmyVzOsE6ZdyCQyY0Jsl0LSlbqkO2UDExgmI,333
 duty/callables/__init__.py,sha256=R42f1qpIy7m2MMbs6Xc_OnQiEARr4g2Pghpp9ry4JFI,1042
@@ -23,14 +23,15 @@ duty/callables/ruff.py,sha256=ZBjl1_MxaZ1-atHVB6YOFNf3QAm6GTw7Xj3hX8jnofo,13314
 duty/callables/safety.py,sha256=ClwwAnDdZFG71_Fbh5X2XEGSPI8PZRy4-Jz6zq2amV4,2454
 duty/callables/ssort.py,sha256=Lqak-xfJtKkj3AaI4_jPeaRkZ9SbvMCYhoUIVVHE6s8,842
 duty/callables/twine.py,sha256=hsp8TcOYlbHCCqRwglDmNHS55LdnXFd-n2tFaJkMafs,9511
-duty/cli.py,sha256=9uca96F31uTzWJuREU0ReWGhXntvjQaoSW6ZkUxBTV4,8521
-duty/collection.py,sha256=Xp85w6R4Lxv9A3IcdG2ZRtOJdyf1CXSlYr6-N0wBzwo,6584
+duty/cli.py,sha256=XnkVQAmHCf5QAykZ4foiLvBrsSD22dhSljXmLdFhWM4,9273
+duty/collection.py,sha256=cg_rInuTErP7HTrUJsHenOSdtFZtzIw8cIIsr5g-0T8,7500
+duty/completions.bash,sha256=7-JMwnzlvRLGv3eK55dIahDsuQCqmAGSLvxXRyeQ60M,1293
 duty/context.py,sha256=YVF68a2w3SMEM0AsN1mBCvlOZ5jTEZ9OYCxDZvv_soI,3250
 duty/debug.py,sha256=9stdqxNJ9zA2HWsYfmy3C9BrWOXLlHYRGsQ6dHfCUfM,2813
 duty/decorator.py,sha256=3puIe45Q_5vOVXlr71eFayHS1Swz6YdNANHOnDnHDk0,2984
 duty/exceptions.py,sha256=gTtqtqOiMroP5-83kC5jakuwBfYKpzCQHE9RWfAGRv0,358
 duty/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-duty/tools/__init__.py,sha256=soQxh0HEwSV5zZhfv5DEIpBonk53-JRE0YvcXfWvPI8,1179
+duty/tools/__init__.py,sha256=btCGiw-6e2CD_VPbUCvmZFNqGvmkwaw6gnkpNQBJm6Y,1225
 duty/tools/_autoflake.py,sha256=wDqNyfuC6rju9LqyTTimaQZs_8v7YvYECzdltO5rof0,5285
 duty/tools/_base.py,sha256=MpjsSguxu_O6HAOkIy0hZdP2RkguS-NGVhYQHPnurWA,1474
 duty/tools/_black.py,sha256=avo5-J2gHeXlOneYC0j1PSV7J-QFfPFUTdbwczsMvrA,7907
@@ -49,5 +50,6 @@ duty/tools/_ruff.py,sha256=LftbwvIahvjZQPc3ksLmP34a26dK22rafkpL7VQyoXc,15224
 duty/tools/_safety.py,sha256=D0ID65aeSCx6ZG01jZVSik075YkojjoYb8DoRtaz4X8,3206
 duty/tools/_ssort.py,sha256=xhh5eYq16BC8KTSKDCxA10mR8RZoQuN10-xUjhu3QlE,1097
 duty/tools/_twine.py,sha256=9y7-X9fqZ6wbOddGtxBMePI7hgq9QldYyMHxRBy_JXg,10347
+duty/tools/_yore.py,sha256=lS8ZrK3KH71X3yevIylT7U0PtV-3ik2GNuEU2cOWgNQ,1888
 duty/validation.py,sha256=z0CLIsc-2AYbh-zqm3XMhWwE9JlVYmIJkrbo_bjmqVw,8241
-duty-1.4.3.dist-info/RECORD,,
+duty-1.6.0.dist-info/RECORD,,

{duty-1.4.3.dist-info → duty-1.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.2)
+Generator: pdm-backend (2.4.3)
 Root-Is-Purelib: true
 Tag: py3-none-any