Avoid using Documenter.name (#13975)

Author: AA-Turner

sphinx/ext/autodoc/_documenters.py

@@ -86,7 +86,7 @@ class Documenter:
     }
 
     def __init__(
-        self, directive: DocumenterBridge, name: str, indent: str = ''
+        self, directive: DocumenterBridge, orig_name: str, indent: str = ''
     ) -> None:
         self.directive = directive
         self.config: Config = directive.env.config
@@ -95,7 +95,7 @@ def __init__(
         self._events: EventManager = directive.env.events
         self.options: _AutoDocumenterOptions = directive.genopt
         self.get_attr = directive.get_attr
-        self.name = name
+        self.orig_name = orig_name
         self.indent: Final = indent
         # the parent/owner of the object to document
         self.parent: Any = None
@@ -122,15 +122,15 @@ def add_line(self, line: str, source: str, *lineno: int, indent: str) -> None:
             self.directive.result.append('', source, *lineno)
 
     def _load_object_by_name(self) -> Literal[True] | None:
-        """Import the object given by *self.name*.
+        """Import the object given by *self.orig_name*.
 
         Returns True if parsing and resolving was successful, otherwise None.
         """
         if self._load_object_has_been_called:
             return True
 
         ret = _load_object_by_name(
-            name=self.name,
+            name=self.orig_name,
             objtype=self.objtype,  # type: ignore[arg-type]
             mock_imports=self.config.autodoc_mock_imports,
             type_aliases=self.config.autodoc_type_aliases,
@@ -359,7 +359,7 @@ def generate(
         check_module: bool = False,
         all_members: bool = False,
     ) -> None:
-        """Generate reST for the object given by *self.name*, and possibly for
+        """Generate reST for the object given by *self.orig_name*, and possibly for
         its members.
 
         If *more_content* is given, include that content. If *real_modname* is
@@ -433,7 +433,7 @@ def _generate(
         if ismock(self.props._obj) and not has_docstring:
             logger.warning(
                 __('A mocked object is detected: %r'),
-                self.name,
+                self.props.full_name,
                 type='autodoc',
                 subtype='mocked_object',
             )
@@ -475,7 +475,6 @@ def _generate(
             events=self._events,
             get_attr=self.get_attr,
             indent=indent,
-            name=self.name,
             options=self.options,
             props=self.props,
             real_modname=self.real_modname,

sphinx/ext/autodoc/_member_finder.py

@@ -101,7 +101,6 @@ def _document_members(
     events: EventManager,
     get_attr: _AttrGetter,
     indent: str,
-    name: str,
     options: _AutoDocumenterOptions,
     props: _ItemProperties,
     real_modname: str,
@@ -129,7 +128,6 @@ def _document_members(
         directive=directive,
         events=events,
         get_attr=get_attr,
-        name=name,
         options=options,
         props=props,
         registry=registry,
@@ -167,7 +165,6 @@ def _gather_members(
     directive: DocumenterBridge,
     events: EventManager,
     get_attr: _AttrGetter,
-    name: str,
     options: _AutoDocumenterOptions,
     props: _ItemProperties,
     registry: SphinxComponentRegistry,
@@ -207,7 +204,6 @@ def _gather_members(
         get_attr=get_attr,
         inherit_docstrings=config.autodoc_inherit_docstrings,
         options=options,
-        orig_name=name,
         props=props,
         inherited_members=inherited_members,
         exclude_members=options.exclude_members,
@@ -233,9 +229,9 @@ def _gather_members(
         doccls = registry.documenters[obj_type]
         # give explicitly separated module name, so that members
         # of inner classes can be documented
-        module_prefix = f'{props.module_name}::'
-        full_mname = module_prefix + '.'.join((*props.parts, member_name))
-        documenter = doccls(directive, full_mname, indent)
+        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
@@ -476,7 +472,6 @@ def _filter_members(
     events: EventManager,
     get_attr: _AttrGetter,
     options: _AutoDocumenterOptions,
-    orig_name: str,
     props: _ModuleProperties | _ClassDefProperties,
     inherit_docstrings: bool,
     inherited_members: Set[str],
@@ -517,7 +512,7 @@ def _filter_members(
                     'autodoc: failed to determine %s.%s (%r) to be documented, '
                     'the following exception was raised:\n%s'
                 ),
-                orig_name,
+                props.full_name,
                 member_name,
                 member_obj,
                 exc,
@@ -633,7 +628,10 @@ def _sort_members(
     """Sort the given member list."""
     if order == 'groupwise':
         # sort by group; alphabetically within groups
-        documenters.sort(key=lambda e: (e[0].props._groupwise_order_key, e[0].name))
+        def group_order(entry: tuple[Documenter, bool]) -> tuple[int, str]:
+            return entry[0].props._groupwise_order_key, entry[0].props.full_name
+
+        documenters.sort(key=group_order)
     elif order == 'bysource':
         if (
             isinstance(props, _ModuleProperties)
@@ -644,25 +642,25 @@ def _sort_members(
             module_all_idx = {name: idx for idx, name in enumerate(module_all)}
             module_all_len = len(module_all)
 
-            def key_func(entry: tuple[Documenter, bool]) -> int:
-                fullname = entry[0].name.split('::')[1]
+            def source_order(entry: tuple[Documenter, bool]) -> int:
+                fullname = entry[0].props.dotted_parts
                 return module_all_idx.get(fullname, module_all_len)
 
-            documenters.sort(key=key_func)
+            documenters.sort(key=source_order)
 
         # By default, member discovery order matches source order,
         # as dicts are insertion-ordered from Python 3.7.
         elif analyzer_order:
             # sort by source order, by virtue of the module analyzer
             order_len = len(analyzer_order)
 
-            def key_func(entry: tuple[Documenter, bool]) -> int:
-                fullname = entry[0].name.split('::')[1]
+            def source_order(entry: tuple[Documenter, bool]) -> int:
+                fullname = entry[0].props.dotted_parts
                 return analyzer_order.get(fullname, order_len)
 
-            documenters.sort(key=key_func)
+            documenters.sort(key=source_order)
     else:  # alphabetical
-        documenters.sort(key=lambda e: e[0].name)
+        documenters.sort(key=lambda entry: entry[0].props.full_name)
 
     return documenters
 

sphinx/ext/autosummary/__init__.py

@@ -364,11 +364,12 @@ 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 = self.env._registry.documenters[obj_type]
-            full_name = real_name
-            if not isinstance(obj, ModuleType):
+            if isinstance(obj, ModuleType):
+                full_name = real_name
+            else:
                 # give explicitly separated module name, so that members
                 # of inner classes can be documented
-                full_name = modname + '::' + full_name[len(modname) + 1 :]
+                full_name = f'{modname}::{real_name[len(modname) + 1 :]}'
             # NB. using full_name here is important, since Documenters
             #     handle module prefixes slightly differently
             self.bridge.result = result