<!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>Full pytest 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="Getting started basics" href="overview.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="overview.html" title="Getting started basics" accesskey="N">next</a></li> <li><a href="#">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="#">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>Next topic</h4> <p class="topless"><a href="overview.html" title="next chapter">Getting started basics</a></p> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="full-pytest-documentation"> <span id="toc"></span><h1>Full pytest documentation<a class="headerlink" href="#full-pytest-documentation" title="Permalink to this headline">ΒΆ</a></h1> <p><a class="reference external" href="pytest.pdf">Download latest version as PDF</a></p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="overview.html">Getting started basics</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html">pytest: helps you write better programs</a></li> <li class="toctree-l2"><a class="reference internal" href="getting-started.html">Installation and Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="usage.html">Usage and Invocations</a></li> <li class="toctree-l2"><a class="reference internal" href="goodpractises.html">Good Integration Practises</a></li> <li class="toctree-l2"><a class="reference internal" href="projects.html">Project examples</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html">Some Issues and Questions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="apiref.html">py.test reference documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="builtin.html">Pytest API and builtin fixtures</a></li> <li class="toctree-l2"><a class="reference internal" href="customize.html">Basic test configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="assert.html">The writing and reporting of assertions in tests</a></li> <li class="toctree-l2"><a class="reference internal" href="fixture.html">pytest fixtures: explicit, modular, scalable</a></li> <li class="toctree-l2"><a class="reference internal" href="parametrize.html">Parametrizing fixtures and test functions</a></li> <li class="toctree-l2"><a class="reference internal" href="xunit_setup.html">classic xunit-style setup</a></li> <li class="toctree-l2"><a class="reference internal" href="capture.html">Capturing of the stdout/stderr output</a></li> <li class="toctree-l2"><a class="reference internal" href="monkeypatch.html">Monkeypatching/mocking modules and environments</a></li> <li class="toctree-l2"><a class="reference internal" href="xdist.html">xdist: pytest distributed testing plugin</a></li> <li class="toctree-l2"><a class="reference internal" href="tmpdir.html">Temporary directories and files</a></li> <li class="toctree-l2"><a class="reference internal" href="mark.html">Marking test functions with attributes</a></li> <li class="toctree-l2"><a class="reference internal" href="skipping.html">Skip and xfail: dealing with tests that can not succeed</a></li> <li class="toctree-l2"><a class="reference internal" href="recwarn.html">Asserting deprecation and other warnings</a></li> <li class="toctree-l2"><a class="reference internal" href="unittest.html">Support for unittest.TestCase / Integration of fixtures</a></li> <li class="toctree-l2"><a class="reference internal" href="nose.html">Running tests written for nose</a></li> <li class="toctree-l2"><a class="reference internal" href="doctest.html">Doctest integration for modules and test files</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="plugins.html">Working with plugins and conftest files</a><ul> <li class="toctree-l2"><a class="reference internal" href="plugins.html#conftest-py-local-per-directory-plugins">conftest.py: local per-directory plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#installing-external-plugins-searching">Installing External Plugins / Searching</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#writing-a-plugin-by-looking-at-examples">Writing a plugin by looking at examples</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#making-your-plugin-installable-by-others">Making your plugin installable by others</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#plugin-discovery-order-at-tool-startup">Plugin discovery order at tool startup</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file">Requiring/Loading plugins in a test module or conftest file</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#accessing-another-plugin-by-name">Accessing another plugin by name</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#finding-out-which-plugins-are-active">Finding out which plugins are active</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#deactivating-unregistering-a-plugin-by-name">Deactivating / unregistering a plugin by name</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="plugins.html#py-test-default-plugin-reference">py.test default plugin reference</a></li> <li class="toctree-l1"><a class="reference internal" href="plugins.html#py-test-hook-reference">py.test hook reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="plugins.html#hook-specification-and-validation">Hook specification and validation</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#initialization-command-line-and-configuration-hooks">Initialization, command line and configuration hooks</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#generic-runtest-hooks">Generic “runtest” hooks</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#collection-hooks">Collection hooks</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins.html#reporting-hooks">Reporting hooks</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="plugins.html#reference-of-objects-involved-in-hooks">Reference of objects involved in hooks</a></li> <li class="toctree-l1"><a class="reference internal" href="example/index.html">Usages and Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="example/reportingdemo.html">Demo of Python failure reports with py.test</a></li> <li class="toctree-l2"><a class="reference internal" href="example/simple.html">Basic patterns and examples</a></li> <li class="toctree-l2"><a class="reference internal" href="example/parametrize.html">Parametrizing tests</a></li> <li class="toctree-l2"><a class="reference internal" href="example/markers.html">Working with custom markers</a></li> <li class="toctree-l2"><a class="reference internal" href="example/special.html">A sesssion-fixture which can look at all collected tests</a></li> <li class="toctree-l2"><a class="reference internal" href="example/pythoncollection.html">Changing standard (Python) test discovery</a></li> <li class="toctree-l2"><a class="reference internal" href="example/nonpython.html">Working with non-python tests</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="talks.html">Talks and Tutorials</a><ul> <li class="toctree-l2"><a class="reference internal" href="talks.html#tutorial-examples-and-blog-postings">Tutorial examples and blog postings</a></li> <li class="toctree-l2"><a class="reference internal" href="talks.html#older-conference-talks-and-tutorials">Older conference talks and tutorials</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="develop.html">Feedback and contribute to py.test</a><ul> <li class="toctree-l2"><a class="reference internal" href="contact.html">Contact channels</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#working-from-version-control-or-a-tarball">Working from version control or a tarball</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="funcarg_compare.html">pytest-2.3: reasoning for fixture/funcarg evolution</a><ul> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#shortcomings-of-the-previous-pytest-funcarg-mechanism">Shortcomings of the previous <tt class="docutils literal"><span class="pre">pytest_funcarg__</span></tt> mechanism</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#direct-scoping-of-fixture-funcarg-factories">Direct scoping of fixture/funcarg factories</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#direct-parametrization-of-funcarg-resource-factories">Direct parametrization of funcarg resource factories</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#no-pytest-funcarg-prefix-when-using-fixture-decorator">No <tt class="docutils literal"><span class="pre">pytest_funcarg__</span></tt> prefix when using @fixture decorator</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#solving-per-session-setup-autouse-fixtures">solving per-session setup / autouse fixtures</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#funcargs-fixture-discovery-now-happens-at-collection-time">funcargs/fixture discovery now happens at collection time</a></li> <li class="toctree-l2"><a class="reference internal" href="funcarg_compare.html#conclusion-and-compatibility-notes">Conclusion and compatibility notes</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="announce/index.html">Release announcements</a><ul> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.3.4.html">pytest-2.3.4: stabilization, more flexible selection via “-k expr”</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.3.3.html">pytest-2.3.3: integration fixes, py24 suport, <tt class="docutils literal"><span class="pre">*/**</span></tt> shown in traceback</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.3.2.html">pytest-2.3.2: some fixes and more traceback-printing speed</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.3.1.html">pytest-2.3.1: fix regression with factory functions</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.3.0.html">pytest-2.3: improved fixtures / better unittest integration</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.2.4.html">pytest-2.2.4: bug fixes, better junitxml/unittest/python3 compat</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.2.2.html">pytest-2.2.2: bug fixes</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.2.1.html">pytest-2.2.1: bug fixes, perfect teardowns</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.2.0.html">py.test 2.2.0: test marking++, parametrization++ and duration profiling</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.1.3.html">py.test 2.1.3: just some more fixes</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.1.2.html">py.test 2.1.2: bug fixes and fixes for jython</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.1.1.html">py.test 2.1.1: assertion fixes and improved junitxml output</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.1.0.html">py.test 2.1.0: perfected assertions and bug fixes</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.0.3.html">py.test 2.0.3: bug fixes and speed ups</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.0.2.html">py.test 2.0.2: bug fixes, improved xfail/skip expressions, speed ups</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.0.1.html">py.test 2.0.1: bug fixes</a></li> <li class="toctree-l2"><a class="reference internal" href="announce/release-2.0.0.html">py.test 2.0.0: asserts++, unittest++, reporting++, config++, docs++</a></li> </ul> </li> </ul> </div> <div class="toctree-wrapper compound"> </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="overview.html" title="Getting started basics" >next</a></li> <li><a href="#">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>