<!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>py.test reference documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.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.4.1',
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="None" href="index.html" />
<link rel="next" title="Pytest API and builtin fixtures" href="builtin.html" />
<link rel="prev" title="Some Issues and Questions" href="faq.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="builtin.html" title="Pytest API and builtin fixtures"
accesskey="N">next</a></li>
<li class="right" >
<a href="faq.html" title="Some Issues and Questions"
accesskey="P">previous</a> |</li>
<li><a href="contents.html">pytest-2.3.4.1</a> »</li>
<g:plusone></g:plusone>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Search" />
<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>
<h3>quicklinks</h3>
<div style="text-align: left; font-size: 100%; vertical-align: middle;">
<table>
<tr>
<td>
<a href="index.html">home</a>
</td><td>
<a href="contents.html">TOC/contents</a>
</td></tr><tr><td>
<a href="getting-started.html">install</a>
</td><td>
<a href="changelog.html">changelog</a>
</td></tr><tr><td>
<a href="example/index.html">examples</a>
</td><td>
<a href="customize.html">customize</a>
</td></tr><tr><td>
<a href="https://bitbucket.org/hpk42/pytest/issues?status=new&status=open">issues[bb]</a>
</td><td>
<a href="contact.html">contact</a>
</td></tr></table>
</div>
<h4>Previous topic</h4>
<p class="topless"><a href="faq.html"
title="previous chapter">Some Issues and Questions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="builtin.html"
title="next chapter">Pytest API and builtin fixtures</a></p>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="py-test-reference-documentation">
<span id="apiref"></span><h1>py.test reference documentation<a class="headerlink" href="#py-test-reference-documentation" title="Permalink to this headline">ΒΆ</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="builtin.html">Pytest API and builtin fixtures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="builtin.html#invoking-pytest-interactively">Invoking pytest interactively</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtin.html#helpers-for-assertions-about-exceptions-warnings">Helpers for assertions about Exceptions/Warnings</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtin.html#raising-a-specific-test-outcome">Raising a specific test outcome</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtin.html#fixtures-and-requests">fixtures and requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="builtin.html#builtin-fixtures-function-arguments">Builtin fixtures/function arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="customize.html">Basic test configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="customize.html#command-line-options-and-configuration-file-settings">Command line options and configuration file settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="customize.html#how-test-configuration-is-read-from-configuration-ini-files">How test configuration is read from configuration INI-files</a></li>
<li class="toctree-l2"><a class="reference internal" href="customize.html#adding-default-options">How to change command line options defaults</a></li>
<li class="toctree-l2"><a class="reference internal" href="customize.html#builtin-configuration-file-options">Builtin configuration file options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="assert.html">The writing and reporting of assertions in tests</a><ul>
<li class="toctree-l2"><a class="reference internal" href="assert.html#asserting-with-the-assert-statement">Asserting with the <tt class="docutils literal"><span class="pre">assert</span></tt> statement</a></li>
<li class="toctree-l2"><a class="reference internal" href="assert.html#assertions-about-expected-exceptions">Assertions about expected exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="assert.html#making-use-of-context-sensitive-comparisons">Making use of context-sensitive comparisons</a></li>
<li class="toctree-l2"><a class="reference internal" href="assert.html#defining-your-own-assertion-comparison">Defining your own assertion comparison</a></li>
<li class="toctree-l2"><a class="reference internal" href="assert.html#advanced-assertion-introspection">Advanced assertion introspection</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="fixture.html">pytest fixtures: explicit, modular, scalable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#fixtures-as-function-arguments-funcargs">Fixtures as Function arguments (funcargs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#funcargs-a-prime-example-of-dependency-injection">Funcargs a prime example of dependency injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#working-with-a-module-shared-fixture">Working with a module-shared fixture</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#fixtures-can-interact-with-the-requesting-test-context">Fixtures can interact with the requesting test context</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#parametrizing-a-fixture">Parametrizing a fixture</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#modularity-using-fixtures-from-a-fixture-function">Modularity: using fixtures from a fixture function</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#automatic-grouping-of-tests-by-fixture-instances">Automatic grouping of tests by fixture instances</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#using-fixtures-from-classes-modules-or-projects">using fixtures from classes, modules or projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#autouse-fixtures-xunit-setup-on-steroids">autouse fixtures (xUnit setup on steroids)</a></li>
<li class="toctree-l2"><a class="reference internal" href="fixture.html#shifting-visibility-of-fixture-functions">Shifting (visibility of) fixture functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="parametrize.html">Parametrizing fixtures and test functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="parametrize.html#pytest-mark-parametrize-parametrizing-test-functions"><tt class="docutils literal"><span class="pre">@pytest.mark.parametrize</span></tt>: parametrizing test functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="parametrize.html#basic-pytest-generate-tests-example">Basic <tt class="docutils literal"><span class="pre">pytest_generate_tests</span></tt> example</a></li>
<li class="toctree-l2"><a class="reference internal" href="parametrize.html#the-metafunc-object">The <strong>metafunc</strong> object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="xunit_setup.html">classic xunit-style setup</a><ul>
<li class="toctree-l2"><a class="reference internal" href="xunit_setup.html#module-level-setup-teardown">Module level setup/teardown</a></li>
<li class="toctree-l2"><a class="reference internal" href="xunit_setup.html#class-level-setup-teardown">Class level setup/teardown</a></li>
<li class="toctree-l2"><a class="reference internal" href="xunit_setup.html#method-and-function-level-setup-teardown">Method and function level setup/teardown</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="capture.html">Capturing of the stdout/stderr output</a><ul>
<li class="toctree-l2"><a class="reference internal" href="capture.html#default-stdout-stderr-stdin-capturing-behaviour">Default stdout/stderr/stdin capturing behaviour</a></li>
<li class="toctree-l2"><a class="reference internal" href="capture.html#setting-capturing-methods-or-disabling-capturing">Setting capturing methods or disabling capturing</a></li>
<li class="toctree-l2"><a class="reference internal" href="capture.html#using-print-statements-for-debugging">Using print statements for debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="capture.html#accessing-captured-output-from-a-test-function">Accessing captured output from a test function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="monkeypatch.html">Monkeypatching/mocking modules and environments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="monkeypatch.html#simple-example-monkeypatching-functions">Simple example: monkeypatching functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="monkeypatch.html#method-reference-of-the-monkeypatch-function-argument">Method reference of the monkeypatch function argument</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="xdist.html">xdist: pytest distributed testing plugin</a><ul>
<li class="toctree-l2"><a class="reference internal" href="xdist.html#installation-of-xdist-plugin">Installation of xdist plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="xdist.html#usage-examples">Usage examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tmpdir.html">Temporary directories and files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tmpdir.html#the-tmpdir-test-function-argument">The ‘tmpdir’ test function argument</a></li>
<li class="toctree-l2"><a class="reference internal" href="tmpdir.html#the-default-base-temporary-directory">The default base temporary directory</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mark.html">Marking test functions with attributes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mark.html#api-reference-for-mark-related-objects">API reference for mark related objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="skipping.html">Skip and xfail: dealing with tests that can not succeed</a><ul>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#marking-a-test-function-to-be-skipped">Marking a test function to be skipped</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#skip-all-test-functions-of-a-class">Skip all test functions of a class</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#mark-a-test-function-as-expected-to-fail">Mark a test function as expected to fail</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#evaluation-of-skipif-xfail-expressions">Evaluation of skipif/xfail expressions</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#imperative-xfail-from-within-a-test-or-setup-function">Imperative xfail from within a test or setup function</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#skipping-on-a-missing-import-dependency">Skipping on a missing import dependency</a></li>
<li class="toctree-l2"><a class="reference internal" href="skipping.html#imperative-skip-from-within-a-test-or-setup-function">Imperative skip from within a test or setup function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="recwarn.html">Asserting deprecation and other warnings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="recwarn.html#the-recwarn-function-argument">The recwarn function argument</a></li>
<li class="toctree-l2"><a class="reference internal" href="recwarn.html#ensuring-a-function-triggers-a-deprecation-warning">Ensuring a function triggers a deprecation warning</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="unittest.html">Support for unittest.TestCase / Integration of fixtures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="unittest.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="unittest.html#mixing-pytest-fixtures-into-unittest-testcase-style-tests">Mixing pytest fixtures into unittest.TestCase style tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="unittest.html#autouse-fixtures-and-accessing-other-fixtures">autouse fixtures and accessing other fixtures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nose.html">Running tests written for nose</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nose.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="nose.html#supported-nose-idioms">Supported nose Idioms</a></li>
<li class="toctree-l2"><a class="reference internal" href="nose.html#unsupported-idioms-known-issues">Unsupported idioms / known issues</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="doctest.html">Doctest integration for modules and test files</a></li>
</ul>
</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="builtin.html" title="Pytest API and builtin fixtures"
>next</a></li>
<li class="right" >
<a href="faq.html" title="Some Issues and Questions"
>previous</a> |</li>
<li><a href="contents.html">pytest-2.3.4.1</a> »</li>
<g:plusone></g:plusone>
</ul>
</div>
<div class="footer">
© Copyright 2012, holger krekel.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-7597274-13']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
</body>
</html>
