Go to file
Ankit Goel ec57cbf82d
Merge pull request #4020 from crazymerlyn/release-3.8.1
Preparing release version 3.8.1
2018-09-23 00:56:27 +05:30
.github Manage GH labels using the new 'labels' tool 2018-07-14 10:12:52 -03:00
bench py.builtin.exec_ => six.exec_ 2018-08-22 23:00:06 -07:00
changelog Preparing release version 3.8.1 2018-09-22 16:34:06 +00:00
doc/en Preparing release version 3.8.1 2018-09-22 16:34:06 +00:00
extra sort out flake8 issues and unicode name usage 2018-05-23 18:12:04 +02:00
scripts coverage: use modules for source 2018-09-19 07:46:19 +02:00
src Fix typo in docstring 2018-09-21 17:11:15 +01:00
testing Merge pull request #4010 from nicoddemus/package-len-error-3749 2018-09-21 07:40:20 +02:00
.coveragerc coverage: use modules for source 2018-09-19 07:46:19 +02:00
.gitattributes Add codecov support to AppVeyor and remove coveralls 2018-09-05 19:50:06 -03:00
.gitignore Ignore Sphinx's .doctrees folder 2018-09-14 16:00:35 -03:00
.pre-commit-config.yaml Improve pre-commit detection for changelog filenames 2018-09-07 09:36:09 -07:00
.travis.yml coverage: use modules for source 2018-09-19 07:46:19 +02:00
AUTHORS Merge remote-tracking branch 'upstream/master' into release-3.8.0 2018-09-05 18:02:02 -03:00
CHANGELOG.rst Preparing release version 3.8.1 2018-09-22 16:34:06 +00: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 Update release procedure [ci skip] 2018-08-29 14:13:08 -07:00
LICENSE Update copyright date in LICENSE and README.rst 2017-06-13 14:58:07 +02:00
README.rst Replace coveralls' badge by codecov's 2018-09-05 22:37:32 -03:00
appveyor.yml tests: use unittest.mock with py34+ 2018-09-12 23:21:47 +02:00
pyproject.toml Use "pytest" on the CHANGELOG 2018-07-27 09:21:18 -03:00
setup.cfg restore setuptools_scm write_to usage 2017-04-23 16:59:08 +02:00
setup.py Move code to get width of current line to a function 2018-08-30 21:16:35 -03:00
tox.ini tox: coverage factor: combine and report 2018-09-17 14:44:47 +02:00

README.rst

.. image:: https://docs.pytest.org/en/latest/_static/pytest1.png
   :target: https://docs.pytest.org/en/latest/
   :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://codecov.io/gh/pytest-dev/pytest/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pytest-dev/pytest
    :alt: Code coverage Status

.. 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 <https://docs.pytest.org/en/latest/getting-started.html#our-first-test-run>`_ for more examples.


Features
--------

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

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

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

- Can run `unittest <https://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
  `nose <https://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 https://docs.pytest.org/en/latest/.


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 <https://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