Avoid self.app in transforms (#13628)

Author: AA-Turner

sphinx/application.py

@@ -399,6 +399,8 @@ def _post_init_env(self) -> None:
         if self._fresh_env_used:
             self.env.find_files(self.config, self.builder)
 
+        self.env._builder_cls = self.builder.__class__
+
     def preload_builder(self, name: str) -> None:
         self.registry.preload_builder(self, name)
 

sphinx/builders/linkcheck.py

@@ -259,11 +259,11 @@ def _add_uri(self, uri: str, node: nodes.Element) -> None:
         :param uri: URI to add
         :param node: A node class where the URI was found
         """
-        builder = cast('CheckExternalLinksBuilder', self.app.builder)
+        builder = cast('CheckExternalLinksBuilder', self.env._app.builder)
         hyperlinks = builder.hyperlinks
         docname = self.env.docname
 
-        if newuri := self.app.events.emit_firstresult('linkcheck-process-uri', uri):
+        if newuri := self.env.events.emit_firstresult('linkcheck-process-uri', uri):
             uri = newuri
 
         try:

sphinx/environment/__init__.py

@@ -107,6 +107,9 @@ class BuildEnvironment:
     srcdir = _StrPathProperty()
     doctreedir = _StrPathProperty()
 
+    # builder is created after the environment.
+    _builder_cls: type[Builder]
+
     def __init__(self, app: Sphinx) -> None:
         self._app: Sphinx = app
         self.doctreedir = app.doctreedir

sphinx/ext/extlinks.py

@@ -68,7 +68,7 @@ def check_uri(self, refnode: nodes.reference) -> None:
         uri = refnode['refuri']
         title = refnode.astext()
 
-        for alias, (base_uri, _caption) in self.app.config.extlinks.items():
+        for alias, (base_uri, _caption) in self.config.extlinks.items():
             uri_pattern = re.compile(re.escape(base_uri).replace('%s', '(?P<value>.+)'))
 
             match = uri_pattern.match(uri)

sphinx/ext/viewcode.py

@@ -103,11 +103,11 @@ def _get_full_modname(modname: str, attribute: str) -> str | None:
         return None
 
 
-def is_supported_builder(builder: Builder) -> bool:
+def is_supported_builder(builder: type[Builder], viewcode_enable_epub: bool) -> bool:
     return (
         builder.format == 'html'
         and builder.name != 'singlehtml'
-        and (not builder.name.startswith('epub') or builder.config.viewcode_enable_epub)
+        and (not builder.name.startswith('epub') or viewcode_enable_epub)
     )
 
 
@@ -220,7 +220,9 @@ class ViewcodeAnchorTransform(SphinxPostTransform):
     default_priority = 100
 
     def run(self, **kwargs: Any) -> None:
-        if is_supported_builder(self.app.builder):
+        if is_supported_builder(
+            self.env._builder_cls, self.config.viewcode_enable_epub
+        ):
             self.convert_viewcode_anchors()
         else:
             self.remove_viewcode_anchors()
@@ -229,7 +231,7 @@ def convert_viewcode_anchors(self) -> None:
         for node in self.document.findall(viewcode_anchor):
             anchor = nodes.inline('', _('[source]'), classes=['viewcode-link'])
             refnode = make_refnode(
-                self.app.builder,
+                self.env._app.builder,
                 node['refdoc'],
                 node['reftarget'],
                 node['refid'],
@@ -281,7 +283,7 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
     env = app.env
     if not hasattr(env, '_viewcode_modules'):
         return
-    if not is_supported_builder(app.builder):
+    if not is_supported_builder(env._builder_cls, env.config.viewcode_enable_epub):
         return
     highlighter = app.builder.highlighter  # type: ignore[attr-defined]
     urito = app.builder.get_relative_uri

sphinx/io.py

@@ -10,16 +10,9 @@
 from docutils.transforms.references import DanglingReferences
 from docutils.writers import UnfilteredWriter
 
-from sphinx.transforms import AutoIndexUpgrader, DoctreeReadEvent, SphinxTransformer
-from sphinx.transforms.i18n import (
-    Locale,
-    PreserveTranslatableMessages,
-    RemoveTranslatableInline,
-)
-from sphinx.transforms.references import SphinxDomains
+from sphinx.transforms import SphinxTransformer
 from sphinx.util import logging
 from sphinx.util.docutils import LoggingReporter
-from sphinx.versioning import UIDTransform
 
 if TYPE_CHECKING:
     from typing import Any
@@ -113,32 +106,6 @@ def read_source(self, env: BuildEnvironment) -> str:
         return arg[0]
 
 
-class SphinxI18nReader(SphinxBaseReader):
-    """A document reader for i18n.
-
-    This returns the source line number of original text as current source line number
-    to let users know where the error happened.
-    Because the translated texts are partial and they don't have correct line numbers.
-    """
-
-    def setup(self, app: Sphinx) -> None:
-        super().setup(app)
-
-        self.transforms = self.transforms + app.registry.get_transforms()
-        unused = [
-            PreserveTranslatableMessages,
-            Locale,
-            RemoveTranslatableInline,
-            AutoIndexUpgrader,
-            SphinxDomains,
-            DoctreeReadEvent,
-            UIDTransform,
-        ]
-        for transform in unused:
-            if transform in self.transforms:
-                self.transforms.remove(transform)
-
-
 class SphinxDummyWriter(UnfilteredWriter):  # type: ignore[type-arg]
     """Dummy writer module used for generating doctree."""
 

sphinx/transforms/__init__.py

@@ -63,8 +63,9 @@ class SphinxTransform(Transform):
     @property
     def app(self) -> Sphinx:
         """Reference to the :class:`.Sphinx` object."""
+        cls_module = self.__class__.__module__
         cls_name = self.__class__.__qualname__
-        _deprecation_warning(__name__, f'{cls_name}.app', remove=(10, 0))
+        _deprecation_warning(cls_module, f'{cls_name}.app', remove=(10, 0))
         return self.env.app
 
     @property
@@ -382,7 +383,7 @@ def is_available(self) -> bool:
         if self.config.smartquotes is False:
             # disabled by confval smartquotes
             return False
-        if self.app.builder.name in builders:
+        if self.env._builder_cls.name in builders:
             # disabled by confval smartquotes_excludes['builders']
             return False
         if self.config.language in languages:
@@ -412,7 +413,7 @@ class DoctreeReadEvent(SphinxTransform):
     default_priority = 880
 
     def apply(self, **kwargs: Any) -> None:
-        self.app.events.emit('doctree-read', self.document)
+        self.env.events.emit('doctree-read', self.document)
 
 
 class GlossarySorter(SphinxTransform):

sphinx/transforms/i18n.py

@@ -5,6 +5,7 @@
 import contextlib
 from re import DOTALL, match
 from textwrap import indent
+from types import SimpleNamespace
 from typing import TYPE_CHECKING, Any, TypeVar
 
 from docutils import nodes
@@ -13,9 +14,11 @@
 from sphinx import addnodes
 from sphinx.domains.std import make_glossary_term, split_term_classifiers
 from sphinx.errors import ConfigError
+from sphinx.io import SphinxBaseReader
 from sphinx.locale import __
 from sphinx.locale import init as init_locale
-from sphinx.transforms import SphinxTransform
+from sphinx.transforms import AutoIndexUpgrader, DoctreeReadEvent, SphinxTransform
+from sphinx.transforms.references import SphinxDomains
 from sphinx.util import get_filetype, logging
 from sphinx.util.i18n import docname_to_domain
 from sphinx.util.index_entries import split_index_msg
@@ -26,12 +29,15 @@
     extract_messages,
     traverse_translatable_index,
 )
+from sphinx.versioning import UIDTransform
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
     from sphinx.application import Sphinx
     from sphinx.config import Config
+    from sphinx.environment import BuildEnvironment
+    from sphinx.registry import SphinxComponentRegistry
     from sphinx.util.typing import ExtensionMetadata
 
 
@@ -47,36 +53,65 @@
 N = TypeVar('N', bound=nodes.Node)
 
 
+class _SphinxI18nReader(SphinxBaseReader):
+    """A document reader for internationalisation (i18n).
+
+    This returns the source line number of the original text
+    as the current source line number to let users know where
+    the error happened, because the translated texts are
+    partial and they don't have correct line numbers.
+    """
+
+    def __init__(
+        self, *args: Any, registry: SphinxComponentRegistry, **kwargs: Any
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        unused = frozenset({
+            PreserveTranslatableMessages,
+            Locale,
+            RemoveTranslatableInline,
+            AutoIndexUpgrader,
+            SphinxDomains,
+            DoctreeReadEvent,
+            UIDTransform,
+        })
+        transforms = self.transforms + registry.get_transforms()
+        self.transforms = [
+            transform for transform in transforms if transform not in unused
+        ]
+
+
 def publish_msgstr(
-    app: Sphinx,
     source: str,
     source_path: str,
     source_line: int,
     config: Config,
     settings: Any,
+    *,
+    env: BuildEnvironment,
+    registry: SphinxComponentRegistry,
 ) -> nodes.Element:
     """Publish msgstr (single line) into docutils document
 
-    :param sphinx.application.Sphinx app: sphinx application
     :param str source: source text
     :param str source_path: source path for warning indication
     :param source_line: source line for warning indication
     :param sphinx.config.Config config: sphinx config
     :param docutils.frontend.Values settings: docutils settings
     :return: document
     :rtype: docutils.nodes.document
+    :param sphinx.environment.BuildEnvironment env: sphinx environment
+    :param sphinx.registry.SphinxComponentRegistry registry: sphinx registry
     """
     try:
         # clear rst_prolog temporarily
         rst_prolog = config.rst_prolog
         config.rst_prolog = None
 
-        from sphinx.io import SphinxI18nReader
-
-        reader = SphinxI18nReader()
-        reader.setup(app)
+        reader = _SphinxI18nReader(registry=registry)
+        app = SimpleNamespace(config=config, env=env, registry=registry)
         filetype = get_filetype(config.source_suffix, source_path)
-        parser = app.registry.create_source_parser(app, filetype)
+        parser = registry.create_source_parser(app, filetype)  # type: ignore[arg-type]
         doc = reader.read(
             source=StringInput(
                 source=source, source_path=f'{source_path}:{source_line}:<translated>'
@@ -436,12 +471,13 @@ def apply(self, **kwargs: Any) -> None:
                 msgstr = '::\n\n' + indent(msgstr, ' ' * 3)
 
             patch = publish_msgstr(
-                self.app,
                 msgstr,
                 source,
                 node.line,  # type: ignore[arg-type]
                 self.config,
                 settings,
+                env=self.env,
+                registry=self.env._registry,
             )
             # FIXME: no warnings about inconsistent references in this part
             # XXX doctest and other block markup
@@ -456,12 +492,13 @@ def apply(self, **kwargs: Any) -> None:
                 for _id in node['ids']:
                     term, first_classifier = split_term_classifiers(msgstr)
                     patch = publish_msgstr(
-                        self.app,
                         term or '',
                         source,
                         node.line,  # type: ignore[arg-type]
                         self.config,
                         settings,
+                        env=self.env,
+                        registry=self.env._registry,
                     )
                     updater.patch = make_glossary_term(
                         self.env,
@@ -533,12 +570,13 @@ def apply(self, **kwargs: Any) -> None:
                 msgstr = msgstr + '\n' + '=' * len(msgstr) * 2
 
             patch = publish_msgstr(
-                self.app,
                 msgstr,
                 source,
                 node.line,  # type: ignore[arg-type]
                 self.config,
                 settings,
+                env=self.env,
+                registry=self.env._registry,
             )
             # Structural Subelements phase2
             if isinstance(node, nodes.title):
@@ -612,7 +650,7 @@ class TranslationProgressTotaliser(SphinxTransform):
     def apply(self, **kwargs: Any) -> None:
         from sphinx.builders.gettext import MessageCatalogBuilder
 
-        if isinstance(self.app.builder, MessageCatalogBuilder):
+        if issubclass(self.env._builder_cls, MessageCatalogBuilder):
             return
 
         total = translated = 0
@@ -635,7 +673,7 @@ class AddTranslationClasses(SphinxTransform):
     def apply(self, **kwargs: Any) -> None:
         from sphinx.builders.gettext import MessageCatalogBuilder
 
-        if isinstance(self.app.builder, MessageCatalogBuilder):
+        if issubclass(self.env._builder_cls, MessageCatalogBuilder):
             return
 
         if not self.config.translation_progress_classes:
@@ -673,7 +711,7 @@ class RemoveTranslatableInline(SphinxTransform):
     def apply(self, **kwargs: Any) -> None:
         from sphinx.builders.gettext import MessageCatalogBuilder
 
-        if isinstance(self.app.builder, MessageCatalogBuilder):
+        if issubclass(self.env._builder_cls, MessageCatalogBuilder):
             return
 
         matcher = NodeMatcher(nodes.inline, translatable=Any)