The pytest framework makes it easy to write small tests, yet scales to support complex functional testing
.. image:: https://github.com/pytest-dev/pytest/raw/main/doc/en/img/pytestlogocurves.svg :target: https://docs.pytest.org/en/stable/ :align: center :height: 200 :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/main/graph/badge.svg :target: https://codecov.io/gh/pytest-dev/pytest :alt: Code coverage Status
.. image:: https://github.com/pytest-dev/pytest/workflows/main/badge.svg :target: https://github.com/pytest-dev/pytest/actions?query=workflow%3Amain
.. image:: https://results.pre-commit.ci/badge/github/pytest-dev/pytest/main.svg :target: https://results.pre-commit.ci/latest/github/pytest-dev/pytest/main :alt: pre-commit.ci status
.. 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
.. image:: https://readthedocs.org/projects/pytest/badge/?version=latest :target: https://pytest.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
pytestframework 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
================================== FAILURES =================================== _________________________________ 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 ===========================
pytest's detailed assertion introspection, only plain
assertstatements are used. See
getting-started_ for more examples.
Detailed info on failing
assert statements_ (no need to remember
Auto-discovery_ of test modules and functions
Modular fixtures_ for managing small or parametrized long-lived test resources
unittest_ (or trial),
nose_ test suites out of the box
Python 3.6+ and PyPy3
Rich plugin architecture, with over 850+
external plugins_ and thriving community
For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/stable/.
Please use the
GitHub issue tracker_ to submit bugs or request features.
Changelog__ page for fixes and enhancements of each version.
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
.. _Open Collective: https://opencollective.com .. _pytest collective: https://opencollective.com/pytest
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.
pytest has never been associated with a security vulnerability, but in any case, to report a security vulnerability please use the
Tidelift security contact_. Tidelift will coordinate the fix and disclosure.
Copyright Holger Krekel and others, 2004-2021.
Distributed under the terms of the
MIT_ license, pytest is free and open source software.