noxfile.py

"""Configuration file for the Nox test runner.

This instantiates the specified sessions in isolated environments and runs the tests.
This allows for locally mirroring the testing occuring with GitHub-actions.
Be careful that the general setup of tests is left to pyproject.toml.
"""

import nox

# set the test parameters
nox.options.stop_on_first_error = True
nox.options.error_on_missing_interpreters = True


@nox.session
def lint(session: nox.Session) -> None:
    """Ensure the code is formatted as expected."""
    session.install("ruff")
    session.run("ruff", "check", "--output-format=github", "--config=pyproject.toml", ".")


# @nox.session  # uncomment this line to only run on the current python interpreter
@nox.session(python=["3.9", "3.10", "3.11", "3.12"])  # missing versions can be installed with `pyenv install ...`
# do not forget check / set the versions with `pyenv global`, or `pyenv local` in case of virtual environment
def tests(session: nox.Session) -> None:
    """Run the tests for the specified Python versions."""
    session.install(".[test]")
    session.run("pytest")