forked from jupyterlab/jupyterlab
/
labapp.py
810 lines (652 loc) · 28.9 KB
/
labapp.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
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
# coding: utf-8
"""A tornado based Jupyter lab server."""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import json
import os
import os.path as osp
import sys
from os.path import join as pjoin
from jupyter_core.application import JupyterApp, NoStart, base_aliases, base_flags
from jupyter_server._version import version_info as jpserver_version_info
from jupyter_server.serverapp import flags
from jupyter_server.utils import url_path_join as ujoin
from jupyterlab_server import WORKSPACE_EXTENSION, LabServerApp, slugify
from nbclassic.shim import NBClassicConfigShimMixin
from traitlets import Bool, Instance, Unicode, default
from ._version import __version__
from .commands import (
DEV_DIR, HERE, AppOptions, build, clean, ensure_app,
ensure_core, ensure_dev, get_app_dir, get_app_version,
get_user_settings_dir, get_workspaces_dir, pjoin, watch,
watch_dev
)
from .coreconfig import CoreConfig
from .debuglog import DebugLogFileMixin
from .handlers.build_handler import Builder, BuildHandler, build_path
from .handlers.error_handler import ErrorHandler
from .handlers.extension_manager_handler import ExtensionHandler, ExtensionManager, extensions_handler_path
from .handlers.yjs_echo_ws import YJSEchoWS
# TODO: remove when oldest compatible jupyterlab_server contains license tooling
try:
from jupyterlab_server import LicensesApp
except ImportError:
LicensesApp = None
DEV_NOTE = """You're running JupyterLab from source.
If you're working on the TypeScript sources of JupyterLab, try running
jupyter lab --dev-mode --watch
to have the system incrementally watch and build JupyterLab for you, as you
make changes.
"""
CORE_NOTE = """
Running the core application with no additional extensions or settings
"""
build_aliases = dict(base_aliases)
build_aliases['app-dir'] = 'LabBuildApp.app_dir'
build_aliases['name'] = 'LabBuildApp.name'
build_aliases['version'] = 'LabBuildApp.version'
build_aliases['dev-build'] = 'LabBuildApp.dev_build'
build_aliases['minimize'] = 'LabBuildApp.minimize'
build_aliases['debug-log-path'] = 'DebugLogFileMixin.debug_log_path'
build_flags = dict(base_flags)
build_flags['dev-build'] = (
{'LabBuildApp': {'dev_build': True}},
"Build in development mode."
)
build_flags['no-minimize'] = (
{'LabBuildApp': {'minimize': False}},
"Do not minimize a production build."
)
build_flags['splice-source'] = (
{'LabBuildApp': {'splice_source': True}},
"Splice source packages into app directory."
)
version = __version__
app_version = get_app_version()
if version != app_version:
version = '%s (dev), %s (app)' % (__version__, app_version)
buildFailureMsg = """Build failed.
Troubleshooting: If the build failed due to an out-of-memory error, you
may be able to fix it by disabling the `dev_build` and/or `minimize` options.
If you are building via the `jupyter lab build` command, you can disable
these options like so:
jupyter lab build --dev-build=False --minimize=False
You can also disable these options for all JupyterLab builds by adding these
lines to a Jupyter config file named `jupyter_config.py`:
c.LabBuildApp.minimize = False
c.LabBuildApp.dev_build = False
If you don't already have a `jupyter_config.py` file, you can create one by
adding a blank file of that name to any of the Jupyter config directories.
The config directories can be listed by running:
jupyter --paths
Explanation:
- `dev-build`: This option controls whether a `dev` or a more streamlined
`production` build is used. This option will default to `False` (i.e., the
`production` build) for most users. However, if you have any labextensions
installed from local files, this option will instead default to `True`.
Explicitly setting `dev-build` to `False` will ensure that the `production`
build is used in all circumstances.
- `minimize`: This option controls whether your JS bundle is minified
during the Webpack build, which helps to improve JupyterLab's overall
performance. However, the minifier plugin used by Webpack is very memory
intensive, so turning it off may help the build finish successfully in
low-memory environments.
"""
class LabBuildApp(JupyterApp, DebugLogFileMixin):
version = version
description = """
Build the JupyterLab application
The application is built in the JupyterLab app directory in `/staging`.
When the build is complete it is put in the JupyterLab app `/static`
directory, where it is used to serve the application.
"""
aliases = build_aliases
flags = build_flags
# Not configurable!
core_config = Instance(CoreConfig, allow_none=True)
app_dir = Unicode('', config=True,
help="The app directory to build in")
name = Unicode('JupyterLab', config=True,
help="The name of the built application")
version = Unicode('', config=True,
help="The version of the built application")
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 (production mode).")
minimize = Bool(True, config=True,
help="Whether to minimize a production build (defaults to True).")
pre_clean = Bool(False, config=True,
help="Whether to clean before building (defaults to False)")
splice_source = Bool(False, config=True,
help="Splice source packages into app directory.")
def start(self):
app_dir = self.app_dir or get_app_dir()
app_options = AppOptions(
app_dir=app_dir, logger=self.log, core_config=self.core_config, splice_source=self.splice_source
)
self.log.info('JupyterLab %s', version)
with self.debug_logging():
if self.pre_clean:
self.log.info('Cleaning %s' % app_dir)
clean(app_options=app_options)
self.log.info('Building in %s', app_dir)
try:
production = None if self.dev_build is None else not self.dev_build
build(name=self.name, version=self.version,
app_options=app_options, production = production, minimize=self.minimize)
except Exception as e:
print(buildFailureMsg)
raise e
clean_aliases = dict(base_aliases)
clean_aliases['app-dir'] = 'LabCleanApp.app_dir'
ext_warn_msg = "WARNING: this will delete all of your extensions, which will need to be reinstalled"
clean_flags = dict(base_flags)
clean_flags['extensions'] = ({'LabCleanApp': {'extensions': True}},
'Also delete <app-dir>/extensions.\n%s' % ext_warn_msg)
clean_flags['settings'] = ({'LabCleanApp': {'settings': True}}, 'Also delete <app-dir>/settings')
clean_flags['static'] = ({'LabCleanApp': {'static': True}}, 'Also delete <app-dir>/static')
clean_flags['all'] = ({'LabCleanApp': {'all': True}},
'Delete the entire contents of the app directory.\n%s' % ext_warn_msg)
class LabCleanAppOptions(AppOptions):
extensions = Bool(False)
settings = Bool(False)
staging = Bool(True)
static = Bool(False)
all = Bool(False)
class LabCleanApp(JupyterApp):
version = version
description = """
Clean the JupyterLab application
This will clean the app directory by removing the `staging` directories.
Optionally, the `extensions`, `settings`, and/or `static` directories,
or the entire contents of the app directory, can also be removed.
"""
aliases = clean_aliases
flags = clean_flags
# Not configurable!
core_config = Instance(CoreConfig, allow_none=True)
app_dir = Unicode('', config=True, help='The app directory to clean')
extensions = Bool(False, config=True,
help="Also delete <app-dir>/extensions.\n%s" % ext_warn_msg)
settings = Bool(False, config=True, help="Also delete <app-dir>/settings")
static = Bool(False, config=True, help="Also delete <app-dir>/static")
all = Bool(False, config=True,
help="Delete the entire contents of the app directory.\n%s" % ext_warn_msg)
def start(self):
app_options = LabCleanAppOptions(
logger=self.log,
core_config=self.core_config,
app_dir=self.app_dir,
extensions=self.extensions,
settings=self.settings,
static=self.static,
all=self.all
)
clean(app_options=app_options)
class LabPathApp(JupyterApp):
version = version
description = """
Print the configured paths for the JupyterLab application
The application path can be configured using the JUPYTERLAB_DIR
environment variable.
The user settings path can be configured using the JUPYTERLAB_SETTINGS_DIR
environment variable or it will fall back to
`/lab/user-settings` in the default Jupyter configuration directory.
The workspaces path can be configured using the JUPYTERLAB_WORKSPACES_DIR
environment variable or it will fall back to
'/lab/workspaces' in the default Jupyter configuration directory.
"""
def start(self):
print('Application directory: %s' % get_app_dir())
print('User Settings directory: %s' % get_user_settings_dir())
print('Workspaces directory: %s' % get_workspaces_dir())
class LabWorkspaceExportApp(JupyterApp):
version = version
description = """
Export a JupyterLab workspace
If no arguments are passed in, this command will export the default
workspace.
If a workspace name is passed in, this command will export that workspace.
If no workspace is found, this command will export an empty workspace.
"""
def start(self):
app = LabApp(config=self.config)
base_url = app.settings.get('base_url', '/')
directory = app.workspaces_dir
app_url = app.app_url
if len(self.extra_args) > 1:
print('Too many arguments were provided for workspace export.')
self.exit(1)
workspaces_url = ujoin(app_url, 'workspaces')
raw = (app_url if not self.extra_args
else ujoin(workspaces_url, self.extra_args[0]))
slug = slugify(raw, base_url)
workspace_path = pjoin(directory, slug + WORKSPACE_EXTENSION)
if osp.exists(workspace_path):
with open(workspace_path) as fid:
try: # to load the workspace file.
print(fid.read())
except Exception as e:
print(json.dumps(dict(data=dict(), metadata=dict(id=raw))))
else:
print(json.dumps(dict(data=dict(), metadata=dict(id=raw))))
class LabWorkspaceImportApp(JupyterApp):
version = version
description = """
Import a JupyterLab workspace
This command will import a workspace from a JSON file. The format of the
file must be the same as what the export functionality emits.
"""
workspace_name = Unicode(
None,
config=True,
allow_none=True,
help="""
Workspace name. If given, the workspace ID in the imported
file will be replaced with a new ID pointing to this
workspace name.
"""
)
aliases = {
'name': 'LabWorkspaceImportApp.workspace_name'
}
def start(self):
app = LabApp(config=self.config)
base_url = app.settings.get('base_url', '/')
directory = app.workspaces_dir
app_url = app.app_url
workspaces_url = ujoin(app.app_url, 'workspaces')
if len(self.extra_args) != 1:
print('One argument is required for workspace import.')
self.exit(1)
workspace = dict()
with self._smart_open() as fid:
try: # to load, parse, and validate the workspace file.
workspace = self._validate(fid, base_url, app_url, workspaces_url)
except Exception as e:
print('%s is not a valid workspace:\n%s' % (fid.name, e))
self.exit(1)
if not osp.exists(directory):
try:
os.makedirs(directory)
except Exception as e:
print('Workspaces directory could not be created:\n%s' % e)
self.exit(1)
slug = slugify(workspace['metadata']['id'], base_url)
workspace_path = pjoin(directory, slug + WORKSPACE_EXTENSION)
# Write the workspace data to a file.
with open(workspace_path, 'w') as fid:
fid.write(json.dumps(workspace))
print('Saved workspace: %s' % workspace_path)
def _smart_open(self):
file_name = self.extra_args[0]
if file_name == '-':
return sys.stdin
else:
file_path = osp.abspath(file_name)
if not osp.exists(file_path):
print('%s does not exist.' % file_name)
self.exit(1)
return open(file_path)
def _validate(self, data, base_url, app_url, workspaces_url):
workspace = json.load(data)
if 'data' not in workspace:
raise Exception('The `data` field is missing.')
# If workspace_name is set in config, inject the
# name into the workspace metadata.
if self.workspace_name is not None:
if self.workspace_name == "":
workspace_id = ujoin(base_url, app_url)
else:
workspace_id = ujoin(base_url, workspaces_url, self.workspace_name)
workspace['metadata'] = {'id': workspace_id}
# else check that the workspace_id is valid.
else:
if 'id' not in workspace['metadata']:
raise Exception('The `id` field is missing in `metadata`.')
else:
id = workspace['metadata']['id']
if id != ujoin(base_url, app_url) and not id.startswith(ujoin(base_url, workspaces_url)):
error = '%s does not match app_url or start with workspaces_url.'
raise Exception(error % id)
return workspace
class LabWorkspaceApp(JupyterApp):
version = version
description = """
Import or export a JupyterLab workspace
There are two sub-commands for export or import of workspaces. This app
should not otherwise do any work.
"""
subcommands = dict()
subcommands['export'] = (
LabWorkspaceExportApp,
LabWorkspaceExportApp.description.splitlines()[0]
)
subcommands['import'] = (
LabWorkspaceImportApp,
LabWorkspaceImportApp.description.splitlines()[0]
)
def start(self):
try:
super().start()
print('Either `export` or `import` must be specified.')
self.exit(1)
except NoStart:
pass
self.exit(0)
if LicensesApp is not None:
class LabLicensesApp(LicensesApp):
version = version
dev_mode = Bool(
False,
config=True,
help="""Whether to start the app in dev mode. Uses the unpublished local
JavaScript packages in the `dev_mode` folder. In this case JupyterLab will
show a red stripe at the top of the page. It can only be used if JupyterLab
is installed as `pip install -e .`.
""",
)
app_dir = Unicode(
"", config=True, help="The app directory for which to show licenses"
)
aliases = {
**LicensesApp.aliases,
"app-dir": "LabLicensesApp.app_dir",
}
flags = {
**LicensesApp.flags,
"dev-mode": (
{"LabLicensesApp": {"dev_mode": True}},
"Start the app in dev mode for running from source.",
),
}
@default('app_dir')
def _default_app_dir(self):
return get_app_dir()
@default('static_dir')
def _default_static_dir(self):
return pjoin(self.app_dir, 'static')
aliases = dict(base_aliases)
aliases.update({
'ip': 'ServerApp.ip',
'port': 'ServerApp.port',
'port-retries': 'ServerApp.port_retries',
'keyfile': 'ServerApp.keyfile',
'certfile': 'ServerApp.certfile',
'client-ca': 'ServerApp.client_ca',
'notebook-dir': 'ServerApp.root_dir',
'browser': 'ServerApp.browser',
'pylab': 'ServerApp.pylab',
})
class LabApp(NBClassicConfigShimMixin, LabServerApp):
version = version
name = "lab"
app_name = "JupyterLab"
# Should your extension expose other server extensions when launched directly?
load_other_extensions = True
description = """
JupyterLab - An extensible computational environment for Jupyter.
This launches a Tornado based HTML Server that serves up an
HTML5/Javascript JupyterLab client.
JupyterLab has three different modes of running:
* Core mode (`--core-mode`): in this mode JupyterLab will run using the JavaScript
assets contained in the installed `jupyterlab` Python package. In core mode, no
extensions are enabled. This is the default in a stable JupyterLab release if you
have no extensions installed.
* Dev mode (`--dev-mode`): uses the unpublished local JavaScript packages in the
`dev_mode` folder. In this case JupyterLab will show a red stripe at the top of
the page. It can only be used if JupyterLab is installed as `pip install -e .`.
* App mode: JupyterLab allows multiple JupyterLab "applications" to be
created by the user with different combinations of extensions. The `--app-dir` can
be used to set a directory for different applications. The default application
path can be found using `jupyter lab path`.
"""
examples = """
jupyter lab # start JupyterLab
jupyter lab --dev-mode # start JupyterLab in development mode, with no extensions
jupyter lab --core-mode # start JupyterLab in core mode, with no extensions
jupyter lab --app-dir=~/myjupyterlabapp # start JupyterLab with a particular set of extensions
jupyter lab --certfile=mycert.pem # use SSL/TLS certificate
"""
aliases = aliases
aliases.update({
'watch': 'LabApp.watch',
})
aliases['app-dir'] = 'LabApp.app_dir'
flags = flags
flags['core-mode'] = (
{'LabApp': {'core_mode': True}},
"Start the app in core mode."
)
flags['dev-mode'] = (
{'LabApp': {'dev_mode': True}},
"Start the app in dev mode for running from source."
)
flags['watch'] = (
{'LabApp': {'watch': True}},
"Start the app in watch mode."
)
flags['splice-source'] = (
{'LabApp': {'splice_source': True}},
"Splice source packages into app directory."
)
flags['expose-app-in-browser'] = (
{'LabApp': {'expose_app_in_browser': True}},
"Expose the global app instance to browser via window.jupyterlab."
)
flags['extensions-in-dev-mode'] = (
{'LabApp': {'extensions_in_dev_mode': True}},
"Load prebuilt extensions in dev-mode."
)
flags['collaborative'] = (
{'LabApp': {'collaborative': True}},
"Whether to enable collaborative mode."
)
subcommands = dict(
build=(LabBuildApp, LabBuildApp.description.splitlines()[0]),
clean=(LabCleanApp, LabCleanApp.description.splitlines()[0]),
path=(LabPathApp, LabPathApp.description.splitlines()[0]),
paths=(LabPathApp, LabPathApp.description.splitlines()[0]),
workspace=(LabWorkspaceApp, LabWorkspaceApp.description.splitlines()[0]),
workspaces=(LabWorkspaceApp, LabWorkspaceApp.description.splitlines()[0])
)
# TODO: remove when oldest compatible jupyterlab_server contains license tooling
if LicensesApp is not None:
subcommands.update(
licenses=(LabLicensesApp, LabLicensesApp.description.splitlines()[0])
)
default_url = Unicode('/lab', config=True,
help="The default URL to redirect to from `/`")
override_static_url = Unicode(config=True, help=('The override url for static lab assets, typically a CDN.'))
override_theme_url = Unicode(config=True, help=('The override url for static lab theme assets, typically a CDN.'))
app_dir = Unicode(None, config=True,
help="The app directory to launch JupyterLab from.")
user_settings_dir = Unicode(get_user_settings_dir(), config=True,
help="The directory for user settings.")
workspaces_dir = Unicode(get_workspaces_dir(), config=True,
help="The directory for workspaces")
core_mode = Bool(False, config=True,
help="""Whether to start the app in core mode. In this mode, JupyterLab
will run using the JavaScript assets that are within the installed
JupyterLab Python package. In core mode, third party extensions are disabled.
The `--dev-mode` flag is an alias to this to be used when the Python package
itself is installed in development mode (`pip install -e .`).
""")
dev_mode = Bool(False, config=True,
help="""Whether to start the app in dev mode. Uses the unpublished local
JavaScript packages in the `dev_mode` folder. In this case JupyterLab will
show a red stripe at the top of the page. It can only be used if JupyterLab
is installed as `pip install -e .`.
""")
extensions_in_dev_mode = Bool(False, config=True,
help="""Whether to load prebuilt extensions in dev mode. This may be
useful to run and test prebuilt extensions in development installs of
JupyterLab. APIs in a JupyterLab development install may be
incompatible with published packages, so prebuilt extensions compiled
against published packages may not work correctly.""")
watch = Bool(False, config=True,
help="Whether to serve the app in watch mode")
splice_source = Bool(False, config=True,
help="Splice source packages into app directory.")
expose_app_in_browser = Bool(False, config=True,
help="Whether to expose the global app instance to browser via window.jupyterlab")
collaborative = Bool(False, config=True,
help="Whether to enable collaborative mode.")
@default('app_dir')
def _default_app_dir(self):
app_dir = get_app_dir()
if self.core_mode:
app_dir = HERE
elif self.dev_mode:
app_dir = DEV_DIR
return app_dir
@default('app_settings_dir')
def _default_app_settings_dir(self):
return pjoin(self.app_dir, 'settings')
@default('app_version')
def _default_app_version(self):
return app_version
@default('cache_files')
def _default_cache_files(self):
return False
@default('schemas_dir')
def _default_schemas_dir(self):
return pjoin(self.app_dir, 'schemas')
@default('templates_dir')
def _default_templates_dir(self):
return pjoin(self.app_dir, 'static')
@default('themes_dir')
def _default_themes_dir(self):
if self.override_theme_url:
return ''
return pjoin(self.app_dir, 'themes')
@default('static_dir')
def _default_static_dir(self):
return pjoin(self.app_dir, 'static')
@default('static_url_prefix')
def _default_static_url_prefix(self):
if self.override_static_url:
return self.override_static_url
else:
static_url = "/static/{name}/".format(
name=self.name)
return ujoin(self.serverapp.base_url, static_url)
@default('theme_url')
def _default_theme_url(self):
if self.override_theme_url:
return self.override_theme_url
return ''
def initialize_templates(self):
# Determine which model to run JupyterLab
if self.core_mode or self.app_dir.startswith(HERE):
self.core_mode = True
self.log.info('Running JupyterLab in core mode')
if self.dev_mode or self.app_dir.startswith(DEV_DIR):
self.dev_mode = True
self.log.info('Running JupyterLab in dev mode')
if self.watch and self.core_mode:
self.log.warn('Cannot watch in core mode, did you mean --dev-mode?')
self.watch = False
if self.core_mode and self.dev_mode:
self.log.warn('Conflicting modes, choosing dev_mode over core_mode')
self.core_mode = False
# Set the paths based on JupyterLab's mode.
if self.dev_mode:
dev_static_dir = ujoin(DEV_DIR, 'static')
self.static_paths = [dev_static_dir]
self.template_paths = [dev_static_dir]
if not self.extensions_in_dev_mode:
self.labextensions_path = []
self.extra_labextensions_path = []
elif self.core_mode:
dev_static_dir = ujoin(HERE, 'static')
self.static_paths = [dev_static_dir]
self.template_paths = [dev_static_dir]
self.labextensions_path = []
self.extra_labextensions_path = []
else:
self.static_paths = [self.static_dir]
self.template_paths = [self.templates_dir]
def initialize_settings(self):
super().initialize_settings()
def initialize_handlers(self):
handlers = []
# Set config for Jupyterlab
page_config = self.serverapp.web_app.settings.setdefault('page_config_data', {})
page_config.setdefault('buildAvailable', not self.core_mode and not self.dev_mode)
page_config.setdefault('buildCheck', not self.core_mode and not self.dev_mode)
page_config['devMode'] = self.dev_mode
page_config['token'] = self.serverapp.token
page_config['exposeAppInBrowser'] = self.expose_app_in_browser
page_config['quitButton'] = self.serverapp.quit_button
page_config['collaborative'] = self.collaborative
# Client-side code assumes notebookVersion is a JSON-encoded string
page_config['notebookVersion'] = json.dumps(jpserver_version_info)
self.log.info('JupyterLab extension loaded from %s' % HERE)
self.log.info('JupyterLab application directory is %s' % self.app_dir)
build_handler_options = AppOptions(logger=self.log, app_dir=self.app_dir, labextensions_path = self.extra_labextensions_path + self.labextensions_path, splice_source=self.splice_source)
builder = Builder(self.core_mode, app_options=build_handler_options)
build_handler = (build_path, BuildHandler, {'builder': builder})
handlers.append(build_handler)
#YJS_Echo WS Handler
yjs_echo_handler = (r"/api/yjs/(.*)", YJSEchoWS)
handlers.append(yjs_echo_handler)
errored = False
if self.core_mode:
self.log.info(CORE_NOTE.strip())
ensure_core(self.log)
elif self.dev_mode:
if not self.watch:
ensure_dev(self.log)
self.log.info(DEV_NOTE)
else:
if self.splice_source:
ensure_dev(self.log)
msgs = ensure_app(self.app_dir)
if msgs:
[self.log.error(msg) for msg in msgs]
handler = (self.app_url, ErrorHandler, { 'messages': msgs })
handlers.append(handler)
errored = True
if self.watch:
self.log.info('Starting JupyterLab watch mode...')
if self.dev_mode:
watch_dev(self.log)
else:
watch(app_options=build_handler_options)
page_config['buildAvailable'] = False
self.cache_files = False
if not self.core_mode and not errored:
ext_manager = ExtensionManager(app_options=build_handler_options)
ext_handler = (
extensions_handler_path,
ExtensionHandler,
{'manager': ext_manager}
)
handlers.append(ext_handler)
# If running under JupyterHub, add more metadata.
if 'hub_prefix' in self.serverapp.tornado_settings:
tornado_settings = self.serverapp.tornado_settings
hub_prefix = tornado_settings['hub_prefix']
page_config['hubPrefix'] = hub_prefix
page_config['hubHost'] = tornado_settings['hub_host']
page_config['hubUser'] = tornado_settings['user']
page_config['shareUrl'] = ujoin(hub_prefix, 'user-redirect')
# Assume the server_name property indicates running JupyterHub 1.0.
if hasattr(self.serverapp, 'server_name'):
page_config['hubServerName'] = self.serverapp.server_name
api_token = os.getenv('JUPYTERHUB_API_TOKEN', '')
page_config['token'] = api_token
# Update Jupyter Server's webapp settings with jupyterlab settings.
self.serverapp.web_app.settings['page_config_data'] = page_config
# Extend Server handlers with jupyterlab handlers.
self.handlers.extend(handlers)
super().initialize_handlers()
def initialize(self, argv=None):
"""Subclass because the ExtensionApp.initialize() method does not take arguments"""
super().initialize()
#-----------------------------------------------------------------------------
# Main entry point
#-----------------------------------------------------------------------------
main = launch_new_instance = LabApp.launch_instance
if __name__ == '__main__':
main()