Create convenience methods for bitbucket config updates (#431)

Author: nathanjmcdougall

pyproject.toml

@@ -162,7 +162,7 @@ layers = [
   "_app",
   "_interface",
   "_core",
-  "_tool | _ci",
+  "_tool",
   "_config_file",
   "_integrations",
   "_console",

src/usethis/_ci.py

@@ -1,14 +1,10 @@
 from __future__ import annotations
 
-from usethis._ci import update_bitbucket_pytest_steps
 from usethis._console import box_print, info_print
 from usethis._integrations.ci.bitbucket.config import (
     add_bitbucket_pipeline_config,
     remove_bitbucket_pipeline_config,
 )
-from usethis._integrations.ci.bitbucket.steps import (
-    add_bitbucket_steps_in_default,
-)
 from usethis._integrations.uv.init import ensure_pyproject_toml
 from usethis._tool import (
     CodespellTool,
@@ -42,23 +38,18 @@ def use_ci_bitbucket(*, remove: bool = False) -> None:
         add_bitbucket_pipeline_config(report_placeholder=not use_any_tool)
 
         if use_pre_commit:
-            add_bitbucket_steps_in_default(PreCommitTool().get_bitbucket_steps())
+            PreCommitTool().update_bitbucket_steps()
         else:
             # This order should match the canonical order in the function which add
             # steps
-            if use_pyproject_fmt:
-                add_bitbucket_steps_in_default(PyprojectFmtTool().get_bitbucket_steps())
-            if use_ruff:
-                add_bitbucket_steps_in_default(RuffTool().get_bitbucket_steps())
-            if use_deptry:
-                add_bitbucket_steps_in_default(DeptryTool().get_bitbucket_steps())
-            if use_codespell:
-                add_bitbucket_steps_in_default(CodespellTool().get_bitbucket_steps())
+            PyprojectFmtTool().update_bitbucket_steps()
+            RuffTool().update_bitbucket_steps()
+            DeptryTool().update_bitbucket_steps()
+            CodespellTool().update_bitbucket_steps()
 
-        if use_pytest:
-            update_bitbucket_pytest_steps()
+        PytestTool().update_bitbucket_steps()
 
-        else:
+        if not use_pytest:
             info_print(
                 "Consider `usethis tool pytest` to test your code for the pipeline."
             )

src/usethis/_core/ci.py

@@ -3,17 +3,9 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from usethis._ci import (
-    is_bitbucket_used,
-    remove_bitbucket_pytest_steps,
-    update_bitbucket_pytest_steps,
-)
 from usethis._config import usethis_config
 from usethis._console import tick_print
-from usethis._integrations.ci.bitbucket.steps import (
-    add_bitbucket_steps_in_default,
-    remove_bitbucket_steps_from_default,
-)
+from usethis._integrations.ci.bitbucket.used import is_bitbucket_used
 from usethis._integrations.file.pyproject_toml.valid import ensure_pyproject_validity
 from usethis._integrations.pre_commit.core import (
     install_pre_commit_hooks,
@@ -52,15 +44,14 @@ def use_codespell(*, remove: bool = False) -> None:
     if not remove:
         if not PreCommitTool().is_used():
             tool.add_dev_deps()
-            if is_bitbucket_used():
-                add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
+            tool.update_bitbucket_steps()
         else:
             tool.add_pre_commit_repo_configs()
 
         tool.add_configs()
         tool.print_how_to_use()
     else:
-        remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
+        tool.remove_bitbucket_steps()
         tool.remove_configs()
         tool.remove_pre_commit_repo_configs()
         tool.remove_dev_deps()
@@ -91,14 +82,14 @@ def use_deptry(*, remove: bool = False) -> None:
         tool.add_dev_deps()
         if PreCommitTool().is_used():
             tool.add_pre_commit_repo_configs()
-        elif is_bitbucket_used():
-            add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
+        else:
+            tool.update_bitbucket_steps()
 
         tool.print_how_to_use()
     else:
         tool.remove_pre_commit_repo_configs()
         tool.remove_configs()
-        remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
+        tool.remove_bitbucket_steps()
         tool.remove_dev_deps()
         tool.remove_managed_files()
 
@@ -133,14 +124,14 @@ def use_pre_commit(*, remove: bool = False) -> None:
 
         install_pre_commit_hooks()
 
+        tool.update_bitbucket_steps()
         if is_bitbucket_used():
-            add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
             _remove_bitbucket_linter_steps_from_default()
 
         tool.print_how_to_use()
     else:
+        tool.remove_bitbucket_steps()
         if is_bitbucket_used():
-            remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
             _add_bitbucket_linter_steps_to_default()
 
         uninstall_pre_commit_hooks()
@@ -177,15 +168,15 @@ def _add_bitbucket_linter_steps_to_default() -> None:
         tools: list[Tool] = [PyprojectFmtTool(), DeptryTool(), RuffTool()]
         for tool in tools:
             if tool.is_used():
-                add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
+                tool.update_bitbucket_steps()
 
 
 def _remove_bitbucket_linter_steps_from_default() -> None:
     # This order of removing tools should be synced with the order hard-coded
     # in the function which adds steps.
-    remove_bitbucket_steps_from_default(PyprojectFmtTool().get_bitbucket_steps())
-    remove_bitbucket_steps_from_default(DeptryTool().get_bitbucket_steps())
-    remove_bitbucket_steps_from_default(RuffTool().get_bitbucket_steps())
+    PyprojectFmtTool().remove_bitbucket_steps()
+    DeptryTool().remove_bitbucket_steps()
+    RuffTool().remove_bitbucket_steps()
 
 
 def use_pyproject_fmt(*, remove: bool = False) -> None:
@@ -196,15 +187,14 @@ def use_pyproject_fmt(*, remove: bool = False) -> None:
     if not remove:
         if not PreCommitTool().is_used():
             tool.add_dev_deps()
-            if is_bitbucket_used():
-                add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
+            tool.update_bitbucket_steps()
         else:
             tool.add_pre_commit_repo_configs()
 
         tool.add_configs()
         tool.print_how_to_use()
     else:
-        remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
+        tool.remove_bitbucket_steps()
         tool.remove_configs()
         tool.remove_pre_commit_repo_configs()
         tool.remove_dev_deps()
@@ -239,16 +229,14 @@ def use_pytest(*, remove: bool = False) -> None:
         # https://github.com/fpgmaas/deptry/issues/302
         add_pytest_dir()
 
-        if is_bitbucket_used():
-            update_bitbucket_pytest_steps()
+        PytestTool().update_bitbucket_steps()
 
         tool.print_how_to_use()
 
         if CoverageTool().is_used():
             CoverageTool().print_how_to_use()
     else:
-        if is_bitbucket_used():
-            remove_bitbucket_pytest_steps()
+        PytestTool().remove_bitbucket_steps()
 
         if RuffTool().is_used():
             RuffTool().deselect_rules(tool.get_associated_ruff_rules())
@@ -342,13 +330,13 @@ def use_ruff(*, remove: bool = False) -> None:
         tool.ignore_rules(ignored_rules)
         if PreCommitTool().is_used():
             tool.add_pre_commit_repo_configs()
-        elif is_bitbucket_used():
-            add_bitbucket_steps_in_default(tool.get_bitbucket_steps())
+        else:
+            tool.update_bitbucket_steps()
 
         tool.print_how_to_use()
     else:
         tool.remove_pre_commit_repo_configs()
-        remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
+        tool.remove_bitbucket_steps()
         tool.remove_configs()
         tool.remove_dev_deps()
         tool.remove_managed_files()

src/usethis/_core/tool.py

@@ -64,11 +64,6 @@
     script_item.yaml_set_anchor(value=name, always_dump=True)
 
 
-def add_bitbucket_steps_in_default(steps: list[Step]) -> None:
-    for step in steps:
-        add_bitbucket_step_in_default(step)
-
-
 def add_bitbucket_step_in_default(step: Step) -> None:
     try:
         existing_steps = get_steps_in_default()
@@ -187,11 +182,6 @@ def _add_step_in_default_via_doc(
         )
 
 
-def remove_bitbucket_steps_from_default(steps: list[Step]) -> None:
-    for step in steps:
-        remove_bitbucket_step_from_default(step)
-
-
 def remove_bitbucket_step_from_default(step: Step) -> None:
     """Remove a step from the default pipeline in the Bitbucket Pipelines configuration.
 

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

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+
+def is_bitbucket_used() -> bool:
+    return (Path.cwd() / "bitbucket-pipelines.yml").exists()