noxfile.py

"""Nox sessions."""

import nox

locations = ["src", "tests", "noxfile.py", "docs/conf.py", "scripts"]

supported_pythons = ["3.8", "3.9", "3.10", "3.11", "3.12"]
docs_python = "3.12"


@nox.session(python=supported_pythons)
def tests(session: nox.Session) -> None:
    """Run the test suite."""
    args = session.posargs or ["--cov", "--cov-report=xml"]
    session.run(
        "poetry",
        "install",
        "--quiet",
        "--all-extras",
        "--only=main,tests",
        external=True,
    )
    session.run("pytest", *args)


@nox.session(python=supported_pythons)
def ruff_format(session: nox.Session) -> None:
    """Check formatting using Ruff."""
    args = session.posargs or locations
    session.run(
        "poetry", "install", "--quiet", "--no-root", "--only=ruff", external=True
    )
    session.run("ruff", "format", "--check", *args)


@nox.session(python=supported_pythons)
def ruff_lint(session: nox.Session) -> None:
    """Lint using Ruff."""
    args = session.posargs or locations
    session.run(
        "poetry", "install", "--quiet", "--no-root", "--only=ruff", external=True
    )
    session.run("ruff", *args)


@nox.session(python=supported_pythons)
def darglint(session: nox.Session) -> None:
    """Check docstrings using darglint."""
    args = session.posargs or ["src"]
    session.run(
        "poetry", "install", "--quiet", "--no-root", "--only=darglint", external=True
    )
    session.run("darglint", *args)


@nox.session(python=supported_pythons)
def mypy(session: nox.Session) -> None:
    """Type-check using mypy."""
    args = session.posargs or locations
    session.run(
        "poetry",
        "install",
        "--quiet",
        "--all-extras",
        "--only=main,dev,docs,tests,mypy",
        external=True,
    )
    session.run("mypy", *args)


@nox.session(python=supported_pythons)
def pyright(session: nox.Session) -> None:
    """Type-check using pyright."""
    args = session.posargs or locations
    session.run(
        "poetry",
        "install",
        "--quiet",
        "--all-extras",
        "--only=main,dev,docs,tests,pyright",
        external=True,
    )
    session.run("pyright", *args)


@nox.session(python=docs_python)
def docs(session: nox.Session) -> None:
    """Build the documentation."""
    session.run(
        "poetry",
        "install",
        "--quiet",
        "--all-extras",
        "--only=main,docs",
        external=True,
    )
    session.run("sphinx-build", "docs", "docs/_build")