test_ok2/doc/mark.txt


.. _mark:

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

.. currentmodule:: _pytest.mark

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

* :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.


API reference for mark related objects
------------------------------------------------

.. autoclass:: MarkGenerator
    :members:

.. autoclass:: MarkDecorator
    :members:

.. autoclass:: MarkInfo
    :members:
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
flat is better than nested (cont'd): - pytest.py is new module, making "python -m pytest" work always - _pytest/*.py now contains core.py, hookspec and the plugins, no sub packages 2010-11-13 18:10:45 +08:00			`.. currentmodule:: _pytest.mark`
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
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
major refinements to documentation and examples --HG-- branch : trunk 2010-10-14 01:30:00 +08:00
select tests by call-id, add and refine documentation around it --HG-- branch : trunk 2010-10-13 18:26:14 +08:00			`API reference for mark related objects`
			`------------------------------------------------`
fix up install docs and plugin docs for the final release have CHANGELOG be a file containing links instead of a symlink beause it causes issues with pip-install on some systems. --HG-- branch : trunk 2009-11-06 00:46:14 +08:00
major refinements to documentation and examples --HG-- branch : trunk 2010-10-14 01:30:00 +08:00			`.. autoclass:: MarkGenerator`
			`:members:`

			`.. autoclass:: MarkDecorator`
			`:members:`

			`.. autoclass:: MarkInfo`
			`:members:`
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