|
|
"""An Application for launching a kernel
|
|
|
|
|
|
Authors
|
|
|
-------
|
|
|
* MinRK
|
|
|
"""
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# 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.
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Imports
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
from __future__ import print_function
|
|
|
|
|
|
# Standard library imports
|
|
|
import atexit
|
|
|
import json
|
|
|
import os
|
|
|
import sys
|
|
|
import signal
|
|
|
|
|
|
# System library imports
|
|
|
import zmq
|
|
|
from zmq.eventloop import ioloop
|
|
|
from zmq.eventloop.zmqstream import ZMQStream
|
|
|
|
|
|
# IPython imports
|
|
|
from IPython.core.ultratb import FormattedTB
|
|
|
from IPython.core.application import (
|
|
|
BaseIPythonApplication, base_flags, base_aliases, catch_config_error
|
|
|
)
|
|
|
from IPython.core.profiledir import ProfileDir
|
|
|
from IPython.core.shellapp import (
|
|
|
InteractiveShellApp, shell_flags, shell_aliases
|
|
|
)
|
|
|
from IPython.utils import io
|
|
|
from IPython.utils.localinterfaces import LOCALHOST
|
|
|
from IPython.utils.path import filefind
|
|
|
from IPython.utils.py3compat import str_to_bytes
|
|
|
from IPython.utils.traitlets import (
|
|
|
Any, Instance, Dict, Unicode, Integer, Bool, CaselessStrEnum,
|
|
|
DottedObjectName,
|
|
|
)
|
|
|
from IPython.utils.importstring import import_item
|
|
|
from IPython.kernel import write_connection_file
|
|
|
|
|
|
# local imports
|
|
|
from heartbeat import Heartbeat
|
|
|
from ipkernel import Kernel
|
|
|
from parentpoller import ParentPollerUnix, ParentPollerWindows
|
|
|
from session import (
|
|
|
Session, session_flags, session_aliases, default_secure,
|
|
|
)
|
|
|
from zmqshell import ZMQInteractiveShell
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Flags and Aliases
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
kernel_aliases = dict(base_aliases)
|
|
|
kernel_aliases.update({
|
|
|
'ip' : 'IPKernelApp.ip',
|
|
|
'hb' : 'IPKernelApp.hb_port',
|
|
|
'shell' : 'IPKernelApp.shell_port',
|
|
|
'iopub' : 'IPKernelApp.iopub_port',
|
|
|
'stdin' : 'IPKernelApp.stdin_port',
|
|
|
'control' : 'IPKernelApp.control_port',
|
|
|
'f' : 'IPKernelApp.connection_file',
|
|
|
'parent': 'IPKernelApp.parent_handle',
|
|
|
'transport': 'IPKernelApp.transport',
|
|
|
})
|
|
|
if sys.platform.startswith('win'):
|
|
|
kernel_aliases['interrupt'] = 'IPKernelApp.interrupt'
|
|
|
|
|
|
kernel_flags = dict(base_flags)
|
|
|
kernel_flags.update({
|
|
|
'no-stdout' : (
|
|
|
{'IPKernelApp' : {'no_stdout' : True}},
|
|
|
"redirect stdout to the null device"),
|
|
|
'no-stderr' : (
|
|
|
{'IPKernelApp' : {'no_stderr' : True}},
|
|
|
"redirect stderr to the null device"),
|
|
|
'pylab' : (
|
|
|
{'IPKernelApp' : {'pylab' : 'auto'}},
|
|
|
"""Pre-load matplotlib and numpy for interactive use with
|
|
|
the default matplotlib backend."""),
|
|
|
})
|
|
|
|
|
|
# inherit flags&aliases for any IPython shell apps
|
|
|
kernel_aliases.update(shell_aliases)
|
|
|
kernel_flags.update(shell_flags)
|
|
|
|
|
|
# inherit flags&aliases for Sessions
|
|
|
kernel_aliases.update(session_aliases)
|
|
|
kernel_flags.update(session_flags)
|
|
|
|
|
|
_ctrl_c_message = """\
|
|
|
NOTE: When using the `ipython kernel` entry point, Ctrl-C will not work.
|
|
|
|
|
|
To exit, you will have to explicitly quit this process, by either sending
|
|
|
"quit" from a client, or using Ctrl-\\ in UNIX-like environments.
|
|
|
|
|
|
To read more about this, see https://github.com/ipython/ipython/issues/2049
|
|
|
|
|
|
"""
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Application class for starting an IPython Kernel
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
class IPKernelApp(BaseIPythonApplication, InteractiveShellApp):
|
|
|
name='ipkernel'
|
|
|
aliases = Dict(kernel_aliases)
|
|
|
flags = Dict(kernel_flags)
|
|
|
classes = [Kernel, ZMQInteractiveShell, ProfileDir, Session]
|
|
|
# the kernel class, as an importstring
|
|
|
kernel_class = DottedObjectName('IPython.kernel.zmq.ipkernel.Kernel', config=True,
|
|
|
help="""The Kernel subclass to be used.
|
|
|
|
|
|
This should allow easy re-use of the IPKernelApp entry point
|
|
|
to configure and launch kernels other than IPython's own.
|
|
|
""")
|
|
|
kernel = Any()
|
|
|
poller = Any() # don't restrict this even though current pollers are all Threads
|
|
|
heartbeat = Instance(Heartbeat)
|
|
|
session = Instance('IPython.kernel.zmq.session.Session')
|
|
|
ports = Dict()
|
|
|
|
|
|
# ipkernel doesn't get its own config file
|
|
|
def _config_file_name_default(self):
|
|
|
return 'ipython_config.py'
|
|
|
|
|
|
# inherit config file name from parent:
|
|
|
parent_appname = Unicode(config=True)
|
|
|
def _parent_appname_changed(self, name, old, new):
|
|
|
if self.config_file_specified:
|
|
|
# it was manually specified, ignore
|
|
|
return
|
|
|
self.config_file_name = new.replace('-','_') + u'_config.py'
|
|
|
# don't let this count as specifying the config file
|
|
|
self.config_file_specified.remove(self.config_file_name)
|
|
|
|
|
|
# connection info:
|
|
|
transport = CaselessStrEnum(['tcp', 'ipc'], default_value='tcp', config=True)
|
|
|
ip = Unicode(config=True,
|
|
|
help="Set the IP or interface on which the kernel will listen.")
|
|
|
def _ip_default(self):
|
|
|
if self.transport == 'ipc':
|
|
|
if self.connection_file:
|
|
|
return os.path.splitext(self.abs_connection_file)[0] + '-ipc'
|
|
|
else:
|
|
|
return 'kernel-ipc'
|
|
|
else:
|
|
|
return LOCALHOST
|
|
|
hb_port = Integer(0, config=True, help="set the heartbeat port [default: random]")
|
|
|
shell_port = Integer(0, config=True, help="set the shell (ROUTER) port [default: random]")
|
|
|
iopub_port = Integer(0, config=True, help="set the iopub (PUB) port [default: random]")
|
|
|
stdin_port = Integer(0, config=True, help="set the stdin (ROUTER) port [default: random]")
|
|
|
control_port = Integer(0, config=True, help="set the control (ROUTER) port [default: random]")
|
|
|
connection_file = Unicode('', config=True,
|
|
|
help="""JSON file in which to store connection info [default: kernel-<pid>.json]
|
|
|
|
|
|
This file will contain the IP, ports, and authentication key needed to connect
|
|
|
clients to this kernel. By default, this file will be created in the security dir
|
|
|
of the current profile, but can be specified by absolute path.
|
|
|
""")
|
|
|
@property
|
|
|
def abs_connection_file(self):
|
|
|
if os.path.basename(self.connection_file) == self.connection_file:
|
|
|
return os.path.join(self.profile_dir.security_dir, self.connection_file)
|
|
|
else:
|
|
|
return self.connection_file
|
|
|
|
|
|
|
|
|
# streams, etc.
|
|
|
no_stdout = Bool(False, config=True, help="redirect stdout to the null device")
|
|
|
no_stderr = Bool(False, config=True, help="redirect stderr to the null device")
|
|
|
outstream_class = DottedObjectName('IPython.kernel.zmq.iostream.OutStream',
|
|
|
config=True, help="The importstring for the OutStream factory")
|
|
|
displayhook_class = DottedObjectName('IPython.kernel.zmq.displayhook.ZMQDisplayHook',
|
|
|
config=True, help="The importstring for the DisplayHook factory")
|
|
|
|
|
|
# polling
|
|
|
parent_handle = Integer(0, config=True,
|
|
|
help="""kill this process if its parent dies. On Windows, the argument
|
|
|
specifies the HANDLE of the parent process, otherwise it is simply boolean.
|
|
|
""")
|
|
|
interrupt = Integer(0, config=True,
|
|
|
help="""ONLY USED ON WINDOWS
|
|
|
Interrupt this process when the parent is signaled.
|
|
|
""")
|
|
|
|
|
|
def init_crash_handler(self):
|
|
|
# Install minimal exception handling
|
|
|
sys.excepthook = FormattedTB(mode='Verbose', color_scheme='NoColor',
|
|
|
ostream=sys.__stdout__)
|
|
|
|
|
|
def init_poller(self):
|
|
|
if sys.platform == 'win32':
|
|
|
if self.interrupt or self.parent_handle:
|
|
|
self.poller = ParentPollerWindows(self.interrupt, self.parent_handle)
|
|
|
elif self.parent_handle:
|
|
|
self.poller = ParentPollerUnix()
|
|
|
|
|
|
def _bind_socket(self, s, port):
|
|
|
iface = '%s://%s' % (self.transport, self.ip)
|
|
|
if self.transport == 'tcp':
|
|
|
if port <= 0:
|
|
|
port = s.bind_to_random_port(iface)
|
|
|
else:
|
|
|
s.bind("tcp://%s:%i" % (self.ip, port))
|
|
|
elif self.transport == 'ipc':
|
|
|
if port <= 0:
|
|
|
port = 1
|
|
|
path = "%s-%i" % (self.ip, port)
|
|
|
while os.path.exists(path):
|
|
|
port = port + 1
|
|
|
path = "%s-%i" % (self.ip, port)
|
|
|
else:
|
|
|
path = "%s-%i" % (self.ip, port)
|
|
|
s.bind("ipc://%s" % path)
|
|
|
return port
|
|
|
|
|
|
def load_connection_file(self):
|
|
|
"""load ip/port/hmac config from JSON connection file"""
|
|
|
try:
|
|
|
fname = filefind(self.connection_file, ['.', self.profile_dir.security_dir])
|
|
|
except IOError:
|
|
|
self.log.debug("Connection file not found: %s", self.connection_file)
|
|
|
# This means I own it, so I will clean it up:
|
|
|
atexit.register(self.cleanup_connection_file)
|
|
|
return
|
|
|
self.log.debug(u"Loading connection file %s", fname)
|
|
|
with open(fname) as f:
|
|
|
s = f.read()
|
|
|
cfg = json.loads(s)
|
|
|
self.transport = cfg.get('transport', self.transport)
|
|
|
if self.ip == self._ip_default() and 'ip' in cfg:
|
|
|
# not overridden by config or cl_args
|
|
|
self.ip = cfg['ip']
|
|
|
for channel in ('hb', 'shell', 'iopub', 'stdin', 'control'):
|
|
|
name = channel + '_port'
|
|
|
if getattr(self, name) == 0 and name in cfg:
|
|
|
# not overridden by config or cl_args
|
|
|
setattr(self, name, cfg[name])
|
|
|
if 'key' in cfg:
|
|
|
self.config.Session.key = str_to_bytes(cfg['key'])
|
|
|
|
|
|
def write_connection_file(self):
|
|
|
"""write connection info to JSON file"""
|
|
|
cf = self.abs_connection_file
|
|
|
self.log.debug("Writing connection file: %s", cf)
|
|
|
write_connection_file(cf, ip=self.ip, key=self.session.key, transport=self.transport,
|
|
|
shell_port=self.shell_port, stdin_port=self.stdin_port, hb_port=self.hb_port,
|
|
|
iopub_port=self.iopub_port, control_port=self.control_port)
|
|
|
|
|
|
def cleanup_connection_file(self):
|
|
|
cf = self.abs_connection_file
|
|
|
self.log.debug("Cleaning up connection file: %s", cf)
|
|
|
try:
|
|
|
os.remove(cf)
|
|
|
except (IOError, OSError):
|
|
|
pass
|
|
|
|
|
|
self.cleanup_ipc_files()
|
|
|
|
|
|
def cleanup_ipc_files(self):
|
|
|
"""cleanup ipc files if we wrote them"""
|
|
|
if self.transport != 'ipc':
|
|
|
return
|
|
|
for port in (self.shell_port, self.iopub_port, self.stdin_port, self.hb_port, self.control_port):
|
|
|
ipcfile = "%s-%i" % (self.ip, port)
|
|
|
try:
|
|
|
os.remove(ipcfile)
|
|
|
except (IOError, OSError):
|
|
|
pass
|
|
|
|
|
|
def init_connection_file(self):
|
|
|
if not self.connection_file:
|
|
|
self.connection_file = "kernel-%s.json"%os.getpid()
|
|
|
try:
|
|
|
self.load_connection_file()
|
|
|
except Exception:
|
|
|
self.log.error("Failed to load connection file: %r", self.connection_file, exc_info=True)
|
|
|
self.exit(1)
|
|
|
|
|
|
def init_sockets(self):
|
|
|
# Create a context, a session, and the kernel sockets.
|
|
|
self.log.info("Starting the kernel at pid: %i", os.getpid())
|
|
|
context = zmq.Context.instance()
|
|
|
# Uncomment this to try closing the context.
|
|
|
# atexit.register(context.term)
|
|
|
|
|
|
self.shell_socket = context.socket(zmq.ROUTER)
|
|
|
self.shell_port = self._bind_socket(self.shell_socket, self.shell_port)
|
|
|
self.log.debug("shell ROUTER Channel on port: %i" % self.shell_port)
|
|
|
|
|
|
self.iopub_socket = context.socket(zmq.PUB)
|
|
|
self.iopub_port = self._bind_socket(self.iopub_socket, self.iopub_port)
|
|
|
self.log.debug("iopub PUB Channel on port: %i" % self.iopub_port)
|
|
|
|
|
|
self.stdin_socket = context.socket(zmq.ROUTER)
|
|
|
self.stdin_port = self._bind_socket(self.stdin_socket, self.stdin_port)
|
|
|
self.log.debug("stdin ROUTER Channel on port: %i" % self.stdin_port)
|
|
|
|
|
|
self.control_socket = context.socket(zmq.ROUTER)
|
|
|
self.control_port = self._bind_socket(self.control_socket, self.control_port)
|
|
|
self.log.debug("control ROUTER Channel on port: %i" % self.control_port)
|
|
|
|
|
|
def init_heartbeat(self):
|
|
|
"""start the heart beating"""
|
|
|
# heartbeat doesn't share context, because it mustn't be blocked
|
|
|
# by the GIL, which is accessed by libzmq when freeing zero-copy messages
|
|
|
hb_ctx = zmq.Context()
|
|
|
self.heartbeat = Heartbeat(hb_ctx, (self.transport, self.ip, self.hb_port))
|
|
|
self.hb_port = self.heartbeat.port
|
|
|
self.log.debug("Heartbeat REP Channel on port: %i" % self.hb_port)
|
|
|
self.heartbeat.start()
|
|
|
|
|
|
def log_connection_info(self):
|
|
|
"""display connection info, and store ports"""
|
|
|
basename = os.path.basename(self.connection_file)
|
|
|
if basename == self.connection_file or \
|
|
|
os.path.dirname(self.connection_file) == self.profile_dir.security_dir:
|
|
|
# use shortname
|
|
|
tail = basename
|
|
|
if self.profile != 'default':
|
|
|
tail += " --profile %s" % self.profile
|
|
|
else:
|
|
|
tail = self.connection_file
|
|
|
lines = [
|
|
|
"To connect another client to this kernel, use:",
|
|
|
" --existing %s" % tail,
|
|
|
]
|
|
|
# log connection info
|
|
|
# info-level, so often not shown.
|
|
|
# frontends should use the %connect_info magic
|
|
|
# to see the connection info
|
|
|
for line in lines:
|
|
|
self.log.info(line)
|
|
|
# also raw print to the terminal if no parent_handle (`ipython kernel`)
|
|
|
if not self.parent_handle:
|
|
|
io.rprint(_ctrl_c_message)
|
|
|
for line in lines:
|
|
|
io.rprint(line)
|
|
|
|
|
|
self.ports = dict(shell=self.shell_port, iopub=self.iopub_port,
|
|
|
stdin=self.stdin_port, hb=self.hb_port,
|
|
|
control=self.control_port)
|
|
|
|
|
|
def init_session(self):
|
|
|
"""create our session object"""
|
|
|
default_secure(self.config)
|
|
|
self.session = Session(parent=self, username=u'kernel')
|
|
|
|
|
|
def init_blackhole(self):
|
|
|
"""redirects stdout/stderr to devnull if necessary"""
|
|
|
if self.no_stdout or self.no_stderr:
|
|
|
blackhole = open(os.devnull, 'w')
|
|
|
if self.no_stdout:
|
|
|
sys.stdout = sys.__stdout__ = blackhole
|
|
|
if self.no_stderr:
|
|
|
sys.stderr = sys.__stderr__ = blackhole
|
|
|
|
|
|
def init_io(self):
|
|
|
"""Redirect input streams and set a display hook."""
|
|
|
if self.outstream_class:
|
|
|
outstream_factory = import_item(str(self.outstream_class))
|
|
|
sys.stdout = outstream_factory(self.session, self.iopub_socket, u'stdout')
|
|
|
sys.stderr = outstream_factory(self.session, self.iopub_socket, u'stderr')
|
|
|
if self.displayhook_class:
|
|
|
displayhook_factory = import_item(str(self.displayhook_class))
|
|
|
sys.displayhook = displayhook_factory(self.session, self.iopub_socket)
|
|
|
|
|
|
def init_signal(self):
|
|
|
signal.signal(signal.SIGINT, signal.SIG_IGN)
|
|
|
|
|
|
def init_kernel(self):
|
|
|
"""Create the Kernel object itself"""
|
|
|
shell_stream = ZMQStream(self.shell_socket)
|
|
|
control_stream = ZMQStream(self.control_socket)
|
|
|
|
|
|
kernel_factory = import_item(str(self.kernel_class))
|
|
|
|
|
|
kernel = kernel_factory(parent=self, session=self.session,
|
|
|
shell_streams=[shell_stream, control_stream],
|
|
|
iopub_socket=self.iopub_socket,
|
|
|
stdin_socket=self.stdin_socket,
|
|
|
log=self.log,
|
|
|
profile_dir=self.profile_dir,
|
|
|
)
|
|
|
kernel.record_ports(self.ports)
|
|
|
self.kernel = kernel
|
|
|
|
|
|
def init_gui_pylab(self):
|
|
|
"""Enable GUI event loop integration, taking pylab into account."""
|
|
|
|
|
|
# Provide a wrapper for :meth:`InteractiveShellApp.init_gui_pylab`
|
|
|
# to ensure that any exception is printed straight to stderr.
|
|
|
# Normally _showtraceback associates the reply with an execution,
|
|
|
# which means frontends will never draw it, as this exception
|
|
|
# is not associated with any execute request.
|
|
|
|
|
|
shell = self.shell
|
|
|
_showtraceback = shell._showtraceback
|
|
|
try:
|
|
|
# replace pyerr-sending traceback with stderr
|
|
|
def print_tb(etype, evalue, stb):
|
|
|
print ("GUI event loop or pylab initialization failed",
|
|
|
file=io.stderr)
|
|
|
print (shell.InteractiveTB.stb2text(stb), file=io.stderr)
|
|
|
shell._showtraceback = print_tb
|
|
|
InteractiveShellApp.init_gui_pylab(self)
|
|
|
finally:
|
|
|
shell._showtraceback = _showtraceback
|
|
|
|
|
|
def init_shell(self):
|
|
|
self.shell = self.kernel.shell
|
|
|
self.shell.configurables.append(self)
|
|
|
|
|
|
@catch_config_error
|
|
|
def initialize(self, argv=None):
|
|
|
super(IPKernelApp, self).initialize(argv)
|
|
|
self.init_blackhole()
|
|
|
self.init_connection_file()
|
|
|
self.init_session()
|
|
|
self.init_poller()
|
|
|
self.init_sockets()
|
|
|
self.init_heartbeat()
|
|
|
# writing/displaying connection info must be *after* init_sockets/heartbeat
|
|
|
self.log_connection_info()
|
|
|
self.write_connection_file()
|
|
|
self.init_io()
|
|
|
self.init_signal()
|
|
|
self.init_kernel()
|
|
|
# shell init steps
|
|
|
self.init_path()
|
|
|
self.init_shell()
|
|
|
self.init_gui_pylab()
|
|
|
self.init_extensions()
|
|
|
self.init_code()
|
|
|
# flush stdout/stderr, so that anything written to these streams during
|
|
|
# initialization do not get associated with the first execution request
|
|
|
sys.stdout.flush()
|
|
|
sys.stderr.flush()
|
|
|
|
|
|
def start(self):
|
|
|
if self.poller is not None:
|
|
|
self.poller.start()
|
|
|
self.kernel.start()
|
|
|
try:
|
|
|
ioloop.IOLoop.instance().start()
|
|
|
except KeyboardInterrupt:
|
|
|
pass
|
|
|
|
|
|
|
|
|
def main():
|
|
|
"""Run an IPKernel as an application"""
|
|
|
app = IPKernelApp.instance()
|
|
|
app.initialize()
|
|
|
app.start()
|
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
main()
|
|
|
|
