##// END OF EJS Templates
convert backtick to repr
convert backtick to repr

File last commit:

r7787:28b538a9
r7815:31d0fe14
Show More
notebookapp.py
592 lines | 22.6 KiB | text/x-python | PythonLexer
MinRK
Ensure handler patterns are str, not unicode...
r6067 # coding: utf-8
Brian E. Granger
More review changes....
r4609 """A tornado based IPython notebook server.
Authors:
* Brian Granger
"""
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 #-----------------------------------------------------------------------------
Brian E. Granger
More review changes....
r4609 # Copyright (C) 2008-2011 The IPython Development Team
Brian E. Granger
Updating the notebook to work with the latex master....
r4348 #
# Distributed under the terms of the BSD License. The full license is in
Brian E. Granger
More review changes....
r4609 # the file COPYING, distributed as part of this software.
Brian E. Granger
Updating the notebook to work with the latex master....
r4348 #-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 # Imports
#-----------------------------------------------------------------------------
Fernando Perez
Start webbrowser in a thread. Prevents lockup with Chrome....
r5212 # stdlib
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 import errno
Brian E. Granger
Creating files to new notebook app.
r4339 import logging
import os
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 import random
MinRK
handle old pyzmq in notebook exit confirmation...
r6509 import re
MinRK
confirm notebook shutdown on SIGINT...
r6508 import select
Brian E. Granger
Notebook app debugging....
r4345 import signal
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 import socket
Brian E. Granger
Notebook app debugging....
r4345 import sys
Fernando Perez
Start webbrowser in a thread. Prevents lockup with Chrome....
r5212 import threading
MinRK
handle old pyzmq in notebook exit confirmation...
r6509 import time
Thomas Kluyver
Add ability to open the notebook in a browser when it starts.
r5065 import webbrowser
Brian E. Granger
Creating files to new notebook app.
r4339
Fernando Perez
Start webbrowser in a thread. Prevents lockup with Chrome....
r5212 # Third party
Brian E. Granger
Creating files to new notebook app.
r4339 import zmq
# Install the pyzmq ioloop. This has to be done before anything else from
# tornado is imported.
from zmq.eventloop import ioloop
MinRK
add ioloop.install to backported patches
r6631 ioloop.install()
Brian E. Granger
Creating files to new notebook app.
r4339
from tornado import httpserver
from tornado import web
Fernando Perez
Start webbrowser in a thread. Prevents lockup with Chrome....
r5212 # Our own libraries
Brian E. Granger
Major refactor of kernel connection management in the notebook....
r4545 from .kernelmanager import MappingKernelManager
Stefan van der Walt
Add logout button.
r5325 from .handlers import (LoginHandler, LogoutHandler,
Brian E. Granger
Renaming NBBrowserHandler->ProjectDashboardHandler.
r5112 ProjectDashboardHandler, NewHandler, NamedNotebookHandler,
Brian E. Granger
Major refactor of kernel connection management in the notebook....
r4545 MainKernelHandler, KernelHandler, KernelActionHandler, IOPubHandler,
Brian Granger
Beginning work on notebook duplication.
r5860 ShellHandler, NotebookRootHandler, NotebookHandler, NotebookCopyHandler,
Brian Granger
First version of cluster web service....
r6191 RSTHandler, AuthenticatedFileHandler, PrintNotebookHandler,
MainClusterHandler, ClusterProfileHandler, ClusterActionHandler
Brian E. Granger
Fixing import statments in handlers and notebookapp.
r4340 )
Fernando Perez
Define flags in application that's going to use them.
r5762 from .notebookmanager import NotebookManager
Brian Granger
First version of cluster web service....
r6191 from .clustermanager import ClusterManager
Brian E. Granger
Creating files to new notebook app.
r4339
Fernando Perez
Define flags in application that's going to use them.
r5762 from IPython.config.application import catch_config_error, boolean_flag
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 from IPython.core.application import BaseIPythonApplication
Brian E. Granger
Notebook app debugging....
r4345 from IPython.core.profiledir import ProfileDir
MinRK
add InlineBackend to ConsoleApp class list...
r7291 from IPython.frontend.consoleapp import IPythonConsoleApp
MinRK
Split swallow_argv into standalone function in lib.kernel...
r5620 from IPython.lib.kernel import swallow_argv
MinRK
enable HMAC message signing by default in notebook kernels...
r4963 from IPython.zmq.session import Session, default_secure
Brian E. Granger
Notebook app debugging....
r4345 from IPython.zmq.zmqshell import ZMQInteractiveShell
from IPython.zmq.ipkernel import (
flags as ipkernel_flags,
aliases as ipkernel_aliases,
IPKernelApp
)
MinRK
add Integer traitlet...
r5344 from IPython.utils.traitlets import Dict, Unicode, Integer, List, Enum, Bool
MinRK
Ensure handler patterns are str, not unicode...
r6067 from IPython.utils import py3compat
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
#-----------------------------------------------------------------------------
# Module globals
#-----------------------------------------------------------------------------
Brian E. Granger
Creating files to new notebook app.
r4339
_kernel_id_regex = r"(?P<kernel_id>\w+-\w+-\w+-\w+-\w+)"
_kernel_action_regex = r"(?P<action>restart|interrupt)"
Brian E. Granger
Massive work on the notebook document format....
r4484 _notebook_id_regex = r"(?P<notebook_id>\w+-\w+-\w+-\w+-\w+)"
MinRK
relax profile regex in notebook...
r7668 _profile_regex = r"(?P<profile>[^\/]+)" # there is almost no text that is invalid
Brian Granger
First version of cluster web service....
r6191 _cluster_action_regex = r"(?P<action>start|stop)"
Brian E. Granger
Creating files to new notebook app.
r4339
Brian E. Granger
Notebook app debugging....
r4345 LOCALHOST = '127.0.0.1'
Brian E. Granger
Updating notebook configuration....
r4519 _examples = """
ipython notebook # start the notebook
ipython notebook --profile=sympy # use the sympy profile
ipython notebook --pylab=inline # pylab in inline plotting mode
ipython notebook --certfile=mycert.pem # use SSL/TLS certificate
ipython notebook --port=5555 --ip=* # Listen on port 5555, all interfaces
"""
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 #-----------------------------------------------------------------------------
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 # Helper functions
#-----------------------------------------------------------------------------
def url_path_join(a,b):
if a.endswith('/') and b.startswith('/'):
return a[:-1]+b
else:
return a+b
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 def random_ports(port, n):
"""Generate a list of n random ports near the given port.
The first 5 ports will be sequential, and the remaining n-5 will be
randomly selected in the range [port-2*n, port+2*n].
"""
for i in range(min(5, n)):
yield port + i
for i in range(n-5):
yield port + random.randint(-2*n, 2*n)
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 #-----------------------------------------------------------------------------
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 # The Tornado web application
#-----------------------------------------------------------------------------
Brian E. Granger
Creating files to new notebook app.
r4339
Brian E. Granger
Renaming NotebookApplication to NotebookWebApplication.
r4342 class NotebookWebApplication(web.Application):
Brian E. Granger
Creating files to new notebook app.
r4339
Brian Granger
First version of cluster web service....
r6191 def __init__(self, ipython_app, kernel_manager, notebook_manager,
cluster_manager, log,
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 base_project_url, settings_overrides):
Brian E. Granger
Creating files to new notebook app.
r4339 handlers = [
Brian E. Granger
Renaming NBBrowserHandler->ProjectDashboardHandler.
r5112 (r"/", ProjectDashboardHandler),
Satrajit Ghosh
enh: added authentication ability for webapp
r4690 (r"/login", LoginHandler),
Stefan van der Walt
Add logout button.
r5325 (r"/logout", LogoutHandler),
Brian E. Granger
Implemented basic notebook browser and fixed numerous bugs.
r4488 (r"/new", NewHandler),
Brian E. Granger
Massive work on the notebook document format....
r4484 (r"/%s" % _notebook_id_regex, NamedNotebookHandler),
Brian Granger
Beginning work on notebook duplication.
r5860 (r"/%s/copy" % _notebook_id_regex, NotebookCopyHandler),
Brian Granger
Created new print view for notebook printing.
r5875 (r"/%s/print" % _notebook_id_regex, PrintNotebookHandler),
Brian E. Granger
Adding kernel/notebook associations.
r4494 (r"/kernels", MainKernelHandler),
(r"/kernels/%s" % _kernel_id_regex, KernelHandler),
Brian E. Granger
Creating files to new notebook app.
r4339 (r"/kernels/%s/%s" % (_kernel_id_regex, _kernel_action_regex), KernelActionHandler),
Brian E. Granger
Major refactor of kernel connection management in the notebook....
r4545 (r"/kernels/%s/iopub" % _kernel_id_regex, IOPubHandler),
(r"/kernels/%s/shell" % _kernel_id_regex, ShellHandler),
Brian E. Granger
Creating files to new notebook app.
r4339 (r"/notebooks", NotebookRootHandler),
Brian E. Granger
Starting work on a Markdown cell.
r4507 (r"/notebooks/%s" % _notebook_id_regex, NotebookHandler),
MinRK
serve files in notebook-dir as local/foo
r5823 (r"/rstservice/render", RSTHandler),
MinRK
serve local files as `files/foo`
r5826 (r"/files/(.*)", AuthenticatedFileHandler, {'path' : notebook_manager.notebook_dir}),
Brian Granger
First version of cluster web service....
r6191 (r"/clusters", MainClusterHandler),
(r"/clusters/%s/%s" % (_profile_regex, _cluster_action_regex), ClusterActionHandler),
(r"/clusters/%s" % _profile_regex, ClusterProfileHandler),
Brian E. Granger
Creating files to new notebook app.
r4339 ]
settings = dict(
template_path=os.path.join(os.path.dirname(__file__), "templates"),
static_path=os.path.join(os.path.dirname(__file__), "static"),
MinRK
notebook auth adjustments...
r4705 cookie_secret=os.urandom(1024),
Satrajit Ghosh
enh: added authentication ability for webapp
r4690 login_url="/login",
Brian E. Granger
Creating files to new notebook app.
r4339 )
Timo Paulssen
use IPythons config subsystem to allow overrides to the tornado web app.
r5664
# allow custom overrides for the tornado web app.
Timo Paulssen
this is how the configuration system is supposed to be used.
r5665 settings.update(settings_overrides)
Timo Paulssen
use IPythons config subsystem to allow overrides to the tornado web app.
r5664
MinRK
Ensure handler patterns are str, not unicode...
r6067 # Python < 2.6.5 doesn't accept unicode keys in f(**kwargs), and
# base_project_url will always be unicode, which will in turn
# make the patterns unicode, and ultimately result in unicode
# keys in kwargs to handler._execute(**kwargs) in tornado.
# This enforces that base_project_url be ascii in that situation.
#
# Note that the URLs these patterns check against are escaped,
# and thus guaranteed to be ASCII: 'héllo' is really 'h%C3%A9llo'.
base_project_url = py3compat.unicode_to_str(base_project_url, 'ascii')
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 # prepend base_project_url onto the patterns that we match
new_handlers = []
for handler in handlers:
pattern = url_path_join(base_project_url, handler[0])
new_handler = tuple([pattern]+list(handler[1:]))
new_handlers.append( new_handler )
super(NotebookWebApplication, self).__init__(new_handlers, **settings)
Brian E. Granger
Creating files to new notebook app.
r4339
Brian E. Granger
Major refactor of kernel connection management in the notebook....
r4545 self.kernel_manager = kernel_manager
Brian E. Granger
Adding kernel/notebook associations.
r4494 self.notebook_manager = notebook_manager
Brian Granger
First version of cluster web service....
r6191 self.cluster_manager = cluster_manager
Brian E. Granger
WebSocket url is now passed to browser when a kernel is started.
r4572 self.ipython_app = ipython_app
MinRK
move read_only flag to page-level...
r5213 self.read_only = self.ipython_app.read_only
Brian Granger
First version of cluster web service....
r6191 self.log = log
Brian E. Granger
Creating files to new notebook app.
r4339
Brian E. Granger
Work to adapt routers to new Session message protocol.
r4346
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 #-----------------------------------------------------------------------------
# Aliases and Flags
#-----------------------------------------------------------------------------
flags = dict(ipkernel_flags)
Thomas Kluyver
Add ability to open the notebook in a browser when it starts.
r5065 flags['no-browser']=(
MinRK
fix --no-browser flag in notebook after rename
r5128 {'NotebookApp' : {'open_browser' : False}},
Thomas Kluyver
Add ability to open the notebook in a browser when it starts.
r5065 "Don't open the notebook in a browser after startup."
)
MinRK
allow the notebook to run without MathJax...
r5547 flags['no-mathjax']=(
{'NotebookApp' : {'enable_mathjax' : False}},
"""Disable MathJax
MathJax is the javascript library IPython uses to render math/LaTeX. It is
very large, so you may want to disable it if you have a slow internet
connection, or for offline use of the notebook.
When disabled, equations etc. will appear as their untransformed TeX source.
"""
)
MinRK
Allow notebook server to run in read-only mode...
r5191 flags['read-only'] = (
{'NotebookApp' : {'read_only' : True}},
MinRK
add read-only view for notebooks...
r5200 """Allow read-only access to notebooks.
When using a password to protect the notebook server, this flag
allows unauthenticated clients to view the notebook list, and
individual notebooks, but not edit them, start kernels, or run
code.
MinRK
allow fully read-only mode if no password is set
r5210 If no password is set, the server will be entirely read-only.
MinRK
add read-only view for notebooks...
r5200 """
MinRK
Allow notebook server to run in read-only mode...
r5191 )
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
Fernando Perez
Define flags in application that's going to use them.
r5762 # Add notebook manager flags
flags.update(boolean_flag('script', 'NotebookManager.save_script',
'Auto-save a .py script everytime the .ipynb notebook is saved',
'Do not auto-save .py scripts for every notebook'))
Fernando Perez
Add --script flag as shorthand for the script autosave notebook option.
r5758
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 # the flags that are specific to the frontend
# these must be scrubbed before being passed to the kernel,
# or it will raise an error on unrecognized flags
Fernando Perez
Define flags in application that's going to use them.
r5762 notebook_flags = ['no-browser', 'no-mathjax', 'read-only', 'script', 'no-script']
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
aliases = dict(ipkernel_aliases)
Brian E. Granger
Updating notebook configuration....
r4519 aliases.update({
Brian E. Granger
Misc changes to the notebook....
r5104 'ip': 'NotebookApp.ip',
'port': 'NotebookApp.port',
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 'port-retries': 'NotebookApp.port_retries',
Brian E. Granger
Misc changes to the notebook....
r5104 'keyfile': 'NotebookApp.keyfile',
'certfile': 'NotebookApp.certfile',
Satrajit Ghosh
enh: added authentication ability for webapp
r4690 'notebook-dir': 'NotebookManager.notebook_dir',
Paul Ivanov
added --browser option to notebook...
r6116 'browser': 'NotebookApp.browser',
Brian E. Granger
Updating notebook configuration....
r4519 })
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
MinRK
enable HMAC message signing by default in notebook kernels...
r4963 # remove ipkernel flags that are singletons, and don't make sense in
# multi-kernel evironment:
aliases.pop('f', None)
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 notebook_aliases = [u'port', u'port-retries', u'ip', u'keyfile', u'certfile',
MinRK
notebook auth adjustments...
r4705 u'notebook-dir']
Brian E. Granger
Stripping notebook server flags from kernel's argv.
r4579
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 #-----------------------------------------------------------------------------
Brian E. Granger
Misc changes to the notebook....
r5104 # NotebookApp
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 #-----------------------------------------------------------------------------
Brian E. Granger
Misc changes to the notebook....
r5104 class NotebookApp(BaseIPythonApplication):
Brian E. Granger
Updating notebook configuration....
r4519
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 name = 'ipython-notebook'
default_config_file_name='ipython_notebook_config.py'
description = """
The IPython HTML Notebook.
This launches a Tornado based HTML Notebook Server that serves up an
HTML5/Javascript Notebook client.
"""
Brian E. Granger
Updating notebook configuration....
r4519 examples = _examples
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
MinRK
add InlineBackend to ConsoleApp class list...
r7291 classes = IPythonConsoleApp.classes + [MappingKernelManager, NotebookManager]
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 flags = Dict(flags)
aliases = Dict(aliases)
kernel_argv = List(Unicode)
Brian E. Granger
Notebook app debugging....
r4345 log_level = Enum((0,10,20,30,40,50,'DEBUG','INFO','WARN','ERROR','CRITICAL'),
default_value=logging.INFO,
config=True,
help="Set the log level by value or name.")
Paul Ivanov
set auto_create flag for notebook apps
r5847 # create requested profiles by default, if they don't exist:
auto_create = Bool(True)
Puneeth Chaganti
ENH: Open a notebook from the command line...
r6724 # file to be opened in the notebook server
file_to_run = Unicode('')
Brian E. Granger
Updating notebook configuration....
r4519 # Network related information.
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 ip = Unicode(LOCALHOST, config=True,
help="The IP address the notebook server will listen on."
)
Brian E. Granger
Updating notebook configuration....
r4519 def _ip_changed(self, name, old, new):
if new == u'*': self.ip = u''
MinRK
add Integer traitlet...
r5344 port = Integer(8888, config=True,
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 help="The port the notebook server will listen on."
)
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 port_retries = Integer(50, config=True,
help="The number of additional ports to try if the specified port is not available."
)
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
Brian E. Granger
Updating notebook configuration....
r4519 certfile = Unicode(u'', config=True,
help="""The full path to an SSL/TLS certificate file."""
)
keyfile = Unicode(u'', config=True,
help="""The full path to a private key file for usage with SSL/TLS."""
)
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
MinRK
notebook auth adjustments...
r4705 password = Unicode(u'', config=True,
Stefan van der Walt
Integrate hashed passwords into the notebook.
r5321 help="""Hashed password to use for web authentication.
Fernando Perez
Fix failing doctests and post correct example of passwd() usage.
r5337 To generate, type in a python/IPython shell:
Stefan van der Walt
Integrate hashed passwords into the notebook.
r5321
Fernando Perez
Fix failing doctests and post correct example of passwd() usage.
r5337 from IPython.lib import passwd; passwd()
Stefan van der Walt
Integrate hashed passwords into the notebook.
r5321
The string should be of the form type:salt:hashed-password.
"""
Satrajit Ghosh
enh: added authentication ability for webapp
r4690 )
Paul Ivanov
added --browser option to notebook...
r6116
Thomas Kluyver
Add ability to open the notebook in a browser when it starts.
r5065 open_browser = Bool(True, config=True,
Paul Ivanov
document how to select browser for notebook
r6115 help="""Whether to open in a browser after starting.
The specific browser used is platform dependent and
determined by the python standard library `webbrowser`
Paul Ivanov
added --browser option to notebook...
r6116 module, unless it is overridden using the --browser
(NotebookApp.browser) configuration option.
Paul Ivanov
document how to select browser for notebook
r6115 """)
Paul Ivanov
added --browser option to notebook...
r6116
browser = Unicode(u'', config=True,
Paul Ivanov
be more explicit about how --browser value is used
r6117 help="""Specify what command to use to invoke a web
browser when opening the notebook. If not specified, the
default browser will be determined by the `webbrowser`
standard library module, which allows setting of the
BROWSER environment variable to override it.
Paul Ivanov
added --browser option to notebook...
r6116 """)
MinRK
Allow notebook server to run in read-only mode...
r5191
read_only = Bool(False, config=True,
help="Whether to prevent editing/execution of notebooks."
)
MinRK
allow the notebook to run without MathJax...
r5547
Timo Paulssen
this is how the configuration system is supposed to be used.
r5665 webapp_settings = Dict(config=True,
help="Supply overrides for the tornado.web.Application that the "
"IPython notebook uses.")
MinRK
allow the notebook to run without MathJax...
r5547 enable_mathjax = Bool(True, config=True,
help="""Whether to enable MathJax for typesetting math/TeX
MathJax is the javascript library IPython uses to render math/LaTeX. It is
very large, so you may want to disable it if you have a slow internet
connection, or for offline use of the notebook.
When disabled, equations etc. will appear as their untransformed TeX source.
"""
)
MinRK
adjust missing mathjax handling per review...
r5557 def _enable_mathjax_changed(self, name, old, new):
"""set mathjax url to empty if mathjax is disabled"""
if not new:
self.mathjax_url = u''
Andrew Straw
let websocket server be traited config option
r6006
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 base_project_url = Unicode('/', config=True,
help='''The base URL for the notebook server''')
base_kernel_url = Unicode('/', config=True,
help='''The base URL for the kernel server''')
Andrew Straw
let websocket server be traited config option
r6006 websocket_host = Unicode("", config=True,
help="""The hostname for the websocket server."""
)
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004
MinRK
adjust missing mathjax handling per review...
r5557 mathjax_url = Unicode("", config=True,
help="""The url for MathJax.js."""
)
def _mathjax_url_default(self):
if not self.enable_mathjax:
return u''
Timo Paulssen
look for mathjax in the custom static path if it's supplied.
r5666 static_path = self.webapp_settings.get("static_path", os.path.join(os.path.dirname(__file__), "static"))
Andrew Straw
use Tornado's handler.static_url() in templates
r6002 static_url_prefix = self.webapp_settings.get("static_url_prefix",
"/static/")
MinRK
adjust missing mathjax handling per review...
r5557 if os.path.exists(os.path.join(static_path, 'mathjax', "MathJax.js")):
self.log.info("Using local MathJax")
Andrew Straw
use Tornado's handler.static_url() in templates
r6002 return static_url_prefix+u"mathjax/MathJax.js"
MinRK
adjust missing mathjax handling per review...
r5557 else:
MinRK
update with forthcoming MathJax CDN move
r6729 if self.certfile:
# HTTPS: load from Rackspace CDN, because SSL certificate requires it
base = u"https://c328740.ssl.cf1.rackcdn.com"
MinRK
load mathjax from CDN via https...
r6155 else:
MinRK
update with forthcoming MathJax CDN move
r6729 base = u"http://cdn.mathjax.org"
MinRK
load mathjax from CDN via https...
r6155
MinRK
update with forthcoming MathJax CDN move
r6729 url = base + u"/mathjax/latest/MathJax.js"
self.log.info("Using MathJax from CDN: %s", url)
return url
MinRK
adjust missing mathjax handling per review...
r5557
def _mathjax_url_changed(self, name, old, new):
if new and not self.enable_mathjax:
# enable_mathjax=False overrides mathjax_url
self.mathjax_url = u''
else:
self.log.info("Using MathJax: %s", new)
Satrajit Ghosh
enh: added authentication ability for webapp
r4690
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 def parse_command_line(self, argv=None):
Brian E. Granger
Misc changes to the notebook....
r5104 super(NotebookApp, self).parse_command_line(argv)
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 if argv is None:
argv = sys.argv[1:]
MinRK
Split swallow_argv into standalone function in lib.kernel...
r5620 # Scrub frontend-specific flags
self.kernel_argv = swallow_argv(argv, notebook_aliases, notebook_flags)
Brian E. Granger
More review changes....
r4609 # Kernel should inherit default config file from frontend
Brian E. Granger
Notebook app debugging....
r4345 self.kernel_argv.append("--KernelApp.parent_appname='%s'"%self.name)
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
Puneeth Chaganti
ENH: Open a notebook from the command line...
r6724 if self.extra_args:
MinRK
minor notebook-dir config adjustments...
r7556 f = os.path.abspath(self.extra_args[0])
if os.path.isdir(f):
nbdir = f
else:
self.file_to_run = f
nbdir = os.path.dirname(f)
self.config.NotebookManager.notebook_dir = nbdir
Puneeth Chaganti
ENH: Open a notebook from the command line...
r6724
Brian E. Granger
Adding kernel/notebook associations.
r4494 def init_configurables(self):
MinRK
enable HMAC message signing by default in notebook kernels...
r4963 # force Session default to be secure
default_secure(self.config)
Brian E. Granger
Major refactor of kernel connection management in the notebook....
r4545 self.kernel_manager = MappingKernelManager(
MinRK
use zmq.KernelManager to manage individual kernels in notebook...
r4960 config=self.config, log=self.log, kernel_argv=self.kernel_argv,
connection_dir = self.profile_dir.security_dir,
Brian E. Granger
Adding kernel/notebook associations.
r4494 )
self.notebook_manager = NotebookManager(config=self.config, log=self.log)
MinRK
minor notebook-dir config adjustments...
r7556 self.log.info("Serving notebooks from %s", self.notebook_manager.notebook_dir)
Brian E. Granger
Changing notebook uuid algorithm to preserver across sessions.
r4622 self.notebook_manager.list_notebooks()
Brian Granger
First version of cluster web service....
r6191 self.cluster_manager = ClusterManager(config=self.config, log=self.log)
Brian Granger
Notebook cluster manager now uses proper launchers.
r6199 self.cluster_manager.update_profiles()
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
Brian E. Granger
Notebook app debugging....
r4345 def init_logging(self):
# This prevents double log messages because tornado use a root logger that
# self.log is a child of. The logging module dipatches log messages to a log
# and all of its ancenstors until propagate is set to False.
self.log.propagate = False
MinRK
cleanup connection files on notebook shutdown...
r5799
def init_webapp(self):
"""initialize tornado webapp and httpserver"""
Brian E. Granger
More work on updating the notebook zmq forwarding.
r4347 self.web_app = NotebookWebApplication(
Brian Granger
First version of cluster web service....
r6191 self, self.kernel_manager, self.notebook_manager,
self.cluster_manager, self.log,
Andrew Straw
allow setting base_project_url and base_kernel_url to non-default values
r6004 self.base_project_url, self.webapp_settings
Brian E. Granger
More work on updating the notebook zmq forwarding.
r4347 )
Brian E. Granger
Updating notebook configuration....
r4519 if self.certfile:
ssl_options = dict(certfile=self.certfile)
if self.keyfile:
ssl_options['keyfile'] = self.keyfile
else:
ssl_options = None
MinRK
notebook auth adjustments...
r4705 self.web_app.password = self.password
Brian E. Granger
Updating notebook configuration....
r4519 self.http_server = httpserver.HTTPServer(self.web_app, ssl_options=ssl_options)
MinRK
cleanup connection files on notebook shutdown...
r5799 if ssl_options is None and not self.ip and not (self.read_only and not self.password):
Brian E. Granger
Updating notebook configuration....
r4519 self.log.critical('WARNING: the notebook server is listening on all IP addresses '
'but not using any encryption or authentication. This is highly '
'insecure and not recommended.')
Brian E. Granger
More review changes....
r4609
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 success = None
for port in random_ports(self.port, self.port_retries+1):
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 try:
self.http_server.listen(port, self.ip)
Matthias BUSSONNIER
conform to pep 3110...
r7787 except socket.error as e:
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 if e.errno != errno.EADDRINUSE:
raise
Brian E. Granger
More review changes....
r4609 self.log.info('The port %i is already in use, trying another random port.' % port)
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 else:
self.port = port
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 success = True
Brian E. Granger
Autotry additional ports if 8888 if already in use.
r4548 break
Bradley M. Froehle
NotebookApp: Make the number of ports to retry user configurable....
r7234 if not success:
self.log.critical('ERROR: the notebook server could not be started because '
'no available port could be found.')
Bradley M. Froehle
exit if server cannot start (instead of ugly traceback)
r7240 self.exit(1)
MinRK
cleanup connection files on notebook shutdown...
r5799
MinRK
exit notebook cleanly on SIGINT, SIGTERM...
r6498 def init_signal(self):
MinRK
handle old pyzmq in notebook exit confirmation...
r6509 # FIXME: remove this check when pyzmq dependency is >= 2.1.11
# safely extract zmq version info:
try:
zmq_v = zmq.pyzmq_version_info()
except AttributeError:
zmq_v = [ int(n) for n in re.findall(r'\d+', zmq.__version__) ]
if 'dev' in zmq.__version__:
zmq_v.append(999)
zmq_v = tuple(zmq_v)
MinRK
disable ^C^C confirmation on Windows
r7689 if zmq_v >= (2,1,9) and not sys.platform.startswith('win'):
MinRK
handle old pyzmq in notebook exit confirmation...
r6509 # This won't work with 2.1.7 and
# 2.1.9-10 will log ugly 'Interrupted system call' messages,
# but it will work
signal.signal(signal.SIGINT, self._handle_sigint)
MinRK
confirm notebook shutdown on SIGINT...
r6508 signal.signal(signal.SIGTERM, self._signal_stop)
MinRK
exit notebook cleanly on SIGINT, SIGTERM...
r6498
MinRK
confirm notebook shutdown on SIGINT...
r6508 def _handle_sigint(self, sig, frame):
"""SIGINT handler spawns confirmation dialog"""
# register more forceful signal handler for ^C^C case
signal.signal(signal.SIGINT, self._signal_stop)
# request confirmation dialog in bg thread, to avoid
# blocking the App
thread = threading.Thread(target=self._confirm_exit)
thread.daemon = True
thread.start()
def _restore_sigint_handler(self):
"""callback for restoring original SIGINT handler"""
signal.signal(signal.SIGINT, self._handle_sigint)
def _confirm_exit(self):
"""confirm shutdown on ^C
A second ^C, or answering 'y' within 5s will cause shutdown,
otherwise original SIGINT handler will be restored.
MinRK
disable ^C^C confirmation on Windows
r7689
This doesn't work on Windows.
MinRK
confirm notebook shutdown on SIGINT...
r6508 """
MinRK
handle old pyzmq in notebook exit confirmation...
r6509 # FIXME: remove this delay when pyzmq dependency is >= 2.1.11
time.sleep(0.1)
MinRK
confirm notebook shutdown on SIGINT...
r6508 sys.stdout.write("Shutdown Notebook Server (y/[n])? ")
sys.stdout.flush()
r,w,x = select.select([sys.stdin], [], [], 5)
if r:
line = sys.stdin.readline()
if line.lower().startswith('y'):
self.log.critical("Shutdown confirmed")
ioloop.IOLoop.instance().stop()
return
else:
print "No answer for 5s:",
print "resuming operation..."
# no answer, or answer is no:
# set it back to original SIGINT handler
# use IOLoop.add_callback because signal.signal must be called
# from main thread
ioloop.IOLoop.instance().add_callback(self._restore_sigint_handler)
def _signal_stop(self, sig, frame):
MinRK
exit notebook cleanly on SIGINT, SIGTERM...
r6498 self.log.critical("received signal %s, stopping", sig)
ioloop.IOLoop.instance().stop()
MinRK
cleanup connection files on notebook shutdown...
r5799 @catch_config_error
def initialize(self, argv=None):
MinRK
move default log setup to _log_default from init_logging...
r6883 self.init_logging()
MinRK
cleanup connection files on notebook shutdown...
r5799 super(NotebookApp, self).initialize(argv)
self.init_configurables()
self.init_webapp()
MinRK
exit notebook cleanly on SIGINT, SIGTERM...
r6498 self.init_signal()
MinRK
cleanup connection files on notebook shutdown...
r5799
def cleanup_kernels(self):
"""shutdown all kernels
The kernels will shutdown themselves when this process no longer exists,
but explicit shutdown allows the KernelManagers to cleanup the connection files.
"""
self.log.info('Shutting down kernels')
km = self.kernel_manager
MinRK
use shutdown_kernel instead of hard kill in notebook
r7627 # copy list, since shutdown_kernel deletes keys
MinRK
explicit for-loop in cleanup_kernels...
r5838 for kid in list(km.kernel_ids):
MinRK
use shutdown_kernel instead of hard kill in notebook
r7627 km.shutdown_kernel(kid)
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
def start(self):
Brian E. Granger
Updating notebook configuration....
r4519 ip = self.ip if self.ip else '[all ip addresses on your system]'
Satrajit Ghosh
fix: applied fernando's if simplification fix
r4682 proto = 'https' if self.certfile else 'http'
Fernando Perez
Add message about how to stop the notebook.
r5786 info = self.log.info
Andrew Straw
use full URL when using alternate URL prefix
r6014 info("The IPython Notebook is running at: %s://%s:%i%s" %
(proto, ip, self.port,self.base_project_url) )
Fernando Perez
Add message about how to stop the notebook.
r5786 info("Use Control-C to stop this server and shut down all kernels.")
MinRK
minor notebook-dir config adjustments...
r7556 if self.open_browser or self.file_to_run:
Thomas Kluyver
Add ability to open the notebook in a browser when it starts.
r5065 ip = self.ip or '127.0.0.1'
Bradley M. Froehle
notebook: Print a warning (but do not abort) if no webbrowser can be found....
r7658 try:
browser = webbrowser.get(self.browser or None)
except webbrowser.Error as e:
self.log.warn('No web browser found: %s.' % e)
browser = None
Puneeth Chaganti
ENH: Open a notebook from the command line...
r6724
if self.file_to_run:
filename, _ = os.path.splitext(os.path.basename(self.file_to_run))
for nb in self.notebook_manager.list_notebooks():
if filename == nb['name']:
url = nb['notebook_id']
break
else:
url = ''
else:
url = ''
Bradley M. Froehle
notebook: Print a warning (but do not abort) if no webbrowser can be found....
r7658 if browser:
b = lambda : browser.open("%s://%s:%i%s%s" % (proto, ip,
self.port, self.base_project_url, url), new=2)
threading.Thread(target=b).start()
MinRK
cleanup connection files on notebook shutdown...
r5799 try:
ioloop.IOLoop.instance().start()
except KeyboardInterrupt:
info("Interrupted...")
finally:
self.cleanup_kernels()
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344
#-----------------------------------------------------------------------------
# Main entry point
#-----------------------------------------------------------------------------
Brian E. Granger
Creating files to new notebook app.
r4339
Brian E. Granger
Initial reorg of files complete....
r4341 def launch_new_instance():
MinRK
cleanup connection files on notebook shutdown...
r5799 app = NotebookApp.instance()
Brian E. Granger
Refactoring the notebook app to support the new config system.
r4344 app.initialize()
app.start()
Brian E. Granger
Creating files to new notebook app.
r4339