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

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,

mkdocstrings_handlers/python/_internal/rendering.py

@@ -107,7 +107,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 +420,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
@@ -784,6 +782,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 +814,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.dist-info → mkdocstrings_python-2.0.6.dist-info}/METADATA

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

@@ -2,8 +2,8 @@ mkdocstrings_handlers/python/__init__.py,sha256=Kxy1zA4JJy0aWxUa2_xl5PfYV2-mrBKJ
 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=8LET9phgBvHe-cpfo1OxqkAIFVK5dZzsYjTCWP3Ls6k,15641
-mkdocstrings_handlers/python/_internal/rendering.py,sha256=0IPOsGkTRice-jEx5frfNYf_0n5lpL5cqXSsBDQAy8s,28535
+mkdocstrings_handlers/python/_internal/handler.py,sha256=Wn_0S4pw511tfC0m24sfbSNiUDlScDiJqEMFgrITdS8,16972
+mkdocstrings_handlers/python/_internal/rendering.py,sha256=Nrkoi1FeRrsEGOUmiBuu13mm0LJXktQr3Zt2iTb3mQE,28564
 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
@@ -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.5.dist-info/METADATA,sha256=eKZN7KMANgICCuu-Hy66bF-r-Tbi5HaM5c9gwE58Fvs,12759
-mkdocstrings_python-2.0.5.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
-mkdocstrings_python-2.0.5.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-2.0.5.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-2.0.5.dist-info/RECORD,,
+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,,