<!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: terminal.console.interactiveshell — 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: terminal.embed" href="IPython.terminal.embed.html" /> <link rel="prev" title="Module: terminal.console.completer" href="IPython.terminal.console.completer.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.terminal.embed.html" title="Module: terminal.embed" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.terminal.console.completer.html" title="Module: terminal.console.completer" 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">terminal.console.interactiveshell</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.terminal.console.completer.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">terminal.console.completer</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.terminal.embed.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">terminal.embed</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.terminal.console.interactiveshell.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.terminal.console.interactiveshell"> <span id="module-terminal-console-interactiveshell"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">terminal.console.interactiveshell</span></tt><a class="headerlink" href="#module-IPython.terminal.console.interactiveshell" title="Permalink to this headline">¶</a></h1> <p>terminal client to the IPython 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.terminal.console.interactiveshell.ZMQTerminalInteractiveShell"> <em class="property">class </em><tt class="descclassname">IPython.terminal.console.interactiveshell.</tt><tt class="descname">ZMQTerminalInteractiveShell</tt><big>(</big><em>config=None</em>, <em>ipython_dir=None</em>, <em>profile_dir=None</em>, <em>user_ns=None</em>, <em>user_module=None</em>, <em>custom_exceptions=(()</em>, <em>None)</em>, <em>usage=None</em>, <em>banner1=None</em>, <em>banner2=None</em>, <em>display_banner=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="IPython.terminal.interactiveshell.html#IPython.terminal.interactiveshell.TerminalInteractiveShell" title="IPython.terminal.interactiveshell.TerminalInteractiveShell"><tt class="xref py py-class docutils literal"><span class="pre">IPython.terminal.interactiveshell.TerminalInteractiveShell</span></tt></a></p> <p>A subclass of TerminalInteractiveShell that uses the 0MQ kernel</p> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.handle_iopub"> <tt class="descname">handle_iopub</tt><big>(</big><em>msg_id=''</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.handle_iopub" title="Permalink to this definition">¶</a></dt> <dd><p>Process messages on the IOPub channel</p> <p>This method consumes and processes messages on the IOPub channel, such as stdout, stderr, pyout and status.</p> <p>It only displays output that is caused by this session.</p> </dd></dl> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.handle_stdin_request"> <tt class="descname">handle_stdin_request</tt><big>(</big><em>msg_id</em>, <em>timeout=0.1</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.handle_stdin_request" title="Permalink to this definition">¶</a></dt> <dd><p>Method to capture raw_input</p> </dd></dl> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.init_completer"> <tt class="descname">init_completer</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.init_completer" title="Permalink to this definition">¶</a></dt> <dd><p>Initialize the completion machinery.</p> <p>This creates completion machinery that can be used by client code, either interactively in-process (typically triggered by the readline library), programmatically (such as in test suites) or out-of-process (typically over the network by remote frontends).</p> </dd></dl> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.interact"> <tt class="descname">interact</tt><big>(</big><em>display_banner=None</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.interact" title="Permalink to this definition">¶</a></dt> <dd><p>Closely emulate the interactive Python console.</p> </dd></dl> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.run_cell"> <tt class="descname">run_cell</tt><big>(</big><em>cell</em>, <em>store_history=True</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.run_cell" title="Permalink to this definition">¶</a></dt> <dd><p>Run a complete IPython cell.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>cell</strong> : str</p> <blockquote> <div><p>The code (including IPython code such as %magic functions) to run.</p> </div></blockquote> <p><strong>store_history</strong> : bool</p> <blockquote class="last"> <div><p>If True, the raw and translated cell will be stored in IPython’s history. For user code calling back into IPython’s machinery, this should be set to False.</p> </div></blockquote> </td> </tr> </tbody> </table> </dd></dl> <dl class="method"> <dt id="IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.wait_for_kernel"> <tt class="descname">wait_for_kernel</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#IPython.terminal.console.interactiveshell.ZMQTerminalInteractiveShell.wait_for_kernel" title="Permalink to this definition">¶</a></dt> <dd><p>method to wait for a kernel to be ready</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.terminal.embed.html" title="Module: terminal.embed" >next</a> |</li> <li class="right" > <a href="IPython.terminal.console.completer.html" title="Module: terminal.console.completer" >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 Jul 14, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>