tox.ini

[tox]
min_version = 4.18.1
env_list =
    lint
    docs
    notebooks
    doctests
    py310
    py311-extras-numpy
    py312-extras-sbck
    py313-extras-lmoments
labels =
    static = lint
    test = py310, py311-extras-numpy, py312-extras-sbck, py313-extras-lmoments
    special = docs, notebooks, doctests
requires =
    pip >= 24.2.0
    flit >=3.9,<4.0
opts = -vv

[gh]
python =
    3.10 = py310-coverage-lmoments
    3.11 = py311-coverage-extras-sbck
    3.12 = py312-coverage-extras-numpy
    # coveralls is not yet supported for Python3.13; Adjust this build when coveralls>4.0.1 is released.
    3.13 = py313-extras-lmoments

[testenv:lint]
description = Run code quality compliance tests under {basepython}
skip_install = True
extras =
deps =
    codespell ==2.3.0
    deptry==0.16.1
    flake8==7.1.1
    flake8-rst-docstrings==0.3.0
    black[jupyter]==24.10.0
    blackdoc==0.3.9
    nbqa==1.8.2
    numpydoc==1.8.0
    ruff==0.7.0
    vulture==2.11
    yamllint==1.35.1
commands_pre =
commands =
    make lint
commands_post =
allowlist_externals =
    make

[testenv:docs]
description = Build the documentation with makefile under {basepython}
setenv =
    PYTHONPATH = {toxinidir}
    READTHEDOCS = 1
deps =
    docs
commands_pre =
commands =
    make docs
commands_post =
allowlist_externals =
    env
    make

# Requires tox-conda compatible with tox@v4.0
;[testenv:conda]
;description = Run tests with pytest under {basepython} (Anaconda distribution)
;commands_pre =
;conda_channels = conda-forge
;conda_env = environment-dev.yml
;deps =
;extras =

[testenv:notebooks{-prefetch,}]
description = Run notebooks with pytest under {basepython}
extras =
    all
deps =
    lmoments3
commands =
    pytest --no-cov --nbval --dist=loadscope --rootdir=tests/ --ignore=docs/notebooks/example.ipynb docs/notebooks
commands_post =

[testenv:doctests{-prefetch,}]
description = Run doctests with pytest under {basepython}
commands =
    python -c 'from xclim.testing.utils import run_doctests; run_doctests()'
commands_post =

[testenv]
description = Run tests with pytest under {basepython}
setenv =
    COV_CORE_SOURCE =
    PYTEST_ADDOPTS = --numprocesses=logical --durations=10
    coverage: PYTEST_ADDOPTS = --numprocesses=logical --durations=10 --cov=xclim --cov-report=term-missing
    Xfrozen_modules = off
passenv =
    CI
    CONDA_EXE
    COVERALLS_*
    GITHUB_*
    LD_LIBRARY_PATH
    SKIP_NOTEBOOKS
    XCLIM_*
extras =
    dev
    extras: extras
deps =
    coverage: coveralls>=4.0.1
    lmoments: lmoments3
    numpy: numpy>=1.23,<2.0
    numpy: pint>=0.18,<0.24.0
    upstream: -r CI/requirements_upstream.txt
install_command = python -m pip install --no-user {opts} {packages}
download = True
commands_pre =
    sbck: python -c 'print("The sbck dependency requires the \"libeigen3-dev\" package to be installed on the system.")'
    sbck: python -m pip install pybind11
    sbck: python -m pip install sbck
    python -m pip list
    xclim show_version_info
    python -m pip check
    xclim --help
    prefetch: xclim prefetch_testing_data
commands =
    !offline: pytest {posargs}
    ; Prevent socket connections (except for unix sockets for async support)
    offline: python -c 'print("Running offline tests with positional arguments: --disable-socket --allow-unix-socket --m \"not requires_internet\"")'
    offline: python -c 'print("These can be overwritten with: tox -e offline -- -m \"some other marker statement\"")'
    offline: pytest --disable-socket --allow-unix-socket {posargs:-m 'not requires_internet'}
commands_post =
    coverage: - coveralls
allowlist_externals =
    git
    xclim