tox.ini

# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
# To use a PEP 517 build-backend you are required to configure tox to use an isolated_build:
# https://tox.readthedocs.io/en/latest/example/package.html
isolated_build = True
skipsdist = True

envlist =
    # always keep coverage-clean first
    coverage-clean
    lint-fix
    lint
    codespell-write
    docstr-coverage
    py

[testenv]
allowlist_externals =
    poetry
commands =
    poetry run pytest {posargs}
description = Run unit tests with pytest. This is a special environment that does not get a name, and
              can be referenced with "py".

[testenv:coverage-clean]
deps = coverage
skip_install = true
commands = coverage erase

# This is used during development
[testenv:lint-fix]
deps =
    black
    ruff
skip_install = true
commands =
    black src/ tests/ --exclude "/(tests/input|tests/output)/"
    ruff --fix src/ tests/ --exclude tests/input --exclude tests/output
description = Run linters.

# This is used for QC checks.
[testenv:lint]
deps =
    black
    ruff
skip_install = true
commands =
    black --check --diff src/ tests/ --exclude "/(tests/input|tests/output)/"
    ruff check src/ tests/ --exclude tests/input --exclude tests/output
description = Run linters.

[testenv:doclint]
deps =
    rstfmt
skip_install = true
commands =
    rstfmt docs/source/
description = Run documentation linters.

[testenv:codespell]
description = Run spell checker.
skip_install = true
deps =
    codespell
    tomli  # required for getting config from pyproject.toml
commands = codespell src/ tests/ -S tests/input/,tests/output/

[testenv:codespell-write]
description = Run spell checker and write corrections.
skip_install = true
deps =
    codespell
    tomli
commands = codespell src/ tests/ --write-changes -S tests/input/,tests/output/

[testenv:docstr-coverage]
skip_install = true
deps =
    docstr-coverage
commands =
    docstr-coverage src/ tests/ --skip-private --skip-magic --exclude=tests/input/* --exclude=tests/output/*
description = Run the docstr-coverage tool to check documentation coverage.