8d59cc726c
This commit adds the tooling necessary to support gradual type annotation of the codebase: - Add mypy to test-requirements.txt - Add mypy configuration to pyproject.toml with a list of type-checked modules (initially empty, to be populated as modules are migrated) - Add tox mypy environment for running type checks - Add mypy pre-commit hook This follows the same pattern established in `ironic-prometheus-exporter`. Change-Id: Ie9e4b5ebccff4ce29b4e014c62f09594d968d721 Signed-off-by: Karan Anand <anandkarancompsci@gmail.com>
103 lines
3.1 KiB
INI
103 lines
3.1 KiB
INI
[tox]
|
|
minversion = 4.4.0
|
|
envlist = py3,pep8
|
|
|
|
[testenv]
|
|
constrain_package_deps = true
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
PYTHONDONTWRITEBYTECODE = 1
|
|
LANGUAGE=en_US
|
|
# .stestr.conf uses TESTS_DIR
|
|
TESTS_DIR=./ironicclient/tests/unit
|
|
usedevelop = True
|
|
deps =
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
-r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands =
|
|
stestr run {posargs}
|
|
|
|
[testenv:releasenotes]
|
|
deps =
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
-r{toxinidir}/doc/requirements.txt
|
|
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
|
|
|
[testenv:pep8]
|
|
deps =
|
|
hacking~=6.1.0 # Apache-2.0
|
|
doc8>=0.6.0 # Apache-2.0
|
|
flake8-import-order>=0.17.1 # LGPLv3
|
|
pycodestyle>=2.0.0,<3.0.0 # MIT
|
|
Pygments>=2.2.0 # BSD
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
commands =
|
|
flake8 {posargs}
|
|
doc8 doc/source CONTRIBUTING.rst README.rst
|
|
|
|
[testenv:cover]
|
|
setenv = {[testenv]setenv}
|
|
PYTHON=coverage run --source ironicclient --omit='*tests*' --parallel-mode
|
|
commands =
|
|
coverage erase
|
|
stestr run {posargs}
|
|
coverage combine
|
|
coverage report --omit='*tests*'
|
|
coverage html -d ./cover --omit='*tests*'
|
|
|
|
[testenv:venv]
|
|
deps =
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
-r{toxinidir}/test-requirements.txt
|
|
-r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/doc/requirements.txt
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
deps =
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
-r{toxinidir}/doc/requirements.txt
|
|
commands =
|
|
sphinx-build -W -b html doc/source doc/build/html
|
|
|
|
[testenv:pdf-docs]
|
|
allowlist_externals = make
|
|
deps = {[testenv:docs]deps}
|
|
commands =
|
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
|
make -C doc/build/pdf
|
|
|
|
[flake8]
|
|
ignore = W503
|
|
exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools
|
|
# [H106] Don't put vim configuration in source files.
|
|
# [H203] Use assertIs(Not)None to check for None.
|
|
# [H204] Use assert(Not)Equal to check for equality.
|
|
# [H205] Use assert(Greater|Less)(Equal) for comparison.
|
|
# [H210] Require 'autospec', 'spec', or 'spec_set' in mock.patch/mock.patch.object calls
|
|
# [H904] Delay string interpolations at logging calls.
|
|
enable-extensions=H106,H203,H204,H205,H210,H904
|
|
filename = *.py
|
|
import-order-style = pep8
|
|
application-import-names = ironicclient
|
|
|
|
[hacking]
|
|
import_exceptions = testtools.matchers, ironicclient.common.i18n
|
|
|
|
[testenv:codespell]
|
|
description =
|
|
Run codespell to check spelling
|
|
deps = codespell
|
|
# note(JayF): {posargs} lets us run `tox -ecodespell -- -w` to get codespell
|
|
# to correct spelling issues in our code it's aware of.
|
|
commands =
|
|
codespell {posargs}
|
|
|
|
[testenv:mypy]
|
|
description =
|
|
Run type checks using mypy
|
|
deps =
|
|
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
|
-r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands = mypy {posargs} |