Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
300 lines (253 sloc) 11.3 KB
""" Defines helper functions for creating kernel entry points and process
# Standard library imports.
import atexit
import os
import socket
from subprocess import Popen, PIPE
import sys
# System library imports.
import zmq
# Local imports.
from IPython.core.ultratb import FormattedTB
from IPython.external.argparse import ArgumentParser
from IPython.utils import io
from IPython.utils.localinterfaces import LOCALHOST
from displayhook import DisplayHook
from heartbeat import Heartbeat
from iostream import OutStream
from parentpoller import ParentPollerUnix, ParentPollerWindows
from session import Session
def bind_port(socket, ip, port):
""" Binds the specified ZMQ socket. If the port is zero, a random port is
chosen. Returns the port that was bound.
connection = 'tcp://%s' % ip
if port <= 0:
port = socket.bind_to_random_port(connection)
connection += ':%i' % port
return port
def make_argument_parser():
""" Creates an ArgumentParser for the generic arguments supported by all
kernel entry points.
parser = ArgumentParser()
parser.add_argument('--ip', type=str, default=LOCALHOST,
help='set the kernel\'s IP address [default: local]')
parser.add_argument('--xrep', type=int, metavar='PORT', default=0,
help='set the XREP channel port [default: random]')
parser.add_argument('--pub', type=int, metavar='PORT', default=0,
help='set the PUB channel port [default: random]')
parser.add_argument('--req', type=int, metavar='PORT', default=0,
help='set the REQ channel port [default: random]')
parser.add_argument('--hb', type=int, metavar='PORT', default=0,
help='set the heartbeat port [default: random]')
parser.add_argument('--no-stdout', action='store_true',
help='redirect stdout to the null device')
parser.add_argument('--no-stderr', action='store_true',
help='redirect stderr to the null device')
if sys.platform == 'win32':
parser.add_argument('--interrupt', type=int, metavar='HANDLE',
default=0, help='interrupt this process when '
'HANDLE is signaled')
parser.add_argument('--parent', type=int, metavar='HANDLE',
default=0, help='kill this process if the process '
'with HANDLE dies')
parser.add_argument('--parent', action='store_true',
help='kill this process if its parent dies')
return parser
def make_kernel(namespace, kernel_factory,
out_stream_factory=None, display_hook_factory=None):
""" Creates a kernel, redirects stdout/stderr, and installs a display hook
and exception handler.
# Re-direct stdout/stderr, if necessary.
if namespace.no_stdout or namespace.no_stderr:
blackhole = file(os.devnull, 'w')
if namespace.no_stdout:
sys.stdout = sys.__stdout__ = blackhole
if namespace.no_stderr:
sys.stderr = sys.__stderr__ = blackhole
# Install minimal exception handling
sys.excepthook = FormattedTB(mode='Verbose', color_scheme='NoColor',
# Create a context, a session, and the kernel sockets.
io.raw_print("Starting the kernel at pid:", os.getpid())
context = zmq.Context()
# Uncomment this to try closing the context.
# atexit.register(context.close)
session = Session(username=u'kernel')
reply_socket = context.socket(zmq.XREP)
xrep_port = bind_port(reply_socket, namespace.ip, namespace.xrep)
io.raw_print("XREP Channel on port", xrep_port)
pub_socket = context.socket(zmq.PUB)
pub_port = bind_port(pub_socket, namespace.ip,
io.raw_print("PUB Channel on port", pub_port)
req_socket = context.socket(zmq.XREQ)
req_port = bind_port(req_socket, namespace.ip, namespace.req)
io.raw_print("REQ Channel on port", req_port)
hb = Heartbeat(context, (namespace.ip, namespace.hb))
hb_port = hb.port
io.raw_print("Heartbeat REP Channel on port", hb_port)
# Helper to make it easier to connect to an existing kernel, until we have
# single-port connection negotiation fully implemented.
io.raw_print("To connect another client to this kernel, use:")
io.raw_print("-e --xreq {0} --sub {1} --rep {2} --hb {3}".format(
xrep_port, pub_port, req_port, hb_port))
# Redirect input streams and set a display hook.
if out_stream_factory:
sys.stdout = out_stream_factory(session, pub_socket, u'stdout')
sys.stderr = out_stream_factory(session, pub_socket, u'stderr')
if display_hook_factory:
sys.displayhook = display_hook_factory(session, pub_socket)
# Create the kernel.
kernel = kernel_factory(session=session, reply_socket=reply_socket,
pub_socket=pub_socket, req_socket=req_socket)
kernel.record_ports(xrep_port=xrep_port, pub_port=pub_port,
req_port=req_port, hb_port=hb_port)
return kernel
def start_kernel(namespace, kernel):
""" Starts a kernel.
# Configure this kernel process to poll the parent process, if necessary.
if sys.platform == 'win32':
if namespace.interrupt or namespace.parent:
poller = ParentPollerWindows(namespace.interrupt, namespace.parent)
elif namespace.parent:
poller = ParentPollerUnix()
# Start the kernel mainloop.
def make_default_main(kernel_factory):
""" Creates the simplest possible kernel entry point.
def main():
namespace = make_argument_parser().parse_args()
kernel = make_kernel(namespace, kernel_factory, OutStream, DisplayHook)
start_kernel(namespace, kernel)
return main
def base_launch_kernel(code, xrep_port=0, pub_port=0, req_port=0, hb_port=0,
stdin=None, stdout=None, stderr=None,
executable=None, independent=False, extra_arguments=[]):
""" Launches a localhost kernel, binding to the specified ports.
code : str,
A string of Python code that imports and executes a kernel entry point.
xrep_port : int, optional
The port to use for XREP channel.
pub_port : int, optional
The port to use for the SUB channel.
req_port : int, optional
The port to use for the REQ (raw input) channel.
hb_port : int, optional
The port to use for the hearbeat REP channel.
stdin, stdout, stderr : optional (default None)
Standards streams, as defined in subprocess.Popen.
executable : str, optional (default sys.executable)
The Python executable to use for the kernel process.
independent : bool, optional (default False)
If set, the kernel process is guaranteed to survive if this process
dies. If not set, an effort is made to ensure that the kernel is killed
when this process dies. Note that in this case it is still good practice
to kill kernels manually before exiting.
extra_arguments = list, optional
A list of extra arguments to pass when executing the launch code.
A tuple of form:
(kernel_process, xrep_port, pub_port, req_port)
where kernel_process is a Popen object and the ports are integers.
# Find open ports as necessary.
ports = []
ports_needed = int(xrep_port <= 0) + int(pub_port <= 0) + \
int(req_port <= 0) + int(hb_port <= 0)
for i in xrange(ports_needed):
sock = socket.socket()
sock.bind(('', 0))
for i, sock in enumerate(ports):
port = sock.getsockname()[1]
ports[i] = port
if xrep_port <= 0:
xrep_port = ports.pop(0)
if pub_port <= 0:
pub_port = ports.pop(0)
if req_port <= 0:
req_port = ports.pop(0)
if hb_port <= 0:
hb_port = ports.pop(0)
# Build the kernel launch command.
if executable is None:
executable = sys.executable
arguments = [ executable, '-c', code, '--xrep', str(xrep_port),
'--pub', str(pub_port), '--req', str(req_port),
'--hb', str(hb_port) ]
# Spawn a kernel.
if sys.platform == 'win32':
# Create a Win32 event for interrupting the kernel.
interrupt_event = ParentPollerWindows.create_interrupt_event()
arguments += [ '--interrupt', str(int(interrupt_event)) ]
# If this process in running on pythonw, stdin, stdout, and stderr are
# invalid. Popen will fail unless they are suitably redirected. We don't
# read from the pipes, but they must exist.
if sys.executable.endswith('pythonw.exe'):
redirect = True
_stdin = PIPE if stdin is None else stdin
_stdout = PIPE if stdout is None else stdout
_stderr = PIPE if stderr is None else stderr
redirect = False
_stdin, _stdout, _stderr = stdin, stdout, stderr
# If the kernel is running on pythonw and stdout/stderr are not been
# re-directed, it will crash when more than 4KB of data is written to
# stdout or stderr. This is a bug that has been with Python for a very
# long time; see
# A cleaner solution to this problem would be to pass os.devnull to
# Popen directly. Unfortunately, that does not work.
if executable.endswith('pythonw.exe'):
if stdout is None:
if stderr is None:
# Launch the kernel process.
if independent:
proc = Popen(arguments,
creationflags=512, # CREATE_NEW_PROCESS_GROUP
stdin=_stdin, stdout=_stdout, stderr=_stderr)
from _subprocess import DuplicateHandle, GetCurrentProcess, \
pid = GetCurrentProcess()
handle = DuplicateHandle(pid, pid, pid, 0,
True, # Inheritable by new processes.
proc = Popen(arguments + ['--parent', str(int(handle))],
stdin=_stdin, stdout=_stdout, stderr=_stderr)
# Attach the interrupt event to the Popen objet so it can be used later.
proc.win32_interrupt_event = interrupt_event
# Clean up pipes created to work around Popen bug.
if redirect:
if stdin is None:
if stdout is None:
if stderr is None:
if independent:
proc = Popen(arguments, preexec_fn=lambda: os.setsid(),
stdin=stdin, stdout=stdout, stderr=stderr)
proc = Popen(arguments + ['--parent'],
stdin=stdin, stdout=stdout, stderr=stderr)
return proc, xrep_port, pub_port, req_port, hb_port
Jump to Line
Something went wrong with that request. Please try again.