Update print_how_to_use for all tools to use new `get_install_metho… (#814)

nathanjmcdougall · web-flow · commit 2af33dba1a4d · 2025-06-28T15:02:40.000+12:00
* Update `print_how_to_use` for all tools to use new `get_install_method` method for determining the approach to recommend for using the tool

* Fix schema violation in pre-commit integration test

* Provide explicit pre-commit config for a few TestPrintHowToUse tests

* Update test to reflect new beheaviour of Import Linter's `print_how_to_use` (i.e. prefer using directly rather than via pre-commit; less verbose and more consistent behaviour viz. other tools)
diff --git a/src/usethis/_tool/impl/deptry.py b/src/usethis/_tool/impl/deptry.py
@@ -3,22 +3,18 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from typing_extensions import assert_never
+
 from usethis._console import box_print, info_print, tick_print
 from usethis._integrations.ci.bitbucket.anchor import (
     ScriptItemAnchor as BitbucketScriptItemAnchor,
 )
 from usethis._integrations.ci.bitbucket.schema import Script as BitbucketScript
 from usethis._integrations.ci.bitbucket.schema import Step as BitbucketStep
 from usethis._integrations.file.pyproject_toml.io_ import PyprojectTOMLManager
-from usethis._integrations.pre_commit.schema import (
-    HookDefinition,
-    Language,
-    LocalRepo,
-)
+from usethis._integrations.pre_commit.schema import HookDefinition, Language, LocalRepo
 from usethis._integrations.project.layout import get_source_dir_str
-from usethis._integrations.uv.deps import (
-    Dependency,
-)
+from usethis._integrations.uv.deps import Dependency
 from usethis._integrations.uv.used import is_uv_used
 from usethis._tool.base import Tool
 from usethis._tool.config import (
@@ -42,10 +38,23 @@ def name(self) -> str:
 
     def print_how_to_use(self) -> None:
         _dir = get_source_dir_str()
-        if is_uv_used():
-            box_print(f"Run 'uv run deptry {_dir}' to run deptry.")
+        install_method = self.get_install_method()
+        if install_method == "pre-commit":
+            if is_uv_used():
+                box_print(
+                    f"Run 'uv run pre-commit run deptry --all-files' to run {self.name}."
+                )
+            else:
+                box_print(
+                    f"Run 'pre-commit run deptry --all-files' to run {self.name}."
+                )
+        elif install_method == "devdep" or install_method is None:
+            if is_uv_used():
+                box_print(f"Run 'uv run deptry {_dir}' to run deptry.")
+            else:
+                box_print(f"Run 'deptry {_dir}' to run deptry.")
         else:
-            box_print(f"Run 'deptry {_dir}' to run deptry.")
+            assert_never(install_method)
 
     def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]:
         return [Dependency(name="deptry")]
diff --git a/src/usethis/_tool/impl/import_linter.py b/src/usethis/_tool/impl/import_linter.py
@@ -5,10 +5,10 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from typing_extensions import assert_never
+
 from usethis._config import usethis_config
-from usethis._config_file import (
-    DotImportLinterManager,
-)
+from usethis._config_file import DotImportLinterManager
 from usethis._console import box_print, info_print, warn_print
 from usethis._integrations.ci.bitbucket.anchor import (
     ScriptItemAnchor as BitbucketScriptItemAnchor,
@@ -18,39 +18,25 @@
 from usethis._integrations.file.ini.io_ import INIFileManager
 from usethis._integrations.file.pyproject_toml.io_ import PyprojectTOMLManager
 from usethis._integrations.file.setup_cfg.io_ import SetupCFGManager
-from usethis._integrations.pre_commit.schema import (
-    HookDefinition,
-    Language,
-    LocalRepo,
-)
+from usethis._integrations.pre_commit.schema import HookDefinition, Language, LocalRepo
 from usethis._integrations.project.errors import ImportGraphBuildFailedError
 from usethis._integrations.project.imports import (
     LayeredArchitecture,
     get_layered_architectures,
 )
 from usethis._integrations.project.name import get_project_name
 from usethis._integrations.project.packages import get_importable_packages
-from usethis._integrations.uv.deps import (
-    Dependency,
-)
+from usethis._integrations.uv.deps import Dependency
 from usethis._integrations.uv.used import is_uv_used
 from usethis._tool.base import Tool
-from usethis._tool.config import (
-    ConfigEntry,
-    ConfigItem,
-    ConfigSpec,
-    NoConfigValue,
-)
-from usethis._tool.impl.pre_commit import PreCommitTool
+from usethis._tool.config import ConfigEntry, ConfigItem, ConfigSpec, NoConfigValue
 from usethis._tool.impl.ruff import RuffTool
 from usethis._tool.pre_commit import PreCommitConfig
 from usethis._tool.rule import RuleConfig
 
 if TYPE_CHECKING:
     from usethis._io import KeyValueFileManager
-    from usethis._tool.config import (
-        ResolutionT,
-    )
+    from usethis._tool.config import ResolutionT
 
 
 IMPORT_LINTER_CONTRACT_MIN_MODULE_COUNT = 3
@@ -77,7 +63,8 @@ def print_how_to_use(self) -> None:
             info_print(
                 "For more info see <https://docs.python.org/3/tutorial/modules.html#packages>"
             )
-        if PreCommitTool().is_used():
+        install_method = self.get_install_method()
+        if install_method == "pre-commit":
             if is_uv_used():
                 box_print(
                     f"Run 'uv run pre-commit run import-linter --all-files' to run {self.name}."
@@ -86,10 +73,13 @@ def print_how_to_use(self) -> None:
                 box_print(
                     f"Run 'pre-commit run import-linter --all-files' to run {self.name}."
                 )
-        elif is_uv_used():
-            box_print(f"Run 'uv run lint-imports' to run {self.name}.")
+        elif install_method == "devdep" or install_method is None:
+            if is_uv_used():
+                box_print(f"Run 'uv run lint-imports' to run {self.name}.")
+            else:
+                box_print(f"Run 'lint-imports' to run {self.name}.")
         else:
-            box_print(f"Run 'lint-imports' to run {self.name}.")
+            assert_never(install_method)
 
     def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]:
         # We need to add the import-linter package itself as a dev dependency.
diff --git a/src/usethis/_tool/impl/pyproject_fmt.py b/src/usethis/_tool/impl/pyproject_fmt.py
@@ -2,24 +2,20 @@
 
 from pathlib import Path
 
+from typing_extensions import assert_never
+
 from usethis._console import box_print
 from usethis._integrations.ci.bitbucket.anchor import (
     ScriptItemAnchor as BitbucketScriptItemAnchor,
 )
 from usethis._integrations.ci.bitbucket.schema import Script as BitbucketScript
 from usethis._integrations.ci.bitbucket.schema import Step as BitbucketStep
 from usethis._integrations.file.pyproject_toml.io_ import PyprojectTOMLManager
-from usethis._integrations.pre_commit.schema import (
-    HookDefinition,
-    UriRepo,
-)
-from usethis._integrations.uv.deps import (
-    Dependency,
-)
+from usethis._integrations.pre_commit.schema import HookDefinition, UriRepo
+from usethis._integrations.uv.deps import Dependency
 from usethis._integrations.uv.used import is_uv_used
 from usethis._tool.base import Tool
 from usethis._tool.config import ConfigEntry, ConfigItem, ConfigSpec
-from usethis._tool.impl.pre_commit import PreCommitTool
 from usethis._tool.pre_commit import PreCommitConfig
 
 
@@ -30,7 +26,8 @@ def name(self) -> str:
         return "pyproject-fmt"
 
     def print_how_to_use(self) -> None:
-        if PreCommitTool().is_used():
+        install_method = self.get_install_method()
+        if install_method == "pre-commit":
             if is_uv_used():
                 box_print(
                     f"Run 'uv run pre-commit run pyproject-fmt --all-files' to run {self.name}."
@@ -39,10 +36,15 @@ def print_how_to_use(self) -> None:
                 box_print(
                     f"Run 'pre-commit run pyproject-fmt --all-files' to run {self.name}."
                 )
-        elif is_uv_used():
-            box_print(f"Run 'uv run pyproject-fmt pyproject.toml' to run {self.name}.")
+        elif install_method == "devdep" or install_method is None:
+            if is_uv_used():
+                box_print(
+                    f"Run 'uv run pyproject-fmt pyproject.toml' to run {self.name}."
+                )
+            else:
+                box_print(f"Run 'pyproject-fmt pyproject.toml' to run {self.name}.")
         else:
-            box_print(f"Run 'pyproject-fmt pyproject.toml' to run {self.name}.")
+            assert_never(install_method)
 
     def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]:
         return [Dependency(name="pyproject-fmt")]
diff --git a/src/usethis/_tool/impl/requirements_txt.py b/src/usethis/_tool/impl/requirements_txt.py
@@ -3,15 +3,12 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from typing_extensions import assert_never
+
 from usethis._console import box_print
-from usethis._integrations.pre_commit.schema import (
-    HookDefinition,
-    Language,
-    LocalRepo,
-)
+from usethis._integrations.pre_commit.schema import HookDefinition, Language, LocalRepo
 from usethis._integrations.uv.used import is_uv_used
 from usethis._tool.base import Tool
-from usethis._tool.impl.pre_commit import PreCommitTool
 from usethis._tool.pre_commit import PreCommitConfig
 
 if TYPE_CHECKING:
@@ -28,21 +25,24 @@ def name(self) -> str:
         return "requirements.txt"
 
     def print_how_to_use(self) -> None:
-        if PreCommitTool().is_used():
+        install_method = self.get_install_method()
+        if install_method == "pre-commit":
             if is_uv_used():
                 box_print(
                     "Run 'uv run pre-commit run uv-export' to write 'requirements.txt'."
                 )
             else:
                 box_print("Run 'pre-commit run uv-export' to write 'requirements.txt'.")
-        else:
+        elif install_method == "devdep" or install_method is None:
             if not is_uv_used():
                 # This is a very crude approach as a temporary measure.
                 box_print("Install uv to use 'uv export'.")
 
             box_print(
                 "Run 'uv export --no-default-groups -o=requirements.txt' to write 'requirements.txt'."
             )
+        else:
+            assert_never(install_method)
 
     def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]:
         return []
diff --git a/src/usethis/_tool/impl/ruff.py b/src/usethis/_tool/impl/ruff.py
@@ -5,10 +5,7 @@
 
 from typing_extensions import assert_never
 
-from usethis._config_file import (
-    DotRuffTOMLManager,
-    RuffTOMLManager,
-)
+from usethis._config_file import DotRuffTOMLManager, RuffTOMLManager
 from usethis._console import box_print, tick_print
 from usethis._integrations.ci.bitbucket.anchor import (
     ScriptItemAnchor as BitbucketScriptItemAnchor,
@@ -23,9 +20,7 @@
     Language,
     LocalRepo,
 )
-from usethis._integrations.uv.deps import (
-    Dependency,
-)
+from usethis._integrations.uv.deps import Dependency
 from usethis._integrations.uv.used import is_uv_used
 from usethis._tool.base import Tool
 from usethis._tool.config import (
@@ -72,21 +67,44 @@ def __init__(
     def name(self) -> str:
         return "Ruff"
 
-    def print_how_to_use(self) -> None:
-        if is_uv_used():
-            if self.is_linter_used():
-                box_print(
-                    "Run 'uv run ruff check --fix' to run the Ruff linter with autofixes."
-                )
-            if self.is_formatter_used():
-                box_print("Run 'uv run ruff format' to run the Ruff formatter.")
+    def print_how_to_use(self) -> None:  # noqa: PLR0912
+        install_method = self.get_install_method()
+        if install_method == "pre-commit":
+            if is_uv_used():
+                if self.is_linter_used():
+                    box_print(
+                        "Run 'uv run pre-commit run ruff --all-files' to run the Ruff linter."
+                    )
+                if self.is_formatter_used():
+                    box_print(
+                        "Run 'uv run pre-commit run ruff-format' to run the Ruff formatter."
+                    )
+            else:
+                if self.is_linter_used():
+                    box_print(
+                        "Run 'pre-commit run ruff --all-files' to run the Ruff linter."
+                    )
+                if self.is_formatter_used():
+                    box_print(
+                        "Run 'pre-commit run ruff-format' to run the Ruff formatter."
+                    )
+        elif install_method == "devdep" or install_method is None:
+            if is_uv_used():
+                if self.is_linter_used():
+                    box_print(
+                        "Run 'uv run ruff check --fix' to run the Ruff linter with autofixes."
+                    )
+                if self.is_formatter_used():
+                    box_print("Run 'uv run ruff format' to run the Ruff formatter.")
+            else:
+                if self.is_linter_used():
+                    box_print(
+                        "Run 'ruff check --fix' to run the Ruff linter with autofixes."
+                    )
+                if self.is_formatter_used():
+                    box_print("Run 'ruff format' to run the Ruff formatter.")
         else:
-            if self.is_linter_used():
-                box_print(
-                    "Run 'ruff check --fix' to run the Ruff linter with autofixes."
-                )
-            if self.is_formatter_used():
-                box_print("Run 'ruff format' to run the Ruff formatter.")
+            assert_never(install_method)
 
     def get_dev_deps(self, *, unconditional: bool = False) -> list[Dependency]:
         return [Dependency(name="ruff")]
diff --git a/tests/usethis/_core/test_core_ci.py b/tests/usethis/_core/test_core_ci.py
@@ -100,7 +100,7 @@ def test_contents(
                 self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
             ):
                 # Arrange
-                (uv_init_dir / ".pre-commit-config.yaml").touch()
+                (uv_init_dir / ".pre-commit-config.yaml").write_text("repos: []")
 
                 # Act
                 with change_cwd(uv_init_dir), files_manager():
diff --git a/tests/usethis/_core/test_core_tool.py b/tests/usethis/_core/test_core_tool.py
@@ -1439,7 +1439,7 @@ def test_config(
                 "✔ Adding hook 'import-linter' to '.pre-commit-config.yaml'.\n"
                 "ℹ Ensure '__init__.py' files are used in your packages.\n"  # noqa: RUF001
                 "ℹ For more info see <https://docs.python.org/3/tutorial/modules.html#packages>\n"  # noqa: RUF001
-                "☐ Run 'uv run pre-commit run import-linter --all-files' to run Import Linter.\n"
+                "☐ Run 'uv run lint-imports' to run Import Linter.\n"
             )
 
     class TestBitbucketIntegration:
diff --git a/tests/usethis/_tool/impl/test_import_linter.py b/tests/usethis/_tool/impl/test_import_linter.py
@@ -14,7 +14,14 @@ def test_pre_commit_and_uv(
         ):
             # Arrange
             (tmp_path / "uv.lock").touch()
-            (tmp_path / ".pre-commit-config.yaml").touch()
+            (tmp_path / ".pre-commit-config.yaml").write_text("""\
+repos:
+  - repo: local
+    hooks:
+      - id: import-linter
+        name: import-linter
+        entry: uv run --frozen --offline lint-imports
+""")
             (tmp_path / "ruff.toml").touch()
 
             # Act
@@ -32,8 +39,15 @@ def test_pre_commit_no_uv(
             self, tmp_path: Path, capfd: pytest.CaptureFixture[str]
         ):
             # Arrange
-            (tmp_path / ".pre-commit-config.yaml").touch()
-            (tmp_path / "ruff.toml").touch()
+            (tmp_path / ".pre-commit-config.yaml").write_text("""\
+repos:
+  - repo: local
+    hooks:
+      - id: import-linter
+        name: import-linter
+        entry: uv run --frozen --offline lint-imports
+""")
+            (tmp_path / "ruff.toml").touch()  # For avoid info/hint messages
 
             # Act
             with change_cwd(tmp_path), files_manager():
diff --git a/tests/usethis/_tool/impl/test_requirements_txt.py b/tests/usethis/_tool/impl/test_requirements_txt.py
@@ -13,7 +13,17 @@ def test_pre_commit_and_not_uv(
             self, tmp_path: Path, capfd: pytest.CaptureFixture[str]
         ):
             # Arrange
-            (tmp_path / ".pre-commit-config.yaml").touch()
+            (tmp_path / ".pre-commit-config.yaml").write_text("""\
+repos:
+  - repo: local
+    hooks:
+      - id: uv-export
+        name: uv-export
+        entry: uv export --frozen --offline --quiet -o=requirements.txt
+        language: system
+        pass_filenames: false
+        require_serial: true
+""")
 
             # Act
             with change_cwd(tmp_path), files_manager():

Original file line number	Diff line number	Diff line change
`@@ -1439,7 +1439,7 @@ def test_config(`
`1439`	`1439`	`"✔ Adding hook 'import-linter' to '.pre-commit-config.yaml'.\n"`
`1440`	`1440`	`"ℹ Ensure '__init__.py' files are used in your packages.\n" # noqa: RUF001`
`1441`	`1441`	`"ℹ For more info see <https://docs.python.org/3/tutorial/modules.html#packages>\n" # noqa: RUF001`
`1442`		`- "☐ Run 'uv run pre-commit run import-linter --all-files' to run Import Linter.\n"`
	`1442`	`+ "☐ Run 'uv run lint-imports' to run Import Linter.\n"`
`1443`	`1443`	`)`
`1444`	`1444`
`1445`	`1445`	`class TestBitbucketIntegration:`