mkdocstrings-python 2.0.2__tar.gz → 2.0.4__tar.gz

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/CHANGELOG.md

@@ -5,6 +5,22 @@ 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.4](https://github.com/mkdocstrings/python/releases/tag/2.0.4) - 2026-06-05
+
+<small>[Compare with 2.0.3](https://github.com/mkdocstrings/python/compare/2.0.3...2.0.4)</small>
+
+### Bug Fixes
+
+- Display Methods instead of Functions for category headings inside classes ([7bf8b98](https://github.com/mkdocstrings/python/commit/7bf8b98cc03e1cb3573e88aecaa3ebd60c7fa9ca) by Timothée Mazzucotelli). [Issue-330](https://github.com/mkdocstrings/python/issues/330)
+
+## [2.0.3](https://github.com/mkdocstrings/python/releases/tag/2.0.3) - 2026-02-20
+
+<small>[Compare with 2.0.2](https://github.com/mkdocstrings/python/compare/2.0.2...2.0.3)</small>
+
+### Build
+
+- Depend on griffelib instead of griffe ([770a5f6](https://github.com/mkdocstrings/python/commit/770a5f69d801f24f0b36d1e671a540196e06f710) by Timothée Mazzucotelli).
+
 ## [2.0.2](https://github.com/mkdocstrings/python/releases/tag/2.0.2) - 2026-02-09
 
 <small>[Compare with 2.0.1](https://github.com/mkdocstrings/python/compare/2.0.1...2.0.2)</small>

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.2
+Version: 2.0.4
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC
@@ -31,7 +31,7 @@ Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.10
 Requires-Dist: mkdocstrings>=0.30
 Requires-Dist: mkdocs-autorefs>=1.4
-Requires-Dist: griffe>=1.13
+Requires-Dist: griffelib>=2.0
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 
@@ -123,7 +123,6 @@ dependencies = [
 
 <div id="silver-sponsors"><b>Silver sponsors</b><p>
 <a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
-<a href="https://docs.pydantic.dev/latest/"><img alt="Pydantic" src="https://pydantic.dev/assets/for-external/pydantic_logfire_logo_endorsed_lithium_rgb.svg" style="height: 180px; "></a><br>
 </p></div>
 
 <div id="bronze-sponsors"><b>Bronze sponsors</b><p>

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/README.md

@@ -86,7 +86,6 @@ dependencies = [
 
 <div id="silver-sponsors"><b>Silver sponsors</b><p>
 <a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
-<a href="https://docs.pydantic.dev/latest/"><img alt="Pydantic" src="https://pydantic.dev/assets/for-external/pydantic_logfire_logo_endorsed_lithium_rgb.svg" style="height: 180px; "></a><br>
 </p></div>
 
 <div id="bronze-sponsors"><b>Bronze sponsors</b><p>

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/pyproject.toml

@@ -38,10 +38,10 @@ classifiers = [
 dependencies = [
     "mkdocstrings>=0.30",
     "mkdocs-autorefs>=1.4",
-    "griffe>=1.13",
+    "griffelib>=2.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "2.0.2"
+version = "2.0.4"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/scripts/gen_credits.py

@@ -55,7 +55,7 @@ def _extra_marker(req: Requirement) -> str | None:
     if not req.marker:
         return None
     try:
-        return next(marker[2].value for marker in req.marker._markers if getattr(marker[0], "value", None) == "extra")
+        return next(marker[2].value for marker in req.marker._markers if getattr(marker[0], "value", None) == "extra")  # type: ignore[union-attr]
     except StopIteration:
         return None
 

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/scripts/griffe_extensions.py

@@ -24,7 +24,7 @@ class CustomFields(griffe.Extension):
         if attr.docstring:
             return
         try:
-            field: griffe.ExprCall = attr.annotation.slice.elements[1]  # type: ignore[union-attr]
+            field: griffe.ExprCall = attr.annotation.slice.elements[1]
         except AttributeError:
             return
 

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -498,7 +498,7 @@ class PythonInputOptions:
             those added to `__all__` or not starting with an underscore (except for special methods/attributes).
             """,
         ),
-    ] = field(default_factory=lambda: _DEFAULT_FILTERS.copy())
+    ] = field(default_factory=_DEFAULT_FILTERS.copy)
 
     find_stubs_package: Annotated[
         bool,

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -203,7 +203,7 @@ class PythonHandler(BaseHandler):
                 extensions=load_extensions(*extensions),
                 search_paths=self._paths,
                 docstring_parser=parser,
-                docstring_options=parser_options,  # type: ignore[arg-type]
+                docstring_options=parser_options,
                 modules_collection=self._modules_collection,
                 lines_collection=self._lines_collection,
                 allow_inspection=options.allow_inspection,

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -414,15 +414,15 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
 
 
 def _parents(obj: Alias) -> set[str]:
-    parent: Object | Alias = obj.parent  # type: ignore[assignment]
+    parent: Object | Alias = obj.parent
     parents = {obj.path, parent.path}
     if parent.is_alias:
-        parents.add(parent.final_target.path)  # type: ignore[union-attr]
+        parents.add(parent.final_target.path)
     while parent.parent:
         parent = parent.parent
         parents.add(parent.path)
         if parent.is_alias:
-            parents.add(parent.final_target.path)  # type: ignore[union-attr]
+            parents.add(parent.final_target.path)
     return parents
 
 
@@ -431,7 +431,7 @@ def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
     for obj in objects:
         if obj.is_alias:
             with suppress_errors:
-                if obj.final_target.path in _parents(obj):  # type: ignore[arg-type,union-attr]
+                if obj.final_target.path in _parents(obj):
                     continue
         yield obj
 
@@ -778,7 +778,7 @@ class AutorefsHook(AutorefsHookInterface):
             obj = self.current_object
             while identifier and identifier[0] == ".":
                 identifier = identifier[1:]
-                obj = obj.parent  # type: ignore[assignment]
+                obj = obj.parent
             identifier = f"{obj.path}.{identifier}" if identifier else obj.path
 
         # We resolve the identifier to its full path.
@@ -809,8 +809,8 @@ class AutorefsHook(AutorefsHookInterface):
         }.get(self.current_object.kind.value.lower(), "obj")
         origin = self.current_object.path
         try:
-            filepath = self.current_object.docstring.parent.filepath  # type: ignore[union-attr]
-            lineno = self.current_object.docstring.lineno or 0  # type: ignore[union-attr]
+            filepath = self.current_object.docstring.parent.filepath
+            lineno = self.current_object.docstring.lineno or 0
         except AttributeError:
             filepath = self.current_object.filepath
             lineno = 0

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

@@ -108,7 +108,7 @@ Context:
           ) %}
           {% if functions %}
             {% if config.show_category_heading %}
-              {% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Functions") }}{% endfilter %}
+              {% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}{% endfilter %}
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/tests/test_api.py

@@ -51,7 +51,7 @@ def _yield_public_objects(
                 if modules:
                     yield member
                 yield from _yield_public_objects(
-                    member,  # type: ignore[arg-type]
+                    member,
                     modules=modules,
                     modulelevel=modulelevel,
                     inherited=inherited,
@@ -63,7 +63,7 @@ def _yield_public_objects(
                 continue
             if member.is_class and not modulelevel:
                 yield from _yield_public_objects(
-                    member,  # type: ignore[arg-type]
+                    member,
                     modules=modules,
                     modulelevel=False,
                     inherited=inherited,

{mkdocstrings_python-2.0.2 → mkdocstrings_python-2.0.4}/tests/test_rendering.py

@@ -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)  # type: ignore[arg-type]
+    filtered = rendering.do_filter_objects(objects, **filter_params)
     filtered_names = {obj.name for obj in filtered}
     assert set(filtered_names) == set(expected_names)