<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Module: kernel.client — IPython 2.3.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" />
<link rel="up" title="The IPython API" href="../index.html" />
<link rel="next" title="Module: kernel.clientabc" href="IPython.kernel.clientabc.html" />
<link rel="prev" title="Module: kernel.channelsabc" href="IPython.kernel.channelsabc.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="IPython.kernel.clientabc.html" title="Module: kernel.clientabc"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="IPython.kernel.channelsabc.html" title="Module: kernel.channelsabc"
accesskey="P">previous</a> |</li>
<li><a href="http://ipython.org">home</a>| </li>
<li><a href="../../search.html">search</a>| </li>
<li><a href="../../index.html">documentation </a> »</li>
<li><a href="../index.html" accesskey="U">The IPython API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">kernel.client</span></tt></a><ul>
<li><a class="reference internal" href="#class">1 Class</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="IPython.kernel.channelsabc.html"
title="previous chapter">Module: <tt class="docutils literal"><span class="pre">kernel.channelsabc</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="IPython.kernel.clientabc.html"
title="next chapter">Module: <tt class="docutils literal"><span class="pre">kernel.clientabc</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/generated/IPython.kernel.client.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-IPython.kernel.client">
<span id="module-kernel-client"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">kernel.client</span></tt><a class="headerlink" href="#module-IPython.kernel.client" title="Permalink to this headline">¶</a></h1>
<p>Base class to manage the interaction with a running kernel</p>
<div class="section" id="class">
<h2>1 Class<a class="headerlink" href="#class" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="IPython.kernel.client.KernelClient">
<em class="property">class </em><tt class="descclassname">IPython.kernel.client.</tt><tt class="descname">KernelClient</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="IPython.config.configurable.html#IPython.config.configurable.LoggingConfigurable" title="IPython.config.configurable.LoggingConfigurable"><tt class="xref py py-class docutils literal"><span class="pre">IPython.config.configurable.LoggingConfigurable</span></tt></a>, <a class="reference internal" href="IPython.kernel.connect.html#IPython.kernel.connect.ConnectionFileMixin" title="IPython.kernel.connect.ConnectionFileMixin"><tt class="xref py py-class docutils literal"><span class="pre">IPython.kernel.connect.ConnectionFileMixin</span></tt></a></p>
<p>Communicates with a single kernel on any host via zmq channels.</p>
<p>There are four channels associated with each kernel:</p>
<ul class="simple">
<li>shell: for request/reply calls to the kernel.</li>
<li>iopub: for the kernel to publish results to frontends.</li>
<li>hb: for monitoring the kernel’s heartbeat.</li>
<li>stdin: for frontends to reply to raw_input calls in the kernel.</li>
</ul>
<p>The methods of the channels are exposed as methods of the client itself
(KernelClient.execute, complete, history, etc.).
See the channels themselves for documentation of these methods.</p>
<dl class="attribute">
<dt id="IPython.kernel.client.KernelClient.channels_running">
<tt class="descname">channels_running</tt><a class="headerlink" href="#IPython.kernel.client.KernelClient.channels_running" title="Permalink to this definition">¶</a></dt>
<dd><p>Are any of the channels created and running?</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.get_iopub_msg">
<tt class="descname">get_iopub_msg</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.get_iopub_msg" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a message from the iopub channel</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.get_shell_msg">
<tt class="descname">get_shell_msg</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.get_shell_msg" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a message from the shell channel</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.get_stdin_msg">
<tt class="descname">get_stdin_msg</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.get_stdin_msg" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a message from the stdin channel</p>
</dd></dl>
<dl class="attribute">
<dt id="IPython.kernel.client.KernelClient.hb_channel">
<tt class="descname">hb_channel</tt><a class="headerlink" href="#IPython.kernel.client.KernelClient.hb_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the hb channel object for this kernel.</p>
</dd></dl>
<dl class="attribute">
<dt id="IPython.kernel.client.KernelClient.iopub_channel">
<tt class="descname">iopub_channel</tt><a class="headerlink" href="#IPython.kernel.client.KernelClient.iopub_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the iopub channel object for this kernel.</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.is_alive">
<tt class="descname">is_alive</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.is_alive" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the kernel process still running?</p>
</dd></dl>
<dl class="attribute">
<dt id="IPython.kernel.client.KernelClient.shell_channel">
<tt class="descname">shell_channel</tt><a class="headerlink" href="#IPython.kernel.client.KernelClient.shell_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the shell channel object for this kernel.</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.start_channels">
<tt class="descname">start_channels</tt><big>(</big><em>shell=True</em>, <em>iopub=True</em>, <em>stdin=True</em>, <em>hb=True</em><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.start_channels" title="Permalink to this definition">¶</a></dt>
<dd><p>Starts the channels for this kernel.</p>
<p>This will create the channels if they do not exist and then start
them (their activity runs in a thread). If port numbers of 0 are
being used (random ports) then you must first call
<tt class="xref py py-meth docutils literal"><span class="pre">start_kernel()</span></tt>. If the channels have been stopped and you
call this, <tt class="xref py py-class docutils literal"><span class="pre">RuntimeError</span></tt> will be raised.</p>
</dd></dl>
<dl class="attribute">
<dt id="IPython.kernel.client.KernelClient.stdin_channel">
<tt class="descname">stdin_channel</tt><a class="headerlink" href="#IPython.kernel.client.KernelClient.stdin_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the stdin channel object for this kernel.</p>
</dd></dl>
<dl class="method">
<dt id="IPython.kernel.client.KernelClient.stop_channels">
<tt class="descname">stop_channels</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.kernel.client.KernelClient.stop_channels" title="Permalink to this definition">¶</a></dt>
<dd><p>Stops all the running channels for this kernel.</p>
<p>This stops their event loops and joins their threads.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="IPython.kernel.clientabc.html" title="Module: kernel.clientabc"
>next</a> |</li>
<li class="right" >
<a href="IPython.kernel.channelsabc.html" title="Module: kernel.channelsabc"
>previous</a> |</li>
<li><a href="http://ipython.org">home</a>| </li>
<li><a href="../../search.html">search</a>| </li>
<li><a href="../../index.html">documentation </a> »</li>
<li><a href="../index.html" >The IPython API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright The IPython Development Team.
Last updated on Sep 02, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
c044f82ec6193fba7e13c97913613b07
>
files
>
708
