<!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: core.autocall — 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: core.builtin_trap" href="IPython.core.builtin_trap.html" /> <link rel="prev" title="Module: core.application" href="IPython.core.application.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.core.builtin_trap.html" title="Module: core.builtin_trap" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.core.application.html" title="Module: core.application" 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">core.autocall</span></tt></a><ul> <li><a class="reference internal" href="#notes">Notes</a></li> <li><a class="reference internal" href="#classes">3 Classes</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.core.application.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">core.application</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.core.builtin_trap.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">core.builtin_trap</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.core.autocall.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.core.autocall"> <span id="module-core-autocall"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">core.autocall</span></tt><a class="headerlink" href="#module-IPython.core.autocall" title="Permalink to this headline">¶</a></h1> <p>Autocall capabilities for IPython.core.</p> <p>Authors:</p> <ul class="simple"> <li>Brian Granger</li> <li>Fernando Perez</li> <li>Thomas Kluyver</li> </ul> <div class="section" id="notes"> <h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2> </div> <div class="section" id="classes"> <h2>3 Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="IPython.core.autocall.IPyAutocall"> <em class="property">class </em><tt class="descclassname">IPython.core.autocall.</tt><tt class="descname">IPyAutocall</tt><big>(</big><em>ip=None</em><big>)</big><a class="headerlink" href="#IPython.core.autocall.IPyAutocall" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="http://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p> <p>Instances of this class are always autocalled</p> <p>This happens regardless of ‘autocall’ variable state. Use this to develop macro-like mechanisms.</p> <dl class="method"> <dt id="IPython.core.autocall.IPyAutocall.__init__"> <tt class="descname">__init__</tt><big>(</big><em>ip=None</em><big>)</big><a class="headerlink" href="#IPython.core.autocall.IPyAutocall.__init__" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="IPython.core.autocall.IPyAutocall.set_ip"> <tt class="descname">set_ip</tt><big>(</big><em>ip</em><big>)</big><a class="headerlink" href="#IPython.core.autocall.IPyAutocall.set_ip" title="Permalink to this definition">¶</a></dt> <dd><p>Will be used to set _ip point to current ipython instance b/f call</p> <p>Override this method if you don’t want this to happen.</p> </dd></dl> </dd></dl> <dl class="class"> <dt id="IPython.core.autocall.ExitAutocall"> <em class="property">class </em><tt class="descclassname">IPython.core.autocall.</tt><tt class="descname">ExitAutocall</tt><big>(</big><em>ip=None</em><big>)</big><a class="headerlink" href="#IPython.core.autocall.ExitAutocall" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#IPython.core.autocall.IPyAutocall" title="IPython.core.autocall.IPyAutocall"><tt class="xref py py-class docutils literal"><span class="pre">IPython.core.autocall.IPyAutocall</span></tt></a></p> <p>An autocallable object which will be added to the user namespace so that exit, exit(), quit or quit() are all valid ways to close the shell.</p> </dd></dl> <dl class="class"> <dt id="IPython.core.autocall.ZMQExitAutocall"> <em class="property">class </em><tt class="descclassname">IPython.core.autocall.</tt><tt class="descname">ZMQExitAutocall</tt><big>(</big><em>ip=None</em><big>)</big><a class="headerlink" href="#IPython.core.autocall.ZMQExitAutocall" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#IPython.core.autocall.ExitAutocall" title="IPython.core.autocall.ExitAutocall"><tt class="xref py py-class docutils literal"><span class="pre">IPython.core.autocall.ExitAutocall</span></tt></a></p> <p>Exit IPython. Autocallable, so it needn’t be explicitly called.</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>keep_kernel</strong> : bool</p> <blockquote class="last"> <div><p>If True, leave the kernel alive. Otherwise, tell the kernel to exit too (default).</p> </div></blockquote> </td> </tr> </tbody> </table> </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.core.builtin_trap.html" title="Module: core.builtin_trap" >next</a> |</li> <li class="right" > <a href="IPython.core.application.html" title="Module: core.application" >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>