Make TypeVars private

Author: oprypin

mkdocstrings_handlers/crystal/collector.py

@@ -26,7 +26,7 @@
 log = logging.getLogger(f"mkdocs.plugins.{__name__}")
 
 if TYPE_CHECKING:
-    D = TypeVar("D", bound=DocItem)
+    _D = TypeVar("_D", bound=DocItem)
 
 
 class CrystalCollector(BaseHandler):
@@ -226,9 +226,9 @@ def _get_locations(cls, obj: DocItem) -> Sequence[str]:
     def _filter(
         cls,
         filters: Sequence[str] | bool,  # noqa: FBT001
-        mapp: DocMapping[D],
-        getter: Callable[[D], Sequence[str]],
-    ) -> DocMapping[D]:
+        mapp: DocMapping[_D],
+        getter: Callable[[_D], Sequence[str]],
+    ) -> DocMapping[_D]:
         if filters is False:
             return DocMapping(())
         if filters is True:

mkdocstrings_handlers/crystal/crystal_html.py

@@ -4,11 +4,12 @@
 import html.parser
 import io
 from collections.abc import Iterable, Sequence
-from typing import Callable
+from typing import TYPE_CHECKING, Callable
 
 from markupsafe import Markup, escape
 
-LinkToken = tuple[int, int, str]
+if TYPE_CHECKING:
+    _LinkToken = tuple[int, int, str]
 
 
 class TextWithLinks(collections.UserString):
@@ -19,10 +20,10 @@ class TextWithLinks(collections.UserString):
     The link information is currently for internal use only.
     """
 
-    tokens: Sequence[LinkToken]
+    tokens: Sequence[_LinkToken]
     """The list of embedded links."""
 
-    def __init__(self, string, tokens: Sequence[LinkToken]):
+    def __init__(self, string, tokens: Sequence[_LinkToken]):
         super().__init__(string)
         self.tokens = tokens
 
@@ -37,7 +38,7 @@ def parse_crystal_html(crystal_html: str) -> TextWithLinks:
 
 
 def linkify_highlighted_html(
-    pygments_html: str, html_tokens: Sequence[LinkToken], make_link: Callable[[str, str], str]
+    pygments_html: str, html_tokens: Sequence[_LinkToken], make_link: Callable[[str, str], str]
 ) -> str:
     pygments_parser = _PygmentsHTMLHandler(html_tokens, make_link)
     pygments_parser.feed(pygments_html)
@@ -48,7 +49,7 @@ class _CrystalHTMLHandler(html.parser.HTMLParser):
     def __init__(self) -> None:
         super().__init__()
         self.text = io.StringIO()
-        self.tokens: list[LinkToken] = []
+        self.tokens: list[_LinkToken] = []
         self._link_starts: list[tuple[int, str]] = []
 
     def handle_starttag(self, tag, attrs):
@@ -73,7 +74,7 @@ def link_to_path(cls, href):
 
 
 class _PygmentsHTMLHandler(html.parser.HTMLParser):
-    def __init__(self, tokens: Iterable[LinkToken], make_link: Callable[[str, str], str]):
+    def __init__(self, tokens: Iterable[_LinkToken], make_link: Callable[[str, str], str]):
         super().__init__()
         self.tokens = iter(tokens)
         self.make_link = make_link

mkdocstrings_handlers/crystal/items.py

@@ -124,7 +124,7 @@ def lookup(self, identifier: str | DocPath) -> DocItem:
 }
 
 
-D = TypeVar("D", bound=DocItem)
+_D = TypeVar("_D", bound=DocItem)
 
 
 class DocType(DocItem):
@@ -415,14 +415,14 @@ class DocConstructor(DocClassMethod):
     """A [DocInstanceMethod][mkdocstrings_handlers.crystal.items.DocInstanceMethod] representing a Crystal macro."""
 
 
-class DocMapping(Generic[D]):
+class DocMapping(Generic[_D]):
     """Represents items contained within a type. A container of [DocItem][mkdocstrings_handlers.crystal.items.DocItem]s."""
 
     items: Sequence = ()
     search: Mapping[str, Any] = {}
     _empty: ClassVar[DocMapping]
 
-    def __new__(cls, items: Sequence[D]) -> Self:
+    def __new__(cls, items: Sequence[_D]) -> Self:
         if not items:
             empty: Self
             try:
@@ -432,15 +432,15 @@ def __new__(cls, items: Sequence[D]) -> Self:
             return empty
         return object.__new__(cls)
 
-    def __init__(self, items: Sequence[D]):
+    def __init__(self, items: Sequence[_D]):
         self.items = items
         search: dict[str, Any] = {}
         self.search = search
         for item in self.items:
             search.setdefault(item.rel_id, item)
             search.setdefault(item.name, item)
 
-    def __iter__(self) -> Iterator[D]:
+    def __iter__(self) -> Iterator[_D]:
         """Iterate over the items like a list."""
         return iter(self.items)
 
@@ -456,7 +456,7 @@ def __contains__(self, key: str) -> bool:
         """`"identifier" in mapping` to check whether the mapping contains an item by this identifier (see [DocItem.rel_id][mkdocstrings_handlers.crystal.items.DocItem.rel_id])."""
         return key in self.search
 
-    def __getitem__(self, key: str) -> D:
+    def __getitem__(self, key: str) -> _D:
         """`mapping["identifier"]` to get the item by this identifier (see [DocItem.rel_id][mkdocstrings_handlers.crystal.items.DocItem.rel_id]).
 
         Returns:

mkdocstrings_handlers/crystal/renderer.py

@@ -3,7 +3,7 @@
 import contextlib
 import xml.etree.ElementTree as etree
 from collections.abc import Mapping
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING, Any
 
 import jinja2
 import markdown_callouts
@@ -18,8 +18,6 @@
 
     from .items import DocItem, DocPath
 
-    T = TypeVar("T")
-
 
 class CrystalRenderer(base.BaseHandler):
     fallback_theme = "material"