tox.ini

[tox]
minversion = 4.28.0
envlist = py310, py311, py312, py313, lint-incr
isolated_build = true

[testenv]
setenv =
  VIRTUAL_ENV={envdir}
  LANGUAGE=en_US
  LC_ALL=en_US.utf-8
  ARGS="-V"
  QISKIT_TEST_CAPTURE_STREAMS=1
  QISKIT_PARALLEL=FALSE
  QISKIT_IGNORE_USER_SETTINGS=TRUE
passenv =
  RUSTUP_TOOLCHAIN
  RAYON_NUM_THREADS
  OMP_NUM_THREADS
  QISKIT_PARALLEL
  QISKIT_IGNORE_USER_SETTINGS
  RUST_BACKTRACE
  SETUPTOOLS_ENABLE_FEATURES
  QISKIT_TESTS
  QISKIT_IN_PARALLEL
  QISKIT_DOCS_GITHUB_BRANCH_NAME
constraints =
  constraints.txt
dependency_groups =
  test
commands =
  stestr run {posargs}

[testenv:rust]
basepython = python3
package_env = .pkg-rust
allowlist_externals = cargo
commands = python tools/run_cargo_test.py

# This is a special package_env used by the 'rust' env above
# to force Qiskit's Rust code to build in debug mode. We do this
# to speed up linking and save dev time. Our Cargo tests should
# still run fast enough.
[testenv:.pkg-rust]
setenv =
  QISKIT_BUILD_PROFILE=debug

[testenv:lint]
basepython = python3
package = editable
allowlist_externals = cargo
dependency_groups =
  lint
commands =
  black --check {posargs} qiskit test tools setup.py docs/conf.py
  cargo fmt --check
  ruff check qiskit test tools setup.py
  cargo clippy -- -D warnings
  python {toxinidir}/tools/verify_headers.py qiskit test tools crates
  python {toxinidir}/tools/find_optional_imports.py
  python {toxinidir}/tools/find_stray_release_notes.py
  python {toxinidir}/tools/verify_images.py
  reno -q lint

[testenv:lint-incr]
basepython = python3
allowlist_externals = git
dependency_groups =
  lint
commands =
  black --check {posargs} qiskit test tools setup.py docs/conf.py
  ruff check qiskit test tools setup.py
  -git fetch -q https://github.com/Qiskit/qiskit.git :lint_incr_latest
  python {toxinidir}/tools/verify_headers.py qiskit test tools crates
  python {toxinidir}/tools/find_optional_imports.py
  python {toxinidir}/tools/find_stray_release_notes.py
  python {toxinidir}/tools/verify_images.py
  reno -q lint

[testenv:black]
skip_install = true
dependency_groups =
  lint
commands = black {posargs} qiskit test tools setup.py docs/conf.py

[testenv:coverage]
basepython = python3
setenv =
  {[testenv]setenv}
  PYTHON=coverage run --source qiskit --parallel-mode
dependency_groups =
  {[testenv]dependency_groups}
  optionals-all
commands =
  stestr run {posargs}
  coverage combine
  coverage report

[testenv:docs]
basepython = python3
allowlist_externals =
  make
  doxygen
setenv =
  {[testenv]setenv}
  QISKIT_BUILD_PROFILE=debug
dependency_groups =
  doc
  optionals-all
commands =
  make cheader
  doxygen docs/Doxyfile
  sphinx-build -W -j auto -T --keep-going -b html docs/ docs/_build/html {posargs}

[testenv:docs-clean]
skip_install = true
deps =
dependency_groups =
allowlist_externals =
  rm
commands =
  rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build {toxinidir}/docs/locale {toxinidir}/docs/xml