Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pytest to 6.2.3 #28787

wants to merge 1 commit into from


Copy link

@pyup-bot pyup-bot commented May 3, 2021

This PR updates pytest from 4.6.11 to 6.2.3.




Bug Fixes

- `8152 <>`_: Fixed "(<Skipped instance>)" being shown as a skip reason in the verbose test summary line when the reason is empty.

- `8249 <>`_: Fix the ``faulthandler`` plugin for occasions when running with ``twisted.logger`` and using ``pytest --capture=no``.



Bug Fixes

- `7678 <>`_: Fixed bug where ``ImportPathMismatchError`` would be raised for files compiled in
the host and loaded later from an UNC mounted path (Windows).

- `8132 <>`_: Fixed regression in ``approx``: in 6.2.0 ``approx`` no longer raises
``TypeError`` when dealing with non-numeric types, falling back to normal comparison.
Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case,
and happened to compare correctly to a scalar if they had only one element.
After 6.2.0, these types began failing, because they inherited neither from
standard Python number hierarchy nor from ``numpy.ndarray``.

``approx`` now converts arguments to ``numpy.ndarray`` if they expose the array
protocol and are not scalars. This treats array-like objects like numpy arrays,
regardless of size.



Breaking Changes

- `7808 <>`_: pytest now supports python3.6+ only.


- `7469 <>`_: Directly constructing/calling the following classes/functions is now deprecated:

- ``_pytest.cacheprovider.Cache``
- ``_pytest.cacheprovider.Cache.for_config()``
- ``_pytest.cacheprovider.Cache.clear_cache()``
- ``_pytest.cacheprovider.Cache.cache_dir_from_config()``
- ``_pytest.capture.CaptureFixture``
- ``_pytest.fixtures.FixtureRequest``
- ``_pytest.fixtures.SubRequest``
- ``_pytest.logging.LogCaptureFixture``
- ``_pytest.pytester.Pytester``
- ``_pytest.pytester.Testdir``
- ``_pytest.recwarn.WarningsRecorder``
- ``_pytest.recwarn.WarningsChecker``
- ``_pytest.tmpdir.TempPathFactory``
- ``_pytest.tmpdir.TempdirFactory``

These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 7.0.0.

- `7530 <>`_: The ``--strict`` command-line option has been deprecated, use ``--strict-markers`` instead.

We have plans to maybe in the future to reintroduce ``--strict`` and make it an encompassing flag for all strictness
related options (``--strict-markers`` and ``--strict-config`` at the moment, more might be introduced in the future).

- `7988 <>`_: The ``pytest.yield_fixture`` decorator/function is now deprecated. Use :func:`pytest.fixture` instead.

``yield_fixture`` has been an alias for ``fixture`` for a very long time, so can be search/replaced safely.


- `5299 <>`_: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8.
See :ref:`unraisable` for more information.

- `7425 <>`_: New :fixture:`pytester` fixture, which is identical to :fixture:`testdir` but its methods return :class:`pathlib.Path` when appropriate instead of ``py.path.local``.

This is part of the movement to use :class:`pathlib.Path` objects internally, in order to remove the dependency to ``py`` in the future.

Internally, the old :class:`Testdir <_pytest.pytester.Testdir>` is now a thin wrapper around :class:`Pytester <_pytest.pytester.Pytester>`, preserving the old interface.

- `7695 <>`_: A new hook was added, `pytest_markeval_namespace` which should return a dictionary.
This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers.

Pseudo example


.. code-block:: python

  def pytest_markeval_namespace():
      return {"color": "red"}


.. code-block:: python

  pytest.mark.skipif("color == 'blue'", reason="Color is not red")
  def test_func():
      assert False

- `8006 <>`_: It is now possible to construct a :class:`~pytest.MonkeyPatch` object directly as ``pytest.MonkeyPatch()``,
in cases when the :fixture:`monkeypatch` fixture cannot be used. Previously some users imported it
from the private `_pytest.monkeypatch.MonkeyPatch` namespace.

Additionally, :meth:`MonkeyPatch.context <pytest.MonkeyPatch.context>` is now a classmethod,
and can be used as ``with MonkeyPatch.context() as mp: ...``. This is the recommended way to use
``MonkeyPatch`` directly, since unlike the ``monkeypatch`` fixture, an instance created directly
is not ``undo()``-ed automatically.


- `1265 <>`_: Added an ``__str__`` implementation to the :class:`~pytest.pytester.LineMatcher` class which is returned from ``pytester.run_pytest().stdout`` and similar. It returns the entire output, like the existing ``str()`` method.

- `2044 <>`_: Verbose mode now shows the reason that a test was skipped in the test's terminal line after the "SKIPPED", "XFAIL" or "XPASS".

- `7469 <>`_ The types of builtin pytest fixtures are now exported so they may be used in type annotations of test functions.
The newly-exported types are:

- ``pytest.FixtureRequest`` for the :fixture:`request` fixture.
- ``pytest.Cache`` for the :fixture:`cache` fixture.
- ``pytest.CaptureFixture[str]`` for the :fixture:`capfd` and :fixture:`capsys` fixtures.
- ``pytest.CaptureFixture[bytes]`` for the :fixture:`capfdbinary` and :fixture:`capsysbinary` fixtures.
- ``pytest.LogCaptureFixture`` for the :fixture:`caplog` fixture.
- ``pytest.Pytester`` for the :fixture:`pytester` fixture.
- ``pytest.Testdir`` for the :fixture:`testdir` fixture.
- ``pytest.TempdirFactory`` for the :fixture:`tmpdir_factory` fixture.
- ``pytest.TempPathFactory`` for the :fixture:`tmp_path_factory` fixture.
- ``pytest.MonkeyPatch`` for the :fixture:`monkeypatch` fixture.
- ``pytest.WarningsRecorder`` for the :fixture:`recwarn` fixture.

