mkdocstrings-python 1.10.4__tar.gz → 1.10.6__tar.gz

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.10.4
+Version: 1.10.6
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC
@@ -29,7 +29,7 @@ Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.8
 Requires-Dist: mkdocstrings>=0.25
-Requires-Dist: griffe>=0.47
+Requires-Dist: griffe>=0.48
 Description-Content-Type: text/markdown
 
 <h1 align="center">mkdocstrings-python</h1>

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/pyproject.toml

@@ -33,9 +33,9 @@ classifiers = [
 ]
 dependencies = [
     "mkdocstrings>=0.25",
-    "griffe>=0.47",
+    "griffe>=0.48",
 ]
-version = "1.10.4"
+version = "1.10.6"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/handler.py

@@ -12,12 +12,15 @@ from contextlib import suppress
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, BinaryIO, ClassVar, Iterator, Mapping, Sequence
 
-from griffe.collections import LinesCollection, ModulesCollection
-from griffe.docstrings.parsers import Parser
-from griffe.exceptions import AliasResolutionError
-from griffe.extensions import load_extensions
-from griffe.loader import GriffeLoader
-from griffe.logger import patch_loggers
+from griffe import (
+    AliasResolutionError,
+    GriffeLoader,
+    LinesCollection,
+    ModulesCollection,
+    Parser,
+    load_extensions,
+    patch_logger,
+)
 from mkdocstrings.extension import PluginError
 from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem
 from mkdocstrings.inventory import Inventory
@@ -47,7 +50,7 @@ else:
 
 logger = get_logger(__name__)
 
-patch_loggers(get_logger)
+patch_logger(get_logger)
 
 
 class PythonHandler(BaseHandler):
@@ -162,7 +165,7 @@ class PythonHandler(BaseHandler):
 
     Attributes: Docstrings options:
         docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`.
-        docstring_options (dict): The options for the docstring parser. See parsers under [`griffe.docstrings`][].
+        docstring_options (dict): The options for the docstring parser. See [docstring parsers](https://mkdocstrings.github.io/griffe/reference/docstrings/) and their options in Griffe docs.
         docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `"table"`.
         merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
         show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/rendering.py

@@ -12,19 +12,20 @@ from functools import lru_cache, partial
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, Match, Pattern, Sequence
 
-from griffe.dataclasses import Alias, Object
-from griffe.docstrings.dataclasses import (
+from griffe import (
+    Alias,
     DocstringSectionAttributes,
     DocstringSectionClasses,
     DocstringSectionFunctions,
     DocstringSectionModules,
+    Object,
 )
 from jinja2 import TemplateNotFound, pass_context, pass_environment
 from markupsafe import Markup
 from mkdocstrings.loggers import get_logger
 
 if TYPE_CHECKING:
-    from griffe.dataclasses import Attribute, Class, Function, Module
+    from griffe import Attribute, Class, Function, Module
     from jinja2 import Environment, Template
     from jinja2.runtime import Context
     from mkdocstrings.handlers.base import CollectorItem
@@ -364,11 +365,9 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
         if regex.search(name):
             keep = not exclude
     if keep is None:
-        if rules == {False}:
-            # only included stuff, no match = reject
-            return False
-        # only excluded stuff, or included and excluded stuff, no match = keep
-        return True
+        # When we only include stuff, no match = reject.
+        # When we only exclude stuff, or include and exclude stuff, no match = keep.
+        return rules != {False}
     return keep
 
 

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -4,7 +4,7 @@ This template renders a Python attribute (or variable).
 This can be a module attribute or a class attribute.
 
 Context:
-  attribute (griffe.dataclasses.Attribute): The attribute to render.
+  attribute (griffe.Attribute): The attribute to render.
   root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
   heading_level (int): The HTML heading level to use.
   config (dict): The configuration options.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/children.html.jinja

@@ -4,13 +4,13 @@ This template iterates on members of a given object and renders them.
 It can group members by category (attributes, classes, functions, modules) or render them in a flat list.
 
 Context:
-  obj (griffe.dataclasses.Object): The object to render.
+  obj (griffe.Object): The object to render.
   config (dict): The configuration options.
   root_members (bool): Whether the object is the root object.
   heading_level (int): The HTML heading level to use.
 -#}
 
-{% if obj.members %}
+{% if obj.all_members %}
   {% block logs scoped %}
     {#- Logging block.
     
@@ -49,7 +49,7 @@ Context:
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
-                {% if members_list is not none or not attribute.is_imported %}
+                {% if members_list is not none or (not attribute.is_imported or attribute.is_public) %}
                   {% include attribute|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -69,7 +69,7 @@ Context:
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
-                {% if members_list is not none or not class.is_imported %}
+                {% if members_list is not none or (not class.is_imported or class.is_public) %}
                   {% include class|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -90,7 +90,7 @@ Context:
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}
                 {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
-                  {% if members_list is not none or not function.is_imported %}
+                  {% if members_list is not none or (not function.is_imported or function.is_public) %}
                     {% include function|get_template with context %}
                   {% endif %}
                 {% endif %}
@@ -112,7 +112,7 @@ Context:
               {% endif %}
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members(config.members_order.alphabetical, members_list) %}
-                  {% if members_list is not none or not module.is_alias %}
+                  {% if members_list is not none or (not module.is_alias or module.is_public) %}
                     {% include module|get_template with context %}
                   {% endif %}
                 {% endfor %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja

@@ -3,7 +3,7 @@
 This template renders a Python class.
 
 Context:
-  class (griffe.dataclasses.Class): The class to render.
+  class (griffe.Class): The class to render.
   root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
   heading_level (int): The HTML heading level to use.
   config (dict): The configuration options.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja

@@ -3,7 +3,7 @@
 This template renders admonitions using the `details` HTML element.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAdmonition): The section to render.
+  section (griffe.DocstringSectionAdmonition): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented attributes in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented classes in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented examples.
 It alternates between rendering text and code examples.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented functions in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented modules in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented other parameters in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented parameters in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented exceptions in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented received values (generators) in the f
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented returned values in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented warnings in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented yielded values (generators) in the fo
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja

@@ -5,7 +5,7 @@ Griffe parses docstrings into a list of sections, each with a `kind` and a `valu
 This template can then iterate on these sections and render them according to the configuration.
 
 Context:
