forked from cda-tum/mqt-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noxfile.py
122 lines (95 loc) · 3.76 KB
/
noxfile.py
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
"""Nox sessions."""
from __future__ import annotations
import argparse
import os
import shutil
import sys
from typing import TYPE_CHECKING
import nox
if TYPE_CHECKING:
from collections.abc import Sequence
nox.needs_version = ">=2024.3.2"
nox.options.default_venv_backend = "uv|virtualenv"
nox.options.sessions = ["lint", "tests", "minimums"]
PYTHON_ALL_VERSIONS = ["3.9", "3.10", "3.11", "3.12"]
# The following lists all the build requirements for building the package.
# Note that this includes transitive build dependencies of package dependencies,
# since we use `--no-build-isolation` to install the package in editable mode
# and get better caching performance. This only concerns dependencies that are
# not available via wheels on PyPI (i.e., only as source distributions).
BUILD_REQUIREMENTS = [
"scikit-build-core>=0.10.1",
"setuptools_scm>=8.1",
"pybind11>=2.13.5",
]
if os.environ.get("CI", None):
nox.options.error_on_missing_interpreters = True
@nox.session(reuse_venv=True)
def lint(session: nox.Session) -> None:
"""Run the linter."""
if shutil.which("pre-commit") is None:
session.install("pre-commit")
session.run("pre-commit", "run", "--all-files", *session.posargs, external=True)
def _run_tests(
session: nox.Session,
*,
install_args: Sequence[str] = (),
run_args: Sequence[str] = (),
extras: Sequence[str] = (),
) -> None:
posargs = list(session.posargs)
env = {}
if os.environ.get("CI", None) and sys.platform == "win32":
env["CMAKE_GENERATOR"] = "Ninja"
env["SKBUILD_CMAKE_ARGS"] = "--fresh"
if shutil.which("cmake") is None and shutil.which("cmake3") is None:
session.install("cmake")
if shutil.which("ninja") is None:
session.install("ninja")
_extras = ["test", *extras]
if "--cov" in posargs:
_extras.append("coverage")
posargs.append("--cov-config=pyproject.toml")
session.install(*BUILD_REQUIREMENTS, *install_args, env=env)
install_arg = f"-ve.[{','.join(_extras)}]"
session.install("--no-build-isolation", install_arg, *install_args, env=env)
session.run("pytest", *run_args, *posargs, env=env)
@nox.session(reuse_venv=True, python=PYTHON_ALL_VERSIONS)
def tests(session: nox.Session) -> None:
"""Run the test suite."""
_run_tests(session)
@nox.session(reuse_venv=True, venv_backend="uv", python=PYTHON_ALL_VERSIONS)
def minimums(session: nox.Session) -> None:
"""Test the minimum versions of dependencies."""
_run_tests(
session,
install_args=["--resolution=lowest-direct"],
run_args=["-Wdefault"],
extras=["qiskit", "evaluation"],
)
session.run("uv", "pip", "list")
@nox.session(reuse_venv=True)
def docs(session: nox.Session) -> None:
"""Build the docs. Use "--non-interactive" to avoid serving. Pass "-b linkcheck" to check links."""
parser = argparse.ArgumentParser()
parser.add_argument("-b", dest="builder", default="html", help="Build target (default: html)")
args, posargs = parser.parse_known_args(session.posargs)
serve = args.builder == "html" and session.interactive
extra_installs = ["sphinx-autobuild"] if serve else []
session.install(*BUILD_REQUIREMENTS, *extra_installs)
session.install("--no-build-isolation", "-ve.[docs]")
if args.builder == "linkcheck":
session.run("sphinx-build", "-b", "linkcheck", "docs", "docs/_build/linkcheck", *posargs)
return
shared_args = (
"-n", # nitpicky mode
"-T", # full tracebacks
f"-b={args.builder}",
"docs",
f"docs/_build/{args.builder}",
*posargs,
)
if serve:
session.run("sphinx-autobuild", "--ignore", "**jupyter**", *shared_args)
else:
session.run("sphinx-build", "--keep-going", *shared_args)