mkdocstrings-python 2.0.8__py3-none-any.whl → 2.0.9__py3-none-any.whl

mkdocstrings_handlers/python/_internal/handler.py

@@ -365,7 +365,7 @@ class PythonHandler(BaseHandler):
             The aliases.
         """
         if "(" in identifier:
-            identifier, parameter = identifier.split("(", 1)
+            identifier, _, parameter = identifier.partition("(")
             parameter = parameter.removesuffix(")")
         else:
             parameter = ""
@@ -373,15 +373,18 @@ class PythonHandler(BaseHandler):
             data = self._modules_collection[identifier]
         except (KeyError, AliasResolutionError):
             return ()
-        aliases = [data.path]
+        aliases: dict[str, object] = {data.path: None}
         try:
-            for alias in [data.canonical_path, *data.aliases]:
-                if alias not in aliases:
-                    aliases.append(alias)
+            canonical_path = data.canonical_path
+            data_aliases = data.aliases
         except AliasResolutionError:
             pass
+        else:
+            aliases[canonical_path] = None
+            aliases.update(data_aliases)
         if parameter:
-            return tuple(f"{alias}({parameter})" for alias in aliases)
+            suffix = f"({parameter})"
+            return tuple(alias + suffix for alias in aliases)
         return tuple(aliases)
 
     def normalize_extension_paths(self, extensions: Sequence) -> list[str | dict[str, Any]]:

mkdocstrings_handlers/python/_internal/rendering.py

@@ -125,6 +125,15 @@ class _StashCrossRefFilter:
 do_stash_crossref = _StashCrossRefFilter()
 """Filter to stash cross-references (and restore them after formatting and highlighting)."""
 
+_highlighting_span_re = re.compile(r'<span class="[a-z]{1,2}">')
+_crossref_key_re = re.compile(r"\b_[A-Za-z0-9]{2,}\b")
+
+
+def _restore_crossrefs(text: str, stash: dict[str, str]) -> str:
+    text = _crossref_key_re.sub(lambda match: stash.get(match[0], match[0]), text)
+    stash.clear()
+    return text
+
 
 def _format_signature(name: Markup, signature: str, line_length: int) -> str:
     name = str(name).strip()  # type: ignore[assignment]
@@ -199,13 +208,11 @@ def do_format_signature(
     # Pygments will set an `fm` (function -> magic) CSS class.
     # To fix this, we replace the CSS class in the first span with `nf`,
     # unless we already found an `nf` span.
-    if not re.search(r'<span class="nf">', signature):
-        signature = re.sub(r'<span class="[a-z]{1,2}">', '<span class="nf">', signature, count=1)
+    if '<span class="nf">' not in signature:
+        signature = _highlighting_span_re.sub('<span class="nf">', signature, count=1)
 
     if stash := env.filters["stash_crossref"].stash:
-        for key, value in stash.items():
-            signature = re.sub(rf"\b{key}\b", value, signature)
-        stash.clear()
+        signature = _restore_crossrefs(signature, stash)
 
     return signature
 
@@ -267,9 +274,7 @@ def do_format_attribute(
     )
 
     if stash := env.filters["stash_crossref"].stash:
-        for key, value in stash.items():
-            signature = re.sub(rf"\b{key}\b", value, signature)
-        stash.clear()
+        signature = _restore_crossrefs(signature, stash)
 
     return signature
 
@@ -322,13 +327,11 @@ def do_format_type_alias(
     # but instead as a regular name: `n` CSS class instead of `nc`.
     # To fix it, we replace the first occurrence of an `n` CSS class
     # with an `nc` one, unless we found `nc` already.
-    if not re.search(r'<span class="nc">', signature):
-        signature = re.sub(r'<span class="[a-z]{1,2}">', '<span class="nc">', signature, count=1)
+    if '<span class="nc">' not in signature:
+        signature = _highlighting_span_re.sub('<span class="nc">', signature, count=1)
 
     if stash := env.filters["stash_crossref"].stash:
-        for key, value in stash.items():
-            signature = re.sub(rf"\b{key}\b", value, signature)
-        stash.clear()
+        signature = _restore_crossrefs(signature, stash)
 
     return signature
 
@@ -805,6 +808,11 @@ class AutorefsHook(AutorefsHookInterface):
         if self.config.relative_crossrefs and identifier.startswith("."):  # type: ignore[attr-defined]
             identifier = identifier[1:]
             obj = self.current_object
+            # Anchor on the docstring's parent: for inherited members the current
+            # object is an alias living under the inheriting class, while the
+            # docstring was written on the defining object in another tree.
+            if self.current_object.docstring is not None and self.current_object.docstring.parent is not None:
+                obj = self.current_object.docstring.parent
             while identifier and identifier[0] == ".":
                 identifier = identifier[1:]
                 if obj.parent is None:

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

@@ -33,10 +33,13 @@ Context:
 
     {% set attribute_name = attribute.path if show_full_path else attribute.name %}
 
+    {% set object_type = "data" if attribute.parent.is_module else "property" if "property" in attribute.labels else "attribute" %}
+    {#- Object type in objects inventory. -#}
+
     {% if not root or config.show_root_heading %}
       {% filter heading(
           heading_level,
-          role=("data" if attribute.parent.kind.value == "module" else "attr"),
+          role=object_type,
           id=html_id,
           class="doc doc-heading",
           toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute.name),
@@ -89,7 +92,7 @@ Context:
 
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role=("data" if attribute.parent.kind.value == "module" else "attr"),
+            role=object_type,
             id=html_id,
             toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute_name),
             hidden=True,

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

@@ -158,7 +158,7 @@ Context:
 
         {% block inheritance_diagram scoped %}
           {#- Inheritance diagram block.
-          
+
           This block renders the inheritance diagram for the class,
           using Mermaid syntax and a bit of JavaScript to make the nodes clickable,
           linking to the corresponding class documentation.

mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja

@@ -38,7 +38,7 @@ Context:
               {% if config.parameter_headings %}
                 {% filter heading(
                     heading_level + 1,
-                    role="param",
+                    role="parameter",
                     id=html_id ~ "(" ~ parameter.name ~ ")",
                     class="doc doc-heading doc-heading-parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
@@ -86,7 +86,7 @@ Context:
           {% if config.parameter_headings %}
             {% filter heading(
                 heading_level + 1,
-                role="param",
+                role="parameter",
                 id=html_id ~ "(" ~ parameter.name ~ ")",
                 class="doc doc-heading doc-heading-parameter",
                 toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
@@ -132,7 +132,7 @@ Context:
               {% if config.parameter_headings %}
                 {% filter heading(
                     heading_level + 1,
-                    role="param",
+                    role="parameter",
                     id=html_id ~ "(" ~ parameter.name ~ ")",
                     class="doc doc-heading doc-heading-parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,

mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja

@@ -42,7 +42,7 @@ Context:
               {% if config.type_parameter_headings %}
                 {% filter heading(
                     heading_level + 1,
-                    role="typeparam",
+                    role="typeparameter",
                     id=obj.path ~ "[" ~ type_parameter.name ~ "]",
                     class="doc doc-heading doc-heading-type_parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,
@@ -93,7 +93,7 @@ Context:
           {% if config.type_parameter_headings %}
             {% filter heading(
                 heading_level + 1,
-                role="typeparam",
+                role="typeparameter",
                 id=obj.path ~ "[" ~ type_parameter.name ~ "]",
                 class="doc doc-heading doc-heading-type_parameter",
                 toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,
@@ -156,7 +156,7 @@ Context:
               {% if config.type_parameter_headings %}
                 {% filter heading(
                     heading_level + 1,
-                    role="typeparam",
+                    role="typeparameter",
                     id=obj.path ~ "[" ~ type_parameter.name ~ "]",
                     class="doc doc-heading doc-heading-type_parameter",
                     toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_parameter.name,

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

@@ -37,11 +37,13 @@ Context:
     {#- Brief or full function name depending on configuration. -#}
     {% set symbol_type = "method" if function.parent.is_class else "function" %}
     {#- Symbol type: method when parent is a class, function otherwise. -#}
+    {% set object_type = symbol_type %}
+    {#- Object type in objects inventory. -#}
 
     {% if not root or config.show_root_heading %}
       {% filter heading(
           heading_level,
-          role="function",
+          role=object_type,
           id=html_id,
           class="doc doc-heading",
           toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
@@ -106,7 +108,7 @@ Context:
       {% if config.show_root_toc_entry %}
         {% filter heading(
             heading_level,
-            role="function",
+            role=object_type,
             id=html_id,
             toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
             hidden=True,

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

@@ -35,7 +35,7 @@ Context:
     {% if not root or config.show_root_heading %}
       {% filter heading(
           heading_level,
-          role="typealias",
+          role="type",
           id=html_id,
           class="doc doc-heading",
           toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_alias"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_alias.name,
@@ -83,7 +83,7 @@ Context:
     {% else %}
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role="typealias",
+            role="type",
             id=html_id,
             toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-type_alias"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + type_alias.name,
             hidden=True,

{mkdocstrings_python-2.0.8.dist-info → mkdocstrings_python-2.0.9.dist-info}/METADATA

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

{mkdocstrings_python-2.0.8.dist-info → mkdocstrings_python-2.0.9.dist-info}/RECORD

@@ -2,13 +2,13 @@ mkdocstrings_handlers/python/__init__.py,sha256=nMq6EQFwlnoSHY5FZAS0Fpa-fnb_piBv
 mkdocstrings_handlers/python/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/_internal/config.py,sha256=iSnsL-DXqWSm_0YKv-2giDxTdljxZWvDgTGkCo9GBPg,35261
 mkdocstrings_handlers/python/_internal/debug.py,sha256=A6B3w6LWN22kYtvvbmz7vnh8Pr5hzvtrHhM3-Es8Isg,2882
-mkdocstrings_handlers/python/_internal/handler.py,sha256=wmFS4BWvgYsepHo50di7ex5H8TN2Hd5oGZVHD_jZeCk,17044
-mkdocstrings_handlers/python/_internal/rendering.py,sha256=PaloOLFj6vZq63R6GEOCItWTfor4JjUEbh0XxJGEdh8,29570
+mkdocstrings_handlers/python/_internal/handler.py,sha256=A80vSRt8LTooP8UIdlgnu0mv7AOJPBjXGUKhqy88OdI,17143
+mkdocstrings_handlers/python/_internal/rendering.py,sha256=Rq3Wpj15KJX-0IvntAFtenVaAgIhyW9yUWiFLXmc5bM,30029
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=oY6HWvWntBLBe5L4jbS8bSRftVuC3jmtF6Iy-8tT5hM,4842
+mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=jKDnwh9FtF9dwVO5iCIXj8NxpUcIhtbqX3EJeqYZXy8,4917
 mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja,sha256=k8eX0lyQmmooaEotjYngdXO8RJldjixvZW30S5jGXOA,2109
 mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=1q7RS0i6SkNriRtGX8BC2wzKhp3pPcLVSJWBEUmZOSg,8153
-mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=ZSDeKPYttMyTbZ9udURpJ4tGm2Nl7HOMaCJlVoG2wzs,11675
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=UHLcx86ZNT-jVsqrtxiRcpZ97V7ReueT7ywPP7JiLZ4,11665
 mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=iKi-31JKoHwG7-w3S88A9YTu9kuV6-c9gwKb8bUtXuw,3440
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja,sha256=VFwImgb1toxkjWqyhTNFQbyYE3d11yXI___3vpIu2u0,687
 mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja,sha256=WVy3pU1KGIhk1rFdADmWydj-KUXZW7STC_OWAl0yFyk,4349
@@ -17,16 +17,16 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.ji
 mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja,sha256=AmPFt0by3CWHL4jBIFNJrVepl1aa467XBVjqqcOUMhM,3842
 mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja,sha256=_7s-TBJtv8i8qMkOREilNQ1E1VWab9XW-Y7Zo05OJYk,3311
 mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja,sha256=tnzLsC0GpcnVryFDEao2go1U61DbxWAM-ZVKwC6QxTY,4049
-mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja,sha256=kKZTWI7DfUWdCEnnzenDc6Rya2WHkPeStMdODjLImpE,7188
+mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja,sha256=KG__L1pPosXS_DJp7JgFVpAgmjE4pTE9qlwqCXJ1Xn0,7200
 mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja,sha256=uLQdEAcaiItD91eEm9cikdJ319Yt09otEKOr2WdGJx4,3637
 mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja,sha256=uhyvkQxAR5JbSgnoh_oglNPm2nb-DsAXi37C7ijUVaU,4765
 mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja,sha256=a5wE6A89wt_zBk72yev4Qa_FUQiQ8JMLey4TEZYOJz4,4729
 mkdocstrings_handlers/python/templates/material/_base/docstring/type_aliases.html.jinja,sha256=SlNRZDplIBDaSKq0u1n0FaEeXyiWJWh89sJf7edblfI,3405
-mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja,sha256=P_M8tvUKMS0DPpkS4GiT2FZq_bujQNIJA1tAjw8VWM0,8596
+mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja,sha256=M5b3lEdhaqK_iazfzqzK0UJT0kJnhOUAgxrHzDVPIOw,8608
 mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja,sha256=evSdVXZwKpHIJ7dnCP3njB0DD7rcJPgTPgeG54jRIUE,3612
 mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja,sha256=bo1Fjfw21VZRdf8MPzReIr8sCFPDoBBWQloXJ42IObQ,4699
 mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=zjjO_q9oCQCpVx6iR0adfog_lhQ85uM4oHZDJO_sKqU,6592
-mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=rW-47bNjme32xUWXGmMm6e-eQRsqtjc3BxEQvFxwyL4,6017
+mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=oEKyREZQnWm9d-f_28qdaOvWZWOaSCjV5OfKvOnYCas,6105
 mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja,sha256=mue5CMl2WQpagj3aYqbUiAQX0P72aLCgY3MX_zEpE8s,786
 mkdocstrings_handlers/python/templates/material/_base/language.html.jinja,sha256=7gyknTiapqCM8TjUHdXkQgZMmYwcuy6Ze0pkntE7g8s,617
 mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja,sha256=tzS9C3l1c5liALvpYl7dHOGhtoFpRQwMgm_gAVKcv_Y,1731
@@ -40,7 +40,7 @@ mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja
 mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja,sha256=zfQtsOcDtbKhXvxsQreGgbVeXAlLHYe6uFo7mWZJaQY,766
 mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja,sha256=4u9XrIKNm_6UNeqrrfhN49eJgJbUMlPw2_jWfYQlYN8,742
 mkdocstrings_handlers/python/templates/material/_base/summary/type_aliases.html.jinja,sha256=-RMlGx46brcKwjSTP-AOCGu3DBci0cMHv2AlBXYkQDY,767
-mkdocstrings_handlers/python/templates/material/_base/type_alias.html.jinja,sha256=bX-4dduZmiW_DH5Xl416kV0y5QFFA8OsKne8XSglWyA,4109
+mkdocstrings_handlers/python/templates/material/_base/type_alias.html.jinja,sha256=jiingF0j_ATOtY_kY6KicAaxm80byuRaMrnx_BgNyRo,4099
 mkdocstrings_handlers/python/templates/material/_base/type_parameters.html.jinja,sha256=xdqFBdIUEgfDDVXu_qqvrM9ZFYmi0t9UJ4DwktxTqok,3265
 mkdocstrings_handlers/python/templates/material/attribute.html.jinja,sha256=HkKz308jpCZj3PffJ5JtZC46rtkNNZ-2bE5zvaQQTRE,43
 mkdocstrings_handlers/python/templates/material/backlinks.html.jinja,sha256=FVUyYCo5n44JCYp9DRufAtb0RJUQQGnJB-O13wOrkTc,43
@@ -114,8 +114,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/en.html.jinja,sha25
 mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha256=e_DPZvMvaaJm0QyjTxW8SkBEbhMXBgBiMrLJ1osAwZc,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-2.0.8.dist-info/METADATA,sha256=_ezNto6WXVYExo2_C15cB4C-wc52RCK9Q-yePs2qemE,12384
-mkdocstrings_python-2.0.8.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
-mkdocstrings_python-2.0.8.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-2.0.8.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-2.0.8.dist-info/RECORD,,
+mkdocstrings_python-2.0.9.dist-info/METADATA,sha256=IbDDrOkyvhr8fjNyc7E1bo5-_ruUIZJRgTLG_kZaI4s,12384
+mkdocstrings_python-2.0.9.dist-info/WHEEL,sha256=Y8xFLOH-FrS4gLE6ON4ti06sl2W_9QUDiRaTK3tfwig,91
+mkdocstrings_python-2.0.9.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-2.0.9.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-2.0.9.dist-info/RECORD,,

{mkdocstrings_python-2.0.8.dist-info → mkdocstrings_python-2.0.9.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.9)
+Generator: pdm-backend (2.4.10)
 Root-Is-Purelib: true
 Tag: py3-none-any