floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove package scope experimental status 

Close #7389
This commit is contained in:
Bruno Oliveira 2020-06-27 11:16:50 -03:00
parent 7450b6dd95
commit 289197ff22
3 changed files with 18 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog/7389.trivial.rst Normal file
View File

@ -0,0 +1 @@
Fixture scope ``package`` is no longer considered experimental.

38
doc/en/fixture.rst
View File

@ -244,8 +244,8 @@ and `pytest-datafiles <https://pypi.org/project/pytest-datafiles/>`__.
.. _smtpshared:
Scope: sharing a fixture instance across tests in a class, module or session
----------------------------------------------------------------------------
Scope: sharing fixtures across classes, modules, packages or session
--------------------------------------------------------------------
.. regendoc:wipe
@ -356,29 +356,23 @@ instance, you can simply declare it:
# all tests needing it
...
Finally, the ``class`` scope will invoke the fixture once per test *class*.
Fixture scopes
^^^^^^^^^^^^^^
Fixtures are created when first requested by a test, and are destroyed based on their ``scope``:
* ``function``: the default scope, the fixture is destroyed at the end of the test.
* ``class``: the fixture is destroyed during teardown of the last test in the class.
* ``module``: the fixture is destroyed during teardown of the last test in the module.
* ``package``: the fixture is destroyed during teardown of the last test in the package.
* ``session``: the fixture is destroyed at the end of the test session.
.. note::
Pytest will only cache one instance of a fixture at a time.
This means that when using a parametrized fixture, pytest may invoke a fixture more than once in the given scope.
``package`` scope (experimental)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In pytest 3.7 the ``package`` scope has been introduced. Package-scoped fixtures
are finalized when the last test of a *package* finishes.
.. warning::
This functionality is considered **experimental** and may be removed in future
versions if hidden corner-cases or serious problems with this functionality
are discovered after it gets more usage in the wild.
Use this new feature sparingly and please make sure to report any issues you find.
Pytest only caches one instance of a fixture at a time, which
means that when using a parametrized fixture, pytest may invoke a fixture more than once in
the given scope.
.. _dynamic scope:

3
src/_pytest/fixtures.py
View File

@ -1274,8 +1274,7 @@ def fixture( # noqa: F811
:arg scope: the scope for which this fixture is shared, one of
``"function"`` (default), ``"class"``, ``"module"``,
``"package"`` or ``"session"`` (``"package"`` is considered **experimental**
at this time).
``"package"`` or ``"session"``.
This parameter may also be a callable which receives ``(fixture_name, config)``
as parameters, and must return a ``str`` with one of the values mentioned above.