Sophie

Sophie

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

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: utils.wildcard &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: utils.zmqrelated" href="IPython.utils.zmqrelated.html" />
    <link rel="prev" title="Module: utils.warn" href="IPython.utils.warn.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.utils.zmqrelated.html" title="Module: utils.zmqrelated"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="IPython.utils.warn.html" title="Module: utils.warn"
             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">utils.wildcard</span></tt></a><ul>
<li><a class="reference internal" href="#authors">Authors</a></li>
<li><a class="reference internal" href="#functions">6 Functions</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="IPython.utils.warn.html"
                        title="previous chapter">Module: <tt class="docutils literal"><span class="pre">utils.warn</span></tt></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="IPython.utils.zmqrelated.html"
                        title="next chapter">Module: <tt class="docutils literal"><span class="pre">utils.zmqrelated</span></tt></a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/api/generated/IPython.utils.wildcard.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.utils.wildcard">
<span id="module-utils-wildcard"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">utils.wildcard</span></tt><a class="headerlink" href="#module-IPython.utils.wildcard" title="Permalink to this headline">¶</a></h1>
<p>Support for wildcard pattern matching in object inspection.</p>
<div class="section" id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Jörgen Stenarson &lt;<a class="reference external" href="mailto:jorgen&#46;stenarson&#37;&#52;&#48;bostream&#46;nu">jorgen<span>&#46;</span>stenarson<span>&#64;</span>bostream<span>&#46;</span>nu</a>&gt;</li>
<li>Thomas Kluyver</li>
</ul>
</div>
<div class="section" id="functions">
<h2>6 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="IPython.utils.wildcard.create_typestr2type_dicts">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">create_typestr2type_dicts</tt><big>(</big><em>dont_include_in_type2typestr=['lambda']</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.create_typestr2type_dicts" title="Permalink to this definition">¶</a></dt>
<dd><p>Return dictionaries mapping lower case typename (e.g. &#8216;tuple&#8217;) to type
objects from the types package, and vice versa.</p>
</dd></dl>

<dl class="function">
<dt id="IPython.utils.wildcard.is_type">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">is_type</tt><big>(</big><em>obj</em>, <em>typestr_or_type</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.is_type" title="Permalink to this definition">¶</a></dt>
<dd><p>is_type(obj, typestr_or_type) verifies if obj is of a certain type. It
can take strings or actual python types for the second argument, i.e.
&#8216;tuple&#8217;&lt;-&gt;TupleType. &#8216;all&#8217; matches all types.</p>
<p>TODO: Should be extended for choosing more than one type.</p>
</dd></dl>

<dl class="function">
<dt id="IPython.utils.wildcard.show_hidden">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">show_hidden</tt><big>(</big><em>str</em>, <em>show_all=False</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.show_hidden" title="Permalink to this definition">¶</a></dt>
<dd><p>Return true for strings starting with single _ if show_all is true.</p>
</dd></dl>

<dl class="function">
<dt id="IPython.utils.wildcard.dict_dir">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">dict_dir</tt><big>(</big><em>obj</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.dict_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Produce a dictionary of an object&#8217;s attributes. Builds on dir2 by
checking that a getattr() call actually succeeds.</p>
</dd></dl>

<dl class="function">
<dt id="IPython.utils.wildcard.filter_ns">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">filter_ns</tt><big>(</big><em>ns</em>, <em>name_pattern='*'</em>, <em>type_pattern='all'</em>, <em>ignore_case=True</em>, <em>show_all=True</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.filter_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>Filter a namespace dictionary by name pattern and item type.</p>
</dd></dl>

<dl class="function">
<dt id="IPython.utils.wildcard.list_namespace">
<tt class="descclassname">IPython.utils.wildcard.</tt><tt class="descname">list_namespace</tt><big>(</big><em>namespace</em>, <em>type_pattern</em>, <em>filter</em>, <em>ignore_case=False</em>, <em>show_all=False</em><big>)</big><a class="headerlink" href="#IPython.utils.wildcard.list_namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return dictionary of all objects in a namespace dictionary that match
type_pattern and filter.</p>
</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.utils.zmqrelated.html" title="Module: utils.zmqrelated"
             >next</a> |</li>
        <li class="right" >
          <a href="IPython.utils.warn.html" title="Module: utils.warn"
             >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>