/usr/share/doc/python-pytest-doc/html/mark.html is in python-pytest-doc 3.0.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | <!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>Marking test functions with attributes — pytest documentation</title>
<link rel="stylesheet" href="_static/flasky.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '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="shortcut icon" href="_static/pytest1favi.ico"/>
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="pytest documentation" href="contents.html" />
<link rel="next" title="Skip and xfail: dealing with tests that cannot succeed" href="skipping.html" />
<link rel="prev" title="Doctest integration for modules and test files" href="doctest.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="skipping.html" title="Skip and xfail: dealing with tests that cannot succeed"
accesskey="N">next</a></li>
<li class="right" >
<a href="doctest.html" title="Doctest integration for modules and test files"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">pytest-3.0</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="marking-test-functions-with-attributes">
<span id="mark"></span><h1>Marking test functions with attributes<a class="headerlink" href="#marking-test-functions-with-attributes" title="Permalink to this headline">¶</a></h1>
<p>By using the <code class="docutils literal"><span class="pre">pytest.mark</span></code> helper you can easily set
metadata on your test functions. There are
some builtin markers, for example:</p>
<ul class="simple">
<li><a class="reference internal" href="skipping.html#skipif"><span class="std std-ref">skipif</span></a> - skip a test function if a certain condition is met</li>
<li><a class="reference internal" href="skipping.html#xfail"><span class="std std-ref">xfail</span></a> - produce an “expected failure” outcome if a certain
condition is met</li>
<li><a class="reference internal" href="parametrize.html#parametrizemark"><span class="std std-ref">parametrize</span></a> to perform multiple calls
to the same test function.</li>
</ul>
<p>It’s easy to create custom markers or to apply markers
to whole test classes or modules. See <a class="reference internal" href="example/markers.html#mark-examples"><span class="std std-ref">Working with custom markers</span></a> for examples
which also serve as documentation.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Marks can only be applied to tests, having no effect on
<a class="reference internal" href="fixture.html#fixtures"><span class="std std-ref">fixtures</span></a>.</p>
</div>
<div class="section" id="api-reference-for-mark-related-objects">
<h2>API reference for mark related objects<a class="headerlink" href="#api-reference-for-mark-related-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="_pytest.mark.MarkGenerator">
<em class="property">class </em><code class="descname">MarkGenerator</code><a class="reference internal" href="_modules/_pytest/mark.html#MarkGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.mark.MarkGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Factory for <a class="reference internal" href="#_pytest.mark.MarkDecorator" title="_pytest.mark.MarkDecorator"><code class="xref py py-class docutils literal"><span class="pre">MarkDecorator</span></code></a> objects - exposed as
a <code class="docutils literal"><span class="pre">pytest.mark</span></code> singleton instance. Example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pytest</span>
<span class="nd">@pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">slowtest</span>
<span class="k">def</span> <span class="nf">test_function</span><span class="p">():</span>
<span class="k">pass</span>
</pre></div>
</div>
<p>will set a ‘slowtest’ <a class="reference internal" href="#_pytest.mark.MarkInfo" title="_pytest.mark.MarkInfo"><code class="xref py py-class docutils literal"><span class="pre">MarkInfo</span></code></a> object
on the <code class="docutils literal"><span class="pre">test_function</span></code> object.</p>
</dd></dl>
<dl class="class">
<dt id="_pytest.mark.MarkDecorator">
<em class="property">class </em><code class="descname">MarkDecorator</code><span class="sig-paren">(</span><em>name</em>, <em>args=None</em>, <em>kwargs=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/mark.html#MarkDecorator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.mark.MarkDecorator" title="Permalink to this definition">¶</a></dt>
<dd><p>A decorator for test functions and test classes. When applied
it will create <a class="reference internal" href="#_pytest.mark.MarkInfo" title="_pytest.mark.MarkInfo"><code class="xref py py-class docutils literal"><span class="pre">MarkInfo</span></code></a> objects which may be
<a class="reference internal" href="example/simple.html#excontrolskip"><span class="std std-ref">retrieved by hooks as item keywords</span></a>.
MarkDecorator instances are often created like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mark1</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">NAME</span> <span class="c1"># simple MarkDecorator</span>
<span class="n">mark2</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">NAME</span><span class="p">(</span><span class="n">name1</span><span class="o">=</span><span class="n">value</span><span class="p">)</span> <span class="c1"># parametrized MarkDecorator</span>
</pre></div>
</div>
<p>and can then be applied as decorators to test functions:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nd">@mark2</span>
<span class="k">def</span> <span class="nf">test_function</span><span class="p">():</span>
<span class="k">pass</span>
</pre></div>
</div>
<dl class="docutils">
<dt>When a MarkDecorator instance is called it does the following:</dt>
<dd><ol class="first last arabic simple">
<li>If called with a single class as its only positional argument and no
additional keyword arguments, it attaches itself to the class so it
gets applied automatically to all test cases found in that class.</li>
<li>If called with a single function as its only positional argument and
no additional keyword arguments, it attaches a MarkInfo object to the
function, containing all the arguments already stored internally in
the MarkDecorator.</li>
<li>When called in any other case, it performs a ‘fake construction’ call,
i.e. it returns a new MarkDecorator instance with the original
MarkDecorator’s content updated with the arguments passed to this
call.</li>
</ol>
</dd>
</dl>
<p>Note: The rules above prevent MarkDecorator objects from storing only a
single function or class reference as their positional argument with no
additional keyword or positional arguments.</p>
</dd></dl>
<dl class="class">
<dt id="_pytest.mark.MarkInfo">
<em class="property">class </em><code class="descname">MarkInfo</code><span class="sig-paren">(</span><em>name</em>, <em>args</em>, <em>kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/mark.html#MarkInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.mark.MarkInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Marking object created by <a class="reference internal" href="#_pytest.mark.MarkDecorator" title="_pytest.mark.MarkDecorator"><code class="xref py py-class docutils literal"><span class="pre">MarkDecorator</span></code></a> instances.</p>
<dl class="attribute">
<dt id="_pytest.mark.MarkInfo.name">
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.mark.MarkInfo.name" title="Permalink to this definition">¶</a></dt>
<dd><p>name of attribute</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.mark.MarkInfo.args">
<code class="descname">args</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.mark.MarkInfo.args" title="Permalink to this definition">¶</a></dt>
<dd><p>positional argument list, empty if none specified</p>
</dd></dl>
<dl class="attribute">
<dt id="_pytest.mark.MarkInfo.kwargs">
<code class="descname">kwargs</code><em class="property"> = None</em><a class="headerlink" href="#_pytest.mark.MarkInfo.kwargs" title="Permalink to this definition">¶</a></dt>
<dd><p>keyword argument dictionary, empty if nothing specified</p>
</dd></dl>
<dl class="method">
<dt id="_pytest.mark.MarkInfo.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>args</em>, <em>kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/_pytest/mark.html#MarkInfo.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#_pytest.mark.MarkInfo.add" title="Permalink to this definition">¶</a></dt>
<dd><p>add a MarkInfo with the given args and kwargs.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="contents.html">
<img class="logo" src="_static/pytest1.png" alt="Logo"/>
</a></p><h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="contents.html">Contents</a></li>
<li><a href="getting-started.html">Install</a></li>
<li><a href="example/index.html">Examples</a></li>
<li><a href="customize.html">Customize</a></li>
<li><a href="contact.html">Contact</a></li>
<li><a href="talks.html">Talks/Posts</a></li>
<li><a href="changelog.html">Changelog</a></li>
<li><a href="license.html">License</a></li>
</ul>
<hr>
<ul>
<li><a class="reference internal" href="#">Marking test functions with attributes</a><ul>
<li><a class="reference internal" href="#api-reference-for-mark-related-objects">API reference for mark related objects</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li>Previous: <a href="doctest.html" title="previous chapter">Doctest integration for modules and test files</a></li>
<li>Next: <a href="skipping.html" title="next chapter">Skip and xfail: dealing with tests that cannot succeed</a></li>
</ul></li>
</ul><h3>Useful Links</h3>
<ul>
<li><a href="index.html">The pytest Website</a></li>
<li><a href="contributing.html">Contribution Guide</a></li>
<li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li>
<li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li>
<li><a href="http://plugincompat.herokuapp.com/">3rd party plugins</a></li>
<li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li>
<li><a href="https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf">PDF Documentation</a>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2017, holger krekel and pytest-dev team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|