Constructing them is not supported (except for `MonkeyPatch`); they are only meant for use in type annotations.
Doing so will emit a deprecation warning, and may become a hard-error in pytest 7.0.

Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.

- `7527 <>`_: When a comparison between :func:`namedtuple <collections.namedtuple>` instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes.

- `7615 <>`_: :meth:`Node.warn <_pytest.nodes.Node.warn>` now permits any subclass of :class:`Warning`, not just :class:`PytestWarning <pytest.PytestWarning>`.

- `7701 <>`_: Improved reporting when using ``--collected-only``. It will now show the number of collected tests in the summary stats.

- `7710 <>`_: Use strict equality comparison for non-numeric types in :func:`pytest.approx` instead of
raising :class:`TypeError`.

This was the undocumented behavior before 3.7, but is now officially a supported feature.

- `7938 <>`_: New ``--sw-skip`` argument which is a shorthand for ``--stepwise-skip``.

- `8023 <>`_: Added ``'node_modules'`` to default value for :confval:`norecursedirs`.

- `8032 <>`_: :meth:`doClassCleanups <unittest.TestCase.doClassCleanups>` (introduced in :mod:`unittest` in Python and 3.8) is now called appropriately.

Bug Fixes

- `4824 <>`_: Fixed quadratic behavior and improved performance of collection of items using autouse fixtures and xunit fixtures.

- `7758 <>`_: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0.

- `7911 <>`_: Directories created by by :fixture:`tmp_path` and :fixture:`tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.

- `7913 <>`_: Fixed a crash or hang in :meth:`pytester.spawn <_pytest.pytester.Pytester.spawn>` when the :mod:`readline` module is involved.

- `7951 <>`_: Fixed handling of recursive symlinks when collecting tests.

- `7981 <>`_: Fixed symlinked directories not being followed during collection. Regressed in pytest 6.1.0.

- `8016 <>`_: Fixed only one doctest being collected when using ``pytest --doctest-modules path/to/an/``.

Improved Documentation

- `7429 <>`_: Add more information and use cases about skipping doctests.

- `7780 <>`_: Classes which should not be inherited from are now marked ``final class`` in the API reference.

- `7872 <>`_: ``_pytest.config.argparsing.Parser.addini()`` accepts explicit ``None`` and ``"string"``.

- `7878 <>`_: In pull request section, ask to commit after editing changelog and authors file.

Trivial/Internal Changes

- `7802 <>`_: The ``attrs`` dependency requirement is now >=19.2.0 instead of >=17.4.0.

- `8014 <>`_: `.pyc` files created by pytest's assertion rewriting now conform to the newer PEP-552 format on Python>=3.7.
(These files are internal and only interpreted by pytest itself.)



Bug Fixes

- `7758 <>`_: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0.

- `7911 <>`_: Directories created by `tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.

Improved Documentation

- `7815 <>`_: Improve deprecation warning message for ``pytest._fillfuncargs()``.



Bug Fixes

- `7807 <>`_: Fixed regression in pytest 6.1.0 causing incorrect rootdir to be determined in some non-trivial cases where parent directories have config files as well.

- `7814 <>`_: Fixed crash in header reporting when :confval:`testpaths` is used and contains absolute paths (regression in 6.1.0).



Breaking Changes

- `5585 <>`_: As per our policy, the following features which have been deprecated in the 5.X series are now

* The ``funcargnames`` read-only property of ``FixtureRequest``, ``Metafunc``, and ``Function`` classes. Use ``fixturenames`` attribute.

* ``pytest.fixture`` no longer supports positional arguments, pass all arguments by keyword instead.

* Direct construction of ``Node`` subclasses now raise an error, use ``from_parent`` instead.

* The default value for ``junit_family`` has changed to ``xunit2``. If you require the old format, add ``junit_family=xunit1`` to your configuration file.

* The ``TerminalReporter`` no longer has a ``writer`` attribute. Plugin authors may use the public functions of the ``TerminalReporter`` instead of accessing the ``TerminalWriter`` object directly.

* The ``--result-log`` option has been removed. Users are recommended to use the `pytest-reportlog <>`__ plugin instead.

For more information consult
`Deprecations and Removals <>`__ in the docs.


- `6981 <>`_: The ``pytest.collect`` module is deprecated: all its names can be imported from ``pytest`` directly.

- `7097 <>`_: The ``pytest._fillfuncargs`` function is deprecated. This function was kept
for backward compatibility with an older plugin.

It's functionality is not meant to be used directly, but if you must replace
it, use `function._request._fillfixtures()` instead, though note this is not
a public API and may break in the future.

- `7210 <>`_: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'``

The special ``-k 'expr:'`` syntax to ``-k`` is deprecated. Please open an issue
if you use this and want a replacement.

- `7255 <>`_: The :func:`pytest_warning_captured <_pytest.hookspec.pytest_warning_captured>` hook is deprecated in favor
of :func:`pytest_warning_recorded <_pytest.hookspec.pytest_warning_recorded>`, and will be removed in a future version.

- `7648 <>`_: The ``gethookproxy()`` and ``isinitpath()`` methods of ``FSCollector`` and ``Package`` are deprecated;
use ``self.session.gethookproxy()`` and ``self.session.isinitpath()`` instead.
This should work on all pytest versions.


- `7667 <>`_: New ``--durations-min`` command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by ``--durations``. Previously this was hard-coded to ``0.005s``.


