Add type-check annotations to sphinx.*

1 files changed, 22 insertions, 13 deletions

diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py
index c23f22228..f263f8df1 100644
--- a/sphinx/setup_command.py
+++ b/sphinx/setup_command.py
@@ -18,7 +18,7 @@ import os
 
 from six import StringIO, string_types
 from distutils.cmd import Command
-from distutils.errors import DistutilsOptionError, DistutilsExecError
+from distutils.errors import DistutilsOptionError, DistutilsExecError  # type: ignore
 
 from sphinx.application import Sphinx
 from sphinx.cmdline import handle_exception
@@ -26,6 +26,10 @@ from sphinx.util.console import nocolor, color_terminal
 from sphinx.util.docutils import docutils_namespace
 from sphinx.util.osutil import abspath
 
+if False:
+    # For type annotation
+    from typing import Any  # NOQA
+
 
 class BuildDoc(Command):
     """
@@ -87,22 +91,24 @@ class BuildDoc(Command):
                        'link-index']
 
     def initialize_options(self):
+        # type: () -> None
         self.fresh_env = self.all_files = False
         self.pdb = False
-        self.source_dir = self.build_dir = None
+        self.source_dir = self.build_dir = None  # type: unicode
         self.builder = 'html'
         self.warning_is_error = False
         self.project = ''
         self.version = ''
         self.release = ''
         self.today = ''
-        self.config_dir = None
+        self.config_dir = None  # type: unicode
         self.link_index = False
         self.copyright = ''
         self.verbosity = 0
         self.traceback = False
 
     def _guess_source_dir(self):
+        # type: () -> unicode
         for guess in ('doc', 'docs'):
             if not os.path.isdir(guess):
                 continue
@@ -115,6 +121,7 @@ class BuildDoc(Command):
     # unicode, causing finalize_options to fail if invoked again. Workaround
     # for http://bugs.python.org/issue19570
     def _ensure_stringlike(self, option, what, default=None):
+        # type: (unicode, unicode, Any) -> Any
         val = getattr(self, option)
         if val is None:
             setattr(self, option, default)
@@ -125,10 +132,11 @@ class BuildDoc(Command):
         return val
 
     def finalize_options(self):
+        # type: () -> None
         if self.source_dir is None:
             self.source_dir = self._guess_source_dir()
-            self.announce('Using source directory %s' % self.source_dir)
-        self.ensure_dirname('source_dir')
+            self.announce('Using source directory %s' % self.source_dir)  # type: ignore
+        self.ensure_dirname('source_dir')  # type: ignore
         if self.source_dir is None:
             self.source_dir = os.curdir
         self.source_dir = abspath(self.source_dir)
@@ -137,22 +145,23 @@ class BuildDoc(Command):
         self.config_dir = abspath(self.config_dir)
 
         if self.build_dir is None:
-            build = self.get_finalized_command('build')
+            build = self.get_finalized_command('build')  # type: ignore
             self.build_dir = os.path.join(abspath(build.build_base), 'sphinx')
-            self.mkpath(self.build_dir)
+            self.mkpath(self.build_dir)  # type: ignore
         self.build_dir = abspath(self.build_dir)
         self.doctree_dir = os.path.join(self.build_dir, 'doctrees')
-        self.mkpath(self.doctree_dir)
+        self.mkpath(self.doctree_dir)  # type: ignore
         self.builder_target_dir = os.path.join(self.build_dir, self.builder)
-        self.mkpath(self.builder_target_dir)
+        self.mkpath(self.builder_target_dir)  # type: ignore
 
     def run(self):
+        # type: () -> None
         if not color_terminal():
             nocolor()
-        if not self.verbose:
+        if not self.verbose:  # type: ignore
             status_stream = StringIO()
         else:
-            status_stream = sys.stdout
+            status_stream = sys.stdout  # type: ignore
         confoverrides = {}
         if self.project:
             confoverrides['project'] = self.project
@@ -182,6 +191,6 @@ class BuildDoc(Command):
                 raise SystemExit(1)
 
         if self.link_index:
-            src = app.config.master_doc + app.builder.out_suffix
-            dst = app.builder.get_outfilename('index')
+            src = app.config.master_doc + app.builder.out_suffix  # type: ignore
+            dst = app.builder.get_outfilename('index')  # type: ignore
             os.symlink(src, dst)