<!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.decorators — 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.globalipapp" href="IPython.testing.globalipapp.html" />
<link rel="prev" title="Module: testing" href="IPython.testing.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.globalipapp.html" title="Module: testing.globalipapp"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="IPython.testing.html" title="Module: testing"
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.decorators</span></tt></a><ul>
<li><a class="reference internal" href="#authors">Authors</a></li>
<li><a class="reference internal" href="#functions">11 Functions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="IPython.testing.html"
title="previous chapter">Module: <tt class="docutils literal"><span class="pre">testing</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="IPython.testing.globalipapp.html"
title="next chapter">Module: <tt class="docutils literal"><span class="pre">testing.globalipapp</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/generated/IPython.testing.decorators.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.decorators">
<span id="module-testing-decorators"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">testing.decorators</span></tt><a class="headerlink" href="#module-IPython.testing.decorators" title="Permalink to this headline">¶</a></h1>
<p>Decorators for labeling test objects.</p>
<p>Decorators that merely return a modified version of the original function
object are straightforward. Decorators that return a new function object need
to use nose.tools.make_decorator(original_function)(decorator) in returning the
decorator, in order to preserve metadata such as function name, setup and
teardown functions and so on - see nose.tools for more information.</p>
<p>This module provides a set of useful decorators meant to be ready to use in
your own tests. See the bottom of the file for the ready-made ones, and if you
find yourself writing a new one that may be of generic use, add it here.</p>
<p>Included decorators:</p>
<p>Lightweight testing that remains unittest-compatible.</p>
<ul class="simple">
<li>An @as_unittest decorator can be used to tag any normal parameter-less
function as a unittest TestCase. Then, both nose and normal unittest will
recognize it as such. This will make it easier to migrate away from Nose if
we ever need/want to while maintaining very lightweight tests.</li>
</ul>
<p>NOTE: This file contains IPython-specific decorators. Using the machinery in
IPython.external.decorators, we import either numpy.testing.decorators if numpy is
available, OR use equivalent code in IPython.external._decorators, which
we’ve copied verbatim from numpy.</p>
<div class="section" id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Fernando Perez <<a class="reference external" href="mailto:Fernando.Perez%40berkeley.edu">Fernando<span>.</span>Perez<span>@</span>berkeley<span>.</span>edu</a>></li>
</ul>
</div>
<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.testing.decorators.as_unittest">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">as_unittest</tt><big>(</big><em>func</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.as_unittest" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator to make a simple function into a normal test via unittest.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.apply_wrapper">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">apply_wrapper</tt><big>(</big><em>wrapper</em>, <em>func</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.apply_wrapper" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply a wrapper to a function for decoration.</p>
<p>This mixes Michele Simionato’s decorator tool with nose’s make_decorator,
to apply a wrapper in a decorator so that all nose attributes, as well as
function signature and other properties, survive the decoration cleanly.
This will ensure that wrapped functions can still be well introspected via
IPython, for example.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.make_label_dec">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">make_label_dec</tt><big>(</big><em>label</em>, <em>ds=None</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.make_label_dec" title="Permalink to this definition">¶</a></dt>
<dd><p>Factory function to create a decorator that applies one or more labels.</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>label</strong> : string or sequence</p>
<blockquote>
<div><p>One or more labels that will be applied by the decorator to the functions</p>
</div></blockquote>
<p><strong>it decorates. Labels are attributes of the decorated function with their</strong></p>
<p><strong>value set to True.</strong></p>
<blockquote>
<div><p>ds : string
An optional docstring for the resulting decorator. If not given, a
default docstring is auto-generated.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A decorator.</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>A simple labeling decorator:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">slow</span> <span class="o">=</span> <span class="n">make_label_dec</span><span class="p">(</span><span class="s">'slow'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">slow</span><span class="o">.</span><span class="n">__doc__</span>
<span class="go">"Labels a test as 'slow'."</span>
</pre></div>
</div>
<p>And one that uses multiple labels and a custom docstring:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">rare</span> <span class="o">=</span> <span class="n">make_label_dec</span><span class="p">([</span><span class="s">'slow'</span><span class="p">,</span><span class="s">'hard'</span><span class="p">],</span>
<span class="gp">... </span><span class="s">"Mix labels 'slow' and 'hard' for rare tests."</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">rare</span><span class="o">.</span><span class="n">__doc__</span>
<span class="go">"Mix labels 'slow' and 'hard' for rare tests."</span>
</pre></div>
</div>
<p>Now, let’s test using this one:
>>> @rare
... def f(): pass
...
>>>
>>> f.slow
True
>>> f.hard
True</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.skipif">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">skipif</tt><big>(</big><em>skip_condition</em>, <em>msg=None</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.skipif" title="Permalink to this definition">¶</a></dt>
<dd><p>Make function raise SkipTest exception if skip_condition is true</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>skip_condition</strong> : bool or callable</p>
<blockquote>
<div><p>Flag to determine whether to skip test. If the condition is a
callable, it is used at runtime to dynamically make the decision. This
is useful for tests that may require costly imports, to delay the cost
until the test suite is actually executed.</p>
</div></blockquote>
<p><strong>msg</strong> : string</p>
<blockquote>
<div><p>Message to give on raising a SkipTest exception.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>decorator</strong> : function</p>
<blockquote class="last">
<div><p>Decorator, which, when applied to a function, causes SkipTest
to be raised when the skip_condition was True, and the function
to be called normally otherwise.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>You will see from the code that we had to further decorate the
decorator with the nose.tools.make_decorator function in order to
transmit function name, and various other metadata.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.skip">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">skip</tt><big>(</big><em>msg=None</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.skip" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator factory - mark a test function for skipping from test suite.</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>msg</strong> : string</p>
<blockquote>
<div><p>Optional message to be added.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>decorator</strong> : function</p>
<blockquote class="last">
<div><p>Decorator, which, when applied to a function, causes SkipTest
to be raised, with the optional message added.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.onlyif">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">onlyif</tt><big>(</big><em>condition</em>, <em>msg</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.onlyif" title="Permalink to this definition">¶</a></dt>
<dd><p>The reverse from skipif, see skipif for details.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.module_not_available">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">module_not_available</tt><big>(</big><em>module</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.module_not_available" title="Permalink to this definition">¶</a></dt>
<dd><p>Can module be imported? Returns true if module does NOT import.</p>
<p>This is used to make a decorator to skip tests that require module to be
available, but delay the ‘import numpy’ to test execution time.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.decorated_dummy">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">decorated_dummy</tt><big>(</big><em>dec</em>, <em>name</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.decorated_dummy" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dummy function decorated with dec, with the given name.</p>
<p class="rubric">Examples</p>
<p>import IPython.testing.decorators as dec
setup = dec.decorated_dummy(dec.skip_if_no_x11, __name__)</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.skip_file_no_x11">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">skip_file_no_x11</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.skip_file_no_x11" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.onlyif_cmds_exist">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">onlyif_cmds_exist</tt><big>(</big><em>*commands</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.onlyif_cmds_exist" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator to skip test when at least one of <cite>commands</cite> is not found.</p>
</dd></dl>
<dl class="function">
<dt id="IPython.testing.decorators.onlyif_any_cmd_exists">
<tt class="descclassname">IPython.testing.decorators.</tt><tt class="descname">onlyif_any_cmd_exists</tt><big>(</big><em>*commands</em><big>)</big><a class="headerlink" href="#IPython.testing.decorators.onlyif_any_cmd_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator to skip test unless at least one of <cite>commands</cite> is found.</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.globalipapp.html" title="Module: testing.globalipapp"
>next</a> |</li>
<li class="right" >
<a href="IPython.testing.html" title="Module: testing"
>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>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
b9a6a1b9f2781444d2917afd8e4421ab
>
files
>
873
