Use _AutodocObjType more consistently (#13970)

Author: AA-Turner

sphinx/ext/autodoc/_member_finder.py

@@ -36,7 +36,7 @@
     from sphinx.events import EventManager
     from sphinx.ext.autodoc import Documenter
     from sphinx.ext.autodoc._directive_options import _AutoDocumenterOptions
-    from sphinx.ext.autodoc._property_types import _ItemProperties
+    from sphinx.ext.autodoc._property_types import _AutodocObjType, _ItemProperties
     from sphinx.ext.autodoc._sentinels import (
         ALL_T,
         EMPTY_T,
@@ -553,7 +553,7 @@ def _best_object_type_for_member(
     *,
     parent_obj_type: str,
     parent_props: _ItemProperties | None,
-) -> str | None:
+) -> _AutodocObjType | None:
     """Return the best object type that supports documenting *member*."""
     filtered = []
 
@@ -618,7 +618,7 @@ def _best_object_type_for_member(
 
     if filtered:
         # return the highest priority object type
-        return max(filtered, key=operator.itemgetter(0))[1]
+        return max(filtered, key=operator.itemgetter(0))[1]  # type: ignore[return-value]
     return None
 
 

sphinx/ext/autodoc/importer.py

@@ -999,7 +999,7 @@ def _parse_name(
 
 def _resolve_name(
     *,
-    objtype: str,
+    objtype: _AutodocObjType,
     module_name: str | None,
     path: str | None,
     base: str,

sphinx/ext/autodoc/typehints.py

@@ -20,12 +20,13 @@
 
     from sphinx.application import Sphinx
     from sphinx.ext.autodoc._directive_options import _AutoDocumenterOptions
+    from sphinx.ext.autodoc._property_types import _AutodocObjType
     from sphinx.util.typing import ExtensionMetadata, _StringifyMode
 
 
 def record_typehints(
     app: Sphinx,
-    objtype: str,
+    obj_type: _AutodocObjType,
     name: str,
     obj: Any,
     options: _AutoDocumenterOptions,
@@ -60,7 +61,7 @@ def record_typehints(
 
 
 def merge_typehints(
-    app: Sphinx, domain: str, objtype: str, contentnode: Element
+    app: Sphinx, domain: str, obj_type: _AutodocObjType, contentnode: Element
 ) -> None:
     if domain != 'py':
         return
@@ -86,7 +87,7 @@ def merge_typehints(
 
         for field_list in field_lists:
             if app.config.autodoc_typehints_description_target == 'all':
-                if objtype == 'class':
+                if obj_type == 'class':
                     modify_field_list(
                         field_list, annotations[fullname], suppress_rtype=True
                     )

sphinx/ext/autosummary/__init__.py

@@ -95,6 +95,7 @@
     from sphinx.application import Sphinx
     from sphinx.environment import BuildEnvironment
     from sphinx.ext.autodoc import Documenter
+    from sphinx.ext.autodoc._property_types import _AutodocObjType
     from sphinx.registry import SphinxComponentRegistry
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
     from sphinx.writers.html5 import HTML5Translator
@@ -166,7 +167,7 @@ def get_documenter(app: Sphinx, obj: Any, parent: Any) -> type[Documenter]:
     return app.registry.documenters[obj_type]
 
 
-def _get_documenter(obj: Any, parent: Any) -> str:
+def _get_documenter(obj: Any, parent: Any) -> _AutodocObjType:
     """Get an autodoc.Documenter class suitable for documenting the given
     object.
 

sphinx/ext/autosummary/generate.py

@@ -68,6 +68,7 @@
     from sphinx.application import Sphinx
     from sphinx.events import EventManager
     from sphinx.ext.autodoc import Documenter
+    from sphinx.ext.autodoc._property_types import _AutodocObjType
 
 logger = logging.getLogger(__name__)
 
@@ -223,20 +224,18 @@ def __init__(
         *,
         config: Config,
         events: EventManager,
-        registry: SphinxComponentRegistry,
     ) -> None:
         self.config = config
         self.events = events
-        self.registry = registry
         self.object = obj
 
     def get_object_type(self, name: str, value: Any) -> str:
         return _get_documenter(value, self.object)
 
-    def is_skipped(self, name: str, value: Any, objtype: str) -> bool:
+    def is_skipped(self, name: str, value: Any, obj_type: _AutodocObjType) -> bool:
         try:
             return self.events.emit_firstresult(
-                'autodoc-skip-member', objtype, name, value, False, {}
+                'autodoc-skip-member', obj_type, name, value, False, {}
             )
         except Exception as exc:
             logger.warning(
@@ -323,16 +322,14 @@ def generate_autosummary_content(
     *,
     config: Config,
     events: EventManager,
-    registry: SphinxComponentRegistry,
 ) -> str:
     obj_type = _get_documenter(obj, parent)
-    doc = registry.documenters[obj_type]
 
     ns: dict[str, Any] = {}
     ns.update(context)
 
-    if doc.objtype == 'module':
-        scanner = ModuleScanner(obj, config=config, events=events, registry=registry)
+    if obj_type == 'module':
+        scanner = ModuleScanner(obj, config=config, events=events)
         ns['members'] = scanner.scan(imported_members)
 
         respect_module_all = not config.autosummary_ignore_module_all
@@ -341,30 +338,27 @@ def generate_autosummary_content(
         )
 
         ns['functions'], ns['all_functions'] = _get_members(
-            doc,
+            obj_type,
             obj,
             {'function'},
             config=config,
             events=events,
-            registry=registry,
             imported=imported_members,
         )
         ns['classes'], ns['all_classes'] = _get_members(
-            doc,
+            obj_type,
             obj,
             {'class'},
             config=config,
             events=events,
-            registry=registry,
             imported=imported_members,
         )
         ns['exceptions'], ns['all_exceptions'] = _get_members(
-            doc,
+            obj_type,
             obj,
             {'exception'},
             config=config,
             events=events,
-            registry=registry,
             imported=imported_members,
         )
         ns['attributes'], ns['all_attributes'] = _get_module_attrs(name, ns['members'])
@@ -387,12 +381,11 @@ def generate_autosummary_content(
             # Otherwise, use get_modules method normally
             if respect_module_all and '__all__' in dir(obj):
                 imported_modules, all_imported_modules = _get_members(
-                    doc,
+                    obj_type,
                     obj,
                     {'module'},
                     config=config,
                     events=events,
-                    registry=registry,
                     imported=True,
                 )
                 skip += all_imported_modules
@@ -406,34 +399,32 @@ def generate_autosummary_content(
             )
             ns['modules'] = imported_modules + modules
             ns['all_modules'] = all_imported_modules + all_modules
-    elif doc.objtype == 'class':
+    elif obj_type == 'class':
         ns['members'] = dir(obj)
         ns['inherited_members'] = set(dir(obj)) - set(obj.__dict__.keys())
         ns['methods'], ns['all_methods'] = _get_members(
-            doc,
+            obj_type,
             obj,
             {'method'},
             config=config,
             events=events,
-            registry=registry,
             include_public={'__init__'},
         )
         ns['attributes'], ns['all_attributes'] = _get_members(
-            doc,
+            obj_type,
             obj,
             {'attribute', 'property'},
             config=config,
             events=events,
-            registry=registry,
         )
 
     if modname is None or qualname is None:
         modname, qualname = _split_full_qualified_name(name)
 
-    if doc.objtype in {'method', 'attribute', 'property'}:
+    if obj_type in {'method', 'attribute', 'property'}:
         ns['class'] = qualname.rsplit('.', 1)[0]
 
-    if doc.objtype == 'class':
+    if obj_type == 'class':
         shortname = qualname
     else:
         shortname = qualname.rsplit('.', 1)[-1]
@@ -443,19 +434,21 @@ def generate_autosummary_content(
     ns['objname'] = qualname
     ns['name'] = shortname
 
-    ns['objtype'] = doc.objtype
+    ns['objtype'] = obj_type
     ns['underline'] = len(name) * '='
 
     if template_name:
         return template.render(template_name, ns)
     else:
-        return template.render(doc.objtype, ns)
+        return template.render(obj_type, ns)
 
 
-def _skip_member(obj: Any, name: str, objtype: str, *, events: EventManager) -> bool:
+def _skip_member(
+    obj: Any, name: str, obj_type: _AutodocObjType, *, events: EventManager
+) -> bool:
     try:
         return events.emit_firstresult(
-            'autodoc-skip-member', objtype, name, obj, False, {}
+            'autodoc-skip-member', obj_type, name, obj, False, {}
         )
     except Exception as exc:
         logger.warning(
@@ -554,37 +547,35 @@ def _get_module_members(obj: Any, *, config: Config) -> dict[str, Any]:
 
 
 def _get_all_members(
-    doc: type[Documenter], obj: Any, *, config: Config
+    obj_type: _AutodocObjType, obj: Any, *, config: Config
 ) -> dict[str, Any]:
-    if doc.objtype == 'module':
+    if obj_type == 'module':
         return _get_module_members(obj, config=config)
-    elif doc.objtype == 'class':
+    elif obj_type == 'class':
         return _get_class_members(obj)
     return {}
 
 
 def _get_members(
-    doc: type[Documenter],
+    obj_type: _AutodocObjType,
     obj: Any,
     types: set[str],
     *,
     config: Config,
     events: EventManager,
-    registry: SphinxComponentRegistry,
     include_public: Set[str] = frozenset(),
     imported: bool = True,
 ) -> tuple[list[str], list[str]]:
     items: list[str] = []
     public: list[str] = []
 
-    all_members = _get_all_members(doc, obj, config=config)
+    all_members = _get_all_members(obj_type, obj, config=config)
     for name, value in all_members.items():
         obj_type = _get_documenter(value, obj)
-        documenter = registry.documenters[obj_type]
-        if documenter.objtype in types:
+        if obj_type in types:
             # skip imported members if expected
             if imported or getattr(value, '__module__', None) == obj.__name__:
-                skipped = _skip_member(value, name, documenter.objtype, events=events)
+                skipped = _skip_member(value, name, obj_type, events=events)
                 if skipped is True:
                     pass
                 elif skipped is False:
@@ -737,7 +728,6 @@ def generate_autosummary_docs(
             qualname,
             config=app.config,
             events=app.events,
-            registry=app.registry,
         )
 
         file_path = Path(path, filename_map.get(name, name) + suffix)

tests/test_ext_autodoc/autodoc_util.py

@@ -18,18 +18,19 @@
     from docutils.statemachine import StringList
 
     from sphinx.application import Sphinx
+    from sphinx.ext.autodoc._property_types import _AutodocObjType
 
 
 def do_autodoc(
     app: Sphinx,
-    objtype: str,
+    obj_type: _AutodocObjType,
     name: str,
     options: dict[str, Any] | None = None,
 ) -> StringList:
     options = {} if options is None else options.copy()
     if not app.env.current_document.docname:
         app.env.current_document.docname = 'index'  # set dummy docname
-    doccls = app.registry.documenters[objtype]
+    doccls = app.registry.documenters[obj_type]
     opts = _process_documenter_options(
         option_spec=doccls.option_spec,
         default_options=app.config.autodoc_default_options,

tests/test_ext_autosummary/test_ext_autosummary.py

@@ -257,7 +257,6 @@ def test_autosummary_generate_content_for_module(app):
         {},
         config=app.config,
         events=app.events,
-        registry=app.registry,
     )
     assert template.render.call_args[0][0] == 'module'
 
@@ -320,7 +319,6 @@ def test_autosummary_generate_content_for_module___all__(app):
         {},
         config=app.config,
         events=app.events,
-        registry=app.registry,
     )
     assert template.render.call_args[0][0] == 'module'
 
@@ -372,7 +370,6 @@ def skip_member(app, what, name, obj, skip, options):
         {},
         config=app.config,
         events=app.events,
-        registry=app.registry,
     )
     context = template.render.call_args[0][1]
     assert context['members'] == [
@@ -414,7 +411,6 @@ def test_autosummary_generate_content_for_module_imported_members(app):
         {},
         config=app.config,
         events=app.events,
-        registry=app.registry,
     )
     assert template.render.call_args[0][0] == 'module'
 
@@ -486,7 +482,6 @@ def test_autosummary_generate_content_for_module_imported_members_inherited_modu
         {},
         config=app.config,
         events=app.events,
-        registry=app.registry,
     )
     assert template.render.call_args[0][0] == 'module'