tox.ini

# This file encodes a lot of our intended support range, as well as some
# details about dependency availability.
#
# The majority of the information is contained in tox.envlist and testenv.deps.
[tox]
requires =
  tox>=4
  tox-uv
envlist =
  # No preinstallations
  py3{11-13}-none
  py3{14-15}{,t}-none
  # Minimum Python with minimum deps
  py311-min
  # Run full and pre dependencies against all archs
  py3{11-13}-{full,pre}-{x86,x64,arm64}
  py3{14-15}{,t}-{full,pre}-{x86,x64,arm64}
  # Python development versions
  py316{,t}-pre-{x64,arm64}
  # Run multithreaded tests against free-threaded Pythons
  # Note: Slow and resource intensive, best left to CI
  py3{14-16}t-threaded
  install
  doctest
  style
  typecheck
skip_missing_interpreters = true

# Configuration that allows us to split tests across GitHub runners effectively
[gh-actions]
python =
  3.10: py310
  3.11: py311
  3.12: py312
  3.13: py313
  3.13t: py313t
  3.14: py314
  3.14t: py314t
  3.15: py315
  3.15t: py315t

[gh-actions:env]
DEPENDS =
  none: none
  pre: pre
  full: full
  min: min

MODE =
  threaded: threaded

ARCH =
  x64: x64
  x86: x86
  arm64: arm64

[testenv]
description = Pytest with coverage
labels = test
pip_pre =
  pre: true
pass_env =
  # getpass.getuser() sources for Windows:
  LOGNAME
  USER
  LNAME
  USERNAME
  # Environment variables we check for
  NIPY_EXTRA_TESTS
  # Pass user color preferences through
  PY_COLORS
  FORCE_COLOR
  NO_COLOR
  CLICOLOR
  CLICOLOR_FORCE
set_env =
  pre: PIP_EXTRA_INDEX_URL=https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
  pre: UV_INDEX=https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
  pre: UV_INDEX_STRATEGY=unsafe-best-match
  py3{13-15}t: PYTHONGIL={env:PYTHONGIL:0}
extras =
  test

  !none: dicomfs
  !none: zstd

  # Minimum dependencies
  min: minc2
  min: spm
  min: viewers

  # Indexed gzip wheels are not available for 3.15 yet
  py3{11-14}{,t}: indexed_gzip

  # Matplotlib/scipy have wheels for everything except win32 (x86)
  py3{11-15}{,t}-{full,pre}-{x,arm}64: viewers
  py3{11-15}{,t}-{full,pre}-{x,arm}64: spm

  # No free-threaded or 3.15 wheels for: h5py
  py3{11-14}-{full,pre}-{x,arm}64: minc2

deps =
  pre: pydicom @ git+https://github.com/pydicom/pydicom.git@main

uv_resolution =
  min: lowest-direct

commands =
  pytest --doctest-modules --doctest-plus \
    --cov nibabel --cov-report xml:cov.xml \
    --junitxml test-results.xml \
    --durations=20 --durations-min=1.0 \
    --pyargs nibabel {posargs:-n auto}

[testenv:py3{10-15}{,t}-{full,none}-{x,arm}64]
runner = uv-venv-lock-runner

[testenv:py3{13-15}t-threaded]
description = Pytest with coverage with free threaded python
set_env =
  PYTHONGIL={env:PYTHONGIL:0}
  PYTEST_RUN_PARALLEL_VERBOSE=1
extras =
  all
  test
commands =
  pytest -ra --strict-config --strict-markers --showlocals --capture=no --parallel-threads 16 nibabel

[testenv:install]
description = Install and verify import succeeds
labels = test
deps =
extras =
commands =
  python -c "import nibabel; print(nibabel.__version__)"

[testenv:docs]
description = Build documentation site
labels = docs
allowlist_externals = make
dependency_groups = doc
commands =
  make -C doc html

[testenv:doctest]
description = Run doctests in documentation site
labels = docs
runner = uv-venv-lock-runner
allowlist_externals = make
extras =
  test
dependency_groups =
  doc
commands =
  make -C doc doctest

# The following checks are pinned in .pre-commit-config.yaml
# The preferred way to run these is `pre-commit run -a`, but they are left here
# for now on the off chance that someone is using these regularly.
[testenv:style{,-fix}]
description = Check our style guide
labels = check
skip_install = true
dependency_groups =
  dev
commands =
  pre-commit run ruff-check --all
  pre-commit run ruff-format --all

[testenv:spellcheck]
description = Check spelling
labels = check
skip_install = true
dependency_groups =
  dev
commands =
  pre-commit run codespell --all

[testenv:typecheck]
description = Check type consistency
labels = check
runner = uv-venv-lock-runner
dependency_groups =
  typecheck
commands =
  mypy nibabel

[testenv:build{,-strict}]
labels =
  check
  pre-release
deps =
  build
  twine
skip_install = true
set_env =
  build-strict: PYTHONWARNINGS=error
commands =
  python -m build
  python -m twine check dist/*

[testenv:publish]
depends = build
labels = release
deps =
  twine
skip_install = true
commands =
  python -m twine upload dist/*

[testenv:zenodo]
labels = pre-release
skip_install = true
allowlist_externals = uv
commands =
  uv run tools/prep_citation_cff.py