mkdocstrings-python 1.6.3__py3-none-any.whl → 1.7.1__py3-none-any.whl

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_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_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_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" -%}

{mkdocstrings_python-1.6.3.dist-info → mkdocstrings_python-1.7.1.dist-info}/METADATA

@@ -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.dist-info → mkdocstrings_python-1.7.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 mkdocstrings_handlers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/__init__.py,sha256=CJT3hmg9HpEMy5dbq2jL3Y8unO6UOHND7yCLojwQrS8,326
-mkdocstrings_handlers/python/handler.py,sha256=DBYtXwFGSDUkfllF4j07LsBzha-w1fmflXs7bIKMcLA,20180
+mkdocstrings_handlers/python/handler.py,sha256=HjHHYUiCzk9zxrIUmZwo6yM-_mjR0C-lvQz6-NLmSe4,20349
 mkdocstrings_handlers/python/rendering.py,sha256=pBpsM_zxGGlp-xmCNZRcOOkQppyQFPev5b1exmtJSW0,11551
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=1nLfAEyZiD3DF9R7nyEb69cIM5oFp1MA-Zl7SJwuVts,2539
 mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=8z5dQ2HOywV7CQ3KYYgdBX8N-CGbnYZ8Sm7ugN89IIo,5709
-mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=OQATi6Zz0Vg34ONWwh6mimGdeHd2s0VqxulyrLMMzq8,4479
+mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=T1i4f82Gtx9Yyf7cvhxiZ2s1ipLnZ0tli_sXnmkRBSc,4523
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=Sw8TwJy4aTZA2phqqg61QVAZDfLYJAzgE_lQmDcdUsU,2163
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=wiD2FtMnGrFMZJDilURnNqzIu8bOR0zcMErUVUqbDPo,274
 mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=hpGB3CKuD44C4utJxKfA4V-uqQCVnV4fVRkjwGMrcdU,2840
@@ -19,14 +19,14 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sh
 mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=GACKAuJKUjAu3mUts_GJnQ31VZt04wxznMQNdHbDeAI,3479
 mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=FROLXo9Xd97TlpokL0YZC1kZ08QRL5bIm8_QnFtrBNQ,2453
 mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=3aBn3F8wO6ptxWQzMHyykrX8r4_rn2ezfhE7IZUO1Uw,3444
-mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=lfvgET2b8dxvqYZJqiGjS-ooO_nNXqV42zsL8yL05_s,1845
+mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=sDcvcJiqWSpSXyX_gr7kY7zetlIAi9IzLPK0RN4rOgo,2078
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=7f_RhIvsWa9KNDrg5Dgj8XX0_ltAv629EybAX-yQ2p0,2787
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=QMO1lrs1smktTGvkDZabvJZFQpMp_nSoM8JBt-tAcu8,250
 mkdocstrings_handlers/python/templates/material/_base/languages/en.html,sha256=u0j9TIPh18qHEI4bzlGlwu4IX95EPIi0Q3AaDi6D58I,966
 mkdocstrings_handlers/python/templates/material/_base/languages/ja.html,sha256=Az63fFTq4MIr65DjufCh8GYujB0-CiAJFDVVW9mCGtQ,984
 mkdocstrings_handlers/python/templates/material/_base/languages/zh.html,sha256=oPB3-fnOdmdGdrnRZUgXw6zuQGlF-aq5Bbkm1zF4xgA,902
 mkdocstrings_handlers/python/templates/material/_base/module.html,sha256=OrQb5_CfpQno9TJeVkHdz0Dp_DrXXKFW7sVRflsw-mI,2085
-mkdocstrings_handlers/python/templates/material/_base/signature.html,sha256=tW7V8nc1Ojan0BrehKDeN4irmRivR0Kfv0C8fPzyhuw,2790
+mkdocstrings_handlers/python/templates/material/_base/signature.html,sha256=aXGcPXowRwAc__-OQYBuNYT45trt7BZIxlp-64-WRrM,2833
 mkdocstrings_handlers/python/templates/material/attribute.html,sha256=Zbo0SMrqjdlUhXunXpy_VENWITviBDLt8UBdF5EnVb0,37
 mkdocstrings_handlers/python/templates/material/children.html,sha256=xLnVaXevA0HRffVdOK0INULbekvbOYV9vKQ_zXBLyK0,36
 mkdocstrings_handlers/python/templates/material/class.html,sha256=BGYm-uj8AEDiUZtNxr6ji7I1xFrlAiyOB7cOwM7gzEM,33
@@ -67,7 +67,7 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/en.html,sha256=bhfj
 mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html,sha256=ULdcRwrN9rF8shxFVwEZ1jqSICebVKMi8cYHpNZypd8,372
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=ZYm9N33cRC4Z66-ZqmteWDfRNfo8hKe25Bz4ijVk22A,359
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
-mkdocstrings_python-1.6.3.dist-info/METADATA,sha256=z0xXCzKJz7OiEMLn7m7S7wD_p90XMZrn6OUoOoZdXjQ,5748
-mkdocstrings_python-1.6.3.dist-info/WHEEL,sha256=1D4d-_ODszlK6-qFybc5BLF-ZhZvee-uKVh2hLa3IIc,90
-mkdocstrings_python-1.6.3.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.6.3.dist-info/RECORD,,
+mkdocstrings_python-1.7.1.dist-info/METADATA,sha256=-xUoZmk8lP5DyZLiop0byqpZmZBTiX6KrkVedc12pn8,5748
+mkdocstrings_python-1.7.1.dist-info/WHEEL,sha256=1D4d-_ODszlK6-qFybc5BLF-ZhZvee-uKVh2hLa3IIc,90
+mkdocstrings_python-1.7.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.7.1.dist-info/RECORD,,