<?xml version="1.0" encoding="utf-8" ?> <!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" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" /> <title></title> <style type="text/css"> /* :Author: David Goodger (goodger@python.org) :Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $ :Copyright: This stylesheet has been placed in the public domain. Default cascading style sheet for the HTML output of Docutils. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to customize this style sheet. */ /* used to remove borders from tables and images */ .borderless, table.borderless td, table.borderless th { border: 0 } table.borderless td, table.borderless th { /* Override padding for "table.docutils td" with "! important". The right padding separates the table cells. */ padding: 0 0.5em 0 0 ! important } .first { /* Override more specific margin styles with "! important". */ margin-top: 0 ! important } .last, .with-subtitle { margin-bottom: 0 ! important } .hidden { display: none } a.toc-backref { text-decoration: none ; color: black } blockquote.epigraph { margin: 2em 5em ; } dl.docutils dd { margin-bottom: 0.5em } object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { overflow: hidden; } /* Uncomment (and remove this text!) to get bold-faced definition list terms dl.docutils dt { font-weight: bold } */ div.abstract { margin: 2em 5em } div.abstract p.topic-title { font-weight: bold ; text-align: center } div.admonition, div.attention, div.caution, div.danger, div.error, div.hint, div.important, div.note, div.tip, div.warning { margin: 2em ; border: medium outset ; padding: 1em } div.admonition p.admonition-title, div.hint p.admonition-title, div.important p.admonition-title, div.note p.admonition-title, div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif } div.attention p.admonition-title, div.caution p.admonition-title, div.danger p.admonition-title, div.error p.admonition-title, div.warning p.admonition-title, .code .error { color: red ; font-weight: bold ; font-family: sans-serif } /* Uncomment (and remove this text!) to get reduced vertical space in compound paragraphs. div.compound .compound-first, div.compound .compound-middle { margin-bottom: 0.5em } div.compound .compound-last, div.compound .compound-middle { margin-top: 0.5em } */ div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic } div.dedication p.topic-title { font-weight: bold ; font-style: normal } div.figure { margin-left: 2em ; margin-right: 2em } div.footer, div.header { clear: both; font-size: smaller } div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em } div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ; margin-left: 1.5em } div.sidebar { margin: 0 0 0.5em 1em ; border: medium outset ; padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ; clear: right } div.sidebar p.rubric { font-family: sans-serif ; font-size: medium } div.system-messages { margin: 5em } div.system-messages h1 { color: red } div.system-message { border: medium outset ; padding: 1em } div.system-message p.system-message-title { color: red ; font-weight: bold } div.topic { margin: 2em } h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { margin-top: 0.4em } h1.title { text-align: center } h2.subtitle { text-align: center } hr.docutils { width: 75% } img.align-left, .figure.align-left, object.align-left { clear: left ; float: left ; margin-right: 1em } img.align-right, .figure.align-right, object.align-right { clear: right ; float: right ; margin-left: 1em } img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto; } .align-left { text-align: left } .align-center { clear: both ; text-align: center } .align-right { text-align: right } /* reset inner alignment in figures */ div.align-right { text-align: inherit } /* div.align-center * { */ /* text-align: left } */ ol.simple, ul.simple { margin-bottom: 1em } ol.arabic { list-style: decimal } ol.loweralpha { list-style: lower-alpha } ol.upperalpha { list-style: upper-alpha } ol.lowerroman { list-style: lower-roman } ol.upperroman { list-style: upper-roman } p.attribution { text-align: right ; margin-left: 50% } p.caption { font-style: italic } p.credits { font-style: italic ; font-size: smaller } p.label { white-space: nowrap } p.rubric { font-weight: bold ; font-size: larger ; color: maroon ; text-align: center } p.sidebar-title { font-family: sans-serif ; font-weight: bold ; font-size: larger } p.sidebar-subtitle { font-family: sans-serif ; font-weight: bold } p.topic-title { font-weight: bold } pre.address { margin-bottom: 0 ; margin-top: 0 ; font: inherit } pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em } pre.code .ln { color: grey; } /* line numbers */ pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } pre.code .literal.string, code .literal.string { color: #0C5404 } pre.code .name.builtin, code .name.builtin { color: #352B84 } pre.code .deleted, code .deleted { background-color: #DEB0A1} pre.code .inserted, code .inserted { background-color: #A3D289} span.classifier { font-family: sans-serif ; font-style: oblique } span.classifier-delimiter { font-family: sans-serif ; font-weight: bold } span.interpreted { font-family: sans-serif } span.option { white-space: nowrap } span.pre { white-space: pre } span.problematic { color: red } span.section-subtitle { /* font-size relative to parent (h1..h6 element) */ font-size: 80% } table.citation { border-left: solid 1px gray; margin-left: 1px } table.docinfo { margin: 2em 4em } table.docutils { margin-top: 0.5em ; margin-bottom: 0.5em } table.footnote { border-left: solid 1px black; margin-left: 1px } table.docutils td, table.docutils th, table.docinfo td, table.docinfo th { padding-left: 0.5em ; padding-right: 0.5em ; vertical-align: top } table.docutils th.field-name, table.docinfo th.docinfo-name { font-weight: bold ; text-align: left ; white-space: nowrap ; padding-left: 0 } /* "booktabs" style (no vertical lines) */ table.docutils.booktabs { border: 0px; border-top: 2px solid; border-bottom: 2px solid; border-collapse: collapse; } table.docutils.booktabs * { border: 0px; } table.docutils.booktabs th { border-bottom: thin solid; text-align: left; } h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { font-size: 100% } ul.auto-toc { list-style-type: none } </style> </head> <body> <div class="document"> <a class="reference external image-reference" href="http://docs.pytest.org"><img alt="pytest" class="align-center" src="http://docs.pytest.org/en/latest/_static/pytest1.png" /></a> <hr class="docutils" /> <a class="reference external image-reference" href="https://pypi.python.org/pypi/pytest"><object data="https://img.shields.io/pypi/v/pytest.svg" type="image/svg+xml">https://img.shields.io/pypi/v/pytest.svg</object></a> <a class="reference external image-reference" href="https://pypi.python.org/pypi/pytest"><object data="https://img.shields.io/pypi/pyversions/pytest.svg" type="image/svg+xml">https://img.shields.io/pypi/pyversions/pytest.svg</object></a> <a class="reference external image-reference" href="https://coveralls.io/r/pytest-dev/pytest"><object data="https://img.shields.io/coveralls/pytest-dev/pytest/master.svg" type="image/svg+xml">https://img.shields.io/coveralls/pytest-dev/pytest/master.svg</object></a> <a class="reference external image-reference" href="https://travis-ci.org/pytest-dev/pytest"><img alt="https://travis-ci.org/pytest-dev/pytest.svg?branch=master" src="https://travis-ci.org/pytest-dev/pytest.svg?branch=master" /></a> <a class="reference external image-reference" href="https://ci.appveyor.com/project/pytestbot/pytest"><img alt="https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true" src="https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true" /></a> <p>The <tt class="docutils literal">pytest</tt> framework makes it easy to write small tests, yet scales to support complex functional testing for applications and libraries.</p> <p>An example of a simple test:</p> <pre class="code python literal-block"> <span class="comment single"># content of test_sample.py</span> <span class="keyword">def</span> <span class="name function">inc</span><span class="punctuation">(</span><span class="name">x</span><span class="punctuation">):</span> <span class="keyword">return</span> <span class="name">x</span> <span class="operator">+</span> <span class="literal number integer">1</span> <span class="keyword">def</span> <span class="name function">test_answer</span><span class="punctuation">():</span> <span class="keyword">assert</span> <span class="name">inc</span><span class="punctuation">(</span><span class="literal number integer">3</span><span class="punctuation">)</span> <span class="operator">==</span> <span class="literal number integer">5</span> </pre> <p>To execute it:</p> <pre class="literal-block"> $ pytest ============================= test session starts ============================= collected 1 items test_sample.py F ================================== FAILURES =================================== _________________________________ test_answer _________________________________ def test_answer(): > assert inc(3) == 5 E assert 4 == 5 E + where 4 = inc(3) test_sample.py:5: AssertionError ========================== 1 failed in 0.04 seconds =========================== </pre> <p>Due to <tt class="docutils literal">pytest</tt>'s detailed assertion introspection, only plain <tt class="docutils literal">assert</tt> statements are used. See <a class="reference external" href="http://docs.pytest.org/en/latest/getting-started.html#our-first-test-run">getting-started</a> for more examples.</p> <div class="section" id="features"> <h1>Features</h1> <ul class="simple"> <li>Detailed info on failing <a class="reference external" href="http://docs.pytest.org/en/latest/assert.html">assert statements</a> (no need to remember <tt class="docutils literal">self.assert*</tt> names);</li> <li><a class="reference external" href="http://docs.pytest.org/en/latest/goodpractices.html#python-test-discovery">Auto-discovery</a> of test modules and functions;</li> <li><a class="reference external" href="http://docs.pytest.org/en/latest/fixture.html">Modular fixtures</a> for managing small or parametrized long-lived test resources;</li> <li>Can run <a class="reference external" href="http://docs.pytest.org/en/latest/unittest.html">unittest</a> (or trial), <a class="reference external" href="http://docs.pytest.org/en/latest/nose.html">nose</a> test suites out of the box;</li> <li>Python2.6+, Python3.3+, PyPy-2.3, Jython-2.5 (untested);</li> <li>Rich plugin architecture, with over 150+ <a class="reference external" href="http://docs.pytest.org/en/latest/plugins.html#installing-external-plugins-searching">external plugins</a> and thriving community;</li> </ul> </div> <div class="section" id="documentation"> <h1>Documentation</h1> <p>For full documentation, including installation, tutorials and PDF documents, please see <a class="reference external" href="http://docs.pytest.org">http://docs.pytest.org</a>.</p> </div> <div class="section" id="bugs-requests"> <h1>Bugs/Requests</h1> <p>Please use the <a class="reference external" href="https://github.com/pytest-dev/pytest/issues">GitHub issue tracker</a> to submit bugs or request features.</p> </div> <div class="section" id="changelog"> <h1>Changelog</h1> <p>Consult the <a class="reference external" href="http://docs.pytest.org/en/latest/changelog.html">Changelog</a> page for fixes and enhancements of each version.</p> </div> <div class="section" id="license"> <h1>License</h1> <p>Copyright Holger Krekel and others, 2004-2016.</p> <p>Distributed under the terms of the <a class="reference external" href="https://github.com/pytest-dev/pytest/blob/master/LICENSE">MIT</a> license, pytest is free and open source software.</p> </div> </div> </body> </html>