Reduce autodoc test duration by up to four times (#14039)

Author: AA-Turner

sphinx/ext/autodoc/_directive_options.py

@@ -241,7 +241,7 @@ def __getattr__(self, name: str) -> Any:
 def _process_documenter_options(
     *,
     obj_type: _AutodocObjType,
-    default_options: dict[str, str | bool],
+    default_options: Mapping[str, str | bool],
     options: dict[str, str | None],
 ) -> _AutoDocumenterOptions:
     """Recognize options of object type from user input."""

tests/test_ext_autodoc/autodoc_util.py

@@ -1,44 +1,70 @@
 from __future__ import annotations
 
+from types import SimpleNamespace
 from typing import TYPE_CHECKING
 
 from docutils.statemachine import StringList
 
-from sphinx.ext.autodoc._directive_options import (
-    _process_documenter_options,
-)
+from sphinx.environment import _CurrentDocument
+from sphinx.events import EventManager
+from sphinx.ext.autodoc._directive_options import _process_documenter_options
 from sphinx.ext.autodoc._generate import _generate_directives
 from sphinx.ext.autodoc._loader import _load_object_by_name
 from sphinx.ext.autodoc._shared import _AutodocConfig
 from sphinx.util.inspect import safe_getattr
 
 if TYPE_CHECKING:
+    from collections.abc import Callable, Mapping
     from typing import Any
 
-    from sphinx.application import Sphinx
     from sphinx.ext.autodoc._property_types import _AutodocObjType
 
+_DEFAULT_CONFIG = _AutodocConfig()
+
+
+class FakeEvents(EventManager):
+    def __init__(self) -> None:
+        super().__init__(SimpleNamespace(pdb=False))  # type: ignore[arg-type]
+
+        self.add('autodoc-before-process-signature')
+        self.add('autodoc-process-docstring')
+        self.add('autodoc-process-signature')
+        self.add('autodoc-skip-member')
+        self.add('autodoc-process-bases')
+        self.add('object-description-transform')
+
+    def connect(
+        self, name: str, callback: Callable[..., Any], priority: int = 500
+    ) -> int:
+        return super().connect(name, callback, priority)
+
 
 def do_autodoc(
-    app: Sphinx,
     obj_type: _AutodocObjType,
     name: str,
+    *,
+    config: _AutodocConfig = _DEFAULT_CONFIG,
+    current_document: _CurrentDocument | None = None,
+    events: FakeEvents | None = None,
+    expect_import_error: bool = False,
     options: dict[str, Any] | None = None,
+    ref_context: Mapping[str, str | None] | None = None,
 ) -> list[str]:
+    if current_document is None:
+        current_document = _CurrentDocument(docname='index')
+    if events is None:
+        events = FakeEvents()
+    if ref_context is None:
+        ref_context = {}
+    reread_always: set[str] = set()
+
     options = {} if options is None else options.copy()
-    if not app.env.current_document.docname:
-        app.env.current_document.docname = 'index'  # set dummy docname
     doc_options = _process_documenter_options(
         obj_type=obj_type,
-        default_options=app.config.autodoc_default_options,
+        default_options=config.autodoc_default_options,
         options=options,
     )
 
-    config = _AutodocConfig.from_config(app.config)
-    current_document = app.env.current_document
-    events = app.events
-    ref_context = app.env.ref_context
-    reread_always: set[str] = set()
     props = _load_object_by_name(
         name=name,
         objtype=obj_type,
@@ -50,19 +76,23 @@ def do_autodoc(
         ref_context=ref_context,
         reread_always=reread_always,
     )
+    if expect_import_error:
+        assert props is None
+        return []
+
+    assert props is not None
     result = StringList()
-    if props is not None:
-        _generate_directives(
-            config=config,
-            current_document=current_document,
-            events=events,
-            get_attr=safe_getattr,
-            indent='',
-            options=doc_options,
-            props=props,
-            record_dependencies=set(),
-            ref_context=ref_context,
-            reread_always=reread_always,
-            result=result,
-        )
+    _generate_directives(
+        config=config,
+        current_document=current_document,
+        events=events,
+        get_attr=safe_getattr,
+        indent='',
+        options=doc_options,
+        props=props,
+        record_dependencies=set(),
+        ref_context=ref_context,
+        reread_always=reread_always,
+        result=result,
+    )
     return result.data

tests/test_ext_autodoc/conftest.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+import sys
+
+import pytest
+
+from tests.utils import TEST_ROOTS_DIR
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+
+@pytest.fixture(scope='module')
+def inject_autodoc_root_into_sys_path() -> Iterator[None]:
+    autodoc_root_path = str(TEST_ROOTS_DIR / 'test-ext-autodoc')
+
+    sys.path.insert(0, autodoc_root_path)
+    yield
+    sys.path[:] = [p for p in sys.path if p != autodoc_root_path]