- `6681 <>`_: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through :confval:`filterwarnings` or ``--pythonwarnings/-W``.

This also fixes a number of long standing issues: `2891 <>`__, `#7620 <>`__, `#7426 <>`__.

- `7572 <>`_: When a plugin listed in ``required_plugins`` is missing or an unknown config key is used with ``--strict-config``, a simple error message is now shown instead of a stacktrace.

- `7685 <>`_: Added two new attributes :attr:`rootpath <_pytest.config.Config.rootpath>` and :attr:`inipath <_pytest.config.Config.inipath>` to :class:`Config <_pytest.config.Config>`.
These attributes are :class:`pathlib.Path` versions of the existing :attr:`rootdir <_pytest.config.Config.rootdir>` and :attr:`inifile <_pytest.config.Config.inifile>` attributes,
and should be preferred over them when possible.

- `7780 <>`_: Public classes which are not designed to be inherited from are now marked `final <>`_.
Code which inherits from these classes will trigger a type-checking (e.g. mypy) error, but will still work in runtime.
Currently the ``final`` designation does not appear in the API Reference but hopefully will in the future.

Bug Fixes

- `1953 <>`_: Fixed error when overwriting a parametrized fixture, while also reusing the super fixture value.

.. code-block:: python
   import pytest

   pytest.fixture(params=[1, 2])
   def foo(request):
       return request.param
   import pytest

   def foo(foo):
       return foo * 2

- `4984 <>`_: Fixed an internal error crash with ``IndexError: list index out of range`` when
collecting a module which starts with a decorated function, the decorator
raises, and assertion rewriting is enabled.

- `7591 <>`_: pylint shouldn't complain anymore about unimplemented abstract methods when inheriting from :ref:`File <non-python tests>`.

- `7628 <>`_: Fixed test collection when a full path without a drive letter was passed to pytest on Windows (for example ``\projects\tests\`` instead of ``c:\projects\tests\``).

- `7638 <>`_: Fix handling of command-line options that appear as paths but trigger an OS-level syntax error on Windows, such as the options used internally by ``pytest-xdist``.

- `7742 <>`_: Fixed INTERNALERROR when accessing locals / globals with faulty ``exec``.

Improved Documentation

- `1477 <>`_: Removed faq.rst and its reference in contents.rst.

Trivial/Internal Changes

- `7536 <>`_: The internal ``junitxml`` plugin has rewritten to use ``xml.etree.ElementTree``.
The order of attributes in XML elements might differ. Some unneeded escaping is
no longer performed.

- `7587 <>`_: The dependency on the ``more-itertools`` package has been removed.

- `7631 <>`_: The result type of :meth:`capfd.readouterr() <_pytest.capture.CaptureFixture.readouterr>` (and similar) is no longer a namedtuple,
but should behave like one in all respects. This was done for technical reasons.

- `7671 <>`_: When collecting tests, pytest finds test classes and functions by examining the
attributes of python objects (modules, classes and instances). To speed up this
process, pytest now ignores builtin attributes (like ``__class__``,
``__delattr__`` and ``__new__``) without consulting the :confval:`python_classes` and
:confval:`python_functions` configuration options and without passing them to plugins
using the :func:`pytest_pycollect_makeitem <_pytest.hookspec.pytest_pycollect_makeitem>` hook.



Bug Fixes

- `7148 <>`_: Fixed ``--log-cli`` potentially causing unrelated ``print`` output to be swallowed.

- `7672 <>`_: Fixed log-capturing level restored incorrectly if ``caplog.set_level`` is called more than once.

- `7686 <>`_: Fixed `NotSetType.token` being used as the parameter ID when the parametrization list is empty.
Regressed in pytest 6.0.0.

- `7707 <>`_: Fix internal error when handling some exceptions that contain multiple lines or the style uses multiple lines (``--tb=line`` for example).



Bug Fixes

- `7394 <>`_: Passing an empty ``help`` value to ``Parser.add_option`` is now accepted instead of crashing when running ``pytest --help``.
Passing ``None`` raises a more informative ``TypeError``.

- `7558 <>`_: Fix pylint ``not-callable`` lint on ``pytest.mark.parametrize()`` and the other builtin marks:
``skip``, ``skipif``, ``xfail``, ``usefixtures``, ``filterwarnings``.

- `7559 <>`_: Fix regression in plugins using ``TestReport.longreprtext`` (such as ``pytest-html``) when ``TestReport.longrepr`` is not a string.

- `7569 <>`_: Fix logging capture handler's level not reset on teardown after a call to ``caplog.set_level()``.



(**Please see the full set of changes for this release also in the 6.0.0rc1 notes below**)

Breaking Changes

- `5584 <>`_: **PytestDeprecationWarning are now errors by default.**

Following our plan to remove deprecated features with as little disruption as
possible, all warnings of type ``PytestDeprecationWarning`` now generate errors
instead of warning messages.

**The affected features will be effectively removed in pytest 6.1**, so please consult the
`Deprecations and Removals <>`__
section in the docs for directions on how to update existing code.

In the pytest ``6.0.X`` series, it is possible to change the errors back into warnings as a
stopgap measure by adding this to your ``pytest.ini`` file:

.. code-block:: ini

   filterwarnings =

But this will stop working when pytest ``6.1`` is released.

**If you have concerns** about the removal of a specific feature, please add a
comment to `5584 <>`__.

- `7472 <>`_: The ``exec_()`` and ``is_true()`` methods of ``_pytest._code.Frame`` have been removed.


- `7464 <>`_: Added support for :envvar:`NO_COLOR` and :envvar:`FORCE_COLOR` environment variables to control colored output.


