envlist =

flake8, mypy, black

test-py{26,27,34,35,36,37,38,py2,py3}

coverage_report

docs

packaging

skip_missing_interpreters = {tty:True:False}

basepython = python3.8

deps =

idna==2.9

test: typing==3.7.4.1

test: {[testenv:coverage_report]deps}

test-{py26,py27,py34}: pytest==4.6.9

test-{py35,py36,py37,py38}: pytest==5.2.4

test: pytest-cov==2.8.1

setenv =

PY_MODULE=hyperlink

PYTHONPYCACHEPREFIX={envtmpdir}/pycache

description = run tests

basepython =

py26: python2.6

py27: python2.7

py34: python3.4

py35: python3.5

py36: python3.6

py37: python3.7

py38: python3.8

py39: python3.9

pypy2: pypy

pypy3: pypy3

deps = {[default]deps}

setenv =

{[default]setenv}

test: COVERAGE_FILE={toxworkdir}/coverage.{envname}

commands =

test: pytest --cov={env:PY_MODULE} --cov-report=term-missing:skip-covered --doctest-modules {posargs:src/{env:PY_MODULE}}

description = run Black (linter)

basepython = {[default]basepython}

skip_install = True

deps =

black==19.10b0

setenv =

BLACK_LINT_ARGS=--check

commands =

black {env:BLACK_LINT_ARGS:} src

description = {[testenv:black]description} and reformat

basepython = {[testenv:black]basepython}

skip_install = {[testenv:black]skip_install}

deps = {[testenv:black]deps}

commands = {[testenv:black]commands}

description = run Flake8 (linter)

basepython = {[default]basepython}

skip_install = True

deps =

flake8-bugbear==20.1.4

flake8==3.7.9

mccabe==0.6.1

pep8-naming==0.10.0

pycodestyle==2.5.0

pydocstyle==5.0.2

# pin pyflakes pending a release with https://github.com/PyCQA/pyflakes/pull/455

git+git://github.com/PyCQA/pyflakes@ffe9386#egg=pyflakes

commands =

flake8 {posargs:src/{env:PY_MODULE}}

select = A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z

show-source = True

doctests = True

max-line-length = 80

ignore =

# syntax error in type comment

F723,

# function name should be lowercase

N802,

# argument name should be lowercase

N803,

# variable in function should be lowercase

N806,

# variable in class scope should not be mixedCase

N815,

# variable in global scope should not be mixedCase

N816,

# line break before binary operator

W503,

# line break after binary operator

W504,

# End of list (allows last item to end with trailing ',')

EOL

application-import-names = deploy

description = run Mypy (static type checker)

basepython = {[default]basepython}

deps =

mypy==0.770

{[default]deps}

commands =

mypy \

--config-file="{toxinidir}/tox.ini" \

--cache-dir="{toxworkdir}/mypy_cache" \

{tty:--pretty:} \

{posargs:src}

check_untyped_defs = True

disallow_any_generics = True

disallow_incomplete_defs = True

disallow_untyped_defs = True

no_implicit_optional = True

show_column_numbers = True

show_error_codes = True

strict_optional = True

warn_no_return = True

warn_redundant_casts = True

warn_return_any = True

warn_unreachable = True

warn_unused_ignores = True

ignore_missing_imports = True

description = generate coverage report

depends = test-py{26,27,34,35,36,37,38,py,py3}

basepython = {[default]basepython}

skip_install = True

deps =

coverage==4.5.4 # rq.filter: <5 # coverage 5.0 drops Python 3.4 support

setenv =

{[default]setenv}

COVERAGE_FILE={toxworkdir}/coverage

commands =

coverage combine

- coverage report

- coverage html

description = upload coverage to Codecov

depends = {[coverage_report]depends}

basepython = python

skip_install = True

deps =

{[testenv:coverage_report]deps}

codecov==2.0.22

passenv =

# See https://github.com/codecov/codecov-python/blob/master/README.md#using-tox

# And CI-specific docs:

# https://help.github.com/en/articles/virtual-environments-for-github-actions#default-environment-variables

# https://docs.travis-ci.com/user/environment-variables#default-environment-variables

# https://www.appveyor.com/docs/environment-variables/

TOXENV CODECOV_* CI

GITHUB_*

TRAVIS TRAVIS_*

APPVEYOR APPVEYOR_*

setenv =

{[testenv:coverage_report]setenv}

COVERAGE_XML={envlogdir}/coverage_report.xml

commands =

# Note documentation for CI variables in passenv above

coverage combine

coverage xml -o "{env:COVERAGE_XML}"

codecov --file="{env:COVERAGE_XML}" --env \

GITHUB_REF GITHUB_COMMIT GITHUB_USER GITHUB_WORKFLOW \

TRAVIS_BRANCH TRAVIS_BUILD_WEB_URL \

TRAVIS_COMMIT TRAVIS_COMMIT_MESSAGE \

APPVEYOR_REPO_BRANCH APPVEYOR_REPO_COMMIT \

APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL \

APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED

description = build documentation

basepython = {[default]basepython}

deps =

Sphinx==2.4.4

sphinx-rtd-theme==0.4.3

commands =

sphinx-build \

-b html -d "{envtmpdir}/doctrees" \

"{toxinidir}/docs" \

"{toxinidir}/htmldocs"

description = build documentation and rebuild automatically

basepython = {[default]basepython}

deps =

{[testenv:docs]deps}

sphinx-autobuild==0.7.1

commands =

sphinx-autobuild \

-b html -d "{envtmpdir}/doctrees" \

--host=localhost \

"{toxinidir}/docs" \

"{toxinidir}/htmldocs"

description = check for potential packaging problems

basepython = {[default]basepython}

skip_install = True

deps =

check-manifest==0.41

readme-renderer==25.0

twine==3.1.1

commands =

check-manifest

pip wheel --wheel-dir "{envtmpdir}/dist" --no-deps {toxinidir}

twine check "{envtmpdir}/dist/"*