mkdocstrings-python 1.6.3__tar.gz → 1.7.1__tar.gz

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.6.3
+Version: 1.7.1
 Summary: A Python handler for mkdocstrings.
 Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
 License: ISC

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "mkdocstrings>=0.20",
     "griffe>=0.35",
 ]
-version = "1.6.3"
+version = "1.7.1"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/handler.py

@@ -109,6 +109,7 @@ class PythonHandler(BaseHandler):
         "annotations_path": "brief",
         "preload_modules": None,
         "allow_inspection": True,
+        "unwrap_annotated": False,
     }
     """
     Attributes: General options:
@@ -180,6 +181,7 @@ class PythonHandler(BaseHandler):
         signature_crossrefs (bool): Whether to render cross-references for type annotations in signatures. Default: `False`.
         separate_signature (bool): Whether to put the whole signature in a code block below the heading.
             If Black is installed, the signature is also formatted using it. Default: `False`.
+        unwrap_annotated (bool): Whether to unwrap `Annotated` types to show only the type without the annotations. Default: `False`.
     """
 
     def __init__(

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/class.html

@@ -26,8 +26,8 @@
       {% block heading scoped %}
         {% if config.separate_signature %}
           <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__"] %}
+        {% elif config.merge_init_into_class and "__init__" in class.all_members %}
+          {% with function = class.all_members["__init__"] %}
             {%+ filter highlight(language="python", inline=True) %}
               {{ class_name }}{% include "signature.html" with context %}
             {% endfilter %}
@@ -47,8 +47,8 @@
 
     {% block signature scoped %}
       {% if config.separate_signature and config.merge_init_into_class %}
-        {% if "__init__" in class.members %}
-          {% with function = class.members["__init__"] %}
+        {% if "__init__" in class.all_members %}
+          {% with function = class.all_members["__init__"] %}
             {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
               {{ class.name }}
             {% endfilter %}
@@ -86,8 +86,8 @@
           {% include "docstring.html" with context %}
         {% endwith %}
         {% if config.merge_init_into_class %}
-          {% if "__init__" in class.members and class.members["__init__"].has_docstring %}
-            {% with docstring_sections = class.members["__init__"].docstring.parsed %}
+          {% if "__init__" in class.all_members and class.all_members["__init__"].has_docstring %}
+            {% with docstring_sections = class.all_members["__init__"].docstring.parsed %}
               {% include "docstring.html" with context %}
             {% endwith %}
           {% endif %}
@@ -97,10 +97,10 @@
       {% block source scoped %}
         {% if config.show_source %}
           {% if config.merge_init_into_class %}
-            {% if "__init__" in class.members and class.members["__init__"].source %}
+            {% if "__init__" in class.all_members and class.all_members["__init__"].source %}
               <details class="quote">
                 <summary>Source code in <code>{{ class.relative_filepath }}</code></summary>
-                {{ class.members["__init__"].source|highlight(language="python", linestart=class.members["__init__"].lineno, linenums=True) }}
+                {{ class.all_members["__init__"].source|highlight(language="python", linestart=class.all_members["__init__"].lineno, linenums=True) }}
               </details>
             {% endif %}
           {% elif class.source %}

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html

@@ -25,6 +25,8 @@
     {%- if signature -%}{{ expression|safe }}{%- else -%}{{ expression }}{%- endif -%}
   {%- elif expression.classname == "ExprName" -%}
     {{ crossref(expression, annotations_path) }}
+  {%- elif config.unwrap_annotated and expression.classname == "ExprSubscript" and expression.canonical_path in ("typing.Annotated", "typing_extensions.Annotated") -%}
+    {{ render(expression.slice.elements[0], annotations_path) }}
   {%- elif expression.classname == "ExprAttribute" -%}
     {%- if annotations_path == "brief" -%}
       {{ render(expression.last, "brief") }}

{mkdocstrings_python-1.6.3 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html

@@ -11,10 +11,6 @@
         )
     -%}
 
-    {%- if config.show_signature_annotations -%}
-      {%- set ns.equal = " = " -%}
-    {%- endif -%}
-
     (
       {%- for parameter in function.parameters -%}
         {%- if parameter.name not in ("self", "cls") or loop.index0 > 0 or not (function.parent and function.parent.is_class) -%}
@@ -31,6 +27,7 @@
           {%- endif -%}
 
           {%- if config.show_signature_annotations and parameter.annotation is not none -%}
+            {%- set ns.equal = " = " -%}
             {%- if config.separate_signature and config.signature_crossrefs -%}
               {%- with expression = parameter.annotation -%}
                 {%- set ns.annotation -%}: {% include "expression.html" with context %}{%- endset -%}
@@ -38,6 +35,9 @@
             {%- else -%}
               {%- set ns.annotation = ": " + parameter.annotation|safe -%}
             {%- endif -%}
+          {%- else -%}
+            {%- set ns.equal = "=" -%}
+            {%- set ns.annotation = "" -%}
           {%- endif -%}
 
           {%- if parameter.default is not none and parameter.kind.value != "variadic positional" and parameter.kind.value != "variadic keyword" -%}