refactor: Update for v2 (ran yore fix -b2)

Author: pawamoy

src/mkdocstrings_handlers/python/__init__.py

@@ -23,13 +23,11 @@
     do_as_functions_section,
     do_as_modules_section,
     do_backlink_tree,
-    do_crossref,
     do_filter_objects,
     do_format_attribute,
     do_format_code,
     do_format_signature,
     do_get_template,
-    do_multi_crossref,
     do_order_members,
     do_split_path,
     do_stash_crossref,
@@ -56,13 +54,11 @@
     "do_as_functions_section",
     "do_as_modules_section",
     "do_backlink_tree",
-    "do_crossref",
     "do_filter_objects",
     "do_format_attribute",
     "do_format_code",
     "do_format_signature",
     "do_get_template",
-    "do_multi_crossref",
     "do_order_members",
     "do_split_path",
     "do_stash_crossref",

src/mkdocstrings_handlers/python/_internal/handler.py

@@ -54,17 +54,6 @@ def chdir(path: str) -> Iterator[None]:
 patch_loggers(get_logger)
 
 
-# YORE: Bump 2: Remove block.
-def _warn_extra_options(names: Sequence[str]) -> None:
-    warn(
-        "Passing extra options directly under `options` is deprecated. "
-        "Instead, pass them under `options.extra`, and update your templates. "
-        f"Current extra (unrecognized) options: {', '.join(sorted(names))}",
-        DeprecationWarning,
-        stacklevel=3,
-    )
-
-
 class PythonHandler(BaseHandler):
     """The Python handler class."""
 
@@ -95,18 +84,9 @@ def __init__(self, config: PythonConfig, base_dir: Path, **kwargs: Any) -> None:
         self.base_dir = base_dir
         """The base directory of the project."""
 
-        # YORE: Bump 2: Remove block.
-        global_extra, global_options = PythonOptions._extract_extra(config.options)
-        if global_extra:
-            _warn_extra_options(global_extra.keys())  # type: ignore[arg-type]
-        self._global_extra = global_extra
-        self.global_options = global_options
+        self.global_options = config.options
         """The global configuration options (in `mkdocs.yml`)."""
 
-        # YORE: Bump 2: Replace `# ` with `` within block.
-        # self.global_options = config.options
-        # """The global configuration options (in `mkdocs.yml`)."""
-
         # Warn if user overrides base templates.
         if self.custom_templates:
             for theme_dir in base_dir.joinpath(self.custom_templates, "python").iterdir():
@@ -186,25 +166,13 @@ def get_options(self, local_options: Mapping[str, Any]) -> HandlerOptions:
         Returns:
             The combined options.
         """
-        # YORE: Bump 2: Remove block.
-        local_extra, local_options = PythonOptions._extract_extra(local_options)  # type: ignore[arg-type]
-        if local_extra:
-            _warn_extra_options(local_extra.keys())  # type: ignore[arg-type]
-        unknown_extra = self._global_extra | local_extra
-
         extra = {**self.global_options.get("extra", {}), **local_options.get("extra", {})}
         options = {**self.global_options, **local_options, "extra": extra}
         try:
-            # YORE: Bump 2: Replace `opts =` with `return` within line.
-            opts = PythonOptions.from_data(**options)
+            return PythonOptions.from_data(**options)
         except Exception as error:
             raise PluginError(f"Invalid options: {error}") from error
 
-        # YORE: Bump 2: Remove block.
-        for key, value in unknown_extra.items():
-            object.__setattr__(opts, key, value)
-        return opts
-
     def collect(self, identifier: str, options: PythonOptions) -> CollectorItem:
         """Collect the documentation for the given identifier.
 