-  docstring_sections (list[griffe.docstrings.dataclasses.DocstringSection]): The list of docstring sections.
+  docstring_sections (list[griffe.DocstringSection]): The list of docstring sections.
   config (dict): The configuration dictionary.
   heading_level (int): The heading level to use for Markdown conversion.
   html_id (str): The HTML ID to use for Markdown conversion.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja

@@ -17,7 +17,7 @@ which is a tree-like structure representing a Python expression.
   This macro outputs a cross-reference to the given name.
 
   Parameters:
-      name (griffe.expressions.ExprName): The name to cross-reference.
+      name (griffe.ExprName): The name to cross-reference.
       annotation_path (str): Either "brief", "source", or "full".
 
   Returns:
@@ -48,7 +48,7 @@ which is a tree-like structure representing a Python expression.
   {#- Render an expression.
 
   Parameters:
-      expression (griffe.expressions.Expr): The expression to render.
+      expression (griffe.Expr): The expression to render.
       annotations_path (str): Either "brief", "source", or "full".
 
   Returns:

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

@@ -3,7 +3,7 @@
 This template renders a Python function or method.
 
 Context:
-  function (griffe.dataclasses.Function): The function to render.
+  function (griffe.Function): The function to render.
   root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
   heading_level (int): The HTML heading level to use.
   config (dict): The configuration options.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/module.html.jinja

@@ -3,7 +3,7 @@
 This template renders a Python module.
 
 Context:
-  module (griffe.dataclasses.Module): The module to render.
+  module (griffe.Module): The module to render.
   root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
   heading_level (int): The HTML heading level to use.
   config (dict): The configuration options.

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja

@@ -5,7 +5,7 @@ It iterates over the parameters of the function to rebuild the signature.
 The signature is the list of parameters of a function or method, including their names, default values, and annotations.
 
 Context:
-  function (griffe.dataclasses.Function): The function or method to render.
+  function (griffe.Function): The function or method to render.
   config (dict): The configuration options.
 -#}
 

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented attributes in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented other parameters in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented parameters in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented exceptions in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented received values (generators) in the f
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented returned values in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented warnings in the format
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}

{mkdocstrings_python-1.10.4 → mkdocstrings_python-1.10.6}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html.jinja

@@ -4,7 +4,7 @@ This template renders a list of documented yielded values (generators) in the fo
 specified with the [`docstring_section_style`][] configuration option.
 
 Context:
-  section (griffe.docstrings.dataclasses.DocstringSectionAttributes): The section to render.
+  section (griffe.DocstringSectionAttributes): The section to render.
 -#}
 
 {% block logs scoped %}