pytest README

The project's README from github.com/pytest-dev/pytest. As one markdown file: README.md.

.. 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/actions/workflows/test.yml/badge.svg :target: https://github.com/pytest-dev/pytest/actions?query=workflow%3Atest

.. 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://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 ===========================

Thanks to pytest's detailed assertion introspection, you can simply use plain assert statements. See getting-started <https://docs.pytest.org/en/stable/getting-started.html#our-first-test-run>_ for more examples.

Features

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

If you have found an issue that you believe is a security vulnerability, please do not create an issue -- instead, report it via a new security advisory <https://github.com/pytest-dev/pytest/security/advisories/new>__.

License

Copyright Holger Krekel and others, 2004.

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

pytest (pytest-dev/pytest)

Searching Database…

14.6K ·GitHub
Что это такое?pytest — это фреймворк для тестирования на Python, который позволяет легко писать небольшие тесты и при этом масштабируется до сложного функционального тестирования приложений и библиотек.
pytest — это библиотека, которую я импортирую, или утилита командной строки?Это фреймворк с запуском из командной строки: вы пишете тестовые функции в обычных .py-файлах и запускаете их командой 'pytest' — тестовые модули и функции она находит сама.
С чего мне начать?Установите pytest по руководству для начинающих, добавьте файл с тестами с обычными проверками 'assert', затем запустите '$ pytest' — результаты сразу выводятся в терминал.
Есть ли какие-то требования, например определённая версия Python?Нужен только интерпретатор: Python 3.10+ или PyPy3. Больше ничего не требуется, чтобы запустить первый тест.
Одинаково ли он работает на Windows, macOS и Linux?Да — в README нет ограничений по ОС, поэтому pytest работает везде, где запускается Python, одной и той же командой.
pytest бесплатный, в том числе для коммерческого использования?Да — это свободное ПО с открытым кодом под лицензией MIT. Компании, которым нужна официальная поддержка, могут дополнительно приобрести коммерческую поддержку через Tidelift Subscription.
Мне нужны специальные методы проверки вроде assertEqual из unittest?Нет — благодаря подробной интроспекции утверждений в pytest достаточно писать обычные инструкции 'assert'. При сбое показываются реальные значения, например 'assert 4 == 5' плюс '+ where 4 = inc(3)'.
Запустит ли pytest мой существующий набор тестов unittest?Да — он умеет запускать наборы тестов unittest (или trial) прямо из коробки, так что можно переходить на него постепенно, не переписывая тесты.
Что такое фикстуры?Модульные фикстуры — это способ pytest управлять тестовыми ресурсами, от небольших до параметризованных долгоживущих: код подготовки остаётся упорядоченным и переиспользуется в разных тестах.
Насколько велика экосистема плагинов?Очень велика: у pytest богатая архитектура плагинов, более 1300 внешних плагинов и активное сообщество.
What are similar projects?ava, pest, phpunit, enzyme, testify, truffle, vitest, SeleniumBase
Creator
pytest-dev
Size
41.1 MB
Stars
14.6K
Age
11y
Commits · 90 Days