Go to file
Florian Bruhin b071fdc633 Merge pull request #1960 from nicoddemus/skip-module-level-doc
Add a note about pytest.skip not being allowed at module level
2016-09-26 08:37:14 +02:00
.github Merge branch 'master' into merge-master 2016-07-25 19:06:29 -03:00
_pytest Remove implementation of `__getslice__` 2016-09-23 09:52:30 -07:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Add a summary on how to skip all tests in a module in different situations 2016-09-25 23:36:25 -03:00
extra Adapt get_issues.py script for GitHub (instead of Bitbucket) 2016-03-28 20:00:57 +02:00
testing Explain a bad scope value to the user 2016-09-21 16:40:58 -04: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 merge master to features 2016-06-01 08:13:26 +02:00
.travis.yml docs warnings as errors and initial page similar to README 2016-08-26 17:47:18 -03:00
AUTHORS Explain a bad scope value to the user 2016-09-21 16:40:58 -04:00
CHANGELOG.rst Explain a bad scope value to the user 2016-09-21 16:40:58 -04:00
CONTRIBUTING.rst Add changelog to requirements for pytest-dev plugins 2016-06-30 22:25:09 +02:00
HOWTORELEASE.rst Send only minor/major release announces to TIP mailing list 2016-09-02 12:27:06 -03:00
LICENSE Wrap lines at 79 characters 2016-02-16 19:14:55 +00:00
MANIFEST.in Changes for 3.0.1 release 2016-08-23 18:15:43 -04:00
README.rst docs warnings as errors and initial page similar to README 2016-08-26 17:47:18 -03:00
appveyor.yml Disable pypy on AppVeyor until #1963 gets fixed 2016-09-25 23:21:37 -03:00
plugin-test.sh Introduce pytest command as recommended entry point 2016-06-21 16:16:57 +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 drop python 3.0-3.2 support code from setup.py 2016-06-27 17:55:37 +02:00
tox.ini Pin hypothesis to 3.5.0 because 3.5.1 breaks the test suite 2016-09-25 18:52:27 -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::

    $ pytest
    ======= test session starts ========
    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 ``pytest``'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.3+, 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