mkdocstrings-python 2.0.6__py3-none-any.whl → 2.0.7__py3-none-any.whl

mkdocstrings_handlers/python/__init__.py

@@ -31,6 +31,7 @@ from mkdocstrings_handlers.python._internal.rendering import (
     do_format_type_alias,
     do_get_template,
     do_order_members,
+    do_source_location,
     do_split_path,
     do_stash_crossref,
 )
@@ -64,6 +65,7 @@ __all__ = [
     "do_format_type_alias",
     "do_get_template",
     "do_order_members",
+    "do_source_location",
     "do_split_path",
     "do_stash_crossref",
     "get_handler",

mkdocstrings_handlers/python/_internal/handler.py

@@ -345,6 +345,7 @@ class PythonHandler(BaseHandler):
         self.env.filters["filter_objects"] = rendering.do_filter_objects
         self.env.filters["stash_crossref"] = rendering.do_stash_crossref
         self.env.filters["get_template"] = rendering.do_get_template
+        self.env.filters["source_location"] = rendering.do_source_location
         self.env.filters["as_attributes_section"] = rendering.do_as_attributes_section
         self.env.filters["as_functions_section"] = rendering.do_as_functions_section
         self.env.filters["as_classes_section"] = rendering.do_as_classes_section

mkdocstrings_handlers/python/_internal/rendering.py

@@ -11,6 +11,7 @@ from collections import defaultdict
 from contextlib import suppress
 from dataclasses import replace
 from functools import lru_cache
+from pathlib import Path
 from re import Pattern
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Literal, TypeVar
 
@@ -590,6 +591,30 @@ def do_get_template(obj: Object | Alias) -> str:
     return f"{name}.html.jinja"
 
 
+def do_source_location(obj: Object | Alias) -> Path:
+    """Get the file path displayed in an object's source block label.
+
+    Environment paths are never displayed: when the object's file lives in
+    a `site-packages` directory (for example a virtual environment inside
+    the current working directory), the path below `site-packages` is
+    returned instead.
+
+    Parameters:
+        obj: A Griffe object.
+
+    Returns:
+        The file path to display.
+    """
+    relative_filepath = obj.relative_filepath
+    parts = relative_filepath.parts
+    if "site-packages" in parts:
+        anchor = len(parts) - 1 - parts[::-1].index("site-packages")
+        return Path(*parts[anchor + 1 :])
+    if relative_filepath.is_absolute():
+        return obj.relative_package_filepath
+    return relative_filepath
+
+
 @pass_context
 def do_as_attributes_section(
     context: Context,  # noqa: ARG001

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

@@ -249,26 +249,14 @@ Context:
               {% if "__init__" in all_members and all_members["__init__"].source %}
                 {% with init = all_members["__init__"] %}
                   <details class="mkdocstrings-source">
-                    <summary>{{ lang.t("Source code in") }} <code>
-                      {%- if init.relative_filepath.is_absolute() -%}
-                        {{ init.relative_package_filepath }}
-                      {%- else -%}
-                        {{ init.relative_filepath }}
-                      {%- endif -%}
-                    </code></summary>
+                    <summary>{{ lang.t("Source code in") }} <code>{{ init|source_location }}</code></summary>
                     {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
                   </details>
                 {% endwith %}
               {% endif %}
             {% elif class.source %}
               <details class="mkdocstrings-source">
-                <summary>{{ lang.t("Source code in") }} <code>
-                  {%- if class.relative_filepath.is_absolute() -%}
-                    {{ class.relative_package_filepath }}
-                  {%- else -%}
-                    {{ class.relative_filepath }}
-                  {%- endif -%}
-                </code></summary>
+                <summary>{{ lang.t("Source code in") }} <code>{{ class|source_location }}</code></summary>
                 {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
               </details>
             {% endif %}

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

@@ -146,13 +146,7 @@ Context:
           -#}
           {% if config.show_source and function.source %}
             <details class="mkdocstrings-source">
-              <summary>{{ lang.t("Source code in") }} <code>
-                {%- if function.relative_filepath.is_absolute() -%}
-                  {{ function.relative_package_filepath }}
-                {%- else -%}
-                  {{ function.relative_filepath }}
-                {%- endif -%}
-              </code></summary>
+              <summary>{{ lang.t("Source code in") }} <code>{{ function|source_location }}</code></summary>
               {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True) }}
             </details>
           {% endif %}

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

@@ -208,26 +208,14 @@ Context:
               {% if "__init__" in class.all_members and class.all_members["__init__"].source %}
                 {% with init = class.all_members["__init__"] %}
                   <details class="quote">
-                    <summary>Source code in <code>
-                      {%- if init.relative_filepath.is_absolute() -%}
-                        {{ init.relative_package_filepath }}
-                      {%- else -%}
-                        {{ init.relative_filepath }}
-                      {%- endif -%}
-                    </code></summary>
+                    <summary>Source code in <code>{{ init|source_location }}</code></summary>
                     {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
                   </details>
                 {% endwith %}
               {% endif %}
             {% elif class.source %}
               <details class="quote">
-                <summary>Source code in <code>
-                  {%- if class.relative_filepath.is_absolute() -%}
-                    {{ class.relative_package_filepath }}
-                  {%- else -%}
-                    {{ class.relative_filepath }}
-                  {%- endif -%}
-                </code></summary>
+                <summary>Source code in <code>{{ class|source_location }}</code></summary>
                 {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
               </details>
             {% endif %}

{mkdocstrings_python-2.0.6.dist-info → mkdocstrings_python-2.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.6
+Version: 2.0.7
 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.6.dist-info → mkdocstrings_python-2.0.7.dist-info}/RECORD

@@ -1,14 +1,14 @@
-mkdocstrings_handlers/python/__init__.py,sha256=Kxy1zA4JJy0aWxUa2_xl5PfYV2-mrBKJ9Re56dq3s94,1650
+mkdocstrings_handlers/python/__init__.py,sha256=nMq6EQFwlnoSHY5FZAS0Fpa-fnb_piBv0yGIW1x13EE,1700
 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=Wn_0S4pw511tfC0m24sfbSNiUDlScDiJqEMFgrITdS8,16972
-mkdocstrings_handlers/python/_internal/rendering.py,sha256=Nrkoi1FeRrsEGOUmiBuu13mm0LJXktQr3Zt2iTb3mQE,28564
+mkdocstrings_handlers/python/_internal/handler.py,sha256=iYVzWehbTd3vM6K0sJJ-Oqklezv6xsyv0S6SWdGklXo,17047
+mkdocstrings_handlers/python/_internal/rendering.py,sha256=3JnVhlZob-Py5aWu-wDN6nsgAMBtOhyvTSa989J_6rA,29399
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=ajtKaGxs9-VJzPNiXbQTYTO6ADq8Ck9M9x2BfXakG0g,4838
 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=Wo_g0ag5P7d3rolVRYxtJMIT2U1KC9h7rh8yQFcuprQ,12153
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=ZSDeKPYttMyTbZ9udURpJ4tGm2Nl7HOMaCJlVoG2wzs,11675
 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
@@ -26,7 +26,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.
 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=AljcQjr1e6laOEpp4LRPKjnQNkN99zcPISxbXeEqPf4,6239
+mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=rW-47bNjme32xUWXGmMm6e-eQRsqtjc3BxEQvFxwyL4,6017
 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
@@ -86,7 +86,7 @@ mkdocstrings_handlers/python/templates/material/type_alias.html.jinja,sha256=wQw
 mkdocstrings_handlers/python/templates/material/type_parameters.html,sha256=-YLk-DbKYz8wQqar6-KAvzyQHlb7jDtykpWqqqRRa88,49
 mkdocstrings_handlers/python/templates/material/type_parameters.html.jinja,sha256=-YLk-DbKYz8wQqar6-KAvzyQHlb7jDtykpWqqqRRa88,49
 mkdocstrings_handlers/python/templates/readthedocs/_base/class.html,sha256=x0M8Wjk7TC9cgnstMoukLVQvxZUEMFjQA0VJQPEAC9Y,415
-mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja,sha256=dWVevPMZKXJNY81VlQvO-g0jMh_CAbutloIjLikBpkI,9613
+mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja,sha256=XBJuYmH65zHBIL4SzylZ8jQKGgSzBXUfvdc3ySy2SHA,9135
 mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja,sha256=Bq7zsZqREC_VkZpbxS0gJlNG46FPyvaYZAJYAVUijPU,1535
 mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja,sha256=t6hWw_CvWQHfLO0EIggXImg4YBarC97HgXBGOLwdjc0,1580
 mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja,sha256=eQFg4aSUNpl8m7Cp_gQHbgsir2aV9nCDUroZWZ4seFQ,1873
@@ -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.6.dist-info/METADATA,sha256=JtU8hPL0qhB5_sEDYrWIiEZRGEABbc0NwWA3gGG65a8,12384
-mkdocstrings_python-2.0.6.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
-mkdocstrings_python-2.0.6.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-2.0.6.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-2.0.6.dist-info/RECORD,,
+mkdocstrings_python-2.0.7.dist-info/METADATA,sha256=x-BFx6xsNyyDXiBczY9WGADLEQF60QaOjKCkWT1ggwk,12384
+mkdocstrings_python-2.0.7.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
+mkdocstrings_python-2.0.7.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-2.0.7.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-2.0.7.dist-info/RECORD,,