mkdocstrings-python 1.5.0__tar.gz → 1.5.2__tar.gz

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.5.0
+Version: 1.5.2
 Summary: A Python handler for mkdocstrings.
 Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
 License: ISC
@@ -29,7 +29,7 @@ Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.8
 Requires-Dist: mkdocstrings>=0.20
-Requires-Dist: griffe>=0.33
+Requires-Dist: griffe>=0.35
 Description-Content-Type: text/markdown
 
 <h1 align="center">mkdocstrings-python</h1>

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/pyproject.toml

@@ -33,9 +33,9 @@ classifiers = [
 ]
 dependencies = [
     "mkdocstrings>=0.20",
-    "griffe>=0.33",
+    "griffe>=0.35",
 ]
-version = "1.5.0"
+version = "1.5.2"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/handler.py

@@ -357,11 +357,17 @@ class PythonHandler(BaseHandler):
         self.env.filters["get_template"] = rendering.do_get_template
         self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()
 
-    def get_anchors(self, data: CollectorItem) -> set[str]:  # noqa: D102 (ignore missing docstring)
+    def get_anchors(self, data: CollectorItem) -> tuple[str, ...]:  # noqa: D102 (ignore missing docstring)
+        anchors = [data.path]
         try:
-            return {data.path, data.canonical_path, *data.aliases}
+            if data.canonical_path != data.path:
+                anchors.append(data.canonical_path)
+            for anchor in data.aliases:
+                if anchor not in anchors:
+                    anchors.append(anchor)
         except AliasResolutionError:
