Add object_name to _ItemProperties

Author: AA-Turner

sphinx/ext/autodoc/_documenters.py

@@ -263,7 +263,7 @@ def _load_object_by_name(self) -> Literal[True] | None:
         self.fullname = props.full_name
         self.module = module
         self.parent = parent
-        self.object_name = props.name
+        self.object_name = props.object_name
         self.object = props._obj
         if self.objtype == 'method':
             if 'staticmethod' in props.properties:  # type: ignore[attr-defined]

sphinx/ext/autodoc/_property_types.py

@@ -2,6 +2,8 @@
 
 import dataclasses
 
+from sphinx.ext.autodoc._sentinels import RUNTIME_INSTANCE_ATTRIBUTE, UNINITIALIZED_ATTR
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -33,8 +35,6 @@
 class _ItemProperties:
     #: The kind of object being documented
     obj_type: _AutodocObjType
-    #: The name of the item
-    name: str
     #: The dotted module name
     module_name: str
     #: The fully-qualified name within the module
@@ -44,9 +44,16 @@ class _ItemProperties:
 
     _obj: Any
 
-    # @property
-    # def name(self) -> str:
-    #     return self.module_name.rpartition('.')[2]
+    @property
+    def name(self) -> str:
+        """The name of the item"""
+        return self.parts[-1]
+
+    @property
+    def object_name(self) -> str:
+        if self._obj is RUNTIME_INSTANCE_ATTRIBUTE or self._obj is UNINITIALIZED_ATTR:
+            return ''
+        return self.name
 
     @property
     def full_name(self) -> str:
@@ -65,9 +72,17 @@ class _ModuleProperties(_ItemProperties):
     file_path: Path | None
     all: Sequence[str] | None
 
-    # @property
-    # def name(self) -> str:
-    #     return self.module_name.rpartition('.')[2]
+    @property
+    def name(self) -> str:
+        return self.module_name.rpartition('.')[2]
+
+    @property
+    def object_name(self) -> str:
+        return ''
+
+    @property
+    def full_name(self) -> str:
+        return self.module_name
 
     @property
     def parent_names(self) -> tuple[str, ...]:

sphinx/ext/autodoc/importer.py

@@ -819,7 +819,6 @@ def _load_object_by_name(
 
         props = _ModuleProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             docstring_lines=(),
             file_path=Path(file_path) if file_path is not None else None,
@@ -838,7 +837,6 @@ def _load_object_by_name(
 
         props = _ClassDefProperties(
             obj_type=objtype,  # type: ignore[arg-type]
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -854,7 +852,6 @@ def _load_object_by_name(
 
         props = _FunctionDefProperties(
             obj_type=objtype,  # type: ignore[arg-type]
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -871,7 +868,6 @@ def _load_object_by_name(
 
         props = _FunctionDefProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -891,7 +887,6 @@ def _load_object_by_name(
 
         props = _FunctionDefProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -917,7 +912,6 @@ def _load_object_by_name(
 
         props = _AssignStatementProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -957,7 +951,6 @@ def _load_object_by_name(
 
         props = _AssignStatementProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),
@@ -970,7 +963,6 @@ def _load_object_by_name(
     else:
         props = _ItemProperties(
             obj_type=objtype,
-            name=object_name,
             module_name=module_name,
             parts=parts,
             docstring_lines=(),

tests/test_extensions/test_ext_autodoc.py

@@ -163,8 +163,7 @@ def formatsig(objtype, name, obj, args, retann):
         inst.args = args
         inst.retann = retann
         inst.props = _ClassDefProperties(
-            obj_type=inst.objtype,
-            name=name,
+            obj_type=objtype,
             module_name=inst.modname,
             parts=(name,),
             docstring_lines=(),