tox.ini

[tox]
minversion = 3.4.0
skipsdist = true
skip_missing_interpreters=true
envlist = py{310,311,312}, pre-commit, docs, docs-notebooks, docs-links

[pytest]
; Uncomment the following lines to deactivate pyglotaran all plugins
; env =
;    DEACTIVATE_GTA_PLUGINS=1
; Uncomment "env =" and "COMPARE_RESULTS_LOCAL" and set it to a local folder
; with results to use as a reference in lieu of the comparison-results branch
; in the pyglotaran-examples git repository
;    COMPARE_RESULTS_LOCAL=~/local_results/ ; On *nix
;    COMPARE_RESULTS_LOCAL=%USERPROFILE%/local_results/ ; On Windows
; Uncomment to ignore deprecation warnings coming from pyglotaran
; (this helps to see the warnings from dependencies)
; filterwarnings =
;     ignore:.+glotaran:GlotaranApiDeprecationWarning


[flake8]
extend-ignore = E231, E203
max-line-length = 99
per-file-ignores =
    # imported but unused
    __init__.py: F401
    glotaran/typing/types.py: F401
    # max line length
    docs/source/conf.py: E501
    # Typedef files are formatted differently
    *.pyi: E301, E302, F401
    # D414 is needed due to a bug in pydocstyle that sees the return type `Parameters` as nested sections
    glotaran/io/interface.py: D414
    # Allow printing in test file
    test_*.py: T201
    # Temporarily deactivated since the code will be removed in PR 1060
    glotaran/optimization/optimization_group_calculator_linked.py: C417

[pydocstyle]
convention = numpy
# this is needed due to the following issue:
# https://github.com/PyCQA/pydocstyle/issues/368
ignore_decorators = wrap_func_as_method

[testenv:docs]
direct = true
whitelist_externals = make
commands =
    make --directory=docs clean html

[testenv:docs-notebooks]
direct = true
commands =
    python docs/remove_notebook_written_data.py
    py.test -vv --nbval docs/source/notebooks

[testenv:docs-links]
direct = true
whitelist_externals = make
commands =
    make --directory=docs clean linkcheck

[testenv:pre-commit]
direct = true
deps=pre-commit
commands = pre-commit run --all

[testenv]
skipsdist = false
install_command = {envpython} -m pip install {opts} {packages}
deps = -r{toxinidir}/requirements_dev.txt
commands =
    py.test --cov=glotaran --cov-config {toxinidir}/pyproject.toml glotaran