| Current File : //usr/share/doc/pytest-2.7.0/html/en/index.html |
<!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>pytest: helps you write better programs</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: '2.7.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="top" title="None" href="#" />
<link rel="up" title="Getting started basics" href="overview.html" />
<link rel="next" title="Installation and Getting Started" href="getting-started.html" />
<link rel="prev" title="Getting started basics" href="overview.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class=indexwrapper>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="getting-started.html" title="Installation and Getting Started"
accesskey="N">next</a></li>
<li class="right" >
<a href="overview.html" title="Getting started basics"
accesskey="P">previous</a> |</li>
<li><a href="contents.html">pytest-2.7.0</a> »</li>
<li><a href="overview.html" accesskey="U">Getting started basics</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="admonition note" id="features">
<p class="first admonition-title">Note</p>
<p class="last">Are you an experienced pytest user, or an open source project that needs some help getting started with pytest? <strong>April 2015</strong> is <a class="reference external" href="adopt.html">adopt pytest month</a>!</p>
</div>
<div class="section" id="pytest-helps-you-write-better-programs">
<h1>pytest: helps you write better programs<a class="headerlink" href="#pytest-helps-you-write-better-programs" title="Permalink to this headline">¶</a></h1>
<p><strong>a mature full-featured Python testing tool</strong></p>
<blockquote>
<div><ul class="simple">
<li>runs on Posix/Windows, Python 2.6-3.4, PyPy and (possibly still) Jython-2.5.1</li>
<li><strong>well tested</strong> with more than a thousand tests against itself</li>
<li><strong>strict backward compatibility policy</strong> for safe pytest upgrades</li>
<li><a class="reference internal" href="contents.html#toc"><em>comprehensive online</em></a> and <a class="reference external" href="pytest.pdf">PDF documentation</a></li>
<li>many <a class="reference internal" href="plugins.html#extplugins"><em>third party plugins</em></a> and <a class="reference internal" href="builtin.html#pytest-helpers"><em>builtin helpers</em></a>,</li>
<li>used in <a class="reference internal" href="projects.html#projects"><em>many small and large projects and organisations</em></a></li>
<li>comes with many <a class="reference internal" href="example/index.html#examples"><em>tested examples</em></a></li>
</ul>
</div></blockquote>
<p><strong>provides easy no-boilerplate testing</strong></p>
<blockquote>
<div><ul class="simple">
<li>makes it <a class="reference internal" href="getting-started.html#getstarted"><em>easy to get started</em></a>,
has many <a class="reference internal" href="usage.html#usage"><em>usage options</em></a></li>
<li><a class="reference internal" href="assert.html#assert-with-the-assert-statement"><em>Asserting with the assert statement</em></a></li>
<li>helpful <a class="reference internal" href="example/reportingdemo.html#tbreportdemo"><em>traceback and failing assertion reporting</em></a></li>
<li><a class="reference internal" href="capture.html#printdebugging"><em>print debugging</em></a> and <a class="reference internal" href="capture.html#captures"><em>the
capturing of standard output during test execution</em></a></li>
</ul>
</div></blockquote>
<p><strong>scales from simple unit to complex functional testing</strong></p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="fixture.html#fixture"><em>modular parametrizeable fixtures</em></a> (new in 2.3,
continuously improved)</li>
<li><a class="reference internal" href="parametrize.html#parametrized-test-functions"><em>parametrized test functions</em></a></li>
<li><a class="reference internal" href="mark.html#mark"><em>Marking test functions with attributes</em></a></li>
<li><a class="reference internal" href="skipping.html#skipping"><em>Skip and xfail: dealing with tests that can not succeed</em></a> (improved in 2.4)</li>
<li><a class="reference internal" href="xdist.html#xdistcpu"><em>distribute tests to multiple CPUs</em></a> through <a class="reference internal" href="xdist.html#xdist"><em>xdist plugin</em></a></li>
<li><a class="reference internal" href="xdist.html#looponfailing"><em>continuously re-run failing tests</em></a></li>
<li>flexible <a class="reference internal" href="goodpractises.html#python-test-discovery"><em>Conventions for Python test discovery</em></a></li>
</ul>
</div></blockquote>
<p><strong>integrates with other testing methods and tools</strong>:</p>
<blockquote>
<div><ul class="simple">
<li>multi-paradigm: pytest can run <tt class="docutils literal"><span class="pre">nose</span></tt>, <tt class="docutils literal"><span class="pre">unittest</span></tt> and
<tt class="docutils literal"><span class="pre">doctest</span></tt> style test suites, including running testcases made for
Django and trial</li>
<li>supports <a class="reference internal" href="goodpractises.html#goodpractises"><em>good integration practises</em></a></li>
<li>supports extended <a class="reference internal" href="xunit_setup.html#xunitsetup"><em>xUnit style setup</em></a></li>
<li>supports domain-specific <a class="reference internal" href="example/nonpython.html#non-python-tests"><em>Working with non-python tests</em></a></li>
<li>supports generating <a class="reference external" href="https://pypi.python.org/pypi/pytest-cov">test coverage reports</a></li>
<li>supports <span class="target" id="index-0"></span><a class="pep reference external" href="http://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a> compliant coding styles in tests</li>
</ul>
</div></blockquote>
<p><strong>extensive plugin and customization system</strong>:</p>
<blockquote>
<div><ul class="simple">
<li>all collection, reporting, running aspects are delegated to hook functions</li>
<li>customizations can be per-directory, per-project or per PyPI released plugin</li>
<li>it is easy to add command line options or customize existing behaviour</li>
</ul>
</div></blockquote>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="contents.html">
<img class="logo" src="_static/pytest1.png" alt="Logo"/>
</a></p><h3>About pytest</h3>
<p>
pytest is a mature full-featured Python testing tool that helps
you write better programs.
</p><h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a href="#">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>
</ul><h3>Useful Links</h3>
<ul>
<li><a href="#">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://bitbucket.org/pytest-dev/pytest/">pytest @ Bitbucket</a></li>
<li><a href="http://pytest.org/latest/plugins_index/index.html">3rd party plugins</a></li>
<li><a href="https://bitbucket.org/pytest-dev/pytest/issues?status=new&status=open">Issue Tracker</a></li>
<li><a href="http://pytest.org/latest/pytest.pdf">PDF Documentation</a>
</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="clearer"></div>
</div>
<div class="footer">
© Copyright 2014, holger krekel.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</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>
</body>
</html>