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

Merge pull request #4037 from nicoddemus/deprecate-item-warnings-captured-hook 

Document that item parameter of pytest_warning_captured hook is deprecated
This commit is contained in:
Ronny Pfannschmidt 2018-09-27 13:20:26 +02:00 committed by GitHub
parent 783019a8e6 1636522563
commit 3c23b5b010
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
changelog/4036.removal.rst Normal file
View File

@ -0,0 +1,9 @@
The ``item`` parameter of ``pytest_warning_captured`` hook is now documented as deprecated. We realized only after
the ``3.8`` release that this parameter is incompatible with ``pytest-xdist``.
Our policy is to not deprecate features during bugfix releases, but in this case we believe it makes sense as we are
only documenting it as deprecated, without issuing warnings which might potentially break test suites. This will get
the word out that hook implementers should not use this parameter at all.
In a future release ``item`` will always be ``None`` and will emit a proper warning when a hook implementation
makes use of it.

3
src/_pytest/hookspec.py
View File

@ -562,6 +562,9 @@ def pytest_warning_captured(warning_message, when, item):
* ``"runtest"``: during test execution. * ``"runtest"``: during test execution.
:param pytest.Item|None item: :param pytest.Item|None item:
**DEPRECATED**: This parameter is incompatible with ``pytest-xdist``, and will always receive ``None``
in a future release.
The item being executed if ``when`` is ``"runtest"``, otherwise ``None``. The item being executed if ``when`` is ``"runtest"``, otherwise ``None``.
""" """