IPython Documentation

Table Of Contents

Previous topic

Module: html.notebook.handlers

Next topic

Module: html.services.clusters.clustermanager

This Page

Module: html.notebookapp

A tornado based IPython notebook server.


  • Brian Granger

3 Classes

class IPython.html.notebookapp.NotebookWebApplication(ipython_app, kernel_manager, notebook_manager, cluster_manager, session_manager, log, base_url, settings_overrides, jinja_env_options)

Bases: tornado.web.Application

__init__(ipython_app, kernel_manager, notebook_manager, cluster_manager, session_manager, log, base_url, settings_overrides, jinja_env_options)
class IPython.html.notebookapp.NbserverListApp(**kwargs)

Bases: IPython.core.application.BaseIPythonApplication

class IPython.html.notebookapp.NotebookApp(**kwargs)

Bases: IPython.core.application.BaseIPythonApplication


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.


Check the components submodule, and warn if it’s unclean


construct the kernel arguments


initialize tornado webapp and httpserver


Return the current working directory and the server url information


Remove the nbserver-<pid>.json file created for this server.

Ignores the error raised when the file has already been removed.


Return a JSONable dict of information about this server.


Start the IPython Notebook server app, after initialization

This method takes no arguments so all configuration and initialization must be done prior to calling this method.


return extra paths + the default location


Write the result of server_info() to the JSON file info_file.

3 Functions

IPython.html.notebookapp.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].


Load the (URL pattern, handler) tuples for each component.


Iterate over the server info files of running notebook servers.

Given a profile name, find nbserver-* files in the security directory of that profile, and yield dicts of their information, each one pertaining to a currently running notebook server instance.