Make sphinx.ext.autodoc._directive private (#14090)

Author: AA-Turner

sphinx/application.py

@@ -1627,7 +1627,7 @@ def add_autodocumenter(self, cls: type[Documenter], override: bool = False) -> N
            Add *override* keyword.
         """
         logger.debug('[app] adding autodocumenter: %r', cls)
-        from sphinx.ext.autodoc.directive import AutodocDirective
+        from sphinx.ext.autodoc._directive import AutodocDirective
 
         objtype = cls.objtype  # type: ignore[attr-defined]
         self.registry.add_documenter(objtype, cls)

sphinx/ext/autodoc/__init__.py

@@ -11,8 +11,8 @@
 
 import sphinx
 from sphinx.config import ENUM
+from sphinx.ext.autodoc._directive import AutodocDirective
 from sphinx.ext.autodoc._directive_options import (
-    Options,
     annotation_option,
     bool_option,
     class_doc_from_option,
@@ -29,7 +29,6 @@
 from sphinx.ext.autodoc._sentinels import ALL, EMPTY, SUPPRESS, UNINITIALIZED_ATTR
 from sphinx.ext.autodoc._sentinels import INSTANCE_ATTR as INSTANCEATTR
 from sphinx.ext.autodoc._sentinels import SLOTS_ATTR as SLOTSATTR
-from sphinx.ext.autodoc.directive import AutodocDirective
 from sphinx.ext.autodoc.typehints import _merge_typehints
 
 if TYPE_CHECKING:
@@ -44,7 +43,7 @@
     # This class is only used in ``sphinx.ext.autodoc.directive``,
     # but we export it here for compatibility.
     # See: https://github.com/sphinx-doc/sphinx/issues/4538
-    'Options',
+    # 'Options',
     # Option spec functions.
     # Exported for compatibility.
     'annotation_option',

sphinx/ext/autodoc/directive.py renamed to sphinx/ext/autodoc/_directive.py

@@ -20,7 +20,6 @@
 
     from sphinx.ext.autodoc._property_types import _AutodocObjType
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -64,14 +63,7 @@ class AutodocDirective(SphinxDirective):
     final_argument_whitespace = True
 
     def run(self) -> list[Node]:
-        reporter = self.state.document.reporter
-
-        try:
-            source, lineno = reporter.get_source_and_line(  # type: ignore[attr-defined]
-                self.lineno
-            )
-        except AttributeError:
-            source, lineno = (None, None)
+        source, lineno = self.get_source_info()
         logger.debug('[autodoc] %s:%s: input:\n%s', source, lineno, self.block_text)
 
         # get target object type / strip prefix (auto-)

sphinx/ext/autodoc/_directive_options.py

@@ -169,22 +169,6 @@ def merge_members_option(options: dict[str, Any]) -> None:
                     members.append(member)
 
 
-class Options(dict[str, object]):  # NoQA: FURB189
-    """A dict/attribute hybrid that returns None on nonexisting keys."""
-
-    def __repr__(self) -> str:
-        return f'Options({super().__repr__()})'
-
-    def copy(self) -> Options:
-        return Options(super().copy())
-
-    def __getattr__(self, name: str) -> Any:
-        try:
-            return self[name.replace('_', '-')]
-        except KeyError:
-            return None
-
-
 _OPTION_SPEC_COMMON: Final[OptionSpec] = {
     'no-index': bool_option,
     'no-index-entry': bool_option,