Avoid using attributes of app

Author: AA-Turner

sphinx/builders/__init__.py

@@ -47,6 +47,7 @@
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Sequence, Set
+    from gettext import NullTranslations
     from typing import Any, Literal
 
     from docutils.nodes import Node
@@ -135,17 +136,21 @@ def __init__(self, app: Sphinx, env: BuildEnvironment) -> None:
         self.parallel_ok = False
         self.finish_tasks: Any = None
 
+    @property
+    def _translator(self) -> NullTranslations | None:
+        return self.app.translator
+
     def get_translator_class(self, *args: Any) -> type[nodes.NodeVisitor]:
         """Return a class of translator."""
-        return self.app.registry.get_translator_class(self)
+        return self.env._registry.get_translator_class(self)
 
     def create_translator(self, *args: Any) -> nodes.NodeVisitor:
         """Return an instance of translator.
 
         This method returns an instance of ``default_translator_class`` by default.
         Users can replace the translator class with ``app.set_translator()`` API.
         """
-        return self.app.registry.create_translator(self, *args)
+        return self.env._registry.create_translator(self, *args)
 
     # helper methods
     def init(self) -> None:
@@ -626,7 +631,7 @@ def read_doc(self, docname: str, *, _cache: bool = True) -> None:
 
         filename = str(env.doc2path(docname))
         filetype = get_filetype(self.app.config.source_suffix, filename)
-        publisher = self.app.registry.get_publisher(self.app, filetype)
+        publisher = self.env._registry.get_publisher(self.app, filetype)
         self.env.current_document._parser = publisher.parser
         # record_dependencies is mutable even though it is in settings,
         # explicitly re-initialise for each document

sphinx/builders/html/__init__.py

@@ -276,7 +276,7 @@ def init_css_files(self) -> None:
         for filename in self._get_style_filenames():
             self.add_css_file(filename, priority=200)
 
-        for filename, attrs in self.app.registry.css_files:
+        for filename, attrs in self.env._registry.css_files:
             self.add_css_file(filename, **attrs)
 
         for filename, attrs in self.get_builder_config('css_files', 'html'):
@@ -303,7 +303,7 @@ def init_js_files(self) -> None:
         self.add_js_file('doctools.js', priority=200)
         self.add_js_file('sphinx_highlight.js', priority=200)
 
-        for filename, attrs in self.app.registry.js_files:
+        for filename, attrs in self.env._registry.js_files:
             self.add_js_file(filename or '', **attrs)
 
         for filename, attrs in self.get_builder_config('js_files', 'html'):
@@ -328,7 +328,7 @@ def math_renderer_name(self) -> str | None:
             return name
         else:
             # not given: choose a math_renderer from registered ones as possible
-            renderers = list(self.app.registry.html_inline_math_renderers)
+            renderers = list(self.env._registry.html_inline_math_renderers)
             if len(renderers) == 1:
                 # only default math_renderer (mathjax) is registered
                 return renderers[0]
@@ -516,9 +516,9 @@ def prepare_writing(self, docnames: Set[str]) -> None:
                 ))
 
         # add assets registered after ``Builder.init()``.
-        for css_filename, attrs in self.app.registry.css_files:
+        for css_filename, attrs in self.env._registry.css_files:
             self.add_css_file(css_filename, **attrs)
-        for js_filename, attrs in self.app.registry.js_files:
+        for js_filename, attrs in self.env._registry.js_files:
             self.add_js_file(js_filename or '', **attrs)
 
         # back up _css_files and _js_files to allow adding CSS/JS files to a specific page.
@@ -1186,7 +1186,7 @@ def js_tag(js: _JavaScript | str) -> str:
         self._js_files[:] = self._orig_js_files
 
         self.update_page_context(pagename, templatename, ctx, event_arg)
