noxfile.py

import os

import nox

# nox options
nox.options.reuse_existing_virtualenvs = True
nox.options.force_venv_backend = "uv|virtualenv"
nox.needs_version = ">=2024.4.15"

# Environment variables to control CI behaviour for nox sessions
PYBOP_SCHEDULED = int(os.environ.get("PYBOP_SCHEDULED", 0))
PYBAMM_VERSION = os.environ.get("PYBAMM_VERSION", None)


@nox.session
def unit(session):
    session.install("-e", ".[all,dev]", silent=False)
    if PYBOP_SCHEDULED:
        session.run("pip", "install", f"pybamm=={PYBAMM_VERSION}", silent=False)
    session.run("pytest", "--unit")


@nox.session
def coverage(session):
    session.install("-e", ".[all,dev]", silent=False)
    session.install("pip")
    if PYBOP_SCHEDULED:
        session.run("pip", "install", f"pybamm=={PYBAMM_VERSION}", silent=False)
    session.run("pytest", "--unit", "--cov", "--cov-append", "--cov-report=xml")
    session.run(
        "pytest",
        "--integration",
        "--cov",
        "--cov-append",
        "--cov-report=xml",
    )
    session.run(
        "pytest", "--plots", "--cov", "--cov-append", "--cov-report=xml", "-n", "0"
    )


@nox.session
def plots(session):
    """Run the tests that generate plots."""
    session.install("-e", ".[plot,dev]", silent=False)
    session.install("pip")
    session.run("pytest", "--plots", "-n", "0")


@nox.session
def integration(session):
    """Run the integration tests."""
    session.install("-e", ".[all,dev]", silent=False)
    session.run("pytest", "--integration")


@nox.session
def examples(session):
    """Run the examples and notebooks"""
    session.install("-e", ".[all,dev]", silent=False)
    session.run("pytest", "--examples")
    notebooks(session)


@nox.session
def notebooks(session):
    """Run the Jupyter notebooks."""
    session.install("openpyxl", "ipywidgets")
    session.install("-e", ".[all,dev]", silent=False)
    if PYBOP_SCHEDULED:
        session.run("pip", "install", f"pybamm=={PYBAMM_VERSION}", silent=False)
    session.run(
        "pytest",
        "--notebooks",
        "--nbmake",
        "--nbmake-timeout=1000",
        "examples/",
    )


@nox.session(name="notebooks-overwrite")
def notebooks_overwrite(session):
    """Run the Jupyter notebooks."""
    session.install("openpyxl", "ipywidgets")
    session.install("-e", ".[all,dev]", silent=False)
    if PYBOP_SCHEDULED:
        session.run("pip", "install", f"pybamm=={PYBAMM_VERSION}", silent=False)
    session.run(
        "pytest",
        "--notebooks",
        "--nbmake",
        "--overwrite",
        "--nbmake-timeout=1000",
        "examples/",
    )


@nox.session(name="tests")
def run_tests(session):
    """Run all or a user-defined set of tests."""
    session.install("-e", ".[all,dev]", silent=False)
    if PYBOP_SCHEDULED:
        session.run("pip", "install", f"pybamm=={PYBAMM_VERSION}", silent=False)
    specific_tests = session.posargs if session.posargs else []
    session.run(
        "pytest",
        "--unit",
        "--integration",
        "--nbmake",
        "--examples",
        "-n",
        "auto",
        *specific_tests,
    )


@nox.session(name="doctest")
def run_doc_tests(session):
    """
    Checks if the documentation can be built, runs any doctests (currently not
    used).
    """
    session.install("-e", ".[plot,docs,dev]", silent=False)
    session.run("pytest", "--docs", "-n", "0")


@nox.session(name="pre-commit")
def lint(session):
    """
    Check all files against the defined pre-commit hooks.

    Credit: PyBaMM Team
    """
    session.install("pre-commit", silent=False)
    session.run("pre-commit", "run", "--all-files")


@nox.session(name="quick", reuse_venv=True)
def run_quick(session):
    """
    Run integration tests, unit tests, and doctests sequentially

    Credit: PyBaMM Team
    """
    run_tests(session)
    run_doc_tests(session)


@nox.session
def benchmarks(session):
    """Run the benchmarks."""
    session.install("-e", ".[all,dev]", silent=False)
    session.install("asv[virtualenv]")
    session.run("asv", "run", "--show-stderr", "--python=same")


@nox.session
def docs(session):
    """
    Build the documentation and load it in a browser tab, rebuilding on changes.
    Credit: PyBaMM Team
    """
    envbindir = session.bin
    session.install("-e", ".[all,docs]", silent=False)
    session.chdir("docs")
    # Local development
    if session.interactive:
        session.run(
            "sphinx-autobuild",
            "-j",
            "auto",
            "--open-browser",
            "-qT",
            ".",
            f"{envbindir}/../tmp/html",
        )
    # Runs in CI only, treating warnings as errors
    else:
        session.run(
            "sphinx-build",
            "-j",
            "auto",
            "-b",
            "html",
            "--keep-going",
            ".",
            "_build/html",
        )