@@ -288,7 +256,7 @@ def render(self, data: CollectorItem, options: PythonOptions) -> str:
         Returns:
             The rendered data (HTML).
         """
-        template_name = rendering.do_get_template(self.env, data)
+        template_name = rendering.do_get_template(data)
         template = self.env.get_template(template_name)
 
         return template.render(
@@ -314,8 +282,6 @@ def update_env(self, config: Any) -> None:  # noqa: ARG002
         self.env.lstrip_blocks = True
         self.env.keep_trailing_newline = False
         self.env.filters["split_path"] = rendering.do_split_path
-        self.env.filters["crossref"] = rendering.do_crossref
-        self.env.filters["multi_crossref"] = rendering.do_multi_crossref
         self.env.filters["order_members"] = rendering.do_order_members
         self.env.filters["format_code"] = rendering.do_format_code
         self.env.filters["format_signature"] = rendering.do_format_signature

src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -7,13 +7,11 @@
 import string
 import subprocess
 import sys
-import warnings
 from collections import defaultdict
 from contextlib import suppress
 from dataclasses import replace
 from functools import lru_cache
-from pathlib import Path
-from re import Match, Pattern
+from re import Pattern
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Literal, TypeVar
 
 from griffe import (
@@ -30,7 +28,7 @@
     DocstringSectionModules,
     Object,
 )
-from jinja2 import TemplateNotFound, pass_context, pass_environment
+from jinja2 import pass_context
 from markupsafe import Markup
 from mkdocs_autorefs import AutorefsHookInterface, Backlink, BacklinkCrumb
 from mkdocstrings import get_logger
@@ -39,7 +37,6 @@
     from collections.abc import Iterable, Iterator, Sequence
 
     from griffe import Attribute, Class, Function, Module
-    from jinja2 import Environment
     from jinja2.runtime import Context
     from mkdocstrings import CollectorItem
 
@@ -160,8 +157,7 @@ def do_format_signature(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "signature")` with `"signature.html.jinja"` within line.
-    template = env.get_template(do_get_template(env, "signature"))
+    template = env.get_template("signature.html.jinja")
 
     if annotations is None:
         new_context = context.parent
@@ -220,8 +216,7 @@ def do_format_attribute(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"` within line.
-    template = env.get_template(do_get_template(env, "expression"))
+    template = env.get_template("expression.html.jinja")
     annotations = context.parent["config"].show_signature_annotations
 
     signature = str(attribute_path).strip()
@@ -286,76 +281,6 @@ def do_order_members(
     return members
 
 
-# YORE: Bump 2: Remove block.
-@lru_cache
-def _warn_crossref() -> None:
-    warnings.warn(
-        "The `crossref` filter is deprecated and will be removed in a future version",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-
-# YORE: Bump 2: Remove block.
-def do_crossref(path: str, *, brief: bool = True) -> Markup:
-    """Deprecated. Filter to create cross-references.
-
-    Parameters:
-        path: The path to link to.
-        brief: Show only the last part of the path, add full path as hover.
-
-    Returns:
-        Markup text.
-    """
-    _warn_crossref()
-    full_path = path
-    if brief:
-        path = full_path.split(".")[-1]
-    return Markup("<autoref identifier={full_path} optional hover>{path}</autoref>").format(
-        full_path=full_path,
-        path=path,
-    )
-
-
-# YORE: Bump 2: Remove block.
-@lru_cache
-def _warn_multi_crossref() -> None:
-    warnings.warn(
-        "The `multi_crossref` filter is deprecated and will be removed in a future version",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-
-# YORE: Bump 2: Remove block.
-def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
-    """Deprecated. Filter to create cross-references.
-
-    Parameters:
-        text: The text to scan.
-        code: Whether to wrap the result in a code tag.
-
-    Returns:
-        Markup text.
-    """
-    _warn_multi_crossref()
-    group_number = 0
-    variables = {}
-
-    def repl(match: Match) -> str:
-        nonlocal group_number
-        group_number += 1
-        path = match.group()
-        path_var = f"path{group_number}"
-        variables[path_var] = path
-        return f"<autoref identifier={{{path_var}}} optional hover>{{{path_var}}}</autoref>"
-
-    text = re.sub(r"([\w.]+)", repl, text)
-    if code:
-        text = f"<code>{text}</code>"
-    return Markup(text).format(**variables)  # noqa: S704
-
-
 _split_path_re = re.compile(r"([.(]?)([\w]+)(\))?")
 _splitable_re = re.compile(r"[().]")
 
@@ -570,39 +495,19 @@ def formatter(code: str, line_length: int) -> str:
     return formatter
 
 
-# YORE: Bump 2: Remove line.
-@pass_environment
-# YORE: Bump 2: Replace `env: Environment, ` with `` within line.
-# YORE: Bump 2: Replace `str | ` with `` within line.
-def do_get_template(env: Environment, obj: str | Object) -> str:
+def do_get_template(obj: Object) -> str:
     """Get the template name used to render an object.
 
     Parameters:
-        env: The Jinja environment, passed automatically.
         obj: A Griffe object, or a template name.
 
     Returns:
         A template name.
     """
-    name = obj
-    if isinstance(obj, (Alias, Object)):
-        extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
-        if name := extra_data.get("template", ""):
-            return name
-        name = obj.kind.value
-    # YORE: Bump 2: Replace block with `return f"{name}.html.jinja"`.
-    try:
-        template = env.get_template(f"{name}.html")
-    except TemplateNotFound:
-        return f"{name}.html.jinja"
-    our_template = Path(template.filename).is_relative_to(Path(__file__).parent.parent)  # type: ignore[arg-type]
-    if our_template:
-        return f"{name}.html.jinja"
-    _logger.warning(
-        f"DeprecationWarning: Overriding '{name}.html' is deprecated, override '{name}.html.jinja' instead. ",
-        once=True,
-    )
-    return f"{name}.html"
+    extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
+    if template := extra_data.get("template", ""):
+        return template
+    return f"{obj.kind.value}.html.jinja"
 
 
 @pass_context

src/mkdocstrings_handlers/python/config.py

@@ -64,8 +64,7 @@ Context:
           This block renders the labels for the attribute.
           -#}
           {% with labels = attribute.labels %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "labels"|get_template with context %}
+            {% include "labels.html.jinja" with context %}
           {% endwith %}
         {% endblock labels %}
 
@@ -111,8 +110,7 @@ Context:
           This block renders the docstring for the attribute.
           -#}
           {% with docstring_sections = attribute.docstring.parsed %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}