refactor: Privatize/remove objects

Author: pawamoy

CHANGELOG.md

@@ -343,8 +343,8 @@ for the initial code allowing to compare two Griffe trees.
 - All parameters of the [`load_git`][griffe.git.load_git] function, except `module`, are now keyword-only.
 - Parameter `try_relative_path` of the [`load_git`][griffe.git.load_git] function was removed.
 - Parameter `commit` was renamed `ref` in the [`load_git`][griffe.git.load_git] function.
-- Parameter `commit` was renamed `ref` in the [`tmp_worktree`][griffe.git.tmp_worktree] helper, which will probably become private later.
-- Parameters `ref` and `repo` switched positions in the [`tmp_worktree`][griffe.git.tmp_worktree] helper.
+- Parameter `commit` was renamed `ref` in the `tmp_worktree` helper, which will probably become private later.
+- Parameters `ref` and `repo` switched positions in the `tmp_worktree` helper.
 - All parameters of the [`resolve_aliases`][griffe.loader.GriffeLoader.resolve_aliases] method are now keyword-only.
 - Parameters `only_exported` and `only_known_modules` of the [`resolve_module_aliases`][griffe.loader.GriffeLoader.resolve_module_aliases]
     method were removed. This method is most probably not used by anyone, and will probably be made private in the future.

src/griffe/docstrings/markdown.py

@@ -7,7 +7,6 @@
     InspectorExtension,
     VisitorExtension,
     When,
-    load_extension,
     load_extensions,
 )
 
@@ -16,7 +15,6 @@
     "Extensions",
     "ExtensionType",
     "InspectorExtension",
-    "load_extension",
     "load_extensions",
     "VisitorExtension",
     "When",

src/griffe/extensions/__init__.py

@@ -402,7 +402,7 @@ def _load_extension_path(path: str) -> ModuleType:
     return module
 
 
-def load_extension(
+def _load_extension(
     extension: str | dict[str, Any] | ExtensionType | type[ExtensionType],
 ) -> ExtensionType | list[ExtensionType]:
     """Load a configured extension.
@@ -500,7 +500,7 @@ def load_extensions(exts: Sequence[str | dict[str, Any] | ExtensionType | type[E
     """
     extensions = Extensions()
     for extension in exts:
-        ext = load_extension(extension)
+        ext = _load_extension(extension)
         if isinstance(ext, list):
             extensions.add(*ext)
         else:

src/griffe/extensions/base.py

@@ -7,7 +7,7 @@
 
 from griffe.agents.nodes import ObjectNode
 from griffe.exceptions import ExtensionError
-from griffe.extensions.base import InspectorExtension, VisitorExtension, When, load_extension
+from griffe.extensions.base import InspectorExtension, VisitorExtension, When, _load_extension
 from griffe.importer import dynamic_import
 from griffe.logger import get_logger
 
@@ -36,7 +36,7 @@ class HybridExtension(VisitorExtension):
 
     def __init__(
         self,
-        extensions: Sequence[str | dict[str, Any] | InspectorExtension | type[Extension]],
+        extensions: Sequence[str | dict[str, Any] | InspectorExtension | type[InspectorExtension]],
         object_paths: Sequence[str | Pattern] | None = None,
     ) -> None:
         """Initialize the extension.
@@ -49,7 +49,7 @@ def __init__(
         Raises:
             ExtensionError: When the passed extension is not an inspector extension.
         """
-        self._extensions: list[InspectorExtension] = [load_extension(ext) for ext in extensions]  # type: ignore[misc]
+        self._extensions: list[InspectorExtension] = [_load_extension(ext) for ext in extensions]  # type: ignore[misc]
         for extension in self._extensions:
             if not isinstance(extension, InspectorExtension):
                 raise ExtensionError(

src/griffe/extensions/hybrid.py

@@ -25,11 +25,6 @@
 _editable_editables_patterns = [re.compile(pat) for pat in (r"^__editables_\w+\.py$", "^_editable_impl_\\w+\\.py$")]
 _editable_setuptools_patterns = [re.compile(pat) for pat in ("^__editable__\\w+\\.py$",)]
 _editable_scikit_build_core_patterns = [re.compile(pat) for pat in (r"^_\w+_editable.py$",)]
-_editable_patterns = (
-    *_editable_editables_patterns,
-    *_editable_setuptools_patterns,
-    *_editable_scikit_build_core_patterns,
-)
 
 
 def _match_pattern(string: str, patterns: Sequence[Pattern]) -> bool:

src/griffe/finder.py

@@ -77,7 +77,7 @@ def _get_repo_root(path: str | Path) -> str:
 
 
 @contextmanager
-def tmp_worktree(repo: str | Path = ".", ref: str = "HEAD") -> Iterator[Path]:
+def _tmp_worktree(repo: str | Path = ".", ref: str = "HEAD") -> Iterator[Path]:
     """Context manager that checks out the given reference in the given repository to a temporary worktree.
 
     Parameters:
@@ -149,7 +149,7 @@ def load_git(
     Returns:
         A loaded module.
     """
-    with tmp_worktree(repo, ref) as worktree:
+    with _tmp_worktree(repo, ref) as worktree:
         search_paths = [worktree / path for path in search_paths or ["."]]
         if isinstance(module, Path):
             module = worktree / module