handlers.py
230 lines
| 7.8 KiB
| text/x-python
|
PythonLexer
|
r16697 | """Tornado handlers for kernels.""" | ||
|
r10641 | |||
|
r16697 | # Copyright (c) IPython Development Team. | ||
# Distributed under the terms of the Modified BSD License. | ||||
|
r10641 | |||
|
r17021 | import json | ||
|
r10641 | import logging | ||
from tornado import web | ||||
from IPython.utils.jsonutil import date_default | ||||
|
r16697 | from IPython.utils.py3compat import string_types | ||
|
r13132 | from IPython.html.utils import url_path_join, url_escape | ||
|
r10641 | |||
|
r13052 | from ...base.handlers import IPythonHandler, json_errors | ||
|
r10665 | from ...base.zmqhandlers import AuthenticatedZMQStreamHandler | ||
|
r10641 | |||
|
r16697 | from IPython.core.release import kernel_protocol_version | ||
|
r10641 | |||
class MainKernelHandler(IPythonHandler): | ||||
@web.authenticated | ||||
|
r13052 | @json_errors | ||
|
r10641 | def get(self): | ||
km = self.kernel_manager | ||||
|
r17021 | self.finish(json.dumps(km.list_kernels())) | ||
|
r10641 | |||
@web.authenticated | ||||
|
r13052 | @json_errors | ||
|
r10641 | def post(self): | ||
|
r17221 | model = self.get_json_body() | ||
if model is None: | ||||
raise web.HTTPError(400, "No JSON data provided") | ||||
try: | ||||
name = model['name'] | ||||
except KeyError: | ||||
raise web.HTTPError(400, "Missing field in JSON data: name") | ||||
|
r10641 | km = self.kernel_manager | ||
|
r17221 | kernel_id = km.start_kernel(kernel_name=name) | ||
|
r15400 | model = km.kernel_model(kernel_id) | ||
|
r15310 | location = url_path_join(self.base_url, 'api', 'kernels', kernel_id) | ||
|
r13132 | self.set_header('Location', url_escape(location)) | ||
|
r13058 | self.set_status(201) | ||
|
r17021 | self.finish(json.dumps(model)) | ||
|
r10641 | |||
class KernelHandler(IPythonHandler): | ||||
|
r12983 | SUPPORTED_METHODS = ('DELETE', 'GET') | ||
@web.authenticated | ||||
|
r13052 | @json_errors | ||
|
r12983 | def get(self, kernel_id): | ||
km = self.kernel_manager | ||||
|
r13058 | km._check_kernel_id(kernel_id) | ||
|
r15400 | model = km.kernel_model(kernel_id) | ||
|
r17021 | self.finish(json.dumps(model)) | ||
|
r10641 | |||
@web.authenticated | ||||
|
r13052 | @json_errors | ||
|
r10641 | def delete(self, kernel_id): | ||
km = self.kernel_manager | ||||
km.shutdown_kernel(kernel_id) | ||||
self.set_status(204) | ||||
self.finish() | ||||
class KernelActionHandler(IPythonHandler): | ||||
@web.authenticated | ||||
|
r13052 | @json_errors | ||
|
r10641 | def post(self, kernel_id, action): | ||
km = self.kernel_manager | ||||
if action == 'interrupt': | ||||
km.interrupt_kernel(kernel_id) | ||||
self.set_status(204) | ||||
if action == 'restart': | ||||
km.restart_kernel(kernel_id) | ||||
|
r15400 | model = km.kernel_model(kernel_id) | ||
|
r15310 | self.set_header('Location', '{0}api/kernels/{1}'.format(self.base_url, kernel_id)) | ||
|
r17021 | self.write(json.dumps(model)) | ||
|
r10641 | self.finish() | ||
class ZMQChannelHandler(AuthenticatedZMQStreamHandler): | ||||
|
r17647 | def __repr__(self): | ||
return "%s(%s)" % (self.__class__.__name__, getattr(self, 'kernel_id', 'uninitialized')) | ||||
|
r10641 | def create_stream(self): | ||
km = self.kernel_manager | ||||
meth = getattr(km, 'connect_%s' % self.channel) | ||||
self.zmq_stream = meth(self.kernel_id, identity=self.session.bsession) | ||||
|
r16698 | # Create a kernel_info channel to query the kernel protocol version. | ||
# This channel will be closed after the kernel_info reply is received. | ||||
|
r16697 | self.kernel_info_channel = None | ||
self.kernel_info_channel = km.connect_shell(self.kernel_id) | ||||
|
r16698 | self.kernel_info_channel.on_recv(self._handle_kernel_info_reply) | ||
|
r16697 | self._request_kernel_info() | ||
def _request_kernel_info(self): | ||||
|
r16698 | """send a request for kernel_info""" | ||
|
r16697 | self.log.debug("requesting kernel info") | ||
self.session.send(self.kernel_info_channel, "kernel_info_request") | ||||
|
r16698 | def _handle_kernel_info_reply(self, msg): | ||
"""process the kernel_info_reply | ||||
enabling msg spec adaptation, if necessary | ||||
""" | ||||
|
r16697 | idents,msg = self.session.feed_identities(msg) | ||
try: | ||||
msg = self.session.unserialize(msg) | ||||
except: | ||||
self.log.error("Bad kernel_info reply", exc_info=True) | ||||
self._request_kernel_info() | ||||
return | ||||
else: | ||||
if msg['msg_type'] != 'kernel_info_reply' or 'protocol_version' not in msg['content']: | ||||
self.log.error("Kernel info request failed, assuming current %s", msg['content']) | ||||
else: | ||||
protocol_version = msg['content']['protocol_version'] | ||||
if protocol_version != kernel_protocol_version: | ||||
self.session.adapt_version = int(protocol_version.split('.')[0]) | ||||
self.log.info("adapting kernel to %s" % protocol_version) | ||||
self.kernel_info_channel.close() | ||||
self.kernel_info_channel = None | ||||
|
r18277 | def initialize(self): | ||
super(ZMQChannelHandler, self).initialize() | ||||
|
r10641 | self.zmq_stream = None | ||
|
r18277 | def open(self, kernel_id): | ||
super(ZMQChannelHandler, self).open(kernel_id) | ||||
|
r10641 | try: | ||
self.create_stream() | ||||
except web.HTTPError: | ||||
# WebSockets don't response to traditional error codes so we | ||||
# close the connection. | ||||
if not self.stream.closed(): | ||||
self.stream.close() | ||||
self.close() | ||||
else: | ||||
self.zmq_stream.on_recv(self._on_zmq_reply) | ||||
def on_message(self, msg): | ||||
|
r17647 | if self.zmq_stream is None: | ||
return | ||||
elif self.zmq_stream.closed(): | ||||
self.log.info("%s closed, closing websocket.", self) | ||||
self.close() | ||||
return | ||||
|
r17021 | msg = json.loads(msg) | ||
|
r11266 | self.session.send(self.zmq_stream, msg) | ||
|
r10641 | |||
def on_close(self): | ||||
# This method can be called twice, once by self.kernel_died and once | ||||
# from the WebSocket close event. If the WebSocket connection is | ||||
# closed before the ZMQ streams are setup, they could be None. | ||||
if self.zmq_stream is not None and not self.zmq_stream.closed(): | ||||
self.zmq_stream.on_recv(None) | ||||
|
r16526 | # close the socket directly, don't wait for the stream | ||
socket = self.zmq_stream.socket | ||||
|
r10641 | self.zmq_stream.close() | ||
|
r16526 | socket.close() | ||
|
r10641 | |||
class IOPubHandler(ZMQChannelHandler): | ||||
channel = 'iopub' | ||||
def create_stream(self): | ||||
super(IOPubHandler, self).create_stream() | ||||
km = self.kernel_manager | ||||
km.add_restart_callback(self.kernel_id, self.on_kernel_restarted) | ||||
km.add_restart_callback(self.kernel_id, self.on_restart_failed, 'dead') | ||||
def on_close(self): | ||||
km = self.kernel_manager | ||||
if self.kernel_id in km: | ||||
km.remove_restart_callback( | ||||
self.kernel_id, self.on_kernel_restarted, | ||||
) | ||||
km.remove_restart_callback( | ||||
self.kernel_id, self.on_restart_failed, 'dead', | ||||
) | ||||
super(IOPubHandler, self).on_close() | ||||
def _send_status_message(self, status): | ||||
msg = self.session.msg("status", | ||||
{'execution_state': status} | ||||
) | ||||
|
r17021 | self.write_message(json.dumps(msg, default=date_default)) | ||
|
r10641 | |||
def on_kernel_restarted(self): | ||||
logging.warn("kernel %s restarted", self.kernel_id) | ||||
self._send_status_message('restarting') | ||||
def on_restart_failed(self): | ||||
logging.error("kernel %s restarted failed!", self.kernel_id) | ||||
self._send_status_message('dead') | ||||
def on_message(self, msg): | ||||
"""IOPub messages make no sense""" | ||||
pass | ||||
|
r10647 | |||
|
r10641 | class ShellHandler(ZMQChannelHandler): | ||
channel = 'shell' | ||||
|
r10647 | |||
|
r10641 | class StdinHandler(ZMQChannelHandler): | ||
channel = 'stdin' | ||||
|
r10647 | |||
#----------------------------------------------------------------------------- | ||||
# URL to handler mappings | ||||
#----------------------------------------------------------------------------- | ||||
_kernel_id_regex = r"(?P<kernel_id>\w+-\w+-\w+-\w+-\w+)" | ||||
_kernel_action_regex = r"(?P<action>restart|interrupt)" | ||||
default_handlers = [ | ||||
|
r12983 | (r"/api/kernels", MainKernelHandler), | ||
(r"/api/kernels/%s" % _kernel_id_regex, KernelHandler), | ||||
(r"/api/kernels/%s/%s" % (_kernel_id_regex, _kernel_action_regex), KernelActionHandler), | ||||
(r"/api/kernels/%s/iopub" % _kernel_id_regex, IOPubHandler), | ||||
(r"/api/kernels/%s/shell" % _kernel_id_regex, ShellHandler), | ||||
(r"/api/kernels/%s/stdin" % _kernel_id_regex, StdinHandler) | ||||
|
r10647 | ] | ||