Skip to main content
`Ctrl`+`K`

# jupyter_client.ioloop package

## Submodules

A kernel manager with a tornado IOLoop

class jupyter_client.ioloop.manager.AsyncIOLoopKernelManager(*args, **kwargs)

  Bases: `AsyncKernelManager`

  An async ioloop kernel manager.

  connect_control(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Control channel

    Return type:

      `Any`

  connect_hb(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Heartbeat channel

    Return type:

      `Any`

  connect_iopub(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the IOPub channel

    Return type:

      `Any`

  connect_shell(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Shell channel

    Return type:

      `Any`

  connect_stdin(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the StdIn channel

    Return type:

      `Any`

  loop

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

    Subclasses can declare default classes by overriding the klass attribute

  restarter_class

    Type of KernelRestarter to use. Must be a subclass of AsyncIOLoopKernelManager. Override this to customize how kernel restarts are managed.

  start_restarter()

    Start the restarter.

    Return type:

      `None`

  stop_restarter()

    Stop the restarter.

    Return type:

      `None`

class jupyter_client.ioloop.manager.IOLoopKernelManager(*args, **kwargs)

  Bases: `KernelManager`

  An io loop kernel manager.

  connect_control(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Control channel

    Return type:

      `Any`

  connect_hb(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Heartbeat channel

    Return type:

      `Any`

  connect_iopub(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the IOPub channel

    Return type:

      `Any`

  connect_shell(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the Shell channel

    Return type:

      `Any`

  connect_stdin(*args: Any, **kwargs: Any) → Any

    return zmq Socket connected to the StdIn channel

    Return type:

      `Any`

  loop

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

    Subclasses can declare default classes by overriding the klass attribute

  restarter_class

    Type of KernelRestarter to use. Must be a subclass of IOLoopKernelRestarter. Override this to customize how kernel restarts are managed.

  start_restarter()

    Start the restarter.

    Return type:

      `None`

  stop_restarter()

    Stop the restarter.

    Return type:

      `None`

jupyter_client.ioloop.manager.as_zmqstream(f)

  Convert a socket to a zmq stream.

  Return type:

    `Callable`

A basic in process kernel monitor with autorestarting.

This watches a kernel’s state using KernelManager.is_alive and auto restarts the kernel if it dies.

class jupyter_client.ioloop.restarter.AsyncIOLoopKernelRestarter(**kwargs)

  Bases: `IOLoopKernelRestarter`

  An async io loop kernel restarter.

  async poll()

    Poll the kernel.

    Return type:

      `None`

class jupyter_client.ioloop.restarter.IOLoopKernelRestarter(**kwargs)

  Bases: `KernelRestarter`

  Monitor and autorestart a kernel.

  loop

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

    Subclasses can declare default classes by overriding the klass attribute

  start()

    Start the polling of the kernel.

    Return type:

      `None`

  stop()

    Stop the kernel polling.

    Return type:

      `None`

## Module contents