tox.ini

# SPDX-FileCopyrightText: 2023 Hynek Schlawack <hs@ox.cx>
#
# SPDX-License-Identifier: MIT

[tox]
min_version = 4
env_list =
    pre-commit,
    docs,
    mypy-pkg,
    pyright,
    py3{9,10,11,12,13}-mypy
    py3{9,10,11,12,13}-tests{,-optional},
    coverage-report


[pkgenv]
pass_env = SETUPTOOLS_SCM_PRETEND_VERSION


[testenv]
package = wheel
wheel_build_env = .pkg
extras =
    tests: tests
    mypy: typing
deps =
    mypy: mypy
    tests: coverage[toml]
    optional: aiohttp
    optional: fastapi
    optional: flask
    optional: httpx
    optional: pyramid
    optional: starlette
commands =
    tests: coverage run -m pytest {posargs}
    mypy: mypy tests/typing docs/examples/fastapi/simple_fastapi_app.py docs/examples/starlette/simple_starlette_app.py


[testenv:coverage-report]
description = Report coverage over all test runs.
deps = coverage
skip_install = true
commands =
    coverage combine
    coverage report


[testenv:pre-commit]
description = Run all pre-commit hooks.
skip_install = true
deps = pre-commit-uv
commands = pre-commit run --all-files


[testenv:mypy-pkg]
description = Type-check the package.
extras = typing
commands = mypy src


[testenv:pyright]
deps = pyright
extras = typing
commands = pyright tests/typing src


[testenv:docs]
# Keep base_python in sync with ci.yml/docs and .readthedocs.yaml.
base_python = py312
extras = docs
commands =
    sphinx-build -n -T -W -b html -d {envtmpdir}/doctrees docs docs/_build/html
    sphinx-build -n -T -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html
    # Sybil
    pytest docs


[testenv:docs-watch]
package = editable
base_python = {[testenv:docs]base_python}
extras = {[testenv:docs]extras}
deps = watchfiles
commands =
    watchfiles \
        --ignore-paths docs/_build/ \
        'sphinx-build -W -n -b html -d {envtmpdir}/doctrees docs docs/_build/html' \
        src \
        docs \
        README.md \
        CHANGELOG.md


[testenv:docs-linkcheck]
base_python = {[testenv:docs]base_python}
extras = {[testenv:docs]extras}
commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/html