1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
from __future__ import annotations
from pathlib import Path
import nox
nox.options.sessions = ["lint", "lite", "tests", "doctests", "disassemble"]
nox.needs_version = ">=2024.4.15"
nox.options.default_venv_backend = "uv|virtualenv"
ALL_PYTHON = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
DIR = Path(__file__).parent.resolve()
@nox.session(reuse_venv=True)
def lint(session: nox.Session) -> None:
"""Run the linter."""
session.install("pre-commit")
session.run("pre-commit", "run", "--all-files", *session.posargs)
@nox.session(reuse_venv=True)
def pylint(session: nox.Session) -> None:
"""Run pylint."""
session.install("pylint")
session.install("-e", ".")
session.run("pylint", "src/vector/", *session.posargs)
@nox.session(reuse_venv=True, python=ALL_PYTHON)
def lite(session: nox.Session) -> None:
"""Run lightweight tests."""
session.install("-e", ".[test]")
session.run("pytest", "--ignore", "tests/test_notebooks.py", *session.posargs)
@nox.session(reuse_venv=True, python=ALL_PYTHON)
def tests(session: nox.Session) -> None:
"""Run the unit and regular tests."""
session.install("-e", ".[awkward,numba,test,test-extras,sympy]")
session.run(
"pytest",
"--ignore",
"tests/test_notebooks.py",
*session.posargs,
)
@nox.session(reuse_venv=True, python=ALL_PYTHON, default=False)
def coverage(session: nox.Session) -> None:
"""Run tests and compute coverage."""
session.posargs.extend(["--cov=vector", "--cov-report=xml"])
tests(session)
@nox.session(reuse_venv=True, python=ALL_PYTHON)
def doctests(session: nox.Session) -> None:
"""Run the doctests."""
session.install("-e", ".[awkward,numba,test,test-extras,sympy]")
session.run("pytest", "--doctest-plus", "src/vector/", *session.posargs)
@nox.session(reuse_venv=True, default=False)
def notebooks(session: nox.Session) -> None:
"""Run the notebook tests"""
session.install("-e", ".[awkward,numba,test,sympy]")
session.install("jupyter")
session.run("pytest", "tests/test_notebooks.py", *session.posargs)
@nox.session(reuse_venv=True, default=False)
def docs(session: nox.Session) -> None:
"""Build the docs. Pass "serve" to serve."""
session.install("-e", ".[docs]")
session.chdir("docs")
session.run("sphinx-build", "-M", "html", ".", "_build")
if session.posargs:
if "serve" in session.posargs:
print("Launching docs at http://localhost:8001/ - use Ctrl-C to quit")
session.run("python", "-m", "http.server", "8001", "-d", "_build/html")
else:
print("Unsupported argument to docs")
@nox.session(reuse_venv=True, default=False)
def build(session: nox.Session) -> None:
"""Build an SDist and wheel."""
session.install("build")
session.run("python", "-m", "build")
@nox.session(reuse_venv=True, python="3.8", default=False)
def disassemble(session: nox.Session) -> None:
"""Disassemble run."""
session.install("-e", ".[test-extras]")
session.posargs.extend(["-m", "dis"])
lite(session)
|