summaryrefslogtreecommitdiff
path: root/test-requirements.txt
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2017-07-27 12:41:34 -0500
committerMonty Taylor <mordred@inaugust.com>2017-07-27 14:34:07 -0500
commitfb8f5a44bd3e828ce87f646ea82f4ce0dfe0c989 (patch)
treed39d97ab999e2837b29e65f8ea1f7621741055de /test-requirements.txt
parente63dcc62a5a791fa5a50fffab93cf673131ead21 (diff)
downloadzuul-fb8f5a44bd3e828ce87f646ea82f4ce0dfe0c989.tar.gz
Use mypy to do static type checking
python3 includes support for optional type annotations which can be used by static analysis tools to perform type checking. The mypy tool is a static type checking tool that can also infer type information in many cases, but which will use explicit type information if it is present. Add mypy to test-requirements and to the pep8 job so that our pep8 job can do more analysis work and less with the code style. To support this, there were a few places in the current codebase that needed an explicit type hint. For variables/attributes in 3.5 this is done via comments. There is a conditional import that was confusion that just got marked with an 'ignore'. Our ansible action and lookup plugins confuse mypi with the way they import the ansible base classes. That's ok - they confuse us with that too. The .pyi files are 'typeshed' files, which are a way that one can provide static type annotations without putting the information into the file itself. mypy will always prefer a .pyi file over a .py file (since the point of them is to be external annotion/interface description) So in order to get mypy to not barf on the ansible import weirdness, just add a corresponding empty .pyi file. We could potentially actually put interface descriptions in them - but I don't think there is very much value in that. It should be amusing to at least someone that we have to flake8: noqa an import from typing that was done to provide a type hint in a comment. Change-Id: I6c4ac3dcfc6fd990e6c6886749de147ad28389d1
Diffstat (limited to 'test-requirements.txt')
-rw-r--r--test-requirements.txt1
1 files changed, 1 insertions, 0 deletions
diff --git a/test-requirements.txt b/test-requirements.txt
index eea1d691e..914dcf019 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -14,3 +14,4 @@ sphinxcontrib-programoutput
oslosphinx
mock
PyMySQL
+mypy