tox.ini

[tox]
requires =
    tox>=4.24.1
    tox-uv>=1.24
env_list =
    fix
    3.13
    3.12
    3.11
    type
    pkg_meta
skip_missing_interpreters = true

[testenv]
description = run the unit tests with pytest under {base_python}
package = wheel
wheel_build_env = .pkg
extras =
    numpy
    testing
    type-comment
pass_env =
    DIFF_AGAINST
    PYTEST_*
set_env =
    COVERAGE_FILE = {work_dir}/.coverage.{env_name}
commands =
    python -m pytest {tty:--color=yes} {posargs: \
      --cov {env_site_packages_dir}{/}sphinx_autodoc_typehints --cov {tox_root}{/}tests \
      --cov-config=pyproject.toml --no-cov-on-fail --cov-report term-missing:skip-covered --cov-context=test \
      --cov-report html:{env_tmp_dir}{/}htmlcov --cov-report xml:{work_dir}{/}coverage.{env_name}.xml \
      --junitxml {work_dir}{/}junit.{env_name}.xml \
      tests}
    diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} {work_dir}{/}coverage.{env_name}.xml --fail-under 100

[testenv:fix]
description = format the code base to adhere to our styles, and complain about what we cannot do automatically
skip_install = true
deps =
    pre-commit-uv>=4.1.4
commands =
    pre-commit run --all-files --show-diff-on-failure

[testenv:type]
description = run type check on code base
deps =
    mypy==1.15
    types-docutils>=0.21.0.20241128
commands =
    mypy src
    mypy tests

[testenv:pkg_meta]
description = check that the long description is valid
skip_install = true
deps =
    check-wheel-contents>=0.6.1
    twine>=6.1
    uv>=0.6.1
commands =
    uv build --sdist --wheel --out-dir {env_tmp_dir} .
    twine check {env_tmp_dir}{/}*
    check-wheel-contents --no-config {env_tmp_dir}

[testenv:dev]
description = generate a DEV environment
package = editable
commands =
    uv pip tree
    python -c 'import sys; print(sys.executable)'