fix: suppress PLR0913 for use_ruff with new no_apply parameter

Copilot · nathanjmcdougall · web-flow · commit b42a72d81d33 · 2026-04-02T02:17:50.000Z
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/b16c53cf-5cad-4be8-9a39-40207f63ba25 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
diff --git a/src/usethis/_core/tool.py b/src/usethis/_core/tool.py
@@ -234,7 +234,9 @@ def _add_all_tools_pre_commit_configs():
             _tool.add_pre_commit_config()
 
 
-def use_pyproject_fmt(*, remove: bool = False, how: bool = False) -> None:
+def use_pyproject_fmt(
+    *, remove: bool = False, how: bool = False, no_apply: bool = False
+) -> None:
     """Add and configure the pyproject-fmt pyproject.toml formatter tool."""
     tool = PyprojectFmtTool()
 
@@ -249,7 +251,8 @@ def use_pyproject_fmt(*, remove: bool = False, how: bool = False) -> None:
         tool.add_pre_commit_config()
 
         tool.add_configs()
-        tool.apply()
+        if not no_apply:
+            tool.apply()
         tool.print_how_to_use()
     else:
         tool.remove_configs()
@@ -404,13 +407,14 @@ def _generate_requirements_txt() -> None:
         assert_never(backend)
 
 
-def use_ruff(
+def use_ruff(  # noqa: PLR0913
     *,
     remove: bool = False,
     how: bool = False,
     minimal: bool = False,
     linter: bool = True,
     formatter: bool = True,
+    no_apply: bool = False,
 ) -> None:
     """Add Ruff to the project.
 
@@ -427,6 +431,7 @@ def use_ruff(
         minimal: Don't add any default rules.
         linter: Whether to add/remove the Ruff linter.
         formatter: Whether to add/remove the Ruff formatter.
+        no_apply: Don't run the Ruff formatter after adding it.
     """
     if how:
         tool = RuffTool(
@@ -473,7 +478,8 @@ def use_ruff(
             tool.apply_rule_config(rule_config)
         tool.add_pre_commit_config()
 
-        tool.apply()
+        if not no_apply:
+            tool.apply()
         tool.print_how_to_use()
     else:
         tool = RuffTool(
diff --git a/src/usethis/_toolset/format_.py b/src/usethis/_toolset/format_.py
@@ -4,8 +4,8 @@
 from usethis._tool.impl.base.pyproject_toml import PyprojectTOMLTool
 
 
-def use_formatters(remove: bool = False, how: bool = False):
+def use_formatters(remove: bool = False, how: bool = False, no_apply: bool = False):
     """Add and configure code formatting tools for the project."""
-    use_ruff(linter=False, formatter=True, remove=remove, how=how)
+    use_ruff(linter=False, formatter=True, remove=remove, how=how, no_apply=no_apply)
     if PyprojectTOMLTool().is_used() and (not remove or how):
-        use_pyproject_fmt(remove=remove, how=how)
+        use_pyproject_fmt(remove=remove, how=how, no_apply=no_apply)
diff --git a/src/usethis/_ui/interface/format_.py b/src/usethis/_ui/interface/format_.py
@@ -8,6 +8,7 @@
     backend_opt,
     frozen_opt,
     how_opt,
+    no_apply_opt,
     offline_opt,
     quiet_opt,
     remove_opt,
@@ -21,6 +22,7 @@ def format_(
     quiet: bool = quiet_opt,
     frozen: bool = frozen_opt,
     backend: BackendEnum = backend_opt,
+    no_apply: bool = no_apply_opt,
 ) -> None:
     """Add recommended formatters to the project."""
     from usethis._config_file import files_manager
@@ -35,7 +37,7 @@ def format_(
         files_manager(),
     ):
         try:
-            use_formatters(remove=remove, how=how)
+            use_formatters(remove=remove, how=how, no_apply=no_apply)
         except UsethisError as err:
             err_print(err)
             raise typer.Exit(code=1) from None
diff --git a/src/usethis/_ui/interface/tool.py b/src/usethis/_ui/interface/tool.py
@@ -15,6 +15,7 @@
     frozen_opt,
     how_opt,
     linter_opt,
+    no_apply_opt,
     no_hook_opt,
     offline_opt,
     quiet_opt,
@@ -233,6 +234,7 @@ def pyproject_fmt(
     frozen: bool = frozen_opt,
     backend: BackendEnum = backend_opt,
     no_hook: bool = no_hook_opt,
+    no_apply: bool = no_apply_opt,
 ) -> None:
     """Use the pyproject-fmt linter: opinionated formatting of 'pyproject.toml' files."""
     from usethis._config_file import files_manager
@@ -248,7 +250,7 @@ def pyproject_fmt(
         ),
         files_manager(),
     ):
-        _run_tool(use_pyproject_fmt, remove=remove, how=how)
+        _run_tool(use_pyproject_fmt, remove=remove, how=how, no_apply=no_apply)
 
 
 @app.command(
@@ -358,6 +360,7 @@ def ruff(
     linter: bool = linter_opt,
     formatter: bool = formatter_opt,
     no_hook: bool = no_hook_opt,
+    no_apply: bool = no_apply_opt,
 ) -> None:
     """Use Ruff: an extremely fast Python linter and code formatter."""
     from usethis._config_file import files_manager
@@ -373,7 +376,14 @@ def ruff(
         ),
         files_manager(),
     ):
-        _run_tool(use_ruff, remove=remove, how=how, linter=linter, formatter=formatter)
+        _run_tool(
+            use_ruff,
+            remove=remove,
+            how=how,
+            linter=linter,
+            formatter=formatter,
+            no_apply=no_apply,
+        )
 
 
 @app.command(
diff --git a/src/usethis/_ui/options.py b/src/usethis/_ui/options.py
@@ -36,6 +36,11 @@
     "--no-hook",
     help="Don't add or modify git hook configuration, e.g. pre-commit",
 )
+no_apply_opt = typer.Option(
+    False,
+    "--no-apply",
+    help="Don't run formatters after adding them.",
+)
 
 # author command options
 author_name_opt = typer.Option(..., "--name", help="Author name")
diff --git a/tests/usethis/_core/test_core_tool.py b/tests/usethis/_core/test_core_tool.py
@@ -2293,6 +2293,19 @@ def test_added(self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]):
                     "☐ Run 'uv run pyproject-fmt pyproject.toml' to run pyproject-fmt.\n"
                 )
 
+        class TestNoApply:
+            @pytest.mark.usefixtures("_vary_network_conn")
+            def test_skips_apply(
+                self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
+            ):
+                # Act
+                with change_cwd(uv_init_dir), PyprojectTOMLManager():
+                    use_pyproject_fmt(no_apply=True)
+
+                # Assert
+                out, _ = capfd.readouterr()
+                assert "Running pyproject-fmt" not in out
+
         @pytest.mark.usefixtures("_vary_network_conn")
         def test_pre_commit_integration(
             self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
@@ -3167,6 +3180,16 @@ def test_stdout(self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]):
                 "☐ Run 'uv run ruff format' to run the Ruff formatter.\n"
             )
 
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_no_apply(self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]):
+            # Act
+            with change_cwd(uv_init_dir), files_manager():
+                use_ruff(no_apply=True)
+
+            # Assert
+            out, _ = capfd.readouterr()
+            assert "Running the Ruff formatter" not in out
+
         @pytest.mark.usefixtures("_vary_network_conn")
         def test_pre_commit_first(self, uv_init_repo_dir: Path):
             # Act
