##// END OF EJS Templates
pass profile-dir instead of profile to Kernel...
MinRK -
Show More
@@ -1,723 +1,726
1 # coding: utf-8
1 # coding: utf-8
2 """A tornado based IPython notebook server.
2 """A tornado based IPython notebook server.
3
3
4 Authors:
4 Authors:
5
5
6 * Brian Granger
6 * Brian Granger
7 """
7 """
8 #-----------------------------------------------------------------------------
8 #-----------------------------------------------------------------------------
9 # Copyright (C) 2013 The IPython Development Team
9 # Copyright (C) 2013 The IPython Development Team
10 #
10 #
11 # Distributed under the terms of the BSD License. The full license is in
11 # Distributed under the terms of the BSD License. The full license is in
12 # the file COPYING, distributed as part of this software.
12 # the file COPYING, distributed as part of this software.
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14
14
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16 # Imports
16 # Imports
17 #-----------------------------------------------------------------------------
17 #-----------------------------------------------------------------------------
18
18
19 # stdlib
19 # stdlib
20 import errno
20 import errno
21 import logging
21 import logging
22 import os
22 import os
23 import random
23 import random
24 import select
24 import select
25 import signal
25 import signal
26 import socket
26 import socket
27 import sys
27 import sys
28 import threading
28 import threading
29 import time
29 import time
30 import webbrowser
30 import webbrowser
31
31
32
32
33 # Third party
33 # Third party
34 # check for pyzmq 2.1.11
34 # check for pyzmq 2.1.11
35 from IPython.utils.zmqrelated import check_for_zmq
35 from IPython.utils.zmqrelated import check_for_zmq
36 check_for_zmq('2.1.11', 'IPython.html')
36 check_for_zmq('2.1.11', 'IPython.html')
37
37
38 from jinja2 import Environment, FileSystemLoader
38 from jinja2 import Environment, FileSystemLoader
39
39
40 # Install the pyzmq ioloop. This has to be done before anything else from
40 # Install the pyzmq ioloop. This has to be done before anything else from
41 # tornado is imported.
41 # tornado is imported.
42 from zmq.eventloop import ioloop
42 from zmq.eventloop import ioloop
43 ioloop.install()
43 ioloop.install()
44
44
45 # check for tornado 2.1.0
45 # check for tornado 2.1.0
46 msg = "The IPython Notebook requires tornado >= 2.1.0"
46 msg = "The IPython Notebook requires tornado >= 2.1.0"
47 try:
47 try:
48 import tornado
48 import tornado
49 except ImportError:
49 except ImportError:
50 raise ImportError(msg)
50 raise ImportError(msg)
51 try:
51 try:
52 version_info = tornado.version_info
52 version_info = tornado.version_info
53 except AttributeError:
53 except AttributeError:
54 raise ImportError(msg + ", but you have < 1.1.0")
54 raise ImportError(msg + ", but you have < 1.1.0")
55 if version_info < (2,1,0):
55 if version_info < (2,1,0):
56 raise ImportError(msg + ", but you have %s" % tornado.version)
56 raise ImportError(msg + ", but you have %s" % tornado.version)
57
57
58 from tornado import httpserver
58 from tornado import httpserver
59 from tornado import web
59 from tornado import web
60
60
61 # Our own libraries
61 # Our own libraries
62 from IPython.html import DEFAULT_STATIC_FILES_PATH
62 from IPython.html import DEFAULT_STATIC_FILES_PATH
63
63
64 from .services.kernels.kernelmanager import MappingKernelManager
64 from .services.kernels.kernelmanager import MappingKernelManager
65 from .services.notebooks.nbmanager import NotebookManager
65 from .services.notebooks.nbmanager import NotebookManager
66 from .services.notebooks.filenbmanager import FileNotebookManager
66 from .services.notebooks.filenbmanager import FileNotebookManager
67 from .services.clusters.clustermanager import ClusterManager
67 from .services.clusters.clustermanager import ClusterManager
68
68
69 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
69 from .base.handlers import AuthenticatedFileHandler, FileFindHandler
70
70
71 from IPython.config.application import catch_config_error, boolean_flag
71 from IPython.config.application import catch_config_error, boolean_flag
72 from IPython.core.application import BaseIPythonApplication
72 from IPython.core.application import BaseIPythonApplication
73 from IPython.consoleapp import IPythonConsoleApp
73 from IPython.consoleapp import IPythonConsoleApp
74 from IPython.kernel import swallow_argv
74 from IPython.kernel import swallow_argv
75 from IPython.kernel.zmq.session import default_secure
75 from IPython.kernel.zmq.session import default_secure
76 from IPython.kernel.zmq.kernelapp import (
76 from IPython.kernel.zmq.kernelapp import (
77 kernel_flags,
77 kernel_flags,
78 kernel_aliases,
78 kernel_aliases,
79 )
79 )
80 from IPython.utils.importstring import import_item
80 from IPython.utils.importstring import import_item
81 from IPython.utils.localinterfaces import LOCALHOST
81 from IPython.utils.localinterfaces import LOCALHOST
82 from IPython.utils import submodule
82 from IPython.utils import submodule
83 from IPython.utils.traitlets import (
83 from IPython.utils.traitlets import (
84 Dict, Unicode, Integer, List, Bool, Bytes,
84 Dict, Unicode, Integer, List, Bool, Bytes,
85 DottedObjectName
85 DottedObjectName
86 )
86 )
87 from IPython.utils import py3compat
87 from IPython.utils import py3compat
88 from IPython.utils.path import filefind
88 from IPython.utils.path import filefind
89
89
90 from .utils import url_path_join
90 from .utils import url_path_join
91
91
92 #-----------------------------------------------------------------------------
92 #-----------------------------------------------------------------------------
93 # Module globals
93 # Module globals
94 #-----------------------------------------------------------------------------
94 #-----------------------------------------------------------------------------
95
95
96 _examples = """
96 _examples = """
97 ipython notebook # start the notebook
97 ipython notebook # start the notebook
98 ipython notebook --profile=sympy # use the sympy profile
98 ipython notebook --profile=sympy # use the sympy profile
99 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
99 ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
100 """
100 """
101
101
102 #-----------------------------------------------------------------------------
102 #-----------------------------------------------------------------------------
103 # Helper functions
103 # Helper functions
104 #-----------------------------------------------------------------------------
104 #-----------------------------------------------------------------------------
105
105
106 def random_ports(port, n):
106 def random_ports(port, n):
107 """Generate a list of n random ports near the given port.
107 """Generate a list of n random ports near the given port.
108
108
109 The first 5 ports will be sequential, and the remaining n-5 will be
109 The first 5 ports will be sequential, and the remaining n-5 will be
110 randomly selected in the range [port-2*n, port+2*n].
110 randomly selected in the range [port-2*n, port+2*n].
111 """
111 """
112 for i in range(min(5, n)):
112 for i in range(min(5, n)):
113 yield port + i
113 yield port + i
114 for i in range(n-5):
114 for i in range(n-5):
115 yield port + random.randint(-2*n, 2*n)
115 yield port + random.randint(-2*n, 2*n)
116
116
117 def load_handlers(name):
117 def load_handlers(name):
118 """Load the (URL pattern, handler) tuples for each component."""
118 """Load the (URL pattern, handler) tuples for each component."""
119 name = 'IPython.html.' + name
119 name = 'IPython.html.' + name
120 mod = __import__(name, fromlist=['default_handlers'])
120 mod = __import__(name, fromlist=['default_handlers'])
121 return mod.default_handlers
121 return mod.default_handlers
122
122
123 #-----------------------------------------------------------------------------
123 #-----------------------------------------------------------------------------
124 # The Tornado web application
124 # The Tornado web application
125 #-----------------------------------------------------------------------------
125 #-----------------------------------------------------------------------------
126
126
127 class NotebookWebApplication(web.Application):
127 class NotebookWebApplication(web.Application):
128
128
129 def __init__(self, ipython_app, kernel_manager, notebook_manager,
129 def __init__(self, ipython_app, kernel_manager, notebook_manager,
130 cluster_manager, log,
130 cluster_manager, log,
131 base_project_url, settings_overrides):
131 base_project_url, settings_overrides):
132
132
133 settings = self.init_settings(
133 settings = self.init_settings(
134 ipython_app, kernel_manager, notebook_manager, cluster_manager,
134 ipython_app, kernel_manager, notebook_manager, cluster_manager,
135 log, base_project_url, settings_overrides)
135 log, base_project_url, settings_overrides)
136 handlers = self.init_handlers(settings)
136 handlers = self.init_handlers(settings)
137
137
138 super(NotebookWebApplication, self).__init__(handlers, **settings)
138 super(NotebookWebApplication, self).__init__(handlers, **settings)
139
139
140 def init_settings(self, ipython_app, kernel_manager, notebook_manager,
140 def init_settings(self, ipython_app, kernel_manager, notebook_manager,
141 cluster_manager, log,
141 cluster_manager, log,
142 base_project_url, settings_overrides):
142 base_project_url, settings_overrides):
143 # Python < 2.6.5 doesn't accept unicode keys in f(**kwargs), and
143 # Python < 2.6.5 doesn't accept unicode keys in f(**kwargs), and
144 # base_project_url will always be unicode, which will in turn
144 # base_project_url will always be unicode, which will in turn
145 # make the patterns unicode, and ultimately result in unicode
145 # make the patterns unicode, and ultimately result in unicode
146 # keys in kwargs to handler._execute(**kwargs) in tornado.
146 # keys in kwargs to handler._execute(**kwargs) in tornado.
147 # This enforces that base_project_url be ascii in that situation.
147 # This enforces that base_project_url be ascii in that situation.
148 #
148 #
149 # Note that the URLs these patterns check against are escaped,
149 # Note that the URLs these patterns check against are escaped,
150 # and thus guaranteed to be ASCII: 'hΓ©llo' is really 'h%C3%A9llo'.
150 # and thus guaranteed to be ASCII: 'hΓ©llo' is really 'h%C3%A9llo'.
151 base_project_url = py3compat.unicode_to_str(base_project_url, 'ascii')
151 base_project_url = py3compat.unicode_to_str(base_project_url, 'ascii')
152 template_path = settings_overrides.get("template_path", os.path.join(os.path.dirname(__file__), "templates"))
152 template_path = settings_overrides.get("template_path", os.path.join(os.path.dirname(__file__), "templates"))
153 settings = dict(
153 settings = dict(
154 # basics
154 # basics
155 base_project_url=base_project_url,
155 base_project_url=base_project_url,
156 base_kernel_url=ipython_app.base_kernel_url,
156 base_kernel_url=ipython_app.base_kernel_url,
157 template_path=template_path,
157 template_path=template_path,
158 static_path=ipython_app.static_file_path,
158 static_path=ipython_app.static_file_path,
159 static_handler_class = FileFindHandler,
159 static_handler_class = FileFindHandler,
160 static_url_prefix = url_path_join(base_project_url,'/static/'),
160 static_url_prefix = url_path_join(base_project_url,'/static/'),
161
161
162 # authentication
162 # authentication
163 cookie_secret=ipython_app.cookie_secret,
163 cookie_secret=ipython_app.cookie_secret,
164 login_url=url_path_join(base_project_url,'/login'),
164 login_url=url_path_join(base_project_url,'/login'),
165 password=ipython_app.password,
165 password=ipython_app.password,
166
166
167 # managers
167 # managers
168 kernel_manager=kernel_manager,
168 kernel_manager=kernel_manager,
169 notebook_manager=notebook_manager,
169 notebook_manager=notebook_manager,
170 cluster_manager=cluster_manager,
170 cluster_manager=cluster_manager,
171
171
172 # IPython stuff
172 # IPython stuff
173 mathjax_url=ipython_app.mathjax_url,
173 mathjax_url=ipython_app.mathjax_url,
174 config=ipython_app.config,
174 config=ipython_app.config,
175 use_less=ipython_app.use_less,
175 use_less=ipython_app.use_less,
176 jinja2_env=Environment(loader=FileSystemLoader(template_path)),
176 jinja2_env=Environment(loader=FileSystemLoader(template_path)),
177 )
177 )
178
178
179 # allow custom overrides for the tornado web app.
179 # allow custom overrides for the tornado web app.
180 settings.update(settings_overrides)
180 settings.update(settings_overrides)
181 return settings
181 return settings
182
182
183 def init_handlers(self, settings):
183 def init_handlers(self, settings):
184 # Load the (URL pattern, handler) tuples for each component.
184 # Load the (URL pattern, handler) tuples for each component.
185 handlers = []
185 handlers = []
186 handlers.extend(load_handlers('base.handlers'))
186 handlers.extend(load_handlers('base.handlers'))
187 handlers.extend(load_handlers('tree.handlers'))
187 handlers.extend(load_handlers('tree.handlers'))
188 handlers.extend(load_handlers('auth.login'))
188 handlers.extend(load_handlers('auth.login'))
189 handlers.extend(load_handlers('auth.logout'))
189 handlers.extend(load_handlers('auth.logout'))
190 handlers.extend(load_handlers('notebook.handlers'))
190 handlers.extend(load_handlers('notebook.handlers'))
191 handlers.extend(load_handlers('services.kernels.handlers'))
191 handlers.extend(load_handlers('services.kernels.handlers'))
192 handlers.extend(load_handlers('services.notebooks.handlers'))
192 handlers.extend(load_handlers('services.notebooks.handlers'))
193 handlers.extend(load_handlers('services.clusters.handlers'))
193 handlers.extend(load_handlers('services.clusters.handlers'))
194 handlers.extend([
194 handlers.extend([
195 (r"/files/(.*)", AuthenticatedFileHandler, {'path' : settings['notebook_manager'].notebook_dir}),
195 (r"/files/(.*)", AuthenticatedFileHandler, {'path' : settings['notebook_manager'].notebook_dir}),
196 ])
196 ])
197 # prepend base_project_url onto the patterns that we match
197 # prepend base_project_url onto the patterns that we match
198 new_handlers = []
198 new_handlers = []
199 for handler in handlers:
199 for handler in handlers:
200 pattern = url_path_join(settings['base_project_url'], handler[0])
200 pattern = url_path_join(settings['base_project_url'], handler[0])
201 new_handler = tuple([pattern] + list(handler[1:]))
201 new_handler = tuple([pattern] + list(handler[1:]))
202 new_handlers.append(new_handler)
202 new_handlers.append(new_handler)
203 return new_handlers
203 return new_handlers
204
204
205
205
206
206
207 #-----------------------------------------------------------------------------
207 #-----------------------------------------------------------------------------
208 # Aliases and Flags
208 # Aliases and Flags
209 #-----------------------------------------------------------------------------
209 #-----------------------------------------------------------------------------
210
210
211 flags = dict(kernel_flags)
211 flags = dict(kernel_flags)
212 flags['no-browser']=(
212 flags['no-browser']=(
213 {'NotebookApp' : {'open_browser' : False}},
213 {'NotebookApp' : {'open_browser' : False}},
214 "Don't open the notebook in a browser after startup."
214 "Don't open the notebook in a browser after startup."
215 )
215 )
216 flags['no-mathjax']=(
216 flags['no-mathjax']=(
217 {'NotebookApp' : {'enable_mathjax' : False}},
217 {'NotebookApp' : {'enable_mathjax' : False}},
218 """Disable MathJax
218 """Disable MathJax
219
219
220 MathJax is the javascript library IPython uses to render math/LaTeX. It is
220 MathJax is the javascript library IPython uses to render math/LaTeX. It is
221 very large, so you may want to disable it if you have a slow internet
221 very large, so you may want to disable it if you have a slow internet
222 connection, or for offline use of the notebook.
222 connection, or for offline use of the notebook.
223
223
224 When disabled, equations etc. will appear as their untransformed TeX source.
224 When disabled, equations etc. will appear as their untransformed TeX source.
225 """
225 """
226 )
226 )
227
227
228 # Add notebook manager flags
228 # Add notebook manager flags
229 flags.update(boolean_flag('script', 'FileNotebookManager.save_script',
229 flags.update(boolean_flag('script', 'FileNotebookManager.save_script',
230 'Auto-save a .py script everytime the .ipynb notebook is saved',
230 'Auto-save a .py script everytime the .ipynb notebook is saved',
231 'Do not auto-save .py scripts for every notebook'))
231 'Do not auto-save .py scripts for every notebook'))
232
232
233 # the flags that are specific to the frontend
233 # the flags that are specific to the frontend
234 # these must be scrubbed before being passed to the kernel,
234 # these must be scrubbed before being passed to the kernel,
235 # or it will raise an error on unrecognized flags
235 # or it will raise an error on unrecognized flags
236 notebook_flags = ['no-browser', 'no-mathjax', 'script', 'no-script']
236 notebook_flags = ['no-browser', 'no-mathjax', 'script', 'no-script']
237
237
238 aliases = dict(kernel_aliases)
238 aliases = dict(kernel_aliases)
239
239
240 aliases.update({
240 aliases.update({
241 'ip': 'NotebookApp.ip',
241 'ip': 'NotebookApp.ip',
242 'port': 'NotebookApp.port',
242 'port': 'NotebookApp.port',
243 'port-retries': 'NotebookApp.port_retries',
243 'port-retries': 'NotebookApp.port_retries',
244 'transport': 'KernelManager.transport',
244 'transport': 'KernelManager.transport',
245 'keyfile': 'NotebookApp.keyfile',
245 'keyfile': 'NotebookApp.keyfile',
246 'certfile': 'NotebookApp.certfile',
246 'certfile': 'NotebookApp.certfile',
247 'notebook-dir': 'NotebookManager.notebook_dir',
247 'notebook-dir': 'NotebookManager.notebook_dir',
248 'browser': 'NotebookApp.browser',
248 'browser': 'NotebookApp.browser',
249 })
249 })
250
250
251 # remove ipkernel flags that are singletons, and don't make sense in
251 # remove ipkernel flags that are singletons, and don't make sense in
252 # multi-kernel evironment:
252 # multi-kernel evironment:
253 aliases.pop('f', None)
253 aliases.pop('f', None)
254
254
255 notebook_aliases = [u'port', u'port-retries', u'ip', u'keyfile', u'certfile',
255 notebook_aliases = [u'port', u'port-retries', u'ip', u'keyfile', u'certfile',
256 u'notebook-dir']
256 u'notebook-dir', u'profile', u'profile-dir']
257
257
258 #-----------------------------------------------------------------------------
258 #-----------------------------------------------------------------------------
259 # NotebookApp
259 # NotebookApp
260 #-----------------------------------------------------------------------------
260 #-----------------------------------------------------------------------------
261
261
262 class NotebookApp(BaseIPythonApplication):
262 class NotebookApp(BaseIPythonApplication):
263
263
264 name = 'ipython-notebook'
264 name = 'ipython-notebook'
265
265
266 description = """
266 description = """
267 The IPython HTML Notebook.
267 The IPython HTML Notebook.
268
268
269 This launches a Tornado based HTML Notebook Server that serves up an
269 This launches a Tornado based HTML Notebook Server that serves up an
270 HTML5/Javascript Notebook client.
270 HTML5/Javascript Notebook client.
271 """
271 """
272 examples = _examples
272 examples = _examples
273
273
274 classes = IPythonConsoleApp.classes + [MappingKernelManager, NotebookManager,
274 classes = IPythonConsoleApp.classes + [MappingKernelManager, NotebookManager,
275 FileNotebookManager]
275 FileNotebookManager]
276 flags = Dict(flags)
276 flags = Dict(flags)
277 aliases = Dict(aliases)
277 aliases = Dict(aliases)
278
278
279 kernel_argv = List(Unicode)
279 kernel_argv = List(Unicode)
280
280
281 def _log_level_default(self):
281 def _log_level_default(self):
282 return logging.INFO
282 return logging.INFO
283
283
284 def _log_format_default(self):
284 def _log_format_default(self):
285 """override default log format to include time"""
285 """override default log format to include time"""
286 return u"%(asctime)s.%(msecs).03d [%(name)s]%(highlevel)s %(message)s"
286 return u"%(asctime)s.%(msecs).03d [%(name)s]%(highlevel)s %(message)s"
287
287
288 # create requested profiles by default, if they don't exist:
288 # create requested profiles by default, if they don't exist:
289 auto_create = Bool(True)
289 auto_create = Bool(True)
290
290
291 # file to be opened in the notebook server
291 # file to be opened in the notebook server
292 file_to_run = Unicode('')
292 file_to_run = Unicode('')
293
293
294 # Network related information.
294 # Network related information.
295
295
296 ip = Unicode(LOCALHOST, config=True,
296 ip = Unicode(LOCALHOST, config=True,
297 help="The IP address the notebook server will listen on."
297 help="The IP address the notebook server will listen on."
298 )
298 )
299
299
300 def _ip_changed(self, name, old, new):
300 def _ip_changed(self, name, old, new):
301 if new == u'*': self.ip = u''
301 if new == u'*': self.ip = u''
302
302
303 port = Integer(8888, config=True,
303 port = Integer(8888, config=True,
304 help="The port the notebook server will listen on."
304 help="The port the notebook server will listen on."
305 )
305 )
306 port_retries = Integer(50, config=True,
306 port_retries = Integer(50, config=True,
307 help="The number of additional ports to try if the specified port is not available."
307 help="The number of additional ports to try if the specified port is not available."
308 )
308 )
309
309
310 certfile = Unicode(u'', config=True,
310 certfile = Unicode(u'', config=True,
311 help="""The full path to an SSL/TLS certificate file."""
311 help="""The full path to an SSL/TLS certificate file."""
312 )
312 )
313
313
314 keyfile = Unicode(u'', config=True,
314 keyfile = Unicode(u'', config=True,
315 help="""The full path to a private key file for usage with SSL/TLS."""
315 help="""The full path to a private key file for usage with SSL/TLS."""
316 )
316 )
317
317
318 cookie_secret = Bytes(b'', config=True,
318 cookie_secret = Bytes(b'', config=True,
319 help="""The random bytes used to secure cookies.
319 help="""The random bytes used to secure cookies.
320 By default this is a new random number every time you start the Notebook.
320 By default this is a new random number every time you start the Notebook.
321 Set it to a value in a config file to enable logins to persist across server sessions.
321 Set it to a value in a config file to enable logins to persist across server sessions.
322
322
323 Note: Cookie secrets should be kept private, do not share config files with
323 Note: Cookie secrets should be kept private, do not share config files with
324 cookie_secret stored in plaintext (you can read the value from a file).
324 cookie_secret stored in plaintext (you can read the value from a file).
325 """
325 """
326 )
326 )
327 def _cookie_secret_default(self):
327 def _cookie_secret_default(self):
328 return os.urandom(1024)
328 return os.urandom(1024)
329
329
330 password = Unicode(u'', config=True,
330 password = Unicode(u'', config=True,
331 help="""Hashed password to use for web authentication.
331 help="""Hashed password to use for web authentication.
332
332
333 To generate, type in a python/IPython shell:
333 To generate, type in a python/IPython shell:
334
334
335 from IPython.lib import passwd; passwd()
335 from IPython.lib import passwd; passwd()
336
336
337 The string should be of the form type:salt:hashed-password.
337 The string should be of the form type:salt:hashed-password.
338 """
338 """
339 )
339 )
340
340
341 open_browser = Bool(True, config=True,
341 open_browser = Bool(True, config=True,
342 help="""Whether to open in a browser after starting.
342 help="""Whether to open in a browser after starting.
343 The specific browser used is platform dependent and
343 The specific browser used is platform dependent and
344 determined by the python standard library `webbrowser`
344 determined by the python standard library `webbrowser`
345 module, unless it is overridden using the --browser
345 module, unless it is overridden using the --browser
346 (NotebookApp.browser) configuration option.
346 (NotebookApp.browser) configuration option.
347 """)
347 """)
348
348
349 browser = Unicode(u'', config=True,
349 browser = Unicode(u'', config=True,
350 help="""Specify what command to use to invoke a web
350 help="""Specify what command to use to invoke a web
351 browser when opening the notebook. If not specified, the
351 browser when opening the notebook. If not specified, the
352 default browser will be determined by the `webbrowser`
352 default browser will be determined by the `webbrowser`
353 standard library module, which allows setting of the
353 standard library module, which allows setting of the
354 BROWSER environment variable to override it.
354 BROWSER environment variable to override it.
355 """)
355 """)
356
356
357 use_less = Bool(False, config=True,
357 use_less = Bool(False, config=True,
358 help="""Wether to use Browser Side less-css parsing
358 help="""Wether to use Browser Side less-css parsing
359 instead of compiled css version in templates that allows
359 instead of compiled css version in templates that allows
360 it. This is mainly convenient when working on the less
360 it. This is mainly convenient when working on the less
361 file to avoid a build step, or if user want to overwrite
361 file to avoid a build step, or if user want to overwrite
362 some of the less variables without having to recompile
362 some of the less variables without having to recompile
363 everything.
363 everything.
364
364
365 You will need to install the less.js component in the static directory
365 You will need to install the less.js component in the static directory
366 either in the source tree or in your profile folder.
366 either in the source tree or in your profile folder.
367 """)
367 """)
368
368
369 webapp_settings = Dict(config=True,
369 webapp_settings = Dict(config=True,
370 help="Supply overrides for the tornado.web.Application that the "
370 help="Supply overrides for the tornado.web.Application that the "
371 "IPython notebook uses.")
371 "IPython notebook uses.")
372
372
373 enable_mathjax = Bool(True, config=True,
373 enable_mathjax = Bool(True, config=True,
374 help="""Whether to enable MathJax for typesetting math/TeX
374 help="""Whether to enable MathJax for typesetting math/TeX
375
375
376 MathJax is the javascript library IPython uses to render math/LaTeX. It is
376 MathJax is the javascript library IPython uses to render math/LaTeX. It is
377 very large, so you may want to disable it if you have a slow internet
377 very large, so you may want to disable it if you have a slow internet
378 connection, or for offline use of the notebook.
378 connection, or for offline use of the notebook.
379
379
380 When disabled, equations etc. will appear as their untransformed TeX source.
380 When disabled, equations etc. will appear as their untransformed TeX source.
381 """
381 """
382 )
382 )
383 def _enable_mathjax_changed(self, name, old, new):
383 def _enable_mathjax_changed(self, name, old, new):
384 """set mathjax url to empty if mathjax is disabled"""
384 """set mathjax url to empty if mathjax is disabled"""
385 if not new:
385 if not new:
386 self.mathjax_url = u''
386 self.mathjax_url = u''
387
387
388 base_project_url = Unicode('/', config=True,
388 base_project_url = Unicode('/', config=True,
389 help='''The base URL for the notebook server.
389 help='''The base URL for the notebook server.
390
390
391 Leading and trailing slashes can be omitted,
391 Leading and trailing slashes can be omitted,
392 and will automatically be added.
392 and will automatically be added.
393 ''')
393 ''')
394 def _base_project_url_changed(self, name, old, new):
394 def _base_project_url_changed(self, name, old, new):
395 if not new.startswith('/'):
395 if not new.startswith('/'):
396 self.base_project_url = '/'+new
396 self.base_project_url = '/'+new
397 elif not new.endswith('/'):
397 elif not new.endswith('/'):
398 self.base_project_url = new+'/'
398 self.base_project_url = new+'/'
399
399
400 base_kernel_url = Unicode('/', config=True,
400 base_kernel_url = Unicode('/', config=True,
401 help='''The base URL for the kernel server
401 help='''The base URL for the kernel server
402
402
403 Leading and trailing slashes can be omitted,
403 Leading and trailing slashes can be omitted,
404 and will automatically be added.
404 and will automatically be added.
405 ''')
405 ''')
406 def _base_kernel_url_changed(self, name, old, new):
406 def _base_kernel_url_changed(self, name, old, new):
407 if not new.startswith('/'):
407 if not new.startswith('/'):
408 self.base_kernel_url = '/'+new
408 self.base_kernel_url = '/'+new
409 elif not new.endswith('/'):
409 elif not new.endswith('/'):
410 self.base_kernel_url = new+'/'
410 self.base_kernel_url = new+'/'
411
411
412 websocket_url = Unicode("", config=True,
412 websocket_url = Unicode("", config=True,
413 help="""The base URL for the websocket server,
413 help="""The base URL for the websocket server,
414 if it differs from the HTTP server (hint: it almost certainly doesn't).
414 if it differs from the HTTP server (hint: it almost certainly doesn't).
415
415
416 Should be in the form of an HTTP origin: ws[s]://hostname[:port]
416 Should be in the form of an HTTP origin: ws[s]://hostname[:port]
417 """
417 """
418 )
418 )
419
419
420 extra_static_paths = List(Unicode, config=True,
420 extra_static_paths = List(Unicode, config=True,
421 help="""Extra paths to search for serving static files.
421 help="""Extra paths to search for serving static files.
422
422
423 This allows adding javascript/css to be available from the notebook server machine,
423 This allows adding javascript/css to be available from the notebook server machine,
424 or overriding individual files in the IPython"""
424 or overriding individual files in the IPython"""
425 )
425 )
426 def _extra_static_paths_default(self):
426 def _extra_static_paths_default(self):
427 return [os.path.join(self.profile_dir.location, 'static')]
427 return [os.path.join(self.profile_dir.location, 'static')]
428
428
429 @property
429 @property
430 def static_file_path(self):
430 def static_file_path(self):
431 """return extra paths + the default location"""
431 """return extra paths + the default location"""
432 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
432 return self.extra_static_paths + [DEFAULT_STATIC_FILES_PATH]
433
433
434 mathjax_url = Unicode("", config=True,
434 mathjax_url = Unicode("", config=True,
435 help="""The url for MathJax.js."""
435 help="""The url for MathJax.js."""
436 )
436 )
437 def _mathjax_url_default(self):
437 def _mathjax_url_default(self):
438 if not self.enable_mathjax:
438 if not self.enable_mathjax:
439 return u''
439 return u''
440 static_url_prefix = self.webapp_settings.get("static_url_prefix",
440 static_url_prefix = self.webapp_settings.get("static_url_prefix",
441 url_path_join(self.base_project_url, "static")
441 url_path_join(self.base_project_url, "static")
442 )
442 )
443 try:
443 try:
444 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), self.static_file_path)
444 mathjax = filefind(os.path.join('mathjax', 'MathJax.js'), self.static_file_path)
445 except IOError:
445 except IOError:
446 if self.certfile:
446 if self.certfile:
447 # HTTPS: load from Rackspace CDN, because SSL certificate requires it
447 # HTTPS: load from Rackspace CDN, because SSL certificate requires it
448 base = u"https://c328740.ssl.cf1.rackcdn.com"
448 base = u"https://c328740.ssl.cf1.rackcdn.com"
449 else:
449 else:
450 base = u"http://cdn.mathjax.org"
450 base = u"http://cdn.mathjax.org"
451
451
452 url = base + u"/mathjax/latest/MathJax.js"
452 url = base + u"/mathjax/latest/MathJax.js"
453 self.log.info("Using MathJax from CDN: %s", url)
453 self.log.info("Using MathJax from CDN: %s", url)
454 return url
454 return url
455 else:
455 else:
456 self.log.info("Using local MathJax from %s" % mathjax)
456 self.log.info("Using local MathJax from %s" % mathjax)
457 return url_path_join(static_url_prefix, u"mathjax/MathJax.js")
457 return url_path_join(static_url_prefix, u"mathjax/MathJax.js")
458
458
459 def _mathjax_url_changed(self, name, old, new):
459 def _mathjax_url_changed(self, name, old, new):
460 if new and not self.enable_mathjax:
460 if new and not self.enable_mathjax:
461 # enable_mathjax=False overrides mathjax_url
461 # enable_mathjax=False overrides mathjax_url
462 self.mathjax_url = u''
462 self.mathjax_url = u''
463 else:
463 else:
464 self.log.info("Using MathJax: %s", new)
464 self.log.info("Using MathJax: %s", new)
465
465
466 notebook_manager_class = DottedObjectName('IPython.html.services.notebooks.filenbmanager.FileNotebookManager',
466 notebook_manager_class = DottedObjectName('IPython.html.services.notebooks.filenbmanager.FileNotebookManager',
467 config=True,
467 config=True,
468 help='The notebook manager class to use.')
468 help='The notebook manager class to use.')
469
469
470 trust_xheaders = Bool(False, config=True,
470 trust_xheaders = Bool(False, config=True,
471 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
471 help=("Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X-Forwarded-For headers"
472 "sent by the upstream reverse proxy. Neccesary if the proxy handles SSL")
472 "sent by the upstream reverse proxy. Neccesary if the proxy handles SSL")
473 )
473 )
474
474
475 def parse_command_line(self, argv=None):
475 def parse_command_line(self, argv=None):
476 super(NotebookApp, self).parse_command_line(argv)
476 super(NotebookApp, self).parse_command_line(argv)
477 if argv is None:
478 argv = sys.argv[1:]
479
480 # Scrub frontend-specific flags
481 self.kernel_argv = swallow_argv(argv, notebook_aliases, notebook_flags)
482 # Kernel should inherit default config file from frontend
483 self.kernel_argv.append("--IPKernelApp.parent_appname='%s'" % self.name)
484
477
485 if self.extra_args:
478 if self.extra_args:
486 f = os.path.abspath(self.extra_args[0])
479 f = os.path.abspath(self.extra_args[0])
487 if os.path.isdir(f):
480 if os.path.isdir(f):
488 nbdir = f
481 nbdir = f
489 else:
482 else:
490 self.file_to_run = f
483 self.file_to_run = f
491 nbdir = os.path.dirname(f)
484 nbdir = os.path.dirname(f)
492 self.config.NotebookManager.notebook_dir = nbdir
485 self.config.NotebookManager.notebook_dir = nbdir
493
486
487 def init_kernel_argv(self):
488 """construct the kernel arguments"""
489 # Scrub frontend-specific flags
490 self.kernel_argv = swallow_argv(self.argv, notebook_aliases, notebook_flags)
491 # Kernel should inherit default config file from frontend
492 self.kernel_argv.append("--IPKernelApp.parent_appname='%s'" % self.name)
493 # Kernel should get *absolute* path to profile directory
494 self.kernel_argv.extend(["--profile-dir", self.profile_dir.location])
495
494 def init_configurables(self):
496 def init_configurables(self):
495 # force Session default to be secure
497 # force Session default to be secure
496 default_secure(self.config)
498 default_secure(self.config)
497 self.kernel_manager = MappingKernelManager(
499 self.kernel_manager = MappingKernelManager(
498 parent=self, log=self.log, kernel_argv=self.kernel_argv,
500 parent=self, log=self.log, kernel_argv=self.kernel_argv,
499 connection_dir = self.profile_dir.security_dir,
501 connection_dir = self.profile_dir.security_dir,
500 )
502 )
501 kls = import_item(self.notebook_manager_class)
503 kls = import_item(self.notebook_manager_class)
502 self.notebook_manager = kls(parent=self, log=self.log)
504 self.notebook_manager = kls(parent=self, log=self.log)
503 self.notebook_manager.load_notebook_names()
505 self.notebook_manager.load_notebook_names()
504 self.cluster_manager = ClusterManager(parent=self, log=self.log)
506 self.cluster_manager = ClusterManager(parent=self, log=self.log)
505 self.cluster_manager.update_profiles()
507 self.cluster_manager.update_profiles()
506
508
507 def init_logging(self):
509 def init_logging(self):
508 # This prevents double log messages because tornado use a root logger that
510 # This prevents double log messages because tornado use a root logger that
509 # self.log is a child of. The logging module dipatches log messages to a log
511 # self.log is a child of. The logging module dipatches log messages to a log
510 # and all of its ancenstors until propagate is set to False.
512 # and all of its ancenstors until propagate is set to False.
511 self.log.propagate = False
513 self.log.propagate = False
512
514
513 # hook up tornado 3's loggers to our app handlers
515 # hook up tornado 3's loggers to our app handlers
514 for name in ('access', 'application', 'general'):
516 for name in ('access', 'application', 'general'):
515 logging.getLogger('tornado.%s' % name).handlers = self.log.handlers
517 logging.getLogger('tornado.%s' % name).handlers = self.log.handlers
516
518
517 def init_webapp(self):
519 def init_webapp(self):
518 """initialize tornado webapp and httpserver"""
520 """initialize tornado webapp and httpserver"""
519 self.web_app = NotebookWebApplication(
521 self.web_app = NotebookWebApplication(
520 self, self.kernel_manager, self.notebook_manager,
522 self, self.kernel_manager, self.notebook_manager,
521 self.cluster_manager, self.log,
523 self.cluster_manager, self.log,
522 self.base_project_url, self.webapp_settings
524 self.base_project_url, self.webapp_settings
523 )
525 )
524 if self.certfile:
526 if self.certfile:
525 ssl_options = dict(certfile=self.certfile)
527 ssl_options = dict(certfile=self.certfile)
526 if self.keyfile:
528 if self.keyfile:
527 ssl_options['keyfile'] = self.keyfile
529 ssl_options['keyfile'] = self.keyfile
528 else:
530 else:
529 ssl_options = None
531 ssl_options = None
530 self.web_app.password = self.password
532 self.web_app.password = self.password
531 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
533 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options,
532 xheaders=self.trust_xheaders)
534 xheaders=self.trust_xheaders)
533 if not self.ip:
535 if not self.ip:
534 warning = "WARNING: The notebook server is listening on all IP addresses"
536 warning = "WARNING: The notebook server is listening on all IP addresses"
535 if ssl_options is None:
537 if ssl_options is None:
536 self.log.critical(warning + " and not using encryption. This "
538 self.log.critical(warning + " and not using encryption. This "
537 "is not recommended.")
539 "is not recommended.")
538 if not self.password:
540 if not self.password:
539 self.log.critical(warning + " and not using authentication. "
541 self.log.critical(warning + " and not using authentication. "
540 "This is highly insecure and not recommended.")
542 "This is highly insecure and not recommended.")
541 success = None
543 success = None
542 for port in random_ports(self.port, self.port_retries+1):
544 for port in random_ports(self.port, self.port_retries+1):
543 try:
545 try:
544 self.http_server.listen(port, self.ip)
546 self.http_server.listen(port, self.ip)
545 except socket.error as e:
547 except socket.error as e:
546 # XXX: remove the e.errno == -9 block when we require
548 # XXX: remove the e.errno == -9 block when we require
547 # tornado >= 3.0
549 # tornado >= 3.0
548 if e.errno == -9 and tornado.version_info[0] < 3:
550 if e.errno == -9 and tornado.version_info[0] < 3:
549 # The flags passed to socket.getaddrinfo from
551 # The flags passed to socket.getaddrinfo from
550 # tornado.netutils.bind_sockets can cause "gaierror:
552 # tornado.netutils.bind_sockets can cause "gaierror:
551 # [Errno -9] Address family for hostname not supported"
553 # [Errno -9] Address family for hostname not supported"
552 # when the interface is not associated, for example.
554 # when the interface is not associated, for example.
553 # Changing the flags to exclude socket.AI_ADDRCONFIG does
555 # Changing the flags to exclude socket.AI_ADDRCONFIG does
554 # not cause this error, but the only way to do this is to
556 # not cause this error, but the only way to do this is to
555 # monkeypatch socket to remove the AI_ADDRCONFIG attribute
557 # monkeypatch socket to remove the AI_ADDRCONFIG attribute
556 saved_AI_ADDRCONFIG = socket.AI_ADDRCONFIG
558 saved_AI_ADDRCONFIG = socket.AI_ADDRCONFIG
557 self.log.warn('Monkeypatching socket to fix tornado bug')
559 self.log.warn('Monkeypatching socket to fix tornado bug')
558 del(socket.AI_ADDRCONFIG)
560 del(socket.AI_ADDRCONFIG)
559 try:
561 try:
560 # retry the tornado call without AI_ADDRCONFIG flags
562 # retry the tornado call without AI_ADDRCONFIG flags
561 self.http_server.listen(port, self.ip)
563 self.http_server.listen(port, self.ip)
562 except socket.error as e2:
564 except socket.error as e2:
563 e = e2
565 e = e2
564 else:
566 else:
565 self.port = port
567 self.port = port
566 success = True
568 success = True
567 break
569 break
568 # restore the monekypatch
570 # restore the monekypatch
569 socket.AI_ADDRCONFIG = saved_AI_ADDRCONFIG
571 socket.AI_ADDRCONFIG = saved_AI_ADDRCONFIG
570 if e.errno != errno.EADDRINUSE:
572 if e.errno != errno.EADDRINUSE:
571 raise
573 raise
572 self.log.info('The port %i is already in use, trying another random port.' % port)
574 self.log.info('The port %i is already in use, trying another random port.' % port)
573 else:
575 else:
574 self.port = port
576 self.port = port
575 success = True
577 success = True
576 break
578 break
577 if not success:
579 if not success:
578 self.log.critical('ERROR: the notebook server could not be started because '
580 self.log.critical('ERROR: the notebook server could not be started because '
579 'no available port could be found.')
581 'no available port could be found.')
580 self.exit(1)
582 self.exit(1)
581
583
582 def init_signal(self):
584 def init_signal(self):
583 if not sys.platform.startswith('win'):
585 if not sys.platform.startswith('win'):
584 signal.signal(signal.SIGINT, self._handle_sigint)
586 signal.signal(signal.SIGINT, self._handle_sigint)
585 signal.signal(signal.SIGTERM, self._signal_stop)
587 signal.signal(signal.SIGTERM, self._signal_stop)
586 if hasattr(signal, 'SIGUSR1'):
588 if hasattr(signal, 'SIGUSR1'):
587 # Windows doesn't support SIGUSR1
589 # Windows doesn't support SIGUSR1
588 signal.signal(signal.SIGUSR1, self._signal_info)
590 signal.signal(signal.SIGUSR1, self._signal_info)
589 if hasattr(signal, 'SIGINFO'):
591 if hasattr(signal, 'SIGINFO'):
590 # only on BSD-based systems
592 # only on BSD-based systems
591 signal.signal(signal.SIGINFO, self._signal_info)
593 signal.signal(signal.SIGINFO, self._signal_info)
592
594
593 def _handle_sigint(self, sig, frame):
595 def _handle_sigint(self, sig, frame):
594 """SIGINT handler spawns confirmation dialog"""
596 """SIGINT handler spawns confirmation dialog"""
595 # register more forceful signal handler for ^C^C case
597 # register more forceful signal handler for ^C^C case
596 signal.signal(signal.SIGINT, self._signal_stop)
598 signal.signal(signal.SIGINT, self._signal_stop)
597 # request confirmation dialog in bg thread, to avoid
599 # request confirmation dialog in bg thread, to avoid
598 # blocking the App
600 # blocking the App
599 thread = threading.Thread(target=self._confirm_exit)
601 thread = threading.Thread(target=self._confirm_exit)
600 thread.daemon = True
602 thread.daemon = True
601 thread.start()
603 thread.start()
602
604
603 def _restore_sigint_handler(self):
605 def _restore_sigint_handler(self):
604 """callback for restoring original SIGINT handler"""
606 """callback for restoring original SIGINT handler"""
605 signal.signal(signal.SIGINT, self._handle_sigint)
607 signal.signal(signal.SIGINT, self._handle_sigint)
606
608
607 def _confirm_exit(self):
609 def _confirm_exit(self):
608 """confirm shutdown on ^C
610 """confirm shutdown on ^C
609
611
610 A second ^C, or answering 'y' within 5s will cause shutdown,
612 A second ^C, or answering 'y' within 5s will cause shutdown,
611 otherwise original SIGINT handler will be restored.
613 otherwise original SIGINT handler will be restored.
612
614
613 This doesn't work on Windows.
615 This doesn't work on Windows.
614 """
616 """
615 # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
617 # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
616 time.sleep(0.1)
618 time.sleep(0.1)
617 info = self.log.info
619 info = self.log.info
618 info('interrupted')
620 info('interrupted')
619 print self.notebook_info()
621 print self.notebook_info()
620 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
622 sys.stdout.write("Shutdown this notebook server (y/[n])? ")
621 sys.stdout.flush()
623 sys.stdout.flush()
622 r,w,x = select.select([sys.stdin], [], [], 5)
624 r,w,x = select.select([sys.stdin], [], [], 5)
623 if r:
625 if r:
624 line = sys.stdin.readline()
626 line = sys.stdin.readline()
625 if line.lower().startswith('y'):
627 if line.lower().startswith('y'):
626 self.log.critical("Shutdown confirmed")
628 self.log.critical("Shutdown confirmed")
627 ioloop.IOLoop.instance().stop()
629 ioloop.IOLoop.instance().stop()
628 return
630 return
629 else:
631 else:
630 print "No answer for 5s:",
632 print "No answer for 5s:",
631 print "resuming operation..."
633 print "resuming operation..."
632 # no answer, or answer is no:
634 # no answer, or answer is no:
633 # set it back to original SIGINT handler
635 # set it back to original SIGINT handler
634 # use IOLoop.add_callback because signal.signal must be called
636 # use IOLoop.add_callback because signal.signal must be called
635 # from main thread
637 # from main thread
636 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
638 ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
637
639
638 def _signal_stop(self, sig, frame):
640 def _signal_stop(self, sig, frame):
639 self.log.critical("received signal %s, stopping", sig)
641 self.log.critical("received signal %s, stopping", sig)
640 ioloop.IOLoop.instance().stop()
642 ioloop.IOLoop.instance().stop()
641
643
642 def _signal_info(self, sig, frame):
644 def _signal_info(self, sig, frame):
643 print self.notebook_info()
645 print self.notebook_info()
644
646
645 def init_components(self):
647 def init_components(self):
646 """Check the components submodule, and warn if it's unclean"""
648 """Check the components submodule, and warn if it's unclean"""
647 status = submodule.check_submodule_status()
649 status = submodule.check_submodule_status()
648 if status == 'missing':
650 if status == 'missing':
649 self.log.warn("components submodule missing, running `git submodule update`")
651 self.log.warn("components submodule missing, running `git submodule update`")
650 submodule.update_submodules(submodule.ipython_parent())
652 submodule.update_submodules(submodule.ipython_parent())
651 elif status == 'unclean':
653 elif status == 'unclean':
652 self.log.warn("components submodule unclean, you may see 404s on static/components")
654 self.log.warn("components submodule unclean, you may see 404s on static/components")
653 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
655 self.log.warn("run `setup.py submodule` or `git submodule update` to update")
654
656
655
657
656 @catch_config_error
658 @catch_config_error
657 def initialize(self, argv=None):
659 def initialize(self, argv=None):
658 self.init_logging()
660 self.init_logging()
659 super(NotebookApp, self).initialize(argv)
661 super(NotebookApp, self).initialize(argv)
662 self.init_kernel_argv()
660 self.init_configurables()
663 self.init_configurables()
661 self.init_components()
664 self.init_components()
662 self.init_webapp()
665 self.init_webapp()
663 self.init_signal()
666 self.init_signal()
664
667
665 def cleanup_kernels(self):
668 def cleanup_kernels(self):
666 """Shutdown all kernels.
669 """Shutdown all kernels.
667
670
668 The kernels will shutdown themselves when this process no longer exists,
671 The kernels will shutdown themselves when this process no longer exists,
669 but explicit shutdown allows the KernelManagers to cleanup the connection files.
672 but explicit shutdown allows the KernelManagers to cleanup the connection files.
670 """
673 """
671 self.log.info('Shutting down kernels')
674 self.log.info('Shutting down kernels')
672 self.kernel_manager.shutdown_all()
675 self.kernel_manager.shutdown_all()
673
676
674 def notebook_info(self):
677 def notebook_info(self):
675 "Return the current working directory and the server url information"
678 "Return the current working directory and the server url information"
676 mgr_info = self.notebook_manager.info_string() + "\n"
679 mgr_info = self.notebook_manager.info_string() + "\n"
677 return mgr_info +"The IPython Notebook is running at: %s" % self._url
680 return mgr_info +"The IPython Notebook is running at: %s" % self._url
678
681
679 def start(self):
682 def start(self):
680 """ Start the IPython Notebook server app, after initialization
683 """ Start the IPython Notebook server app, after initialization
681
684
682 This method takes no arguments so all configuration and initialization
685 This method takes no arguments so all configuration and initialization
683 must be done prior to calling this method."""
686 must be done prior to calling this method."""
684 ip = self.ip if self.ip else '[all ip addresses on your system]'
687 ip = self.ip if self.ip else '[all ip addresses on your system]'
685 proto = 'https' if self.certfile else 'http'
688 proto = 'https' if self.certfile else 'http'
686 info = self.log.info
689 info = self.log.info
687 self._url = "%s://%s:%i%s" % (proto, ip, self.port,
690 self._url = "%s://%s:%i%s" % (proto, ip, self.port,
688 self.base_project_url)
691 self.base_project_url)
689 for line in self.notebook_info().split("\n"):
692 for line in self.notebook_info().split("\n"):
690 info(line)
693 info(line)
691 info("Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).")
694 info("Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).")
692
695
693 if self.open_browser or self.file_to_run:
696 if self.open_browser or self.file_to_run:
694 ip = self.ip or LOCALHOST
697 ip = self.ip or LOCALHOST
695 try:
698 try:
696 browser = webbrowser.get(self.browser or None)
699 browser = webbrowser.get(self.browser or None)
697 except webbrowser.Error as e:
700 except webbrowser.Error as e:
698 self.log.warn('No web browser found: %s.' % e)
701 self.log.warn('No web browser found: %s.' % e)
699 browser = None
702 browser = None
700
703
701 if self.file_to_run:
704 if self.file_to_run:
702 name, _ = os.path.splitext(os.path.basename(self.file_to_run))
705 name, _ = os.path.splitext(os.path.basename(self.file_to_run))
703 url = self.notebook_manager.rev_mapping.get(name, '')
706 url = self.notebook_manager.rev_mapping.get(name, '')
704 else:
707 else:
705 url = ''
708 url = ''
706 if browser:
709 if browser:
707 b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
710 b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
708 self.port, self.base_project_url, url), new=2)
711 self.port, self.base_project_url, url), new=2)
709 threading.Thread(target=b).start()
712 threading.Thread(target=b).start()
710 try:
713 try:
711 ioloop.IOLoop.instance().start()
714 ioloop.IOLoop.instance().start()
712 except KeyboardInterrupt:
715 except KeyboardInterrupt:
713 info("Interrupted...")
716 info("Interrupted...")
714 finally:
717 finally:
715 self.cleanup_kernels()
718 self.cleanup_kernels()
716
719
717
720
718 #-----------------------------------------------------------------------------
721 #-----------------------------------------------------------------------------
719 # Main entry point
722 # Main entry point
720 #-----------------------------------------------------------------------------
723 #-----------------------------------------------------------------------------
721
724
722 launch_new_instance = NotebookApp.launch_instance
725 launch_new_instance = NotebookApp.launch_instance
723
726
General Comments 0
You need to be logged in to leave comments. Login now