.. _`changelog`:
=========
Changelog
=========
Versions follow `Semantic Versioning `_ (``..``).
Backward incompatible (breaking) changes will only be introduced in major versions
with advance notice in the **Deprecations** section of releases.
..
You should *NOT* be adding new change log entries to this file, this
file is managed by towncrier. You *may* edit previous change logs to
fix problems like typo corrections or such.
To add a new change log entry, please see
https://pip.pypa.io/en/latest/development/contributing/#news-entries
we named the news folder changelog
.. only:: changelog_towncrier_draft
.. The 'changelog_towncrier_draft' tag is included by our 'tox -e docs',
but not on readthedocs.
.. include:: _changelog_towncrier_draft.rst
.. towncrier release notes start
pytest 6.0.1 (2020-07-30)
=========================
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()``.
pytest 6.0.0 (2020-07-28)
=========================
(**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
[pytest]
filterwarnings =
ignore::pytest.PytestDeprecationWarning
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.
Features
--------
- `#7464 `_: Added support for :envvar:`NO_COLOR` and :envvar:`FORCE_COLOR` environment variables to control colored output.
Improvements
------------
- `#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.
pytest 6.0.0rc1 (2020-07-08)
============================
Breaking Changes
----------------
- `#1316 `_: ``TestReport.longrepr`` is now always an instance of ``ReprExceptionInfo``. Previously it was a ``str`` when a test failed with ``pytest.fail(..., pytrace=False)``.
- `#5965 `_: symlinks are no longer resolved during collection and matching `conftest.py` 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 `_: ``Testdir.run().parseoutcomes()`` 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()
result.assert_outcomes(error=1)
Need to be changed to:
.. code-block:: python
result = testdir.runpytest()
result.assert_outcomes(errors=1)
- `#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, ``pytest.Package.name`` is now just the name of the directory containing the package's
``__init__.py`` 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
``terminal_writer.flush()``.
- 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 is 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.
Deprecations
------------
- `#7210 `_: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'``
instead.
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.
Features
--------
- `#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
# pyproject.toml
[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = [
"tests",
"integration",
]
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.
Improvements
------------
- `#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 ``.duration`` attribute, created using ``time.perf_counter()``. This attribute is used to fill the ``.duration`` attribute, which is more accurate than the previous ``.stop - .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.
Previously:
.. code-block:: xml
Now:
.. code-block:: xml
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/__init__.py`` 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.
pytest 5.4.3 (2020-06-02)
=========================
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.
pytest 5.4.2 (2020-05-08)
=========================
Bug Fixes
---------
- `#6871 `_: Fix crash with captured output when using the :fixture:`capsysbinary fixture `.
- `#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_constructor`` 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.
pytest 5.4.1 (2020-03-13)
=========================
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.
pytest 5.4.0 (2020-03-12)
=========================
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.
Deprecations
------------
- `#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 ``py.io.TerminalWriter``.
Features
--------
- `#4597 `_: New :ref:`--capture=tee-sys ` 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 `. `-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.
Improvements
------------
- `#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 ` 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.
pytest 5.3.5 (2020-01-29)
=========================
Bug Fixes
---------
- `#6517 `_: Fix regression in pytest 5.3.4 causing an INTERNALERROR due to a wrong assertion.
pytest 5.3.4 (2020-01-20)
=========================
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.
pytest 5.3.3 (2020-01-16)
=========================
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.
pytest 5.3.2 (2019-12-13)
=========================
Improvements
------------
- `#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``).
pytest 5.3.1 (2019-11-25)
=========================
Improvements
------------
- `#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.
pytest 5.3.0 (2019-11-19)
=========================
Deprecations
------------
- `#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 explicitly configured in ``pytest.ini``.
For more information, `see the docs `__.
Features
--------
- `#4488 `_: The pytest team has created the `pytest-reportlog `__
plugin, which provides a new ``--report-log=FILE`` option that writes *report logs* into a file as the test session executes.
Each line of the report log contains a self contained JSON object corresponding to a testing event,
such as a collection or a test result report. The file is guaranteed to be flushed after writing
each line, so systems can read and process events in real-time.
The plugin is meant to replace the ``--resultlog`` option, which is deprecated and meant to be removed
in a future release. If you use ``--resultlog``, please try out ``pytest-reportlog`` and
provide feedback.
- `#4730 `_: When :py:data:`sys.pycache_prefix` (Python 3.8+) is set, it will be used by pytest to cache test files changed by the assertion rewriting mechanism.
This makes it easier to benefit of cached ``.pyc`` files even on file systems without permissions.
- `#5515 `_: Allow selective auto-indentation of multiline log messages.
Adds command line option ``--log-auto-indent``, config option
:confval:`log_auto_indent` and support for per-entry configuration of
indentation behavior on calls to :py:func:`python:logging.log()`.
Alters the default for auto-indention from ``"on"`` to ``"off"``. This
restores the older behavior that existed prior to v4.6.0. This
reversion to earlier behavior was done because it is better to
activate new features that may lead to broken tests explicitly
rather than implicitly.
- `#5914 `_: :fixture:`testdir` learned two new functions, :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` and
:py:func:`~_pytest.pytester.LineMatcher.no_re_match_line`.
The functions are used to ensure the captured text *does not* match the given
pattern.
The previous idiom was to use :py:func:`python:re.match`:
.. code-block:: python
result = testdir.runpytest()
assert re.match(pat, result.stdout.str()) is None
Or the ``in`` operator:
.. code-block:: python
result = testdir.runpytest()
assert text in result.stdout.str()
But the new functions produce best output on failure.
- `#6057 `_: Added tolerances to complex values when printing ``pytest.approx``.
For example, ``repr(pytest.approx(3+4j))`` returns ``(3+4j) ± 5e-06 ∠ ±180°``. This is polar notation indicating a circle around the expected value, with a radius of 5e-06. For ``approx`` comparisons to return ``True``, the actual value should fall within this circle.
- `#6061 `_: Added the pluginmanager as an argument to ``pytest_addoption``
so that hooks can be invoked when setting up command line options. This is
useful for having one plugin communicate things to another plugin,
such as default values or which set of command line options to add.
Improvements
------------
- `#5061 `_: Use multiple colors with terminal summary statistics.
- `#5630 `_: Quitting from debuggers is now properly handled in ``doctest`` items.
- `#5924 `_: Improved verbose diff output with sequences.
Before:
::
E AssertionError: assert ['version', '...version_info'] == ['version', '...version', ...]
E Right contains 3 more items, first extra item: ' '
E Full diff:
E - ['version', 'version_info', 'sys.version', 'sys.version_info']
E + ['version',
E + 'version_info',
E + 'sys.version',
E + 'sys.version_info',
E + ' ',
E + 'sys.version',
E + 'sys.version_info']
After:
::
E AssertionError: assert ['version', '...version_info'] == ['version', '...version', ...]
E Right contains 3 more items, first extra item: ' '
E Full diff:
E [
E 'version',
E 'version_info',
E 'sys.version',
E 'sys.version_info',
E + ' ',
E + 'sys.version',
E + 'sys.version_info',
E ]
- `#5934 `_: ``repr`` of ``ExceptionInfo`` objects has been improved to honor the ``__repr__`` method of the underlying exception.
- `#5936 `_: Display untruncated assertion message with ``-vv``.
- `#5990 `_: Fixed plurality mismatch in test summary (e.g. display "1 error" instead of "1 errors").
- `#6008 `_: ``Config.InvocationParams.args`` is now always a ``tuple`` to better convey that it should be
immutable and avoid accidental modifications.
- `#6023 `_: ``pytest.main`` returns a ``pytest.ExitCode`` instance now, except for when custom exit codes are used (where it returns ``int`` then still).
- `#6026 `_: Align prefixes in output of pytester's ``LineMatcher``.
- `#6059 `_: Collection errors are reported as errors (and not failures like before) in the terminal's short test summary.
- `#6069 `_: ``pytester.spawn`` does not skip/xfail tests on FreeBSD anymore unconditionally.
- `#6097 `_: The "[...%]" indicator in the test summary is now colored according to the final (new) multi-colored line's main color.
- `#6116 `_: Added ``--co`` as a synonym to ``--collect-only``.
- `#6148 `_: ``atomicwrites`` is now only used on Windows, fixing a performance regression with assertion rewriting on Unix.
- `#6152 `_: Now parametrization will use the ``__name__`` attribute of any object for the id, if present. Previously it would only use ``__name__`` for functions and classes.
- `#6176 `_: Improved failure reporting with pytester's ``Hookrecorder.assertoutcome``.
- `#6181 `_: The reason for a stopped session, e.g. with ``--maxfail`` / ``-x``, now gets reported in the test summary.
- `#6206 `_: Improved ``cache.set`` robustness and performance.
Bug Fixes
---------
- `#2049 `_: Fixed ``--setup-plan`` showing inaccurate information about fixture lifetimes.
- `#2548 `_: Fixed line offset mismatch of skipped tests in terminal summary.
- `#6039 `_: The ``PytestDoctestRunner`` is now properly invalidated when unconfiguring the doctest plugin.
This is important when used with ``pytester``'s ``runpytest_inprocess``.
- `#6047 `_: BaseExceptions are now handled in ``saferepr``, which includes ``pytest.fail.Exception`` etc.
- `#6074 `_: pytester: fixed order of arguments in ``rm_rf`` warning when cleaning up temporary directories, and do not emit warnings for errors with ``os.open``.
- `#6189 `_: Fixed result of ``getmodpath`` method.
Trivial/Internal Changes
------------------------
- `#4901 `_: ``RunResult`` from ``pytester`` now displays the mnemonic of the ``ret`` attribute when it is a
valid ``pytest.ExitCode`` value.
pytest 5.2.4 (2019-11-15)
=========================
Bug Fixes
---------
- `#6194 `_: Fix incorrect discovery of non-test ``__init__.py`` files.
- `#6197 `_: Revert "The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped.".
pytest 5.2.3 (2019-11-14)
=========================
Bug Fixes
---------
- `#5830 `_: The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped.
- `#6099 `_: Fix ``--trace`` when used with parametrized functions.
- `#6183 `_: Using ``request`` as a parameter name in ``@pytest.mark.parametrize`` now produces a more
user-friendly error.
pytest 5.2.2 (2019-10-24)
=========================
Bug Fixes
---------
- `#5206 `_: Fix ``--nf`` to not forget about known nodeids with partial test selection.
- `#5906 `_: Fix crash with ``KeyboardInterrupt`` during ``--setup-show``.
- `#5946 `_: Fixed issue when parametrizing fixtures with numpy arrays (and possibly other sequence-like types).
- `#6044 `_: Properly ignore ``FileNotFoundError`` exceptions when trying to remove old temporary directories,
for instance when multiple processes try to remove the same directory (common with ``pytest-xdist``
for example).
pytest 5.2.1 (2019-10-06)
=========================
Bug Fixes
---------
- `#5902 `_: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``.
pytest 5.2.0 (2019-09-28)
=========================
Deprecations
------------
- `#1682 `_: Passing arguments to pytest.fixture() as positional arguments is deprecated - pass them
as a keyword argument instead.
Features
--------
- `#1682 `_: The ``scope`` parameter of ``@pytest.fixture`` can now be a callable that receives
the fixture name and the ``config`` object as keyword-only parameters.
See `the docs `__ for more information.
- `#5764 `_: New behavior of the ``--pastebin`` option: failures to connect to the pastebin server are reported, without failing the pytest run
Bug Fixes
---------
- `#5806 `_: Fix "lexer" being used when uploading to bpaste.net from ``--pastebin`` to "text".
- `#5884 `_: Fix ``--setup-only`` and ``--setup-show`` for custom pytest items.
Trivial/Internal Changes
------------------------
- `#5056 `_: The HelpFormatter uses ``py.io.get_terminal_width`` for better width detection.
pytest 5.1.3 (2019-09-18)
=========================
Bug Fixes
---------
- `#5807 `_: Fix pypy3.6 (nightly) on windows.
- `#5811 `_: Handle ``--fulltrace`` correctly with ``pytest.raises``.
- `#5819 `_: Windows: Fix regression with conftest whose qualified name contains uppercase
characters (introduced by #5792).
pytest 5.1.2 (2019-08-30)
=========================
Bug Fixes
---------
- `#2270 `_: Fixed ``self`` reference in function-scoped fixtures defined plugin classes: previously ``self``
would be a reference to a *test* class, not the *plugin* class.
- `#570 `_: Fixed long standing issue where fixture scope was not respected when indirect fixtures were used during
parametrization.
- `#5782