Create Documenter objects after importing objects

Author: AA-Turner

sphinx/ext/autodoc/_member_finder.py

@@ -233,12 +233,10 @@ def _gather_members(
         if not obj_type:
             # don't know how to document this member
             continue
-        doccls = registry.documenters[obj_type]
         # give explicitly separated module name, so that members
         # of inner classes can be documented
         dotted_parts = '.'.join((*props.parts, member_name))
         full_name = f'{props.module_name}::{dotted_parts}'
-        documenter = doccls(directive, full_name, indent)
 
         # We now try to import all objects before ordering them. This is to
         # avoid possible circular imports if we were to import objects after
@@ -253,10 +251,13 @@ def _gather_members(
             env=env,
             events=events,
             get_attr=get_attr,
-            options=documenter.options,
+            options=directive.genopt,
         )
         if member_props is None:
             continue
+
+        doccls = registry.documenters[obj_type]
+        documenter = doccls(directive, full_name, indent)
         documenter.props = member_props
 
         member_documenters.append((documenter, is_attr))

sphinx/ext/autodoc/directive.py

@@ -142,10 +142,6 @@ def run(self) -> list[Node]:
 
         # generate the output
         get_attr = _AutodocAttrGetter(self.env._registry.autodoc_attrgetters)
-        params = DocumenterBridge(
-            self.env, reporter, documenter_options, lineno, self.state, get_attr
-        )
-        documenter = doccls(params, self.arguments[0])
         props = _load_object_by_name(
             name=self.arguments[0],
             objtype=objtype,  # type: ignore[arg-type]
@@ -156,11 +152,17 @@ def run(self) -> list[Node]:
             env=self.env,
             events=self.env.events,
             get_attr=get_attr,
-            options=documenter.options,
+            options=documenter_options,
+        )
+        if props is None:
+            return []
+
+        params = DocumenterBridge(
+            self.env, reporter, documenter_options, lineno, self.state, get_attr
         )
-        if props is not None:
-            documenter.props = props
-            documenter._generate(more_content=self.content)
+        documenter = doccls(params, self.arguments[0])
+        documenter.props = props
+        documenter._generate(more_content=self.content)
         if not params.result:
             return []
 

sphinx/ext/autosummary/__init__.py

@@ -369,7 +369,6 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
 
             result = StringList()  # initialize for each documenter
             obj_type = _get_documenter(obj, parent)
-            doccls = env._registry.documenters[obj_type]
             if isinstance(obj, ModuleType):
                 full_name = real_name
             else:
@@ -379,7 +378,6 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
             # NB. using full_name here is important, since Documenters
             #     handle module prefixes slightly differently
             self.bridge.result = result
-            documenter = doccls(self.bridge, full_name)
             props = _load_object_by_name(
                 name=full_name,
                 objtype=obj_type,
@@ -390,7 +388,7 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
                 env=env,
                 events=events,
                 get_attr=get_attr,
-                options=documenter.options,
+                options=self.bridge.genopt,
             )
             if props is None:
                 logger.warning(
@@ -400,7 +398,6 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
                 )
                 items.append((display_name, '', '', real_name))
                 continue
-            documenter.props = props
 
             # try to also get a source code analyzer for attribute docs
             real_module = props._obj___module__ or props.module_name
@@ -413,7 +410,6 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
                 logger.debug('[autodoc] module analyzer failed: %s', err)
                 # no source file -- e.g. for builtin and C modules
                 analyzer = None
-            documenter.analyzer = analyzer
 
             # -- Grab the signature
 
@@ -429,6 +425,10 @@ def get_items(self, names: list[str]) -> list[tuple[str, str | None, str, str]]:
 
             # -- Grab the summary
 
+            doccls = env._registry.documenters[obj_type]
+            documenter = doccls(self.bridge, full_name)
+            documenter.props = props
+            documenter.analyzer = analyzer
             documenter.add_content(None, indent=documenter.indent)
             lines = result.data[:]
             if props.obj_type != 'module':

tests/test_ext_autodoc/autodoc_util.py

@@ -3,6 +3,8 @@
 from typing import TYPE_CHECKING
 from unittest.mock import Mock
 
+from docutils.statemachine import StringList
+
 from sphinx.ext.autodoc._directive_options import (
     _AutoDocumenterOptions,
     _process_documenter_options,
@@ -17,8 +19,6 @@
 if TYPE_CHECKING:
     from typing import Any
 
-    from docutils.statemachine import StringList
-
     from sphinx.application import Sphinx
     from sphinx.ext.autodoc._property_types import _AutodocObjType
 
@@ -38,12 +38,7 @@ def do_autodoc(
         default_options=app.config.autodoc_default_options,
         options=options,
     )
-    docoptions = _AutoDocumenterOptions.from_directive_options(opts)
-    state = Mock()
-    bridge = DocumenterBridge(
-        app.env, LoggingReporter(''), docoptions, 1, state, safe_getattr
-    )
-    documenter = doccls(bridge, name)
+    doc_options = _AutoDocumenterOptions.from_directive_options(opts)
     props = _load_object_by_name(
         name=name,
         objtype=obj_type,
@@ -54,9 +49,16 @@ def do_autodoc(
         env=app.env,
         events=app.events,
         get_attr=safe_getattr,
-        options=documenter.options,
+        options=doc_options,
     )
+    result = StringList()
     if props is not None:
+        state = Mock()
+        bridge = DocumenterBridge(
+            app.env, LoggingReporter(''), doc_options, 1, state, safe_getattr
+        )
+        bridge.result = result
+        documenter = doccls(bridge, name)
         documenter.props = props
         documenter._generate()
-    return bridge.result
+    return result

tests/test_ext_autodoc/test_ext_autodoc.py

@@ -598,8 +598,6 @@ def _special_getattr(obj, attr_name, *defargs):
 def _assert_getter_works(app, directive, objtype, name, *attrs):
     getattr_spy.clear()
 
-    doccls = app.registry.documenters[objtype]
-    documenter = doccls(directive, name)
     props = _load_object_by_name(
         name=name,
         objtype=objtype,
@@ -610,9 +608,11 @@ def _assert_getter_works(app, directive, objtype, name, *attrs):
         env=app.env,
         events=app.events,
         get_attr=directive.get_attr,
-        options=documenter.options,
+        options=directive.genopt,
     )
     if props is not None:
+        doccls = app.registry.documenters[objtype]
+        documenter = doccls(directive, name)
         documenter.props = props
         documenter._generate()