This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: html.services.kernels.kernelmanager

A MultiKernelManager for use in the notebook webserver

  • raises HTTPErrors
  • creates REST API models

1 Class

class IPython.html.services.kernels.kernelmanager.MappingKernelManager(**kwargs)

Bases: IPython.kernel.multikernelmanager.MultiKernelManager

A KernelManager that handles notebook mapping and HTTP error handling


Turn API path into absolute OS path.


Return a dictionary of kernel information described in the JSON standard model.


Returns a list of kernel_id’s of kernels running.

shutdown_kernel(kernel_id, now=False)

Shutdown a kernel by kernel_id

start_kernel(kernel_id=None, path=None, kernel_name='python', **kwargs)

Start a kernel for a session and return its kernel_id.


kernel_id : uuid

The uuid to associate the new kernel with. If this is not None, this kernel will be persistent whenever it is requested.

path : API path

The API path (unicode, ‘/’ delimited) for the cwd. Will be transformed to an OS path relative to root_dir.

kernel_name : str

The name identifying which kernel spec to launch. This is ignored if an existing kernel is returned, but it may be checked in the future.