mkdocstrings-python 2.0.9__tar.gz → 2.0.10__tar.gz

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.10](https://github.com/mkdocstrings/python/releases/tag/2.0.10) - 2026-10-19
+
+<small>[Compare with 2.0.9](https://github.com/mkdocstrings/python/compare/2.0.9...2.0.10)</small>
+
+### Build
+
+- Drop support for Python 3.10 ([aad7fc6](https://github.com/mkdocstrings/python/commit/aad7fc6efd12f096807b466e5e3175e27fa7852d) by Timothée Mazzucotelli).
+
+### Bug Fixes
+
+- Prefix code anchor/span IDs in signatures to avoid collisions ([35cde4c](https://github.com/mkdocstrings/python/commit/35cde4c1163d2d8a8fd79b34ab574888bfd30ddf) by Timothée Mazzucotelli). [Issue-200](https://github.com/mkdocstrings/python/issues/200)
+
 ## [2.0.9](https://github.com/mkdocstrings/python/releases/tag/2.0.9) - 2026-09-22
 
 <small>[Compare with 2.0.8](https://github.com/mkdocstrings/python/compare/2.0.8...2.0.9)</small>

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.9
+Version: 2.0.10
 Summary: A Python handler for mkdocstrings.
-Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
 License-Expression: ISC
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
@@ -10,7 +10,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -28,8 +27,8 @@ Project-URL: Issues, https://github.com/mkdocstrings/python/issues
 Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
 Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
-Requires-Python: >=3.10
-Requires-Dist: mkdocstrings>=0.30
+Requires-Python: >=3.11
+Requires-Dist: mkdocstrings>=1.0.8
 Requires-Dist: mkdocs-autorefs>=1.4
 Requires-Dist: griffelib>=2.0
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/pyproject.toml

@@ -15,7 +15,7 @@ license-files = [
     "LICENSE",
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 keywords = []
 dynamic = []
 classifiers = [
@@ -24,7 +24,6 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -36,12 +35,12 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.30",
+    "mkdocstrings>=1.0.8",
     "mkdocs-autorefs>=1.4",
     "griffelib>=2.0",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "2.0.9"
+version = "2.0.10"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -130,5 +129,4 @@ docs = [
     "mkdocs-section-index>=0.3",
     "mkdocstrings>=0.29",
     "pydantic>=2.10",
-    "tomli>=2.0; python_version < '3.11'",
 ]

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/scripts/gen_credits.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-import sys
 from collections import defaultdict
 from collections.abc import Iterable
 from importlib.metadata import distributions
@@ -12,16 +11,11 @@ from pathlib import Path
 from textwrap import dedent
 from typing import Union
 
+import tomllib
 from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
 from packaging.requirements import Requirement
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    import tomllib
-else:
-    import tomli as tomllib
-
 project_dir = Path(os.getenv("MKDOCS_CONFIG_DIR", "."))
 with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
     pyproject = tomllib.load(pyproject_file)

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/scripts/make.py

@@ -14,7 +14,7 @@ if TYPE_CHECKING:
     from collections.abc import Iterator
 
 
-PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.10 3.11 3.12 3.13 3.14 3.15").split()
+PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.11 3.12 3.13 3.14 3.15").split()
 PYTHON_DEV = "3.15"
 
 

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -3,21 +3,13 @@
 from __future__ import annotations
 
 import re
-import sys
 from dataclasses import field, fields
-from typing import TYPE_CHECKING, Annotated, Any, Literal
+from typing import TYPE_CHECKING, Annotated, Any, Literal, Self
 
 from mkdocstrings import get_logger
 
 from mkdocstrings_handlers.python._internal.rendering import Order  # noqa: TC001
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
-
-
 _logger = get_logger(__name__)
 
 _DEFAULT_FILTERS = ["!^_[^_]"]

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -39,21 +39,7 @@ if TYPE_CHECKING:
     from mkdocs_autorefs import Backlink
 
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    from contextlib import chdir
-else:
-    from contextlib import contextmanager
-
-    @contextmanager
-    def chdir(path: str) -> Iterator[None]:
-        old_wd = os.getcwd()
-        os.chdir(path)
-        try:
-            yield
-        finally:
-            os.chdir(old_wd)
-
+from contextlib import chdir
 
 _logger = get_logger(__name__)
 

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

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

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

@@ -149,7 +149,7 @@ Context:
           {% if config.show_source and function.source %}
             <details class="mkdocstrings-source">
               <summary>{{ lang.t("Source code in") }} <code>{{ function|source_location }}</code></summary>
-              {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True) }}
+              {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
             </details>
           {% endif %}
         {% endblock source %}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja

@@ -209,14 +209,14 @@ Context:
                 {% with init = class.all_members["__init__"] %}
                   <details class="quote">
                     <summary>Source code in <code>{{ init|source_location }}</code></summary>
-                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
+                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
                   </details>
                 {% endwith %}
               {% endif %}
             {% elif class.source %}
               <details class="quote">
                 <summary>Source code in <code>{{ class|source_location }}</code></summary>
-                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
+                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
               </details>
             {% endif %}
           {% endif %}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.10}/tests/test_handler.py

@@ -21,6 +21,7 @@ from griffe import (
     DocstringSectionKind,
     Module,
     temporary_inspected_module,
+    temporary_pypackage,
     temporary_visited_module,
 )
 from mkdocstrings import CollectionError
@@ -28,6 +29,7 @@ from mkdocstrings import CollectionError
 from mkdocstrings_handlers.python import Inventory, PythonConfig, PythonHandler, PythonOptions
 
 if TYPE_CHECKING:
+    from markdown import Markdown
     from mkdocstrings import MkdocstringsPlugin
 
 
@@ -204,6 +206,130 @@ def test_rendering_object_source_without_lineno(handler: PythonHandler) -> None:
         assert handler.render(module, PythonOptions(show_source=True))
 
 
+@pytest.mark.parametrize(
+    ("handler", "merge_init_into_class"),
+    [
+        (
+            {
+                "theme": theme,
+                "markdown_extensions": [
+                    {
+                        "pymdownx.highlight": {
+                            "anchor_linenums": True,
+                            "line_spans": "custom-span",
+                            "line_anchors": "custom-line",
+                            "linenums_style": linenums_style,
+                        },
+                    },
+                    {"pymdownx.superfences": {}},
+                ],
+            },
+            merge_init_into_class,
+        )
+        for theme in ("material", "readthedocs", "mkdocs")
+        for linenums_style in ("table", "inline")
+        for merge_init_into_class in (True, False)
+    ],
+    indirect=["handler"],
+)
+def test_source_code_ids_are_unique(
+    handler: PythonHandler,
+    ext_markdown: Markdown,
+    merge_init_into_class: bool,
+) -> None:
+    """Keep source line IDs unique across modules, overlapping sources, and inherited methods."""
+    # Both modules put their source at the same line numbers. Class source also overlaps method source.
+    code = '''
+        class Base:
+            """Base class."""
+
+            def __init__(self):
+                """Initialize the base class."""
+                self.value = 1
+
+            def method(self):
+                """Return a value."""
+                return self.value
+
+        class Derived(Base):
+            """Derived class."""
+    '''
+    markdown = f"""
+::: source_ids.first
+    options:
+      show_source: true
+      inherited_members: true
+      merge_init_into_class: {str(merge_init_into_class).lower()}
+
+::: source_ids.second
+    options:
+      show_source: true
+      inherited_members: true
+      merge_init_into_class: {str(merge_init_into_class).lower()}
+"""
+    with temporary_pypackage("source_ids", {"first.py": code, "second.py": code}) as package:
+        handler._paths = [str(package.tmpdir)]
+
+        html = ext_markdown.convert(markdown)
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    source_blocks = soup.select("details.mkdocstrings-source, details.quote")
+    assert len(source_blocks) == (8 if merge_init_into_class else 12)
+
+    # Every source ID is unique, including methods repeated under Derived.
+    ids = [element["id"] for block in source_blocks for element in block.select("[id]")]
+    assert ids
+    assert len(ids) == len(set(ids))
+    assert all(
+        str(identifier).startswith("source_ids.") and "--source--custom-" in str(identifier) for identifier in ids
+    )
+
+    # Line-number links and legacy anchor names still point to IDs in their own source block.
+    for block in source_blocks:
+        block_ids = {element["id"] for element in block.select("[id]")}
+        links = block.select('a[href^="#"]')
+        assert links
+        assert all(str(link["href"])[1:] in block_ids for link in links)
+        assert all(anchor["name"] == anchor["id"] for anchor in block.select("a[name]"))
+
+
+@pytest.mark.parametrize(
+    "handler",
+    [
+        {
+            "markdown_extensions": [
+                {"pymdownx.highlight": {"anchor_linenums": True, "line_spans": "__span"}},
+                {"pymdownx.superfences": {}},
+            ],
+        },
+    ],
+    indirect=True,
+)
+def test_source_and_docstring_code_ids_do_not_collide(handler: PythonHandler) -> None:
+    """Keep source and docstring code IDs distinct."""
+    # Both the function's source and the fenced example start at line 1.
+    code = '''def function():
+    """An example.
+
+    ```python linenums="1"
+    print("example")
+    ```
+    """
+    return 1
+'''
+    with temporary_visited_module(code, module_name="code_ids") as module:
+        html = handler.render(module["function"], handler.get_options({"show_source": True}))
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    ids = [element["id"] for element in soup.select("[id]")]
+
+    assert len(ids) == len(set(ids))
+    assert "code_ids.function--__span-0-1" in ids
+    assert "code_ids.function--source--__span-0-1" in ids
+    assert "code_ids.function--__codelineno-0-1" in ids
+    assert "code_ids.function--source--__codelineno-0-1" in ids
+
+
 def test_give_precedence_to_user_paths() -> None:
     """Assert user paths take precedence over default paths."""
     last_sys_path = sys.path[-1]