2021-03-10 04:56:16 +08:00
.. image :: https://github.com/pytest-dev/pytest/raw/main/doc/en/img/pytest_logo_curves.svg
2020-07-07 18:39:35 +08:00
:target: https://docs.pytest.org/en/stable/
2015-12-26 05:58:00 +08:00
:align: center
2020-12-16 22:19:45 +08:00
:height: 200
2015-12-26 05:58:00 +08:00
:alt: pytest
2015-06-16 05:28:31 +08:00
2018-07-07 07:57:30 +08:00
2015-12-26 05:58:00 +08:00
------
2015-06-16 05:28:31 +08:00
2015-12-10 07:01:36 +08:00
.. image :: https://img.shields.io/pypi/v/pytest.svg
2018-04-26 21:45:48 +08:00
:target: https://pypi.org/project/pytest/
2017-04-28 23:51:40 +08:00
2018-04-27 21:23:28 +08:00
.. image :: https://img.shields.io/conda/vn/conda-forge/pytest.svg
2017-04-28 23:51:40 +08:00
:target: https://anaconda.org/conda-forge/pytest
2015-12-26 02:28:50 +08:00
.. image :: https://img.shields.io/pypi/pyversions/pytest.svg
2018-04-26 21:45:48 +08:00
:target: https://pypi.org/project/pytest/
2017-04-28 23:51:40 +08:00
2021-03-10 04:56:16 +08:00
.. image :: https://codecov.io/gh/pytest-dev/pytest/branch/main/graph/badge.svg
2018-09-06 06:59:19 +08:00
:target: https://codecov.io/gh/pytest-dev/pytest
:alt: Code coverage Status
2017-04-28 23:51:40 +08:00
2022-03-19 19:56:05 +08:00
.. image :: https://github.com/pytest-dev/pytest/workflows/test/badge.svg
:target: https://github.com/pytest-dev/pytest/actions?query=workflow%3Atest
2019-02-27 06:01:59 +08:00
2021-03-10 04:56:16 +08:00
.. image :: https://results.pre-commit.ci/badge/github/pytest-dev/pytest/main.svg
2021-03-19 05:13:12 +08:00
:target: https://results.pre-commit.ci/latest/github/pytest-dev/pytest/main
2020-12-23 06:57:04 +08:00
:alt: pre-commit.ci status
2018-05-26 05:23:59 +08:00
.. image :: https://img.shields.io/badge/code%20style-black-000000.svg
2019-08-11 03:38:13 +08:00
:target: https://github.com/psf/black
2018-05-26 05:23:59 +08:00
2018-02-21 00:51:51 +08:00
.. image :: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
:target: https://www.codetriage.com/pytest-dev/pytest
2018-02-22 07:42:09 +08:00
2020-02-29 07:29:56 +08:00
.. image :: https://readthedocs.org/projects/pytest/badge/?version=latest
:target: https://pytest.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
2021-09-13 01:22:44 +08:00
.. image :: https://img.shields.io/badge/Discord-pytest--dev-blue
:target: https://discord.com/invite/pytest-dev
:alt: Discord
.. image :: https://img.shields.io/badge/Libera%20chat-%23pytest-orange
:target: https://web.libera.chat/#pytest
:alt: Libera chat
2015-12-26 05:58:00 +08:00
The `` pytest `` framework makes it easy to write small tests, yet
2016-06-28 00:19:00 +08:00
scales to support complex functional testing for applications and libraries.
2013-10-24 21:08:50 +08:00
2015-12-26 05:58:00 +08:00
An example of a simple test:
2013-10-02 18:09:19 +08:00
2015-12-26 05:58:00 +08:00
.. code-block :: python
# content of test_sample.py
2016-11-28 00:45:52 +08:00
def inc(x):
2015-12-26 05:58:00 +08:00
return x + 1
2018-06-03 11:29:28 +08:00
2015-12-26 05:58:00 +08:00
def test_answer():
2016-11-28 00:45:52 +08:00
assert inc(3) == 5
2015-12-26 05:58:00 +08:00
To execute it::
2016-06-21 22:16:57 +08:00
$ pytest
2017-04-28 23:51:40 +08:00
============================= test session starts =============================
2015-12-26 05:58:00 +08:00
collected 1 items
test_sample.py F
2016-11-28 00:45:52 +08:00
================================== FAILURES ===================================
_________________________________ test_answer _________________________________
2015-12-26 05:58:00 +08:00
def test_answer():
2016-11-28 00:45:52 +08:00
> assert inc(3) == 5
2015-12-26 05:58:00 +08:00
E assert 4 == 5
2016-11-28 00:45:52 +08:00
E + where 4 = inc(3)
2015-12-26 05:58:00 +08:00
test_sample.py:5: AssertionError
2016-11-28 00:45:52 +08:00
========================== 1 failed in 0.04 seconds ===========================
2015-12-26 05:58:00 +08:00
2016-08-07 04:58:17 +08:00
2020-07-07 18:39:35 +08:00
Due to `` pytest `` 's detailed assertion introspection, only plain `` assert `` statements are used. See `getting-started <https://docs.pytest.org/en/stable/getting-started.html#our-first-test-run> `_ for more examples.
2016-06-28 00:19:00 +08:00
2013-10-24 21:08:50 +08:00
2015-06-16 05:28:31 +08:00
Features
--------
2008-08-18 23:08:39 +08:00
2021-12-07 01:56:39 +08:00
- Detailed info on failing `assert statements <https://docs.pytest.org/en/stable/how-to/assert.html> `_ (no need to remember `` self.assert* `` names)
2015-12-26 05:58:00 +08:00
- `Auto-discovery
2021-07-06 15:09:04 +08:00
<https://docs.pytest.org/en/stable/explanation/goodpractices.html#python-test-discovery>`_
2020-09-16 08:37:23 +08:00
of test modules and functions
2014-09-09 17:22:39 +08:00
2021-07-06 15:09:04 +08:00
- `Modular fixtures <https://docs.pytest.org/en/stable/explanation/fixtures.html> `_ for
2020-09-16 08:37:23 +08:00
managing small or parametrized long-lived test resources
2012-11-20 21:24:26 +08:00
2021-07-06 15:09:04 +08:00
- Can run `unittest <https://docs.pytest.org/en/stable/how-to/unittest.html> `_ (or trial),
`nose <https://docs.pytest.org/en/stable/how-to/nose.html> `_ test suites out of the box
2012-11-20 21:24:26 +08:00
2021-12-28 19:06:55 +08:00
- Python 3.7+ or PyPy3
2015-06-16 05:28:31 +08:00
2021-05-05 20:16:21 +08:00
- Rich plugin architecture, with over 850+ `external plugins <https://docs.pytest.org/en/latest/reference/plugin_list.html> `_ and thriving community
2015-12-26 05:58:00 +08:00
Documentation
-------------
2012-11-20 21:24:26 +08:00
2020-07-07 18:39:35 +08:00
For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/stable/.
2012-11-20 21:24:26 +08:00
2015-12-26 05:58:00 +08:00
Bugs/Requests
-------------
2012-11-20 21:24:26 +08:00
2015-12-29 04:55:20 +08:00
Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues> `_ to submit bugs or request features.
2012-11-20 21:24:26 +08:00
2015-12-26 05:58:00 +08:00
Changelog
---------
2012-11-20 21:24:26 +08:00
2020-07-07 18:39:35 +08:00
Consult the `Changelog <https://docs.pytest.org/en/stable/changelog.html> `__ page for fixes and enhancements of each version.
2013-07-24 18:14:53 +08:00
2019-05-10 06:05:45 +08:00
Support pytest
--------------
2019-10-25 01:58:58 +08:00
`Open Collective`_ is an online funding platform for open and transparent communities.
2020-01-10 06:12:57 +08:00
It provides tools to raise money and share your finances in full transparency.
2019-05-10 06:05:45 +08:00
2019-10-25 01:58:58 +08:00
It is the platform of choice for individuals and companies that want to make one-time or
monthly donations directly to the project.
2019-05-10 06:05:45 +08:00
2019-12-19 17:35:15 +08:00
See more details in the `pytest collective`_ .
2019-05-10 06:05:45 +08:00
2019-10-25 01:58:58 +08:00
.. _Open Collective: https://opencollective.com
.. _pytest collective: https://opencollective.com/pytest
2019-05-10 06:05:45 +08:00
2019-10-25 01:58:58 +08:00
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> `_
2019-05-10 06:05:45 +08:00
Security
^^^^^^^^
2019-12-09 11:26:53 +08:00
pytest has never been associated with a security vulnerability, but in any case, to report a
2019-05-10 06:05:45 +08:00
security vulnerability please use the `Tidelift security contact <https://tidelift.com/security> `_ .
Tidelift will coordinate the fix and disclosure.
2015-12-26 05:58:00 +08:00
License
-------
2013-07-24 18:14:53 +08:00
2021-11-30 20:28:23 +08:00
Copyright Holger Krekel and others, 2004.
2016-02-17 03:26:30 +08:00
Distributed under the terms of the `MIT`_ license, pytest is free and open source software.
2021-03-10 04:56:16 +08:00
.. _`MIT`: https://github.com/pytest-dev/pytest/blob/main/LICENSE