forked from python-jsonschema/jsonschema
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noxfile.py
211 lines (174 loc) · 5.24 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
from pathlib import Path
from tempfile import TemporaryDirectory
import os
import nox
ROOT = Path(__file__).parent
PACKAGE = ROOT / "jsonschema"
BENCHMARKS = PACKAGE / "benchmarks"
PYPROJECT = ROOT / "pyproject.toml"
CHANGELOG = ROOT / "CHANGELOG.rst"
DOCS = ROOT / "docs"
INSTALLABLE = [
nox.param(value, id=name) for name, value in [
("no-extras", str(ROOT)),
("format", f"{ROOT}[format]"),
("format-nongpl", f"{ROOT}[format-nongpl]"),
]
]
NONGPL_LICENSES = [
"Apache Software License",
"BSD License",
"ISC License (ISCL)",
"MIT License",
"Mozilla Public License 2.0 (MPL 2.0)",
"Python Software Foundation License",
"The Unlicense (Unlicense)",
]
nox.options.sessions = []
def session(default=True, **kwargs):
def _session(fn):
if default:
nox.options.sessions.append(kwargs.get("name", fn.__name__))
return nox.session(**kwargs)(fn)
return _session
@session(python=["3.8", "3.9", "3.10", "3.11", "pypy3"])
@nox.parametrize("installable", INSTALLABLE)
def tests(session, installable):
env = dict(JSON_SCHEMA_TEST_SUITE=str(ROOT / "json"))
session.install("virtue", installable)
if session.posargs and session.posargs[0] == "coverage":
if len(session.posargs) > 1 and session.posargs[1] == "github":
posargs = session.posargs[2:]
github = os.environ["GITHUB_STEP_SUMMARY"]
else:
posargs, github = session.posargs[1:], None
session.install("coverage[toml]")
session.run(
"coverage",
"run",
*posargs,
"-m",
"virtue",
PACKAGE,
env=env,
)
if github is None:
session.run("coverage", "report")
else:
with open(github, "a") as summary:
summary.write("### Coverage\n\n")
summary.flush() # without a flush, output seems out of order.
session.run(
"coverage",
"report",
"--format=markdown",
stdout=summary,
)
else:
session.run("virtue", *session.posargs, PACKAGE, env=env)
@session()
@nox.parametrize("installable", INSTALLABLE)
def audit(session, installable):
session.install("pip-audit", installable)
session.run("python", "-m", "pip_audit")
if "format-nongpl" in installable:
session.install("pip-licenses")
session.run(
"python",
"-m",
"piplicenses",
"--ignore-packages",
"pip-requirements-parser",
"pip_audit",
"pip-api",
"--allow-only",
";".join(NONGPL_LICENSES),
)
@session(tags=["build"])
def build(session):
session.install("build", "docutils", "twine")
with TemporaryDirectory() as tmpdir:
session.run("python", "-m", "build", ROOT, "--outdir", tmpdir)
session.run("twine", "check", "--strict", tmpdir + "/*")
session.run(
"python", "-m", "docutils", "--strict", CHANGELOG, os.devnull,
)
@session()
def secrets(session):
session.install("detect-secrets")
session.run("detect-secrets", "scan", ROOT)
@session(tags=["style"])
def style(session):
session.install("ruff")
session.run("ruff", "check", ROOT)
@session()
def typing(session):
session.install("mypy", "types-requests", ROOT)
session.run("mypy", "--config", PYPROJECT, PACKAGE)
@session(tags=["docs"])
@nox.parametrize(
"builder",
[
nox.param(name, id=name)
for name in [
"dirhtml",
"doctest",
"linkcheck",
"man",
"spelling",
]
],
)
def docs(session, builder):
session.install("-r", DOCS / "requirements.txt")
with TemporaryDirectory() as tmpdir_str:
tmpdir = Path(tmpdir_str)
argv = ["-n", "-T", "-W"]
if builder != "spelling":
argv += ["-q"]
session.run(
"python",
"-m",
"sphinx",
"-b",
builder,
DOCS,
tmpdir / builder,
*argv,
)
@session(tags=["docs", "style"], name="docs(style)")
def docs_style(session):
session.install(
"doc8",
"pygments",
"pygments-github-lexers",
)
session.run("python", "-m", "doc8", "--config", PYPROJECT, DOCS)
@session(default=False)
def bandit(session):
session.install("bandit")
session.run("bandit", "--recursive", PACKAGE)
@session(default=False)
@nox.parametrize(
"benchmark",
[
nox.param(each.stem, id=each.stem)
for each in BENCHMARKS.glob("[!_]*.py")
],
)
def perf(session, benchmark):
session.install("pyperf", f"{ROOT}[format]")
tmpdir = Path(session.create_tmp())
output = tmpdir / f"bench-{benchmark}.json"
session.run("python", BENCHMARKS / f"{benchmark}.py", "--output", output)
@session(default=False)
def requirements(session):
session.install("pip-tools")
for each in [DOCS / "requirements.in", ROOT / "test-requirements.in"]:
session.run(
"pip-compile",
"--resolver",
"backtracking",
"-U",
each.relative_to(ROOT),
)