c8b44ae95b
- Fix TODO tag to use the correct username. - Consolidate from typing imports onto one line per file where flake8 allows. - Rework pyproject.toml: strict mypy, check all of ironicclient/, overrides for tests (relaxed defs + disabled noisy error codes); incremental on. - Adjust production code for the stricter checker (generics, list() returns, casts / ignores as needed). - Remove the pre-commit mypy hook. Running mypy there duplicates dependency pins and cannot use upper-constraints the way tox does; tox keeps one dependency graph for the project and ensures mypy runs in the same gate as the rest of CI (see Stephen's rationale on running mypy from tox). - Fix codespell typos in release notes and node docstring. Related: https://review.opendev.org/c/openstack/python-ironicclient/+/981228 Change-Id: I723d8c826f4e7e4e96b8ac44cda3a4143c314a11 Signed-off-by: Karan Anand <anandkarancompsci@gmail.com>
110 lines
3.0 KiB
INI
110 lines
3.0 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]
|
|
description =
|
|
Run style checks.
|
|
deps =
|
|
hacking~=7.0.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
|
|
{[testenv:mypy]deps}
|
|
commands =
|
|
flake8 {posargs}
|
|
doc8 doc/source CONTRIBUTING.rst README.rst
|
|
{[testenv:mypy]commands}
|
|
|
|
[testenv:mypy]
|
|
description =
|
|
Run type checks.
|
|
deps =
|
|
{[testenv]deps}
|
|
commands =
|
|
mypy --cache-dir="{envdir}/mypy_cache" {posargs}
|
|
|
|
[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 =
|
|
collections.abc
|
|
ironicclient.common.i18n
|
|
testtools.matchers
|
|
typing
|
|
|
|
[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}
|