ipkernel.py
700 lines
| 25.6 KiB
| text/x-python
|
PythonLexer
Fernando Perez
|
r2598 | #!/usr/bin/env python | ||
"""A simple interactive kernel that talks to a frontend over 0MQ. | ||||
Things to do: | ||||
* Implement `set_parent` logic. Right before doing exec, the Kernel should | ||||
call set_parent on all the PUB objects with the message about to be executed. | ||||
* Implement random port and security key logic. | ||||
* Implement control messages. | ||||
* Implement event loop and poll version. | ||||
""" | ||||
epatters
|
r2712 | #----------------------------------------------------------------------------- | ||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
Fernando Perez
|
r2856 | from __future__ import print_function | ||
epatters
|
r2712 | |||
epatters
|
r2641 | # Standard library imports. | ||
Fernando Perez
|
r2598 | import __builtin__ | ||
Fernando Perez
|
r2972 | import atexit | ||
Fernando Perez
|
r2598 | import sys | ||
import time | ||||
import traceback | ||||
Omar Andres Zapata Mesa
|
r3294 | import logging | ||
epatters
|
r2641 | # System library imports. | ||
Fernando Perez
|
r2598 | import zmq | ||
epatters
|
r2641 | # Local imports. | ||
Brian Granger
|
r2759 | from IPython.config.configurable import Configurable | ||
MinRK
|
r3970 | from IPython.config.application import boolean_flag | ||
MinRK
|
r4023 | from IPython.core.application import ProfileDir | ||
MinRK
|
r3979 | from IPython.core.shellapp import ( | ||
InteractiveShellApp, shell_flags, shell_aliases | ||||
) | ||||
Fernando Perez
|
r2856 | from IPython.utils import io | ||
Fernando Perez
|
r2948 | from IPython.utils.jsonutil import json_clean | ||
Brian Granger
|
r2868 | from IPython.lib import pylabtools | ||
MinRK
|
r3970 | from IPython.utils.traitlets import ( | ||
List, Instance, Float, Dict, Bool, Int, Unicode, CaselessStrEnum | ||||
) | ||||
MinRK
|
r3979 | |||
MinRK
|
r3970 | from entry_point import base_launch_kernel | ||
from kernelapp import KernelApp, kernel_flags, kernel_aliases | ||||
epatters
|
r2796 | from iostream import OutStream | ||
epatters
|
r2778 | from session import Session, Message | ||
from zmqshell import ZMQInteractiveShell | ||||
Fernando Perez
|
r2598 | |||
Omar Andres Zapata Mesa
|
r3314 | |||
Fernando Perez
|
r3427 | |||
epatters
|
r2712 | #----------------------------------------------------------------------------- | ||
Brian Granger
|
r2754 | # Main kernel class | ||
epatters
|
r2712 | #----------------------------------------------------------------------------- | ||
epatters
|
r2641 | |||
Brian Granger
|
r2759 | class Kernel(Configurable): | ||
epatters
|
r2778 | #--------------------------------------------------------------------------- | ||
# Kernel interface | ||||
#--------------------------------------------------------------------------- | ||||
Brian Granger
|
r2760 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | ||
epatters
|
r2778 | session = Instance(Session) | ||
MinRK
|
r3970 | shell_socket = Instance('zmq.Socket') | ||
iopub_socket = Instance('zmq.Socket') | ||||
stdin_socket = Instance('zmq.Socket') | ||||
log = Instance(logging.Logger) | ||||
Brian Granger
|
r2759 | |||
Fernando Perez
|
r2940 | # Private interface | ||
# Time to sleep after flushing the stdout/err buffers in each execute | ||||
# cycle. While this introduces a hard limit on the minimal latency of the | ||||
# execute cycle, it helps prevent output synchronization problems for | ||||
# clients. | ||||
# Units are in seconds. The minimum zmq latency on local host is probably | ||||
# ~150 microseconds, set this to 500us for now. We may need to increase it | ||||
# a little if it's not enough after more interactive testing. | ||||
_execute_sleep = Float(0.0005, config=True) | ||||
# Frequency of the kernel's event loop. | ||||
# Units are in seconds, kernel subclasses for GUI toolkits may need to | ||||
# adapt to milliseconds. | ||||
_poll_interval = Float(0.05, config=True) | ||||
Fernando Perez
|
r2972 | |||
# If the shutdown was requested over the network, we leave here the | ||||
# necessary reply message so it can be sent by our registered atexit | ||||
# handler. This ensures that the reply is only sent to clients truly at | ||||
# the end of our shutdown process (which happens after the underlying | ||||
# IPython shell's own shutdown). | ||||
_shutdown_message = None | ||||
Brian Granger
|
r3019 | |||
# This is a dict of port number that the kernel is listening on. It is set | ||||
# by record_ports and used by connect_request. | ||||
MinRK
|
r3970 | _recorded_ports = Dict() | ||
Omar Andres Zapata Mesa
|
r3294 | |||
Brian Granger
|
r2759 | def __init__(self, **kwargs): | ||
super(Kernel, self).__init__(**kwargs) | ||||
Brian Granger
|
r2786 | |||
Fernando Perez
|
r2972 | # Before we even start up the shell, register *first* our exit handlers | ||
# so they come before the shell's | ||||
atexit.register(self._at_shutdown) | ||||
Brian Granger
|
r2786 | # Initialize the InteractiveShell subclass | ||
MinRK
|
r3970 | self.shell = ZMQInteractiveShell.instance(config=self.config) | ||
Brian Granger
|
r2786 | self.shell.displayhook.session = self.session | ||
MinRK
|
r3970 | self.shell.displayhook.pub_socket = self.iopub_socket | ||
Brian Granger
|
r3277 | self.shell.display_pub.session = self.session | ||
MinRK
|
r3970 | self.shell.display_pub.pub_socket = self.iopub_socket | ||
epatters
|
r2778 | |||
Fernando Perez
|
r2838 | # TMP - hack while developing | ||
self.shell._reply_content = None | ||||
Fernando Perez
|
r2598 | # Build dict of handlers for message types | ||
epatters
|
r2612 | msg_types = [ 'execute_request', 'complete_request', | ||
Thomas Kluyver
|
r3817 | 'object_info_request', 'history_request', | ||
Brian Granger
|
r3024 | 'connect_request', 'shutdown_request'] | ||
Fernando Perez
|
r2598 | self.handlers = {} | ||
epatters
|
r2612 | for msg_type in msg_types: | ||
Fernando Perez
|
r2598 | self.handlers[msg_type] = getattr(self, msg_type) | ||
Brian Granger
|
r2868 | def do_one_iteration(self): | ||
Fernando Perez
|
r2949 | """Do one iteration of the kernel's evaluation loop. | ||
""" | ||||
MinRK
|
r4521 | try: | ||
ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) | ||||
except Exception: | ||||
self.log.warn("Invalid Message:", exc_info=True) | ||||
return | ||||
MinRK
|
r3269 | if msg is None: | ||
return | ||||
Brian E. Granger
|
r4237 | |||
msg_type = msg['header']['msg_type'] | ||||
Brian Granger
|
r3127 | # This assert will raise in versions of zeromq 2.0.7 and lesser. | ||
# We now require 2.0.8 or above, so we can uncomment for safety. | ||||
MinRK
|
r3269 | # print(ident,msg, file=sys.__stdout__) | ||
assert ident is not None, "Missing message part." | ||||
Fernando Perez
|
r2926 | |||
# Print some info about this message and leave a '--->' marker, so it's | ||||
# easier to trace visually the message chain when debugging. Each | ||||
# handler prints its message at the end. | ||||
Brian E. Granger
|
r4236 | self.log.debug('\n*** MESSAGE TYPE:'+str(msg_type)+'***') | ||
MinRK
|
r3970 | self.log.debug(' Content: '+str(msg['content'])+'\n --->\n ') | ||
Fernando Perez
|
r2926 | |||
# Find and call actual handler for message | ||||
Brian E. Granger
|
r4236 | handler = self.handlers.get(msg_type, None) | ||
Brian Granger
|
r2868 | if handler is None: | ||
MinRK
|
r3970 | self.log.error("UNKNOWN MESSAGE TYPE:" +str(msg)) | ||
Brian Granger
|
r2868 | else: | ||
Fernando Perez
|
r2926 | handler(ident, msg) | ||
Fernando Perez
|
r2950 | |||
# Check whether we should exit, in case the incoming message set the | ||||
# exit flag on | ||||
if self.shell.exit_now: | ||||
MinRK
|
r3970 | self.log.debug('\nExiting IPython kernel...') | ||
Fernando Perez
|
r2950 | # We do a normal, clean exit, which allows any actions registered | ||
# via atexit (such as history saving) to take place. | ||||
sys.exit(0) | ||||
epatters
|
r2778 | |||
def start(self): | ||||
""" Start the kernel main loop. | ||||
""" | ||||
MinRK
|
r3970 | poller = zmq.Poller() | ||
poller.register(self.shell_socket, zmq.POLLIN) | ||||
Fernando Perez
|
r2598 | while True: | ||
Thomas Kluyver
|
r3900 | try: | ||
MinRK
|
r3970 | # scale by extra factor of 10, because there is no | ||
# reason for this to be anything less than ~ 0.1s | ||||
# since it is a real poller and will respond | ||||
# to events immediately | ||||
MinRK
|
r4544 | |||
# double nested try/except, to properly catch KeyboardInterrupt | ||||
# due to pyzmq Issue #130 | ||||
try: | ||||
poller.poll(10*1000*self._poll_interval) | ||||
self.do_one_iteration() | ||||
except: | ||||
raise | ||||
Thomas Kluyver
|
r3900 | except KeyboardInterrupt: | ||
# Ctrl-C shouldn't crash the kernel | ||||
Thomas Kluyver
|
r3901 | io.raw_print("KeyboardInterrupt caught in kernel") | ||
Brian Granger
|
r3019 | |||
MinRK
|
r3970 | def record_ports(self, ports): | ||
Brian Granger
|
r3019 | """Record the ports that this kernel is using. | ||
The creator of the Kernel instance must call this methods if they | ||||
want the :meth:`connect_request` method to return the port numbers. | ||||
""" | ||||
MinRK
|
r3970 | self._recorded_ports = ports | ||
Brian Granger
|
r3019 | |||
epatters
|
r2778 | #--------------------------------------------------------------------------- | ||
# Kernel request handlers | ||||
#--------------------------------------------------------------------------- | ||||
Fernando Perez
|
r2598 | |||
Fernando Perez
|
r2926 | def _publish_pyin(self, code, parent): | ||
"""Publish the code request on the pyin stream.""" | ||||
MinRK
|
r3970 | pyin_msg = self.session.send(self.iopub_socket, u'pyin',{u'code':code}, parent=parent) | ||
Fernando Perez
|
r2926 | |||
Fernando Perez
|
r2598 | def execute_request(self, ident, parent): | ||
Brian Granger
|
r3035 | |||
MinRK
|
r3970 | status_msg = self.session.send(self.iopub_socket, | ||
Brian Granger
|
r3035 | u'status', | ||
{u'execution_state':u'busy'}, | ||||
parent=parent | ||||
) | ||||
Fernando Perez
|
r2598 | try: | ||
Fernando Perez
|
r2926 | content = parent[u'content'] | ||
code = content[u'code'] | ||||
silent = content[u'silent'] | ||||
Fernando Perez
|
r2598 | except: | ||
MinRK
|
r3970 | self.log.error("Got bad msg: ") | ||
self.log.error(str(Message(parent))) | ||||
Fernando Perez
|
r2598 | return | ||
epatters
|
r2722 | |||
Fernando Perez
|
r2926 | shell = self.shell # we'll need this a lot here | ||
# Replace raw_input. Note that is not sufficient to replace | ||||
# raw_input in the user namespace. | ||||
raw_input = lambda prompt='': self._raw_input(prompt, ident, parent) | ||||
__builtin__.raw_input = raw_input | ||||
# Set the parent message of the display hook and out streams. | ||||
shell.displayhook.set_parent(parent) | ||||
Brian Granger
|
r3277 | shell.display_pub.set_parent(parent) | ||
Fernando Perez
|
r2926 | sys.stdout.set_parent(parent) | ||
sys.stderr.set_parent(parent) | ||||
# Re-broadcast our input for the benefit of listening clients, and | ||||
# start computing output | ||||
if not silent: | ||||
self._publish_pyin(code, parent) | ||||
reply_content = {} | ||||
Fernando Perez
|
r2598 | try: | ||
Fernando Perez
|
r2926 | if silent: | ||
Fernando Perez
|
r3096 | # run_code uses 'exec' mode, so no displayhook will fire, and it | ||
Fernando Perez
|
r2926 | # doesn't call logging or history manipulations. Print | ||
# statements in that code will obviously still execute. | ||||
Fernando Perez
|
r3096 | shell.run_code(code) | ||
Fernando Perez
|
r2926 | else: | ||
Fernando Perez
|
r3087 | # FIXME: the shell calls the exception handler itself. | ||
Fernando Perez
|
r2967 | shell.run_cell(code) | ||
Fernando Perez
|
r2598 | except: | ||
Fernando Perez
|
r2926 | status = u'error' | ||
Fernando Perez
|
r2838 | # FIXME: this code right now isn't being used yet by default, | ||
Thomas Kluyver
|
r3752 | # because the run_cell() call above directly fires off exception | ||
Fernando Perez
|
r2838 | # reporting. This code, therefore, is only active in the scenario | ||
# where runlines itself has an unhandled exception. We need to | ||||
# uniformize this, for all exception construction to come from a | ||||
# single location in the codbase. | ||||
Fernando Perez
|
r2598 | etype, evalue, tb = sys.exc_info() | ||
Fernando Perez
|
r2838 | tb_list = traceback.format_exception(etype, evalue, tb) | ||
Fernando Perez
|
r2926 | reply_content.update(shell._showtraceback(etype, evalue, tb_list)) | ||
Fernando Perez
|
r2598 | else: | ||
Fernando Perez
|
r2926 | status = u'ok' | ||
reply_content[u'status'] = status | ||||
Fernando Perez
|
r3077 | |||
# Return the execution counter so clients can display prompts | ||||
Fernando Perez
|
r3085 | reply_content['execution_count'] = shell.execution_count -1 | ||
Fernando Perez
|
r2926 | |||
# FIXME - fish exception info out of shell, possibly left there by | ||||
# runlines. We'll need to clean up this logic later. | ||||
if shell._reply_content is not None: | ||||
reply_content.update(shell._reply_content) | ||||
MinRK
|
r3853 | # reset after use | ||
shell._reply_content = None | ||||
Fernando Perez
|
r2926 | |||
# At this point, we can tell whether the main code execution succeeded | ||||
# or not. If it did, we proceed to evaluate user_variables/expressions | ||||
if reply_content['status'] == 'ok': | ||||
reply_content[u'user_variables'] = \ | ||||
Fernando Perez
|
r3050 | shell.user_variables(content[u'user_variables']) | ||
Fernando Perez
|
r2926 | reply_content[u'user_expressions'] = \ | ||
Fernando Perez
|
r3050 | shell.user_expressions(content[u'user_expressions']) | ||
Fernando Perez
|
r2926 | else: | ||
# If there was an error, don't even try to compute variables or | ||||
# expressions | ||||
reply_content[u'user_variables'] = {} | ||||
reply_content[u'user_expressions'] = {} | ||||
Fernando Perez
|
r2987 | |||
# Payloads should be retrieved regardless of outcome, so we can both | ||||
# recover partial output (that could have been generated early in a | ||||
# block, before an error) and clear the payload system always. | ||||
reply_content[u'payload'] = shell.payload_manager.read_payload() | ||||
# Be agressive about clearing the payload because we don't want | ||||
# it to sit in memory until the next execute_request comes in. | ||||
shell.payload_manager.clear_payload() | ||||
Fernando Perez
|
r2938 | # Flush output before sending the reply. | ||
sys.stdout.flush() | ||||
sys.stderr.flush() | ||||
# FIXME: on rare occasions, the flush doesn't seem to make it to the | ||||
# clients... This seems to mitigate the problem, but we definitely need | ||||
# to better understand what's going on. | ||||
Fernando Perez
|
r2940 | if self._execute_sleep: | ||
time.sleep(self._execute_sleep) | ||||
Fernando Perez
|
r2938 | |||
MinRK
|
r3333 | # Send the reply. | ||
MinRK
|
r3970 | reply_msg = self.session.send(self.shell_socket, u'execute_reply', | ||
MinRK
|
r3333 | reply_content, parent, ident=ident) | ||
MinRK
|
r3970 | self.log.debug(str(reply_msg)) | ||
MinRK
|
r3333 | |||
Fernando Perez
|
r2598 | if reply_msg['content']['status'] == u'error': | ||
epatters
|
r2778 | self._abort_queue() | ||
MinRK
|
r3970 | status_msg = self.session.send(self.iopub_socket, | ||
Brian Granger
|
r3035 | u'status', | ||
{u'execution_state':u'idle'}, | ||||
parent=parent | ||||
) | ||||
epatters
|
r2778 | def complete_request(self, ident, parent): | ||
Fernando Perez
|
r2856 | txt, matches = self._complete(parent) | ||
matches = {'matches' : matches, | ||||
'matched_text' : txt, | ||||
epatters
|
r2778 | 'status' : 'ok'} | ||
MinRK
|
r3970 | completion_msg = self.session.send(self.shell_socket, 'complete_reply', | ||
epatters
|
r2778 | matches, parent, ident) | ||
MinRK
|
r3970 | self.log.debug(str(completion_msg)) | ||
epatters
|
r2778 | |||
def object_info_request(self, ident, parent): | ||||
Fernando Perez
|
r2931 | object_info = self.shell.object_inspect(parent['content']['oname']) | ||
Fernando Perez
|
r3051 | # Before we send this object over, we scrub it for JSON usage | ||
oinfo = json_clean(object_info) | ||||
MinRK
|
r3970 | msg = self.session.send(self.shell_socket, 'object_info_reply', | ||
Fernando Perez
|
r2948 | oinfo, parent, ident) | ||
MinRK
|
r3970 | self.log.debug(msg) | ||
epatters
|
r2795 | |||
Thomas Kluyver
|
r3817 | def history_request(self, ident, parent): | ||
Thomas Kluyver
|
r3404 | # We need to pull these out, as passing **kwargs doesn't work with | ||
# unicode keys before Python 2.6.5. | ||||
Thomas Kluyver
|
r3817 | hist_access_type = parent['content']['hist_access_type'] | ||
epatters
|
r2844 | raw = parent['content']['raw'] | ||
Thomas Kluyver
|
r3404 | output = parent['content']['output'] | ||
Thomas Kluyver
|
r3817 | if hist_access_type == 'tail': | ||
n = parent['content']['n'] | ||||
hist = self.shell.history_manager.get_tail(n, raw=raw, output=output, | ||||
include_latest=True) | ||||
elif hist_access_type == 'range': | ||||
session = parent['content']['session'] | ||||
start = parent['content']['start'] | ||||
stop = parent['content']['stop'] | ||||
hist = self.shell.history_manager.get_range(session, start, stop, | ||||
raw=raw, output=output) | ||||
elif hist_access_type == 'search': | ||||
pattern = parent['content']['pattern'] | ||||
hist = self.shell.history_manager.search(pattern, raw=raw, output=output) | ||||
else: | ||||
hist = [] | ||||
Thomas Kluyver
|
r3397 | content = {'history' : list(hist)} | ||
MinRK
|
r3970 | msg = self.session.send(self.shell_socket, 'history_reply', | ||
epatters
|
r2795 | content, parent, ident) | ||
MinRK
|
r3970 | self.log.debug(str(msg)) | ||
Brian Granger
|
r3019 | |||
def connect_request(self, ident, parent): | ||||
if self._recorded_ports is not None: | ||||
content = self._recorded_ports.copy() | ||||
else: | ||||
content = {} | ||||
MinRK
|
r3970 | msg = self.session.send(self.shell_socket, 'connect_reply', | ||
Brian Granger
|
r3019 | content, parent, ident) | ||
MinRK
|
r3970 | self.log.debug(msg) | ||
Brian Granger
|
r3019 | |||
Fernando Perez
|
r2972 | def shutdown_request(self, ident, parent): | ||
self.shell.exit_now = True | ||||
MinRK
|
r3089 | self._shutdown_message = self.session.msg(u'shutdown_reply', parent['content'], parent) | ||
Fernando Perez
|
r2972 | sys.exit(0) | ||
Brian Granger
|
r3019 | |||
epatters
|
r2778 | #--------------------------------------------------------------------------- | ||
# Protected interface | ||||
#--------------------------------------------------------------------------- | ||||
Fernando Perez
|
r2598 | |||
epatters
|
r2778 | def _abort_queue(self): | ||
while True: | ||||
MinRK
|
r4521 | try: | ||
ident,msg = self.session.recv(self.shell_socket, zmq.NOBLOCK) | ||||
except Exception: | ||||
self.log.warn("Invalid Message:", exc_info=True) | ||||
continue | ||||
MinRK
|
r3269 | if msg is None: | ||
break | ||||
epatters
|
r2778 | else: | ||
MinRK
|
r3269 | assert ident is not None, \ | ||
Fernando Perez
|
r2926 | "Unexpected missing message part." | ||
Fernando Perez
|
r3322 | |||
MinRK
|
r3970 | self.log.debug("Aborting:\n"+str(Message(msg))) | ||
Brian E. Granger
|
r4230 | msg_type = msg['header']['msg_type'] | ||
epatters
|
r2778 | reply_type = msg_type.split('_')[0] + '_reply' | ||
MinRK
|
r3970 | reply_msg = self.session.send(self.shell_socket, reply_type, | ||
MinRK
|
r3269 | {'status' : 'aborted'}, msg, ident=ident) | ||
MinRK
|
r3970 | self.log.debug(reply_msg) | ||
epatters
|
r2778 | # We need to wait a bit for requests to come in. This can probably | ||
# be set shorter for true asynchronous clients. | ||||
time.sleep(0.1) | ||||
def _raw_input(self, prompt, ident, parent): | ||||
epatters
|
r2730 | # Flush output before making the request. | ||
sys.stderr.flush() | ||||
sys.stdout.flush() | ||||
# Send the input request. | ||||
content = dict(prompt=prompt) | ||||
MinRK
|
r3970 | msg = self.session.send(self.stdin_socket, u'input_request', content, parent) | ||
epatters
|
r2730 | |||
# Await a response. | ||||
MinRK
|
r4521 | while True: | ||
try: | ||||
ident, reply = self.session.recv(self.stdin_socket, 0) | ||||
except Exception: | ||||
self.log.warn("Invalid Message:", exc_info=True) | ||||
else: | ||||
break | ||||
epatters
|
r2730 | try: | ||
value = reply['content']['value'] | ||||
except: | ||||
MinRK
|
r3970 | self.log.error("Got bad raw_input reply: ") | ||
self.log.error(str(Message(parent))) | ||||
epatters
|
r2730 | value = '' | ||
return value | ||||
epatters
|
r2778 | |||
def _complete(self, msg): | ||||
Fernando Perez
|
r2839 | c = msg['content'] | ||
try: | ||||
cpos = int(c['cursor_pos']) | ||||
except: | ||||
# If we don't get something that we can convert to an integer, at | ||||
Fernando Perez
|
r2856 | # least attempt the completion guessing the cursor is at the end of | ||
# the text, if there's any, and otherwise of the line | ||||
Fernando Perez
|
r2839 | cpos = len(c['text']) | ||
Fernando Perez
|
r2856 | if cpos==0: | ||
cpos = len(c['line']) | ||||
Fernando Perez
|
r2839 | return self.shell.complete(c['text'], c['line'], cpos) | ||
Fernando Perez
|
r2598 | |||
epatters
|
r2778 | def _object_info(self, context): | ||
symbol, leftover = self._symbol_from_context(context) | ||||
epatters
|
r2612 | if symbol is not None and not leftover: | ||
doc = getattr(symbol, '__doc__', '') | ||||
else: | ||||
doc = '' | ||||
object_info = dict(docstring = doc) | ||||
return object_info | ||||
epatters
|
r2778 | def _symbol_from_context(self, context): | ||
epatters
|
r2612 | if not context: | ||
return None, context | ||||
base_symbol_string = context[0] | ||||
Brian Granger
|
r2759 | symbol = self.shell.user_ns.get(base_symbol_string, None) | ||
epatters
|
r2612 | if symbol is None: | ||
symbol = __builtin__.__dict__.get(base_symbol_string, None) | ||||
if symbol is None: | ||||
return None, context | ||||
context = context[1:] | ||||
for i, name in enumerate(context): | ||||
new_symbol = getattr(symbol, name, None) | ||||
if new_symbol is None: | ||||
return symbol, context[i:] | ||||
else: | ||||
symbol = new_symbol | ||||
return symbol, [] | ||||
Fernando Perez
|
r2972 | def _at_shutdown(self): | ||
"""Actions taken at shutdown by the kernel, called by python's atexit. | ||||
""" | ||||
# io.rprint("Kernel at_shutdown") # dbg | ||||
if self._shutdown_message is not None: | ||||
MinRK
|
r3970 | self.session.send(self.shell_socket, self._shutdown_message) | ||
self.session.send(self.iopub_socket, self._shutdown_message) | ||||
self.log.debug(str(self._shutdown_message)) | ||||
Fernando Perez
|
r2972 | # A very short sleep to give zmq time to flush its message buffers | ||
# before Python truly shuts down. | ||||
time.sleep(0.01) | ||||
Brian Granger
|
r2868 | |||
class QtKernel(Kernel): | ||||
Brian Granger
|
r2872 | """A Kernel subclass with Qt support.""" | ||
Brian Granger
|
r2868 | |||
def start(self): | ||||
"""Start a kernel with QtPy4 event loop integration.""" | ||||
Brian Granger
|
r2872 | |||
epatters
|
r4149 | from IPython.external.qt_for_kernel import QtCore | ||
Fernando Perez
|
r2972 | from IPython.lib.guisupport import get_app_qt4, start_event_loop_qt4 | ||
Brian Granger
|
r2900 | self.app = get_app_qt4([" "]) | ||
self.app.setQuitOnLastWindowClosed(False) | ||||
Brian Granger
|
r2872 | self.timer = QtCore.QTimer() | ||
self.timer.timeout.connect(self.do_one_iteration) | ||||
Fernando Perez
|
r2940 | # Units for the timer are in milliseconds | ||
self.timer.start(1000*self._poll_interval) | ||||
Brian Granger
|
r2900 | start_event_loop_qt4(self.app) | ||
Brian Granger
|
r2872 | |||
Fernando Perez
|
r2926 | |||
Brian Granger
|
r2872 | class WxKernel(Kernel): | ||
"""A Kernel subclass with Wx support.""" | ||||
Brian Granger
|
r2868 | |||
Brian Granger
|
r2872 | def start(self): | ||
"""Start a kernel with wx event loop support.""" | ||||
import wx | ||||
Brian Granger
|
r2900 | from IPython.lib.guisupport import start_event_loop_wx | ||
Fernando Perez
|
r2972 | |||
Brian Granger
|
r2872 | doi = self.do_one_iteration | ||
Fernando Perez
|
r2949 | # Wx uses milliseconds | ||
poll_interval = int(1000*self._poll_interval) | ||||
Brian Granger
|
r2872 | |||
# We have to put the wx.Timer in a wx.Frame for it to fire properly. | ||||
# We make the Frame hidden when we create it in the main app below. | ||||
class TimerFrame(wx.Frame): | ||||
def __init__(self, func): | ||||
wx.Frame.__init__(self, None, -1) | ||||
self.timer = wx.Timer(self) | ||||
Fernando Perez
|
r2940 | # Units for the timer are in milliseconds | ||
Fernando Perez
|
r2949 | self.timer.Start(poll_interval) | ||
Brian Granger
|
r2872 | self.Bind(wx.EVT_TIMER, self.on_timer) | ||
self.func = func | ||||
Fernando Perez
|
r2949 | |||
Brian Granger
|
r2872 | def on_timer(self, event): | ||
self.func() | ||||
# We need a custom wx.App to create our Frame subclass that has the | ||||
# wx.Timer to drive the ZMQ event loop. | ||||
class IPWxApp(wx.App): | ||||
def OnInit(self): | ||||
self.frame = TimerFrame(doi) | ||||
self.frame.Show(False) | ||||
return True | ||||
# The redirect=False here makes sure that wx doesn't replace | ||||
# sys.stdout/stderr with its own classes. | ||||
self.app = IPWxApp(redirect=False) | ||||
Brian Granger
|
r2900 | start_event_loop_wx(self.app) | ||
Brian Granger
|
r2872 | |||
class TkKernel(Kernel): | ||||
"""A Kernel subclass with Tk support.""" | ||||
def start(self): | ||||
"""Start a Tk enabled event loop.""" | ||||
import Tkinter | ||||
doi = self.do_one_iteration | ||||
Fernando Perez
|
r2949 | # Tk uses milliseconds | ||
poll_interval = int(1000*self._poll_interval) | ||||
Brian Granger
|
r2872 | # For Tkinter, we create a Tk object and call its withdraw method. | ||
class Timer(object): | ||||
def __init__(self, func): | ||||
self.app = Tkinter.Tk() | ||||
self.app.withdraw() | ||||
self.func = func | ||||
Fernando Perez
|
r2949 | |||
Brian Granger
|
r2872 | def on_timer(self): | ||
self.func() | ||||
Fernando Perez
|
r2949 | self.app.after(poll_interval, self.on_timer) | ||
Brian Granger
|
r2872 | def start(self): | ||
self.on_timer() # Call it once to get things going. | ||||
self.app.mainloop() | ||||
self.timer = Timer(doi) | ||||
self.timer.start() | ||||
Brian Granger
|
r2868 | |||
Fernando Perez
|
r2949 | |||
class GTKKernel(Kernel): | ||||
"""A Kernel subclass with GTK support.""" | ||||
def start(self): | ||||
"""Start the kernel, coordinating with the GTK event loop""" | ||||
from .gui.gtkembed import GTKEmbed | ||||
gtk_kernel = GTKEmbed(self) | ||||
gtk_kernel.start() | ||||
epatters
|
r2712 | #----------------------------------------------------------------------------- | ||
MinRK
|
r3970 | # Aliases and Flags for the IPKernelApp | ||
epatters
|
r2712 | #----------------------------------------------------------------------------- | ||
MinRK
|
r3970 | flags = dict(kernel_flags) | ||
MinRK
|
r3979 | flags.update(shell_flags) | ||
MinRK
|
r3970 | |||
addflag = lambda *args: flags.update(boolean_flag(*args)) | ||||
flags['pylab'] = ( | ||||
{'IPKernelApp' : {'pylab' : 'auto'}}, | ||||
"""Pre-load matplotlib and numpy for interactive use with | ||||
the default matplotlib backend.""" | ||||
) | ||||
aliases = dict(kernel_aliases) | ||||
MinRK
|
r3979 | aliases.update(shell_aliases) | ||
MinRK
|
r3970 | |||
# it's possible we don't want short aliases for *all* of these: | ||||
aliases.update(dict( | ||||
pylab='IPKernelApp.pylab', | ||||
)) | ||||
epatters
|
r2700 | |||
MinRK
|
r3970 | #----------------------------------------------------------------------------- | ||
# The IPKernelApp class | ||||
#----------------------------------------------------------------------------- | ||||
epatters
|
r2700 | |||
MinRK
|
r3979 | class IPKernelApp(KernelApp, InteractiveShellApp): | ||
MinRK
|
r3970 | name = 'ipkernel' | ||
aliases = Dict(aliases) | ||||
flags = Dict(flags) | ||||
MinRK
|
r4015 | classes = [Kernel, ZMQInteractiveShell, ProfileDir, Session] | ||
MinRK
|
r3970 | # configurables | ||
pylab = CaselessStrEnum(['tk', 'qt', 'wx', 'gtk', 'osx', 'inline', 'auto'], | ||||
config=True, | ||||
help="""Pre-load matplotlib and numpy for interactive use, | ||||
selecting a particular matplotlib backend and loop integration. | ||||
""" | ||||
) | ||||
Jens Hedegaard Nielsen
|
r4143 | pylab_import_all = Bool(True, config=True, | ||
help="""If true, an 'import *' is done from numpy and pylab, | ||||
when using pylab""" | ||||
) | ||||
MinRK
|
r3979 | def initialize(self, argv=None): | ||
super(IPKernelApp, self).initialize(argv) | ||||
self.init_shell() | ||||
self.init_extensions() | ||||
self.init_code() | ||||
MinRK
|
r3970 | |||
def init_kernel(self): | ||||
kernel_factory = Kernel | ||||
kernel_map = { | ||||
'qt' : QtKernel, | ||||
'qt4': QtKernel, | ||||
'inline': Kernel, | ||||
'osx': TkKernel, | ||||
'wx' : WxKernel, | ||||
'tk' : TkKernel, | ||||
'gtk': GTKKernel, | ||||
} | ||||
epatters
|
r2702 | |||
MinRK
|
r3970 | if self.pylab: | ||
key = None if self.pylab == 'auto' else self.pylab | ||||
gui, backend = pylabtools.find_gui_and_backend(key) | ||||
kernel_factory = kernel_map.get(gui) | ||||
if kernel_factory is None: | ||||
raise ValueError('GUI is not supported: %r' % gui) | ||||
pylabtools.activate_matplotlib(backend) | ||||
kernel = kernel_factory(config=self.config, session=self.session, | ||||
shell_socket=self.shell_socket, | ||||
iopub_socket=self.iopub_socket, | ||||
stdin_socket=self.stdin_socket, | ||||
log=self.log | ||||
) | ||||
self.kernel = kernel | ||||
kernel.record_ports(self.ports) | ||||
epatters
|
r2641 | |||
MinRK
|
r3970 | if self.pylab: | ||
Jens Hedegaard Nielsen
|
r4143 | import_all = self.pylab_import_all | ||
pylabtools.import_pylab(kernel.shell.user_ns, backend, import_all, | ||||
MinRK
|
r3970 | shell=kernel.shell) | ||
MinRK
|
r3979 | |||
def init_shell(self): | ||||
self.shell = self.kernel.shell | ||||
epatters
|
r3828 | |||
epatters
|
r3812 | |||
MinRK
|
r3970 | #----------------------------------------------------------------------------- | ||
# Kernel main and launch functions | ||||
#----------------------------------------------------------------------------- | ||||
epatters
|
r2700 | |||
MinRK
|
r3970 | def launch_kernel(*args, **kwargs): | ||
"""Launches a localhost IPython kernel, binding to the specified ports. | ||||
epatters
|
r2778 | |||
MinRK
|
r3970 | This function simply calls entry_point.base_launch_kernel with the right first | ||
command to start an ipkernel. See base_launch_kernel for arguments. | ||||
MinRK
|
r3173 | |||
epatters
|
r2700 | Returns | ||
------- | ||||
A tuple of form: | ||||
MinRK
|
r3970 | (kernel_process, shell_port, iopub_port, stdin_port, hb_port) | ||
epatters
|
r2702 | where kernel_process is a Popen object and the ports are integers. | ||
epatters
|
r2641 | """ | ||
epatters
|
r2778 | return base_launch_kernel('from IPython.zmq.ipkernel import main; main()', | ||
MinRK
|
r3970 | *args, **kwargs) | ||
epatters
|
r2700 | |||
Fernando Perez
|
r2926 | |||
epatters
|
r2778 | def main(): | ||
MinRK
|
r3979 | """Run an IPKernel as an application""" | ||
MinRK
|
r3980 | app = IPKernelApp.instance() | ||
MinRK
|
r3970 | app.initialize() | ||
app.start() | ||||
Fernando Perez
|
r2598 | |||
Fernando Perez
|
r2926 | |||
Fernando Perez
|
r2598 | if __name__ == '__main__': | ||
epatters
|
r2667 | main() | ||