test_ok2/doc/en/mark.rst


.. _mark:

Marking test functions with attributes
=================================================================


By using the ``pytest.mark`` helper you can easily set
metadata on your test functions. There are
some builtin markers, for example:

* :ref:`skip <skip>` - always skip a test function
* :ref:`skipif <skipif>` - skip a test function if a certain condition is met
* :ref:`xfail <xfail>` - produce an "expected failure" outcome if a certain
  condition is met
* :ref:`parametrize <parametrizemark>` to perform multiple calls
  to the same test function.

It's easy to create custom markers or to apply markers
to whole test classes or modules. See :ref:`mark examples` for examples
which also serve as documentation.

.. note::

    Marks can only be applied to tests, having no effect on
    :ref:`fixtures <fixtures>`.
refine naming, API and docs for py.test.mark mechanism - now contained in pytest_mark plugin --HG-- branch : trunk 2009-10-23 02:57:21 +08:00
start reorganizing docs, write more docs, shift plugin docs, to proper documentation, use sphinx, remove old docs ... work in progress. --HG-- branch : trunk 2010-10-11 05:45:45 +08:00			`.. _mark:`

Capitalised start of headlines, added -ing to a few headlines. 2011-09-06 17:43:42 +08:00			`Marking test functions with attributes`
select tests by call-id, add and refine documentation around it --HG-- branch : trunk 2010-10-13 18:26:14 +08:00			`=================================================================`
remove dist-testing and looponfail code from core. there remain some (pytest_runner particularly) tests that test both plain and dist modes which cannot be easily dis-entangled. food for thought. --HG-- branch : trunk 2010-01-13 23:00:33 +08:00
major refinements to documentation and examples --HG-- branch : trunk 2010-10-14 01:30:00 +08:00
improve mark.txt document and add new regristration/markers features. (welcome to documentation driven development) 2011-11-12 06:56:06 +08:00			By using the ``pytest.mark`` helper you can easily set
improve release announcement, shift and fix examples a bit. Bump version to 2.2.0 2011-11-19 02:32:11 +08:00			`metadata on your test functions. There are`
improve mark.txt document and add new regristration/markers features. (welcome to documentation driven development) 2011-11-12 06:56:06 +08:00			`some builtin markers, for example:`
refine naming, API and docs for py.test.mark mechanism - now contained in pytest_mark plugin --HG-- branch : trunk 2009-10-23 02:57:21 +08:00
Document which pytest features work with `unittest` Fix #2626 2017-08-04 09:00:11 +08:00			* :ref:`skip <skip>` - always skip a test function
introduce metafunc.parametrize() and @pytest.mark.parametrize with examples. deprecate metafunc.addcall() 2011-11-17 19:09:21 +08:00			* :ref:`skipif <skipif>` - skip a test function if a certain condition is met
			* :ref:`xfail <xfail>` - produce an "expected failure" outcome if a certain
improve mark.txt document and add new regristration/markers features. (welcome to documentation driven development) 2011-11-12 06:56:06 +08:00			`condition is met`
introduce metafunc.parametrize() and @pytest.mark.parametrize with examples. deprecate metafunc.addcall() 2011-11-17 19:09:21 +08:00			* :ref:`parametrize <parametrizemark>` to perform multiple calls
			`to the same test function.`
improve mark.txt document and add new regristration/markers features. (welcome to documentation driven development) 2011-11-12 06:56:06 +08:00
improve release announcement, shift and fix examples a bit. Bump version to 2.2.0 2011-11-19 02:32:11 +08:00			`It's easy to create custom markers or to apply markers`
			to whole test classes or modules. See :ref:`mark examples` for examples
			`which also serve as documentation.`
improve mark.txt document and add new regristration/markers features. (welcome to documentation driven development) 2011-11-12 06:56:06 +08:00
Add note that using marks on fixtures is not supported Fix #964 2015-08-28 07:11:07 +08:00			`.. note::`

			`Marks can only be applied to tests, having no effect on`
			:ref:`fixtures <fixtures>`.

major refinements to documentation and examples --HG-- branch : trunk 2010-10-14 01:30:00 +08:00