Enable reportPrivateUsage in basedpyright

nathanjmcdougall · nathanjmcdougall · commit d4efe305e49f · 2026-03-23T07:24:48.000+13:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -214,7 +214,6 @@ reportExplicitAny = false
 reportImplicitStringConcatenation = false
 reportMissingParameterType = false
 reportMissingTypeArgument = false
-reportPrivateUsage = false
 reportUnknownArgumentType = false
 reportUnknownMemberType = false
 reportUnknownVariableType = false
@@ -223,6 +222,7 @@ reportUnusedCallResult = false
 
 [[tool.basedpyright.executionEnvironments]]
 root = "tests"
+reportPrivateUsage = false
 reportUnannotatedClassAttribute = false
 reportUnknownLambdaType = false
 reportUnknownParameterType = false
diff --git a/src/usethis/_backend/uv/call.py b/src/usethis/_backend/uv/call.py
@@ -82,10 +82,9 @@ def _prepare_pyproject_write() -> None:
     if is_pyproject_toml and is_locked:
         ensure_pyproject_validity()
         PyprojectTOMLManager().write_file()
-        PyprojectTOMLManager()._content = None  # Basically a cache clear
+        PyprojectTOMLManager().revert()
     elif not is_pyproject_toml and is_locked:
-        # Similarly; cache clear
-        PyprojectTOMLManager()._content = None
+        PyprojectTOMLManager().revert()
     elif is_pyproject_toml:
         with PyprojectTOMLManager():
             ensure_pyproject_validity()
diff --git a/src/usethis/_core/tool.py b/src/usethis/_core/tool.py
@@ -244,7 +244,7 @@ def _add_bitbucket_linter_steps_to_default() -> None:
         tools: list[Tool] = [PyprojectFmtTool(), DeptryTool(), RuffTool()]
         for tool in tools:
             if tool.is_used():
-                tool._unconditional_update_bitbucket_steps()
+                tool.unconditional_update_bitbucket_steps()
 
 
 def _remove_bitbucket_linter_steps_from_default() -> None:
