=========================
Removals
--------
- :issue:`2169`: ``pytest.mark.parametrize``: in previous versions, errors raised by id functions were suppressed and changed into warnings. Now the exceptions are propagated, along with a pytest message informing the node, parameter value and index where the exception occurred.
- :issue:`3078`: Remove legacy internal warnings system: ``config.warn``, ``Node.warn``. The ``pytest_logwarning`` now issues a warning when implemented.
See our :ref:`docs <config.warn and node.warn deprecated>` on information on how to update your code.
- :issue:`3079`: Removed support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated.
See our :ref:`docs <yield tests deprecated>` on information on how to update your code.
- :issue:`3082`: Removed support for applying marks directly to values in ``pytest.mark.parametrize``. Use ``pytest.param`` instead.
See our :ref:`docs <marks in pytest.parametrize deprecated>` on information on how to update your code.
- :issue:`3083`: Removed ``Metafunc.addcall``. This was the predecessor mechanism to ``pytest.mark.parametrize``.
See our :ref:`docs <metafunc.addcall deprecated>` on information on how to update your code.
- :issue:`3085`: Removed support for passing strings to ``pytest.main``. Now, always pass a list of strings instead.
See our :ref:`docs <passing command-line string to pytest.main deprecated>` on information on how to update your code.
- :issue:`3086`: ``[pytest]`` section in **setup.cfg** files is no longer supported, use ``[tool:pytest]`` instead. ``setup.cfg`` files
are meant for use with ``distutils``, and a section named ``pytest`` has notoriously been a source of conflicts and bugs.
Note that for **pytest.ini** and **tox.ini** files the section remains ``[pytest]``.
- :issue:`3616`: Removed the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now.
See our :ref:`docs <internal classes accessed through node deprecated>` on information on how to update your code.
- :issue:`4421`: Removed the implementation of the ``pytest_namespace`` hook.
See our :ref:`docs <pytest.namespace deprecated>` on information on how to update your code.
- :issue:`4489`: Removed ``request.cached_setup``. This was the predecessor mechanism to modern fixtures.
See our :ref:`docs <cached_setup deprecated>` on information on how to update your code.
- :issue:`4535`: Removed the deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago.
- :issue:`4543`: Removed support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``pytest.fixture`` decorator instead.
See our :ref:`docs <pytest_funcarg__ prefix deprecated>` on information on how to update your code.
- :issue:`4545`: Calling fixtures directly is now always an error instead of a warning.
See our :ref:`docs <calling fixtures directly deprecated>` on information on how to update your code.
- :issue:`4546`: Remove ``Node.get_marker(name)`` the return value was not usable for more than an existence check.
Use ``Node.get_closest_marker(name)`` as a replacement.
- :issue:`4547`: The deprecated ``record_xml_property`` fixture has been removed, use the more generic ``record_property`` instead.
See our :ref:`docs <record_xml_property deprecated>` for more information.
- :issue:`4548`: An error is now raised if the ``pytest_plugins`` variable is defined in a non-top-level ``conftest.py`` file (i.e., not residing in the ``rootdir``).
See our :ref:`docs <pytest_plugins in non-top-level conftest files deprecated>` for more information.
- :issue:`891`: Remove ``testfunction.markername`` attributes - use ``Node.iter_markers(name=None)`` to iterate them.
Deprecations
------------
- :issue:`3050`: Deprecated the ``pytest.config`` global.
See :ref:`pytest.config global deprecated` for rationale.
- :issue:`3974`: Passing the ``message`` parameter of ``pytest.raises`` now issues a ``DeprecationWarning``.
It is a common mistake to think this parameter will match the exception message, while in fact
it only serves to provide a custom message in case the ``pytest.raises`` check fails. To avoid this
mistake and because it is believed to be little used, pytest is deprecating it without providing
an alternative for the moment.
If you have concerns about this, please comment on :issue:`3974`.
- :issue:`4435`: Deprecated ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``.
See :std:ref:`raises-warns-exec` for rationale and examples.
Features
--------
- :issue:`3191`: A warning is now issued when assertions are made for ``None``.
This is a common source of confusion among new users, which write:
.. code-block:: python
assert mocked_object.assert_called_with(3, 4, 5, key="value")
When they should write:
.. code-block:: python
mocked_object.assert_called_with(3, 4, 5, key="value")
Because the ``assert_called_with`` method of mock objects already executes an assertion.
This warning will not be issued when ``None`` is explicitly checked. An assertion like:
.. code-block:: python
assert variable is None
will not issue the warning.
- :issue:`3632`: Richer equality comparison introspection on ``AssertionError`` for objects created using `attrs <https://www.attrs.org/en/stable/>`__ or :mod:`dataclasses` (Python 3.7+, :pypi:`backported to 3.6 <dataclasses>`).
- :issue:`4278`: ``CACHEDIR.TAG`` files are now created inside cache directories.
Those files are part of the `Cache Directory Tagging Standard <https://bford.info/cachedir/spec.html>`__, and can
be used by backup or synchronization programs to identify pytest's cache directory as such.
- :issue:`4292`: ``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``. This allows us to better handle ``pdb`` exiting.
- :issue:`4371`: Updated the ``--collect-only`` option to display test descriptions when ran using ``--verbose``.
- :issue:`4386`: Restructured ``ExceptionInfo`` object construction and ensure incomplete instances have a ``repr``/``str``.
- :issue:`4416`: pdb: added support for keyword arguments with ``pdb.set_trace``.
It handles ``header`` similar to Python 3.7 does it, and forwards any
other keyword arguments to the ``Pdb`` constructor.
This allows for ``__import__("pdb").set_trace(skip=["foo.*"])``.
- :issue:`4483`: Added ini parameter ``junit_duration_report`` to optionally report test call durations, excluding setup and teardown times.
The JUnit XML specification and the default pytest behavior is to include setup and teardown times in the test duration
report. You can include just the call durations instead (excluding setup and teardown) by adding this to your ``pytest.ini`` file:
.. code-block:: ini
[pytest]
junit_duration_report = call
- :issue:`4532`: ``-ra`` now will show errors and failures last, instead of as the first items in the summary.
This makes it easier to obtain a list of errors and failures to run tests selectively.
- :issue:`4599`: ``pytest.importorskip`` now supports a ``reason`` parameter, which will be shown when the
requested module cannot be imported.
Bug Fixes
---------
- :issue:`3532`: ``-p`` now accepts its argument without a space between the value, for example ``-pmyplugin``.
- :issue:`4327`: ``approx`` again works with more generic containers, more precisely instances of ``Iterable`` and ``Sized`` instead of more restrictive ``Sequence``.
- :issue:`4397`: Ensure that node ids are printable.
- :issue:`4435`: Fixed ``raises(..., 'code(string)')`` frame filename.
- :issue:`4458`: Display actual test ids in ``--collect-only``.
Improved Documentation
----------------------
- :issue:`4557`: Markers example documentation page updated to support latest pytest version.
- :issue:`4558`: Update cache documentation example to correctly show cache hit and miss.
- :issue:`4580`: Improved detailed summary report documentation.
Trivial/Internal Changes
------------------------
- :issue:`4447`: Changed the deprecation type of ``--result-log`` to ``PytestDeprecationWarning``.
It was decided to remove this feature at the next major revision.