{{ message }}
Repository navigation
Expand file tree
/
Copy pathcommands.py
More file actions
503 lines (401 loc) · 15.1 KB
/
Copy pathcommands.py
File metadata and controls
503 lines (401 loc) · 15.1 KB
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
"""Utility command runner."""
import argparse
import base64
import hashlib
import io
import logging
import json
import os
import platform
import re
import requests
import shutil
import subprocess
from subprocess import check_call
import sys
import tarfile
import time
from codegen import perform_codegen, lint_code, reformat_code
LOGGER = logging.getLogger(__name__)
PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
NODE_ROOT = os.path.join(PROJECT_ROOT, "js")
NODE_MODULES = os.path.join(NODE_ROOT, "node_modules")
WIDGET_TARGETS = [
os.path.join(PROJECT_ROOT, "plotly", "package_data", "widgetbundle.js"),
]
NPM_PATH = os.pathsep.join(
[
os.path.join(NODE_ROOT, "node_modules", ".bin"),
os.environ.get("PATH", os.defpath),
]
)
def plotly_js_version():
"""Load plotly.js version from js/package.json."""
path = os.path.join(PROJECT_ROOT, "js", "package.json")
with open(path, "rt") as f:
package_json = json.load(f)
version = package_json["dependencies"]["plotly.js"]
version = version.replace("^", "")
return version
def install_js_deps(local, build=True):
"""Install package.json dependencies using npm.
When ``build`` is True (the default), also runs ``npm run build`` to
rebuild the JupyterLab extension and FigureWidget bundles and verifies
that the widget bundle exists. Pass ``build=False`` when you only need
to refresh ``node_modules`` / ``package-lock.json`` but don't
need the bundles rebuilt.
"""
npmName = "npm"
if platform.system() == "Windows":
npmName = "npm.cmd"
try:
check_call([npmName, "--version"])
has_npm = True
except Exception:
has_npm = False
skip_npm = os.environ.get("SKIP_NPM", False)
if skip_npm:
LOGGER.info("Skipping npm-installation")
return
if not has_npm:
LOGGER.error(
"`npm` unavailable. If you're running this command using sudo, make sure `npm` is available to sudo"
)
env = os.environ.copy()
env["PATH"] = NPM_PATH
if has_npm:
LOGGER.info("Installing build dependencies with npm. This may take a while...")
check_call(
[npmName, "install"],
cwd=NODE_ROOT,
stdout=sys.stdout,
stderr=sys.stderr,
)
if local is not None:
plotly_archive = os.path.join(local, "plotly.js.tgz")
check_call(
[npmName, "install", plotly_archive],
cwd=NODE_ROOT,
stdout=sys.stdout,
stderr=sys.stderr,
)
if build:
check_call(
[npmName, "run", "build"],
cwd=NODE_ROOT,
stdout=sys.stdout,
stderr=sys.stderr,
)
os.utime(NODE_MODULES, None)
if build:
for target in WIDGET_TARGETS:
if not os.path.exists(target):
msg = "Missing file: %s" % target
raise ValueError(msg)
def overwrite_schema_local(uri):
"""Replace plot-schema.json with local copy."""
path = os.path.join(PROJECT_ROOT, "codegen", "resources", "plot-schema.json")
shutil.copyfile(uri, path)
def overwrite_bundle_local(uri):
"""Replace minified JavaScript bundle.json with local copy."""
path = os.path.join(PROJECT_ROOT, "plotly", "package_data", "plotly.min.js")
shutil.copyfile(uri, path)
def overwrite_plotlyjs_version_file(plotlyjs_version):
"""Replace plotly.js version file."""
path = os.path.join(PROJECT_ROOT, "plotly", "offline", "_plotlyjs_version.py")
with open(path, "w") as f:
f.write(
"""\
# DO NOT EDIT
# This file is generated by the updateplotlyjs and updateplotlyjsdev commands in commands.py
__plotlyjs_version__ = "{plotlyjs_version}"
""".format(plotlyjs_version=plotlyjs_version)
)
def get_bundle_schema_local(local):
"""Get paths to local build files."""
plotly_archive = os.path.join(local, "plotly.js.tgz")
plotly_bundle = os.path.join(local, "dist/plotly.min.js")
plotly_schemas = os.path.join(local, "dist/plot-schema.json")
return plotly_archive, plotly_bundle, plotly_schemas
def update_bundle_schema(plotly_js_version):
"""
Replace plotly.min.js and plot-schema.json with the copies from the
plotly.js npm package, and write the plotly.js version file.
Raise an AssertionError if a download fails, if the package does not match
the integrity hash that npm publishes, or if a file is missing. Write no
files in those cases.
"""
metadata_url = f"https://registry.npmjs.org/plotly.js/{plotly_js_version}"
req = requests.get(metadata_url)
assert req.status_code == 200, f"Failed to fetch npm metadata: {metadata_url}"
dist = req.json()["dist"]
url = dist["tarball"]
print("url:", url)
req = requests.get(url)
assert req.status_code == 200, f"Failed to download: {url}"
# npm publishes the integrity as "sha512-<base64 digest>"
algorithm, expected = dist["integrity"].split("-", 1)
actual = base64.b64encode(hashlib.new(algorithm, req.content).digest()).decode()
assert actual == expected, f"Integrity mismatch for {url}"
destinations = {
"package/dist/plotly.min.js": os.path.join(
PROJECT_ROOT, "plotly", "package_data", "plotly.min.js"
),
"package/dist/plot-schema.json": os.path.join(
PROJECT_ROOT, "codegen", "resources", "plot-schema.json"
),
}
# Read every file before writing any, so a failure leaves no partial update
with tarfile.open(fileobj=io.BytesIO(req.content), mode="r:gz") as tar:
contents = {
path: tar.extractfile(member).read()
for member in tar
if (path := destinations.get(member.name))
}
assert len(contents) == len(destinations), f"Missing files in {url}"
for path, data in contents.items():
with open(path, "wb") as f:
f.write(data)
overwrite_plotlyjs_version_file(plotly_js_version)
def update_plotlyjs(plotly_js_version, outdir):
"""Update project to a new version of plotly.js."""
update_bundle_schema(plotly_js_version)
perform_codegen(outdir)
install_js_deps(local=None, build=True)
def update_schema_bundle_from_local(plotlyjs_path):
"""
Update the plotly.js schema and bundle from a local plotly.js repository.
The repository must contain a build in dist/ and a plotly.js.tgz archive
from `npm pack`.
"""
# npm runs from js/, so a relative path would resolve from the wrong folder
plotlyjs_path = os.path.abspath(plotlyjs_path)
archive_uri, bundle_uri, schema_uri = get_bundle_schema_local(plotlyjs_path)
overwrite_bundle_local(bundle_uri)
overwrite_schema_local(schema_uri)
# Update plotly.js url in package.json
package_json_path = os.path.join(NODE_ROOT, "package.json")
with open(package_json_path, "r") as f:
package_json = json.load(f)
# Replace version with bundle url
package_json["dependencies"]["plotly.js"] = archive_uri
with open(package_json_path, "w") as f:
json.dump(package_json, f, indent=2)
# update plotly.js version in _plotlyjs_version
timestamp = str(int(time.time()))
overwrite_plotlyjs_version_file(f"{plotlyjs_path}__{timestamp}_local")
install_js_deps(plotlyjs_path)
def update_plotlyjs_dev(args, outdir):
"""Update project to a new development version of plotly.js."""
update_schema_bundle_from_local(args.plotlyjs_path)
perform_codegen(outdir)
def bump_version_pyproject_toml(new_version):
"""
Bump the version in pyproject.toml to new_version
Returns True on success, False on failure
"""
pyproject_toml_path = "pyproject.toml"
pattern = r'(^\s*version\s*=\s*")([\w.]+)"(\s*$)'
with open(pyproject_toml_path, "r") as f:
content = f.read()
new_content, n_subs = re.subn(
pattern,
rf'\g<1>{new_version}"\g<3>',
content,
count=1, # replace only the first match
flags=re.MULTILINE,
)
if n_subs < 1:
print(
f"FAILED to update version in {pyproject_toml_path}.",
"Please update manually and then run `uv lock`.",
)
return False
with open(pyproject_toml_path, "w") as f:
f.write(new_content)
# Run `uv lock` to update the version number in the `uv.lock` file (do not update manually)
subprocess.run(["uv", "lock"], check=True)
print(
f"SUCCESS: Updated version in {pyproject_toml_path} to {new_version},",
"and updated uv lockfile",
)
return True
def bump_version_package_json(new_version):
"""
Bump the version in package.json to new_version
Returns True on success, False on failure
"""
js_dir = "js"
subprocess.run(
["npm", "version", new_version, "--no-git-tag-version", "--allow-same-version"],
cwd=js_dir,
check=True,
)
print(
f"SUCCESS: Updated version in {js_dir}/package.json and {js_dir}/package-lock.json to {new_version}"
)
# After modifying files in js/, we need to rebuild the JupyterLab extension
print("Rebuilding JupyterLab extension (this may take a few seconds)...")
subprocess.run(
["npm", "run", "build:labextension"],
cwd=js_dir,
check=True,
stdout=subprocess.DEVNULL, # Suppress stdout and stderr to avoid terminal clutter
stderr=subprocess.DEVNULL,
)
print(f"SUCCESS: Updated JupyterLab extension files in plotly/labextension")
return True
def bump_version_citation_cff(new_version, new_date):
"""
Bump the version in CITATION.cff to new_version and date-released to new_date
Returns True on success, False on failure
"""
citation_cff_path = "CITATION.cff"
pattern_version = r"(^\s*version\s*:\s*)([\w.]+)(\s*$)"
pattern_date = r"(^\s*date-released\s*:\s*)([0-9\-]+)(\s*$)"
with open(citation_cff_path, "r") as f:
content = f.read()
new_content, n_subs = re.subn(
pattern_version,
rf"\g<1>{new_version}\g<3>",
content,
count=1, # replace only the first match
flags=re.MULTILINE,
)
if n_subs < 1:
print(
f"FAILED to update version in {citation_cff_path}.",
"Please update manually.",
)
return False
new_content, n_subs = re.subn(
pattern_date,
rf"\g<1>{new_date}\g<3>",
new_content,
count=1, # replace only the first match
flags=re.MULTILINE,
)
if n_subs < 1:
print(
f"FAILED to update date-released in {citation_cff_path}.",
"Please update manually.",
)
return False
with open(citation_cff_path, "w") as f:
f.write(new_content)
print(
f"SUCCESS: Updated version in {citation_cff_path} to {new_version}",
f"and date-released to {new_date}",
)
return True
def bump_version_changelog_md(new_version, new_date):
"""
Bump the version in CHANGELOG.md to new_version and date to new_date
Returns True on success, False on failure
"""
changelog_md_path = "CHANGELOG.md"
pattern = r"(^\s*##\s*Unreleased\s*$)"
new_header = f"\n\n## [{new_version}] - {new_date}\n"
with open(changelog_md_path, "r") as f:
content = f.read()
# Check if the header already exists, so that we don't add a double header
already_exists_pattern = rf"(^\s*##\s*\[ *{re.escape(new_version)} *\])"
if re.search(already_exists_pattern, content, flags=re.MULTILINE):
print(
f"Header for version {new_version} already exists",
f"in {changelog_md_path}.",
)
return True
new_content, n_subs = re.subn(
pattern,
rf"\g<1>{new_header}",
content,
count=1, # replace only the first match
flags=re.MULTILINE,
)
if n_subs < 1:
print(
f"FAILED to update version in {changelog_md_path}.",
"Please update manually.",
)
return False
with open(changelog_md_path, "w") as f:
f.write(new_content)
print(
f"Added header in {changelog_md_path} with version {new_version}",
f"and release date {new_date}",
)
return True
def bump_version(args):
"""Bump the version of plotly.py everywhere it needs to be updated."""
new_version = args.version
new_date = time.strftime("%Y-%m-%d")
success = True
success = success and bump_version_citation_cff(new_version, new_date)
success = success and bump_version_changelog_md(new_version, new_date)
success = success and bump_version_package_json(new_version)
# Do this one last since it's the most visible,
# so that if one of the above commands fails it will be easier to notice
success = success and bump_version_pyproject_toml(new_version)
if not success:
print(
"\n\n*** FAILED to update version for at least one file.",
"Please check the output above for details. ***\n\n",
)
exit(1)
print(
f"\n\n*** SUCCESSFULLY updated version to {new_version}.",
"Please verify the result using `git diff`. ***\n\n",
)
def make_parser():
"""Make argument parser."""
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest="cmd", help="Available subcommands")
p_codegen = subparsers.add_parser("codegen", help="generate code")
p_codegen.add_argument(
"--noformat", action="store_true", help="prevent reformatting"
)
subparsers.add_parser("lint", help="lint code")
subparsers.add_parser("format", help="reformat code")
p_update_dev = subparsers.add_parser(
"updateplotlyjsdev", help="update plotly.js for development"
)
p_update_dev.add_argument(
"plotlyjs_path", help="path to a local plotly.js repository"
)
subparsers.add_parser("updateplotlyjs", help="update plotly.js")
p_bump_version = subparsers.add_parser("bumpversion", help="bump plotly.py version")
# Add a positional argument for the version
p_bump_version.add_argument("version", help="version number")
return parser
def parse_args(parser: argparse.ArgumentParser):
"""Parse command line arguments."""
return parser.parse_args()
def main():
"""Main driver."""
project_root = os.path.dirname(os.path.realpath(__file__))
outdir = os.path.join(project_root, "plotly")
parser = make_parser()
args = parse_args(parser)
if args.cmd == "codegen":
perform_codegen(outdir, noformat=args.noformat)
elif args.cmd == "format":
reformat_code(outdir)
elif args.cmd == "lint":
lint_code(outdir)
elif args.cmd == "updateplotlyjsdev":
update_plotlyjs_dev(args, outdir)
elif args.cmd == "updateplotlyjs":
version = plotly_js_version()
print(version)
update_plotlyjs(version, outdir)
elif args.cmd == "bumpversion":
bump_version(args)
elif args.cmd is None:
parser.print_help()
sys.exit(1)
else:
print(f"unknown command {args.cmd}", file=sys.stderr)
sys.exit(1)
if __name__ == "__main__":
main()
You can’t perform that action at this time.