Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-updates > by-pkgid > b9a6a1b9f2781444d2917afd8e4421ab > files > 747

ipython-doc-2.3.0-2.2.mga5.noarch.rpm

<!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: lib.editorhooks &mdash; 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: lib.guisupport" href="IPython.lib.guisupport.html" />
    <link rel="prev" title="Module: lib.display" href="IPython.lib.display.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.lib.guisupport.html" title="Module: lib.guisupport"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="IPython.lib.display.html" title="Module: lib.display"
             accesskey="P">previous</a> |</li>
        <li><a href="http://ipython.org">home</a>|&nbsp;</li>
        <li><a href="../../search.html">search</a>|&nbsp;</li>
       <li><a href="../../index.html">documentation </a> &raquo;</li>

          <li><a href="../index.html" accesskey="U">The IPython API</a> &raquo;</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">lib.editorhooks</span></tt></a><ul>
<li><a class="reference internal" href="#functions">11 Functions</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="IPython.lib.display.html"
                        title="previous chapter">Module: <tt class="docutils literal"><span class="pre">lib.display</span></tt></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="IPython.lib.guisupport.html"
                        title="next chapter">Module: <tt class="docutils literal"><span class="pre">lib.guisupport</span></tt></a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/api/generated/IPython.lib.editorhooks.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.lib.editorhooks">
<span id="module-lib-editorhooks"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">lib.editorhooks</span></tt><a class="headerlink" href="#module-IPython.lib.editorhooks" title="Permalink to this headline">¶</a></h1>
<p>&#8216;editor&#8217; hooks for common editors that work well with ipython</p>
<p>They should honor the line number argument, at least.</p>
<p>Contributions are <em>very</em> welcome.</p>
<div class="section" id="functions">
<h2>11 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="IPython.lib.editorhooks.install_editor">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">install_editor</tt><big>(</big><em>template</em>, <em>wait=False</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.install_editor" title="Permalink to this definition">¶</a></dt>
<dd><p>Installs the editor that is called by IPython for the %edit magic.</p>
<p>This overrides the default editor, which is generally set by your EDITOR
environment variable or is notepad (windows) or vi (linux). By supplying a
template string <cite>run_template</cite>, you can control how the editor is invoked
by IPython &#8211; (e.g. the format in which it accepts command line options)</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>template</strong> : basestring</p>
<blockquote>
<div><p>run_template acts as a template for how your editor is invoked by
the shell. It should contain &#8216;{filename}&#8217;, which will be replaced on
invokation with the file name, and &#8216;{line}&#8217;, $line by line number
(or 0) to invoke the file with.</p>
</div></blockquote>
<p><strong>wait</strong> : bool</p>
<blockquote class="last">
<div><p>If <cite>wait</cite> is true, wait until the user presses enter before returning,
to facilitate non-blocking editors that exit immediately after
the call.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.komodo">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">komodo</tt><big>(</big><em>exe=u'komodo'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.komodo" title="Permalink to this definition">¶</a></dt>
<dd><p>Activestate Komodo [Edit]</p>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.scite">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">scite</tt><big>(</big><em>exe=u'scite'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.scite" title="Permalink to this definition">¶</a></dt>
<dd><p>SciTE or Sc1</p>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.notepadplusplus">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">notepadplusplus</tt><big>(</big><em>exe=u'notepad++'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.notepadplusplus" title="Permalink to this definition">¶</a></dt>
<dd><p>Notepad++ <a class="reference external" href="http://notepad-plus.sourceforge.net">http://notepad-plus.sourceforge.net</a></p>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.jed">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">jed</tt><big>(</big><em>exe=u'jed'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.jed" title="Permalink to this definition">¶</a></dt>
<dd><p>JED, the lightweight emacsish editor</p>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.idle">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">idle</tt><big>(</big><em>exe=u'idle'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.idle" title="Permalink to this definition">¶</a></dt>
<dd><p>Idle, the editor bundled with python</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>exe</strong> : str, None</p>
<blockquote class="last">
<div><p>If none, should be pretty smart about finding the executable.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.mate">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">mate</tt><big>(</big><em>exe=u'mate'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.mate" title="Permalink to this definition">¶</a></dt>
<dd><p>TextMate, the missing editor</p>
</dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.emacs">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">emacs</tt><big>(</big><em>exe=u'emacs'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.emacs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.gnuclient">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">gnuclient</tt><big>(</big><em>exe=u'gnuclient'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.gnuclient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.crimson_editor">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">crimson_editor</tt><big>(</big><em>exe=u'cedt.exe'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.crimson_editor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="IPython.lib.editorhooks.kate">
<tt class="descclassname">IPython.lib.editorhooks.</tt><tt class="descname">kate</tt><big>(</big><em>exe=u'kate'</em><big>)</big><a class="headerlink" href="#IPython.lib.editorhooks.kate" title="Permalink to this definition">¶</a></dt>
<dd></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.lib.guisupport.html" title="Module: lib.guisupport"
             >next</a> |</li>
        <li class="right" >
          <a href="IPython.lib.display.html" title="Module: lib.display"
             >previous</a> |</li>
        <li><a href="http://ipython.org">home</a>|&nbsp;</li>
        <li><a href="../../search.html">search</a>|&nbsp;</li>
       <li><a href="../../index.html">documentation </a> &raquo;</li>

          <li><a href="../index.html" >The IPython API</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; 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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional