tox.ini

[tox]
env_list = py{3.10,3.11,3.12,3.13,3.14},format,lint,typecheck
skip_missing_interpreters = False
isolated_build = True
labels =
    test = py3.12
    test_oldest = py3.10
    test_latest = py3.14
    test_all = py{3.10,3.11,3.12,3.13,3.14}
    static = lint,typecheck
    check = lint,typecheck,py3.12

[testenv]
# Multi-env performance tweak based on https://hynek.me/articles/turbo-charge-tox/
package = wheel
wheel_build_env = .pkg
groups = dev
allowlist_externals = pytest
passenv =
    CI
    LMS_*
commands =
    # Even the "slow" tests aren't absurdly slow, so default to running them
    pytest {posargs} tests/

[testenv:load-test-models]
commands =
    python -m tests.load_models

[testenv:unload-test-models]
commands =
    python -m tests.unload_models

[testenv:coverage]
# Subprocess coverage based on https://hynek.me/articles/turbo-charge-tox/
allowlist_externals = coverage
set_env = COVERAGE_PROCESS_START={toxinidir}/pyproject.toml
commands_pre = python -c 'import pathlib; pathlib.Path("{env_site_packages_dir}/cov.pth").write_text("import coverage; coverage.process_startup()")'
commands =
    coverage run --parallel -m pytest {posargs} tests/

[testenv:format]
allowlist_externals = ruff
skip_install = true
commands =
    ruff format {posargs} src/ tests/ examples/plugins sdk-schema/sync-sdk-schema.py

[testenv:lint]
allowlist_externals = ruff
skip_install = true
commands =
    ruff check {posargs} src/ tests/ examples/plugins

[testenv:typecheck]
allowlist_externals = mypy
commands =
    mypy --strict {posargs} src/ tests/
    # Examples folder is checked separately as a named package
    # so mypy doesn't complain about multiple plugin.py files
    mypy --strict {posargs} -p examples

[testenv:sync-sdk-schema]
allowlist_externals = python
groups = sync-sdk-schema
skip_install = true
commands =
    python sdk-schema/sync-sdk-schema.py {posargs}

[testenv:docs]
groups =
deps = -r docs/requirements.txt
allowlist_externals = sphinx-build
commands =
    sphinx-build -W -b dirhtml {posargs} docs/ docs/_build

[testenv:linkcheck]
groups =
deps = -r docs/requirements.txt
allowlist_externals = sphinx-build
commands =
    sphinx-build -W -b linkcheck {posargs} docs/ docs/_build

[testenv:doctest]
# Doctest trick: change `...` to `..` in the expected test
# output to force test failures and see the actual results.
# (`...` is a placeholder for non-determistic output that
# can unfortunately hide real errors in the example output)
groups =
deps = -r docs/requirements.txt
allowlist_externals = sphinx-build
commands =
    sphinx-build -W -b doctest {posargs} docs/ docs/_build

[gh]
python =
    3.10 = py3.10
    3.11 = py3.11
    3.12 = py3.12
    3.13 = py3.13
    # Collect coverage stats on the newest version
    3.14 = coverage