diff options
author | Bruno Oliveira <nicoddemus@gmail.com> | 2019-06-30 11:40:24 -0300 |
---|---|---|
committer | Bruno Oliveira <nicoddemus@gmail.com> | 2019-06-30 11:40:24 -0300 |
commit | 279733a30b700bc30848c4d4ff10f65c454e952b (patch) | |
tree | ae730054c58a49e7ea5da24c391e6689b56b2cd8 /doc/en/deprecations.rst | |
parent | be91c4d932820d9e8b69ce63b480dfbcc2e3fa33 (diff) | |
download | pytest-279733a30b700bc30848c4d4ff10f65c454e952b.tar.gz |
Remove support for 'code as string' from pytest.raises and pytest.warns
Diffstat (limited to 'doc/en/deprecations.rst')
-rw-r--r-- | doc/en/deprecations.rst | 46 |
1 files changed, 24 insertions, 22 deletions
diff --git a/doc/en/deprecations.rst b/doc/en/deprecations.rst index e2399dd41..344e1dd72 100644 --- a/doc/en/deprecations.rst +++ b/doc/en/deprecations.rst @@ -80,12 +80,35 @@ The ``pytest.config`` global object is deprecated. Instead use use the ``pytest_configure(config)`` hook. Note that many hooks can also access the ``config`` object indirectly, through ``session.config`` or ``item.config`` for example. + +Result log (``--result-log``) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. deprecated:: 4.0 + +The ``--result-log`` option produces a stream of test reports which can be +analysed at runtime. It uses a custom format which requires users to implement their own +parser, but the team believes using a line-based format that can be parsed using standard +tools would provide a suitable and better alternative. + +The current plan is to provide an alternative in the pytest 5.0 series and remove the ``--result-log`` +option in pytest 6.0 after the new implementation proves satisfactory to all users and is deemed +stable. + +The actual alternative is still being discussed in issue `#4488 <https://github.com/pytest-dev/pytest/issues/4488>`__. + +Removed Features +---------------- + +As stated in our :ref:`backwards-compatibility` policy, deprecated features are removed only in major releases after +an appropriate period of deprecation has passed. + .. _raises-warns-exec: ``raises`` / ``warns`` with a string as the second argument ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. deprecated:: 4.1 +.. versionremoved:: 5.0 Use the context manager form of these instead. When necessary, invoke ``exec`` directly. @@ -116,27 +139,6 @@ Becomes: -Result log (``--result-log``) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. deprecated:: 4.0 - -The ``--result-log`` option produces a stream of test reports which can be -analysed at runtime. It uses a custom format which requires users to implement their own -parser, but the team believes using a line-based format that can be parsed using standard -tools would provide a suitable and better alternative. - -The current plan is to provide an alternative in the pytest 5.0 series and remove the ``--result-log`` -option in pytest 6.0 after the new implementation proves satisfactory to all users and is deemed -stable. - -The actual alternative is still being discussed in issue `#4488 <https://github.com/pytest-dev/pytest/issues/4488>`__. - -Removed Features ----------------- - -As stated in our :ref:`backwards-compatibility` policy, deprecated features are removed only in major releases after -an appropriate period of deprecation has passed. Using ``Class`` in custom Collectors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |