tox.ini

[tox]
minversion = 3.21
# relies on the correct version of Python installed
envlist = ruff,tests,mypy
# https://github.com/tox-dev/tox/issues/20#issuecomment-247788333
# hack to prevent .tox from crapping to the project directory
toxworkdir = {env:TOXWORKDIR_BASE:}{toxinidir}/.tox

[testenv]
# TODO how to get package name from setuptools?
package_name = "orgparse"
passenv =
# useful for tests to know they are running under ci
  CI
  CI_*
# respect user's cache dirs to prevent tox from crapping into project dir
  MYPY_CACHE_DIR
  PYTHONPYCACHEPREFIX


[testenv:ruff]
commands =
    {envpython} -m pip install --use-pep517 -e .[linting]
    {envpython} -m ruff src/


# note: --use-pep517 here is necessary for tox --parallel flag to work properly
# otherwise it seems that it tries to modify .eggs dir in parallel and it fails
[testenv:tests]
commands =
    {envpython} -m pip install --use-pep517 -e .[testing]
    # posargs allow test filtering, e.g. tox ... -- -k test_name
    {envpython} -m pytest \
        --pyargs {[testenv]package_name} \
        {posargs}


[testenv:mypy]
commands =
    {envpython} -m pip install --use-pep517 -e .[linting]
    {envpython} -m mypy --install-types --non-interactive \
        -p {[testenv]package_name}       \
        # txt report is a bit more convenient to view on CI
        --txt-report  .coverage.mypy     \
        --html-report .coverage.mypy     \
        {posargs}