Go to file
Bruno Oliveira 4ed412eb59 unittest's unexpectedSuccess should work as non-strict xpass
Make sure tests for that behavior obtain the same return code
using either pytest or unittest to run the same file
2016-08-17 21:32:04 -03:00
.github Explain why thanks yourself in the CHANGELOG 2016-07-23 10:44:38 -03:00
_pytest unittest's unexpectedSuccess should work as non-strict xpass 2016-08-17 21:32:04 -03:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Update documentation to describe expected rootdir behaviour 2016-08-06 19:35:40 +02:00
extra Adapt get_issues.py script for GitHub (instead of Bitbucket) 2016-03-28 20:00:57 +02:00
testing unittest's unexpectedSuccess should work as non-strict xpass 2016-08-17 21:32:04 -03:00
.coveragerc Ignore vendored_packages folder for coverage purposes 2015-09-14 10:30:58 -03:00
.gitattributes Use "union" merge strategy for CHANGELOG 2015-08-10 19:27:22 -03:00
.gitignore ignore hypothesis temp folder 2016-05-31 19:05:36 +02:00
.travis.yml Use PyInstaller for freeze test env 2016-07-26 22:02:37 -03:00
AUTHORS Fix #1798 to include errors in total tests in junit xml output. 2016-08-08 13:35:49 +01:00
CHANGELOG.rst Add CHANGELOG entry for #1809 2016-08-15 19:31:00 -03:00
CONTRIBUTING.rst Add changelog to requirements for pytest-dev plugins 2016-06-30 22:25:09 +02:00
HOWTORELEASE.rst fix minor typos 2016-06-01 08:03:22 +02:00
ISSUES.txt Dummy change to test readthedocs hook 2016-01-27 08:59:26 -02:00
LICENSE Wrap lines at 79 characters 2016-02-16 19:14:55 +00:00
MANIFEST.in Add CHANGELOG.rst to MANIFEST and small format fix 2016-01-05 20:01:41 -02:00
README.rst Point doc links in README to docs.pytest.org 2016-07-26 20:25:55 -03:00
appveyor.yml Use PyInstaller for freeze test env 2016-07-26 22:02:37 -03:00
plugin-test.sh add pluginmanager.do_configure(config) as a link to 2013-10-04 11:36:45 +02:00
pytest.py revert setuptools_scm addition introduced with f22d14b105 2015-09-17 12:58:04 +02:00
requirements-docs.txt use regendoc normalization and regenerate docs 2015-06-06 23:30:49 +02:00
runtox.py make runtox.py not import external modules unless run as a script 2014-04-05 08:51:00 +02:00
setup.cfg configure a plain "devpi upload" to create sdist and universal wheel 2015-07-09 14:56:56 +02:00
setup.py Convert readthedocs link for their .org -> .io migration for hosted projects 2016-05-18 17:12:39 +01:00
tox.ini Use PyInstaller for freeze test env 2016-07-26 22:02:37 -03:00

README.rst

.. image:: http://docs.pytest.org/en/latest/_static/pytest1.png
   :target: http://docs.pytest.org
   :align: center
   :alt: pytest

------

.. image:: https://img.shields.io/pypi/v/pytest.svg
   :target: https://pypi.python.org/pypi/pytest
.. image:: https://img.shields.io/pypi/pyversions/pytest.svg
  :target: https://pypi.python.org/pypi/pytest
.. image:: https://img.shields.io/coveralls/pytest-dev/pytest/master.svg
   :target: https://coveralls.io/r/pytest-dev/pytest
.. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master
    :target: https://travis-ci.org/pytest-dev/pytest
.. image:: https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true
    :target: https://ci.appveyor.com/project/pytestbot/pytest

The ``pytest`` framework makes it easy to write small tests, yet
scales to support complex functional testing for applications and libraries.    

An example of a simple test:

.. code-block:: python

    # content of test_sample.py
    def func(x):
        return x + 1

    def test_answer():
        assert func(3) == 5


To execute it::

    $ py.test
    ======= test session starts ========
    platform linux -- Python 3.4.3, pytest-2.8.5, py-1.4.31, pluggy-0.3.1    
    collected 1 items

    test_sample.py F

    ======= FAILURES ========
    _______ test_answer ________

        def test_answer():
    >       assert func(3) == 5
    E       assert 4 == 5
    E        +  where 4 = func(3)

    test_sample.py:5: AssertionError
    ======= 1 failed in 0.12 seconds ========

Due to ``py.test``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <http://docs.pytest.org/en/latest/getting-started.html#our-first-test-run>`_ for more examples.
        

Features
--------

- Detailed info on failing `assert statements <http://docs.pytest.org/en/latest/assert.html>`_ (no need to remember ``self.assert*`` names);

- `Auto-discovery
  <http://docs.pytest.org/en/latest/goodpractices.html#python-test-discovery>`_
  of test modules and functions;

- `Modular fixtures <http://docs.pytest.org/en/latest/fixture.html>`_  for
  managing small or parametrized long-lived test resources;

- Can run `unittest <http://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
  `nose <http://docs.pytest.org/en/latest/nose.html>`_ test suites out of the box;

- Python2.6+, Python3.2+, PyPy-2.3, Jython-2.5 (untested);

- Rich plugin architecture, with over 150+ `external plugins <http://docs.pytest.org/en/latest/plugins.html#installing-external-plugins-searching>`_ and thriving community;


Documentation
-------------

For full documentation, including installation, tutorials and PDF documents, please see http://docs.pytest.org.


Bugs/Requests
-------------

Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.


Changelog
---------

Consult the `Changelog <http://docs.pytest.org/en/latest/changelog.html>`_ page for fixes and enhancements of each version.


License
-------

Copyright Holger Krekel and others, 2004-2016.

Distributed under the terms of the `MIT`_ license, pytest is free and open source software.

.. _`MIT`: https://github.com/pytest-dev/pytest/blob/master/LICENSE