Go to file
Anthony Shaw 1ec99132e6
add myself to authors
2018-03-23 15:31:57 +11:00
.github Code review suggestions 2018-02-08 08:03:14 -02:00
_pytest conditional for resetting of sys.breakpointhook for cleanup where breakpoint() not supported 2018-03-23 14:26:16 +11:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
changelog add changelog entry 2018-03-23 15:31:16 +11:00
doc/en Merge pull request #3193 from pytest-dev/ref-docs 2018-03-15 12:04:34 -03:00
extra Replace py.std with stdlib imports 2018-01-09 12:44:10 -08:00
scripts Use py36 as preferred Python 3 interpreter for CI testing 2017-08-14 20:27:28 -03:00
tasks Add --yes to towncrier to automatically remove files 2018-02-20 01:43:20 +00:00
testing add tests to validate that --pdbcls custom debugger classes will be called when breakpoint() is used 2018-03-23 15:30:05 +11:00
.coveragerc Remove code for unsupported Python versions 2017-10-10 08:54:56 +03:00
.gitattributes Use "union" merge strategy for CHANGELOG 2015-08-10 19:27:22 -03:00
.gitignore Add .pytest_cache directory to gitignore 2018-01-29 08:44:11 -02:00
.travis.yml Implement publishing to PyPI by pushing a tag 2018-02-17 10:13:25 -02:00
AUTHORS add myself to authors 2018-03-23 15:31:57 +11:00
CHANGELOG.rst Remove :py:mod: ref from changelog: fails our linting check 2018-03-12 20:57:51 -03:00
CONTRIBUTING.rst Merge pull request #2068 from flub/commitaccess 2017-12-18 18:20:49 +01:00
HOWTORELEASE.rst Implement publishing to PyPI by pushing a tag 2018-02-17 10:13:25 -02:00
LICENSE Update copyright date in LICENSE and README.rst 2017-06-13 14:58:07 +02:00
README.rst Fix README because of code triage badge 2018-02-21 20:42:09 -03:00
appveyor.yml remove eol python from the ci config 2017-10-09 16:36:41 +02:00
pyproject.toml Show "trivial" category in CHANGELOG 2017-06-23 12:33:50 -03:00
pytest.py move node base classes from main to nodes 2017-12-18 11:08:20 +01:00
setup.cfg restore setuptools_scm write_to usage 2017-04-23 16:59:08 +02:00
setup.py Revert introduction of more_itertools 2018-03-04 10:56:24 -03:00
tox.ini Remove basepython from testenv:docs so it can be built with Python 3 2018-03-06 20:41:19 -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://anaconda.org/conda-forge/pytest/badges/version.svg
    :target: https://anaconda.org/conda-forge/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

.. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
    :target: https://www.codetriage.com/pytest-dev/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 inc(x):
        return x + 1

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


To execute it::

    $ 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 ===========================


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;

- Python 2.7, Python 3.4+, PyPy 2.3, Jython 2.5 (untested);

- Rich plugin architecture, with over 315+ `external plugins <http://plugincompat.herokuapp.com>`_ 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-2017.

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