File: cli.rst

package info (click to toggle)
pytest-rerunfailures 16.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 248 kB
  • sloc: python: 1,222; makefile: 2
file content (98 lines) | stat: -rw-r--r-- 1,880 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
Command Line Interface Options
==============================

.. option:: --force-reruns

   **Description**:
       Force specified number of reruns, irrespective of the number passed to pytest markers.

   **Type**:
       Integer

   **Default**:
       Not set (must be provided)

   **Example**:
       .. code-block:: bash

           pytest --force-reruns 5

.. option:: --only-rerun

   **Description**:
       Specify regex patterns for errors to rerun. Use this option multiple times to accumulate a list of regexes.

   **Type**:
       String (repeatable)

   **Default**:
       None

   **Example**:
       .. code-block:: bash

           pytest --only-rerun AssertionError --only-rerun ValueError

.. option:: --reruns

   **Description**:
       The number of times to rerun failing tests.

   **Type**:
       Integer

   **Default**:
       Not set (must be provided)

   **Example**:
       .. code-block:: bash

           pytest --reruns 5

.. option:: --reruns-delay

   **Description**:
       Delay in seconds between reruns.

   **Type**:
       Float

   **Default**:
       Not set (must be provided)

   **Example**:
       .. code-block:: bash

           pytest --reruns 5 --reruns-delay 1

.. option:: --rerun-except

   **Description**:
       Specify regex patterns for errors to exclude from reruns. Use this option multiple times to accumulate a list of regexes.

   **Type**:
       String (repeatable)

   **Default**:
       None

   **Example**:
       .. code-block:: bash

           pytest --reruns 5 --rerun-except AssertionError --rerun-except OSError

.. option:: --fail-on-flaky

   **Description**:
       If set, the test run will fail with exit code 7 if a flaky test passes on rerun.

   **Type**:
       Boolean flag

   **Default**:
       False

   **Example**:
       .. code-block:: bash

           pytest --fail-on-flaky