mkdocstrings-python 2.0.5__tar.gz → 2.0.7__tar.gz

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/CHANGELOG.md

@@ -5,6 +5,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [2.0.7](https://github.com/mkdocstrings/python/releases/tag/2.0.7) - 2026-08-17
+
+<small>[Compare with 2.0.6](https://github.com/mkdocstrings/python/compare/2.0.6...2.0.7)</small>
+
+### Bug Fixes
+
+- Don't render environment paths in source block labels ([84ba73e](https://github.com/mkdocstrings/python/commit/84ba73e8ca4e54afd29a4fe67b8bfb022e76c794) by Chris Wilson). [Issue-333](https://github.com/mkdocstrings/python/issues/333), [PR-338](https://github.com/mkdocstrings/python/pull/338)
+
+## [2.0.6](https://github.com/mkdocstrings/python/releases/tag/2.0.6) - 2026-08-16
+
+<small>[Compare with 2.0.5](https://github.com/mkdocstrings/python/compare/2.0.5...2.0.6)</small>
+
+### Bug Fixes
+
+- Don't pass unsupported options to Griffe parsers ([4b38b6b](https://github.com/mkdocstrings/python/commit/4b38b6ba6c3d1e09339cd5eb2c43145be84bda66) by Timothée Mazzucotelli). [Issue-337](https://github.com/mkdocstrings/python/issues/337)
+- Increase stash key length from 1 to 2 ([6ff2749](https://github.com/mkdocstrings/python/commit/6ff274911441ffaace47dd822fd92a3cdac84e65) by Jonas Haag). [PR-336](https://github.com/mkdocstrings/python/pull/336)
+
 ## [2.0.5](https://github.com/mkdocstrings/python/releases/tag/2.0.5) - 2026-06-19
 
 <small>[Compare with 2.0.4](https://github.com/mkdocstrings/python/compare/2.0.4...2.0.5)</small>

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.5
+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
@@ -145,7 +145,7 @@ dependencies = [
 <a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=fe0e7bf2882d1c9c901a341c2502e1518466527a&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
@@ -157,17 +157,15 @@ dependencies = [
 <a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
 </p></div>
 
 
-*And 7 more private sponsor(s).*
+*And 4 more private sponsor(s).*
 
 <!-- sponsors-end -->

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/README.md

@@ -108,7 +108,7 @@ dependencies = [
 <a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=fe0e7bf2882d1c9c901a341c2502e1518466527a&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
@@ -120,17 +120,15 @@ dependencies = [
 <a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
 </p></div>
 
 
-*And 7 more private sponsor(s).*
+*And 4 more private sponsor(s).*
 
 <!-- sponsors-end -->

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "griffelib>=2.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "2.0.5"
+version = "2.0.7"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -103,18 +103,19 @@ maintain = [
     "yore>=0.3.3",
 ]
 ci = [
+    "beautifulsoup4>=4.12.3",
     "black>=25.1",
     "duty>=1.6",
-    "ruff>=0.4",
+    "griffe>=2.1",
+    "inline-snapshot>=0.25",
+    "mypy>=1.10",
     "pytest>=8.2",
     "pytest-cov>=5.0",
     "pytest-randomly>=3.15",
     "pytest-xdist>=3.6",
-    "beautifulsoup4>=4.12.3",
-    "inline-snapshot>=0.25",
-    "mypy>=1.10",
     "types-markdown>=3.6",
     "types-pyyaml>=6.0",
+    "ruff>=0.4",
 ]
 docs = [
     "markdown-callouts>=0.4",

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/scripts/griffe_extensions.py

@@ -23,9 +23,14 @@ class CustomFields(griffe.Extension):
         """Fetch descriptions from `Field` annotations."""
         if attr.docstring:
             return
+        annotation = attr.annotation
+        if not isinstance(annotation, griffe.ExprSubscript) or not isinstance(annotation.slice, griffe.ExprTuple):
+            return
         try:
-            field: griffe.ExprCall = attr.annotation.slice.elements[1]
-        except AttributeError:
+            field = annotation.slice.elements[1]
+        except IndexError:
+            return
+        if not isinstance(field, griffe.ExprCall):
             return
 
         if field.canonical_path == "mkdocstrings_handlers.python._internal.config._Field":

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/src/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_python-2.0.5 → mkdocstrings_python-2.0.7}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -3,13 +3,14 @@
 from __future__ import annotations
 
 import glob
+import inspect
 import os
 import posixpath
 import sys
 from contextlib import suppress
 from dataclasses import asdict
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, BinaryIO, ClassVar
+from typing import TYPE_CHECKING, Any, BinaryIO, Callable, ClassVar
 
 from griffe import (
     AliasResolutionError,
@@ -18,6 +19,10 @@ from griffe import (
     ModulesCollection,
     Parser,
     load_extensions,
+    parse_auto,
+    parse_google,
+    parse_numpy,
+    parse_sphinx,
     patch_loggers,
 )
 from mkdocs.exceptions import PluginError
@@ -54,6 +59,34 @@ _logger = get_logger(__name__)
 
 patch_loggers(get_logger)
 
+_PARSER_FUNCTIONS: dict[Parser, Callable] = {
+    Parser.auto: parse_auto,
+    Parser.google: parse_google,
+    Parser.numpy: parse_numpy,
+    Parser.sphinx: parse_sphinx,
+}
+
+
+def _filter_parser_options(parser: Parser | None, options: dict[str, Any] | None) -> dict[str, Any] | None:
+    """Filter options unsupported by the selected Griffe parser."""
+    if parser is None or options is None:
+        return options
+
+    accepted_options = set(inspect.signature(_PARSER_FUNCTIONS[parser]).parameters) - {"docstring"}
+    filtered_options = {}
+    for name, value in options.items():
+        if name in accepted_options:
+            if parser is Parser.auto and name == "per_style_options":
+                filtered_options[name] = {
+                    style: _filter_parser_options(Parser(style), style_options)
+                    for style, style_options in value.items()
+                }
+            else:
+                filtered_options[name] = value
+        else:
+            _logger.warning(f"Ignoring unsupported {parser.value} docstring parser option: {name}")
+    return filtered_options
+
 
 class PythonHandler(BaseHandler):
     """The Python handler class."""
@@ -195,7 +228,9 @@ class PythonHandler(BaseHandler):
 
         parser_name = options.docstring_style
         parser = parser_name and Parser(parser_name)
-        parser_options = options.docstring_options and asdict(options.docstring_options)
+        parser_options: dict[str, Any] | None = None
+        if options.docstring_options is not None:
+            parser_options = _filter_parser_options(parser, asdict(options.docstring_options))
 
         if unknown_module:
             extensions = self.normalize_extension_paths(options.extensions)
@@ -203,7 +238,7 @@ class PythonHandler(BaseHandler):
                 extensions=load_extensions(*extensions),
                 search_paths=self._paths,
                 docstring_parser=parser,
-                docstring_options=parser_options,
+                docstring_options=parser_options,  # type: ignore[arg-type]
                 modules_collection=self._modules_collection,
                 lines_collection=self._lines_collection,
                 allow_inspection=options.allow_inspection,
@@ -310,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_python-2.0.5 → mkdocstrings_python-2.0.7}/src/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
 
@@ -107,7 +108,7 @@ class _StashCrossRefFilter:
 
     @staticmethod
     def _gen_key(length: int) -> str:
-        return "_" + "".join(random.choice(string.ascii_letters + string.digits) for _ in range(max(1, length - 1)))  # noqa: S311
+        return "_" + "".join(random.choice(string.ascii_letters + string.digits) for _ in range(max(2, length - 1)))  # noqa: S311
 
     def _gen_stash_key(self, length: int) -> str:
         key = self._gen_key(length)
@@ -420,22 +421,20 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
 
 
 def _parents(obj: Alias) -> set[str]:
-    parent: Object | Alias = obj.parent
-    parents = {obj.path, parent.path}
-    if parent.is_alias:
-        parents.add(parent.final_target.path)
-    while parent.parent:
-        parent = parent.parent
+    parents = {obj.path}
+    parent = obj.parent
+    while parent is not None:
         parents.add(parent.path)
-        if parent.is_alias:
+        if isinstance(parent, Alias):
             parents.add(parent.final_target.path)
+        parent = parent.parent
     return parents
 
 
 def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
     suppress_errors = suppress(AliasResolutionError, CyclicAliasError)
     for obj in objects:
-        if obj.is_alias:
+        if isinstance(obj, Alias):
             with suppress_errors:
                 if obj.final_target.path in _parents(obj):
                     continue
@@ -592,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
@@ -784,6 +807,8 @@ class AutorefsHook(AutorefsHookInterface):
             obj = self.current_object
             while identifier and identifier[0] == ".":
                 identifier = identifier[1:]
+                if obj.parent is None:
+                    break
                 obj = obj.parent
             identifier = f"{obj.path}.{identifier}" if identifier else obj.path
 
@@ -814,12 +839,13 @@ class AutorefsHook(AutorefsHookInterface):
             "module": "mod",
         }.get(self.current_object.kind.value.lower(), "obj")
         origin = self.current_object.path
-        try:
-            filepath = self.current_object.docstring.parent.filepath
-            lineno = self.current_object.docstring.lineno or 0
-        except AttributeError:
+        docstring = self.current_object.docstring
+        if docstring is None or docstring.parent is None:
             filepath = self.current_object.filepath
             lineno = 0
+        else:
+            filepath = docstring.parent.filepath
+            lineno = docstring.lineno or 0
 
         return AutorefsHookInterface.Context(
             domain="py",

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/src/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_python-2.0.5 → mkdocstrings_python-2.0.7}/src/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_python-2.0.5 → mkdocstrings_python-2.0.7}/src/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.5 → mkdocstrings_python-2.0.7}/tests/test_api.py

@@ -36,7 +36,7 @@ def _fixture_public_api(loader: griffe.GriffeLoader) -> griffe.Module:
 
 
 def _yield_public_objects(
-    obj: griffe.Module | griffe.Class,
+    obj: griffe.Module | griffe.Class | griffe.Alias,
     *,
     modules: bool = False,
     modulelevel: bool = True,
@@ -48,6 +48,7 @@ def _yield_public_objects(
             if member.is_module:
                 if member.is_alias or not member.is_public:
                     continue
+                assert isinstance(member, griffe.Module)
                 if modules:
                     yield member
                 yield from _yield_public_objects(
@@ -62,6 +63,7 @@ def _yield_public_objects(
             else:
                 continue
             if member.is_class and not modulelevel:
+                assert isinstance(member, (griffe.Class, griffe.Alias))
                 yield from _yield_public_objects(
                     member,
                     modules=modules,

mkdocstrings_python-2.0.7/tests/test_config.py

@@ -0,0 +1,61 @@
+"""Tests for configuration options."""
+
+from __future__ import annotations
+
+import inspect
+from dataclasses import asdict, fields
+from typing import TYPE_CHECKING, Any
+
+import pytest
+from griffe import Parser, parse_google, parse_numpy, parse_sphinx
+
+from mkdocstrings_handlers.python import AutoStyleOptions, GoogleStyleOptions, NumpyStyleOptions, SphinxStyleOptions
+from mkdocstrings_handlers.python._internal.handler import _filter_parser_options
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+@pytest.mark.parametrize(
+    ("options_class", "parser"),
+    [
+        (GoogleStyleOptions, parse_google),
+        (NumpyStyleOptions, parse_numpy),
+        (SphinxStyleOptions, parse_sphinx),
+    ],
+)
+def test_style_options_match_griffe_parser(options_class: type[Any], parser: Callable[..., object]) -> None:
+    """Ensure style options stay in sync with Griffe parser options."""
+    option_names = {field.name for field in fields(options_class)}
+    parser_parameters = inspect.signature(parser).parameters
+    parser_option_names = set(parser_parameters) - {"docstring"}
+
+    assert parser_option_names <= option_names
+
+
+def test_filter_style_options(caplog: pytest.LogCaptureFixture) -> None:
+    """Ensure unsupported options are not passed to Griffe and are reported."""
+    options = asdict(SphinxStyleOptions())
+
+    filtered_options = _filter_parser_options(Parser.sphinx, options)
+
+    assert filtered_options == {
+        name: value for name, value in options.items() if name in inspect.signature(parse_sphinx).parameters
+    }
+    assert "warn_missing_types" in options
+    for name in set(options) - set(filtered_options or {}):
+        assert f"Ignoring unsupported sphinx docstring parser option: {name}" in caplog.text
+
+
+def test_filter_auto_style_options(caplog: pytest.LogCaptureFixture) -> None:
+    """Ensure unsupported options nested in auto style options are reported."""
+    options = asdict(AutoStyleOptions())
+
+    filtered_options = _filter_parser_options(Parser.auto, options)
+
+    assert filtered_options is not None
+    if "warn_missing_types" in inspect.signature(parse_sphinx).parameters:
+        assert "warn_missing_types" in filtered_options["per_style_options"]["sphinx"]
+    else:
+        assert "warn_missing_types" not in filtered_options["per_style_options"]["sphinx"]
+        assert "Ignoring unsupported sphinx docstring parser option: warn_missing_types" in caplog.text

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/tests/test_handler.py

@@ -11,6 +11,7 @@ from pathlib import Path
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
+import bs4
 import mkdocstrings
 import pytest
 from griffe import (
@@ -333,3 +334,77 @@ def test_specifying_inventory_base_url(handler: PythonHandler) -> None:
     # Assert the URL is based on the provided base URL
     msg = "Expected inventory URL to start with base_url"
     assert item_url.startswith(base_url), msg
+
+
+def _source_labels(html: str) -> list[Path]:
+    soup = bs4.BeautifulSoup(html, features="html.parser")
+    labels = []
+    for summary in soup.find_all("summary"):
+        if "Source code in" in summary.get_text():
+            code_tag = summary.find("code")
+            assert code_tag is not None
+            labels.append(Path(code_tag.get_text(strip=True)))
+    return labels
+
+
+def _write_site_packages_package(tmp_path: Path, *, single_module: bool) -> None:
+    """Lay out the issue-333 scenario: a package installed in a virtual environment inside the project.
+
+    The environment's `site-packages` directory is relative to the current
+    working directory, so the package's `relative_filepath` is relative too,
+    slipping past `is_absolute()` checks.
+    """
+    code = """
+    class Model:
+        '''Model docstring.'''
+
+        def __init__(self) -> None:
+            '''Init docstring.'''
+            self.model_attribute = 0
+
+        def method(self) -> None:
+            '''Method docstring.'''
+    """
+    site = tmp_path / "site-packages"
+    module_path = site / "pkg.py" if single_module else site / "pkg" / "__init__.py"
+    module_path.parent.mkdir(parents=True)
+    module_path.write_text(dedent(code), encoding="utf-8")
+
+
+@pytest.mark.parametrize(
+    "handler",
+    [
+        {"theme": "readthedocs"},
+        {"theme": {"name": "material"}},
+    ],
+    indirect=["handler"],
+)
+@pytest.mark.parametrize(
+    ("single_module", "extra_options", "expected_label"),
+    [
+        pytest.param(False, {"merge_init_into_class": True}, Path("pkg", "__init__.py"), id="merged-init"),
+        pytest.param(False, {}, Path("pkg", "__init__.py"), id="class-and-methods"),
+        pytest.param(True, {"merge_init_into_class": True}, Path("pkg.py"), id="single-module"),
+    ],
+)
+def test_no_environment_path_in_source_labels(
+    *,
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+    handler: PythonHandler,
+    single_module: bool,
+    extra_options: dict,
+    expected_label: Path,
+) -> None:
+    """Assert source labels never show an environment path."""
+    _write_site_packages_package(tmp_path, single_module=single_module)
+    monkeypatch.chdir(tmp_path)
+    # `collect()` reads the search paths lazily from this attribute.
+    handler._paths = [str(tmp_path / "site-packages")]
+    options = handler.get_options({"show_source": True, **extra_options})
+    html = handler.render(handler.collect("pkg.Model", options), options)
+    labels = _source_labels(html)
+    assert labels
+    assert set(labels) == {expected_label}
+    # The source bodies themselves are still rendered.
+    assert "model_attribute" in html

{mkdocstrings_python-2.0.5 → mkdocstrings_python-2.0.7}/tests/test_rendering.py

@@ -4,10 +4,10 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, cast
 
 import pytest
-from griffe import ModulesCollection, temporary_visited_module
+from griffe import Alias, ModulesCollection, Object, temporary_visited_module
 
 from mkdocstrings_handlers.python._internal import rendering
 
@@ -78,7 +78,7 @@ def test_filter_objects(names: list[str], filter_params: dict[str, Any], expecte
         expected_names: Names expected to be kept.
     """
     objects = {name: _FakeObject(name) for name in names}
-    filtered = rendering.do_filter_objects(objects, **filter_params)
+    filtered = rendering.do_filter_objects(cast("dict[str, Object | Alias]", objects), **filter_params)
     filtered_names = {obj.name for obj in filtered}
     assert set(filtered_names) == set(expected_names)