p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reword the docs on markers a bit

This commit is contained in:
Bruno Oliveira 2018-04-05 12:39:21 -03:00 committed by GitHub
parent 1fcadeb2ce
commit 48bcc3419f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/en/mark.rst
View File

@ -26,17 +26,11 @@ which also serve as documentation.
:ref:`fixtures <fixtures>`.
.. currentmodule:: _pytest.mark.structures
.. autoclass:: Mark
:members:
.. `marker-iteration`
Marker iteration
@ -44,17 +38,13 @@ Marker iteration
.. versionadded:: 3.6
A new api to access markers was introduced in order to elevate the inherent design mistakes
which accumulated over the evolution of markers from simply updating the ``__dict__`` attribute of functions to something more powerful.
pytest's marker implementation traditionally worked by simply updating the ``__dict__`` attribute of functions to add markers, in a cumulative manner. As a result of the this, markers would unintendely be passed along class hierarchies in surprising ways plus the API for retriving them was inconsistent, as markers from parameterization would be stored differently than markers applied using the ``@pytest.mark`` decorator and markers added via ``node.add_marker``.
At the end of this evolution Markers would unintenedly pass along in class hierachies and the api for retriving them was inconsistent,
as markers from parameterization would store differently than markers from objects and markers added via ``node.add_marker``
This state of things made it technically next to impossible to use data from markers correctly (``args`` and ``kwargs``) without having a deep understanding of the internals, leading to subtle and hard to understand bugs in more advanced usages.
This in turnd made it technically next to impossible to use the data of markers correctly without having a deep understanding of the broken internals.
A new API to access markers has been introduced in pytest 3.6 in order to solve the problems with the initial design, providing :func:`_pytest.nodes.Node.iter_markers` method to iterate over markers in a consistent manner and reworking the internals, which solved great deal of problems with the initial design.
The new api is provides :func:`_pytest.nodes.Node.iter_markers` on :py:class:`_pytest.nodes.node` method to iterate over markers in a consistent manner.
.. warning::
.. note::
in a future major relase of pytest we will introduce class based markers,
at which points markers will no longer be limited to instances of :py:class:`Mark`