duty 1.4.1__tar.gz → 1.4.2__tar.gz

{duty-1.4.1 → duty-1.4.2}/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.4.2](https://github.com/pawamoy/duty/releases/tag/1.4.2) - 2024-09-10
+
+<small>[Compare with 1.4.1](https://github.com/pawamoy/duty/compare/1.4.1...1.4.2)</small>
+
+### Bug Fixes
+
+- Add missing (new) `check_only` argument to blacken-docs ([1a6dc99](https://github.com/pawamoy/duty/commit/1a6dc995dc0caa47d8734a9feb54eb766652cadc) by Timothée Mazzucotelli). [Issue-22](https://github.com/pawamoy/duty/issues/22)
+
 ## [1.4.1](https://github.com/pawamoy/duty/releases/tag/1.4.1) - 2024-08-15
 
 <small>[Compare with 1.4.0](https://github.com/pawamoy/duty/compare/1.4.0...1.4.1)</small>

{duty-1.4.1 → duty-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: duty
-Version: 1.4.1
+Version: 1.4.2
 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.1 → duty-1.4.2}/duties.py

@@ -54,7 +54,7 @@ def changelog(ctx: Context, bump: str = "") -> None:
 
 
 @duty(pre=["check_quality", "check_types", "check_docs", "check_dependencies", "check-api"])
-def check(ctx: Context) -> None:  # noqa: ARG001
+def check(ctx: Context) -> None:
     """Check it all!"""
 
 

{duty-1.4.1 → duty-1.4.2}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "failprint>=0.11,!=1.0.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.4.1"
+version = "1.4.2"
 
 [project.license]
 text = "ISC"

{duty-1.4.1 → duty-1.4.2}/src/duty/callables/blacken_docs.py

@@ -24,6 +24,7 @@ def run(
     magic_trailing_comma: bool = True,
     python_cell_magics: set[str] | None = None,
     preview: bool = False,
+    check_only: bool = False,
 ) -> int:
     """Run `blacken-docs`.
 
@@ -44,6 +45,8 @@ def run(
             Useful for formatting cells with custom python magics.
         preview: Enable potentially disruptive style changes that may be added
             to Black's main functionality in the next major release.
+        check_only: Don't modify files but indicate when changes are necessary
+            with a message and non-zero return code.
 
     Returns:
         Success/failure.
@@ -80,5 +83,6 @@ def run(
             black_mode,
             skip_errors=skip_errors,
             rst_literal_blocks=rst_literal_blocks,
+            check_only=check_only,
         )
     return retv

{duty-1.4.1 → duty-1.4.2}/src/duty/callables/ruff.py

@@ -1,4 +1,4 @@
-"""Callable for [Ruff](https://github.com/charliermarsh/ruff)."""
+"""Callable for [Ruff](https://github.com/astral-sh/ruff)."""
 
 from __future__ import annotations
 
@@ -90,34 +90,34 @@ def check(
     """Run Ruff on the given files or directories.
 
     Parameters:
-        fix: Attempt to automatically fix lint violations
-        config: Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
-        show_source: Show violations with source code
-        show_fixes: Show an enumeration of all autofixed lint violations
-        diff: Avoid writing any fixed files back; instead, output a diff for each changed file to stdout
-        watch: Run in watch mode by re-running whenever files change
-        fix_only: Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`
-        output_format: Output serialization format for violations [env: RUFF_FORMAT=] [possible values: text, json, junit, grouped, github, gitlab, pylint]
-        statistics: Show counts for every rule with at least one violation
-        add_noqa: Enable automatic additions of `noqa` directives to failing lines
-        show_files: See the files Ruff will be run against with the current settings
-        show_settings: See the settings Ruff will use to lint a given Python file
-        select: Comma-separated list of rule codes to enable (or ALL, to enable all rules)
-        ignore: Comma-separated list of rule codes to disable
-        extend_select: Like --select, but adds additional rule codes on top of the selected ones
-        per_file_ignores: List of mappings from file pattern to code to exclude
-        fixable: List of rule codes to treat as eligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`)
-        unfixable: List of rule codes to treat as ineligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`)
-        exclude: List of paths, used to omit files and/or directories from analysis
-        extend_exclude: Like --exclude, but adds additional files and directories on top of those already excluded
-        respect_gitignore: Respect file exclusions via `.gitignore` and other standard ignore files
-        force_exclude: Enforce exclusions, even for paths passed to Ruff directly on the command-line
-        no_cache: Disable cache reads
-        isolated: Ignore all configuration files
-        cache_dir: Path to the cache directory [env: RUFF_CACHE_DIR=]
-        stdin_filename: The name of the file when passing it through stdin
-        exit_zero: Exit with status code "0", even upon detecting lint violations
-        exit_non_zero_on_fix: Exit with a non-zero status code if any files were modified via autofix, even if no lint violations remain
+        fix: Attempt to automatically fix lint violations.
+        config: Path to the `pyproject.toml` or `ruff.toml` file to use for configuration.
+        show_source: Show violations with source code.
+        show_fixes: Show an enumeration of all autofixed lint violations.
+        diff: Avoid writing any fixed files back; instead, output a diff for each changed file to stdout.
+        watch: Run in watch mode by re-running whenever files change.
+        fix_only: Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`.
+        output_format: Output serialization format for violations (env: RUFF_FORMAT=) (possible values: text, json, junit, grouped, github, gitlab, pylint).
+        statistics: Show counts for every rule with at least one violation.
+        add_noqa: Enable automatic additions of `noqa` directives to failing lines.
+        show_files: See the files Ruff will be run against with the current settings.
+        show_settings: See the settings Ruff will use to lint a given Python file.
+        select: Comma-separated list of rule codes to enable (or ALL, to enable all rules).
+        ignore: Comma-separated list of rule codes to disable.
+        extend_select: Like --select, but adds additional rule codes on top of the selected ones.
+        per_file_ignores: List of mappings from file pattern to code to exclude.
+        fixable: List of rule codes to treat as eligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`).
+        unfixable: List of rule codes to treat as ineligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`).
+        exclude: List of paths, used to omit files and/or directories from analysis.
+        extend_exclude: Like --exclude, but adds additional files and directories on top of those already excluded.
+        respect_gitignore: Respect file exclusions via `.gitignore` and other standard ignore files.
+        force_exclude: Enforce exclusions, even for paths passed to Ruff directly on the command-line.
+        no_cache: Disable cache reads.
+        isolated: Ignore all configuration files.
+        cache_dir: Path to the cache directory (env: RUFF_CACHE_DIR=).
+        stdin_filename: The name of the file when passing it through stdin.
+        exit_zero: Exit with status code "0", even upon detecting lint violations.
+        exit_non_zero_on_fix: Exit with a non-zero status code if any files were modified via autofix, even if no lint violations remain.
         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).
@@ -368,7 +368,7 @@ def linter(
     """List all supported upstream linters.
 
     Parameters:
-        output_format: Output format [default: pretty] [possible values: text, json, pretty].
+        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).

{duty-1.4.1 → duty-1.4.2}/src/duty/tools/_blacken_docs.py

@@ -29,6 +29,7 @@ class blacken_docs(Tool):  # noqa: N801
         magic_trailing_comma: bool = True,
         python_cell_magics: set[str] | None = None,
         preview: bool = False,
+        check_only: bool = False,
     ) -> None:
         """Run `blacken-docs`.
 
@@ -49,6 +50,8 @@ class blacken_docs(Tool):  # noqa: N801
                 Useful for formatting cells with custom python magics.
             preview: Enable potentially disruptive style changes that may be added
                 to Black's main functionality in the next major release.
+            check_only: Don't modify files but indicate when changes are necessary
+                with a message and non-zero return code.
 
         Returns:
             Success/failure.
@@ -77,6 +80,7 @@ class blacken_docs(Tool):  # noqa: N801
         preview = self.py_args["preview"]
         skip_errors = self.py_args["skip_errors"]
         rst_literal_blocks = self.py_args["rst_literal_blocks"]
+        check_only = self.py_args["check_only"]
 
         # Build filepaths.
         exts = ("md", "py") if exts is None else tuple(ext.lstrip(".") for ext in exts)
@@ -111,5 +115,6 @@ class blacken_docs(Tool):  # noqa: N801
                 black_mode,
                 skip_errors=skip_errors,
                 rst_literal_blocks=rst_literal_blocks,
+                check_only=check_only,
             )
         return retv

{duty-1.4.1 → duty-1.4.2}/src/duty/tools/_ruff.py

@@ -1,4 +1,4 @@
-"""Callable for [Ruff](https://github.com/charliermarsh/ruff)."""
+"""Callable for [Ruff](https://github.com/astral-sh/ruff)."""
 
 from __future__ import annotations
 
@@ -31,7 +31,7 @@ def _find_ruff() -> str:
 
 
 class ruff(Tool):  # noqa: N801
-    """Call [Ruff](https://github.com/charliermarsh/ruff)."""
+    """Call [Ruff](https://github.com/astral-sh/ruff)."""
 
     cli_name = "ruff"
 
@@ -74,34 +74,34 @@ class ruff(Tool):  # noqa: N801
         """Run Ruff on the given files or directories.
 
         Parameters:
-            fix: Attempt to automatically fix lint violations
-            config: Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
-            show_source: Show violations with source code
-            show_fixes: Show an enumeration of all autofixed lint violations
-            diff: Avoid writing any fixed files back; instead, output a diff for each changed file to stdout
-            watch: Run in watch mode by re-running whenever files change
-            fix_only: Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`
-            output_format: Output serialization format for violations [env: RUFF_FORMAT=] [possible values: text, json, junit, grouped, github, gitlab, pylint]
-            statistics: Show counts for every rule with at least one violation
-            add_noqa: Enable automatic additions of `noqa` directives to failing lines
-            show_files: See the files Ruff will be run against with the current settings
-            show_settings: See the settings Ruff will use to lint a given Python file
-            select: Comma-separated list of rule codes to enable (or ALL, to enable all rules)
-            ignore: Comma-separated list of rule codes to disable
-            extend_select: Like --select, but adds additional rule codes on top of the selected ones
-            per_file_ignores: List of mappings from file pattern to code to exclude
-            fixable: List of rule codes to treat as eligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`)
-            unfixable: List of rule codes to treat as ineligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`)
-            exclude: List of paths, used to omit files and/or directories from analysis
-            extend_exclude: Like --exclude, but adds additional files and directories on top of those already excluded
-            respect_gitignore: Respect file exclusions via `.gitignore` and other standard ignore files
-            force_exclude: Enforce exclusions, even for paths passed to Ruff directly on the command-line
-            no_cache: Disable cache reads
-            isolated: Ignore all configuration files
-            cache_dir: Path to the cache directory [env: RUFF_CACHE_DIR=]
-            stdin_filename: The name of the file when passing it through stdin
-            exit_zero: Exit with status code "0", even upon detecting lint violations
-            exit_non_zero_on_fix: Exit with a non-zero status code if any files were modified via autofix, even if no lint violations remain
+            fix: Attempt to automatically fix lint violations.
+            config: Path to the `pyproject.toml` or `ruff.toml` file to use for configuration.
+            show_source: Show violations with source code.
+            show_fixes: Show an enumeration of all autofixed lint violations.
+            diff: Avoid writing any fixed files back; instead, output a diff for each changed file to stdout.
+            watch: Run in watch mode by re-running whenever files change.
+            fix_only: Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`.
+            output_format: Output serialization format for violations (env: RUFF_FORMAT=) (possible values: text, json, junit, grouped, github, gitlab, pylint).
+            statistics: Show counts for every rule with at least one violation.
+            add_noqa: Enable automatic additions of `noqa` directives to failing lines.
+            show_files: See the files Ruff will be run against with the current settings.
+            show_settings: See the settings Ruff will use to lint a given Python file.
+            select: Comma-separated list of rule codes to enable (or ALL, to enable all rules).
+            ignore: Comma-separated list of rule codes to disable.
+            extend_select: Like --select, but adds additional rule codes on top of the selected ones.
+            per_file_ignores: List of mappings from file pattern to code to exclude.
+            fixable: List of rule codes to treat as eligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`).
+            unfixable: List of rule codes to treat as ineligible for autofix. Only applicable when autofix itself is enabled (e.g., via `--fix`).
+            exclude: List of paths, used to omit files and/or directories from analysis.
+            extend_exclude: Like --exclude, but adds additional files and directories on top of those already excluded.
+            respect_gitignore: Respect file exclusions via `.gitignore` and other standard ignore files.
+            force_exclude: Enforce exclusions, even for paths passed to Ruff directly on the command-line.
+            no_cache: Disable cache reads.
+            isolated: Ignore all configuration files.
+            cache_dir: Path to the cache directory (env: RUFF_CACHE_DIR=).
+            stdin_filename: The name of the file when passing it through stdin.
+            exit_zero: Exit with status code "0", even upon detecting lint violations.
+            exit_non_zero_on_fix: Exit with a non-zero status code if any files were modified via autofix, even if no lint violations remain.
             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).
@@ -390,7 +390,7 @@ class ruff(Tool):  # noqa: N801
         """List all supported upstream linters.
 
         Parameters:
-            output_format: Output format [default: pretty] [possible values: text, json, pretty].
+            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).

{duty-1.4.1 → duty-1.4.2}/tests/test_collection.py

@@ -8,7 +8,7 @@ from duty.collection import Collection, Duty
 from duty.decorator import duty as decorate
 
 
-def none(*args, **kwargs) -> None:  # noqa: ANN002, ANN003, ARG001, D103
+def none(*args, **kwargs) -> None:  # noqa: ANN002, ANN003, D103
     ...  # pragma: no cover
 
 

{duty-1.4.1 → duty-1.4.2}/tests/test_validation.py

@@ -139,7 +139,7 @@ def test_params_caster(func: Callable, args: tuple, kwargs: dict, expected_args:
 def test_casting_based_on_default_value_type() -> None:
     """Test that we cast according to the default value type when there is no annotation."""
 
-    def func(ctx, a=0):  # noqa: ANN202,ARG001,ANN001
+    def func(ctx, a=0):  # noqa: ANN202, ANN001
         ...
 
     caster = _get_params_caster(func, a="1")
@@ -150,7 +150,7 @@ def test_casting_based_on_default_value_type() -> None:
 def test_validating_modern_annotations() -> None:
     """Test modern type annotations in function signatures."""
 
-    def func(ctx, a: int | None = None):  # noqa: ANN202,ARG001,ANN001
+    def func(ctx, a: int | None = None):  # noqa: ANN202, ANN001
         ...
 
     caster = _get_params_caster(func, a=1)