Go to file
Ran Benita 631c8b4df2
Merge pull request #9143 from bluetech/docs-stash-typo
Fix syntax typo in writing_hook_functions.rst
2021-10-01 11:38:15 +03:00
.github Fix prepare-release-pr invocation with empty --prerelease argument 2021-08-27 14:46:28 -03:00
bench unittest: fix quadratic behavior in collection of unittests using setUpClass/setup_method 2020-11-01 15:17:42 +02:00
changelog Fix non-sensical error message (#9077) 2021-09-24 06:15:53 +02:00
doc/en Fix syntax typo in writing_hook_functions.rst 2021-10-01 10:26:56 +03:00
extra Replace some usages of py.path.local 2020-08-06 18:46:17 +03:00
scripts [pre-commit.ci] auto fixes from pre-commit.com hooks 2021-09-22 13:41:33 +00:00
src Fix formatting 2021-09-27 22:51:08 -03:00
testing Merge pull request #9127 from pytest-dev/dependabot/pip/testing/plugins_integration/pytest-rerunfailures-10.2 2021-09-27 08:13:15 -03:00
.coveragerc Don't use NotImplementedError in `@overload`s 2020-08-14 13:54:46 +03:00
.gitattributes Add codecov support to AppVeyor and remove coveralls 2018-09-05 19:50:06 -03:00
.gitblameignore Add .gitblameignore (#6848) 2020-03-04 05:32:30 +01:00
.gitignore Making `--debug` more configurable for the pytest user (#8955) 2021-07-30 17:37:38 -03:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2021-09-27 19:44:12 +00:00
.readthedocs.yml Add readthedocs config file to use pip for installation 2020-08-01 14:21:36 -03:00
AUTHORS Add myself to AUTHORS file 2021-09-22 00:23:13 +02:00
CHANGELOG.rst port the rest of the scripts/docs over to the main branch 2021-03-18 22:13:12 +01:00
CITATION Fix linting issues 2018-07-14 16:35:33 +01:00
CODE_OF_CONDUCT.md remove myself from the list of coc handlers (#6857) 2020-03-03 19:08:59 -03:00
CONTRIBUTING.rst Adjust doc links for new scheme 2021-07-06 09:11:35 +02:00
LICENSE Update LICENSE 2021-05-08 23:38:48 +05:30
OPENCOLLECTIVE.rst doc: fix typos in OPENCOLLECTIVE.rst [ci skip] 2019-07-10 20:15:22 +02:00
README.rst adding contact and badge for pytest-dev discord server (#9078) 2021-09-12 18:22:44 +01:00
RELEASING.rst Adjust releasing infra/docs (#8795) 2021-06-28 12:24:48 +02:00
TIDELIFT.rst Add myself to tidelift 2021-05-04 17:46:35 +02:00
codecov.yml Adjust codecov: only patch statuses 2020-06-02 08:17:43 -03:00
pyproject.toml Ignore various warnings from Python 3.10 2021-05-04 17:24:50 +02:00
setup.cfg Allow pluggy >=1.0 2021-08-26 09:26:51 -03:00
setup.py Configure setuptools_scm using pyproject.toml 2020-07-31 15:46:02 -03:00
tox.ini Adjust releasing infra/docs (#8795) 2021-06-28 12:24:48 +02:00

README.rst

.. image:: https://github.com/pytest-dev/pytest/raw/main/doc/en/img/pytest_logo_curves.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

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


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/stable/getting-started.html#our-first-test-run>`_ for more examples.


Features
--------

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

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

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

- 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

- Python 3.6+ and PyPy3

- Rich plugin architecture, with over 850+ `external plugins <https://docs.pytest.org/en/latest/reference/plugin_list.html>`_ and thriving community


Documentation
-------------

For full documentation, including installation, tutorials and PDF documents, please see https://docs.pytest.org/en/stable/.


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/stable/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-2021.

Distributed under the terms of the `MIT`_ license, pytest is free and open source software.

.. _`MIT`: https://github.com/pytest-dev/pytest/blob/main/LICENSE