Go to file
Alan 7bff5866b1 bugfix in ApproxNumpy initialisation, use keywords for arguments now 2018-07-18 17:29:55 -04:00
.github Manage GH labels using the new 'labels' tool 2018-07-14 10:12:52 -03:00
bench sort out flake8 issues and unicode name usage 2018-05-23 18:12:04 +02:00
changelog Merge pull request #3684 from Vlad-Shcherbina/type_comments 2018-07-15 11:52:12 -03:00
doc/en Fix fixture.rst spelling & grammar 2018-07-17 10:53:57 -04:00
extra sort out flake8 issues and unicode name usage 2018-05-23 18:12:04 +02:00
scripts Revamp the release script: drop invoke and use tox directly 2018-07-14 11:35:37 -03:00
src bugfix in ApproxNumpy initialisation, use keywords for arguments now 2018-07-18 17:29:55 -04:00
testing Merge pull request #3670 from asottile/remove_unused_fix_lint 2018-07-10 19:08:31 -03: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 switch to src layout 2018-05-26 09:10:38 +02:00
.pre-commit-config.yaml Correct code blocks in docs 2018-07-04 15:16:34 -07:00
.travis.yml Skip deploy stage entirely unless we have a tag 2018-07-07 12:12:07 -03:00
AUTHORS Bug fix #3593 - approx method in a single element of numpy array 2018-06-25 22:55:16 +02:00
CHANGELOG.rst Correct code blocks in docs 2018-07-04 15:16:34 -07:00
CITATION Fix linting issues 2018-07-14 16:35:33 +01:00
CONTRIBUTING.rst Improve contributing instructions regarding black/linting 2018-06-11 20:49:25 -03:00
HOWTORELEASE.rst Revamp the release script: drop invoke and use tox directly 2018-07-14 11:35:37 -03:00
LICENSE Update copyright date in LICENSE and README.rst 2017-06-13 14:58:07 +02:00
README.rst Adjust copyright in README 2018-07-06 21:03:27 -03:00
appveyor.yml Skip AppVeyor builds on tag pushes 2018-06-27 08:28:34 -03:00
pyproject.toml add build-system section to pyproject.toml 2018-06-19 10:41:04 +02:00
setup.cfg restore setuptools_scm write_to usage 2017-04-23 16:59:08 +02:00
setup.py Merge pull request #3535 from RonnyPfannschmidt/config-split 2018-06-15 10:28:06 -07:00
tox.ini Revamp the release script: drop invoke and use tox directly 2018-07-14 11:35: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.org/project/pytest/

.. image:: https://img.shields.io/conda/vn/conda-forge/pytest.svg
    :target: https://anaconda.org/conda-forge/pytest

.. image:: https://img.shields.io/pypi/pyversions/pytest.svg
    :target: https://pypi.org/project/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://img.shields.io/badge/code%20style-black-000000.svg
  :target: https://github.com/ambv/black

.. 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-2018.

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