unittest subTest()
support and subtests
fixture.
.. image:: https://img.shields.io/pypi/v/pytest-subtests.svg :target: https://pypi.org/project/pytest-subtests :alt: PyPI version
.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-subtests.svg :target: https://anaconda.org/conda-forge/pytest-subtests
.. image:: https://img.shields.io/pypi/pyversions/pytest-subtests.svg :target: https://pypi.org/project/pytest-subtests :alt: Python versions
.. image:: https://github.com/pytest-dev/pytest-subtests/workflows/test/badge.svg :target: https://github.com/pytest-dev/pytest-subtests/actions
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black
This pytest
plugin was generated with Cookiecutter
along with @hackebrot
's cookiecutter-pytest-plugin
template.
Adds support for TestCase.subTest <https://docs.python.org/3/library/unittest.html#distinguishing-test-iterations-using-subtests>
__.
New subtests
fixture, providing similar functionality for pure pytest tests.
You can install pytest-subtests
via pip
from PyPI
::
$ pip install pytest-subtests
unittest subTest() example ^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
import unittest
class T(unittest.TestCase):
def test_foo(self):
for i in range(5):
with self.subTest("custom message", i=i):
self.assertEqual(i % 2, 0)
if __name__ == "__main__":
unittest.main()
Output
.. code-block::
λ pytest .tmp\test-unit-subtest.py
======================== test session starts ========================
...
collected 1 item
.tmp\test-unit-subtest.py FF. [100%]
============================= FAILURES ==============================
_________________ T.test_foo [custom message] (i=1) _________________
self = <test-unit-subtest.T testMethod=test_foo>
def test_foo(self):
for i in range(5):
with self.subTest('custom message', i=i):
> self.assertEqual(i % 2, 0)
E AssertionError: 1 != 0
.tmp\test-unit-subtest.py:9: AssertionError
_________________ T.test_foo [custom message] (i=3) _________________
self = <test-unit-subtest.T testMethod=test_foo>
def test_foo(self):
for i in range(5):
with self.subTest('custom message', i=i):
> self.assertEqual(i % 2, 0)
E AssertionError: 1 != 0
.tmp\test-unit-subtest.py:9: AssertionError
================ 2 failed, 1 passed in 0.07 seconds =================
subtests
fixture example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
def test(subtests):
for i in range(5):
with subtests.test(msg="custom message", i=i):
assert i % 2 == 0
Output
.. code-block::
λ pytest .tmp\test-subtest.py
======================== test session starts ========================
...
collected 1 item
.tmp\test-subtest.py .F.F.. [100%]
============================= FAILURES ==============================
____________________ test [custom message] (i=1) ____________________
def test(subtests):
for i in range(5):
with subtests.test(msg='custom message', i=i):
> assert i % 2 == 0
E assert (1 % 2) == 0
.tmp\test-subtest.py:4: AssertionError
____________________ test [custom message] (i=3) ____________________
def test(subtests):
for i in range(5):
with subtests.test(msg='custom message', i=i):
> assert i % 2 == 0
E assert (3 % 2) == 0
.tmp\test-subtest.py:4: AssertionError
================ 2 failed, 1 passed in 0.07 seconds =================
Contributions are very welcome. Tests can be run with tox
_:
.. code-block::
tox -e py37
Distributed under the terms of the MIT
_ license, "pytest-subtests" is free and open source software
If you encounter any problems, please file an issue
_ along with a detailed description.
.. Cookiecutter
: https://github.com/audreyr/cookiecutter
.. @hackebrot
: https://github.com/hackebrot
.. MIT
: http://opensource.org/licenses/MIT
.. cookiecutter-pytest-plugin
: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. file an issue
: https://github.com/pytest-dev/pytest-subtests/issues
.. pytest
: https://github.com/pytest-dev/pytest
.. tox
: https://tox.readthedocs.io/en/latest/
.. pip
: https://pypi.org/project/pip/
.. _PyPI
: https://pypi.org/project/pytest-subtests/