Migrate to py3 style type annotation: sphinx.ext.autodoc.directive

sphinx/ext/autodoc/directive.py

@@ -7,27 +7,22 @@
 """
 
 import warnings
+from typing import Any, Callable, Dict, List, Set, Type
 
 from docutils import nodes
-from docutils.parsers.rst.states import Struct
+from docutils.nodes import Element, Node
+from docutils.parsers.rst.states import RSTState, Struct
 from docutils.statemachine import StringList
-from docutils.utils import assemble_option_dict
+from docutils.utils import Reporter, assemble_option_dict
 
+from sphinx.config import Config
 from sphinx.deprecation import RemovedInSphinx40Warning
-from sphinx.ext.autodoc import Options, get_documenters
+from sphinx.environment import BuildEnvironment
+from sphinx.ext.autodoc import Documenter, Options, get_documenters
 from sphinx.util import logging
 from sphinx.util.docutils import SphinxDirective, switch_source_input
 from sphinx.util.nodes import nested_parse_with_titles
 
-if False:
-    # For type annotation
-    from typing import Any, Callable, Dict, List, Set, Type  # NOQA
-    from docutils.parsers.rst.state import RSTState  # NOQA
-    from docutils.utils import Reporter  # NOQA
-    from sphinx.config import Config  # NOQA
-    from sphinx.environment import BuildEnvironment  # NOQA
-    from sphinx.ext.autodoc import Documenter  # NOQA
-
 logger = logging.getLogger(__name__)
 
 
@@ -41,21 +36,19 @@ AUTODOC_DEFAULT_OPTIONS = ['members', 'undoc-members', 'inherited-members',
 class DummyOptionSpec(dict):
     """An option_spec allows any options."""
 
-    def __bool__(self):
+    def __bool__(self) -> bool:
-        # type: () -> bool
         """Behaves like some options are defined."""
         return True
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str) -> Callable[[str], str]:
-        # type: (str) -> Callable[[str], str]
         return lambda x: x
 
 
 class DocumenterBridge:
     """A parameters container for Documenters."""
 
-    def __init__(self, env, reporter, options, lineno, state=None):
+    def __init__(self, env: BuildEnvironment, reporter: Reporter, options: Options,
-        # type: (BuildEnvironment, Reporter, Options, int, Any) -> None
+                 lineno: int, state: Any = None) -> None:
         self.env = env
         self.reporter = reporter
         self.genopt = options
@@ -73,13 +66,12 @@ class DocumenterBridge:
             document = Struct(settings=settings)
             self.state = Struct(document=document)
 
-    def warn(self, msg):
+    def warn(self, msg: str) -> None:
-        # type: (str) -> None
         logger.warning(msg, location=(self.env.docname, self.lineno))
 
 
-def process_documenter_options(documenter, config, options):
+def process_documenter_options(documenter: Type[Documenter], config: Config, options: Dict
-    # type: (Type[Documenter], Config, Dict) -> Options
+                               ) -> Options:
     """Recognize options of Documenter from user input."""
     for name in AUTODOC_DEFAULT_OPTIONS:
         if name not in documenter.option_spec:
@@ -92,12 +84,12 @@ def process_documenter_options(documenter, config, options):
     return Options(assemble_option_dict(options.items(), documenter.option_spec))
 
 
-def parse_generated_content(state, content, documenter):
+def parse_generated_content(state: RSTState, content: StringList, documenter: Documenter
-    # type: (RSTState, StringList, Documenter) -> List[nodes.Node]
+                            ) -> List[Node]:
     """Parse a generated content by Documenter."""
     with switch_source_input(state, content):
         if documenter.titles_allowed:
-            node = nodes.section()  # type: nodes.Element
+            node = nodes.section()  # type: Element
             # necessary so that the child nodes get the right source/line set
             node.document = state.document
             nested_parse_with_titles(state, content, node)
@@ -121,8 +113,7 @@ class AutodocDirective(SphinxDirective):
     optional_arguments = 0
     final_argument_whitespace = True
 
-    def run(self):
+    def run(self) -> List[Node]:
-        # type: () -> List[nodes.Node]
         reporter = self.state.document.reporter
 
         try: