tox.ini

# Generated from:
# https://github.com/zopefoundation/meta/tree/master/config/zope-product
[tox]
minversion = 3.18
envlist =
    release-check
    lint
    py37
    py38
    py39
    py310
    py311
    py312
    docs
    coverage
    pre-commit

[testenv]
skip_install = true
deps =
    zc.buildout >= 3.0.1
    wheel > 0.37
    cffi
setenv =
    py312: VIRTUALENV_PIP=23.1.2
    py312: PIP_REQUIRE_VIRTUALENV=0
commands_pre =
    {envbindir}/buildout -c {toxinidir}/buildout.cfg buildout:directory={envdir} buildout:develop={toxinidir} buildout:root-directory={toxinidir}
commands =
    # the `layer` argument below suppresses a `ZCatalog` performance test
    # which occasionally fails on GITHUB
    {envdir}/bin/alltests --layer '!Products.PluginIndexes' {posargs:-vc}
allowlist_externals = *

[testenv:pre-commit]
basepython = python3
description = This env runs all linters configured in .pre-commit-config.yaml
skip_install = true
deps =
    pre-commit
commands_pre =
commands =
    pre-commit run --all-files --show-diff-on-failure

[testenv:autopep8]
basepython = python3.8
skip_install = true
deps =
    -cconstraints.txt
    autopep8
    docformatter
commands =
    autopep8 --verbose --in-place --recursive --aggressive --aggressive {toxinidir}/src setup.py
    docformatter --in-place --recursive {toxinidir}/src setup.py

[testenv:release-check]
description = ensure that the distribution is ready to release
basepython = python3
skip_install = true
deps =
    twine
    build
    check-manifest
    check-python-versions >= 0.20.0
    wheel
commands_pre =
commands =
    check-manifest
    check-python-versions
    python -m build --sdist --no-isolation
    twine check dist/*

[testenv:lint]
basepython = python3
commands_pre =
    mkdir -p {toxinidir}/parts/flake8
allowlist_externals =
    mkdir
commands =
    isort --check-only --diff {toxinidir}/src {toxinidir}/setup.py
    flake8 {toxinidir}/src {toxinidir}/setup.py
deps =
    flake8
    isort
    # Useful flake8 plugins that are Python and Plone specific:
    flake8-coding
    flake8-debugger
    mccabe

[testenv:isort-apply]
basepython = python3
commands_pre =
deps =
    isort
commands =
    isort {toxinidir}/src {toxinidir}/setup.py []

[testenv:docs]
basepython = python3
skip_install = false
extras =
    docs
commands_pre =
commands =
    sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html

[testenv:coverage]
basepython = python3.8
skip_install = true
allowlist_externals =
    {[testenv]allowlist_externals}
    mkdir
deps =
    {[testenv]deps}
    coverage
commands =
    mkdir -p {toxinidir}/parts/htmlcov
    coverage run {envdir}/bin/alltests {posargs:-vc}
    coverage html
    coverage report -m --fail-under=80

[coverage:run]
branch = True
source = src

[coverage:report]
precision = 2
exclude_lines =
    pragma: no cover
    pragma: nocover
    except ImportError:
    raise NotImplementedError
    if __name__ == '__main__':
    self.fail
    raise AssertionError

[coverage:html]
directory = parts/htmlcov