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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
#!/usr/bin/env -S uv run --script
# Copyright 2016 Alethea Katherine Flowers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# /// script
# dependencies = ["nox>=2025.02.09"]
# ///
from __future__ import annotations
import contextlib
import functools
import os
import shutil
import sqlite3
import sys
import nox
ON_WINDOWS_CI = "CI" in os.environ and sys.platform.startswith("win32")
nox.needs_version = ">=2025.02.09"
nox.options.default_venv_backend = "uv|virtualenv"
PYPROJECT = nox.project.load_toml("pyproject.toml")
ALL_PYTHONS = nox.project.python_versions(PYPROJECT)
@nox.session(python=ALL_PYTHONS)
def tests(session: nox.Session) -> None:
"""Run test suite with pytest."""
coverage_file = f".coverage.{sys.platform}.{session.python}"
session.create_tmp() # Fixes permission errors on Windows
session.install(*PYPROJECT["dependency-groups"]["test"], "uv")
session.install("-e.[tox_to_nox,pbs]")
extra_env = {"PYTHONWARNDEFAULTENCODING": "1"}
session.run(
"pytest",
"--cov",
"--cov-config",
"pyproject.toml",
"--cov-report=",
*session.posargs,
env={
"COVERAGE_FILE": coverage_file,
**extra_env,
},
)
if sys.platform.startswith("win"):
with contextlib.closing(sqlite3.connect(coverage_file)) as con, con:
con.execute("UPDATE file SET path = REPLACE(path, '\\', '/')")
con.execute("DELETE FROM file WHERE SUBSTR(path, 2, 1) == ':'")
@nox.session(venv_backend="uv", default=False)
def minimums(session: nox.Session) -> None:
"""Run test suite with the lowest supported versions of everything. Requires uv."""
session.create_tmp()
session.install("-e.", "--group=test", "--resolution=lowest-direct")
session.run("uv", "pip", "list")
session.run("pytest", *session.posargs)
@nox.session(venv_backend="conda", default=bool(shutil.which("conda")))
def conda_tests(session: nox.Session) -> None:
"""Run test suite set up with conda."""
session.conda_install(
"--file", "requirements-conda-test.txt", channel="conda-forge"
)
session.install("-e.", "--no-deps")
# Currently, this doesn't work on Windows either with or without quoting
if not sys.platform.startswith("win32"):
session.conda_install("requests<99")
session.run("pytest", *session.posargs)
@nox.session(venv_backend="mamba", default=shutil.which("mamba"))
def mamba_tests(session: nox.Session) -> None:
"""Run test suite set up with mamba."""
session.conda_install(
"--file", "requirements-conda-test.txt", channel="conda-forge"
)
session.install("-e.", "--no-deps")
if not sys.platform.startswith("win32"):
session.conda_install("requests<99")
session.run("pytest", *session.posargs)
@nox.session(venv_backend="micromamba", default=shutil.which("micromamba"))
def micromamba_tests(session: nox.Session) -> None:
"""Run test suite set up with micromamba."""
session.conda_install(
"--file", "requirements-conda-test.txt", channel="conda-forge"
)
# Currently, this doesn't work on Windows either with or without quoting
session.install("-e.", "--no-deps")
if not sys.platform.startswith("win32"):
session.conda_install("requests<99")
session.run("pytest", *session.posargs)
@nox.session(default=False)
def cover(session: nox.Session) -> None:
"""Coverage analysis."""
if ON_WINDOWS_CI:
return
session.install("coverage[toml]>=7.3")
session.run("coverage", "combine")
session.run("coverage", "report", "--fail-under=100", "--show-missing")
session.run("coverage", "erase")
@nox.session(python="3.12")
def lint(session: nox.Session) -> None:
"""Run pre-commit linting."""
session.install("pre-commit")
session.run(
"pre-commit",
"run",
"--all-files",
"--show-diff-on-failure",
"--hook-stage=manual",
*session.posargs,
)
@nox.session(default=False)
def docs(session: nox.Session) -> None:
"""Build the documentation."""
output_dir = os.path.join(session.create_tmp(), "output")
doctrees, html = map(
functools.partial(os.path.join, output_dir), ["doctrees", "html"]
)
shutil.rmtree(output_dir, ignore_errors=True)
session.install(*PYPROJECT["dependency-groups"]["docs"])
session.install("-e.")
session.cd("docs")
sphinx_args = ["-b", "html", "-W", "-d", doctrees, ".", html]
if not session.interactive:
sphinx_cmd = "sphinx-build"
else:
sphinx_cmd = "sphinx-autobuild"
sphinx_args.insert(0, "--open-browser")
session.run(sphinx_cmd, *sphinx_args)
# The following sessions are only to be run in CI to check the nox GHA action
def _check_python_version(session: nox.Session) -> None:
if session.python.startswith("pypy"):
# Drop starting "pypy" and maybe "-"
python_version = session.python.lstrip("py-")
implementation = "pypy"
else:
python_version = session.python
implementation = "cpython"
session.run(
"python",
"-c",
"import sys; assert '.'.join(str(v) for v in sys.version_info[:2]) =="
f" '{python_version}'",
)
if python_version[:2] != "2.":
session.run(
"python",
"-c",
f"import sys; assert sys.implementation.name == '{implementation}'",
)
@nox.session(
python=[
*ALL_PYTHONS,
"pypy-3.11",
],
default=False,
)
def github_actions_default_tests(session: nox.Session) -> None:
"""Check default versions installed by the nox GHA Action"""
assert sys.version_info[:2] == (3, 12)
_check_python_version(session)
@nox.session(
python=[
*ALL_PYTHONS,
"pypy3.8",
"pypy3.9",
"pypy3.10",
"pypy3.11",
],
default=False,
)
def github_actions_all_tests(session: nox.Session) -> None:
"""Check all versions installed by the nox GHA Action"""
_check_python_version(session)
if __name__ == "__main__":
nox.main()
|