@@ -441,7 +441,7 @@ def use_ruff(
         # See docstring. Basically, `usethis docstyle` manages the pydocstyle rules,
         # so we want to allow the user to subsequently call `usethis tool ruff` and
         # still get non-minimal default rules.
-        all(tool._is_pydocstyle_rule(rule) for rule in tool.selected_rules())
+        all(tool.is_pydocstyle_rule(rule) for rule in tool.selected_rules())
         # Another situation where we add default rules is when there are no rules
         # selected yet (and we haven't explicitly been requested to add minimal config).
         or not tool.selected_rules()
diff --git a/src/usethis/_file/manager.py b/src/usethis/_file/manager.py
@@ -109,6 +109,10 @@ def commit(self, document: DocumentT) -> None:
         self._validate_lock()
         self._content = document
 
+    def revert(self) -> None:
+        """Clear the stored document without writing to disk."""
+        self._content = None
+
     def write_file(self) -> None:
         """Write the stored document to disk if there are changes."""
         self._validate_lock()
diff --git a/src/usethis/_file/merge.py b/src/usethis/_file/merge.py
@@ -6,7 +6,7 @@
 T = TypeVar("T", bound=MutableMapping[Any, Any])
 
 
-def _deep_merge(target: T, source: MutableMapping[Any, Any]) -> T:
+def deep_merge(target: T, source: MutableMapping[Any, Any]) -> T:
     """Recursively merge source into target in place, returning target.
 
     For keys present in both mappings, if both values are mappings the merge is
@@ -18,7 +18,7 @@ def _deep_merge(target: T, source: MutableMapping[Any, Any]) -> T:
             and isinstance(target[key], MutableMapping)
             and isinstance(value, MutableMapping)
         ):
-            _deep_merge(target[key], value)
+            deep_merge(target[key], value)
         else:
             target[key] = value
     return target
diff --git a/src/usethis/_file/pyproject_toml/valid.py b/src/usethis/_file/pyproject_toml/valid.py
@@ -63,7 +63,7 @@ def _ensure_project_name(project: Table) -> None:
     name = get_project_name_from_dir()
 
     tick_print(f"Setting project name to '{name}' in 'pyproject.toml'.")
-    if project._value:
-        project._value._insert_at(0, "name", name)
+    if project.value:
+        project._value._insert_at(0, "name", name)  # pyright: ignore[reportPrivateUsage]
     else:
         project["name"] = name
diff --git a/src/usethis/_file/toml/io_.py b/src/usethis/_file/toml/io_.py
@@ -18,7 +18,7 @@
     UnexpectedFileIOError,
     UnexpectedFileOpenError,
 )
-from usethis._file.merge import _deep_merge
+from usethis._file.merge import deep_merge
 from usethis._file.print_ import print_keys
 from usethis._file.toml.errors import (
     TOMLDecodeError,
@@ -396,7 +396,7 @@ def _set_value_in_existing(
         contents = value
         for key in reversed(keys):
             contents = {key: contents}
-        toml_document = _deep_merge(toml_document, contents)
+        toml_document = deep_merge(toml_document, contents)
         assert isinstance(toml_document, TOMLDocument)
     else:
         # Note that this alternative logic is just to avoid a bug:
@@ -411,7 +411,7 @@ def _set_value_in_existing(
             # https://github.com/usethis-python/usethis-python/issues/558
 
             placeholder = {keys[0]: {keys[1]: {}}}
-            toml_document = _deep_merge(toml_document, placeholder)
+            toml_document = deep_merge(toml_document, placeholder)
 
             contents = value
             for key in reversed(unshared_keys[1:]):
diff --git a/src/usethis/_file/yaml/io_.py b/src/usethis/_file/yaml/io_.py
@@ -21,7 +21,7 @@
     UnexpectedFileIOError,
     UnexpectedFileOpenError,
 )
-from usethis._file.merge import _deep_merge
+from usethis._file.merge import deep_merge
 from usethis._file.print_ import print_keys
 from usethis._file.yaml.errors import (
     UnexpectedYAMLIOError,
@@ -323,7 +323,7 @@ def extend_list(self, *, keys: Sequence[Key], values: Sequence[Any]) -> None:
             for key in reversed(keys):
                 new_content = {key: new_content}
             assert isinstance(new_content, dict)
-            content = _deep_merge(content, new_content)
+            content = deep_merge(content, new_content)
             assert isinstance(content, dict)
         else:
             TypeAdapter(dict).validate_python(p_parent)
@@ -400,7 +400,7 @@ def _set_value_in_existing(
     contents = value
     for key in reversed(keys):
         contents = {key: contents}
-    content = _deep_merge(content, contents)
+    content = deep_merge(content, contents)
 
 
 def _validate_keys(keys: Sequence[Key]) -> list[str]:
diff --git a/src/usethis/_integrations/ci/bitbucket/cache.py b/src/usethis/_integrations/ci/bitbucket/cache.py
@@ -28,11 +28,11 @@ def add_caches(cache_by_name: dict[str, schema.Cache]) -> None:
 
     mgr = BitbucketPipelinesYAMLManager()
     model = mgr.model_validate()
-    _add_caches_via_model(cache_by_name, model=model)
+    add_caches_via_model(cache_by_name, model=model)
     mgr.commit_model(model)
 
 
-def _add_caches_via_model(
+def add_caches_via_model(
     cache_by_name: dict[str, schema.Cache], *, model: schema.PipelinesConfiguration
 ) -> None:
     if model.definitions is None:
diff --git a/src/usethis/_integrations/ci/bitbucket/steps.py b/src/usethis/_integrations/ci/bitbucket/steps.py
@@ -15,7 +15,7 @@
     ScriptItemAnchor,
     anchor_name_from_script_item,
 )
-from usethis._integrations.ci.bitbucket.cache import _add_caches_via_model, remove_cache
+from usethis._integrations.ci.bitbucket.cache import add_caches_via_model, remove_cache
 from usethis._integrations.ci.bitbucket.errors import (
     UnexpectedImportPipelineError,
 )
@@ -412,7 +412,7 @@ def _add_step_caches_via_model(
                 )
                 raise NotImplementedError(msg) from None
             cache_by_name[name] = cache
-        _add_caches_via_model(cache_by_name, model=model)
+        add_caches_via_model(cache_by_name, model=model)
 
 
 def bitbucket_steps_are_equivalent(
diff --git a/src/usethis/_tool/base.py b/src/usethis/_tool/base.py
@@ -500,11 +500,11 @@ def update_bitbucket_steps(self, *, matrix_python: bool = True) -> None:
         """
         # If pre-commit is being used, we assume the tool is running via pre-commit,
         # and we don't need to add a separate Bitbucket step for it.
-        self._unconditional_update_bitbucket_steps(
+        self.unconditional_update_bitbucket_steps(
             matrix_python=matrix_python, skip_add=is_pre_commit_used()
         )
 
-    def _unconditional_update_bitbucket_steps(
+    def unconditional_update_bitbucket_steps(
         self, *, matrix_python: bool = True, skip_add: bool = False
     ) -> None:
         if not is_bitbucket_used() or not self.is_used():
diff --git a/src/usethis/_tool/impl/base/pre_commit.py b/src/usethis/_tool/impl/base/pre_commit.py
@@ -77,7 +77,7 @@ def update_bitbucket_steps(self, *, matrix_python: bool = True) -> None:
             matrix_python: Whether to use a Python version matrix. When False,
                            only the current development version is used.
         """
-        self._unconditional_update_bitbucket_steps(matrix_python=matrix_python)
+        self.unconditional_update_bitbucket_steps(matrix_python=matrix_python)
 
     @override
     def migrate_config_to_pre_commit(self) -> None:
diff --git a/src/usethis/_tool/impl/base/pytest.py b/src/usethis/_tool/impl/base/pytest.py
@@ -186,7 +186,7 @@ def update_bitbucket_steps(self, *, matrix_python: bool = True) -> None:
         # need to inform the user
         # Call _unconditional_update_bitbucket_steps directly to bypass the
         # pre-commit check in the base class
-        self._unconditional_update_bitbucket_steps(matrix_python=matrix_python)
+        self.unconditional_update_bitbucket_steps(matrix_python=matrix_python)
 
         backend = get_backend()
 
diff --git a/src/usethis/_tool/impl/base/ruff.py b/src/usethis/_tool/impl/base/ruff.py
@@ -322,12 +322,12 @@ def are_pydocstyle_rules_selected(self) -> bool:
         for rule in rules:
             if rule == "ALL":
                 return True
-            if self._is_pydocstyle_rule(rule):
+            if self.is_pydocstyle_rule(rule):
                 return True
         return False
 
     @staticmethod
-    def _is_pydocstyle_rule(rule: Rule) -> bool:
+    def is_pydocstyle_rule(rule: Rule) -> bool:
         return [d for d in rule if d.isalpha()] == ["D"]
 
     @override
diff --git a/tests/usethis/_file/test_merge.py b/tests/usethis/_file/test_merge.py
@@ -1,82 +1,82 @@
 from __future__ import annotations
 
-from usethis._file.merge import _deep_merge
+from usethis._file.merge import deep_merge
 
 
 class TestDeepMerge:
     class TestBasicMerge:
         def test_top_level_key_added(self) -> None:
             target: dict = {"a": 1}
             source: dict = {"b": 2}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 1, "b": 2}
 
     class TestNestedDicts:
         def test_nested_merge(self) -> None:
             target: dict = {"a": {"x": 1}}
             source: dict = {"a": {"y": 2}}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": {"x": 1, "y": 2}}
 
         def test_deeply_nested(self) -> None:
             target: dict = {"a": {"b": {"c": 1}}}
             source: dict = {"a": {"b": {"d": 2}}}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": {"b": {"c": 1, "d": 2}}}
 
     class TestReplacementOfNonDictValues:
         def test_scalar_replaced_by_scalar(self) -> None:
             target: dict = {"a": 1}
             source: dict = {"a": 2}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 2}
 
         def test_dict_replaced_by_scalar(self) -> None:
             target: dict = {"a": {"x": 1}}
             source: dict = {"a": 99}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 99}
 
         def test_scalar_replaced_by_dict(self) -> None:
             target: dict = {"a": 99}
             source: dict = {"a": {"x": 1}}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": {"x": 1}}
 
         def test_list_replaced_by_list(self) -> None:
             target: dict = {"a": [1, 2]}
             source: dict = {"a": [3, 4]}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": [3, 4]}
 
     class TestInPlaceMutation:
         def test_returns_target(self) -> None:
             target: dict = {"a": 1}
             source: dict = {"b": 2}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result is target
 
         def test_target_is_mutated(self) -> None:
             target: dict = {"a": 1}
             source: dict = {"b": 2}
-            _deep_merge(target, source)
+            deep_merge(target, source)
             assert target == {"a": 1, "b": 2}
 
     class TestDisjointKeys:
         def test_disjoint_keys_merged(self) -> None:
             target: dict = {"a": 1, "b": 2}
             source: dict = {"c": 3, "d": 4}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 1, "b": 2, "c": 3, "d": 4}
 
         def test_empty_source(self) -> None:
             target: dict = {"a": 1}
             source: dict = {}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 1}
 
         def test_empty_target(self) -> None:
             target: dict = {}
             source: dict = {"a": 1}
-            result = _deep_merge(target, source)
+            result = deep_merge(target, source)
             assert result == {"a": 1}

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`ScriptItemAnchor,`
`16`	`16`	`anchor_name_from_script_item,`
`17`	`17`	`)`
`18`		`-from usethis._integrations.ci.bitbucket.cache import _add_caches_via_model, remove_cache`
	`18`	`+from usethis._integrations.ci.bitbucket.cache import add_caches_via_model, remove_cache`
`19`	`19`	`from usethis._integrations.ci.bitbucket.errors import (`
`20`	`20`	`UnexpectedImportPipelineError,`
`21`	`21`	`)`
`@@ -412,7 +412,7 @@ def _add_step_caches_via_model(`
`412`	`412`	`)`
`413`	`413`	`raise NotImplementedError(msg) from None`
`414`	`414`	`cache_by_name[name] = cache`
`415`		`- _add_caches_via_model(cache_by_name, model=model)`
	`415`	`+ add_caches_via_model(cache_by_name, model=model)`
`416`	`416`
`417`	`417`
`418`	`418`	`def bitbucket_steps_are_equivalent(`