Delete FakeDirective in autosummary (sphinx-doc#13967)

Author: AA-Turner

sphinx/ext/autodoc/_documenters.py

@@ -598,7 +598,8 @@ def _gather_members(
                 member=member,
                 member_name=member_name,
                 is_attr=is_attr,
-                parent_documenter=self,
+                parent_obj_type=self.objtype,
+                parent_props=self.props,
             )
             if not obj_type:
                 # don't know how to document this member
@@ -795,7 +796,9 @@ def _best_object_type_for_member(
     member: Any,
     member_name: str,
     is_attr: bool,
-    parent_documenter: Documenter,
+    *,
+    parent_obj_type: str,
+    parent_props: _ItemProperties | None,
 ) -> str | None:
     """Return the best object type that supports documenting *member*."""
     filtered = []
@@ -818,42 +821,36 @@ def _best_object_type_for_member(
         # as NewType can be an attribute and is a class after Python 3.10.
         filtered.append((15, 'class'))
 
-    if isinstance(parent_documenter, ClassDocumenter):
+    if parent_obj_type in {'class', 'exception'}:
         if inspect.isproperty(member):
             # priority must be higher than 'attribute'
             filtered.append((11, 'property'))
 
-        # Support for class properties. Note: these only work on Python 3.9.
-        elif hasattr(parent_documenter, 'props'):
-            # See FakeDirective &c in autosummary, parent might not be a
-            # 'proper' Documenter.
-            __dict__ = safe_getattr(parent_documenter.props._obj, '__dict__', {})
+        # See _get_documenter() in autosummary, parent_props might be None.
+        elif parent_props is not None:
+            # Support for class properties. Note: these only work on Python 3.9.
+            __dict__ = safe_getattr(parent_props._obj, '__dict__', {})
             obj = __dict__.get(member_name)
             if isinstance(obj, classmethod) and inspect.isproperty(obj.__func__):
                 # priority must be higher than 'attribute'
                 filtered.append((11, 'property'))
 
-    if not isinstance(parent_documenter, ModuleDocumenter):
+    if parent_obj_type != 'module':
         if inspect.isattributedescriptor(member) or not (
             inspect.isroutine(member) or isinstance(member, type)
         ):
             # priority must be higher than 'method', else it will recognise
             # some non-data descriptors as methods
             filtered.append((10, 'attribute'))
 
-    if inspect.isroutine(member) and not isinstance(
-        parent_documenter, ModuleDocumenter
-    ):
+    if inspect.isroutine(member) and parent_obj_type != 'module':
         # priority must be higher than 'function'
         filtered.append((1, 'method'))
 
     if (
         inspect.isfunction(member)
         or inspect.isbuiltin(member)
-        or (
-            inspect.isroutine(member)
-            and isinstance(parent_documenter, ModuleDocumenter)
-        )
+        or (inspect.isroutine(member) and parent_obj_type == 'module')
     ):
         # supports functions, builtins and bound methods exported
         # at the module level
@@ -862,7 +859,7 @@ def _best_object_type_for_member(
     if isinstance(member, AnyTypeAliasType):
         filtered.append((0, 'type'))
 
-    if isinstance(parent_documenter, ModuleDocumenter) and is_attr:
+    if parent_obj_type == 'module' and is_attr:
         filtered.append((-10, 'data'))
 
     if filtered:

sphinx/ext/autosummary/__init__.py

@@ -55,19 +55,16 @@
 import re
 import sys
 from inspect import Parameter
-from pathlib import Path
 from types import ModuleType
 from typing import TYPE_CHECKING, cast
 
 from docutils import nodes
 from docutils.parsers.rst import directives
-from docutils.parsers.rst.states import RSTStateMachine, Struct, state_classes
+from docutils.parsers.rst.states import RSTStateMachine, state_classes
 from docutils.statemachine import StringList
 
 import sphinx
 from sphinx import addnodes
-from sphinx.config import Config
-from sphinx.environment import BuildEnvironment
 from sphinx.errors import PycodeError
 from sphinx.ext.autodoc._directive_options import _AutoDocumenterOptions
 from sphinx.ext.autodoc._documenters import _best_object_type_for_member
@@ -76,9 +73,7 @@
 from sphinx.ext.autodoc.importer import _format_signatures, import_module
 from sphinx.ext.autodoc.mock import mock
 from sphinx.locale import __
-from sphinx.project import Project
 from sphinx.pycode import ModuleAnalyzer
-from sphinx.registry import SphinxComponentRegistry
 from sphinx.util import logging, rst
 from sphinx.util.docutils import (
     NullReporter,
@@ -98,8 +93,9 @@
     from docutils.nodes import Node, system_message
 
     from sphinx.application import Sphinx
+    from sphinx.environment import BuildEnvironment
     from sphinx.ext.autodoc import Documenter
-    from sphinx.extension import Extension
+    from sphinx.registry import SphinxComponentRegistry
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
     from sphinx.writers.html5 import HTML5Translator
 
@@ -158,31 +154,6 @@ def autosummary_table_visit_html(
 # -- autodoc integration -------------------------------------------------------
 
 
-class FakeApplication:
-    verbosity = 0
-
-    def __init__(self) -> None:
-        self.doctreedir = Path()
-        self.events = None
-        self.extensions: dict[str, Extension] = {}
-        self.srcdir = Path()
-        self.config = Config()
-        self.project = Project('', {})
-        self.registry = SphinxComponentRegistry()
-
-
-class FakeDirective(DocumenterBridge):
-    def __init__(self) -> None:
-        settings = Struct(tab_width=8)
-        document = Struct(settings=settings)
-        app = FakeApplication()
-        app.config.add('autodoc_class_signature', 'mixed', 'env', ())
-        env = BuildEnvironment(app)  # type: ignore[arg-type]
-        opts = _AutoDocumenterOptions()
-        state = Struct(document=document)
-        super().__init__(env, None, opts, 0, state)
-
-
 def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
     """Get an autodoc.Documenter class suitable for documenting the given
     object.
@@ -191,43 +162,36 @@ def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
     another Python object (e.g. a module or a class) to which *obj*
     belongs to.
     """
-    return _get_documenter(obj, parent, registry=app.registry)
+    obj_type = _get_documenter(obj, parent)
+    return app.registry.documenters[obj_type]
 
 
-def _get_documenter(
-    obj: Any, parent: Any, *, registry: SphinxComponentRegistry
-) -> type[Documenter]:
+def _get_documenter(obj: Any, parent: Any) -> str:
     """Get an autodoc.Documenter class suitable for documenting the given
     object.
 
     *obj* is the Python object to be documented, and *parent* is an
     another Python object (e.g. a module or a class) to which *obj*
     belongs to.
     """
-    from sphinx.ext.autodoc import DataDocumenter, ModuleDocumenter
-
     if inspect.ismodule(obj):
-        return ModuleDocumenter
-
-    # Construct a fake documenter for *parent*
-    if parent is not None:
-        parent_doc_cls = _get_documenter(parent, None, registry=registry)
-    else:
-        parent_doc_cls = ModuleDocumenter
+        return 'module'
 
-    if hasattr(parent, '__name__'):
-        parent_doc = parent_doc_cls(FakeDirective(), parent.__name__)
+    if parent is None:
+        parent_obj_type = 'module'
     else:
-        parent_doc = parent_doc_cls(FakeDirective(), '')
+        parent_obj_type = _get_documenter(parent, None)
 
     # Get the correct documenter class for *obj*
-    obj_type = _best_object_type_for_member(
-        member=obj, member_name='', is_attr=False, parent_documenter=parent_doc
-    )
-    if obj_type:
-        return registry.documenters[obj_type]
-    else:
-        return DataDocumenter
+    if obj_type := _best_object_type_for_member(
+        member=obj,
+        member_name='',
+        is_attr=False,
+        parent_obj_type=parent_obj_type,
+        parent_props=None,
+    ):
+        return obj_type
+    return 'data'
 
 
 # -- .. autosummary:: ----------------------------------------------------------
@@ -343,7 +307,8 @@ def create_documenter(
 
         Wraps _get_documenter and is meant as a hook for extensions.
         """
-        doccls = _get_documenter(obj, parent, registry=registry)
+        obj_type = _get_documenter(obj, parent)
+        doccls = registry.documenters[obj_type]
         return doccls(self.bridge, full_name)
 
     def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
@@ -389,16 +354,16 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
                 continue
 
             self.bridge.result = StringList()  # initialize for each documenter
+            obj_type = _get_documenter(obj, parent)
+            doccls = self.env._registry.documenters[obj_type]
             full_name = real_name
             if not isinstance(obj, ModuleType):
                 # give explicitly separated module name, so that members
                 # of inner classes can be documented
                 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(
-                obj, parent, full_name, registry=self.env._registry
-            )
+            documenter = doccls(self.bridge, full_name)
             if documenter._load_object_by_name() is None:
                 logger.warning(
                     __('failed to import object %s'),

sphinx/ext/autosummary/generate.py

@@ -231,7 +231,7 @@ def __init__(
         self.object = obj
 
     def get_object_type(self, name: str, value: Any) -> str:
-        return _get_documenter(value, self.object, registry=self.registry).objtype
+        return _get_documenter(value, self.object)
 
     def is_skipped(self, name: str, value: Any, objtype: str) -> bool:
         try:
@@ -264,7 +264,7 @@ def scan(self, imported_members: bool) -> list[str]:
             except AttributeError:
                 value = None
 
-            objtype = self.get_object_type(name, value)
+            objtype = _get_documenter(value, self.object)
             if self.is_skipped(name, value, objtype):
                 continue
 
@@ -325,7 +325,8 @@ def generate_autosummary_content(
     events: EventManager,
     registry: SphinxComponentRegistry,
 ) -> str:
-    doc = _get_documenter(obj, parent, registry=registry)
+    obj_type = _get_documenter(obj, parent)
+    doc = registry.documenters[obj_type]
 
     ns: dict[str, Any] = {}
     ns.update(context)
@@ -578,7 +579,8 @@ def _get_members(
 
     all_members = _get_all_members(doc, obj, config=config)
     for name, value in all_members.items():
-        documenter = _get_documenter(value, obj, registry=registry)
+        obj_type = _get_documenter(value, obj)
+        documenter = registry.documenters[obj_type]
         if documenter.objtype in types:
             # skip imported members if expected
             if imported or getattr(value, '__module__', None) == obj.__name__: