kernelmanager.py
188 lines
| 5.8 KiB
| text/x-python
|
PythonLexer
|
r4343 | """A kernel manager for multiple kernels.""" | ||
|
r4344 | #----------------------------------------------------------------------------- | ||
|
r4348 | # Copyright (C) 2011 The IPython Development Team | ||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING.txt, distributed as part of this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
|
r4344 | # Imports | ||
#----------------------------------------------------------------------------- | ||||
|
r4297 | import signal | ||
import sys | ||||
|
r4306 | import uuid | ||
|
r4297 | |||
|
r4343 | import zmq | ||
|
r4345 | from IPython.config.configurable import LoggingConfigurable | ||
|
r4297 | from IPython.zmq.ipkernel import launch_kernel | ||
|
r4346 | from IPython.utils.traitlets import Instance, Dict | ||
|
r4297 | |||
|
r4344 | #----------------------------------------------------------------------------- | ||
# Classes | ||||
#----------------------------------------------------------------------------- | ||||
|
r4297 | |||
|
r4298 | class DuplicateKernelError(Exception): | ||
pass | ||||
|
r4345 | class KernelManager(LoggingConfigurable): | ||
|
r4343 | """A class for managing multiple kernels.""" | ||
context = Instance('zmq.Context') | ||||
def _context_default(self): | ||||
return zmq.Context.instance() | ||||
|
r4297 | |||
|
r4343 | _kernels = Dict() | ||
|
r4297 | |||
@property | ||||
def kernel_ids(self): | ||||
|
r4343 | """Return a list of the kernel ids of the active kernels.""" | ||
|
r4297 | return self._kernels.keys() | ||
def __len__(self): | ||||
|
r4343 | """Return the number of running kernels.""" | ||
|
r4297 | return len(self.kernel_ids) | ||
def __contains__(self, kernel_id): | ||||
if kernel_id in self.kernel_ids: | ||||
return True | ||||
else: | ||||
return False | ||||
|
r4343 | def start_kernel(self, **kwargs): | ||
"""Start a new kernel.""" | ||||
|
r4306 | kernel_id = str(uuid.uuid4()) | ||
|
r4343 | (process, shell_port, iopub_port, stdin_port, hb_port) = launch_kernel(**kwargs) | ||
# Store the information for contacting the kernel. This assumes the kernel is | ||||
# running on localhost. | ||||
|
r4297 | d = dict( | ||
process = process, | ||||
stdin_port = stdin_port, | ||||
iopub_port = iopub_port, | ||||
shell_port = shell_port, | ||||
hb_port = hb_port, | ||||
|
r4343 | ip = '127.0.0.1' | ||
|
r4297 | ) | ||
|
r4298 | self._kernels[kernel_id] = d | ||
return kernel_id | ||||
|
r4297 | |||
def kill_kernel(self, kernel_id): | ||||
|
r4343 | """Kill a kernel by its kernel uuid. | ||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel to kill. | ||||
""" | ||||
|
r4297 | kernel_process = self.get_kernel_process(kernel_id) | ||
if kernel_process is not None: | ||||
# Attempt to kill the kernel. | ||||
try: | ||||
kernel_process.kill() | ||||
except OSError, e: | ||||
# In Windows, we will get an Access Denied error if the process | ||||
# has already terminated. Ignore it. | ||||
if not (sys.platform == 'win32' and e.winerror == 5): | ||||
raise | ||||
del self._kernels[kernel_id] | ||||
def interrupt_kernel(self, kernel_id): | ||||
|
r4343 | """Interrupt (SIGINT) the kernel by its uuid. | ||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel to interrupt. | ||||
""" | ||||
|
r4297 | kernel_process = self.get_kernel_process(kernel_id) | ||
if kernel_process is not None: | ||||
if sys.platform == 'win32': | ||||
from parentpoller import ParentPollerWindows as Poller | ||||
Poller.send_interrupt(kernel_process.win32_interrupt_event) | ||||
else: | ||||
kernel_process.send_signal(signal.SIGINT) | ||||
def signal_kernel(self, kernel_id, signum): | ||||
|
r4343 | """ Sends a signal to the kernel by its uuid. | ||
Note that since only SIGTERM is supported on Windows, this function | ||||
is only useful on Unix systems. | ||||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel to signal. | ||||
|
r4297 | """ | ||
kernel_process = self.get_kernel_process(kernel_id) | ||||
if kernel_process is not None: | ||||
kernel_process.send_signal(signum) | ||||
def get_kernel_process(self, kernel_id): | ||||
|
r4343 | """Get the process object for a kernel by its uuid. | ||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel. | ||||
""" | ||||
|
r4297 | d = self._kernels.get(kernel_id) | ||
if d is not None: | ||||
return d['process'] | ||||
else: | ||||
raise KeyError("Kernel with id not found: %s" % kernel_id) | ||||
def get_kernel_ports(self, kernel_id): | ||||
|
r4343 | """Return a dictionary of ports for a kernel. | ||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel. | ||||
Returns | ||||
======= | ||||
port_dict : dict | ||||
A dict of key, value pairs where the keys are the names | ||||
(stdin_port,iopub_port,shell_port) and the values are the | ||||
integer port numbers for those channels. | ||||
""" | ||||
|
r4297 | d = self._kernels.get(kernel_id) | ||
if d is not None: | ||||
dcopy = d.copy() | ||||
dcopy.pop('process') | ||||
|
r4343 | dcopy.pop('ip') | ||
|
r4297 | return dcopy | ||
else: | ||||
raise KeyError("Kernel with id not found: %s" % kernel_id) | ||||
|
r4343 | def get_kernel_ip(self, kernel_id): | ||
"""Return ip address for a kernel. | ||||
Parameters | ||||
========== | ||||
kernel_id : uuid | ||||
The id of the kernel. | ||||
Returns | ||||
======= | ||||
ip : str | ||||
The ip address of the kernel. | ||||
""" | ||||
|
r4297 | d = self._kernels.get(kernel_id) | ||
if d is not None: | ||||
|
r4343 | return d['ip'] | ||
|
r4297 | else: | ||
raise KeyError("Kernel with id not found: %s" % kernel_id) | ||||
|
r4343 | def create_session_manager(self, kernel_id): | ||
"""Create a new session manager for a kernel by its uuid.""" | ||||
from sessionmanager import SessionManager | ||||
return SessionManager( | ||||
kernel_id=kernel_id, kernel_manager=self, | ||||
|
r4345 | config=self.config, context=self.context, log=self.log | ||
|
r4343 | ) | ||
|
r4297 | |||