mkdocstrings-python 1.10.1__tar.gz → 1.10.3__tar.gz

{mkdocstrings_python-1.10.1 → mkdocstrings_python-1.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.10.1
+Version: 1.10.3
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC

{mkdocstrings_python-1.10.1 → mkdocstrings_python-1.10.3}/pyproject.toml

@@ -34,7 +34,7 @@ dependencies = [
     "mkdocstrings>=0.25",
     "griffe>=0.44",
 ]
-version = "1.10.1"
+version = "1.10.3"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.10.1 → mkdocstrings_python-1.10.3}/src/mkdocstrings_handlers/python/rendering.py

@@ -474,25 +474,25 @@ def do_get_template(env: Environment, obj: str | Object) -> str | Template:
         template = env.get_template(f"{name}.html")
     except TemplateNotFound:
         return f"{name}.html.jinja"
-    else:
-        # TODO: Remove once support for Python 3.8 is dropped.
-        if sys.version_info < (3, 9):
-            try:
-                Path(template.filename).relative_to(Path(__file__).parent)  # type: ignore[arg-type]
-            except ValueError:
-                our_template = False
-            else:
-                our_template = True
+    # TODO: Remove once support for Python 3.8 is dropped.
+    if sys.version_info < (3, 9):
+        try:
+            Path(template.filename).relative_to(Path(__file__).parent)  # type: ignore[arg-type]
+        except ValueError:
+            our_template = False
         else:
-            our_template = Path(template.filename).is_relative_to(Path(__file__).parent)  # type: ignore[arg-type]
-        if not our_template:
-            # TODO: Switch to a warning log after some time.
-            logger.info(
-                f"DeprecationWarning: Overriding '{name}.html' is deprecated, override '{name}.html.jinja' instead. "
-                "After some time, this message will be logged as a warning, causing strict builds to fail.",
-                once=True,
-            )
-        return f"{name}.html"
+            our_template = True
+    else:
+        our_template = Path(template.filename).is_relative_to(Path(__file__).parent)  # type: ignore[arg-type]
+    if our_template:
+        return f"{name}.html.jinja"
+    # TODO: Switch to a warning log after some time.
+    logger.info(
+        f"DeprecationWarning: Overriding '{name}.html' is deprecated, override '{name}.html.jinja' instead. "
+        "After some time, this message will be logged as a warning, causing strict builds to fail.",
+        once=True,
+    )
+    return f"{name}.html"
 
 
 @pass_context

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

@@ -157,7 +157,7 @@ Context:
                         {{ init.relative_filepath }}
                       {%- endif -%}
                     </code></summary>
-                    {{ init.source|highlight(language="python", linestart=init.lineno, linenums=True) }}
+                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
                   </details>
                 {% endwith %}
               {% endif %}
@@ -170,7 +170,7 @@ Context:
                     {{ class.relative_filepath }}
                   {%- endif -%}
                 </code></summary>
-                {{ class.source|highlight(language="python", linestart=class.lineno, linenums=True) }}
+                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
               </details>
             {% endif %}
           {% endif %}

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

@@ -133,7 +133,7 @@ Context:
                   {{ function.relative_filepath }}
                 {%- endif -%}
               </code></summary>
-              {{ function.source|highlight(language="python", linestart=function.lineno, linenums=True) }}
+              {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True) }}
             </details>
           {% endif %}
         {% endblock source %}

{mkdocstrings_python-1.10.1 → mkdocstrings_python-1.10.3}/tests/test_handler.py

@@ -4,10 +4,12 @@ from __future__ import annotations
 
 import os
 from glob import glob
+from textwrap import dedent
 from typing import TYPE_CHECKING
 
 import pytest
 from griffe.docstrings.dataclasses import DocstringSectionExamples, DocstringSectionKind
+from griffe.tests import temporary_visited_module
 
 from mkdocstrings_handlers.python.handler import CollectionError, PythonHandler, get_handler
 
@@ -145,3 +147,29 @@ def test_extension_paths(tmp_path: Path, expect_change: bool, extension: str | d
             raise ValueError("Normalization must not change extension items type")
     else:
         assert normalized == extension
+
+
+def test_rendering_object_source_without_lineno(handler: PythonHandler) -> None:
+    """Test rendering objects without a line number."""
+    code = dedent(
+        """
+        '''Module docstring.'''
+
+        class Class:
+            '''Class docstring.'''
+
+            def function(self):
+                '''Function docstring.'''
+
+        attribute = 0
+        '''Attribute docstring.'''
+        """,
+    )
+    with temporary_visited_module(code) as module:
+        # TODO: Remove once Griffe does that automatically.
+        module.lines_collection[module.filepath] = code.splitlines()  # type: ignore[index]
+
+        module["Class"].lineno = None
+        module["Class.function"].lineno = None
+        module["attribute"].lineno = None
+        assert handler.render(module, {"show_source": True})