-        if new_template := self.app.emit_firstresult(
+        if new_template := self.events.emit_firstresult(
             'html-page-context', pagename, templatename, ctx, event_arg
         ):
             templatename = new_template

sphinx/builders/latex/__init__.py

@@ -211,7 +211,7 @@ def init_context(self) -> None:
     def update_context(self) -> None:
         """Update template variables for .tex file just before writing."""
         # Apply extension settings to context
-        registry = self.app.registry
+        registry = self.env._registry
         self.context['packages'] = registry.latex_packages
         self.context['packages_after_hyperref'] = registry.latex_packages_after_hyperref
 

sphinx/builders/linkcheck.py

@@ -262,7 +262,7 @@ def _add_uri(self, uri: str, node: nodes.Element) -> None:
         hyperlinks = builder.hyperlinks
         docname = self.env.docname
 
-        if newuri := self.app.emit_firstresult('linkcheck-process-uri', uri):
+        if newuri := self.app.events.emit_firstresult('linkcheck-process-uri', uri):
             uri = newuri
 
         try:

sphinx/domains/std/__init__.py

@@ -808,7 +808,7 @@ def __init__(self, env: BuildEnvironment) -> None:
         self.enumerable_nodes = copy(
             self.enumerable_nodes
         )  # create a copy for this instance
-        for node, settings in env.app.registry.enumerable_nodes.items():
+        for node, settings in env._registry.enumerable_nodes.items():
             self.enumerable_nodes[node] = settings
 
     def note_hyperlink_target(

sphinx/environment/__init__.py

@@ -48,6 +48,8 @@
     from sphinx.events import EventManager
     from sphinx.extension import Extension
     from sphinx.project import Project
+    from sphinx.registry import SphinxComponentRegistry
+    from sphinx.util.tags import Tags
 
 logger = logging.getLogger(__name__)
 
@@ -282,6 +284,14 @@ def setup(self, app: Sphinx) -> None:
         # initialize settings
         self._update_settings(app.config)
 
+    @property
+    def _registry(self) -> SphinxComponentRegistry:
+        return self.app.registry
+
+    @property
+    def _tags(self) -> Tags:
+        return self.app.tags
+
     @staticmethod
     def _config_status(
         *, old_config: Config | None, new_config: Config, verbosity: int
@@ -629,7 +639,7 @@ def note_included(self, filename: str | os.PathLike[str]) -> None:
         """
         doc = self.path2doc(filename)
         if doc:
-            self.included[self.docname].add(doc)
+            self.included.setdefault(self.docname, set()).add(doc)
 
     def note_reread(self) -> None:
         """Add the current document to the list of documents that will
@@ -759,7 +769,7 @@ def apply_post_transforms(self, doctree: nodes.document, docname: str) -> None:
 
             transformer = SphinxTransformer(doctree)
             transformer.set_environment(self)
-            transformer.add_transforms(self.app.registry.get_post_transforms())
+            transformer.add_transforms(self._registry.get_post_transforms())
             transformer.apply_transforms()
         finally:
             self.current_document = backup

sphinx/environment/adapters/toctree.py

@@ -574,7 +574,7 @@ def get_toctree_ancestors(self, docname: str) -> list[str]:
         return [*_get_toctree_ancestors(self.env.toctree_includes, docname)]
 
     def get_toc_for(self, docname: str, builder: Builder) -> Node:
-        return document_toc(self.env, docname, self.env.app.tags)
+        return document_toc(self.env, docname, self.env._tags)
 
     def get_toctree_for(
         self,

sphinx/ext/autodoc/__init__.py

@@ -44,6 +44,7 @@
     from sphinx.environment import BuildEnvironment, _CurrentDocument
     from sphinx.events import EventManager
     from sphinx.ext.autodoc.directive import DocumenterBridge
+    from sphinx.registry import SphinxComponentRegistry
     from sphinx.util.typing import ExtensionMetadata, OptionSpec, _RestifyMode
 
     _AutodocObjType = Literal[
@@ -380,7 +381,7 @@ class Documenter:
 
     def get_attr(self, obj: Any, name: str, *defargs: Any) -> Any:
         """getattr() override for types such as Zope interfaces."""
-        return autodoc_attrgetter(self.env.app, obj, name, *defargs)
+        return autodoc_attrgetter(self.env._registry, obj, name, *defargs)
 
     @classmethod
     def can_document_member(
@@ -422,7 +423,7 @@ def __init__(
     @property
     def documenters(self) -> dict[str, type[Documenter]]:
         """Returns registered Documenter classes"""
-        return self.env.app.registry.documenters
+        return self.env._registry.documenters
 
     def add_line(self, line: str, source: str, *lineno: int) -> None:
         """Append one line of generated reST to the output."""
@@ -3137,9 +3138,11 @@ def _get_property_getter(self) -> Callable[..., Any] | None:
         return None
 
 
-def autodoc_attrgetter(app: Sphinx, obj: Any, name: str, *defargs: Any) -> Any:
+def autodoc_attrgetter(
+    registry: SphinxComponentRegistry, obj: Any, name: str, *defargs: Any
+) -> Any:
     """Alternative getattr() for types"""
-    for typ, func in app.registry.autodoc_attrgetters.items():
+    for typ, func in registry.autodoc_attrgetters.items():
         if isinstance(obj, typ):
             return func(obj, name, *defargs)
 

sphinx/ext/autodoc/directive.py

@@ -150,7 +150,7 @@ def run(self) -> list[Node]:
 
         # look up target Documenter
         objtype = self.name[4:]  # strip prefix (auto-).
-        doccls = self.env.app.registry.documenters[objtype]
+        doccls = self.env._registry.documenters[objtype]
 
         # process the options with the selected documenter's option_spec
         try:

sphinx/ext/autosummary/__init__.py

@@ -180,7 +180,9 @@ def __init__(self) -> None:
         super().__init__(env, None, Options(), 0, state)
 
 
-def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
+def _get_documenter(
+    obj: Any, parent: Any, *, registry: SphinxComponentRegistry
+) -> type[Documenter]:
     """Get an autodoc.Documenter class suitable for documenting the given
     object.
 
@@ -196,7 +198,7 @@ def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
 
     # Construct a fake documenter for *parent*
     if parent is not None:
-        parent_doc_cls = get_documenter(app, parent, None)
+        parent_doc_cls = _get_documenter(parent, None, registry=registry)
     else:
         parent_doc_cls = ModuleDocumenter
 
@@ -208,7 +210,7 @@ def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
     # Get the correct documenter class for *obj*
     classes = [
         cls
-        for cls in app.registry.documenters.values()
+        for cls in registry.documenters.values()
         if cls.can_document_member(obj, '', False, parent_doc)
     ]
     if classes:
@@ -318,14 +320,19 @@ def import_by_name(
                     raise ImportExceptionGroup(exc.args[0], errors) from None
 
     def create_documenter(
-        self, app: Sphinx, obj: Any, parent: Any, full_name: str
+        self,
+        obj: Any,
+        parent: Any,
+        full_name: str,
+        *,
+        registry: SphinxComponentRegistry,
     ) -> Documenter:
         """Get an autodoc.Documenter class suitable for documenting the given
         object.
 
-        Wraps get_documenter and is meant as a hook for extensions.
+        Wraps _get_documenter and is meant as a hook for extensions.
         """
-        doccls = get_documenter(app, obj, parent)
+        doccls = _get_documenter(obj, parent, registry=registry)
         return doccls(self.bridge, full_name)
 
     def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
@@ -378,7 +385,9 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
                 full_name = modname + '::' + full_name[len(modname) + 1 :]
             # NB. using full_name here is important, since Documenters
             #     handle module prefixes slightly differently
-            documenter = self.create_documenter(self.env.app, obj, parent, full_name)
+            documenter = self.create_documenter(
+                obj, parent, full_name, registry=self.env._registry
+            )
             if not documenter.parse_name():
                 logger.warning(
                     __('failed to parse name %s'),