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

duty/callables/blacken_docs.py

@@ -4,10 +4,14 @@ from __future__ import annotations
 
 import re
 from pathlib import Path
-from typing import Pattern, Sequence
+from re import Pattern
+from typing import TYPE_CHECKING
 
 from failprint.lazy import lazy
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 @lazy(name="blacken_docs")
 def run(

duty/callables/ruff.py

@@ -5,12 +5,12 @@ from __future__ import annotations
 import os
 import subprocess
 import sys
-from functools import lru_cache
+from functools import cache
 
 from failprint.lazy import lazy
 
 
-@lru_cache(maxsize=None)
+@cache
 def _find_ruff() -> str:
     from ruff.__main__ import find_ruff_bin
 

duty/callables/safety.py

@@ -5,10 +5,13 @@ from __future__ import annotations
 import importlib
 import sys
 from io import StringIO
-from typing import Literal, Sequence, cast
+from typing import TYPE_CHECKING, Literal, cast
 
 from failprint.lazy import lazy
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 @lazy(name="safety.check")
 def check(

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

@@ -6,11 +6,11 @@ import inspect
 import sys
 from copy import deepcopy
 from importlib import util as importlib_util
-from typing import Any, Callable, ClassVar, List, Union
+from typing import Any, Callable, ClassVar, Union
 
 from duty.context import Context
 
-DutyListType = List[Union[str, Callable, "Duty"]]
+DutyListType = list[Union[str, Callable, "Duty"]]
 default_duties_file = "duties.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 @@
+# Invoke tab-completion script to be sourced with Bash shell.
+# Known to work on Bash 3.x, untested on 4.x.
+
+_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/context.py

@@ -4,14 +4,17 @@ from __future__ import annotations
 
 import os
 from contextlib import contextmanager, suppress
-from typing import Any, Callable, Iterator, List, Union
+from typing import TYPE_CHECKING, Any, Callable, 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]
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+CmdType = Union[str, list[str], Callable]
 
 
 class Context:

duty/decorator.py

@@ -4,11 +4,13 @@ from __future__ import annotations
 
 import inspect
 from functools import wraps
-from typing import TYPE_CHECKING, Any, Callable, Iterable, overload
+from typing import TYPE_CHECKING, Any, Callable, overload
 
 from duty.collection import Duty, DutyListType
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
+
     from duty.context import Context
 
 

duty/tools/__init__.py

@@ -24,10 +24,9 @@ from duty.tools._ssort import ssort
 from duty.tools._twine import twine
 
 __all__ = [
-    "Tool",
-    "LazyStdout",
     "LazyStderr",
-    "lazy",
+    "LazyStdout",
+    "Tool",
     "autoflake",
     "black",
     "blacken_docs",
@@ -38,6 +37,7 @@ __all__ = [
     "griffe",
     "interrogate",
     "isort",
+    "lazy",
     "mkdocs",
     "mypy",
     "pytest",

duty/tools/_blacken_docs.py

@@ -4,10 +4,14 @@ from __future__ import annotations
 
 import re
 from pathlib import Path
-from typing import Pattern, Sequence
+from re import Pattern
+from typing import TYPE_CHECKING
 
 from duty.tools._base import Tool
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 class blacken_docs(Tool):  # noqa: N801
     """Call [blacken-docs](https://github.com/adamchainz/blacken-docs)."""

duty/tools/_ruff.py

@@ -5,12 +5,12 @@ from __future__ import annotations
 import os
 import subprocess
 import sys
-from functools import lru_cache
+from functools import cache
 
 from duty.tools._base import Tool
 
 
-@lru_cache(maxsize=None)
+@cache
 def _find_ruff() -> str:
     from ruff.__main__ import find_ruff_bin
 

duty/tools/_safety.py

@@ -5,10 +5,13 @@ from __future__ import annotations
 import importlib
 import sys
 from io import StringIO
-from typing import Literal, Sequence, cast
+from typing import TYPE_CHECKING, Literal, cast
 
 from duty.tools._base import Tool
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 class safety(Tool):  # noqa: N801
     """Call [Safety](https://github.com/pyupio/safety)."""

duty/validation.py

@@ -12,9 +12,12 @@ import textwrap
 from contextlib import suppress
 from functools import cached_property, partial
 from inspect import Parameter, Signature, signature
-from typing import Any, Callable, ForwardRef, Sequence, Union, get_args, get_origin
+from typing import TYPE_CHECKING, Any, Callable, ForwardRef, Union, get_args, get_origin
 
-# TODO: Update once support for Python 3.9 is dropped.
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+# YORE: EOL 3.9: Replace block with lines 6-13.
 if sys.version_info < (3, 10):
     from eval_type_backport import eval_type_backport as eval_type
 

{duty-1.4.2.dist-info → duty-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: duty
-Version: 1.4.2
+Version: 1.5.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>
@@ -10,12 +10,12 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development
 Classifier: Topic :: Utilities
@@ -28,7 +28,7 @@ Project-URL: Issues, https://github.com/pawamoy/duty/issues
 Project-URL: Discussions, https://github.com/pawamoy/duty/discussions
 Project-URL: Gitter, https://gitter.im/duty/community
 Project-URL: Funding, https://github.com/sponsors/pawamoy
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: eval-type-backport; python_version < "3.10"
 Requires-Dist: failprint!=1.0.0,>=0.11
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
@@ -39,7 +39,6 @@ Description-Content-Type: text/markdown
 [![ci](https://github.com/pawamoy/duty/workflows/ci/badge.svg)](https://github.com/pawamoy/duty/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/duty/)
 [![pypi version](https://img.shields.io/pypi/v/duty.svg)](https://pypi.org/project/duty/)
-[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/duty)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#duty:gitter.im)
 
 A simple task runner.
@@ -50,17 +49,14 @@ Inspired by [Invoke](https://github.com/pyinvoke/invoke).
 
 ## Installation
 
-With `pip`:
-
 ```bash
 pip install duty
 ```
 
-With [`pipx`](https://github.com/pipxproject/pipx):
+With [`uv`](https://docs.astral.sh/uv/):
 
 ```bash
-python3.8 -m pip install --user pipx
-pipx install duty
+uv tool install duty
 ```
 
 ## Quick start

{duty-1.4.2.dist-info → duty-1.5.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
-duty-1.4.2.dist-info/METADATA,sha256=KlculFrWoh28QsweZPTaRzFqO03YW0pwozgrGCZbhhw,2900
-duty-1.4.2.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
-duty-1.4.2.dist-info/entry_points.txt,sha256=gxDUGvj_bg7DA77MogNmnGQSc2__ri9kAEp2RJ1p60Q,40
-duty-1.4.2.dist-info/licenses/LICENSE,sha256=nQxdYSduhkgEpOTmg4yyIMmFPzcr2qrlUl8Tf9QZPug,754
+duty-1.5.0.dist-info/METADATA,sha256=CeSruNp_c1LB1AERsGqjy0UwRiww5pivOXdon_fRz7g,2710
+duty-1.5.0.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+duty-1.5.0.dist-info/entry_points.txt,sha256=XZTh9yTgC9GDFmNoVeOqgKT6BCMifkCToilIj77B9ss,55
+duty-1.5.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
 duty/callables/_io.py,sha256=vrMLd7ggCFDy8coWUqntmxgKC9BvFu8smK4pK2S7EeA,367
 duty/callables/autoflake.py,sha256=5IUL2TUfrbWUs_-TBjzqsSHJOxGFiGtBuWBV6AIYdu4,4699
 duty/callables/black.py,sha256=c2gWuhESEWRi1JGKAlMF_ZLoVJ5_bHLd7c4Lg0qyuX8,7153
-duty/callables/blacken_docs.py,sha256=P0lyXg_txxdIwr1qGuzeop1Plb1R8FMkRIo46O0BkgQ,3418
+duty/callables/blacken_docs.py,sha256=OMKrfIZ1ZN6_h8SFGCBcnFCnlonQkkuRY7Vl-B2eGB0,3497
 duty/callables/build.py,sha256=_cF8B3HKy3BWsTSLfpKwhxkZ0JVhfB3v1Zh2eO1FnQw,2150
 duty/callables/coverage.py,sha256=3F2DeHyB-L-Y4v_qJU3TIGPNISnX_Nwn79JtmdE-a-0,23843
 duty/callables/flake8.py,sha256=3uqFdZUF3B35Zc-otjrZfUQgEQkQ3ecZd0ZlEH83sZc,8476
@@ -19,22 +19,23 @@ duty/callables/isort.py,sha256=WutuLM1CZiobHK4Kl2N22xbZg7d0JU6MBZV2muvyG94,26437
 duty/callables/mkdocs.py,sha256=laaToR_KGsPYX7zcVa9u0fC7mMbKR5PYi5g_5pBW_J8,7902
 duty/callables/mypy.py,sha256=qtdOxX4x1VeEXCgY_Mw9EzKs0flBU86Ih4PKgf1WyT4,19797
 duty/callables/pytest.py,sha256=GJHRZCeRhItqOA-ikcFmr9WdpN7ohwTRIIgKl7pWKyw,18345
-duty/callables/ruff.py,sha256=jyRo23J4qNLjUGSfRqOYqpbv7DYaxBqfvsBzO88caWA,13336
-duty/callables/safety.py,sha256=sTjBad1y3Cly__QOT_z29e8KD4YOPi9FFAV1UlW-niM,2389
+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=cri--t6aUmOw3c17yCy9tAp_ceHfEQMhf4tMqPssNa0,6590
-duty/context.py,sha256=T5PNPY6lqXQ088EriWljveFn1SWfrQNVicFbDcnk0GU,3191
+duty/cli.py,sha256=XnkVQAmHCf5QAykZ4foiLvBrsSD22dhSljXmLdFhWM4,9273
+duty/collection.py,sha256=cg_rInuTErP7HTrUJsHenOSdtFZtzIw8cIIsr5g-0T8,7500
+duty/completions.bash,sha256=xXtsZoF1bxhfG4vEuh8hwyYkzNBNlDRxKC9myHV4LPA,1311
+duty/context.py,sha256=YVF68a2w3SMEM0AsN1mBCvlOZ5jTEZ9OYCxDZvv_soI,3250
 duty/debug.py,sha256=9stdqxNJ9zA2HWsYfmy3C9BrWOXLlHYRGsQ6dHfCUfM,2813
-duty/decorator.py,sha256=0FLcTH4nMKHR1MDzZ7PXrblsxu-2m-OVh6Pc_h9T8v8,2952
+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=X-DqE9t47ybEhDf3eboxOEM0vVMQQsqKEOdmDafcuvc,1179
 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
-duty/tools/_blacken_docs.py,sha256=GZvGjPY5Fx6mnZYRwGUB6inH2WQEBkptwPkfWLqSCyY,4893
+duty/tools/_blacken_docs.py,sha256=szKBSsAfQNoZVzTxtm7bZd9bCFe-UzL65XM3MZUJoZI,4972
 duty/tools/_build.py,sha256=QbOZzeR9T_mWkF9poalOkCWuYe22E1liMUC7aBQTJ5k,2567
 duty/tools/_coverage.py,sha256=UKCu-DLyW_-en_Hn9qsh4kXyfrL7DK82VOw9Hblkh_g,26341
 duty/tools/_flake8.py,sha256=ZmV_1Hy773fzP40LDNmj8YJslWatldl0qfr_g2pcgrI,9371
@@ -45,9 +46,9 @@ duty/tools/_isort.py,sha256=VbQbK4iPVNWNYlmOPDEnEcFVB6fJ66W-8s36bS9HziQ,28352
 duty/tools/_mkdocs.py,sha256=GfhXUScTjGQK5Djg6fAGtLSSssdbhebL2AonG5FGPV0,9027
 duty/tools/_mypy.py,sha256=6La6BTfTfMlpA4-JO8dn1O0QQ1zaVEUEp5M6cRmPr7k,21555
 duty/tools/_pytest.py,sha256=HG5jmRbdCKMK6-6i8cDd4MZ1CsDhHa0TQyjls0vy1WU,20064
-duty/tools/_ruff.py,sha256=bsj2CcKFEb4A-4lko9Lxc_KNTks74Q902AxImRqBUCs,15246
-duty/tools/_safety.py,sha256=3kQOko-z07w8S-zq3Qs1FdVXSdY3F13QgRsx1NPPxOg,3141
+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/validation.py,sha256=NbinkhQGsfnL4ZqjMoWZgv5GxmNQ0qMDhE6pWxLxuM4,8183
-duty-1.4.2.dist-info/RECORD,,
+duty/validation.py,sha256=z0CLIsc-2AYbh-zqm3XMhWwE9JlVYmIJkrbo_bjmqVw,8241
+duty-1.5.0.dist-info/RECORD,,

{duty-1.4.2.dist-info → duty-1.5.0.dist-info}/WHEEL

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

{duty-1.4.2.dist-info → duty-1.5.0.dist-info}/entry_points.txt

@@ -1,3 +1,5 @@
 [console_scripts]
 duty = duty.cli:main
 
+[gui_scripts]
+