noxfile.py

"""
Nox sessions for the `gptsum`_ project.

.. _gptsum: https://github.com/NicolasT/gptsum
"""

import os
import shutil
import sys
from pathlib import Path

from nox_poetry import Session, session

# pylint: disable=redefined-outer-name


PACKAGE = "gptsum"

PYTHON_VERSIONS = [
    # Note: keep these sorted
    "3.8",
    "3.9",
    "3.10",
    "3.11",
    "3.12",
    "3.13",
]

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


@session(python=PYTHON_VERSIONS[-1])
def flake8(session: Session) -> None:
    """Lint using flake8."""
    args = session.posargs or SOURCES
    session.install(
        "darglint",
        "flake8",
        "flake8-black",
        "flake8-bugbear",
        "flake8-builtins",
        "flake8-docstrings",
        "flake8-expression-complexity",
        "flake8-isort",
        "flake8-pytest",
        "flake8-pytest-style",
        "flake8-return",
        "flake8-rst-docstrings",
        "pep8-naming",
    )
    session.run("flake8", *args)


@session(python=PYTHON_VERSIONS)
def pylint(session: Session) -> None:
    """Lint using pylint."""
    args = session.posargs or SOURCES

    noxdeps = [
        "nox-poetry",
    ]
    # Don't use `nox-poetry`'s `Session`, but its inner `nox` `Session`
    # Rationale: `nox`, `nox-poetry` and others aren't managed by Poetry, hence
    # their versions (and versions of dependencies) aren't tracked in `poetry.lock`.
    # Moreover, these can conflict with versions kept in
    # `.github/workflows/constraints.txt`. Hence, install the version of `nox-poetry`
    # we'd use in CI, by only using the relevant constraints file.
    assert hasattr(session.poetry, "session")  # Make MyPy happy
    session.poetry.session.install(
        "--constraint=.github/workflows/constraints.txt", *noxdeps
    )

    session.install(".")

    deps = [
        "pylint",
        "pytest",
        "pytest-mock",
        "pytest-benchmark",
    ]

    session.install(*deps)

    session.run("pylint", *args)


@session(python=PYTHON_VERSIONS[-1])
def safety(session: Session) -> None:
    """Scan dependencies for insecure packages."""
    requirements = session.poetry.export_requirements()
    session.install("safety")
    session.run("safety", "check", f"--file={requirements}", "--bare")


@session(python=PYTHON_VERSIONS)
def mypy(session: Session) -> None:
    """Type-check using mypy."""
    args = session.posargs or [src for src in SOURCES if src != "noxfile.py"]
    session.install(".")

    deps = [
        "mypy",
        "pytest",
        "pytest-benchmark",
        "pytest-mock",
    ]

    session.install(*deps)

    session.run("mypy", *args)
    if not session.posargs:
        session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")


@session(python=PYTHON_VERSIONS)
def tests(session: Session) -> None:
    """Run the test suite."""
    session.install(".")
    session.install(
        "coverage[toml]",
        "coverage-conditional-plugin",
        "pygments",
        "pytest",
        "pytest-benchmark",
        "pytest-mock",
    )

    env = {
        "COVERAGE_FILE": os.environ.get(
            "COVERAGE_FILE",
            f".coverage.{session.name}.py{session.python}.{sys.platform}",
        ),
    }

    try:
        session.run("coverage", "run", "-m", "pytest", *session.posargs, env=env)
        session.run("coverage", "report", env=env)
    finally:
        if session.interactive:
            session.notify("coverage")


@session
def coverage(session: Session) -> None:
    """Produce the coverage report."""
    # Do not use session.posargs unless this is the only session.
    nsessions = len(session._runner.manifest)  # pylint: disable=protected-access
    has_args = session.posargs and nsessions == 1
    args = session.posargs if has_args else ["report"]

    session.install(
        "coverage[toml]",
        "coverage-conditional-plugin",
    )

    if not has_args and any(Path().glob(".coverage.*")):
        session.run("coverage", "combine")

    session.run("coverage", *args)


@session(python=PYTHON_VERSIONS)
def typeguard(session: Session) -> None:
    """Runtime type checking using Typeguard."""
    session.install(".")
    session.install(
        "pygments",
        "pytest",
        "pytest-benchmark",
        "pytest-mock",
        "typeguard",
    )
    session.run("pytest", f"--typeguard-packages={PACKAGE}", *session.posargs)


@session(python=PYTHON_VERSIONS)
def xdoctest(session: Session) -> None:
    """Run examples with xdoctest."""
    args = session.posargs or ["all"]
    session.install(".")
    session.install(
        "xdoctest[colors]",
    )
    session.run("python", "-m", "xdoctest", PACKAGE, *args)


@session(python=PYTHON_VERSIONS[-1])
def docs(session: Session) -> None:
    """Build the documentation."""
    args = session.posargs or ["docs", "docs/_build"]
    session.install(".")
    session.install(
        "Sphinx",
        "furo",
        "sphinx-argparse",
    )

    build_dir = Path("docs", "_build")
    if build_dir.exists():
        shutil.rmtree(build_dir)

    session.run("sphinx-build", *args)