<!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>gui.wx.ipshell_nonblocking — IPython 0.10.2 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: '0.10.2',
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 0.10.2 documentation" href="../../index.html" />
<link rel="up" title="The IPython API" href="../index.html" />
<link rel="next" title="gui.wx.ipython_history" href="IPython.gui.wx.ipython_history.html" />
<link rel="prev" title="genutils" href="IPython.genutils.html" />
</head>
<body>
<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.gui.wx.ipython_history.html" title="gui.wx.ipython_history"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="IPython.genutils.html" title="genutils"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">IPython 0.10.2 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">The IPython API</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="gui-wx-ipshell-nonblocking">
<h1>gui.wx.ipshell_nonblocking<a class="headerlink" href="#gui-wx-ipshell-nonblocking" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-gui-wx-ipshell-nonblocking">
<h2>Module: <tt class="xref py py-mod docutils literal"><span class="pre">gui.wx.ipshell_nonblocking</span></tt><a class="headerlink" href="#module-gui-wx-ipshell-nonblocking" title="Permalink to this headline">¶</a></h2>
<p>Inheritance diagram for <tt class="docutils literal"><span class="pre">IPython.gui.wx.ipshell_nonblocking</span></tt>:</p>
<img src="../../_images/inheritanceab5a152275.png" usemap="#inheritanceab5a152275" class="inheritance"/><map id="inheritanceab5a152275" name="inheritanceab5a152275">
</map>
<span class="target" id="module-IPython.gui.wx.ipshell_nonblocking"></span><p>Provides IPython remote instance.</p>
<p>@author: Laurent Dufrechou
laurent.dufrechou _at_ gmail.com
@license: BSD</p>
<p>All rights reserved. This program and the accompanying materials are made
available under the terms of the BSD which accompanies this distribution, and
is available at U{<a class="reference external" href="http://www.opensource.org/licenses/bsd-license.php">http://www.opensource.org/licenses/bsd-license.php</a>}</p>
</div>
<div class="section" id="nonblockingipshell">
<h2><a class="reference internal" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell" title="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell"><tt class="xref py py-class docutils literal"><span class="pre">NonBlockingIPShell</span></tt></a><a class="headerlink" href="#nonblockingipshell" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell">
<em class="property">class </em><tt class="descclassname">IPython.gui.wx.ipshell_nonblocking.</tt><tt class="descname">NonBlockingIPShell</tt><big>(</big><em>argv=</em><span class="optional">[</span><span class="optional">]</span>, <em>user_ns={}</em>, <em>user_global_ns=None</em>, <em>cin=None</em>, <em>cout=None</em>, <em>cerr=None</em>, <em>ask_exit_handler=None</em><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Create an IPython instance, running the commands in a separate,
non-blocking thread.
This allows embedding in any GUI without blockage.</p>
<dl class="docutils">
<dt>Note: The ThreadEx class supports asynchroneous function call</dt>
<dd>via raise_exc()</dd>
</dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.__init__">
<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>@param argv: Command line options for IPython
@type argv: list
@param user_ns: User namespace.
@type user_ns: dictionary
@param user_global_ns: User global namespace.
@type user_global_ns: dictionary.
@param cin: Console standard input.
@type cin: IO stream
@param cout: Console standard output.
@type cout: IO stream
@param cerr: Console standard error.
@type cerr: IO stream
@param exit_handler: Replacement for builtin exit() function
@type exit_handler: function
@param time_loop: Define the sleep time between two thread’s loop
@type int</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.complete">
<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.complete" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an auto completed line and/or posibilities for completion.</p>
<p>@param line: Given line so far.
@type line: string</p>
<p>@return: Line completed as for as possible,
and possible further completions.
@rtype: tuple</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.do_execute">
<tt class="descname">do_execute</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.do_execute" title="Permalink to this definition">¶</a></dt>
<dd><p>Tell the thread to process the ‘line’ command</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_banner">
<tt class="descname">get_banner</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_banner" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the IPython banner for useful info on IPython instance</p>
<p>@return: The banner string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_doc_text">
<tt class="descname">get_doc_text</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_doc_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the output of the processing that need to be paged (if any)</p>
<p>@return: The std output string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_help_text">
<tt class="descname">get_help_text</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_help_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the output of the processing that need to be paged via help pager(if any)</p>
<p>@return: The std output string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_indentation">
<tt class="descname">get_indentation</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_indentation" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the current indentation level
Usefull to put the caret at the good start position if we want to do autoindentation.</p>
<p>@return: The indentation level.
@rtype: int</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_prompt">
<tt class="descname">get_prompt</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_prompt" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns current prompt inside IPython instance
(Can be In [...]: ot ...:)</p>
<p>@return: The current prompt.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_prompt_count">
<tt class="descname">get_prompt_count</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_prompt_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the prompt number.
Each time a user execute a line in the IPython shell the prompt count is increased</p>
<p>@return: The prompt number
@rtype: int</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_threading">
<tt class="descname">get_threading</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.get_threading" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns threading status, is set to True, then each command sent to
the interpreter will be executed in a separated thread allowing,
for example, breaking a long running commands.
Disallowing it, permits better compatibilty with instance that is embedding
IPython instance.</p>
<p>@return: Execution method
@rtype: bool</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.history_back">
<tt class="descname">history_back</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.history_back" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides one history command back.</p>
<p>@return: The command string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.history_forward">
<tt class="descname">history_forward</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.history_forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides one history command forward.</p>
<p>@return: The command string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.init_history_index">
<tt class="descname">init_history_index</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.init_history_index" title="Permalink to this definition">¶</a></dt>
<dd><p>set history to last command entered</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.init_ipython0">
<tt class="descname">init_ipython0</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.init_ipython0" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize an ipython0 instance</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.set_threading">
<tt class="descname">set_threading</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.set_threading" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets threading state, if set to True, then each command sent to
the interpreter will be executed in a separated thread allowing,
for example, breaking a long running commands.
Disallowing it, permits better compatibilty with instance that is embedding
IPython instance.</p>
<p>@param state: Sets threading state
@type bool</p>
</dd></dl>
<dl class="method">
<dt id="IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.update_namespace">
<tt class="descname">update_namespace</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.gui.wx.ipshell_nonblocking.NonBlockingIPShell.update_namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the current dictionary to the shell namespace.</p>
<p>@param ns_dict: A dictionary of symbol-values.
@type ns_dict: dictionary</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">gui.wx.ipshell_nonblocking</a><ul>
<li><a class="reference internal" href="#module-gui-wx-ipshell-nonblocking">Module: <tt class="docutils literal"><span class="pre">gui.wx.ipshell_nonblocking</span></tt></a></li>
<li><a class="reference internal" href="#nonblockingipshell"><tt class="docutils literal"><span class="pre">NonBlockingIPShell</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="IPython.genutils.html"
title="previous chapter">genutils</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="IPython.gui.wx.ipython_history.html"
title="next chapter">gui.wx.ipython_history</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/generated/IPython.gui.wx.ipshell_nonblocking.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" size="18" />
<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="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.gui.wx.ipython_history.html" title="gui.wx.ipython_history"
>next</a> |</li>
<li class="right" >
<a href="IPython.genutils.html" title="genutils"
>previous</a> |</li>
<li><a href="../../index.html">IPython 0.10.2 documentation</a> »</li>
<li><a href="../index.html" >The IPython API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008, The IPython Development Team.
Last updated on Apr 09, 2011.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
</div>
</body>
</html>