- `7467 <>`_: ``--log-file`` CLI option and ``log_file`` ini marker now create subdirectories if needed.

- `7489 <>`_: The :func:`pytest.raises` function has a clearer error message when ``match`` equals the obtained string but is not a regex match. In this case it is suggested to escape the regex.

Bug Fixes

- `7392 <>`_: Fix the reported location of tests skipped with ``pytest.mark.skip`` when ``--runxfail`` is used.

- `7491 <>`_: :fixture:`tmpdir` and :fixture:`tmp_path` no longer raise an error if the lock to check for
stale temporary directories is not accessible.

- `7517 <>`_: Preserve line endings when captured via ``capfd``.

- `7534 <>`_: Restored the previous formatting of ``TracebackEntry.__str__`` which was changed by accident.

Improved Documentation

- `7422 <>`_: Clarified when the ``usefixtures`` mark can apply fixtures to test.

- `7441 <>`_: Add a note about ``-q`` option used in getting started guide.

Trivial/Internal Changes

- `7389 <>`_: Fixture scope ``package`` is no longer considered experimental.



Breaking Changes

- `1316 <>`_: ``TestReport.longrepr`` is now always an instance of ``ReprExceptionInfo``. Previously it was a ``str`` when a test failed with ``, pytrace=False)``.

- `5965 <>`_: symlinks are no longer resolved during collection and matching `` files with test file paths.

Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms.

The team decided to step back on resolving symlinks at all, planning to review this in the future with a more solid solution (see discussion in
`6523 <>`__ for details).

This might break test suites which made use of this feature; the fix is to create a symlink
for the entire test tree, and not only to partial files/tress as it was possible previously.

- `6505 <>`_: ```` now always returns the parsed nouns in plural form.

Originally ``parseoutcomes()`` would always returns the nouns in plural form, but a change
meant to improve the terminal summary by using singular form single items (``1 warning`` or ``1 error``)
caused an unintended regression by changing the keys returned by ``parseoutcomes()``.

Now the API guarantees to always return the plural form, so calls like this:

.. code-block:: python

   result = testdir.runpytest()

Need to be changed to:

.. code-block:: python

   result = testdir.runpytest()

- `6903 <>`_: The ``os.dup()`` function is now assumed to exist. We are not aware of any
supported Python 3 implementations which do not provide it.

- `7040 <>`_: ``-k`` no longer matches against the names of the directories outside the test session root.

Also, ```` is now just the name of the directory containing the package's
```` file, instead of the full path. This is consistent with how the other nodes
are named, and also one of the reasons why ``-k`` would match against any directory containing
the test suite.

- `7122 <>`_: Expressions given to the ``-m`` and ``-k`` options are no longer evaluated using Python's :func:`eval`.
The format supports ``or``, ``and``, ``not``, parenthesis and general identifiers to match against.
Python constants, keywords or other operators are no longer evaluated differently.

- `7135 <>`_: Pytest now uses its own ``TerminalWriter`` class instead of using the one from the ``py`` library.
Plugins generally access this class through ``TerminalReporter.writer``, ``TerminalReporter.write()``
(and similar methods), or ``_pytest.config.create_terminal_writer()``.

The following breaking changes were made:

- Output (``write()`` method and others) no longer flush implicitly; the flushing behavior
 of the underlying file is respected. To flush explicitly (for example, if you
 want output to be shown before an end-of-line is printed), use ``write(flush=True)`` or
- Explicit Windows console support was removed, delegated to the colorama library.
- Support for writing ``bytes`` was removed.
- The ``reline`` method and ``chars_on_current_line`` property were removed.
- The ``stringio`` and ``encoding`` arguments was removed.
- Support for passing a callable instead of a file was removed.

- `7224 <>`_: The `item.catch_log_handler` and `item.catch_log_handlers` attributes, set by the
logging plugin and never meant to be public, are no longer available.

The deprecated ``--no-print-logs`` option and ``log_print`` ini option are removed. Use ``--show-capture`` instead.

- `7226 <>`_: Removed the unused ``args`` parameter from ``pytest.Function.__init__``.

- `7418 <>`_: Removed the `pytest_doctest_prepare_content` hook specification. This hook
hasn't been triggered by pytest for at least 10 years.

- `7438 <>`_: Some changes were made to the internal ``_pytest._code.source``, listed here
for the benefit of plugin authors who may be using it:

- The ``deindent`` argument to ``Source()`` has been removed, now it is always true.
- Support for zero or multiple arguments to ``Source()`` has been removed.
- Support for comparing ``Source`` with an ``str`` has been removed.
- The methods ``Source.isparseable()`` and ``Source.putaround()`` have been removed.
- The method ``Source.compile()`` and function ``_pytest._code.compile()`` have
 been removed; use plain ``compile()`` instead.
- The function ``_pytest._code.source.getsource()`` has been removed; use
 ``Source()`` directly instead.


- `7210 <>`_: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'``

The special ``-k 'expr:'`` syntax to ``-k`` is deprecated. Please open an issue
if you use this and want a replacement.

- `4049 <>`_: ``pytest_warning_captured`` is deprecated in favor of the ``pytest_warning_recorded`` hook.


- `1556 <>`_: pytest now supports ``pyproject.toml`` files for configuration.

The configuration options is similar to the one available in other formats, but must be defined
in a ``[tool.pytest.ini_options]`` table to be picked up by pytest:

