Update dependency pytest to v7 #12
Loading…
Reference in a new issue
No description provided.
Delete branch "renovate/pytest-7.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
==5.4.1
->==7.4.2
Release Notes
pytest-dev/pytest (pytest)
v7.4.2
: pytest 7.4.2 (2023-09-07)Compare Source
Bug Fixes
#11237: Fix doctest collection of
functools.cached_property
objects.#11306: Fixed bug using
--importmode=importlib
which would cause package__init__.py
files to be imported more than once in some cases.#11367: Fixed bug where
user_properties
where not being saved in the JUnit XML file if a fixture failed during teardown.#11394: Fixed crash when parsing long command line arguments that might be interpreted as files.
Improved Documentation
v7.4.1
: pytest 7.4.1 (2023-09-02)Compare Source
Bug Fixes
#10337: Fixed bug where fake intermediate modules generated by
--import-mode=importlib
would not include thechild modules as attributes of the parent modules.
#10702: Fixed error assertion handling in
pytest.approx
whenNone
is an expected or received value when comparing dictionaries.#10811: Fixed issue when using
--import-mode=importlib
together with--doctest-modules
that caused modulesto be imported more than once, causing problems with modules that have import side effects.
v7.4.0
Compare Source
pytest 7.4.0 (2023-06-23)
Features
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 replace
ExceptionInfo.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 requested
level
iflevel
was disabled globally vialogging.disable(LEVEL)
.Bug Fixes
--tb=line
mode wherepytest.fail(pytrace=False)
tests reportNone
.--last-failed
whole-file skipping functionality ("skipped N files") fornon-python test files <non-python tests>
{.interpreted-text role="ref"}.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 the
testpaths
are only considered when they are in use.__tracebackhide__ = True
still being shown for chained exceptions (parts after "... the above exception ..." message).--debug
.Improved Documentation
caplog.set_level() <pytest.LogCaptureFixture.set_level>
{.interpreted-text role="func"}.Trivial/Internal Changes
-c
to now include--config-file
to make it clear that this flag applies to the usage of a custom config file.v7.3.2
Compare Source
pytest 7.3.2 (2023-06-10)
Bug Fixes
OSError: [Errno 36] File name too long
on some systems.testpaths
{.interpreted-text role="confval"} is now honored to load rootconftests
.--last-failed
's "(skipped N files)" functionality for files inside of packages (directories with [__init__.py]{.title-ref} files).v7.3.1
Compare Source
pytest 7.3.1 (2023-04-14)
Improvements
RuntimeError: TestResult has no addDuration method
when runningunittest
tests.shutil.rmtree(onerror=...)
deprecation warning when usingtmp_path
{.interpreted-text role="fixture"}.Bug Fixes
tmp_path
{.interpreted-text role="fixture"} and the newtmp_path_retention_policy
{.interpreted-text role="confval"} option.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.v7.3.0
Compare Source
pytest 7.3.0 (2023-04-08)
Features
@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.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.--log-disable
CLI option added to disable individual loggers.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
ExceptionGroup
of them instead of discarding all but the last.-p
arguments to include spaces (eg:-p no:logging
instead of-pno:logging
). Mostly useful in theaddopts
section of the configurationfile.
start
andstop
timestamps toTestReport
objects.rootdir
,config file
andtestpaths
so each has its own line.the hidden text. The line number shown has also been fixed.
Bug Fixes
tmp_path
{.interpreted-text role="fixture"} fixture always raisingOSError
{.interpreted-text role="class"} onemscripten
platform due to missingos.getuid
{.interpreted-text role="func"}.__tracebackhide__
for chained exceptions.Improved Documentation
goodpractices
{.interpreted-text role="ref"}:pip install -e .
requires aversion
entry inpyproject.toml
to run successfully.Trivial/Internal Changes
v7.2.2
Compare Source
pytest 7.2.2 (2023-03-03)
Bug Fixes
pytest.approx
{.interpreted-text role="func"} handling of dictionaries containing one or more values of [0.0]{.title-ref}.teardown
would be called as part ofnose
teardown stage.--fixtures
and--help
are passed at the same time.pytest.raises
{.interpreted-text role="func"} to return a 'ContextManager' so that type-checkers could narrowpytest.raises(...) if ... else nullcontext()
down to 'ContextManager' rather than 'object'.Improved Documentation
about not collecting tests and not executing the rest of the module.
v7.2.1
Compare Source
pytest 7.2.1 (2023-01-13)
Bug Fixes
rootdir <rootdir>
{.interpreted-text role="ref"} on Windows.v7.2.0
Compare Source
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 the
docs <legacy-path-hooks-deprecated>
{.interpreted-text role="ref"}.#9886: The functionality for running tests written for
nose
has been officially deprecated.This includes:
setup
andteardown
functions and methods: this might catch users by surprise, assetup()
andteardown()
are not pytest idioms, but part of thenose
support.For more details, consult the
deprecation docs <nose-deprecation>
{.interpreted-text role="ref"}.Features
testpaths
.Improvements
#10218:
@pytest.mark.parametrize()
(and similar functions) now accepts anySequence[str]
for the argument names,instead of just
list[str]
andtuple[str, ...]
.(Note that
str
, which is itself aSequence[str]
, is still treated as acomma-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"} andenhance 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 confusingerror. 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
pyproject.toml
instead ofsetup.py
.pytest.warns
{.interpreted-text role="func"} affectsDeprecationWarning
{.interpreted-text role="class"}.Trivial/Internal Changes
~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._pytest.doctest.DoctestItem
exportpytest.DoctestItem
fortype check and runtime purposes. Made [_pytest.doctest]{.title-ref} use internal APIs
to avoid circular imports.
_pytest.compat
re-exportimportlib_metadata
in the eyes of type checkers.EncodingWarning
) incacheprovider
torn down.
Add an additional sentence to the docstring explaining when it's not a good
idea to call getfixturevalue.
v7.1.3
Compare Source
pytest 7.1.3 (2022-08-31)
Bug Fixes
--pdb
,TestCase.tearDown
is no longer called for tests when the class has been skipped viaunittest.skip
orpytest.mark.skip
..py
files created bypyproject.toml
-based editable builds introduced in pip 21.3.--import-mode
flag.FixtureRequest.param
asAny
as a stop gap measure until8073
{.interpreted-text role="issue"} is fixed.rewrite.py
that seems to work fine, but was incorrect and fails in some systems.pytest.approx
{.interpreted-text role="func"} when used to compare tuples.Improved Documentation
tmpdir
{.interpreted-text role="fixture"} fixture is discouraged in favour oftmp_path
{.interpreted-text role="fixture"}.Trivial/Internal Changes
v7.1.2
Compare Source
pytest 7.1.2 (2022-04-23)
Bug Fixes
numpy
import insidepytest.approx
{.interpreted-text role="func"} was removed.dataclasses
withInitVar
.stacklevel
for theNODE_CTOR_FSPATH_ARG
deprecation to point to theuser's code, not pytest.
an internal error while attempting to get the current user's username.
v7.1.1
Compare Source
pytest 7.1.1 (2022-03-17)
Bug Fixes
v7.1.0
Compare Source
pytest 7.1.0 (2022-03-13)
Breaking Changes
#8838: As per our policy, the following features have been deprecated in the 6.X series and are now
removed:
pytest._fillfuncargs
function.pytest_warning_captured
hook - usepytest_warning_recorded
instead.-k -foobar
syntax - use-k 'not foobar'
instead.-k foobar:
syntax.pytest.collect
module - import frompytest
directly.For more information consult
Deprecations and Removals in the docs.
#9437: Dropped support for Python 3.6, which reached end-of-life at 2021-12-23.
Improvements
#5192: Fixed test output for some data types where
-v
would show less information.Also, when showing diffs for sequences,
-q
would produce full diffs instead of the expected diff.#9362: pytest now avoids specialized assert formatting when it is detected that the default
__eq__
is overridden inattrs
ordataclasses
.#9536: When
-vv
is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width.#9644: More information about the location of resources that led Python to raise
ResourceWarning
{.interpreted-text role="class"} can nowbe obtained by enabling
tracemalloc
{.interpreted-text role="mod"}.See
resource-warnings
{.interpreted-text role="ref"} for more information.#9678: More types are now accepted in the
ids
argument to@pytest.mark.parametrize
.Previously only [str]{.title-ref}, [float]{.title-ref}, [int]{.title-ref} and [bool]{.title-ref} were accepted;
now [bytes]{.title-ref}, [complex]{.title-ref}, [re.Pattern]{.title-ref}, [Enum]{.title-ref} and anything with a [__name__]{.title-ref} are also accepted.
#9692:
pytest.approx
{.interpreted-text role="func"} now raises aTypeError
{.interpreted-text role="class"} when given an unordered sequence (such asset
{.interpreted-text role="class"}).Note that this implies that custom classes which only implement
__iter__
and__len__
are no longer supported as they don't guarantee order.Bug Fixes
#8242: The deprecation of raising
unittest.SkipTest
{.interpreted-text role="class"} to skip collection oftests during the pytest collection phase is reverted - this is now a supported
feature again.
#9493: Symbolic link components are no longer resolved in conftest paths.
This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice.
For example, given
running
pytest tests
now imports the conftest twice, once astests/real/conftest.py
and once astests/link/conftest.py
.This is a fix to match a similar change made to test collection itself in pytest 6.0 (see
6523
{.interpreted-text role="pull"} for details).#9626: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules.
If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count.
#9645: Fixed regression where
--import-mode=importlib
used together withPYTHONPATH
{.interpreted-text role="envvar"} orpythonpath
{.interpreted-text role="confval"} would cause import errors in test suites.#9708:
pytester
{.interpreted-text role="fixture"} now requests amonkeypatch
{.interpreted-text role="fixture"} fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables.#9730: Malformed
pyproject.toml
files now produce a clearer error message.v7.0.1
Compare Source
pytest 7.0.1 (2022-02-11)
Bug Fixes
importlib.readers
in Python 3.9.Fixes a crash during a failed teardown in unittest TestCases with non-default [__init__]{.title-ref}.
Regressed in pytest 7.0.0.
pythonpath
plugin was renamed topython_path
. This avoids a conflict with thepytest-pythonpath
plugin.::
in the parametrize portion.~pytest.PytestWarning
{.interpreted-text role="class"} about diamond inheritance involving~pytest.Item
{.interpreted-text role="class"} and~pytest.Collector
{.interpreted-text role="class"} so it can be filtered usingstandard warning filters <warnings>
{.interpreted-text role="ref"}.v7.0.0
Compare Source
pytest 7.0.0 (2022-02-03)
(Please see the full set of changes for this release also in the 7.0.0rc1 notes below)
Deprecations
#9488: If custom subclasses of nodes like
pytest.Item
{.interpreted-text role="class"} override the__init__
method, they should take**kwargs
. Seeuncooperative-constructors-deprecated
{.interpreted-text role="ref"} for details.Note that a deprection warning is only emitted when there is a conflict in the
arguments pytest expected to pass. This deprecation was already part of pytest
7.0.0rc1 but wasn't documented.
Bug Fixes
pytest.Config.inifile
{.interpreted-text role="attr"} is available during thepytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>
{.interpreted-text role="func"} hook (regression during7.0.0rc1
).Improved Documentation
that configuration file is located in the root of the repository.
Trivial/Internal Changes
pytest 7.0.0rc1 (2021-12-06)
Breaking Changes
#7259: The
Node.reportinfo() <non-python tests>
{.interpreted-text role="ref"} function first return value type has been expanded from [py.path.local | str]{.title-ref} to [os.PathLike[str] | str]{.title-ref}.Most plugins which refer to [reportinfo()]{.title-ref} only define it as part of a custom
pytest.Item
{.interpreted-text role="class"} implementation.Since [py.path.local]{.title-ref} is a [os.PathLike[str]]{.title-ref}, these plugins are unaffacted.
Plugins and users which call [reportinfo()]{.title-ref}, use the first return value and interact with it as a [py.path.local]{.title-ref}, would need to adjust by calling [py.path.local(fspath)]{.title-ref}.
Although preferably, avoid the legacy [py.path.local]{.title-ref} and use [pathlib.Path]{.title-ref}, or use [item.location]{.title-ref} or [item.path]{.title-ref}, instead.
Note: pytest was not able to provide a deprecation period for this change.
#8246:
--version
now writes version information tostdout
rather thanstderr
.#8733: Drop a workaround for pyreadline that made it work with
--pdb
.The workaround was introduced in #1281 in 2015, however since then
pyreadline seems to have gone unmaintained, is generating
warnings, and will stop working on Python 3.10.
#9061: Using
pytest.approx
{.interpreted-text role="func"} in a boolean context now raises an error hinting at the proper usage.It is apparently common for users to mistakenly use
pytest.approx
like this:While the correct usage is:
The new error message helps catch those mistakes.
#9277: The
pytest.Instance
collector type has been removed.Importing
pytest.Instance
or_pytest.python.Instance
returns a dummy type and emits a deprecation warning.See
instance-collector-deprecation
{.interpreted-text role="ref"} for details.#9308: PytestRemovedIn7Warning deprecation warnings are now errors by default.
Following our plan to remove deprecated features with as little disruption as
possible, all warnings of type
PytestRemovedIn7Warning
now generate errorsinstead of warning messages by default.
The affected features will be effectively removed in pytest 7.1, so please consult the
deprecations
{.interpreted-text role="ref"} section in the docs for directions on how to update existing code.In the pytest
7.0.X
series, it is possible to change the errors back into warnings as astopgap measure by adding this to your
pytest.ini
file:But this will stop working when pytest
7.1
is released.If you have concerns about the removal of a specific feature, please add a
comment to
9308
{.interpreted-text role="issue"}.Deprecations
#7259:
py.path.local
arguments for hooks have been deprecated. Seethe deprecation note <legacy-path-hooks-deprecated>
{.interpreted-text role="ref"} for full details.py.path.local
arguments to Node constructors have been deprecated. Seethe deprecation note <node-ctor-fspath-deprecation>
{.interpreted-text role="ref"} for full details.::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#7469: Directly constructing the following classes is now deprecated:
_pytest.mark.structures.Mark
_pytest.mark.structures.MarkDecorator
_pytest.mark.structures.MarkGenerator
_pytest.python.Metafunc
_pytest.runner.CallInfo
_pytest._code.ExceptionInfo
_pytest.config.argparsing.Parser
_pytest.config.argparsing.OptionGroup
_pytest.pytester.HookRecorder
These constructors have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8.
#8242: Raising
unittest.SkipTest
{.interpreted-text role="class"} to skip collection of tests during thepytest collection phase is deprecated. Use
pytest.skip
{.interpreted-text role="func"} instead.Note: This deprecation only relates to using
unittest.SkipTest
{.interpreted-text role="class"} during testcollection. You are probably not doing that. Ordinary usage of
unittest.SkipTest
{.interpreted-text role="class"} /unittest.TestCase.skipTest
{.interpreted-text role="meth"} /unittest.skip
{.interpreted-text role="func"} in unittest test cases is fully supported.#8315: Several behaviors of
Parser.addoption <pytest.Parser.addoption>
{.interpreted-text role="meth"} are nowscheduled for removal in pytest 8 (deprecated since pytest 2.4.0):
parser.addoption(..., help=".. %default ..")
- use%(default)s
instead.parser.addoption(..., type="int/string/float/complex")
- usetype=int
etc. instead.#8447: Defining a custom pytest node type which is both an
pytest.Item <Item>
{.interpreted-text role="class"} and apytest.Collector <Collector>
{.interpreted-text role="class"} (e.g.pytest.File <File>
{.interpreted-text role="class"}) now issues a warning.It was never sanely supported and triggers hard to debug errors.
See
the deprecation note <diamond-inheritance-deprecated>
{.interpreted-text role="ref"} for full details.#8592:
pytest_cmdline_preparse
{.interpreted-text role="hook"} has been officially deprecated. It will be removed in a future release. Usepytest_load_initial_conftests
{.interpreted-text role="hook"} instead.See
the deprecation note <cmdline-preparse-deprecated>
{.interpreted-text role="ref"} for full details.#8645:
pytest.warns(None) <pytest.warns>
{.interpreted-text role="func"} is now deprecated because many people usedit to mean "this code does not emit warnings", but it actually had the effect of
checking that the code emits at least one warning of any type - like
pytest.warns()
or
pytest.warns(Warning)
.#8948:
pytest.skip(msg=...) <pytest.skip>
{.interpreted-text role="func"},pytest.fail(msg=...) <pytest.fail>
{.interpreted-text role="func"} andpytest.exit(msg=...) <pytest.exit>
{.interpreted-text role="func"}signatures now accept a
reason
argument instead ofmsg
. Usingmsg
still works, but is deprecated and will be removed in a future release.This was changed for consistency with
pytest.mark.skip <pytest.mark.skip>
{.interpreted-text role="func"} andpytest.mark.xfail <pytest.mark.xfail>
{.interpreted-text role="func"} which both acceptreason
as an argument.#8174: The following changes have been made to types reachable through
pytest.ExceptionInfo.traceback
{.interpreted-text role="attr"}:path
property of_pytest.code.Code
returnsPath
instead ofpy.path.local
.path
property of_pytest.code.TracebackEntry
returnsPath
instead ofpy.path.local
.There was no deprecation period for this change (sorry!).
Features
#5196: Tests are now ordered by definition order in more cases.
In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order).
#7132: Added two environment variables
PYTEST_THEME
{.interpreted-text role="envvar"} andPYTEST_THEME_MODE
{.interpreted-text role="envvar"} to let the users customize the pygments theme used.#7259: Added
cache.mkdir() <pytest.Cache.mkdir>
{.interpreted-text role="meth"}, which is similar to the existingcache.makedir() <pytest.Cache.makedir>
{.interpreted-text role="meth"},but returns a
pathlib.Path
{.interpreted-text role="class"} instead of a legacypy.path.local
.Added a
paths
type toparser.addini() <pytest.Parser.addini>
{.interpreted-text role="meth"},as in
parser.addini("mypaths", "my paths", type="paths")
,which is similar to the existing
pathlist
,but returns a list of
pathlib.Path
{.interpreted-text role="class"} instead of legacypy.path.local
.#7469: The types of objects used in pytest's API are now exported so they may be used in type annotations.
The newly-exported types are:
pytest.Config
forConfig <pytest.Config>
{.interpreted-text role="class"}.pytest.Mark
formarks <pytest.Mark>
{.interpreted-text role="class"}.pytest.MarkDecorator
formark decorators <pytest.MarkDecorator>
{.interpreted-text role="class"}.pytest.MarkGenerator
for thepytest.mark <pytest.MarkGenerator>
{.interpreted-text role="class"} singleton.pytest.Metafunc
for themetafunc <pytest.MarkGenerator>
{.interpreted-text role="class"} argument to thepytest_generate_tests
{.interpreted-text role="hook"} hook.pytest.CallInfo
for theCallInfo <pytest.CallInfo>
{.interpreted-text role="class"} type passed to various hooks.pytest.PytestPluginManager
forPytestPluginManager <pytest.PytestPluginManager>
{.interpreted-text role="class"}.pytest.ExceptionInfo
for theExceptionInfo <pytest.ExceptionInfo>
{.interpreted-text role="class"} type returned frompytest.raises
{.interpreted-text role="func"} and passed to various hooks.pytest.Parser
for theParser <pytest.Parser>
{.interpreted-text role="class"} type passed to thepytest_addoption
{.interpreted-text role="hook"} hook.pytest.OptionGroup
for theOptionGroup <pytest.OptionGroup>
{.interpreted-text role="class"} type returned from theparser.addgroup <pytest.Parser.getgroup>
{.interpreted-text role="func"} method.pytest.HookRecorder
for theHookRecorder <pytest.HookRecorder>
{.interpreted-text role="class"} type returned from~pytest.Pytester
{.interpreted-text role="class"}.pytest.RecordedHookCall
for theRecordedHookCall <pytest.HookRecorder>
{.interpreted-text role="class"} type returned from~pytest.HookRecorder
{.interpreted-text role="class"}.pytest.RunResult
for theRunResult <pytest.RunResult>
{.interpreted-text role="class"} type returned from~pytest.Pytester
{.interpreted-text role="class"}.pytest.LineMatcher
for theLineMatcher <pytest.RunResult>
{.interpreted-text role="class"} type used in~pytest.RunResult
{.interpreted-text role="class"} and others.pytest.TestReport
for theTestReport <pytest.TestReport>
{.interpreted-text role="class"} type used in various hooks.pytest.CollectReport
for theCollectReport <pytest.CollectReport>
{.interpreted-text role="class"} type used in various hooks.Constructing most of them directly is not supported; they are only meant for use in type annotations.
Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0.
Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.
#7856:
--import-mode=importlib <import-modes>
{.interpreted-text role="ref"} now works with features thatdepend on modules being on :py
sys.modules
{.interpreted-text role="data"}, such aspickle
{.interpreted-text role="mod"} anddataclasses
{.interpreted-text role="mod"}.#8144: The following hooks now receive an additional
pathlib.Path
argument, equivalent to an existingpy.path.local
argument:pytest_ignore_collect
{.interpreted-text role="hook"} - Thecollection_path
parameter (equivalent to existingpath
parameter).pytest_collect_file
{.interpreted-text role="hook"} - Thefile_path
parameter (equivalent to existingpath
parameter).pytest_pycollect_makemodule
{.interpreted-text role="hook"} - Themodule_path
parameter (equivalent to existingpath
parameter).pytest_report_header
{.interpreted-text role="hook"} - Thestart_path
parameter (equivalent to existingstartdir
parameter).pytest_report_collectionfinish
{.interpreted-text role="hook"} - Thestart_path
parameter (equivalent to existingstartdir
parameter).::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#8251: Implement
Node.path
as apathlib.Path
. Both the oldfspath
and this new attribute gets set no matter whetherpath
orfspath
(deprecated) is passed to the constructor. It is a replacement for thefspath
attribute (which represents the same path aspy.path.local
). Whilefspath
is not deprecated yetdue to the ongoing migration of methods like
~_pytest.Item.reportinfo
{.interpreted-text role="meth"}, we expect to deprecate it in a future release.::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#8421:
pytest.approx
{.interpreted-text role="func"} now works on~decimal.Decimal
{.interpreted-text role="class"} within mappings/dicts and sequences/lists.#8606: pytest invocations with
--fixtures-per-test
and--fixtures
have been enriched with:--verbose
option.#8761: New
version-tuple
{.interpreted-text role="ref"} attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions).#8789: Switch TOML parser from
toml
totomli
for TOML v1.0.0 support inpyproject.toml
.#8920: Added
pytest.Stash
{.interpreted-text role="class"}, a facility for plugins to store their data on~pytest.Config
{.interpreted-text role="class"} and~_pytest.nodes.Node
{.interpreted-text role="class"}s in a type-safe and conflict-free manner.See
plugin-stash
{.interpreted-text role="ref"} for details.#8953:
RunResult <_pytest.pytester.RunResult>
{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>
{.interpreted-text role="meth"} now accepts awarnings
argument to assert the total number of warnings captured.#8954:
--debug
flag now accepts astr
{.interpreted-text role="class"} file to route debug logs into, remains defaulted to [pytestdebug.log]{.title-ref}.#9023: Full diffs are now always shown for equality assertions of iterables when
[CI]{.title-ref} or
BUILD_NUMBER
is found in the environment, even when-v
isn'tused.
#9113:
RunResult <_pytest.pytester.RunResult>
{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>
{.interpreted-text role="meth"} now accepts adeselected
argument to assert the total number of deselected tests.#9114: Added
pythonpath
{.interpreted-text role="confval"} setting that adds listed paths tosys.path
{.interpreted-text role="data"} for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in [pythonpath]{.title-ref} setting.Improvements
#7480: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category [PytestRemovedInXWarning]{.title-ref},
a subclass of
~pytest.PytestDeprecationWarning
{.interpreted-text role="class"},instead of
PytestDeprecationWarning
{.interpreted-text role="class"} directly.See
backwards-compatibility
{.interpreted-text role="ref"} for more details.#7864: Improved error messages when parsing warning filters.
Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause
of the problem (for example an
ImportError
while importing a specific warning type).#8335: Improved
pytest.approx
{.interpreted-text role="func"} assertion messages for sequences of numbers.The assertion messages now dumps a table with the index and the error of each diff.
Example:
#8403: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much,
currently at
240
characters by default.However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using
-v
willnow increase the truncation threshold to
2400
characters, and-vv
or higher will disable truncation entirely.#8509: Fixed issue where
unittest.TestCase.setUpClass
{.interpreted-text role="meth"} is not called when a test has [/]{.title-ref} in its name since pytest 6.2.0.This refers to the path part in pytest node IDs, e.g.
TestClass::test_it
in the node IDtests/test_file.py::TestClass::test_it
.Now, instead of assuming that the test name does not contain
/
, it is assumed that test path does not contain::
. We plan to hopefully make both of these work in the future.#8803: It is now possible to add colors to custom log levels on cli log.
By using
add_color_level <_pytest.logging.add_color_level>
{.interpreted-text role="func"} from apytest_configure
hook, colors can be added:See
log_colors
{.interpreted-text role="ref"} for more information.#8822: When showing fixture paths in [--fixtures]{.title-ref} or [--fixtures-by-test]{.title-ref}, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the [site-packages]{.title-ref} directory.
#8898: Complex numbers are now treated like floats and integers when generating parameterization IDs.
#9062:
--stepwise-skip
now implicitly enables--stepwise
and can be used on its own.#9205:
pytest.Cache.set
{.interpreted-text role="meth"} now preserves key order when saving dicts.Bug Fixes
#7124: Fixed an issue where
__main__.py
would raise anImportError
when--doctest-modules
was provided.#8061: Fixed failing
staticmethod
test cases if they are inherited from a parent test class.#8192:
testdir.makefile
now silently accepts values which don't start with.
to maintain backward compatibility with older pytest versions.pytester.makefile
now issues a clearer error if the.
is missing in theext
argument.#8258: Fixed issue where pytest's
faulthandler
support would not dump traceback on crashesif the
faulthandler
{.interpreted-text role="mod"} module was already enabled during pytest startup (usingpython -X dev -m pytest
for example).#8317: Fixed an issue where illegal directory characters derived from
getpass.getuser()
raised anOSError
.#8367: Fix
Class.from_parent
so it forwards extra keyword arguments to the constructor.#8377: The test selection options
pytest -k
andpytest -m
now support matchingnames containing forward slash (
/
) characters.#8384: The
@pytest.mark.skip
decorator now correctly handles its arguments. When thereason
argument is accidentally given both positional and as a keyword (e.g. because it was confused withskipif
), aTypeError
now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally,reason
is now documented correctly as positional or keyword (rather than keyword-only).#8394: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default
--fixtures
invocation (but they still show up with--fixtures -v
).#8456: The
required_plugins
{.interpreted-text role="confval"} config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all.#8464:
-c <config file>
now also properly definesrootdir
as the directory that contains<config file>
.#8503:
pytest.MonkeyPatch.syspath_prepend
{.interpreted-text role="meth"} no longer fails whensetuptools
is not installed.It now only calls
pkg_resources.fixup_namespace_packages
{.interpreted-text role="func"} ifpkg_resources
was previously imported, because it is not needed otherwise.#8548: Introduce fix to handle precision width in
log-cli-format
in turn to fix output coloring for certain formats.#8796: Fixed internal error when skipping doctests.
#8983: The test selection options
pytest -k
andpytest -m
now support matching names containing backslash ([\]{.title-ref}) characters.Backslashes are treated literally, not as escape characters (the values being matched against are already escaped).
#8990: Fix [pytest -vv]{.title-ref} crashing with an internal exception [AttributeError: 'str' object has no attribute 'relative_to']{.title-ref} in some cases.
#9077: Fixed confusing error message when
request.fspath
/request.path
was accessed from a session-scoped fixture.#9131: Fixed the URL used by
--pastebin
to use bpa.st.#9163: The end line number and end column offset are now properly set for rewritten assert statements.
#9169: Support for the
files
API fromimportlib.resources
within rewritten files.#9272: The nose compatibility module-level fixtures [setup()]{.title-ref} and [teardown()]{.title-ref} are now only called once per module, instead of for each test function.
They are now called even if object-level [setup]{.title-ref}/[teardown]{.title-ref} is defined.
Improved Documentation
plugin-list
{.interpreted-text role="ref"}. The list is updated on a periodic schedule.pytest.approx
{.interpreted-text role="func"} documentation.--pdbcls
more accurately reflects the option's behavior.confcutdir
being a configuration option: it can only be set through the--confcutdir
command-line option.non-python tests
{.interpreted-text role="ref"} are now correctly documented in the reference docs. They were undocumented previously.Trivial/Internal Changes
setuptools_scm
6.x to useSETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST
for more robust release tooling._pytest.code.getfslineno()
function returnsPath
instead ofpy.path.local
._pytest.python.path_matches_patterns()
function takesPath
instead ofpy.path.local
._pytest._code.Traceback.cut()
function accepts anyos.PathLike[str]
, not justpy.path.local
.python.PyObjMixin
inherit fromnodes.Node
to carry over typing information.pytest.skip
{.interpreted-text role="func"} is used at module level without passing [allow_module_level=True]{.title-ref}.regendoc
opts out ofTOX_ENV
cachedir selection to ensure independent example test runs.CallSpec2._arg2scopenum
attribute has been removed after an internal refactoring.pytest_assertion_pass
{.interpreted-text role="hook"} is no longer considered experimental andfuture changes to it will be considered more carefully.
v6.2.5
Compare Source
pytest 6.2.5 (2021-08-29)
Trivial/Internal Changes
pluggy 1.0
or later.v6.2.4
Compare Source
pytest 6.2.4 (2021-05-04)
Bug Fixes
v6.2.3
Compare Source
pytest 6.2.3 (2021-04-03)
Bug Fixes
#8414: pytest used to create directories under
/tmp
with world-readablepermissions. This means that any user in the system was able to read
information written by tests in temporary directories (such as those created by
the
tmp_path
/tmpdir
fixture). Now the directories are created withprivate permissions.
pytest used silenty use a pre-existing
/tmp/pytest-of-<username>
directory,even if owned by another user. This means another user could pre-create such a
directory and gain control of another user's temporary directory. Now such a
condition results in an error.
v6.2.2
Compare Source
pytest 6.2.2 (2021-01-25)
Bug Fixes
faulthandler
plugin for occasions when running withtwisted.logger
and usingpytest --capture=no
.v6.2.1
Compare Source
pytest 6.2.1 (2020-12-15)
Bug Fixes
#7678: Fixed bug where
ImportPathMismatchError
would be raised for files compiled inthe host and loaded later from an UNC mounted path (Windows).
#8132: Fixed regression in
approx
: in 6.2.0approx
no longer raisesTypeError
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 tonumpy.ndarray
if they expose the arrayprotocol and are not scalars. This treats array-like objects like numpy arrays,
regardless of size.
v6.2.0
Compare Source
pytest 6.2.0 (2020-12-12)
Breaking Changes
Deprecations
#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 strictnessrelated 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 pytest.fixture instead.yield_fixture
has been an alias forfixture
for a very long time, so can be search/replaced safely.Features
#5299: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8.
See unraisable for more information.
#7425: New pytester fixture, which is identical to testdir but its methods return pathlib.Path when appropriate instead of
py.path.local
.This is part of the movement to use pathlib.Path objects internally, in order to remove the dependency to
py
in the future.Internally, the old Testdir <_pytest.pytester.Testdir> is now a thin wrapper around 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
conftest.py
:test_func.py
:#8006: It is now possible to construct a ~pytest.MonkeyPatch object directly as
pytest.MonkeyPatch()
,in cases when the monkeypatch fixture cannot be used. Previously some users imported it
from the private _pytest.monkeypatch.MonkeyPatch namespace.
Additionally, 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 useMonkeyPatch
directly, since unlike themonkeypatch
fixture, an instance created directlyis not
undo()
-ed automatically.Improvements
#1265: Added an
__str__
implementation to the ~pytest.pytester.LineMatcher class which is returned frompytester.run_pytest().stdout
and similar. It returns the entire output, like the existingstr()
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 request fixture.pytest.Cache
for the cache fixture.pytest.CaptureFixture[str]
for the capfd and capsys fixtures.pytest.CaptureFixture[bytes]
for the capfdbinary and capsysbinary fixtures.pytest.LogCaptureFixture
for the caplog fixture.pytest.Pytester
for the pytester fixture.pytest.Testdir
for the testdir fixture.pytest.TempdirFactory
for the tmpdir_factory fixture.pytest.TempPathFactory
for the tmp_path_factory fixture.pytest.MonkeyPatch
for the monkeypatch fixture.pytest.WarningsRecorder
for the 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 namedtuple <collections.namedtuple> instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes.
#7615: Node.warn <_pytest.nodes.Node.warn> now permits any subclass of Warning, not just 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 pytest.approx instead of
raising 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 norecursedirs.#8032: doClassCleanups <unittest.TestCase.doClassCleanups> (introduced in unittest in Python and 3.8) is now called appropriately.
Bug Fixes
--lf
even though they contain tests that failed. Regressed in pytest 5.4.0.pytest --doctest-modules path/to/an/__init__.py
.Improved Documentation
final class
in the API reference._pytest.config.argparsing.Parser.addini()
accepts explicitNone
and"string"
.Trivial/Internal Changes
attrs
dependency requirement is now >=19.2.0 instead of >=17.4.0.(These files are internal and only interpreted by pytest itself.)
v6.1.2
Compare Source
pytest 6.1.2 (2020-10-28)
Bug Fixes
--lf
even though they contain tests that failed. Regressed in pytest 5.4.0.Improved Documentation
pytest._fillfuncargs()
.v6.1.1
Compare Source
pytest 6.1.1 (2020-10-03)
Bug Fixes
v6.1.0
Compare Source
pytest 6.1.0 (2020-09-26)
Breaking Changes
#5585: As per our policy, the following features which have been deprecated in the 5.X series are now
removed:
funcargnames
read-only property ofFixtureRequest
,Metafunc
, andFunction
classes. Usefixturenames
attribute.@pytest.fixture
no longer supports positional arguments, pass all arguments by keyword instead.Node
subclasses now raise an error, usefrom_parent
instead.junit_family
has changed toxunit2
. If you require the old format, addjunit_family=xunit1
to your configuration file.TerminalReporter
no longer has awriter
attribute. Plugin authors may use the public functions of theTerminalReporter
instead of accessing theTerminalWriter
object directly.--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.
Deprecations
#6981: The
pytest.collect
module is deprecated: all its names can be imported frompytest
directly.#7097: The
pytest._fillfuncargs
function is deprecated. This function was keptfor 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'
instead.
The special
-k 'expr:'
syntax to-k
is deprecated. Please open an issueif you use this and want a replacement.
#7255: The pytest_warning_captured <_pytest.hookspec.pytest_warning_captured> hook is deprecated in favor
of pytest_warning_recorded <_pytest.hookspec.pytest_warning_recorded>, and will be removed in a future version.
#7648: The
gethookproxy()
andisinitpath()
methods ofFSCollector
andPackage
are deprecated;use
self.session.gethookproxy()
andself.session.isinitpath()
instead.This should work on all pytest versions.
Features
--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 to0.005s
.Improvements
#6681: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through 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 rootpath <_pytest.config.Config.rootpath> and inipath <_pytest.config.Config.inipath> to Config <_pytest.config.Config>.
These attributes are pathlib.Path versions of the existing rootdir <_pytest.config.Config.rootdir> and 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.
conftest.py
test_foo.py
IndexError: list index out of range
whencollecting a module which starts with a decorated function, the decorator
raises, and assertion rewriting is enabled.
\projects\tests\test.py
instead ofc:\projects\tests\pytest.py
).pytest-xdist
.exec
.Improved Documentation
Trivial/Internal Changes
junitxml
plugin has rewritten to usexml.etree.ElementTree
.The order of attributes in XML elements might differ. Some unneeded escaping is
no longer performed.
more-itertools
package has been removed.but should behave like one in all respects. This was done for technical reasons.
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 python_classes andpython_functions configuration options and without passing them to plugins
using the pytest_pycollect_makeitem <_pytest.hookspec.pytest_pycollect_makeitem> hook.
v6.0.2
Compare Source
pytest 6.0.2 (2020-09-04)
Bug Fixes
--log-cli
potentially causing unrelatedprint
output to be swallowed.caplog.set_level
is called more than once.Regressed in pytest 6.0.0.
--tb=line
for example).v6.0.1
Compare Source
pytest 6.0.1 (2020-07-30)
Bug Fixes
help
value toParser.add_option
is now accepted instead of crashing when runningpytest --help
.Passing
None
raises a more informativeTypeError
.not-callable
lint onpytest.mark.parametrize()
and the other builtin marks:skip
,skipif
,xfail
,usefixtures
,filterwarnings
.TestReport.longreprtext
(such aspytest-html
) whenTestReport.longrepr
is not a string.caplog.set_level()
.v6.0.0
Compare Source
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 errorsinstead 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 astopgap measure by adding this to your
pytest.ini
file: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_()
andis_true()
methods of_pytest._code.Frame
have been removed.Features
Improvements
--log-file
CLI option andlog_file
ini marker now create subdirectories if needed.match
equals the obtained string but is not a regex match. In this case it is suggested to escape the regex.Bug Fixes
@pytest.mark.skip
when--runxfail
is used.stale temporary directories is not accessible.
capfd
.TracebackEntry.__str__
which was changed by accident.Improved Documentation
usefixtures
mark can apply fixtures to test.-q
option used in getting started guide.Trivial/Internal Changes
package
is no longer considered experimental.pytest 6.0.0rc1 (2020-07-08)
Breaking Changes
#1316:
TestReport.longrepr
is now always an instance ofReprExceptionInfo
. Previously it was astr
when a test failed withpytest.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 changemeant to improve the terminal summary by using singular form single items (
1 warning
or1 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:
Need to be changed to:
#6903: The
os.dup()
function is now assumed to exist. We are not aware of anysupported 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 nodesare named, and also one of the reasons why
-k
would match against any directory containingthe test suite.
#7122: Expressions given to the
-m
and-k
options are no longer evaluated using Python's 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 thepy
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:
write()
method and others) no longer flush implicitly; the flushing behaviorof 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)
orterminal_writer.flush()
.bytes
was removed.reline
method andchars_on_current_line
property were removed.stringio
andencoding
arguments 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 frompytest.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 herefor the benefit of plugin authors who may be using it:
deindent
argument toSource()
has been removed, now it is always true.Source()
has been removed.Source
with anstr
has been removed.Source.isparseable()
andSource.putaround()
have been removed.Source.compile()
and function_pytest._code.compile()
havebeen removed; use plain
compile()
instead._pytest._code.source.getsource()
has been removed; useSource()
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 issueif you use this and want a replacement.
#4049:
pytest_warning_captured
is deprecated in favor of thepytest_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:pyproject.toml
#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:
#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 changingsys.path
to import test modules (whichalso changes
sys.modules
as a side-effect), which works but has a number of drawbacks, like requiring test modulesthat 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 fromimportlib
which don'trequire pytest to change
sys.path
orsys.modules
at all, eliminating much of the drawbacksof the previous mode.
We intend to make
--import-mode=importlib
the default in future versions, so users are encouragedto 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 theBrokenPipeError
error message thatis printed to stderr when the output of
pytest
is piped and and the pipe isclosed by the piped-to program (common examples are
less
andhead
).#4391: Improved precision of test durations measurement.
CallInfo
items now have a new<CallInfo>.duration
attribute, created usingtime.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 ontime.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 ismissing), 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 thecapfd
andcapfdbinary
fixtures, and the file descriptor (0, 1, 2) cannot beduplicated, 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: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> will now override any log_level set via the CLI or configuration file.
#7159: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> and 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 themessage
XML attribute for failures during setup and teardown.Previously:
Now:
Bug Fixes
#1120: Fix issue where directories from 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 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 tmp_path and 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 tmpdir.
#6871: Fix crash with captured output when using 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 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 aparametrize
parameter when Python is called with the
-bb
flag.#7143: Fix 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 unittest.TestCase.tearDown for skipped tests.#7253: When using
pytest.fixture
on a function directly, as inpytest.fixture(func)
,if the
autouse
orparams
arguments are also passed, the function is no longerignored, but is marked as a fixture.
#7360: Fix possibly incorrect evaluation of string expressions passed to
pytest.mark.skipif
andpytest.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
--strict
and--strict-markers
and the preference for the latter one.Trivial/Internal Changes
originalname
attribute of_pytest.python.Function
now defaults toname
if notprovided explicitly, and is always set.
wcwidth
package has been removed.py.iniconfig
with iniconfig.src/_pytest/config/__init__.py
now uses thewarnings
module to report warnings instead ofsys.stderr.write
.pytest-xdist
.py
>=1.8.2 is now required.v5.4.3
Compare Source
pytest 5.4.3 (2020-06-02)
Bug Fixes
changed since the start of the session.
ConfTestImportFailure
is raised.--pdb
would call thetearDown
methods ofunittest.TestCase
subclasses for skipped tests.
v5.4.2
Compare Source
pytest 5.4.2 (2020-05-08)
Bug Fixes
unittest.IsolatedAsyncioTestCase
is actually awaited.TestCase.addCleanup
were not being called on test failures.TerminalReporter.writer
attribute.asyncbase.TestCase
tests are executed correctly again.File.from_constructor
so it forwards extra keyword arguments to the constructor.__getattribute__
methods are displayed correctly during failures._is_setup_py
for files encoded differently than locale.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.
34f24ec2ca
to4c1c04f435
4c1c04f435
to8c3d8ae96e