mkdocstrings-python 1.14.6__py3-none-any.whl → 1.15.0__py3-none-any.whl

mkdocstrings_handlers/python/handler.py

@@ -305,6 +305,11 @@ class PythonHandler(BaseHandler):
         self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()
 
     def get_aliases(self, identifier: str) -> tuple[str, ...]:  # noqa: D102 (ignore missing docstring)
+        if "(" in identifier:
+            identifier, parameter = identifier.split("(", 1)
+            parameter.removesuffix(")")
+        else:
+            parameter = ""
         try:
             data = self._modules_collection[identifier]
         except (KeyError, AliasResolutionError):
@@ -315,7 +320,9 @@ class PythonHandler(BaseHandler):
                 if alias not in aliases:
                     aliases.append(alias)
         except AliasResolutionError:
-            return tuple(aliases)
+            pass
+        if parameter:
+            return tuple(f"{alias}({parameter})" for alias in aliases)
         return tuple(aliases)
 
     def normalize_extension_paths(self, extensions: Sequence) -> Sequence:

mkdocstrings_handlers/python/rendering.py

@@ -32,7 +32,7 @@ from mkdocs_autorefs.references import AutorefsHookInterface
 from mkdocstrings.loggers import get_logger
 
 if TYPE_CHECKING:
-    from collections.abc import Sequence
+    from collections.abc import Iterator, Sequence
 
     from griffe import Attribute, Class, Function, Module
     from jinja2 import Environment, Template
@@ -326,26 +326,47 @@ def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
     return Markup(text).format(**variables)
 
 
-def do_split_path(path: str, full_path: str) -> list[tuple[str, str]]:
+_split_path_re = re.compile(r"([.(]?)([\w]+)(\))?")
+_splitable_re = re.compile(r"[().]")
+
+
+def do_split_path(path: str, full_path: str) -> Iterator[tuple[str, str, str, str]]:
     """Split object paths for building cross-references.
 
     Parameters:
         path: The path to split.
+        full_path: The full path, used to compute correct paths for each part of the path.
 
-    Returns:
-        A list of pairs (title, full path).
+    Yields:
+        4-tuples: prefix, word, full path, suffix.
     """
-    if "." not in path:
-        return [(path, full_path)]
-    pairs = []
-    full_path = ""
-    for part in path.split("."):
-        if full_path:
-            full_path += f".{part}"
-        else:
-            full_path = part
-        pairs.append((part, full_path))
-    return pairs
+    # Path is a single word, yield full path directly.
+    if not _splitable_re.search(path):
+        yield ("", path, full_path, "")
+        return
+
+    current_path = ""
+    if path == full_path:
+        # Split full path and yield directly without storing data in a dict.
+        for match in _split_path_re.finditer(full_path):
+            prefix, word, suffix = match.groups()
+            current_path = f"{current_path}{prefix}{word}{suffix or ''}" if current_path else word
+            yield prefix or "", word, current_path, suffix or ""
+        return
+
+    # Split full path first to store tuples in a dict.
+    elements = {}
+    for match in _split_path_re.finditer(full_path):
+        prefix, word, suffix = match.groups()
+        current_path = f"{current_path}{prefix}{word}{suffix or ''}" if current_path else word
+        elements[word] = (prefix or "", word, current_path, suffix or "")
+
+    # Then split path and pick tuples from the dict.
+    first = True
+    for match in _split_path_re.finditer(path):
+        prefix, word, current_path, suffix = elements[match.group(2)]
+        yield "" if first else prefix, word, current_path, suffix
+        first = False
 
 
 def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:

mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja

@@ -31,7 +31,8 @@ which is a tree-like structure representing a Python expression.
     {%- elif annotation_path == "full" -%}
       {%- set annotation = full -%}
     {%- endif -%}
-    {%- for title, path in annotation|split_path(full) -%}
+    {%- for prefix, title, path, suffix in annotation|split_path(full) -%}
+      {{ prefix }}
       {%- if not signature -%}
         {#- Always render cross-references outside of signatures. We don't need to stash them. -#}
         <autoref identifier="{{ path }}" optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
@@ -44,7 +45,7 @@ which is a tree-like structure representing a Python expression.
         {#- We're in a signature but cross-references are disabled, we just render the title. -#}
         {{ title }}
       {%- endif -%}
-      {%- if not loop.last -%}.{%- endif -%}
+      {{ suffix }}
     {%- endfor -%}
   {%- endwith -%}
 {%- endmacro -%}

{mkdocstrings_python-1.14.6.dist-info → mkdocstrings_python-1.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.14.6
+Version: 1.15.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC

{mkdocstrings_python-1.14.6.dist-info → mkdocstrings_python-1.15.0.dist-info}/RECORD

@@ -150,9 +150,9 @@ mkdocstrings_handlers/python/.mypy_cache/CACHEDIR.TAG,sha256=8cE6_FVTWMkDOw8fMKq
 mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
 mkdocstrings_handlers/python/config.py,sha256=dZTBl2BbEyVc_o8PW0rReWHDzdqYstOP7fnlWioRVk0,31459
 mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
-mkdocstrings_handlers/python/handler.py,sha256=05cu68blsknnR_KCgiHVnyUeDQMcuP57zgiZSHZeReI,14601
+mkdocstrings_handlers/python/handler.py,sha256=0ap57utWbw6o4LWLhZOQWsr_H4Fr7t1zcCmV6xfqY-w,14849
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/python/rendering.py,sha256=rxK3GMaw_kyx8xA2b_LM9H54j746eAz6gbGf7RnGW-A,21946
+mkdocstrings_handlers/python/rendering.py,sha256=DuNV-cI2Tie574yItj6CiE95THbKOxpZE0uvl50iGmI,23054
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
 mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=sbbkQtl5bPm5mmmZ-VCyLtfsOuhSr-FrD2FUSlbK-Zs,4451
 mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
@@ -188,7 +188,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja
 mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=-aNSOHi5lvqheUzklSRThN7UeCdsqTHm35CyKi5yaWU,448
 mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja,sha256=2J1tK2lSTUHYOnOnqeX_I_LWMAOh2dZGbIvifKKt46c,4589
 mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=JU-ScDWoFk0m6x0Dx50LKN9yW7RzTWj4VYcJYEIQ144,430
-mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=sdK6-0ars0CuX8Jsf7pPKP1YoPQV8NBSl9qDncQTFaA,4384
+mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=kfvwxwW6BrHLAEd-h7YOUWMu4lFaOrUEPvt9sD_y0G0,4393
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=tFpXIt5sIhjXjTCXhtYZ4cGpbgdbaIdbm8HdP9Pccik,424
 mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=KyiqTv51KNJmItZmdzV0BuUsr341yKn4um7exYkJ2Is,5718
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=SJGvRoTYj9AImTRRn-SP4nGAdpfz-ai4gGgHGxMOJK8,418
@@ -327,8 +327,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
-mkdocstrings_python-1.14.6.dist-info/METADATA,sha256=g2HXnCzLjLHuwqo76VSQIGJXNSBmTYVzJ-2XUhU7Vew,5570
-mkdocstrings_python-1.14.6.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-mkdocstrings_python-1.14.6.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-1.14.6.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.14.6.dist-info/RECORD,,
+mkdocstrings_python-1.15.0.dist-info/METADATA,sha256=RHYBPgd4y65iKIORXsqIBrJoP1wuOkvFG_Dq1kE5YS4,5570
+mkdocstrings_python-1.15.0.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+mkdocstrings_python-1.15.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-1.15.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.15.0.dist-info/RECORD,,