forked from landlab/landlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noxfile.py
329 lines (260 loc) · 8.95 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
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
import os
import pathlib
import shutil
import tempfile
import nox
PROJECT = "landlab"
ROOT = pathlib.Path(__file__).parent
@nox.session(venv_backend="mamba")
def test(session: nox.Session) -> None:
"""Run the tests."""
session.conda_install("--file", "requirements.in")
session.conda_install("--file", "requirements-testing.in")
session.conda_install("richdem")
session.install("-e", ".", "--no-deps")
args = [
"-n",
"auto",
"--cov",
PROJECT,
"-vvv",
# "--dist", "worksteal", # this is not available quite yet
] + session.posargs
if "CI" in os.environ:
args.append(f"--cov-report=xml:{ROOT.absolute()!s}/coverage.xml")
session.run("pytest", *args)
if "CI" not in os.environ:
session.run("coverage", "report", "--ignore-errors", "--show-missing")
@nox.session(name="test-notebooks", venv_backend="mamba")
def test_notebooks(session: nox.Session) -> None:
"""Run the notebooks."""
args = [
"pytest",
"notebooks",
"--nbmake",
"--nbmake-kernel=python3",
"--nbmake-timeout=3000",
"-n",
"auto",
"-vvv",
] + session.posargs
session.install("git+https://github.com/mcflugen/nbmake.git@mcflugen/add-markers")
session.conda_install("richdem")
session.conda_install(
"pytest",
"pytest-xdist",
"--file",
"notebooks/requirements.in",
"--file",
"requirements.in",
)
session.install("-e", ".", "--no-deps")
session.run(*args)
@nox.session(name="test-cli")
def test_cli(session: nox.Session) -> None:
"""Test the command line interface."""
session.install(".")
session.run("landlab", "--help")
session.run("landlab", "--version")
session.run("landlab", "index", "--help")
session.run("landlab", "list", "--help")
session.run("landlab", "provided-by", "--help")
session.run("landlab", "provides", "--help")
session.run("landlab", "used-by", "--help")
session.run("landlab", "uses", "--help")
session.run("landlab", "validate", "--help")
@nox.session
def lint(session: nox.Session) -> None:
"""Look for lint."""
session.install("pre-commit")
session.run("pre-commit", "run", "--all-files")
# towncrier(session)
@nox.session
def towncrier(session: nox.Session) -> None:
"""Check that there is a news fragment."""
session.install("towncrier")
session.run("towncrier", "check", "--compare-with", "origin/master")
@nox.session(name="build-index")
def build_index(session: nox.Session) -> None:
index_file = ROOT / "docs" / "index.toml"
header = """
# This file was automatically generated with:
# nox -s build-index
""".strip()
session.install("sphinx")
session.install(".")
with open(index_file, "w") as fp:
print(header, file=fp, flush=True)
session.run(
"landlab", "--silent", "index", "components", "fields", "grids", stdout=fp
)
session.log(f"generated index at {index_file!s}")
# @nox.session(name="build-docs", venv_backend="mamba")
@nox.session(name="build-docs")
def build_docs(session: nox.Session) -> None:
"""Build the docs."""
build_dir = ROOT / "build"
docs_dir = ROOT / "docs"
session.install("-r", docs_dir / "requirements.in")
session.install("-e", ".")
build_dir.mkdir(exist_ok=True)
session.run(
"sphinx-build",
"-b",
"html",
"-W",
"--keep-going",
docs_dir / "source",
build_dir / "html",
)
session.log(f"generated docs at {build_dir / 'html'!s}")
@nox.session
def locks(session: nox.Session) -> None:
"""Create lock files."""
folders = session.posargs or [".", "docs", "notebooks"]
session.install("pip-tools")
def upgrade_requirements(src, dst="requirements.txt"):
with open(dst, "wb") as fp:
session.run("pip-compile", "--upgrade", src, stdout=fp)
for folder in folders:
with session.chdir(ROOT / folder):
upgrade_requirements("requirements.in", dst="requirements.txt")
for folder in folders:
session.log(f"updated {ROOT / folder / 'requirements.txt'!s}")
# session.install("conda-lock[pip_support]")
# session.run("conda-lock", "lock", "--mamba", "--kind=lock")
@nox.session(name="sync-requirements", python="3.11", venv_backend="conda")
def sync_requirements(session: nox.Session) -> None:
"""Sync requirements.in with pyproject.toml."""
with open("requirements.in", "w") as fp:
session.run(
"python",
"-c",
"""
import os, tomllib
with open("pyproject.toml", "rb") as fp:
print(os.linesep.join(sorted(tomllib.load(fp)["project"]["dependencies"])))
""",
stdout=fp,
)
@nox.session
def build(session: nox.Session) -> None:
"""Build sdist and wheel dists."""
session.install("pip")
session.install("build")
session.run("python", "--version")
session.run("pip", "--version")
session.run("python", "-m", "build", "--outdir", "./build/wheelhouse")
@nox.session
def release(session):
"""Tag, build and publish a new release to PyPI."""
session.install("zest.releaser[recommended]")
session.install("zestreleaser.towncrier")
session.run("fullrelease")
@nox.session(name="publish-testpypi")
def publish_testpypi(session):
"""Publish wheelhouse/* to TestPyPI."""
session.run("twine", "check", "build/wheelhouse/*")
session.run(
"twine",
"upload",
"--skip-existing",
"--repository-url",
"https://test.pypi.org/legacy/",
"build/wheelhouse/*.tar.gz",
)
@nox.session(name="publish-pypi")
def publish_pypi(session):
"""Publish wheelhouse/* to PyPI."""
session.run("twine", "check", "build/wheelhouse/*")
session.run(
"twine",
"upload",
"--skip-existing",
"build/wheelhouse/*.tar.gz",
)
@nox.session(python=False)
def clean(session):
"""Remove all .venv's, build files and caches in the directory."""
for folder in _args_to_folders(session.posargs):
with session.chdir(folder):
shutil.rmtree("build", ignore_errors=True)
shutil.rmtree("build/wheelhouse", ignore_errors=True)
shutil.rmtree(f"{PROJECT}.egg-info", ignore_errors=True)
shutil.rmtree(".pytest_cache", ignore_errors=True)
shutil.rmtree(".venv", ignore_errors=True)
for pattern in ["*.py[co]", "__pycache__"]:
_clean_rglob(pattern)
@nox.session(python=False, name="clean-checkpoints")
def clean_checkpoints(session):
"""Remove jupyter notebook checkpoint files."""
for folder in _args_to_folders(session.posargs):
with session.chdir(folder):
_clean_rglob("*-checkpoint.ipynb")
_clean_rglob(".ipynb_checkpoints")
@nox.session(python=False, name="clean-docs")
def clean_docs(session: nox.Session) -> None:
"""Clean up the docs folder."""
build_dir = ROOT / "build"
if (build_dir / "html").is_dir():
with session.chdir(build_dir):
shutil.rmtree("html")
if (ROOT / "build").is_dir():
session.chdir(ROOT / "build")
if os.path.exists("html"):
shutil.rmtree("html")
@nox.session(python=False, name="clean-ext")
def clean_ext(session: nox.Session) -> None:
"""Clean shared libraries for extension modules."""
for folder in _args_to_folders(session.posargs):
with session.chdir(folder):
_clean_rglob("*.so")
@nox.session(python=False)
def nuke(session):
"""Run all clean sessions."""
clean_checkpoints(session)
clean_docs(session)
clean(session)
clean_ext(session)
@nox.session(name="list-wheels")
def list_wheels(session):
print(os.linesep.join(_get_wheels(session)))
@nox.session(name="list-ci-matrix")
def list_ci_matrix(session):
def _os_from_wheel(name):
if "linux" in name:
return "linux"
elif "macos" in name:
return "macos"
elif "win" in name:
return "windows"
for wheel in _get_wheels(session):
print(f"- cibw-only: {wheel}")
print(f" os: {_os_from_wheel(wheel)}")
def _get_wheels(session):
platforms = session.posargs or ["linux", "macos", "windows"]
session.install("cibuildwheel")
wheels = []
for platform in platforms:
with tempfile.TemporaryFile("w+") as fp:
session.run(
"cibuildwheel",
"--print-build-identifiers",
"--platform",
platform,
stdout=fp,
)
fp.seek(0)
wheels += fp.read().splitlines()
return wheels
def _args_to_folders(args):
return [ROOT] if not args else [pathlib.Path(f) for f in args]
def _clean_rglob(pattern):
nox_dir = pathlib.Path(".nox")
for p in pathlib.Path(".").rglob(pattern):
if nox_dir in p.parents:
continue
if p.is_dir():
p.rmdir()
else:
p.unlink()