Refactor _tool.py into separate modules (#573)

* Draft refactor - still circularity present

* Fix import cycles

* Test sync of OTHER_TOOLS list for pyproject.toml

Author: nathanjmcdougall

pyproject.toml

@@ -196,6 +196,30 @@ layers = [
 containers = [ "usethis._core" ]
 exhaustive = true
 
+[[tool.importlinter.contracts]]
+name = "usethis._tool"
+type = "layers"
+layers = [
+  "all_",
+  "impl",
+  "base",
+  "config | rule",
+]
+containers = [ "usethis._tool" ]
+exhaustive = true
+
+[[tool.importlinter.contracts]]
+name = "usethis._tool.impl"
+type = "layers"
+layers = [
+  "pyproject_toml",
+  "codespell | deptry | import_linter | pyproject_fmt | requirements_txt | ruff",
+  "pytest : coverage",
+  "pre_commit",
+]
+containers = [ "usethis._tool.impl" ]
+exhaustive = true
+
 [[tool.importlinter.contracts]]
 name = "usethis._integrations"
 type = "layers"

src/usethis/_core/ci.py

@@ -6,14 +6,12 @@
     remove_bitbucket_pipeline_config,
 )
 from usethis._integrations.uv.init import ensure_pyproject_toml
-from usethis._tool import (
-    CodespellTool,
-    DeptryTool,
-    PreCommitTool,
-    PyprojectFmtTool,
-    PytestTool,
-    RuffTool,
-)
+from usethis._tool.impl.codespell import CodespellTool
+from usethis._tool.impl.deptry import DeptryTool
+from usethis._tool.impl.pre_commit import PreCommitTool
+from usethis._tool.impl.pyproject_fmt import PyprojectFmtTool
+from usethis._tool.impl.pytest import PytestTool
+from usethis._tool.impl.ruff import RuffTool
 
 
 def use_ci_bitbucket(*, remove: bool = False) -> None:

src/usethis/_core/docstyle.py

@@ -1,7 +1,7 @@
 from typing import Literal
 
 from usethis._core.tool import use_ruff
-from usethis._tool import RuffTool
+from usethis._tool.impl.ruff import RuffTool
 from usethis.errors import UsethisError
 
 

src/usethis/_core/list.py

@@ -7,7 +7,8 @@
 
 from usethis._core.readme import is_readme_used
 from usethis._integrations.ci.bitbucket.used import is_bitbucket_used
-from usethis._tool import ALL_TOOLS, RuffTool
+from usethis._tool.all_ import ALL_TOOLS
+from usethis._tool.impl.ruff import RuffTool
 
 
 class UsageRow(BaseModel):

src/usethis/_core/tool.py

@@ -19,23 +19,21 @@
 from usethis._integrations.pytest.core import add_pytest_dir, remove_pytest_dir
 from usethis._integrations.uv.call import call_uv_subprocess
 from usethis._integrations.uv.init import ensure_pyproject_toml
-from usethis._tool import (
-    ALL_TOOLS,
-    CodespellTool,
-    CoverageTool,
-    DeptryTool,
-    ImportLinterTool,
-    PreCommitTool,
-    PyprojectFmtTool,
-    PyprojectTOMLTool,
-    PytestTool,
-    RequirementsTxtTool,
-    RuffTool,
-    RuleConfig,
-)
+from usethis._tool.all_ import ALL_TOOLS
+from usethis._tool.impl.codespell import CodespellTool
+from usethis._tool.impl.coverage import CoverageTool
+from usethis._tool.impl.deptry import DeptryTool
+from usethis._tool.impl.import_linter import ImportLinterTool
+from usethis._tool.impl.pre_commit import PreCommitTool
+from usethis._tool.impl.pyproject_fmt import PyprojectFmtTool
+from usethis._tool.impl.pyproject_toml import PyprojectTOMLTool
+from usethis._tool.impl.pytest import PytestTool
+from usethis._tool.impl.requirements_txt import RequirementsTxtTool
+from usethis._tool.impl.ruff import RuffTool
+from usethis._tool.rule import RuleConfig
 
 if TYPE_CHECKING:
-    from usethis._tool import Tool
+    from usethis._tool.base import Tool
 
 
 def use_codespell(*, remove: bool = False) -> None:

src/usethis/_integrations/ci/bitbucket/steps.py

@@ -76,7 +76,7 @@ def add_bitbucket_step_in_default(step: Step) -> None:
 
     # Early exit if the step already exists in some sense
     for existing_step in existing_steps:
-        if _steps_are_equivalent(existing_step, step):
+        if bitbucket_steps_are_equivalent(existing_step, step):
             return
 
     # Add the step to the default pipeline
@@ -91,7 +91,7 @@ def add_bitbucket_step_in_default(step: Step) -> None:
 
     # Remove the placeholder step if it already exists
     placeholder = _get_placeholder_step()
-    if not _steps_are_equivalent(placeholder, step):
+    if not bitbucket_steps_are_equivalent(placeholder, step):
         # Only remove the placeholder if it hasn't already been added.
         remove_bitbucket_step_from_default(placeholder)
 
@@ -247,7 +247,7 @@ def _censor_step(
 
 @_censor_step.register(StepItem)
 def _(item: StepItem, *, step: Step) -> StepItem | ParallelItem | StageItem | None:
-    if _steps_are_equivalent(item.step, step):
+    if bitbucket_steps_are_equivalent(item.step, step):
         return None
     return item
 
@@ -265,7 +265,7 @@ def _(item: ParallelItem, *, step: Step) -> StepItem | ParallelItem | StageItem
 
     new_step_items: list[StepItem] = []
     for step_item in step_items:
-        if _steps_are_equivalent(step_item.step, step):
+        if bitbucket_steps_are_equivalent(step_item.step, step):
             continue
         new_step_items.append(step_item)
 
@@ -288,7 +288,7 @@ def _(item: StageItem, *, step: Step) -> StepItem | ParallelItem | StageItem | N
 
     new_step1s = []
     for step1 in step1s:
-        if _steps_are_equivalent(step1tostep(step1), step):
+        if bitbucket_steps_are_equivalent(step1tostep(step1), step):
             continue
         new_step1s.append(step1)
 
@@ -326,7 +326,7 @@ def _add_step_caches_via_doc(
         _add_caches_via_doc(cache_by_name, doc=doc)
 
 
-def _steps_are_equivalent(step1: Step | None, step2: Step) -> bool:
+def bitbucket_steps_are_equivalent(step1: Step | None, step2: Step) -> bool:
     if step1 is None:
         return False
 

src/usethis/_integrations/pre_commit/hooks.py

@@ -54,7 +54,7 @@ def add_repo(repo: LocalRepo | UriRepo) -> None:
         existing_hooks = extract_hook_ids(doc.model)
 
         if not existing_hooks:
-            if _hook_ids_are_equivalent(hook_config.id, _PLACEHOLDER_ID):
+            if hook_ids_are_equivalent(hook_config.id, _PLACEHOLDER_ID):
                 tick_print("Adding placeholder hook to '.pre-commit-config.yaml'.")
             else:
                 tick_print(
@@ -113,12 +113,12 @@ def insert_repo(
         # Don't include the placeholder from now on, since we're adding a repo
         # which can be there instead.
         if not (
-            len(hooks) == 1 and _hook_ids_are_equivalent(hooks[0].id, _PLACEHOLDER_ID)
+            len(hooks) == 1 and hook_ids_are_equivalent(hooks[0].id, _PLACEHOLDER_ID)
         ):
             repos.append(repo)
 
         for hook in hooks:
-            if _hook_ids_are_equivalent(hook.id, predecessor):
+            if hook_ids_are_equivalent(hook.id, predecessor):
                 if repo_to_insert.hooks is not None:
                     for inserted_hook in repo_to_insert.hooks:
                         tick_print(
@@ -163,7 +163,7 @@ def remove_hook(hook_id: str) -> None:
                 continue
 
             for hook in repo.hooks:
-                if _hook_ids_are_equivalent(hook.id, hook_id):
+                if hook_ids_are_equivalent(hook.id, hook_id):
                     tick_print(
                         f"Removing hook '{hook.id}' from '.pre-commit-config.yaml'."
                     )
@@ -205,7 +205,7 @@ def extract_hook_ids(model: JsonSchemaForPreCommitConfigYaml) -> list[str]:
 
 def _hooks_are_equivalent(hook: HookDefinition, other: HookDefinition) -> bool:
     """Check if two hooks are equivalent."""
-    if _hook_ids_are_equivalent(hook.id, other.id):
+    if hook_ids_are_equivalent(hook.id, other.id):
         return True
 
     # Same contents, different name
@@ -214,7 +214,7 @@ def _hooks_are_equivalent(hook: HookDefinition, other: HookDefinition) -> bool:
     return hook == other
 
 
-def _hook_ids_are_equivalent(hook_id: str | None, other: str | None) -> bool:
+def hook_ids_are_equivalent(hook_id: str | None, other: str | None) -> bool:
     """Check if two hook IDs are equivalent."""
     # Same name
     if hook_id == other:

src/usethis/_interface/readme.py

@@ -14,7 +14,8 @@
 )
 from usethis._core.readme import add_readme
 from usethis._integrations.uv.used import is_uv_used
-from usethis._tool import PreCommitTool, RuffTool
+from usethis._tool.impl.pre_commit import PreCommitTool
+from usethis._tool.impl.ruff import RuffTool
 from usethis.errors import UsethisError