Releases: pytest-dev/pytest
Prepare release version 7.4.0
pytest 7.4.0 (2023-06-23)
Features
- #10901: Added
ExceptionInfo.from_exception() <pytest.ExceptionInfo.from_exception>
{.interpreted-text role="func"}, a simpler way to create an~pytest.ExceptionInfo
{.interpreted-text role="class"} from an exception.
This can replaceExceptionInfo.from_exc_info() <pytest.ExceptionInfo.from_exc_info()>
{.interpreted-text role="func"} for most uses.
Improvements
-
#10872: Update test log report annotation to named tuple and fixed inconsistency in docs for
pytest_report_teststatus
{.interpreted-text role="hook"} hook. -
#10907: When an exception traceback to be displayed is completely filtered out (by mechanisms such as
__tracebackhide__
, internal frames, and similar), now only the exception string and the following message are shown:"All traceback entries are hidden. Pass [--full-trace]{.title-ref} to see hidden and internal frames.".
Previously, the last frame of the traceback was shown, even though it was hidden.
-
#10940: Improved verbose output (
-vv
) ofskip
andxfail
reasons by performing text wrapping while leaving a clear margin for progress output.Added
TerminalReporter.wrap_write()
as a helper for that. -
#10991: Added handling of
%f
directive to print microseconds in log format options, such aslog-date-format
. -
#11005: Added the underlying exception to the cache provider's path creation and write warning messages.
-
#11013: Added warning when
testpaths
{.interpreted-text role="confval"} is set, but paths are not found by glob. In this case, pytest will fall back to searching from the current directory. -
#11043: When [--confcutdir]{.title-ref} is not specified, and there is no config file present, the conftest cutoff directory ([--confcutdir]{.title-ref}) is now set to the
rootdir <rootdir>
{.interpreted-text role="ref"}.
Previously in such cases, [conftest.py]{.title-ref} files would be probed all the way to the root directory of the filesystem.
If you are badly affected by this change, consider adding an empty config file to your desired cutoff directory, or explicitly set [--confcutdir]{.title-ref}. -
#11081: The
norecursedirs
{.interpreted-text role="confval"} check is now performed in apytest_ignore_collect
{.interpreted-text role="hook"} implementation, so plugins can affect it.If after updating to this version you see that your [norecursedirs]{.title-ref} setting is not being respected,
it means that a conftest or a plugin you use has a bad [pytest_ignore_collect]{.title-ref} implementation.
Most likely, your hook returns [False]{.title-ref} for paths it does not want to ignore,
which ends the processing and doesn't allow other plugins, including pytest itself, to ignore the path.
The fix is to return [None]{.title-ref} instead of [False]{.title-ref} for paths your hook doesn't want to ignore. -
#8711:
caplog.set_level() <pytest.LogCaptureFixture.set_level>
{.interpreted-text role="func"} andcaplog.at_level() <pytest.LogCaptureFixture.at_level>
{.interpreted-text role="func"}
will temporarily enable the requestedlevel
iflevel
was disabled globally via
logging.disable(LEVEL)
.
Bug Fixes
- #10831: Terminal Reporting: Fixed bug when running in
--tb=line
mode wherepytest.fail(pytrace=False)
tests reportNone
. - #11068: Fixed the
--last-failed
whole-file skipping functionality ("skipped N files") fornon-python test files <non-python tests>
{.interpreted-text role="ref"}. - #11104: Fixed a regression in pytest 7.3.2 which caused to
testpaths
{.interpreted-text role="confval"} to be considered for loading initial conftests,
even when it was not utilized (e.g. when explicit paths were given on the command line).
Now thetestpaths
are only considered when they are in use. - #1904: Fixed traceback entries hidden with
__tracebackhide__ = True
still being shown for chained exceptions (parts after "... the above exception ..." message). - #7781: Fix writing non-encodable text to log file when using
--debug
.
Improved Documentation
- #9146: Improved documentation for
caplog.set_level() <pytest.LogCaptureFixture.set_level>
{.interpreted-text role="func"}.
Trivial/Internal Changes
- #11031: Enhanced the CLI flag for
-c
to now include--config-file
to make it clear that this flag applies to the usage of a custom config file.
7.3.2
pytest 7.3.2 (2023-06-10)
Bug Fixes
- #10169: Fix bug where very long option names could cause pytest to break with
OSError: [Errno 36] File name too long
on some systems. - #10894: Support for Python 3.12 (beta at the time of writing).
- #10987:
testpaths
{.interpreted-text role="confval"} is now honored to load rootconftests
. - #10999: The [monkeypatch]{.title-ref} [setitem]{.title-ref}/[delitem]{.title-ref} type annotations now allow [TypedDict]{.title-ref} arguments.
- #11028: Fixed bug in assertion rewriting where a variable assigned with the walrus operator could not be used later in a function call.
- #11054: Fixed
--last-failed
's "(skipped N files)" functionality for files inside of packages (directories with [__init__.py]{.title-ref} files).
7.3.1
pytest 7.3.1 (2023-04-14)
Improvements
- #10875: Python 3.12 support: fixed
RuntimeError: TestResult has no addDuration method
when runningunittest
tests. - #10890: Python 3.12 support: fixed
shutil.rmtree(onerror=...)
deprecation warning when usingtmp_path
{.interpreted-text role="fixture"}.
Bug Fixes
- #10896: Fixed performance regression related to
tmp_path
{.interpreted-text role="fixture"} and the newtmp_path_retention_policy
{.interpreted-text role="confval"} option. - #10903: Fix crash
INTERNALERROR IndexError: list index out of range
which happens when displaying an exception where all entries are hidden.
This reverts the change "Correctly handle__tracebackhide__
for chained exceptions." introduced in version 7.3.0.
7.3.0
pytest 7.3.0 (2023-04-08)
Features
- #10525: Test methods decorated with
@classmethod
can now be discovered as tests, following the same rules as normal methods. This fills the gap that static methods were discoverable as tests but not class methods. - #10755:
console_output_style
{.interpreted-text role="confval"} now supportsprogress-even-when-capture-no
to force the use of the progress output even when capture is disabled. This is useful in large test suites where capture may have significant performance impact. - #7431:
--log-disable
CLI option added to disable individual loggers. - #8141: Added
tmp_path_retention_count
{.interpreted-text role="confval"} andtmp_path_retention_policy
{.interpreted-text role="confval"} configuration options to control how directories created by thetmp_path
{.interpreted-text role="fixture"} fixture are kept.
Improvements
- #10226: If multiple errors are raised in teardown, we now re-raise an
ExceptionGroup
of them instead of discarding all but the last. - #10658: Allow
-p
arguments to include spaces (eg:-p no:logging
instead of
-pno:logging
). Mostly useful in theaddopts
section of the configuration
file. - #10710: Added
start
andstop
timestamps toTestReport
objects. - #10727: Split the report header for
rootdir
,config file
andtestpaths
so each has its own line. - #10840: pytest should no longer crash on AST with pathological position attributes, for example testing AST produced by [Hylang <https://github.com/hylang/hy>__]{.title-ref}.
- #6267: The full output of a test is no longer truncated if the truncation message would be longer than
the hidden text. The line number shown has also been fixed.
Bug Fixes
- #10743: The assertion rewriting mechanism now works correctly when assertion expressions contain the walrus operator.
- #10765: Fixed
tmp_path
{.interpreted-text role="fixture"} fixture always raisingOSError
{.interpreted-text role="class"} onemscripten
platform due to missingos.getuid
{.interpreted-text role="func"}. - #1904: Correctly handle
__tracebackhide__
for chained exceptions.
Improved Documentation
- #10782: Fixed the minimal example in
goodpractices
{.interpreted-text role="ref"}:pip install -e .
requires aversion
entry inpyproject.toml
to run successfully.
Trivial/Internal Changes
- #10669: pytest no longer depends on the [attrs]{.title-ref} package (don't worry, nice diffs for attrs classes are still supported).
7.2.2
pytest 7.2.2 (2023-03-03)
Bug Fixes
- #10533: Fixed
pytest.approx
{.interpreted-text role="func"} handling of dictionaries containing one or more values of [0.0]{.title-ref}. - #10592: Fixed crash if [--cache-show]{.title-ref} and [--help]{.title-ref} are passed at the same time.
- #10597: Fixed bug where a fixture method named
teardown
would be called as part ofnose
teardown stage. - #10626: Fixed crash if
--fixtures
and--help
are passed at the same time. - #10660: Fixed :py
pytest.raises
{.interpreted-text role="func"} to return a 'ContextManager' so that type-checkers could narrow
pytest.raises(...) if ... else nullcontext()
down to 'ContextManager' rather than 'object'.
Improved Documentation
- #10690: Added [CI]{.title-ref} and [BUILD_NUMBER]{.title-ref} environment variables to the documentation.
- #10721: Fixed entry-points declaration in the documentation example using Hatch.
- #10753: Changed wording of the module level skip to be very explicit
about not collecting tests and not executing the rest of the module.
7.2.1
pytest 7.2.1 (2023-01-13)
Bug Fixes
- #10452: Fix 'importlib.abc.TraversableResources' deprecation warning in Python 3.12.
- #10457: If a test is skipped from inside a fixture, the test summary now shows the test location instead of the fixture location.
- #10506: Fix bug where sometimes pytest would use the file system root directory as
rootdir <rootdir>
{.interpreted-text role="ref"} on Windows. - #10607: Fix a race condition when creating junitxml reports, which could occur when multiple instances of pytest execute in parallel.
- #10641: Fix a race condition when creating or updating the stepwise plugin's cache, which could occur when multiple xdist worker nodes try to simultaneously update the stepwise plugin's cache.
7.2.0
pytest 7.2.0 (2022-10-23)
Deprecations
-
#10012: Update
pytest.PytestUnhandledCoroutineWarning
{.interpreted-text role="class"} to a deprecation; it will raise an error in pytest 8. -
#10396: pytest no longer depends on the
py
library.pytest
provides a vendored copy ofpy.error
andpy.path
modules but will use thepy
library if it is installed. If you need otherpy.*
modules, continue to install the deprecatedpy
library separately, otherwise it can usually be removed as a dependency. -
#4562: Deprecate configuring hook specs/impls using attributes/marks.
Instead use :py
pytest.hookimpl
{.interpreted-text role="func"} and :pypytest.hookspec
{.interpreted-text role="func"}.
For more details, see thedocs <legacy-path-hooks-deprecated>
{.interpreted-text role="ref"}. -
#9886: The functionality for running tests written for
nose
has been officially deprecated.This includes:
- Plain
setup
andteardown
functions and methods: this might catch users by surprise, assetup()
andteardown()
are not pytest idioms, but part of thenose
support. - Setup/teardown using the @with_setup decorator.
For more details, consult the
deprecation docs <nose-deprecation>
{.interpreted-text role="ref"}. - Plain
Features
- #9897: Added shell-style wildcard support to
testpaths
.
Improvements
-
#10218:
@pytest.mark.parametrize()
(and similar functions) now accepts anySequence[str]
for the argument names,
instead of justlist[str]
andtuple[str, ...]
.(Note that
str
, which is itself aSequence[str]
, is still treated as a
comma-delimited name list, as before). -
#10381: The
--no-showlocals
flag has been added. This can be passed directly to tests to override--showlocals
declared throughaddopts
. -
#3426: Assertion failures with strings in NFC and NFD forms that normalize to the same string now have a dedicated error message detailing the issue, and their utf-8 representation is expresed instead.
-
#7337: A warning is now emitted if a test function returns something other than [None]{.title-ref}. This prevents a common mistake among beginners that expect that returning a [bool]{.title-ref} (for example [return foo(a, b) == result]{.title-ref}) would cause a test to pass or fail, instead of using [assert]{.title-ref}.
-
#8508: Introduce multiline display for warning matching via :py
pytest.warns
{.interpreted-text role="func"} and
enhance match comparison for :py_pytest._code.ExceptionInfo.match
{.interpreted-text role="func"} as returned by :pypytest.raises
{.interpreted-text role="func"}. -
#8646: Improve :py
pytest.raises
{.interpreted-text role="func"}. Previously passing an empty tuple would give a confusing
error. We now raise immediately with a more helpful message. -
#9741: On Python 3.11, use the standard library's
tomllib
{.interpreted-text role="mod"} to parse TOML.tomli
{.interpreted-text role="mod"}` is no longer a dependency on Python 3.11. -
#9742: Display assertion message without escaped newline characters with
-vv
. -
#9823: Improved error message that is shown when no collector is found for a given file.
-
#9873: Some coloring has been added to the short test summary.
-
#9883: Normalize the help description of all command-line options.
-
#9920: Display full crash messages in
short test summary info
, when runng in a CI environment. -
#9987: Added support for hidden configuration file by allowing
.pytest.ini
as an alternative topytest.ini
.
Bug Fixes
-
#10150:
sys.stdin
{.interpreted-text role="data"} now contains all expected methods of a file-like object when capture is enabled. -
#10382: Do not break into pdb when
raise unittest.SkipTest()
appears top-level in a file. -
#7792: Marks are now inherited according to the full MRO in test classes. Previously, if a test class inherited from two or more classes, only marks from the first super-class would apply.
When inheriting marks from super-classes, marks from the sub-classes are now ordered before marks from the super-classes, in MRO order. Previously it was the reverse.
When inheriting marks from super-classes, the [pytestmark]{.title-ref} attribute of the sub-class now only contains the marks directly applied to it. Previously, it also contained marks from its super-classes. Please note that this attribute should not normally be accessed directly; use
pytest.Node.iter_markers
{.interpreted-text role="func"} instead. -
#9159: Showing inner exceptions by forcing native display in
ExceptionGroups
even when using display options other than--tb=native
. A temporary step before full implementation of pytest-native display for inner exceptions inExceptionGroups
. -
#9877: Ensure
caplog.get_records(when)
returns current/correct data after invokingcaplog.clear()
.
Improved Documentation
- #10344: Update information on writing plugins to use
pyproject.toml
instead ofsetup.py
. - #9248: The documentation is now built using Sphinx 5.x (up from 3.x previously).
- #9291: Update documentation on how
pytest.warns
{.interpreted-text role="func"} affectsDeprecationWarning
{.interpreted-text role="class"}.
Trivial/Internal Changes
- #10196:
~pytest.PytestReturnNotNoneWarning
{.interpreted-text role="class"} is now a subclass of~pytest.PytestRemovedIn8Warning
{.interpreted-text role="class"}: the plan is to make returning non-None
from tests an error in the future. - #10313: Made
_pytest.doctest.DoctestItem
exportpytest.DoctestItem
for
type check and runtime purposes. Made [_pytest.doctest]{.title-ref} use internal APIs
to avoid circular imports. - #9906: Made
_pytest.compat
re-exportimportlib_metadata
in the eyes of type checkers. - #9910: Fix default encoding warning (
EncodingWarning
) incacheprovider
- #9984: Improve the error message when we attempt to access a fixture that has been
torn down.
Add an additional sentence to the docstring explaining when it's not a good
idea to call getfixturevalue.
7.1.3
pytest 7.1.3 (2022-08-31)
Bug Fixes
- #10060: When running with
--pdb
,TestCase.tearDown
is no longer called for tests when the class has been skipped viaunittest.skip
orpytest.mark.skip
. - #10190: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports.
- #10230: Ignore
.py
files created bypyproject.toml
-based editable builds introduced in pip 21.3. - #3396: Doctests now respect the
--import-mode
flag. - #9514: Type-annotate
FixtureRequest.param
asAny
as a stop gap measure until8073
{.interpreted-text role="issue"} is fixed. - #9791: Fixed a path handling code in
rewrite.py
that seems to work fine, but was incorrect and fails in some systems. - #9917: Fixed string representation for
pytest.approx
{.interpreted-text role="func"} when used to compare tuples.
Improved Documentation
- #9937: Explicit note that
tmpdir
{.interpreted-text role="fixture"} fixture is discouraged in favour oftmp_path
{.interpreted-text role="fixture"}.
Trivial/Internal Changes
- #10114: Replace atomicwrites dependency on windows with [os.replace]{.title-ref}.
7.1.2
pytest 7.1.2 (2022-04-23)
Bug Fixes
- #9726: An unnecessary
numpy
import insidepytest.approx
{.interpreted-text role="func"} was removed. - #9820: Fix comparison of
dataclasses
withInitVar
. - #9869: Increase
stacklevel
for theNODE_CTOR_FSPATH_ARG
deprecation to point to the
user's code, not pytest. - #9871: Fix a bizarre (and fortunately rare) bug where the [temp_path]{.title-ref} fixture could raise
an internal error while attempting to get the current user's username.