Configuration

The pytest.ini configuration file allows you to set default values for the plugin’s options, enabling a consistent test execution environment without the need to specify command-line options every time.

Available pytest.ini Options

Below are the pytest.ini options supported by the plugin:

reruns

  • Description: Sets the default number of times to rerun failed tests. If not set, you must provide the --reruns option on the command line.

  • Type: String

  • Default: Not set (must be provided as a CLI argument if not configured).

  • Example:

    [pytest]
reruns = 3

reruns_delay

  • Description: Sets the default delay (in seconds) between reruns of failed tests.

  • Type: String

  • Default: Not set (optional).

  • Example:

    [pytest]
reruns_delay = 2.5

only_rerun

  • Description: Sets regular expressions for errors that should be rerun. Add one expression per line. The --only-rerun command-line flag replaces this list rather than adding to it, and a project-wide only_rerun also applies to tests carrying a plain @pytest.mark.flaky(reruns=...) marker — a marked test raising a non-matching error stops rerunning.

  • Type: List of strings

  • Default: Not set (all errors are eligible for reruns).

  • Example:

    [pytest]
only_rerun =
    AssertionError
    ValueError

rerun_except

  • Description: Sets regular expressions for errors that should not be rerun. Add one expression per line. The --rerun-except command-line flag replaces this list rather than adding to it.

  • Type: List of strings

  • Default: Not set (all errors are eligible for reruns).

  • Example:

    [pytest]
rerun_except =
    AssertionError
    ValueError

Example

To configure your test environment for consistent retries and delays, add the following options to your pytest.ini file:

[pytest]
reruns = 3
reruns_delay = 2.0
only_rerun = AssertionError

This setup ensures that:

  • Failed tests will be retried up to 3 times.

  • There will be a 2-second delay between each retry.

  • Only failures matching AssertionError are retried; other errors fail without rerunning.

Overriding pytest.ini Options

Command-line arguments always override pytest.ini settings. For example:

pytest --reruns 5 --reruns-delay 1.5

This will retry tests 5 times with a 1.5-second delay, regardless of the values set in pytest.ini.