Docs: Fixtures page - clarify usage of module-level pytestmark.

It certainly wasn't clear to me that the variable assigned by
pytest.mark.usefixtures should also be called pytestmark,
so I was confused when::

  foo = pytest.mark.usefixtures('fixture_bar')

wasn't behaving as expected; correct usage is of course::

  pytestmark = pytest.mark.usefixtures('fixture_bar')

I assume this is by design, otherwise that's a separate issue, at
least current behaviour should be documented.
This commit is contained in:
Tim Staley 2015-09-25 14:54:03 +01:00
parent 7c5d2ea81d
commit eb2caa554c
1 changed files with 6 additions and 3 deletions

View File

@ -243,7 +243,7 @@ instance, you can simply declare it:
.. _`finalization`: .. _`finalization`:
fixture finalization / executing teardown code Fixture finalization / executing teardown code
------------------------------------------------------------- -------------------------------------------------------------
pytest supports execution of fixture specific finalization code pytest supports execution of fixture specific finalization code
@ -630,7 +630,7 @@ before the ``mod2`` resource was setup.
.. _`usefixtures`: .. _`usefixtures`:
using fixtures from classes, modules or projects Using fixtures from classes, modules or projects
---------------------------------------------------------------------- ----------------------------------------------------------------------
.. regendoc:wipe .. regendoc:wipe
@ -692,6 +692,9 @@ a generic feature of the mark mechanism:
pytestmark = pytest.mark.usefixtures("cleandir") pytestmark = pytest.mark.usefixtures("cleandir")
Note that the assigned variable *must* be called ``pytestmark``, assigning e.g.
``foomark`` will not activate the fixtures.
Lastly you can put fixtures required by all tests in your project Lastly you can put fixtures required by all tests in your project
into an ini-file: into an ini-file:
@ -705,7 +708,7 @@ into an ini-file:
.. _`autouse`: .. _`autouse`:
.. _`autouse fixtures`: .. _`autouse fixtures`:
autouse fixtures (xUnit setup on steroids) Autouse fixtures (xUnit setup on steroids)
---------------------------------------------------------------------- ----------------------------------------------------------------------
.. regendoc:wipe .. regendoc:wipe