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

duty/{tools → _internal/tools}/_black.py

@@ -1,14 +1,13 @@
-"""Callable for [Black](https://github.com/psf/black)."""
-
 from __future__ import annotations
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class black(Tool):  # noqa: N801
     """Call [Black](https://github.com/psf/black)."""
 
     cli_name = "black"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -179,6 +178,7 @@ class black(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> None:
-        from black import main as run_black
+        """Run the command."""
+        from black import main as run_black  # noqa: PLC0415
 
-        return run_black(self.cli_args, prog_name="black")
+        run_black(self.cli_args, prog_name="black")

duty/{tools → _internal/tools}/_blacken_docs.py

@@ -1,5 +1,3 @@
-"""Callable for [blacken-docs](https://github.com/adamchainz/blacken-docs)."""
-
 from __future__ import annotations
 
 import re
@@ -7,7 +5,7 @@ from pathlib import Path
 from re import Pattern
 from typing import TYPE_CHECKING
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -17,6 +15,7 @@ class blacken_docs(Tool):  # noqa: N801
     """Call [blacken-docs](https://github.com/adamchainz/blacken-docs)."""
 
     cli_name = "blacken-docs"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -64,11 +63,17 @@ class blacken_docs(Tool):  # noqa: N801
 
     @property
     def cli_command(self) -> str:
+        """The equivalent CLI command."""
         raise ValueError("This command cannot be translated to a CLI command.")
 
     def __call__(self) -> int:
-        import black
-        from blacken_docs import format_file
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        import black  # noqa: PLC0415
+        from blacken_docs import format_file  # noqa: PLC0415
 
         # Restore locals.
         exts = self.py_args["exts"]

duty/{tools → _internal/tools}/_build.py

@@ -1,16 +1,15 @@
-"""Callable for [build](https://github.com/pypa/build)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class build(Tool):  # noqa: N801
     """Call [build](https://github.com/pypa/build)."""
 
     cli_name = "pyproject-build"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -79,6 +78,7 @@ class build(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> None:
-        from build.__main__ import main as run_build
+        """Run the command."""
+        from build.__main__ import main as run_build  # noqa: PLC0415
 
         run_build(self.cli_args)

duty/{tools → _internal/tools}/_coverage.py

@@ -1,16 +1,15 @@
-"""Callable for [Coverage.py](https://github.com/nedbat/coveragepy)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class coverage(Tool):  # noqa: N801
     """Call [Coverage.py](https://github.com/nedbat/coveragepy)."""
 
     cli_name = "coverage"
+    """The name of the executable on PATH."""
 
     @classmethod
     def annotate(
@@ -716,6 +715,11 @@ class coverage(Tool):  # noqa: N801
         return cls(cli_args)
 
     def __call__(self) -> int | None:
-        from coverage.cmdline import main as run_coverage
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from coverage.cmdline import main as run_coverage  # noqa: PLC0415
 
         return run_coverage(self.cli_args)

duty/{tools → _internal/tools}/_flake8.py

@@ -1,17 +1,15 @@
-"""Callable for [Flake8](https://github.com/PyCQA/flake8)."""
-
 from __future__ import annotations
 
-import sys
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class flake8(Tool):  # noqa: N801
     """Call [Flake8](https://github.com/PyCQA/flake8)."""
 
     cli_name = "flake8"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -220,11 +218,11 @@ class flake8(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> int:
-        from flake8.main import main as run_flake8
-
-        old_sys_argv = sys.argv
-        sys.argv = ["flake8", *self.cli_args]
-        try:
-            return run_flake8()
-        finally:
-            sys.argv = old_sys_argv
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from flake8.main.cli import main as run_flake8  # noqa: PLC0415
+
+        return run_flake8(self.cli_args)

duty/{tools → _internal/tools}/_git_changelog.py

@@ -1,16 +1,15 @@
-"""Callable for [git-changelog](https://github.com/pawamoy/git-changelog)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class git_changelog(Tool):  # noqa: N801
     """Call [git-changelog](https://github.com/pawamoy/git-changelog)."""
 
     cli_name = "git-changelog"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -181,6 +180,11 @@ class git_changelog(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> int:
-        from git_changelog.cli import main as run_git_changelog
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from git_changelog.cli import main as run_git_changelog  # noqa: PLC0415
 
         return run_git_changelog(self.cli_args)

duty/{tools → _internal/tools}/_griffe.py

@@ -1,16 +1,15 @@
-"""Callable for [Griffe](https://github.com/mkdocstrings/griffe)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class griffe(Tool):  # noqa: N801
     """Call [Griffe](https://github.com/mkdocstrings/griffe)."""
 
     cli_name = "griffe"
+    """The name of the executable on PATH."""
 
     @classmethod
     def check(
@@ -221,6 +220,11 @@ class griffe(Tool):  # noqa: N801
         return cls(cli_args)
 
     def __call__(self) -> int:
-        from griffe import main as run_griffe
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from griffe import main as run_griffe  # noqa: PLC0415
 
         return run_griffe(self.cli_args)

duty/{tools → _internal/tools}/_interrogate.py

@@ -1,10 +1,8 @@
-"""Callable for [Interrogate](https://github.com/econchick/interrogate)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 _BADGE_STYLE = Literal["flat", "flat-square", "flat-square-modified", "for-the-badge", "plastic", "social"]
 
@@ -13,6 +11,7 @@ class interrogate(Tool):  # noqa: N801
     """Call [Interrogate](https://github.com/econchick/interrogate)."""
 
     cli_name = "interrogate"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -155,6 +154,7 @@ class interrogate(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> None:
-        from interrogate.cli import main as run_interrogate
+        """Run the command."""
+        from interrogate.cli import main as run_interrogate  # noqa: PLC0415
 
         return run_interrogate(self.cli_args)

duty/{tools → _internal/tools}/_isort.py

@@ -1,10 +1,8 @@
-"""Callable for [isort](https://github.com/PyCQA/isort)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 Multiline = Literal[
     "GRID",
@@ -37,6 +35,9 @@ Multiline = Literal[
 class isort(Tool):  # noqa: N801
     """Call [isort](https://github.com/PyCQA/isort)."""
 
+    cli_name = "isort"
+    """The name of the executable on PATH."""
+
     def __init__(
         self,
         *files: str,
@@ -573,7 +574,8 @@ class isort(Tool):  # noqa: N801
 
         super().__init__(cli_args)
 
-    def __call__(self) -> int:
-        from isort.main import main as run_isort
+    def __call__(self) -> None:
+        """Run the command."""
+        from isort.main import main as run_isort  # noqa: PLC0415
 
-        return run_isort(self.cli_args)
+        run_isort(self.cli_args)

duty/{tools → _internal/tools}/_mkdocs.py

@@ -1,14 +1,13 @@
-"""Callable for [MkDocs](https://github.com/mkdocs/mkdocs)."""
-
 from __future__ import annotations
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class mkdocs(Tool):  # noqa: N801
     """Call [MkDocs](https://github.com/mkdocs/mkdocs)."""
 
     cli_name = "mkdocs"
+    """The name of the executable on PATH."""
 
     @classmethod
     def build(
@@ -266,6 +265,11 @@ class mkdocs(Tool):  # noqa: N801
         return cls(cli_args)
 
     def __call__(self) -> int:
-        from mkdocs.__main__ import cli as run_mkdocs
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from mkdocs.__main__ import cli as run_mkdocs  # noqa: PLC0415
 
         return run_mkdocs(self.cli_args)

duty/{tools → _internal/tools}/_mypy.py

@@ -1,16 +1,15 @@
-"""Callable for [Mypy](https://github.com/python/mypy)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import LazyStderr, LazyStdout, Tool
+from duty._internal.tools._base import LazyStderr, LazyStdout, Tool
 
 
 class mypy(Tool):  # noqa: N801
     """Call [Mypy](https://github.com/python/mypy)."""
 
     cli_name = "mypy"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -492,9 +491,10 @@ class mypy(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> None:
-        from mypy.main import main as run_mypy
+        """Run the command."""
+        from mypy.main import main as run_mypy  # noqa: PLC0415
 
-        return run_mypy(
+        run_mypy(
             args=self.cli_args,
             stdout=LazyStdout(),
             stderr=LazyStderr(),

duty/{tools → _internal/tools}/_pytest.py

@@ -1,16 +1,15 @@
-"""Callable for [pytest](https://github.com/pytest-dev/pytest)."""
-
 from __future__ import annotations
 
 from typing import Literal
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class pytest(Tool):  # noqa: N801
     """Call [pytest](https://github.com/pytest-dev/pytest)."""
 
     cli_name = "pytest"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -478,6 +477,11 @@ class pytest(Tool):  # noqa: N801
         super().__init__(cli_args)
 
     def __call__(self) -> int:
-        from pytest import main as run_pytest  # noqa: PT013
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from pytest import main as run_pytest  # noqa: PT013,PLC0415
 
         return run_pytest(self.cli_args)

duty/{tools → _internal/tools}/_ruff.py

@@ -1,5 +1,3 @@
-"""Callable for [Ruff](https://github.com/astral-sh/ruff)."""
-
 from __future__ import annotations
 
 import os
@@ -7,12 +5,12 @@ import subprocess
 import sys
 from functools import cache
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 @cache
 def _find_ruff() -> str:
-    from ruff.__main__ import find_ruff_bin
+    from ruff.__main__ import find_ruff_bin  # noqa: PLC0415
 
     try:
         return find_ruff_bin()
@@ -34,6 +32,7 @@ class ruff(Tool):  # noqa: N801
     """Call [Ruff](https://github.com/astral-sh/ruff)."""
 
     cli_name = "ruff"
+    """The name of the executable on PATH."""
 
     @classmethod
     def check(
@@ -319,6 +318,7 @@ class ruff(Tool):  # noqa: N801
     @classmethod
     def rule(
         cls,
+        rule: str,
         *,
         output_format: str | None = None,
         verbose: bool = False,
@@ -328,12 +328,13 @@ class ruff(Tool):  # noqa: N801
         """Explain a rule.
 
         Parameters:
+            rule: A rule code, or `--all`.
             output_format: Output format (default: pretty, possible values: text, json, pretty).
             verbose: Enable verbose logging.
             quiet: Print lint violations, but nothing else.
             silent: Disable all logging (but still exit with status code "1" upon detecting lint violations).
         """
-        cli_args = ["rule"]
+        cli_args = ["rule", rule]
 
         if output_format:
             cli_args.append("--format")
@@ -441,6 +442,11 @@ class ruff(Tool):  # noqa: N801
         return cls(cli_args)
 
     def __call__(self) -> int:
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
         process = subprocess.run(  # noqa: S603
             [_find_ruff(), *self.cli_args],
             capture_output=True,

duty/{tools → _internal/tools}/_safety.py

@@ -1,5 +1,3 @@
-"""Callable for [Safety](https://github.com/pyupio/safety)."""
-
 from __future__ import annotations
 
 import importlib
@@ -7,7 +5,7 @@ import sys
 from io import StringIO
 from typing import TYPE_CHECKING, Literal, cast
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -17,6 +15,7 @@ class safety(Tool):  # noqa: N801
     """Call [Safety](https://github.com/pyupio/safety)."""
 
     cli_name = "safety"
+    """The name of the executable on PATH."""
 
     @classmethod
     def check(
@@ -44,9 +43,15 @@ class safety(Tool):  # noqa: N801
 
     @property
     def cli_command(self) -> str:
+        """The equivalent CLI command."""
         raise ValueError("This command cannot be translated to a CLI command.")
 
     def __call__(self) -> bool:
+        """Run the command.
+
+        Returns:
+            False when vulnerabilities are found.
+        """
         requirements = self.py_args["requirements"]
         ignore_vulns = self.py_args["ignore_vulns"]
         formatter = self.py_args["formatter"]
@@ -64,19 +69,19 @@ class safety(Tool):  # noqa: N801
         importlib.invalidate_caches()
 
         # reload original, unpatched safety
-        from safety.formatter import SafetyFormatter
-        from safety.safety import calculate_remediations, check
-        from safety.util import read_requirements
+        from safety.formatter import SafetyFormatter  # noqa: PLC0415
+        from safety.safety import calculate_remediations, check  # noqa: PLC0415
+        from safety.util import read_requirements  # noqa: PLC0415
 
         # check using safety as a library
         if isinstance(requirements, (list, tuple, set)):
             requirements = "\n".join(requirements)
-        packages = list(read_requirements(StringIO(cast(str, requirements))))
+        packages = list(read_requirements(StringIO(cast("str", requirements))))
 
         # TODO: Safety 3 support, merge once support for v2 is dropped.
         check_kwargs = {"packages": packages, "ignore_vulns": ignore_vulns}
         try:
-            from safety.auth.cli_utils import build_client_session
+            from safety.auth.cli_utils import build_client_session  # noqa: PLC0415
 
             client_session, _ = build_client_session()
             check_kwargs["session"] = client_session

duty/{tools → _internal/tools}/_ssort.py

@@ -1,16 +1,15 @@
-"""Callable for [ssort](https://github.com/bwhmather/ssort)."""
-
 from __future__ import annotations
 
 import sys
 
-from duty.tools._base import Tool
+from duty._internal.tools._base import Tool
 
 
 class ssort(Tool):  # noqa: N801
     """Call [ssort](https://github.com/bwhmather/ssort)."""
 
     cli_name = "ssort"
+    """The name of the executable on PATH."""
 
     def __init__(
         self,
@@ -33,12 +32,17 @@ class ssort(Tool):  # noqa: N801
         if check:
             cli_args.append("--check")
 
-    def __call__(self) -> int:
-        from ssort._main import main as run_ssort
+    def __call__(self) -> None:
+        """Run the command.
+
+        Returns:
+            The exit code of the command.
+        """
+        from ssort._main import main as run_ssort  # noqa: PLC0415
 
         old_sys_argv = sys.argv
         sys.argv = ["ssort", *self.cli_args]
         try:
-            return run_ssort()
+            run_ssort()
         finally:
             sys.argv = old_sys_argv

duty/{tools → _internal/tools}/_twine.py

@@ -1,14 +1,15 @@
-"""Callable for [Twine](https://github.com/pypa/twine)."""
-
 from __future__ import annotations
 
-from duty.tools._base import Tool
+from typing import Any
+
+from duty._internal.tools._base import Tool
 
 
 class twine(Tool):  # noqa: N801
     """Call [Twine](https://github.com/pypa/twine)."""
 
     cli_name = "twine"
+    """The name of the executable on PATH."""
 
     @classmethod
     def check(
@@ -283,7 +284,12 @@ class twine(Tool):  # noqa: N801
 
         return cls(cli_args)
 
-    def __call__(self) -> None:
-        from twine.cli import dispatch as run_twine
+    def __call__(self) -> Any:
+        """Run the command.
+
+        Returns:
+            The return value of the corresponding Twine command / entrypoint.
+        """
+        from twine.cli import dispatch as run_twine  # noqa: PLC0415
 
         return run_twine(self.cli_args)