/
labextensions.py
309 lines (238 loc) · 9.87 KB
/
labextensions.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
# coding: utf-8
"""Jupyter LabExtension Entry Points."""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import os
import sys
import traceback
from copy import copy
from jupyter_core.application import JupyterApp, base_flags, base_aliases
from traitlets import Bool, Instance, Unicode
from .commands import (
install_extension, uninstall_extension, list_extensions,
enable_extension, disable_extension, check_extension,
link_package, unlink_package, build, get_app_version, HERE,
update_extension,
)
from .coreconfig import CoreConfig
from .debuglog import DebugLogFileMixin
flags = dict(base_flags)
flags['no-build'] = (
{'BaseExtensionApp': {'should_build': False}},
"Defer building the app after the action."
)
flags['clean'] = (
{'BaseExtensionApp': {'should_clean': True}},
"Cleanup intermediate files after the action."
)
check_flags = copy(flags)
check_flags['installed'] = (
{'CheckLabExtensionsApp': {'should_check_installed_only': True}},
"Check only if the extension is installed."
)
update_flags = copy(flags)
update_flags['all'] = (
{'UpdateLabExtensionApp': {'all': True}},
"Update all extensions"
)
uninstall_flags = copy(flags)
uninstall_flags['all'] = (
{'UninstallLabExtensionApp': {'all': True}},
"Uninstall all extensions"
)
aliases = dict(base_aliases)
aliases['app-dir'] = 'BaseExtensionApp.app_dir'
aliases['dev-build'] = 'BaseExtensionApp.dev_build'
aliases['minimize'] = 'BaseExtensionApp.minimize'
aliases['debug-log-path'] = 'DebugLogFileMixin.debug_log_path'
install_aliases = copy(aliases)
install_aliases['pin-version-as'] = 'InstallLabExtensionApp.pin'
VERSION = get_app_version()
class BaseExtensionApp(JupyterApp, DebugLogFileMixin):
version = VERSION
flags = flags
aliases = aliases
# Not configurable!
core_config = Instance(CoreConfig, allow_none=True)
app_dir = Unicode('', config=True,
help="The app directory to target")
should_build = Bool(True, config=True,
help="Whether to build the app after the action")
dev_build = Bool(None, allow_none=True, config=True,
help="Whether to build in dev mode. Defaults to True (dev mode) if there are any locally linked extensions, else defaults to False (prod mode).")
minimize = Bool(True, config=True,
help="Whether to use a minifier during the Webpack build (defaults to True). Only affects production builds.")
should_clean = Bool(False, config=True,
help="Whether temporary files should be cleaned up after building jupyterlab")
def start(self):
if self.app_dir and self.app_dir.startswith(HERE):
raise ValueError('Cannot run lab extension commands in core app')
with self.debug_logging():
ans = self.run_task()
if ans and self.should_build:
parts = ['build']
parts.append('none' if self.dev_build is None else
'dev' if self.dev_build else
'prod')
if self.minimize:
parts.append('minimize')
command = ':'.join(parts)
build(app_dir=self.app_dir, clean_staging=self.should_clean,
logger=self.log, command=command,
core_config=self.core_config)
def run_task(self):
pass
def _log_format_default(self):
"""A default format for messages"""
return "%(message)s"
class InstallLabExtensionApp(BaseExtensionApp):
description = """Install labextension(s)
Usage
jupyter labextension install [--pin-version-as <alias,...>] <package...>
This installs JupyterLab extensions similar to yarn add or npm install.
Pass a list of comma seperate names to the --pin-version-as flag
to use as alises for the packages providers. This is useful to
install multiple versions of the same extension.
These can be uninstalled with the alias you provided
to the flag, similar to the "alias" feature of yarn add.
"""
aliases = install_aliases
pin = Unicode('', config=True,
help="Pin this version with a certain alias")
def run_task(self):
pinned_versions = self.pin.split(',')
self.extra_args = self.extra_args or [os.getcwd()]
return any([
install_extension(
arg,
self.app_dir,
logger=self.log,
core_config=self.core_config,
# Pass in pinned alias if we have it
pin=pinned_versions[i] if i < len(pinned_versions) else None
)
for i, arg in enumerate(self.extra_args)
])
class UpdateLabExtensionApp(BaseExtensionApp):
description = "Update labextension(s)"
flags = update_flags
all = Bool(False, config=True,
help="Whether to update all extensions")
def run_task(self):
if not self.all and not self.extra_args:
self.log.warn('Specify an extension to update, or use --all to update all extensions')
return False
if self.all:
return update_extension(
all_=True, app_dir=self.app_dir, logger=self.log,
core_config=self.core_config)
return any([
update_extension(
name=arg, app_dir=self.app_dir, logger=self.log,
core_config=self.core_config)
for arg in self.extra_args
])
class LinkLabExtensionApp(BaseExtensionApp):
description = """
Link local npm packages that are not lab extensions.
Links a package to the JupyterLab build process. A linked
package is manually re-installed from its source location when
`jupyter lab build` is run.
"""
should_build = Bool(True, config=True,
help="Whether to build the app after the action")
def run_task(self):
self.extra_args = self.extra_args or [os.getcwd()]
return any([
link_package(
arg, self.app_dir, logger=self.log,
core_config=self.core_config)
for arg in self.extra_args
])
class UnlinkLabExtensionApp(BaseExtensionApp):
description = "Unlink packages by name or path"
def run_task(self):
self.extra_args = self.extra_args or [os.getcwd()]
return any([
unlink_package(
arg, self.app_dir, logger=self.log,
core_config=self.core_config)
for arg in self.extra_args
])
class UninstallLabExtensionApp(BaseExtensionApp):
description = "Uninstall labextension(s) by name"
flags = uninstall_flags
all = Bool(False, config=True,
help="Whether to uninstall all extensions")
def run_task(self):
self.extra_args = self.extra_args or [os.getcwd()]
return any([
uninstall_extension(
arg, all_=self.all, app_dir=self.app_dir, logger=self.log,
core_config=self.core_config)
for arg in self.extra_args
])
class ListLabExtensionsApp(BaseExtensionApp):
description = "List the installed labextensions"
def run_task(self):
list_extensions(
self.app_dir, logger=self.log, core_config=self.core_config)
class EnableLabExtensionsApp(BaseExtensionApp):
description = "Enable labextension(s) by name"
def run_task(self):
[enable_extension(
arg, self.app_dir, logger=self.log, core_config=self.core_config)
for arg in self.extra_args]
class DisableLabExtensionsApp(BaseExtensionApp):
description = "Disable labextension(s) by name"
def run_task(self):
[disable_extension(
arg, self.app_dir, logger=self.log, core_config=self.core_config)
for arg in self.extra_args]
class CheckLabExtensionsApp(BaseExtensionApp):
description = "Check labextension(s) by name"
flags = check_flags
should_check_installed_only = Bool(False, config=True,
help="Whether it should check only if the extensions is installed")
def run_task(self):
all_enabled = all(
check_extension(
arg, self.app_dir,
self.should_check_installed_only,
logger=self.log,
core_config=self.core_config)
for arg in self.extra_args)
if not all_enabled:
self.exit(1)
_examples = """
jupyter labextension list # list all configured labextensions
jupyter labextension install <extension name> # install a labextension
jupyter labextension uninstall <extension name> # uninstall a labextension
"""
class LabExtensionApp(JupyterApp):
"""Base jupyter labextension command entry point"""
name = "jupyter labextension"
version = VERSION
description = "Work with JupyterLab extensions"
examples = _examples
subcommands = dict(
install=(InstallLabExtensionApp, "Install labextension(s)"),
update=(UpdateLabExtensionApp, "Update labextension(s)"),
uninstall=(UninstallLabExtensionApp, "Uninstall labextension(s)"),
list=(ListLabExtensionsApp, "List labextensions"),
link=(LinkLabExtensionApp, "Link labextension(s)"),
unlink=(UnlinkLabExtensionApp, "Unlink labextension(s)"),
enable=(EnableLabExtensionsApp, "Enable labextension(s)"),
disable=(DisableLabExtensionsApp, "Disable labextension(s)"),
check=(CheckLabExtensionsApp, "Check labextension(s)"),
)
def start(self):
"""Perform the App's functions as configured"""
super(LabExtensionApp, self).start()
# The above should have called a subcommand and raised NoStart; if we
# get here, it didn't, so we should self.log.info a message.
subcmds = ", ".join(sorted(self.subcommands))
self.exit("Please supply at least one subcommand: %s" % subcmds)
main = LabExtensionApp.launch_instance
if __name__ == '__main__':
sys.exit(main())