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

Improve deprecation docs

This commit is contained in:
Bruno Oliveira 2024-04-20 10:11:47 -03:00
parent 7de869d8c2
commit 3ca329b968
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/en/deprecations.rst
View File

@ -27,15 +27,15 @@ Below is a complete list of all pytest features which are considered deprecated.
.. deprecated:: 8.2 .. deprecated:: 8.2
Traditionally :func:`pytest.importorskip` will capture :class:`ImportError`, with the original intent being to skip Traditionally :func:`pytest.importorskip` will capture :class:`ImportError`, with the original intent being to skip
tests where a dependent module is not installed, for example testing with different available dependencies. tests where a dependent module is not installed, for example testing with different dependencies.
However some packages might be installed in the system, but are not importable due to However some packages might be installed in the system, but are not importable due to
some other issue (e.g., a compilation error or a broken installation). In those cases :func:`pytest.importorskip` some other issue, for example, a compilation error or a broken installation. In those cases :func:`pytest.importorskip`
would still silently skip the test, but more often than not users would like to see the unexpected would still silently skip the test, but more often than not users would like to see the unexpected
error so the underlying issue can be fixed. error so the underlying issue can be fixed.
In ``8.2`` the ``exc_type`` parameter has been added, giving users the ability of passing :class:`ModuleNotFoundError` In ``8.2`` the ``exc_type`` parameter has been added, giving users the ability of passing :class:`ModuleNotFoundError`
to only skip tests only if the module cannot really be found, and not because of some other error. to skip tests only if the module cannot really be found, and not because of some other error.
Catching only :class:`ModuleNotFoundError` by default (and let other errors propagate) would be the best solution, Catching only :class:`ModuleNotFoundError` by default (and let other errors propagate) would be the best solution,
however for backward compatibility, pytest will keep the existing behavior but raise an warning if: however for backward compatibility, pytest will keep the existing behavior but raise an warning if:
@ -46,16 +46,13 @@ however for backward compatibility, pytest will keep the existing behavior but r
If the import attempt raises :class:`ModuleNotFoundError` (the usual case), then the module is skipped and no If the import attempt raises :class:`ModuleNotFoundError` (the usual case), then the module is skipped and no
warning is emitted. warning is emitted.
This will maintain the normal cases working the same way, while unexpected errors will now issue a warning. This way, the usual cases will keep working the same way, while unexpected errors will now issue a warning, with
Users can supress the warning by passing ``exc_type=ImportError`` explicitly. users being able to supress the warning by passing ``exc_type=ImportError`` explicitly.
In ``9.0``, the warning will turn into an error, and in ``9.1`` :func:`pytest.importorskip` will only capture In ``9.0``, the warning will turn into an error, and in ``9.1`` :func:`pytest.importorskip` will only capture
:class:`ModuleNotFoundError` by default and no warnings will be issued anymore -- but users can still capture :class:`ModuleNotFoundError` by default and no warnings will be issued anymore -- but users can still capture
:class:`ImportError` by passing it to ``exc_type``. :class:`ImportError` by passing it to ``exc_type``.
This roadmap should then be as little disruptive as possible: the intended case will continue to work as normal,
and the exceptional cases will issue a warning, while providing users with a escape hatch when needed.
.. _node-ctor-fspath-deprecation: .. _node-ctor-fspath-deprecation: