Go to file
Daniel Hahler eac933acde assertion: rewrite: only catch EnvironmentError
This was changed unintentionally in 45c4a8fb3 (pytest 5.3.0), but only
EnvironmentErrors might have `errno`.
Since that is not really guaranteed and it is good to have more
information this uses the string representation of the exc in the trace
message.
2020-02-25 17:29:30 +01:00
.github Switch to new git workflow 2020-02-12 09:49:21 +02:00
bench Add rudimentary mypy type checking 2019-07-09 12:12:07 -07:00
changelog doctest: strip newlines with unexpected exceptions (#6801) 2020-02-24 15:18:08 +01:00
doc/en doc: add list of fixtures to start of fixture chapter (#6696) 2020-02-22 14:56:19 +01:00
extra pre-commit run fix-encoding-pragma --all-files 2019-06-03 12:08:01 -03:00
scripts Revert "ci: codecov: use `--retry-connrefused` with curl" 2020-01-30 19:56:25 +01:00
src assertion: rewrite: only catch EnvironmentError 2020-02-25 17:29:30 +01:00
testing test_assertion: harden/improve test_{text_diff,unicode} (#6806) 2020-02-24 15:19:08 +01:00
.coveragerc Ignore "assert False" statements in coverage 2020-02-15 17:08:01 +02:00
.gitattributes Add codecov support to AppVeyor and remove coveralls 2018-09-05 19:50:06 -03:00
.gitignore docs: move changelog to docs/en and allow sphinx directives 2019-11-28 21:23:58 -03:00
.pre-commit-config.yaml Merge branch 'features' into master 2020-02-12 13:50:02 +02:00
.travis.yml ci: fix Travis (#236) (#6786) 2020-02-21 12:50:54 +01:00
AUTHORS doc: add list of fixtures to start of fixture chapter (#6696) 2020-02-22 14:56:19 +01:00
CHANGELOG.rst docs: move changelog to docs/en and allow sphinx directives 2019-11-28 21:23:58 -03:00
CITATION Fix linting issues 2018-07-14 16:35:33 +01:00
CODE_OF_CONDUCT.md Add a code of conduct 2019-08-08 14:01:29 +02:00
CONTRIBUTING.rst Switch to new git workflow 2020-02-12 09:49:21 +02:00
LICENSE Update copyright year to 2020 2020-01-04 08:46:58 -03:00
OPENCOLLECTIVE.rst doc: fix typos in OPENCOLLECTIVE.rst [ci skip] 2019-07-10 20:15:22 +02:00
README.rst Fix grammar in README 2020-01-09 14:12:57 -08:00
RELEASING.rst Switch to new git workflow 2020-02-12 09:49:21 +02:00
TIDELIFT.rst Add docs about Tidelift and OpenCollective 2019-06-30 14:13:30 -03:00
codecov.yml ci: codecov: only use "comment: off" 2020-01-25 11:14:00 +01:00
pyproject.toml Replace 'removal' by 'breaking' changelog category 2019-12-06 08:50:35 -03:00
setup.cfg mypy: show_error_codes=True 2020-01-27 22:18:35 +01:00
setup.py tox: add mypy toxenv 2020-01-14 08:59:48 +01:00
tox.ini Use code highlighting if pygments is installed (#6658) 2020-02-12 08:32:37 -03: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://dev.azure.com/pytest-dev/pytest/_apis/build/status/pytest-CI?branchName=master
    :target: https://dev.azure.com/pytest-dev/pytest

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/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 3.5+ and PyPy3;

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


Support pytest
--------------

`Open Collective`_ is an online funding platform for open and transparent communities.
It provides tools to raise money and share your finances in full transparency.

It is the platform of choice for individuals and companies that want to make one-time or
monthly donations directly to the project.

See more details in the `pytest collective`_.

.. _Open Collective: https://opencollective.com
.. _pytest collective: https://opencollective.com/pytest


pytest for enterprise
---------------------

Available as part of the Tidelift Subscription.

The maintainers of pytest and thousands of other packages are working with Tidelift to deliver commercial support and
maintenance for the open source dependencies you use to build your applications.
Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.

`Learn more. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_

Security
^^^^^^^^

pytest has never been associated with a security vulnerability, but in any case, to report a
security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
Tidelift will coordinate the fix and disclosure.


License
-------

Copyright Holger Krekel and others, 2004-2020.

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