135 lines
4.6 KiB
ReStructuredText
135 lines
4.6 KiB
ReStructuredText
:orphan:
|
|
|
|
.. sidebar:: Next Open Trainings and Events
|
|
|
|
- `Professional Testing with Python <https://python-academy.com/courses/python_course_testing.html>`_, via `Python Academy <https://www.python-academy.com/>`_ (3 day in-depth training):
|
|
* **June 11th to 13th 2024**, Remote
|
|
* **March 4th to 6th 2025**, Leipzig, Germany / Remote
|
|
- `pytest development sprint <https://github.com/pytest-dev/pytest/discussions/11655>`_, **June 17th -- 22nd 2024**
|
|
- pytest tips and tricks for a better testsuite, `Europython 2024 <https://ep2024.europython.eu/>`_, **July 8th -- 14th 2024** (3h), Prague
|
|
|
|
Also see :doc:`previous talks and blogposts <talks>`.
|
|
|
|
.. _features:
|
|
|
|
pytest: helps you write better programs
|
|
=======================================
|
|
|
|
.. module:: pytest
|
|
|
|
The ``pytest`` framework makes it easy to write small, readable tests, and can
|
|
scale to support complex functional testing for applications and libraries.
|
|
|
|
|
|
``pytest`` requires: Python 3.8+ or PyPy3.
|
|
|
|
**PyPI package name**: :pypi:`pytest`
|
|
|
|
|
|
A quick example
|
|
---------------
|
|
|
|
.. code-block:: python
|
|
|
|
# content of test_sample.py
|
|
def inc(x):
|
|
return x + 1
|
|
|
|
|
|
def test_answer():
|
|
assert inc(3) == 5
|
|
|
|
|
|
To execute it:
|
|
|
|
.. code-block:: pytest
|
|
|
|
$ pytest
|
|
=========================== test session starts ============================
|
|
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
|
|
rootdir: /home/sweet/project
|
|
collected 1 item
|
|
|
|
test_sample.py F [100%]
|
|
|
|
================================= FAILURES =================================
|
|
_______________________________ test_answer ________________________________
|
|
|
|
def test_answer():
|
|
> assert inc(3) == 5
|
|
E assert 4 == 5
|
|
E + where 4 = inc(3)
|
|
|
|
test_sample.py:6: AssertionError
|
|
========================= short test summary info ==========================
|
|
FAILED test_sample.py::test_answer - assert 4 == 5
|
|
============================ 1 failed in 0.12s =============================
|
|
|
|
Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used.
|
|
See :ref:`Get started <getstarted>` for a basic introduction to using pytest.
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
- Detailed info on failing :ref:`assert statements <assert>` (no need to remember ``self.assert*`` names)
|
|
|
|
- :ref:`Auto-discovery <test discovery>` of test modules and functions
|
|
|
|
- :ref:`Modular fixtures <fixture>` for managing small or parametrized long-lived test resources
|
|
|
|
- Can run :ref:`unittest <unittest>` (including trial) test suites out of the box
|
|
|
|
- Python 3.8+ or PyPy 3
|
|
|
|
- Rich plugin architecture, with over 1300+ :ref:`external plugins <plugin-list>` and thriving community
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
* :ref:`Get started <get-started>` - install pytest and grasp its basics in just twenty minutes
|
|
* :ref:`How-to guides <how-to>` - step-by-step guides, covering a vast range of use-cases and needs
|
|
* :ref:`Reference guides <reference>` - includes the complete pytest API reference, lists of plugins and more
|
|
* :ref:`Explanation <explanation>` - background, discussion of key topics, answers to higher-level questions
|
|
|
|
|
|
Bugs/Requests
|
|
-------------
|
|
|
|
Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.
|
|
|
|
|
|
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.
|