<!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: testing.iptest — 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: testing.iptestcontroller" href="IPython.testing.iptestcontroller.html" />
<link rel="prev" title="Module: testing.globalipapp" href="IPython.testing.globalipapp.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.testing.iptestcontroller.html" title="Module: testing.iptestcontroller"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="IPython.testing.globalipapp.html" title="Module: testing.globalipapp"
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">testing.iptest</span></tt></a><ul>
<li><a class="reference internal" href="#classes">4 Classes</a></li>
<li><a class="reference internal" href="#functions">5 Functions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="IPython.testing.globalipapp.html"
title="previous chapter">Module: <tt class="docutils literal"><span class="pre">testing.globalipapp</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="IPython.testing.iptestcontroller.html"
title="next chapter">Module: <tt class="docutils literal"><span class="pre">testing.iptestcontroller</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/generated/IPython.testing.iptest.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.testing.iptest">
<span id="module-testing-iptest"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">testing.iptest</span></tt><a class="headerlink" href="#module-IPython.testing.iptest" title="Permalink to this headline">¶</a></h1>
<p>IPython Test Suite Runner.</p>
<p>This module provides a main entry point to a user script to test IPython
itself from the command line. There are two ways of running this script:</p>
<ol class="arabic simple">
<li>With the syntax <cite>iptest all</cite>. This runs our entire test suite by
calling this script (with different arguments) recursively. This
causes modules and package to be tested in different processes, using nose
or trial where appropriate.</li>
<li>With the regular nose syntax, like <cite>iptest -vvs IPython</cite>. In this form
the script simply calls nose, but with special command line flags and
plugins loaded.</li>
</ol>
<div class="section" id="classes">
<h2>4 Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="IPython.testing.iptest.TestSection">
<em class="property">class </em><tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">TestSection</tt><big>(</big><em>name</em>, <em>includes</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.TestSection" 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>
<dl class="method">
<dt id="IPython.testing.iptest.TestSection.__init__">
<tt class="descname">__init__</tt><big>(</big><em>name</em>, <em>includes</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.TestSection.__init__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="IPython.testing.iptest.ExclusionPlugin">
<em class="property">class </em><tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">ExclusionPlugin</tt><big>(</big><em>exclude_patterns=None</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.ExclusionPlugin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">nose.plugins.base.Plugin</span></tt></p>
<p>A nose plugin to effect our exclusions of files and directories.</p>
<dl class="method">
<dt id="IPython.testing.iptest.ExclusionPlugin.__init__">
<tt class="descname">__init__</tt><big>(</big><em>exclude_patterns=None</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.ExclusionPlugin.__init__" title="Permalink to this definition">¶</a></dt>
<dd><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>exclude_patterns</strong> : sequence of strings, optional</p>
<blockquote class="last">
<div><p>Filenames containing these patterns (as raw strings, not as regular
expressions) are excluded from the tests.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="IPython.testing.iptest.ExclusionPlugin.wantDirectory">
<tt class="descname">wantDirectory</tt><big>(</big><em>directory</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.ExclusionPlugin.wantDirectory" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the given directory should be scanned for tests.</p>
</dd></dl>
<dl class="method">
<dt id="IPython.testing.iptest.ExclusionPlugin.wantFile">
<tt class="descname">wantFile</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.ExclusionPlugin.wantFile" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the given filename should be scanned for tests.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="IPython.testing.iptest.StreamCapturer">
<em class="property">class </em><tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">StreamCapturer</tt><a class="headerlink" href="#IPython.testing.iptest.StreamCapturer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="http://docs.python.org/2/library/threading.html#threading.Thread" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></a></p>
<dl class="method">
<dt id="IPython.testing.iptest.StreamCapturer.__init__">
<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.StreamCapturer.__init__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="IPython.testing.iptest.StreamCapturer.halt">
<tt class="descname">halt</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.StreamCapturer.halt" title="Permalink to this definition">¶</a></dt>
<dd><p>Safely stop the thread.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="IPython.testing.iptest.SubprocessStreamCapturePlugin">
<em class="property">class </em><tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">SubprocessStreamCapturePlugin</tt><a class="headerlink" href="#IPython.testing.iptest.SubprocessStreamCapturePlugin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">nose.plugins.base.Plugin</span></tt></p>
<dl class="method">
<dt id="IPython.testing.iptest.SubprocessStreamCapturePlugin.__init__">
<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.SubprocessStreamCapturePlugin.__init__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="functions">
<h2>5 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="IPython.testing.iptest.monkeypatch_xunit">
<tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">monkeypatch_xunit</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.monkeypatch_xunit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="IPython.testing.iptest.extract_version">
<tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">extract_version</tt><big>(</big><em>mod</em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.extract_version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="IPython.testing.iptest.test_for">
<tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">test_for</tt><big>(</big><em>item</em>, <em>min_version=None</em>, <em>callback=<function extract_version at 0xef3b5b54></em><big>)</big><a class="headerlink" href="#IPython.testing.iptest.test_for" title="Permalink to this definition">¶</a></dt>
<dd><p>Test to see if item is importable, and optionally check against a minimum
version.</p>
<p>If min_version is given, the default behavior is to check against the
<cite>__version__</cite> attribute of the item, but specifying <cite>callback</cite> allows you to
extract the value you are interested in. e.g:</p>
<div class="highlight-python"><div class="highlight"><pre>In [1]: import sys
In [2]: from IPython.testing.iptest import test_for
In [3]: test_for('sys', (2,6), callback=lambda sys: sys.version_info)
Out[3]: True
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.iptest.check_exclusions_exist">
<tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">check_exclusions_exist</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.check_exclusions_exist" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="IPython.testing.iptest.run_iptest">
<tt class="descclassname">IPython.testing.iptest.</tt><tt class="descname">run_iptest</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.testing.iptest.run_iptest" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the IPython test suite using nose.</p>
<p>This function is called when this script is <strong>not</strong> called with the form
<cite>iptest all</cite>. It simply calls nose with appropriate command line flags
and accepts all of the standard nose arguments.</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.testing.iptestcontroller.html" title="Module: testing.iptestcontroller"
>next</a> |</li>
<li class="right" >
<a href="IPython.testing.globalipapp.html" title="Module: testing.globalipapp"
>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 Sep 02, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
c044f82ec6193fba7e13c97913613b07
>
files
>
876