.. code-block:: toml

   minversion = "6.0"
   addopts = "-ra -q"
   testpaths = [

More information can be found `in the docs <>`__.

- `3342 <>`_: pytest now includes inline type annotations and exposes them to user programs.
Most of the user-facing API is covered, as well as internal code.

If you are running a type checker such as mypy on your tests, you may start
noticing type errors indicating incorrect usage. If you run into an error that
you believe to be incorrect, please let us know in an issue.

The types were developed against mypy version 0.780. Versions before 0.750
are known not to work. We recommend using the latest version. Other type
checkers may work as well, but they are not officially verified to work by
pytest yet.

- `4049 <>`_: Introduced a new hook named `pytest_warning_recorded` to convey information about warnings captured by the internal `pytest` warnings plugin.

This hook is meant to replace `pytest_warning_captured`, which is deprecated and will be removed in a future release.

- `6471 <>`_: New command-line flags:

* `--no-header`: disables the initial header, including platform, version, and plugins.
* `--no-summary`: disables the final test summary, including warnings.

- `6856 <>`_: A warning is now shown when an unknown key is read from a config INI file.

The `--strict-config` flag has been added to treat these warnings as errors.

- `6906 <>`_: Added `--code-highlight` command line option to enable/disable code highlighting in terminal output.

- `7245 <>`_: New ``--import-mode=importlib`` option that uses `importlib <>`__ to import test modules.

Traditionally pytest used ``__import__`` while changing ``sys.path`` to import test modules (which
also changes ``sys.modules`` as a side-effect), which works but has a number of drawbacks, like requiring test modules
that don't live in packages to have unique names (as they need to reside under a unique name in ``sys.modules``).

``--import-mode=importlib`` uses more fine grained import mechanisms from ``importlib`` which don't
require pytest to change ``sys.path`` or ``sys.modules`` at all, eliminating much of the drawbacks
of the previous mode.

We intend to make ``--import-mode=importlib`` the default in future versions, so users are encouraged
to try the new mode and provide feedback (both positive or negative) in issue `7245 <>`__.

You can read more about this option in `the documentation <>`__.

- `7305 <>`_: New ``required_plugins`` configuration option allows the user to specify a list of plugins, including version information, that are required for pytest to run. An error is raised if any required plugins are not found when running pytest.


- `4375 <>`_: The ``pytest`` command now suppresses the ``BrokenPipeError`` error message that
is printed to stderr when the output of ``pytest`` is piped and and the pipe is
closed by the piped-to program (common examples are ``less`` and ``head``).

- `4391 <>`_: Improved precision of test durations measurement. ``CallInfo`` items now have a new ``<CallInfo>.duration`` attribute, created using ``time.perf_counter()``. This attribute is used to fill the ``<TestReport>.duration`` attribute, which is more accurate than the previous ``<CallInfo>.stop - <CallInfo>.start`` (as these are based on ``time.time()``).

- `4675 <>`_: Rich comparison for dataclasses and `attrs`-classes is now recursive.

- `6285 <>`_: Exposed the `pytest.FixtureLookupError` exception which is raised by `request.getfixturevalue()`
(where `request` is a `FixtureRequest` fixture) when a fixture with the given name cannot be returned.

- `6433 <>`_: If an error is encountered while formatting the message in a logging call, for
example ``logging.warning("oh no!: %s: %s", "first")`` (a second argument is
missing), pytest now propagates the error, likely causing the test to fail.

Previously, such a mistake would cause an error to be printed to stderr, which
is not displayed by default for passing tests. This change makes the mistake
visible during testing.

You may supress this behavior temporarily or permanently by setting
``logging.raiseExceptions = False``.

- `6817 <>`_: Explicit new-lines in help texts of command-line options are preserved, allowing plugins better control
of the help displayed to users.

- `6940 <>`_: When using the ``--duration`` option, the terminal message output is now more precise about the number and duration of hidden items.

- `6991 <>`_: Collected files are displayed after any reports from hooks, e.g. the status from ``--lf``.

- `7091 <>`_: When ``fd`` capturing is used, through ``--capture=fd`` or the ``capfd`` and
``capfdbinary`` fixtures, and the file descriptor (0, 1, 2) cannot be
duplicated, FD capturing is still performed. Previously, direct writes to the
file descriptors would fail or be lost in this case.

- `7119 <>`_: Exit with an error if the ``--basetemp`` argument is empty, is the current working directory or is one of the parent directories.
This is done to protect against accidental data loss, as any directory passed to this argument is cleared.

- `7128 <>`_: `pytest --version` now displays just the pytest version, while `pytest --version --version` displays more verbose information including plugins. This is more consistent with how other tools show `--version`.

- `7133 <>`_: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` will now override any :confval:`log_level` set via the CLI or configuration file.

- `7159 <>`_: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` and :meth:`caplog.at_level() <_pytest.logging.LogCaptureFixture.at_level>` no longer affect
the level of logs that are shown in the *Captured log report* report section.

- `7348 <>`_: Improve recursive diff report for comparison asserts on dataclasses / attrs.

- `7385 <>`_: ``--junitxml`` now includes the exception cause in the ``message`` XML attribute for failures during setup and teardown.


.. code-block:: xml

   <error message="test setup failure">


.. code-block:: xml

   <error message="failed on setup with "ValueError: Some error during setup"">

Bug Fixes

- `1120 <>`_: Fix issue where directories from :fixture:`tmpdir` are not removed properly when multiple instances of pytest are running in parallel.

- `4583 <>`_: Prevent crashing and provide a user-friendly error when a marker expression (`-m`) invoking of :func:`eval` raises any exception.

- `4677 <>`_: The path shown in the summary report for SKIPPED tests is now always relative. Previously it was sometimes absolute.

- `5456 <>`_: Fix a possible race condition when trying to remove lock files used to control access to folders
created by :fixture:`tmp_path` and :fixture:`tmpdir`.

- `6240 <>`_: Fixes an issue where logging during collection step caused duplication of log
messages to stderr.

- `6428 <>`_: Paths appearing in error messages are now correct in case the current working directory has
changed since the start of the session.

- `6755 <>`_: Support deleting paths longer than 260 characters on windows created inside :fixture:`tmpdir`.

- `6871 <>`_: Fix crash with captured output when using :fixture:`capsysbinary`.

- `6909 <>`_: Revert the change introduced by `#6330 <>`_, which required all arguments to ``pytest.mark.parametrize`` to be explicitly defined in the function signature.

The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.

- `6910 <>`_: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option.

- `6924 <>`_: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited.

- `6925 <>`_: Fix `TerminalRepr` instances to be hashable again.

- `6947 <>`_: Fix regression where functions registered with :meth:`unittest.TestCase.addCleanup` were not being called on test failures.

- `6951 <>`_: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute.

- `6956 <>`_: Prevent pytest from printing `ConftestImportFailure` traceback to stdout.

- `6991 <>`_: Fix regressions with `--lf` filtering too much since pytest 5.4.

- `6992 <>`_: Revert "tmpdir: clean up indirection via config for factories" `#6767 <>`_ as it breaks pytest-xdist.

- `7061 <>`_: When a yielding fixture fails to yield a value, report a test setup error instead of crashing.

- `7076 <>`_: The path of file skipped by ``pytest.mark.skip`` in the SKIPPED report is now relative to invocation directory. Previously it was relative to root directory.

- `7110 <>`_: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again.

- `7126 <>`_: ``--setup-show`` now doesn't raise an error when a bytes value is used as a ``parametrize``
parameter when Python is called with the ``-bb`` flag.

- `7143 <>`_: Fix :meth:`pytest.File.from_parent` so it forwards extra keyword arguments to the constructor.

- `7145 <>`_: Classes with broken ``__getattribute__`` methods are displayed correctly during failures.

- `7150 <>`_: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised.

- `7180 <>`_: Fix ``_is_setup_py`` for files encoded differently than locale.

- `7215 <>`_: Fix regression where running with ``--pdb`` would call :meth:`unittest.TestCase.tearDown` for skipped tests.

- `7253 <>`_: When using ``pytest.fixture`` on a function directly, as in ``pytest.fixture(func)``,
if the ``autouse`` or ``params`` arguments are also passed, the function is no longer
ignored, but is marked as a fixture.

- `7360 <>`_: Fix possibly incorrect evaluation of string expressions passed to ``pytest.mark.skipif`` and ``pytest.mark.xfail``,
in rare circumstances where the exact same string is used but refers to different global values.

- `7383 <>`_: Fixed exception causes all over the codebase, i.e. use `raise new_exception from old_exception` when wrapping an exception.

Improved Documentation

- `7202 <>`_: The development guide now links to the contributing section of the docs and `RELEASING.rst` on GitHub.

- `7233 <>`_: Add a note about ``--strict`` and ``--strict-markers`` and the preference for the latter one.

- `7345 <>`_: Explain indirect parametrization and markers for fixtures.

Trivial/Internal Changes

- `7035 <>`_: The ``originalname`` attribute of ``_pytest.python.Function`` now defaults to ``name`` if not
provided explicitly, and is always set.

- `7264 <>`_: The dependency on the ``wcwidth`` package has been removed.

- `7291 <>`_: Replaced ``py.iniconfig`` with `iniconfig <>`__.

- `7295 <>`_: ``src/_pytest/config/`` now uses the ``warnings`` module to report warnings instead of ``sys.stderr.write``.

- `7356 <>`_: Remove last internal uses of deprecated *slave* term from old ``pytest-xdist``.

- `7357 <>`_: ``py``>=1.8.2 is now required.



Bug Fixes

- `6428 <>`_: Paths appearing in error messages are now correct in case the current working directory has
changed since the start of the session.

- `6755 <>`_: Support deleting paths longer than 260 characters on windows created inside tmpdir.

- `6956 <>`_: Prevent pytest from printing ConftestImportFailure traceback to stdout.

- `7150 <>`_: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised.

- `7215 <>`_: Fix regression where running with ``--pdb`` would call the ``tearDown`` methods of ``unittest.TestCase``
subclasses for skipped tests.



Bug Fixes

- `6871 <>`_: Fix crash with captured output when using the :fixture:`capsysbinary fixture <capsysbinary>`.

- `6924 <>`_: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited.

- `6925 <>`_: Fix TerminalRepr instances to be hashable again.

- `6947 <>`_: Fix regression where functions registered with ``TestCase.addCleanup`` were not being called on test failures.

- `6951 <>`_: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute.

- `6992 <>`_: Revert "tmpdir: clean up indirection via config for factories" #6767 as it breaks pytest-xdist.

- `7110 <>`_: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again.

- `7143 <>`_: Fix ``File.from_parent`` so it forwards extra keyword arguments to the constructor.

- `7145 <>`_: Classes with broken ``__getattribute__`` methods are displayed correctly during failures.

- `7180 <>`_: Fix ``_is_setup_py`` for files encoded differently than locale.



Bug Fixes

- `6909 <>`_: Revert the change introduced by `#6330 <>`_, which required all arguments to ``pytest.mark.parametrize`` to be explicitly defined in the function signature.

The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.

- `6910 <>`_: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option.



Breaking Changes

- `6316 <>`_: Matching of ``-k EXPRESSION`` to test names is now case-insensitive.

- `6443 <>`_: Plugins specified with ``-p`` are now loaded after internal plugins, which results in their hooks being called *before* the internal ones.

This makes the ``-p`` behavior consistent with ``PYTEST_PLUGINS``.

- `6637 <>`_: Removed the long-deprecated ``pytest_itemstart`` hook.

This hook has been marked as deprecated and not been even called by pytest for over 10 years now.

- `6673 <>`_: Reversed / fix meaning of "+/-" in error diffs.  "-" means that sth. expected is missing in the result and "+" means that there are unexpected extras in the result.

- `6737 <>`_: The ``cached_result`` attribute of ``FixtureDef`` is now set to ``None`` when
the result is unavailable, instead of being deleted.

If your plugin performs checks like ``hasattr(fixturedef, 'cached_result')``,
for example in a ``pytest_fixture_post_finalizer`` hook implementation, replace
it with ``fixturedef.cached_result is not None``. If you ``del`` the attribute,
set it to ``None`` instead.


- `3238 <>`_: Option ``--no-print-logs`` is deprecated and meant to be removed in a future release. If you use ``--no-print-logs``, please try out ``--show-capture`` and
provide feedback.

``--show-capture`` command-line option was added in ``pytest 3.5.0`` and allows to specify how to
display captured output when tests fail: ``no``, ``stdout``, ``stderr``, ``log`` or ``all`` (the default).

- `571 <>`_: Deprecate the unused/broken `pytest_collect_directory` hook.
It was misaligned since the removal of the ``Directory`` collector in 2010
and incorrect/unusable as soon as collection was split from test execution.

- `5975 <>`_: Deprecate using direct constructors for ``Nodes``.

Instead they are now constructed via ``Node.from_parent``.

This transitional mechanism enables us to untangle the very intensely
entangled ``Node`` relationships by enforcing more controlled creation/configuration patterns.

As part of this change, session/config are already disallowed parameters and as we work on the details we might need disallow a few more as well.

Subclasses are expected to use `super().from_parent` if they intend to expand the creation of `Nodes`.

- `6779 <>`_: The ``TerminalReporter.writer`` attribute has been deprecated and should no longer be used. This
was inadvertently exposed as part of the public API of that plugin and ties it too much
with ````.


- `4597 <>`_: New :ref:`--capture=tee-sys <capture-method>` option to allow both live printing and capturing of test output.

- `5712 <>`_: Now all arguments to ``pytest.mark.parametrize`` need to be explicitly declared in the function signature or via ``indirect``.
Previously it was possible to omit an argument if a fixture with the same name existed, which was just an accident of implementation and was not meant to be a part of the API.

- `6454 <>`_: Changed default for `-r` to `fE`, which displays failures and errors in the :ref:`short test summary <pytest.detailed_failed_tests_usage>`.  `-rN` can be used to disable it (the old behavior).

- `6469 <>`_: New options have been added to the :confval:`junit_logging` option: ``log``, ``out-err``, and ``all``.

- `6834 <>`_: Excess warning summaries are now collapsed per file to ensure readable display of warning summaries.


- `1857 <>`_: ``pytest.mark.parametrize`` accepts integers for ``ids`` again, converting it to strings.

- `449 <>`_: Use "yellow" main color with any XPASSED tests.

- `4639 <>`_: Revert "A warning is now issued when assertions are made for ``None``".

The warning proved to be less useful than initially expected and had quite a
few false positive cases.

- `5686 <>`_: ``tmpdir_factory.mktemp`` now fails when given absolute and non-normalized paths.

- `5984 <>`_: The ``pytest_warning_captured`` hook now receives a ``location`` parameter with the code location that generated the warning.

- `6213 <>`_: pytester: the ``testdir`` fixture respects environment settings from the ``monkeypatch`` fixture for inner runs.

- `6247 <>`_: ``--fulltrace`` is honored with collection errors.

- `6384 <>`_: Make `--showlocals` work also with `--tb=short`.

- `6653 <>`_: Add support for matching lines consecutively with :attr:`LineMatcher <_pytest.pytester.LineMatcher>`'s :func:`~_pytest.pytester.LineMatcher.fnmatch_lines` and :func:`~_pytest.pytester.LineMatcher.re_match_lines`.

- `6658 <>`_: Code is now highlighted in tracebacks when ``pygments`` is installed.

Users are encouraged to install ``pygments`` into their environment and provide feedback, because
the plan is to make ``pygments`` a regular dependency in the future.

- `6795 <>`_: Import usage error message with invalid `-o` option.

- `759 <>`_: ``pytest.mark.parametrize`` supports iterators and generators for ``ids``.

Bug Fixes

- `310 <>`_: Add support for calling `pytest.xfail()` and `pytest.importorskip()` with doctests.

- `3823 <>`_: ``--trace`` now works with unittests.

- `4445 <>`_: Fixed some warning reports produced by pytest to point to the correct location of the warning in the user's code.

- `5301 <>`_: Fix ``--last-failed`` to collect new tests from files with known failures.

- `5928 <>`_: Report ``PytestUnknownMarkWarning`` at the level of the user's code, not ``pytest``'s.

- `5991 <>`_: Fix interaction with ``--pdb`` and unittests: do not use unittest's ``TestCase.debug()``.

- `6334 <>`_: Fix summary entries appearing twice when ``f/F`` and ``s/S`` report chars were used at the same time in the ``-r`` command-line option (for example ``-rFf``).

The upper case variants were never documented and the preferred form should be the lower case.

- `6409 <>`_: Fallback to green (instead of yellow) for non-last items without previous passes with colored terminal progress indicator.

- `6454 <>`_: `--disable-warnings` is honored with `-ra` and `-rA`.

- `6497 <>`_: Fix bug in the comparison of request key with cached key in fixture.

A construct ``if key == cached_key:`` can fail either because ``==`` is explicitly disallowed, or for, e.g., NumPy arrays, where the result of ``a == b`` cannot generally be converted to `bool`.
The implemented fix replaces `==` with ``is``.

- `6557 <>`_: Make capture output streams ``.write()`` method return the same return value from original streams.

- `6566 <>`_: Fix ``EncodedFile.writelines`` to call the underlying buffer's ``writelines`` method.

- `6575 <>`_: Fix internal crash when ``faulthandler`` starts initialized
(for example with ``PYTHONFAULTHANDLER=1`` environment variable set) and ``faulthandler_timeout`` defined
in the configuration file.

- `6597 <>`_: Fix node ids which contain a parametrized empty-string variable.

- `6646 <>`_: Assertion rewriting hooks are (re)stored for the current item, which fixes them being still used after e.g. pytester's :func:`testdir.runpytest <_pytest.pytester.Testdir.runpytest>` etc.

- `6660 <>`_: :py:func:`pytest.exit` is handled when emitted from the :func:`pytest_sessionfinish <_pytest.hookspec.pytest_sessionfinish>` hook.  This includes quitting from a debugger.

- `6752 <>`_: When :py:func:`pytest.raises` is used as a function (as opposed to a context manager),
a `match` keyword argument is now passed through to the tested function. Previously
it was swallowed and ignored (regression in pytest 5.1.0).

- `6801 <>`_: Do not display empty lines inbetween traceback for unexpected exceptions with doctests.

- `6802 <>`_: The :fixture:`testdir fixture <testdir>` works within doctests now.

Improved Documentation

- `6696 <>`_: Add list of fixtures to start of fixture chapter.

- `6742 <>`_: Expand first sentence on fixtures into a paragraph.

Trivial/Internal Changes

- `6404 <>`_: Remove usage of ``parser`` module, deprecated in Python 3.9.



Bug Fixes

- `6517 <>`_: Fix regression in pytest 5.3.4 causing an INTERNALERROR due to a wrong assertion.



Bug Fixes

- `6496 <>`_: Revert `#6436 <>`__: unfortunately this change has caused a number of regressions in many suites,
so the team decided to revert this change and make a new release while we continue to look for a solution.



Bug Fixes

- `2780 <>`_: Captured output during teardown is shown with ``-rP``.

- `5971 <>`_: Fix a ``pytest-xdist`` crash when dealing with exceptions raised in subprocesses created by the
``multiprocessing`` module.

- `6436 <>`_: :class:`FixtureDef <_pytest.fixtures.FixtureDef>` objects now properly register their finalizers with autouse and
parameterized fixtures that execute before them in the fixture stack so they are torn
down at the right times, and in the right order.

- `6532 <>`_: Fix parsing of outcomes containing multiple errors with ``testdir`` results (regression in 5.3.0).

Trivial/Internal Changes

- `6350 <>`_: Optimized automatic renaming of test parameter IDs.




- `4639 <>`_: Revert "A warning is now issued when assertions are made for ``None``".

The warning proved to be less useful than initially expected and had quite a
few false positive cases.

Bug Fixes

- `5430 <>`_: junitxml: Logs for failed test are now passed to junit report in case the test fails during call phase.

- `6290 <>`_: The supporting files in the ``.pytest_cache`` directory are kept with ``--cache-clear``, which only clears cached values now.

- `6301 <>`_: Fix assertion rewriting for egg-based distributions and ``editable`` installs (``pip install --editable``).




- `6231 <>`_: Improve check for misspelling of :ref:`pytest.mark.parametrize ref`.

- `6257 <>`_: Handle :py:func:`pytest.exit` being used via :py:func:`~_pytest.hookspec.pytest_internalerror`, e.g. when quitting pdb from post mortem.

Bug Fixes

- `5914 <>`_: pytester: fix :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` when used after positive matching.

- `6082 <>`_: Fix line detection for doctest samples inside :py:class:`python:property` docstrings, as a workaround to `bpo-17446 <>`__.

- `6254 <>`_: Fix compatibility with pytest-parallel (regression in pytest 5.3.0).

- `6255 <>`_: Clear the :py:data:`sys.last_traceback`, :py:data:`sys.last_type`
and :py:data:`sys.last_value` attributes by deleting them instead
of setting them to ``None``. This better matches the behaviour of
the Python standard library.




- `6179 <>`_: The default value of :confval:`junit_family` option will change to ``"xunit2"`` in pytest 6.0, given
that this is the version supported by default in modern tools that manipulate this type of file.

In order to smooth the transition, pytest will issue a warning in case the ``--junitxml`` option
is given in the command line but :confval:`junit_family` is not ex
Copy link

@foolip foolip commented May 3, 2021

We're getting this and #28788 because of #28737.

We should probably upgrade both together and get rid of the comments.

@foolip foolip mentioned this pull request May 3, 2021
foolip added a commit that referenced this issue May 3, 2021
Note that these are for internal testing only, independent of the
versions in tools/third_party/.

pyest-cov and hypothesis are already up-to-date.

Closes #28787.
Closes #28788.
@LukeZielinski LukeZielinski assigned foolip and unassigned LukeZielinski May 3, 2021
Copy link
Contributor Author

@pyup-bot pyup-bot commented May 4, 2021

Closing this in favor of #28817

@pyup-bot pyup-bot closed this May 4, 2021
@gsnedders gsnedders deleted the pyup-update-pytest-4.6.11-to-6.2.3 branch May 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants