duty 1.4.3__tar.gz → 1.5.0__tar.gz

{duty-1.4.3 → duty-1.5.0}/CHANGELOG.md

@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.5.0](https://github.com/pawamoy/duty/releases/tag/1.5.0) - 2025-02-02
+
+<small>[Compare with 1.4.3](https://github.com/pawamoy/duty/compare/1.4.3...1.5.0)</small>
+
+### Features
+
+- Enable Bash completions ([9ed4400](https://github.com/pawamoy/duty/commit/9ed44002ff8e122ea6e5aaaf4a968e08d0dc83fd) by Bartosz Sławecki). [Issue-27](https://github.com/pawamoy/duty/issues/27), [PR-33](https://github.com/pawamoy/duty/pull/33), Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
+
 ## [1.4.3](https://github.com/pawamoy/duty/releases/tag/1.4.3) - 2024-10-17
 
 <small>[Compare with 1.4.2](https://github.com/pawamoy/duty/compare/1.4.2...1.4.3)</small>

{duty-1.4.3 → duty-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: duty
-Version: 1.4.3
+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>

{duty-1.4.3 → duty-1.5.0}/docs/index.md

@@ -63,7 +63,7 @@ clean:
 ```
 
 See [our Makefile](https://github.com/pawamoy/duty/blob/main/Makefile)
-for inspiration. 
+for inspiration.
 
 ### [Task](https://taskfile.dev/)?
 

{duty-1.4.3 → duty-1.5.0}/docs/usage.md

@@ -647,7 +647,7 @@ You can also pass parameters as positional arguments:
 duty shoot 5,15
 ```
 
-WARNING: **Limitation with positional arguments.**  
+WARNING: **Limitation with positional arguments.**
 When passing positional arguments,
 make sure there is no overlap between other duties' names
 and the argument value, otherwise `duty` will not be able
@@ -713,7 +713,7 @@ def play(ctx, file):
 ```bash
 duty --capture=none --strict play this-file.mp4
 # or with the short options
-duty -Zc none play this-file.mp4 
+duty -Zc none play this-file.mp4
 ```
 
 #### Local options
@@ -724,7 +724,7 @@ you can pass them to a specific duty on the command line.
 If we use the previous example again:
 
 ```bash
-duty play -Zc none this-file.mp4 
+duty play -Zc none this-file.mp4
 ```
 
 It allows to use different options for different duties
@@ -778,6 +778,8 @@ It is not possible to capture only stdout, or only stderr,
 and let the other one be printed to the console.
 Capturing one is capturing both, but discarding the other.
 
+WARNING: **Windows quirks.** On Windows you might need to set the following environment variables to allow proper output capture: `PYTHONLEGACYWINDOWSSTDIO=1`, `PYTHONUTF8=1`, `PYTHONIOENCODING=UTF8`. If the `✓` and `✗` characters are mangled, try changing them by [customizing the output format](#formatting-duty-output).
+
 ### Formatting duty output
 
 Thanks to its underlying [`failprint`](https://github.com/pawamoy/failprint) dependency,
@@ -789,7 +791,7 @@ For example, the two builtin `failprint` formats are:
   ```jinja
   {% if success %}<green>✓</green>
   {% elif nofail %}<yellow>✗</yellow>
-  {% else %}<red>✗</red>{% endif %} 
+  {% else %}<red>✗</red>{% endif %}
   <bold>{{ title or command }}</bold>
   {% if failure %} ({{ code }}){% endif %}
   {% if failure and output and not quiet %}\n
@@ -871,4 +873,16 @@ export FAILPRINT_FORMAT="custom={{output}}"
 # always print the captured output, nothing else
 
 duty task1 task2
-```
+```
+
+### Shell completions
+
+You can enable auto-completion in Bash with these commands:
+
+```bash
+completions_dir="${BASH_COMPLETION_USER_DIR:-${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion}/completions"
+mkdir -p "${completions_dir}"
+duty --completion > "${completions_dir}/duty"
+```
+
+Only Bash is supported for now.

{duty-1.4.3 → duty-1.5.0}/duties.py

@@ -84,6 +84,7 @@ def check_docs(ctx: Context) -> None:
 @duty
 def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
+    os.environ["FORCE_COLOR"] = "1"
     ctx.run(
         tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
         title=pyprefix("Type-checking"),

{duty-1.4.3 → duty-1.5.0}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "failprint>=0.11,!=1.0.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.4.3"
+version = "1.5.0"
 
 [project.license]
 text = "ISC"
@@ -60,11 +60,10 @@ Funding = "https://github.com/sponsors/pawamoy"
 duty = "duty.cli:main"
 
 [tool.pdm.version]
-source = "scm"
+source = "call"
+getter = "scripts.get_version:get_version"
 
 [tool.pdm.build]
-package-dir = "src"
-editable-backend = "editables"
 excludes = [
     "**/.pytest_cache",
 ]
@@ -85,9 +84,8 @@ data = [
     { path = "share/**/*", relative-to = "." },
 ]
 
-[tool.uv]
-dev-dependencies = [
-    "editables>=0.5",
+[dependency-groups]
+dev = [
     "build>=1.2",
     "git-changelog>=2.5",
     "twine>=5.1",

{duty-1.4.3 → duty-1.5.0}/scripts/gen_credits.py

@@ -27,7 +27,7 @@ with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
     pyproject = tomllib.load(pyproject_file)
 project = pyproject["project"]
 project_name = project["name"]
-devdeps = [dep for dep in pyproject["tool"]["uv"]["dev-dependencies"] if not dep.startswith("-e")]
+devdeps = [dep for dep in pyproject["dependency-groups"]["dev"] if not dep.startswith("-e")]
 
 PackageMetadata = dict[str, Union[str, Iterable[str]]]
 Metadata = dict[str, PackageMetadata]

duty-1.5.0/scripts/get_version.py

@@ -0,0 +1,27 @@
+"""Get current project version from Git tags or changelog."""
+
+import re
+from contextlib import suppress
+from pathlib import Path
+
+from pdm.backend.hooks.version import SCMVersion, Version, default_version_formatter, get_version_from_scm
+
+_root = Path(__file__).parent.parent
+_changelog = _root / "CHANGELOG.md"
+_changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
+_default_scm_version = SCMVersion(Version("0.0.0"), None, False, None, None)  # noqa: FBT003
+
+
+def get_version() -> str:
+    """Get current project version from Git tags or changelog."""
+    scm_version = get_version_from_scm(_root) or _default_scm_version
+    if scm_version.version <= Version("0.1"):  # Missing Git tags?
+        with suppress(OSError, StopIteration):  # noqa: SIM117
+            with _changelog.open("r", encoding="utf8") as file:
+                match = next(filter(None, map(_changelog_version_re.match, file)))
+                scm_version = scm_version._replace(version=Version(match.group(1)))
+    return default_version_formatter(scm_version)
+
+
+if __name__ == "__main__":
+    print(get_version())

duty-1.5.0/scripts/make

@@ -0,0 +1 @@
+make.py

duty-1.4.3/scripts/make → duty-1.5.0/scripts/make.py

@@ -10,12 +10,16 @@ import sys
 from contextlib import contextmanager
 from pathlib import Path
 from textwrap import dedent
-from typing import Any, Iterator
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 
 PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.9 3.10 3.11 3.12 3.13 3.14").split()
 
 
-def shell(cmd: str, capture_output: bool = False, **kwargs: Any) -> str | None:
+def shell(cmd: str, *, capture_output: bool = False, **kwargs: Any) -> str | None:
     """Run a shell command."""
     if capture_output:
         return subprocess.check_output(cmd, shell=True, text=True, **kwargs)  # noqa: S602
@@ -49,15 +53,15 @@ def setup() -> None:
     if not shutil.which("uv"):
         raise ValueError("make: setup: uv must be installed, see https://github.com/astral-sh/uv")
 
-    print("Installing dependencies (default environment)")  # noqa: T201
+    print("Installing dependencies (default environment)")
     default_venv = Path(".venv")
     if not default_venv.exists():
-        shell("uv venv --python python")
+        shell("uv venv")
     uv_install(default_venv)
 
     if PYTHON_VERSIONS:
         for version in PYTHON_VERSIONS:
-            print(f"\nInstalling dependencies (python{version})")  # noqa: T201
+            print(f"\nInstalling dependencies (python{version})")
             venv_path = Path(f".venvs/{version}")
             if not venv_path.exists():
                 shell(f"uv venv --python {version} {venv_path}")
@@ -65,12 +69,10 @@ def setup() -> None:
                 uv_install(venv_path)
 
 
-def run(version: str, cmd: str, *args: str, no_sync: bool = False, **kwargs: Any) -> None:
+def run(version: str, cmd: str, *args: str, **kwargs: Any) -> None:
     """Run a command in a virtual environment."""
     kwargs = {"check": True, **kwargs}
-    uv_run = ["uv", "run"]
-    if no_sync:
-        uv_run.append("--no-sync")
+    uv_run = ["uv", "run", "--no-sync"]
     if version == "default":
         with environ(UV_PROJECT_ENVIRONMENT=".venv"):
             subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
@@ -99,7 +101,7 @@ def clean() -> None:
     """Delete build artifacts and cache files."""
     paths_to_clean = ["build", "dist", "htmlcov", "site", ".coverage*", ".pdm-build"]
     for path in paths_to_clean:
-        shell(f"rm -rf {path}")
+        shutil.rmtree(path, ignore_errors=True)
 
     cache_dirs = {".cache", ".pytest_cache", ".mypy_cache", ".ruff_cache", "__pycache__"}
     for dirpath in Path(".").rglob("*/"):
@@ -109,8 +111,7 @@ def clean() -> None:
 
 def vscode() -> None:
     """Configure VSCode to work on this project."""
-    Path(".vscode").mkdir(parents=True, exist_ok=True)
-    shell("cp -v config/vscode/* .vscode")
+    shutil.copytree("config/vscode", ".vscode", dirs_exist_ok=True)
 
 
 def main() -> int:
@@ -132,13 +133,13 @@ def main() -> int:
                       3.x                   Run a command in the virtual environment for Python 3.x.
                       clean                 Delete build artifacts and cache files.
                       vscode                Configure VSCode to work on this project.
-                    """
+                    """,
                 ),
                 flush=True,
-            )  # noqa: T201
+            )
             if os.path.exists(".venv"):
-                print("\nAvailable tasks", flush=True)  # noqa: T201
-                run("default", "duty", "--list", no_sync=True)
+                print("\nAvailable tasks", flush=True)
+                run("default", "duty", "--list")
         return 0
 
     while args:
@@ -186,5 +187,5 @@ if __name__ == "__main__":
         sys.exit(main())
     except subprocess.CalledProcessError as process:
         if process.output:
-            print(process.output, file=sys.stderr)  # noqa: T201
+            print(process.output, file=sys.stderr)
         sys.exit(process.returncode)

{duty-1.4.3 → duty-1.5.0}/src/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-1.4.3 → duty-1.5.0}/src/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-1.5.0/src/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-1.4.3 → duty-1.5.0}/tests/test_collection.py

@@ -68,3 +68,19 @@ def test_add_duty_to_multiple_collections() -> None:
     assert duty1 is not duty2
     assert duty1.collection is collection1
     assert duty2.collection is collection2
+
+
+def test_completion_candidates() -> None:
+    """Check whether proper completion candidates are returned from collections."""
+    collection = Collection()
+
+    collection.add(decorate(none, name="duty_1"))  # type: ignore[call-overload]
+    collection.add(decorate(none, name="duty_2", aliases=["alias_2"]))  # type: ignore[call-overload]
+
+    assert collection.completion_candidates(("duty",)) == [
+        "alias_2",
+        "duty-1",
+        "duty-2",
+        "duty_1",
+        "duty_2",
+    ]

{duty-1.4.3 → duty-1.5.0}/src/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",