chore(deps): update dependency pytest to v8 (master) #1023
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==6.2.5
->==8.0.1
Release Notes
pytest-dev/pytest (pytest)
v8.0.1
Compare Source
pytest 8.0.1 (2024-02-16)
Bug Fixes
getpass.getuser
{.interpreted-text role="func"} in Python 3.13.ExceptionInfo._stringify_exception
could crashpytest.raises
{.interpreted-text role="func"}.pytest.warns
{.interpreted-text role="func"} using custom warning subclasses which have more than one parameter in their [__init__]{.title-ref}.pytest.skip
{.interpreted-text role="func"} and similar control-flow exceptions within apytest.warns()
{.interpreted-text role="func"} block would get suppressed instead of propagating.v8.0.0
: pytest 8.0.0 (2024-01-27)Compare Source
See 8.0.0rc1 and 8.0.0rc2 for the full changes since pytest 7.4!
Bug Fixes
reason
of askip <pytest.mark.skip ref>
{.interpreted-text role="ref"} mark when writing JUnit XML files.1_000_000
when usinglog-date-format
with%f
specifier, which might cause the test suite to crash.v7.4.4
Compare Source
v7.4.3
: pytest 7.4.3 (2023-10-24)Compare Source
Bug Fixes
#10447: Markers are now considered in the reverse mro order to ensure base class markers are considered first -- this resolves a regression.
#11239: Fixed
:=
in asserts impacting unrelated test cases.#11439: Handled an edge case where :data:
sys.stderr
might already be closed when :ref:faulthandler
is tearing down.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](https://togithub.com/pytest-dev/pytest/issues/9
Configuration
📅 Schedule: Branch creation - "after 6pm and before 11pm every weekday,after 10am on saturday,on sunday" in timezone Asia/Taipei, 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 Mend Renovate. View repository job log here.