-            return {data.path}
+            return tuple(anchors)
+        return tuple(anchors)
 
 
 def get_handler(

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html

@@ -13,6 +13,8 @@
     {% set show_full_path = config.show_object_full_path %}
   {% endif %}
 
+  {% set attribute_name = attribute.path if show_full_path else attribute.name %}
+
   {% if not root or config.show_root_heading %}
 
     {% filter heading(heading_level,
@@ -23,11 +25,10 @@
 
       {% block heading scoped %}
         {% if config.separate_signature %}
-          <span class="doc doc-object-name doc-attribute-name">{% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}</span>
+          <span class="doc doc-object-name doc-attribute-name">{{ attribute_name }}</span>
         {% else %}
-          {% filter highlight(language="python", inline=True) %}
-            {% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}
-            {% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
+          {%+ filter highlight(language="python", inline=True) %}
+            {{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
             {% if attribute.value %} = {{ attribute.value }}{% endif %}
           {% endfilter %}
         {% endif %}
@@ -45,8 +46,7 @@
       {% if config.separate_signature %}
         {% filter highlight(language="python", inline=False) %}
           {% filter format_code(config.line_length) %}
-            {% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}
-            {% if attribute.annotation %}: {{ attribute.annotation|safe }}{% endif %}
+            {{ attribute.name }}{% if attribute.annotation %}: {{ attribute.annotation|safe }}{% endif %}
             {% if attribute.value %} = {{ attribute.value|safe }}{% endif %}
           {% endfilter %}
         {% endfilter %}
@@ -58,7 +58,7 @@
       {% filter heading(heading_level,
           role="data" if attribute.parent.kind.value == "module" else "attr",
           id=html_id,
-          toc_label=attribute.path if config.show_root_full_path else attribute.name,
+          toc_label=attribute.name,
           hidden=True) %}
       {% endfilter %}
     {% endif %}

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/templates/material/_base/children.html

@@ -31,7 +31,7 @@
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
-                {% if not attribute.is_alias or attribute.is_explicitely_exported or attribute.inherited %}
+                {% if members_list is not none or attribute.is_public(check_name=False) %}
                   {% include attribute|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -51,7 +51,7 @@
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
-                {% if not class.is_alias or class.is_explicitely_exported or class.inherited %}
+                {% if members_list is not none or class.is_public(check_name=False) %}
                   {% include class|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -72,7 +72,7 @@
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}
                 {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
-                  {% if not function.is_alias or function.is_explicitely_exported or function.inherited %}
+                  {% if members_list is not none or function.is_public(check_name=False) %}
                     {% include function|get_template with context %}
                   {% endif %}
                 {% endif %}
@@ -93,8 +93,8 @@
                 {% filter heading(heading_level, id=html_id ~ "-modules") %}Modules{% endfilter %}
               {% endif %}
               {% with heading_level = heading_level + extra_level %}
-                {% for module in modules|order_members(config.members_order, members_list) %}
-                  {% if not module.is_alias or module.is_explicitely_exported or module.inherited %}
+                {% for module in modules|order_members(config.members_order.alphabetical, members_list) %}
+                  {% if members_list is not none or module.is_public(check_name=False) %}
                     {% include module|get_template with context %}
                   {% endif %}
                 {% endfor %}
@@ -119,7 +119,7 @@
 
         {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
 
-          {% if not child.is_alias or child.is_explicitely_exported or child.inherited %}
+          {% if members_list is not none or child.is_public(check_name=False) %}
             {% if child.is_attribute %}
               {% with attribute = child %}
                 {% include attribute|get_template with context %}

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/templates/material/_base/class.html

@@ -13,6 +13,8 @@
     {% set show_full_path = config.show_object_full_path %}
   {% endif %}
 
+  {% set class_name = class.path if show_full_path else class.name %}
+
   {% if not root or config.show_root_heading %}
 
     {% filter heading(heading_level,
@@ -23,16 +25,15 @@
 
       {% block heading scoped %}
         {% if config.separate_signature %}
-          <span class="doc doc-object-name doc-class-name">{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}</span>
-        {% elif config.merge_init_into_class and "__init__" in class.members -%}
-          {%- with function = class.members["__init__"] -%}
-            {%- filter highlight(language="python", inline=True) -%}
-              {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
-              {%- include "signature.html" with context -%}
-            {%- endfilter -%}
-          {%- endwith -%}
+          <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
+        {% elif config.merge_init_into_class and "__init__" in class.members %}
+          {% with function = class.members["__init__"] %}
+            {%+ filter highlight(language="python", inline=True) %}
+              {{ class_name }}{% include "signature.html" with context %}
+            {% endfilter %}
+          {% endwith %}
         {% else %}
-          <code>{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}</code>
+          <code>{{ class_name }}</code>
         {% endif %}
       {% endblock heading %}
 
@@ -49,7 +50,7 @@
         {% if "__init__" in class.members %}
           {% with function = class.members["__init__"] %}
             {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
-              {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
+              {{ class.name }}
             {% endfilter %}
           {% endwith %}
         {% endif %}
@@ -61,7 +62,7 @@
       {% filter heading(heading_level,
           role="class",
           id=html_id,
-          toc_label=class.path if config.show_root_full_path else class.name,
+          toc_label=class.name,
           hidden=True) %}
       {% endfilter %}
     {% endif %}
@@ -112,11 +113,9 @@
       {% endblock source %}
 
       {% block children scoped %}
-        {% with obj = class %}
-          {% set root = False %}
-          {% set heading_level = heading_level + 1 %}
-          {% include "children.html" with context %}
-        {% endwith %}
+        {% set root = False %}
+        {% set heading_level = heading_level + 1 %}
+        {% include "children.html" with context %}
       {% endblock children %}
     {% endblock contents %}
   </div>

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/templates/material/_base/function.html

@@ -15,6 +15,8 @@
     {% set show_full_path = config.show_object_full_path %}
   {% endif %}
 
+  {% set function_name = function.path if show_full_path else function.name %}
+
   {% if not root or config.show_root_heading %}
 
     {% filter heading(heading_level,
@@ -25,11 +27,10 @@
 
       {% block heading scoped %}
         {% if config.separate_signature %}
-          <span class="doc doc-object-name doc-function-name">{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}</span>
+          <span class="doc doc-object-name doc-function-name">{{ function_name }}</span>
         {% else %}
-          {% filter highlight(language="python", inline=True) %}
-            {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
-            {% include "signature.html" with context %}
+          {%+ filter highlight(language="python", inline=True) %}
+            {{ function_name }}{% include "signature.html" with context %}
           {% endfilter %}
         {% endif %}
       {% endblock heading %}
@@ -45,7 +46,7 @@
     {% block signature scoped %}
       {% if config.separate_signature %}
         {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
-          {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
+          {{ function.name }}
         {% endfilter %}
       {% endif %}
     {% endblock signature %}
@@ -55,7 +56,7 @@
       {% filter heading(heading_level,
           role="function",
           id=html_id,
-          toc_label=function.path if config.show_root_full_path else function.name,
+          toc_label=function.name,
           hidden=True) %}
       {% endfilter %}
     {% endif %}

{mkdocstrings_python-1.5.0 → mkdocstrings_python-1.5.2}/src/mkdocstrings_handlers/python/templates/material/_base/module.html

@@ -13,6 +13,8 @@
     {% set show_full_path = config.show_object_full_path %}
   {% endif %}
 
+  {% set module_name = module.path if show_full_path else module.name %}
+
   {% if not root or config.show_root_heading %}
 
     {% filter heading(heading_level,
@@ -22,13 +24,11 @@
         toc_label=module.name) %}
 
       {% block heading scoped %}
-        {% with module_name = module.path if show_full_path else module.name %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
-          {% else %}
-            <code>{{ module_name }}</code>
-          {% endif %}
-        {% endwith %}
+        {% if config.separate_signature %}
+          <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
+        {% else %}
+          <code>{{ module_name }}</code>
+        {% endif %}
       {% endblock heading %}
 
       {% block labels scoped %}
@@ -44,7 +44,7 @@
       {% filter heading(heading_level,
           role="module",
           id=html_id,
-          toc_label=module.path if config.show_root_full_path else module.name,
+          toc_label=module.name,
           hidden=True) %}
       {% endfilter %}
     {% endif %}
@@ -60,11 +60,9 @@
       {% endblock docstring %}
 
       {% block children scoped %}
-        {% with obj = module %}
-          {% set root = False %}
-          {% set heading_level = heading_level + 1 %}
-          {% include "children.html" with context %}
-        {% endwith %}
+        {% set root = False %}
+        {% set heading_level = heading_level + 1 %}
+        {% include "children.html" with context %}
       {% endblock children %}
     {% endblock contents %}
   </div>