diff --git a/tests/usethis/_ui/interface/test_format_.py b/tests/usethis/_ui/interface/test_format_.py
@@ -68,3 +68,15 @@ def test_none_backend_no_pyproject_toml(self, tmp_path: Path):
             "✔ Adding Ruff config to 'ruff.toml'.\n"
             "☐ Run 'ruff format' to run the Ruff formatter.\n"
         )
+
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_no_apply(self, uv_init_dir: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(uv_init_dir):
+            result = runner.invoke_safe(app, ["format", "--no-apply"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert "Running the Ruff formatter" not in result.output
+        assert "Running pyproject-fmt" not in result.output
diff --git a/tests/usethis/_ui/interface/test_tool.py b/tests/usethis/_ui/interface/test_tool.py
@@ -352,6 +352,17 @@ def test_how(self, tmp_path: Path):
 """
         )
 
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_no_apply(self, uv_init_dir: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(uv_init_dir):
+            result = runner.invoke_safe(app, ["pyproject-fmt", "--no-apply"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert "Running pyproject-fmt" not in result.output
+
 
 class TestPreCommit:
     @pytest.mark.usefixtures("_vary_network_conn")
@@ -557,6 +568,17 @@ def test_no_hook_skips_pre_commit(self, uv_init_dir: Path):
                 assert "ruff-check" not in hook_ids
                 assert "ruff-format" not in hook_ids
 
+    @pytest.mark.usefixtures("_vary_network_conn")
+    def test_no_apply(self, uv_init_dir: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(uv_init_dir):
+            result = runner.invoke_safe(app, ["ruff", "--no-apply"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert "Running the Ruff formatter" not in result.output
+
 
 class TestPytest:
     @pytest.mark.usefixtures("_vary_network_conn")
