{"author":null,"author_email":"Leah Klearman ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: Pytest","Intended Audience :: Developers","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Quality Assurance","Topic :: Software Development :: Testing","Topic :: Utilities"],"description":".. contents::\n\npytest-rerunfailures\n====================\n\n.. START-SHORT-DESCRIPTION\n\npytest-rerunfailures is a plugin for `pytest `_ that\nre-runs tests to eliminate intermittent failures.\n\n.. END-SHORT-DESCRIPTION\n\n.. image:: https://img.shields.io/badge/license-MPL%202.0-blue.svg\n :target: https://github.com/pytest-dev/pytest-rerunfailures/blob/master/LICENSE\n :alt: License\n.. image:: https://img.shields.io/pypi/v/pytest-rerunfailures.svg\n :target: https://pypi.python.org/pypi/pytest-rerunfailures/\n :alt: PyPI\n.. image:: https://github.com/pytest-dev/pytest-rerunfailures/workflows/Test/badge.svg\n :target: https://github.com/pytest-dev/pytest-rerunfailures/actions\n :alt: GitHub Actions\n.. image:: https://readthedocs.org/projects/pytest-rerunfailures/badge/?version=latest\n :target: https://pytest-rerunfailures.readthedocs.io/latest/?badge=latest\n :alt: Documentation Status\n\n.. START-INSTALLATION\n\nRequirements\n------------\n\nYou will need the following prerequisites in order to use pytest-rerunfailures:\n\n- Python 3.9+ or PyPy3\n- pytest 7.4 or newer\n\nThis plugin can recover from a hard crash with the following optional\nprerequisites:\n\n- pytest-xdist 2.3.0 or newer\n\nThis package is currently tested against the last 5 minor pytest releases. In\ncase you work with an older version of pytest you should consider updating or\nuse one of the earlier versions of this package.\n\nInstallation\n------------\n\nTo install pytest-rerunfailures:\n\n.. code-block:: bash\n\n $ pip install pytest-rerunfailures\n\n.. END-INSTALLATION\n\nRecover from hard crashes\n-------------------------\n\nIf one or more tests trigger a hard crash (for example: segfault), this plugin\nwill ordinarily be unable to rerun the test. However, if a compatible version of\npytest-xdist is installed, and the tests are run within pytest-xdist using the ``-n``\nflag, this plugin will be able to rerun crashed tests, assuming the workers and\ncontroller are on the same LAN (this assumption is valid for almost all cases\nbecause most of the time the workers and controller are on the same computer).\nIf this assumption is not the case, then this functionality may not operate.\n\nRe-run all failures\n-------------------\n\nTo re-run all test failures, use the ``--reruns`` command line option with the\nmaximum number of times you'd like the tests to run:\n\n.. code-block:: bash\n\n $ pytest --reruns 5\n\nFailed fixture or setup_class will also be re-executed.\n\nTo add a delay time between re-runs use the ``--reruns-delay`` command line\noption with the amount of seconds that you would like wait before the next\ntest re-run is launched:\n\n.. code-block:: bash\n\n $ pytest --reruns 5 --reruns-delay 1\n\nRe-run all failures matching certain expressions\n------------------------------------------------\n\nTo re-run only those failures that match a certain list of expressions, use the\n``--only-rerun`` flag and pass it a regular expression. For example,\nthe following would only rerun those errors that match ``AssertionError``:\n\n.. code-block:: bash\n\n $ pytest --reruns 5 --only-rerun AssertionError\n\nPassing the flag multiple times accumulates the arguments, so the following\nwould only rerun those errors that match ``AssertionError`` or ``ValueError``:\n\n.. code-block:: bash\n\n $ pytest --reruns 5 --only-rerun AssertionError --only-rerun ValueError\n\nRe-run all failures other than matching certain expressions\n-----------------------------------------------------------\n\nTo re-run only those failures that do not match a certain list of expressions, use the\n``--rerun-except`` flag and pass it a regular expression. For example,\nthe following would only rerun errors other than that match ``AssertionError``:\n\n.. code-block:: bash\n\n $ pytest --reruns 5 --rerun-except AssertionError\n\nPassing the flag multiple times accumulates the arguments, so the following\nwould only rerun those errors that does not match with ``AssertionError`` or ``OSError``:\n\n.. code-block:: bash\n\n $ pytest --reruns 5 --rerun-except AssertionError --rerun-except OSError\n\nRe-run individual failures\n--------------------------\n\nTo mark individual tests as flaky, and have them automatically re-run when they\nfail, add the ``flaky`` mark with the maximum number of times you'd like the\ntest to run:\n\n.. code-block:: python\n\n @pytest.mark.flaky(reruns=5)\n def test_example():\n import random\n assert random.choice([True, False])\n\nNote that when teardown fails, two reports are generated for the case, one for\nthe test case and the other for the teardown error.\n\nYou can also specify the re-run delay time in the marker:\n\n.. code-block:: python\n\n @pytest.mark.flaky(reruns=5, reruns_delay=2)\n def test_example():\n import random\n assert random.choice([True, False])\n\nYou can also specify an optional ``condition`` in the re-run marker:\n\n.. code-block:: python\n\n @pytest.mark.flaky(reruns=5, condition=sys.platform.startswith(\"win32\"))\n def test_example():\n import random\n assert random.choice([True, False])\n\nException filtering can be accomplished by specifying regular expressions for\n``only_rerun`` and ``rerun_except``. They override the ``--only-rerun`` and\n``--rerun-except`` command line arguments, respectively.\n\nArguments can be a single string:\n\n.. code-block:: python\n\n @pytest.mark.flaky(rerun_except=\"AssertionError\")\n def test_example():\n raise AssertionError()\n\nOr a list of strings:\n\n.. code-block:: python\n\n @pytest.mark.flaky(only_rerun=[\"AssertionError\", \"ValueError\"])\n def test_example():\n raise AssertionError()\n\n\nYou can use ``@pytest.mark.flaky(condition)`` similarly as ``@pytest.mark.skipif(condition)``, see `pytest-mark-skipif `_\n\n.. code-block:: python\n\n @pytest.mark.flaky(reruns=2,condition=\"sys.platform.startswith('win32')\")\n def test_example():\n import random\n assert random.choice([True, False])\n # totally same as the above\n @pytest.mark.flaky(reruns=2,condition=sys.platform.startswith(\"win32\"))\n def test_example():\n import random\n assert random.choice([True, False])\n\nNote that the test will re-run for any ``condition`` that is truthy.\n\nOutput\n------\n\nHere's an example of the output provided by the plugin when run with\n``--reruns 2`` and ``-r aR``::\n\n test_report.py RRF\n\n ================================== FAILURES ==================================\n __________________________________ test_fail _________________________________\n\n def test_fail():\n > assert False\n E assert False\n\n test_report.py:9: AssertionError\n ============================ rerun test summary info =========================\n RERUN test_report.py::test_fail\n RERUN test_report.py::test_fail\n ============================ short test summary info =========================\n FAIL test_report.py::test_fail\n ======================= 1 failed, 2 rerun in 0.02 seconds ====================\n\nNote that output will show all re-runs. Tests that fail on all the re-runs will\nbe marked as failed.\n\n.. START-COMPATIBILITY\n\nCompatibility\n-------------\n\n* This plugin may *not* be used with class, module, and package level fixtures.\n* This plugin is *not* compatible with pytest-xdist's --looponfail flag.\n* This plugin is *not* compatible with the core --pdb flag.\n* This plugin is *not* compatible with the plugin\n `flaky `_, you can only have\n ``pytest-rerunfailures`` or ``flaky`` but not both.\n\n.. END-COMPATIBILITY\n\n.. START-CONTRIBUTING\n\nResources\n---------\n\n- `Issue Tracker `_\n- `Code `_\n\nDevelopment\n-----------\n\n* Test execution count can be retrieved from the ``execution_count`` attribute\n in test ``item``'s object. Example:\n\n .. code-block:: python\n\n @hookimpl(tryfirst=True)\n def pytest_runtest_makereport(item, call):\n print(item.execution_count)\n\n.. END-CONTRIBUTING\n\nChangelog\n=========\n\n15.1 (2025-05-08)\n-----------------\n\nBug fixes\n+++++++++\n\n- Fix ``--fail-on-flaky`` option to fail the test run with custom exit code\n only when reruns are detected.\n (`#287 `_)\n\n- Switched to using the SPDX license identifier in the project metadata.\n\nOther changes\n+++++++++++++\n\n- Change exception filtering logic to match ``AssertionError`` raised via\n ``assert`` statements when filtering by \"AssertionError\".\n (`#292 `_)\n\n15.0 (2024-11-20)\n-----------------\n\nBreaking changes\n++++++++++++++++\n\n- Drop support for Python 3.8.\n\n- Drop support for pytest < 7.4.\n\nFeatures\n++++++++\n\n- Fix compatibility with pytest 8.2.\n (`#267 `_)\n\n- Add support for pytest 8.2, 8.3.\n\n- Add ``--fail-on-flaky`` option to fail the test run with custom exit code\n when test passed on rerun.\n\n14.0 (2024-03-13)\n-----------------\n\nBug fixes\n+++++++++\n\n- Fix missing teardown for non-function scoped fixtures when using only_rerun or rerun_except queries.\n (`#234 `_)\n and (`#241 `_)\n\nBreaking changes\n++++++++++++++++\n\n- Drop support for Python 3.7.\n\n- Drop support for pytest < 7.2.\n\nFeatures\n++++++++\n\n- Add support for pytest 8.0, 8.1.\n\n\n13.0 (2023-11-22)\n-----------------\n\nBreaking changes\n++++++++++++++++\n\n- Drop support for pytest < 7.0.\n\nFeatures\n++++++++\n\n- Add support for Python 3.12.\n\nBug fixes\n+++++++++\n\n- Fix crashitem names mismatch between client and server.\n (`#172 `_)\n\n- Fix crash when setup fails with --rerun-except flag.\n (`#230 `_)\n\n12.0 (2023-07-05)\n-----------------\n\nBreaking changes\n++++++++++++++++\n\n- Drop support for pytest < 6.2.\n\nFeatures\n++++++++\n\n- Add ``only_rerun`` and ``rerun_except`` arguments to ``@pytest.mark.flaky`` marker.\n\n- Add support for pytest 7.3, 7.4.\n\nBug fixes\n+++++++++\n\n- Failures are now rerun only if they match at least one ``--only-rerun``\n pattern (if given) and none of the ``--rerun-except`` patterns. Previously,\n using both ``--only-rerun`` and ``--rerun-except`` together could cause\n failures to be rerun even if they did not match any ``--only-rerun``\n pattern, and when using multiple ``--rerun-except`` patterns, all failures\n would be rerun unless they matched every pattern.\n (`#225 `_)\n\n\n11.1.2 (2023-03-09)\n-------------------\n\nBug fixes\n+++++++++\n\n- Execute teardown when test was skipped in setup phase of a fixture.\n\n\n11.1.1 (2023-02-17)\n-------------------\n\nBug fixes\n+++++++++\n\n- Fix crash during teardown when runtest protocol hook is overwritten by\n another plugin.\n\n- Fix crash during teardown when TestCase class is used as base class.\n\n\n11.1 (2023-02-09)\n-----------------\n\nBug fixes\n+++++++++\n\n- Run teardown of session, class, ... scoped fixtures only once after rerunning tests\n\nFeatures\n++++++++\n\n- Expose ``reruns`` and ``reruns_delay`` through ``pytest.ini`` file.\n\n\n11.0 (2023-01-12)\n-----------------\n\nBreaking changes\n++++++++++++++++\n\n- Drop support for Python 3.6.\n\n- Drop support for pytest < 6.\n\nBug fixes\n+++++++++\n\n- Fix crash when pytest-xdist is installed but disabled.\n (Thanks to `@mgorny `_ for the PR.)\n\n- Fix crash when xfail(strict=True) mark is used with --rerun-only flag.\n\nFeatures\n++++++++\n\n- Added option ``--rerun-except`` to rerun failed tests those are other than the mentioned Error.\n\n- Add support for Python 3.11.\n\n- Add support for pytest 7.0, 7.1, 7.2.\n\n\n10.2 (2021-09-17)\n-----------------\n\nFeatures\n++++++++\n\n- Allow recovery from crashed tests with pytest-xdist.\n- Add support for Python 3.10 (as of Python 3.10.rc2).\n (Thanks to `@hugovk `_ for the PR.)\n\n\n10.1 (2021-07-02)\n-----------------\n\nFeatures\n++++++++\n\n- Allows using a ``str`` as condition for\n ``@pytest.mark.flaky(condition)``\n which gets evaluated dynamically similarly to\n ``@pytest.mark.skipif(condition)``.\n (`#162 `_\n provided by `@15klli `_)\n\n10.0 (2021-05-26)\n-----------------\n\nBackwards incompatible changes\n++++++++++++++++++++++++++++++\n\n- Drop support for Python 3.5.\n\n- Drop support for pytest < 5.3.\n\nFeatures\n++++++++\n\n- Add ``condition`` keyword argument to the re-run marker.\n (Thanks to `@BeyondEvil`_ for the PR.)\n\n- Add support for Python 3.9.\n (Thanks to `@digitronik`_ for the PR.)\n\n- Add support for pytest 6.3.\n (Thanks to `@bluetech`_ for the PR.)\n\n- Add compatibility with ``pytest-xdist >= 2.0``.\n (Thanks to `@bluetech`_ for the PR.)\n\nOther changes\n+++++++++++++\n\n- Check for the resultlog by feature and not by version as pytest master does\n not provide a consistent version.\n\n.. _@BeyondEvil: https://github.com/BeyondEvil\n.. _@digitronik: https://github.com/digitronik\n.. _@bluetech: https://github.com/bluetech\n\n9.1.1 (2020-09-29)\n------------------\n\nCompatibility fix.\n++++++++++++++++++\n\n- Ignore ``--result-log`` command line option when used together with ``pytest\n >= 6.1.0``, as it was removed there. This is a quick fix, use an older\n version of pytest, if you want to keep this feature for now.\n (Thanks to `@ntessore`_ for the PR)\n\n- Support up to pytest 6.1.0.\n\n.. _@ntessore: https://github.com/ntessore\n\n\n9.1 (2020-08-26)\n----------------\n\nFeatures\n++++++++\n\n- Add a new flag ``--only-rerun`` to allow for users to rerun only certain\n errors.\n\nOther changes\n+++++++++++++\n\n- Drop dependency on ``mock``.\n\n- Add support for pre-commit and add a linting tox target.\n (`#117 `_)\n (PR from `@gnikonorov`_)\n\n.. _@gnikonorov: https://github.com/gnikonorov\n\n\n9.0 (2020-03-18)\n----------------\n\nBackwards incompatible changes\n++++++++++++++++++++++++++++++\n\n- Drop support for pytest version 4.4, 4.5 and 4.6.\n\n- Drop support for Python 2.7.\n\n\nFeatures\n++++++++\n\n- Add support for pytest 5.4.\n\n- Add support for Python 3.8.\n\n\n8.0 (2019-11-18)\n----------------\n\nBackwards incompatible changes\n++++++++++++++++++++++++++++++\n\n- Drop support for pytest version 3.10, 4.0, 4.1, 4.2 and 4.3\n\n- Drop support for Python 3.4.\n\nFeatures\n++++++++\n\n- Add support for pytest version 4.4, 4.5, 4.6, 5.0, 5.1 and 5.2.\n\nBug fixes\n+++++++++\n\n- Explicitly depend on setuptools to ensure installation when working in\n environments without it.\n (`#98 `_)\n (PR from `@Eric-Arellano`_)\n\n.. _@Eric-Arellano: https://github.com/Eric-Arellano\n\n\n7.0 (2019-03-28)\n----------------\n\nBackwards incompatible changes\n++++++++++++++++++++++++++++++\n\n- Drop support for pytest version 3.8 and 3.9.\n\nFeatures\n++++++++\n\n- Add support for pytest version 4.2 and 4.3.\n\nBug fixes\n+++++++++\n\n- Fixed #83 issue about ignored ``pytest_runtest_logfinish`` hooks.\n (`#83 `_)\n (PR from `@KillAChicken`_)\n\n.. _@KillAChicken: https://github.com/KillAChicken\n\n\n6.0 (2019-01-08)\n----------------\n\nBackwards incompatible changes\n++++++++++++++++++++++++++++++\n\n- Drop support for pytest version 3.6 and 3.7.\n\nFeatures\n++++++++\n\n- Add support for pytest version 4.0 and 4.1.\n\nBug fixes\n+++++++++\n\n- Fixed #77 regression issue introduced in 4.2 related to the ``rerun``\n attribute on the test report.\n (`#77 `_)\n (Thanks to `@RibeiroAna`_ for the PR).\n\n.. _@RibeiroAna: https://github.com/RibeiroAna\n\n\n5.0 (2018-11-06)\n----------------\n\n- Drop support for pytest versions < 3.6 to reduce the maintenance burden.\n\n- Add support up to pytest version 3.10. Thus supporting the newest 5 pytest\n releases.\n\n- Add support for Python 3.7.\n\n- Fix issue can occur when used together with ``pytest-flake8``\n (`#73 `_)\n\n\n4.2 (2018-10-04)\n----------------\n\n- Fixed #64 issue related to ``setup_class`` and ``fixture`` executions on\n rerun (Thanks to `@OlegKuzovkov`_ for the PR).\n\n- Added new ``execution_count`` attribute to reflect the number of test case\n executions according to #67 issue. (Thanks to `@OlegKuzovkov`_ for the PR).\n\n.. _@OlegKuzovkov: https://github.com/OlegKuzovkov\n\n\n4.1 (2018-05-23)\n----------------\n\n- Add support for pytest 3.6 by using ``Node.get_closest_marker()`` (Thanks to\n `@The-Compiler`_ for the PR).\n\n.. _@The-Compiler: https://github.com/The-Compiler\n\n4.0 (2017-12-23)\n----------------\n\n- Added option to add a delay time between test re-runs (Thanks to `@Kanguros`_\n for the PR).\n\n- Added support for pytest >= 3.3.\n\n- Drop support for pytest < 2.8.7.\n\n.. _@Kanguros: https://github.com/Kanguros\n\n\n3.1 (2017-08-29)\n----------------\n\n- Restored compatibility with pytest-xdist. (Thanks to `@davehunt`_ for the PR)\n\n.. _@davehunt: https://github.com/davehunt\n\n\n3.0 (2017-08-17)\n----------------\n\n- Add support for Python 3.6.\n\n- Add support for pytest 2.9 up to 3.2\n\n- Drop support for Python 2.6 and 3.3.\n\n- Drop support for pytest < 2.7.\n\n\n2.2 (2017-06-23)\n----------------\n\n- Ensure that other plugins can run after this one, in case of a global setting\n ``--rerun=0``. (Thanks to `@sublee`_ for the PR)\n\n.. _@sublee: https://github.com/sublee\n\n2.1.0 (2016-11-01)\n------------------\n\n- Add default value of ``reruns=1`` if ``pytest.mark.flaky()`` is called\n without arguments.\n\n- Also offer a distribution as universal wheel. (Thanks to `@tltx`_ for the PR)\n\n.. _@tltx: https://github.com/tltx\n\n\n2.0.1 (2016-08-10)\n-----------------------------\n\n- Prepare CLI options to pytest 3.0, to avoid a deprecation warning.\n\n- Fix error due to missing CHANGES.rst when creating the source distribution\n by adding a MANIFEST.in.\n\n\n2.0.0 (2016-04-06)\n------------------\n\n- Drop support for Python 3.2, since supporting it became too much of a hassle.\n (Reason: Virtualenv 14+ / PIP 8+ do not support Python 3.2 anymore.)\n\n\n1.0.2 (2016-03-29)\n------------------\n\n- Add support for ``--resultlog`` option by parsing reruns accordingly. (#28)\n\n\n1.0.1 (2016-02-02)\n------------------\n\n- Improve package description and include CHANGELOG into description.\n\n\n1.0.0 (2016-02-02)\n------------------\n\n- Rewrite to use newer API of pytest >= 2.3.0\n\n- Improve support for pytest-xdist by only logging the final result.\n (Logging intermediate results will finish the test rather rerunning it.)\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":null,"keywords":"failures, flaky, pytest, rerun","license":"MPL-2.0","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"pytest-rerunfailures","package_url":"https://pypi.org/project/pytest-rerunfailures/","platform":null,"project_url":"https://pypi.org/project/pytest-rerunfailures/","project_urls":{"Homepage":"https://github.com/pytest-dev/pytest-rerunfailures"},"provides_extra":null,"release_url":"https://pypi.org/project/pytest-rerunfailures/15.1/","requires_dist":["packaging>=17.1","pytest!=8.2.2,>=7.4"],"requires_python":">=3.9","summary":"pytest plugin to re-run tests to eliminate flaky failures","version":"15.1","yanked":false,"yanked_reason":null}

Dependencies of pytest-rerunfailures (2).
Dependency	Optional
packaging	false
pytest	false

Package search

pytest-rerunfailures

project_urls

Dependencies

All package metadata

Releases