20200602 type hints part1 (Project-MONAI#477)

* DOC: Type hints support for the Sphinx autodoc extension

https://github.com/agronholm/sphinx-autodoc-typehints

* setup.cfg to ignore pep484 warnings related to refactoring

These temporary changes are needed in order to decouple
adding typehints in separate PR's to a completely
clean typehint checked system.  It is not possible
to have small independant commits and exhaustive
typehint checking over the entire package.

* Add .gitignore for .pyre temporary files.

Author: hjmjohnson

.gitignore

@@ -110,3 +110,14 @@ temp/
 .idea/
 
 *~
+
+# Remove .pyre temporary config files
+.pyre
+.pyre_configuration
+
+# temporary editor files that should not be in git
+.orig
+.bak
+.swp
+*~
+.DS_Store

docs/requirements.txt

@@ -17,3 +17,4 @@ sphinxcontrib-htmlhelp==1.0.2
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.2
 sphinxcontrib-serializinghtml==1.1.3
+sphinx-autodoc-typehints>=1.10.3

setup.cfg

@@ -36,6 +36,16 @@ ignore =
     N812
     # suppress flake8-mypy failures occuring when MYPYPATH=${src_dir}/monai/monai
     T499
+# --- Temporary disabling to allow smaller PRs
+# Subsequent fixes necessary to make this tool pass are not yet
+# merged into the master branch, but requested as separate
+# commits.  Can not enable until all outstanding typehint
+# PR's are approved
+    T484
+# Unused imports may be used later, disable warning while we
+# separate many PR's
+    F401
+# ^^^^^^^^^ Temporary disabling to allow smaller PRs
 per-file-ignores = __init__.py: F401
 exclude = *.pyi,.git,monai/_version.py,versioneer.py
 
@@ -48,11 +58,27 @@ tag_prefix =
 parentdir_prefix =
 
 [mypy]
+# --- Temporary disabling to allow smaller PRs
+# Subsequent fixes necessary to make this tool pass are not yet
+# merged into the master branch, but requested as separate
+# commits.  Can not enable until all outstanding typehint
+# PR's are approved
+ignore_errors = True  ## Temporarily disable all mypy warnings
+# ^^^^^^ Temporary disabling to allow smaller PRs
+
+
 # do not follow imports (except for ones found in typeshed)
 follow_imports=normal
 
 # suppress errors about unsatisfied imports
-ignore_missing_imports=False
+# The pytorch-ignite package is not type hinted and generates
+# hundreds of failures that are not the priority to address
+# at the monment.  Eventually ignore_missing_imports=False
+# should be used add consistent typing information to
+# those parts of the MONAI package that depend on ignite.
+ignore_missing_imports=True
+# Temporarily ignore all site packages too
+# --no_site_packages=True
 
 # allow returning Any as a consequence of the options above
 warn_return_any=True
@@ -63,10 +89,25 @@ warn_no_return=True
 # lint-style cleanliness for typing needs to be disabled; returns more errors
 # than the full run.
 warn_redundant_casts=True
-warn_unused_ignores=True
-# NOTE: All relative paths are relative to the location of this file.
+warn_unused_ignores=False
+
+[mypy-torch.*]
+# --- Temporary disabling to allow smaller PRs
+# Subsequent fixes necessary to make this tool pass are not yet
+# merged into the master branch, but requested as separate
+# commits.  Can not enable until all outstanding typehint
+# PR's are approved
+ignore_errors = True  ## Temporarily disable all mypy warnings
+# ^^^^^^ Temporary disabling to allow smaller PRs
+follow_imports = skip
+follow_imports_for_stubs = True
+
+[mypy-monai._version]
+# Always ignore any type issues in teh monai/._version file
+ignore_errors = True
 
 [pytype]
+# NOTE: All relative paths are relative to the location of this file.
 # Space-separated list of files or directories to exclude.
 exclude = **/*_test.py **/test_*.py
 # Space-separated list of files or directories to process.