Rename to managed pyproject keys instead of ID keys

nathanjmcdougall · nathanjmcdougall · commit f11a58334331 · 2025-02-22T08:22:35.000+13:00
diff --git a/src/usethis/_tool.py b/src/usethis/_tool.py
@@ -95,7 +95,7 @@ def get_managed_files(self) -> list[Path]:
         """Get (relative) paths to files managed by the tool."""
         return []
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         """Get keys for any pyproject.toml sections only used by this tool (not shared)."""
         return []
 
@@ -118,7 +118,7 @@ def is_used(self) -> bool:
         for file in self.get_managed_files():
             if file.exists() and file.is_file():
                 return True
-        for id_keys in self.get_pyproject_id_keys():
+        for id_keys in self.get_managed_pyproject_keys():
             if do_id_keys_exist(id_keys):
                 return True
         for dep in self.get_dev_deps(unconditional=True):
@@ -208,7 +208,7 @@ def remove_pyproject_configs(self) -> None:
         # Collect all keys to remove
         keys_to_remove = [
             config.id_keys for config in self.get_pyproject_configs()
-        ] + self.get_pyproject_id_keys()
+        ] + self.get_managed_pyproject_keys()
 
         # Try to remove the first key to trigger the message
         first_removal = True
@@ -273,7 +273,7 @@ def get_pre_commit_repos(self) -> list[LocalRepo | UriRepo]:
             )
         ]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "codespell"]]
 
     def get_managed_files(self) -> list[Path]:
@@ -335,7 +335,7 @@ def get_pyproject_configs(self) -> list[PyProjectConfig]:
             ),
         ]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "coverage"]]
 
     def get_managed_files(self) -> list[Path]:
@@ -372,7 +372,7 @@ def get_pre_commit_repos(self) -> list[LocalRepo | UriRepo]:
             )
         ]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "deptry"]]
 
     def get_bitbucket_steps(self) -> list[BitbucketStep]:
@@ -453,7 +453,7 @@ def get_pyproject_configs(self) -> list[PyProjectConfig]:
             )
         ]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "pyproject-fmt"]]
 
     def get_bitbucket_steps(self) -> list[BitbucketStep]:
@@ -535,7 +535,7 @@ def get_pyproject_configs(self) -> list[PyProjectConfig]:
     def get_associated_ruff_rules(self) -> list[str]:
         return ["PT"]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "pytest"]]
 
     def get_managed_files(self) -> list[Path]:
@@ -639,7 +639,7 @@ def get_pyproject_configs(self) -> list[PyProjectConfig]:
             )
         ]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", "ruff"]]
 
     def get_managed_files(self) -> list[Path]:
diff --git a/tests/usethis/test_usethis_tool.py b/tests/usethis/test_usethis_tool.py
@@ -69,7 +69,7 @@ def get_associated_ruff_rules(self) -> list[str]:
     def get_managed_files(self) -> list[Path]:
         return [Path("mytool-config.yaml")]
 
-    def get_pyproject_id_keys(self) -> list[list[str]]:
+    def get_managed_pyproject_keys(self) -> list[list[str]]:
         return [["tool", self.name], ["project", "classifiers"]]
 
 
@@ -171,14 +171,14 @@ def test_specific(self):
                 Path("mytool-config.yaml"),
             ]
 
-    class TestGetPyprojectIdKeys:
+    class TestManagedPyprojectKeys:
         def test_default(self):
             tool = DefaultTool()
-            assert tool.get_pyproject_id_keys() == []
+            assert tool.get_managed_pyproject_keys() == []
 
         def test_specific(self):
             tool = MyTool()
-            assert tool.get_pyproject_id_keys() == [
+            assert tool.get_managed_pyproject_keys() == [
                 ["tool", "my_tool"],
                 ["project", "classifiers"],
             ]
@@ -781,7 +781,7 @@ def test_get_pyproject_id_keys(self):
         tool = DeptryTool()
 
         # Act
-        result = tool.get_pyproject_id_keys()
+        result = tool.get_managed_pyproject_keys()
 
         # Assert
         assert result == [["tool", "deptry"]]
@@ -809,7 +809,7 @@ def test_config_keys_are_subkeys_of_id_keys(self):
         tool = DeptryTool()
 
         # Act
-        id_keys = tool.get_pyproject_id_keys()
+        id_keys = tool.get_managed_pyproject_keys()
         configs = tool.get_pyproject_configs()
 
         # Assert
@@ -823,7 +823,7 @@ def test_config_keys_are_subkeys_of_id_keys(self):
 @pytest.mark.parametrize("tool", ALL_TOOLS)
 def test_all_tools_config_keys_are_subkeys_of_id_keys(tool: Tool):
     """Test that all tools' config keys are subkeys of their ID keys."""
-    id_keys = tool.get_pyproject_id_keys()
+    id_keys = tool.get_managed_pyproject_keys()
     configs = tool.get_pyproject_configs()
 
     for config in configs:
