@@ -92,23 +92,23 @@ pytest.param
92
92
pytest.raises
93
93
~~~~~~~~~~~~~
94
94
95
- **Tutorial **: :ref: `assertraises `.
95
+ **Tutorial **: :ref: `assertraises `
96
96
97
97
.. autofunction :: pytest.raises(expected_exception: Exception [, *, match])
98
98
:with: excinfo
99
99
100
100
pytest.deprecated_call
101
101
~~~~~~~~~~~~~~~~~~~~~~
102
102
103
- **Tutorial **: :ref: `ensuring_function_triggers `.
103
+ **Tutorial **: :ref: `ensuring_function_triggers `
104
104
105
105
.. autofunction :: pytest.deprecated_call()
106
106
:with:
107
107
108
108
pytest.register_assert_rewrite
109
109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110
110
111
- **Tutorial **: :ref: `assertion-rewriting `.
111
+ **Tutorial **: :ref: `assertion-rewriting `
112
112
113
113
.. autofunction :: pytest.register_assert_rewrite
114
114
@@ -123,7 +123,7 @@ pytest.warns
123
123
pytest.freeze_includes
124
124
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
125
126
- **Tutorial **: :ref: `freezing-pytest `.
126
+ **Tutorial **: :ref: `freezing-pytest `
127
127
128
128
.. autofunction :: pytest.freeze_includes
129
129
@@ -143,7 +143,7 @@ fixtures or plugins.
143
143
pytest.mark.filterwarnings
144
144
~~~~~~~~~~~~~~~~~~~~~~~~~~
145
145
146
- **Tutorial **: :ref: `filterwarnings `.
146
+ **Tutorial **: :ref: `filterwarnings `
147
147
148
148
Add warning filters to marked test items.
149
149
@@ -169,7 +169,7 @@ Add warning filters to marked test items.
169
169
pytest.mark.parametrize
170
170
~~~~~~~~~~~~~~~~~~~~~~~
171
171
172
- : ref: `parametrize `.
172
+ ** Tutorial **: : ref: `parametrize `
173
173
174
174
This mark has the same signature as :py:meth: `pytest.Metafunc.parametrize `; see there.
175
175
@@ -179,7 +179,7 @@ This mark has the same signature as :py:meth:`pytest.Metafunc.parametrize`; see
179
179
pytest.mark.skip
180
180
~~~~~~~~~~~~~~~~
181
181
182
- : ref: `skip `.
182
+ ** Tutorial **: : ref: `skip `
183
183
184
184
Unconditionally skip a test function.
185
185
@@ -193,7 +193,7 @@ Unconditionally skip a test function.
193
193
pytest.mark.skipif
194
194
~~~~~~~~~~~~~~~~~~
195
195
196
- : ref: `skipif `.
196
+ ** Tutorial **: : ref: `skipif `
197
197
198
198
Skip a test function if a condition is ``True ``.
199
199
@@ -209,7 +209,7 @@ Skip a test function if a condition is ``True``.
209
209
pytest.mark.usefixtures
210
210
~~~~~~~~~~~~~~~~~~~~~~~
211
211
212
- **Tutorial **: :ref: `usefixtures `.
212
+ **Tutorial **: :ref: `usefixtures `
213
213
214
214
Mark a test function as using the given fixture names.
215
215
@@ -231,7 +231,7 @@ Mark a test function as using the given fixture names.
231
231
pytest.mark.xfail
232
232
~~~~~~~~~~~~~~~~~~
233
233
234
- **Tutorial **: :ref: `xfail `.
234
+ **Tutorial **: :ref: `xfail `
235
235
236
236
Marks a test function as *expected to fail *.
237
237
@@ -297,7 +297,7 @@ When :meth:`Node.iter_markers <_pytest.nodes.Node.iter_markers>` or :meth:`Node.
297
297
Fixtures
298
298
--------
299
299
300
- **Tutorial **: :ref: `fixture `.
300
+ **Tutorial **: :ref: `fixture `
301
301
302
302
Fixtures are requested by test functions or other fixtures by declaring them as argument names.
303
303
@@ -338,7 +338,7 @@ For more details, consult the full :ref:`fixtures docs <fixture>`.
338
338
config.cache
339
339
~~~~~~~~~~~~
340
340
341
- **Tutorial **: :ref: `cache `.
341
+ **Tutorial **: :ref: `cache `
342
342
343
343
The ``config.cache `` object allows other plugins and fixtures
344
344
to store and retrieve values across test runs. To access it from fixtures
@@ -358,7 +358,7 @@ Under the hood, the cache plugin uses the simple
358
358
capsys
359
359
~~~~~~
360
360
361
- : ref: `captures `.
361
+ ** Tutorial **: : ref: `captures `
362
362
363
363
.. autofunction :: _pytest.capture.capsys()
364
364
:no-auto-options:
@@ -383,7 +383,7 @@ capsys
383
383
capsysbinary
384
384
~~~~~~~~~~~~
385
385
386
- : ref: `captures `.
386
+ ** Tutorial **: : ref: `captures `
387
387
388
388
.. autofunction :: _pytest.capture.capsysbinary()
389
389
:no-auto-options:
@@ -405,7 +405,7 @@ capsysbinary
405
405
capfd
406
406
~~~~~~
407
407
408
- : ref: `captures `.
408
+ ** Tutorial **: : ref: `captures `
409
409
410
410
.. autofunction :: _pytest.capture.capfd()
411
411
:no-auto-options:
@@ -427,7 +427,7 @@ capfd
427
427
capfdbinary
428
428
~~~~~~~~~~~~
429
429
430
- : ref: `captures `.
430
+ ** Tutorial **: : ref: `captures `
431
431
432
432
.. autofunction :: _pytest.capture.capfdbinary()
433
433
:no-auto-options:
@@ -449,7 +449,7 @@ capfdbinary
449
449
doctest_namespace
450
450
~~~~~~~~~~~~~~~~~
451
451
452
- : ref: `doctest `.
452
+ ** Tutorial **: : ref: `doctest `
453
453
454
454
.. autofunction :: _pytest.doctest.doctest_namespace()
455
455
@@ -469,7 +469,7 @@ doctest_namespace
469
469
request
470
470
~~~~~~~
471
471
472
- : ref: `request example `.
472
+ ** Example **: : ref: `request example `
473
473
474
474
The ``request `` fixture is a special fixture providing information of the requesting test function.
475
475
@@ -490,7 +490,7 @@ pytestconfig
490
490
record_property
491
491
~~~~~~~~~~~~~~~~~~~
492
492
493
- **Tutorial **: :ref: `record_property example `.
493
+ **Tutorial **: :ref: `record_property example `
494
494
495
495
.. autofunction :: _pytest.junitxml.record_property()
496
496
@@ -500,7 +500,7 @@ record_property
500
500
record_testsuite_property
501
501
~~~~~~~~~~~~~~~~~~~~~~~~~
502
502
503
- **Tutorial **: :ref: `record_testsuite_property example `.
503
+ **Tutorial **: :ref: `record_testsuite_property example `
504
504
505
505
.. autofunction :: _pytest.junitxml.record_testsuite_property()
506
506
@@ -510,7 +510,7 @@ record_testsuite_property
510
510
caplog
511
511
~~~~~~
512
512
513
- : ref: `logging `.
513
+ ** Tutorial **: : ref: `logging `
514
514
515
515
.. autofunction :: _pytest.logging.caplog()
516
516
:no-auto-options:
@@ -526,7 +526,7 @@ caplog
526
526
monkeypatch
527
527
~~~~~~~~~~~
528
528
529
- : ref: `monkeypatching `.
529
+ ** Tutorial **: : ref: `monkeypatching `
530
530
531
531
.. autofunction :: _pytest.monkeypatch.monkeypatch()
532
532
:no-auto-options:
@@ -612,7 +612,7 @@ Each recorded warning is an instance of :class:`warnings.WarningMessage`.
612
612
tmp_path
613
613
~~~~~~~~
614
614
615
- :ref: `tmp_path `
615
+ ** Tutorial **: :ref: `tmp_path `
616
616
617
617
.. autofunction :: _pytest.tmpdir.tmp_path()
618
618
:no-auto-options:
@@ -623,7 +623,7 @@ tmp_path
623
623
tmp_path_factory
624
624
~~~~~~~~~~~~~~~~
625
625
626
- :ref: `tmp_path_factory example `
626
+ ** Tutorial **: :ref: `tmp_path_factory example `
627
627
628
628
.. _`tmp_path_factory factory api` :
629
629
@@ -638,7 +638,7 @@ tmp_path_factory
638
638
tmpdir
639
639
~~~~~~
640
640
641
- :ref: `tmpdir and tmpdir_factory `
641
+ ** Tutorial **: :ref: `tmpdir and tmpdir_factory `
642
642
643
643
.. autofunction :: _pytest.legacypath.LegacyTmpdirPlugin.tmpdir()
644
644
:no-auto-options:
@@ -649,7 +649,7 @@ tmpdir
649
649
tmpdir_factory
650
650
~~~~~~~~~~~~~~
651
651
652
- :ref: `tmpdir and tmpdir_factory `
652
+ ** Tutorial **: :ref: `tmpdir and tmpdir_factory `
653
653
654
654
``tmpdir_factory `` is an instance of :class: `~pytest.TempdirFactory `:
655
655
@@ -662,7 +662,7 @@ tmpdir_factory
662
662
Hooks
663
663
-----
664
664
665
- : ref: `writing-plugins `.
665
+ ** Tutorial **: : ref: `writing-plugins `
666
666
667
667
.. currentmodule :: _pytest.hookspec
668
668
0 commit comments