Update dependency pytest to v8 #33
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "renovate/pytest-8.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:
^6.2.2->^8.0.0Release Notes
pytest-dev/pytest (pytest)
v8.3.4Compare Source
pytest 8.3.4 (2024-12-01)
Bug fixes
#12592: Fixed
KeyError{.interpreted-text role="class"} crash when using--import-mode=importlibin a directory layout where a directory contains a child directory with the same name.#12818: Assertion rewriting now preserves the source ranges of the original instructions, making it play well with tools that deal with the
AST, like executing.#12849: ANSI escape codes for colored output now handled correctly in
pytest.fail{.interpreted-text role="func"} with [pytrace=False]{.title-ref}.#9353:
pytest.approx{.interpreted-text role="func"} now uses strict equality when given booleans.Improved documentation
#10558: Fix ambiguous docstring of
pytest.Config.getoption{.interpreted-text role="func"}.#10829: Improve documentation on the current handling of the
--basetempoption and its lack of retention functionality (temporary directory location and retention{.interpreted-text role="ref"}).#12866: Improved cross-references concerning the
recwarn{.interpreted-text role="fixture"} fixture.#12966: Clarify
filterwarnings{.interpreted-text role="ref"} docs on filter precedence/order when using multiple@pytest.mark.filterwarnings <pytest.mark.filterwarnings ref>{.interpreted-text role="ref"} marks.Contributor-facing changes
v8.3.3Compare Source
pytest 8.3.3 (2024-09-09)
Bug fixes
#12446: Avoid calling
@property(and other instance descriptors) during fixture discovery -- byasottile{.interpreted-text role="user"}#12659: Fixed the issue of not displaying assertion failure differences when using the parameter
--import-mode=importlibin pytest>=8.1.#12667: Fixed a regression where type change in [ExceptionInfo.errisinstance]{.title-ref} caused [mypy]{.title-ref} to fail.
#12744: Fixed typing compatibility with Python 3.9 or less -- replaced [typing.Self]{.title-ref} with [typing_extensions.Self]{.title-ref} -- by
Avasam{.interpreted-text role="user"}#12745: Fixed an issue with backslashes being incorrectly converted in nodeid paths on Windows, ensuring consistent path handling across environments.
#6682: Fixed bug where the verbosity levels where not being respected when printing the "msg" part of failed assertion (as in
assert condition, msg).#9422: Fix bug where disabling the terminal plugin via
-p no:terminalwould cause crashes related to missing theverboseoption.-- by
GTowers1{.interpreted-text role="user"}Improved documentation
Miscellaneous internal changes
v8.3.2Compare Source
pytest 8.3.2 (2024-07-24)
Bug fixes
#12652: Resolve regression [conda]{.title-ref} environments where no longer being automatically detected.
-- by
RonnyPfannschmidt{.interpreted-text role="user"}v8.3.1Compare Source
pytest 8.3.1 (2024-07-20)
The 8.3.0 release failed to include the change notes and docs for the release. This patch release remedies this. There are no other changes.
v8.3.0Compare Source
pytest 8.3.0 (2024-07-20)
New features
#12231: Added [--xfail-tb]{.title-ref} flag, which turns on traceback output for XFAIL results.
Some history:
With pytest 8.0, [-rx]{.title-ref} or [-ra]{.title-ref} would not only turn on summary reports for xfail, but also report the tracebacks for xfail results. This caused issues with some projects that utilize xfail, but don't want to see all of the xfail tracebacks.
This change detaches xfail tracebacks from [-rx]{.title-ref}, and now we turn on xfail tracebacks with [--xfail-tb]{.title-ref}. With this, the default [-rx]{.title-ref}/ [-ra]{.title-ref} behavior is identical to pre-8.0 with respect to xfail tracebacks. While this is a behavior change, it brings default behavior back to pre-8.0.0 behavior, which ultimately was considered the better course of action.
#12281: Added support for keyword matching in marker expressions.
Now tests can be selected by marker keyword arguments.
Supported values are
int{.interpreted-text role="class"}, (unescaped)str{.interpreted-text role="class"},bool{.interpreted-text role="class"} &None{.interpreted-text role="data"}.See
marker examples <marker_keyword_expression_example>{.interpreted-text role="ref"} for more information.-- by
lovetheguitar{.interpreted-text role="user"}#12567: Added
--no-fold-skippedcommand line option.If this option is set, then skipped tests in short summary are no longer grouped
by reason but all tests are printed individually with their nodeid in the same
way as other statuses.
-- by
pbrezina{.interpreted-text role="user"}Improvements in existing functionality
#12469: The console output now uses the "third-party plugins" terminology,
replacing the previously established but confusing and outdated
reference to
setuptools <setuptools:index>{.interpreted-text role="std:doc"}-- by
webknjaz{.interpreted-text role="user"}.#12544, #12545: Python virtual environment detection was improved by
checking for a
pyvenv.cfg{.interpreted-text role="file"} file, ensuring reliable detection onvarious platforms -- by
zachsnickers{.interpreted-text role="user"}.#2871: Do not truncate arguments to functions in output when running with [-vvv]{.title-ref}.
#389: The readability of assertion introspection of bound methods has been enhanced
-- by
farbodahm{.interpreted-text role="user"},webknjaz{.interpreted-text role="user"},obestwalter{.interpreted-text role="user"},flub{.interpreted-text role="user"}and
glyphack{.interpreted-text role="user"}.Earlier, it was like:
And now it's like:
#7662: Added timezone information to the testsuite timestamp in the JUnit XML report.
Bug fixes
#11706: Fixed reporting of teardown errors in higher-scoped fixtures when using [--maxfail]{.title-ref} or [--stepwise]{.title-ref}.
Originally added in pytest 8.0.0, but reverted in 8.0.2 due to a regression in pytest-xdist.
This regression was fixed in pytest-xdist 3.6.1.
#11797:
pytest.approx{.interpreted-text role="func"} now correctly handlesSequence <collections.abc.Sequence>{.interpreted-text role="class"}-like objects.#12204, #12264: Fixed a regression in pytest 8.0 where tracebacks get longer and longer when multiple
tests fail due to a shared higher-scope fixture which raised -- by
bluetech{.interpreted-text role="user"}.Also fixed a similar regression in pytest 5.4 for collectors which raise during setup.
The fix necessitated internal changes which may affect some plugins:
FixtureDef.cached_result[2]is now a tuple(exc, tb)instead of
exc.SetupState.stackfailures are now a tuple(exc, tb)instead of
exc.#12275: Fixed collection error upon encountering an
abstract <abc>{.interpreted-text role="mod"} class, including abstract [unittest.TestCase]{.title-ref} subclasses.#12328: Fixed a regression in pytest 8.0.0 where package-scoped parameterized items were not correctly reordered to minimize setups/teardowns in some cases.
#12424: Fixed crash with [assert testcase is not None]{.title-ref} assertion failure when re-running unittest tests using plugins like pytest-rerunfailures. Regressed in 8.2.2.
#12472: Fixed a crash when returning category
"error"or"failed"with a custom test status frompytest_report_teststatus{.interpreted-text role="hook"} hook --pbrezina{.interpreted-text role="user"}.#12505: Improved handling of invalid regex patterns in
pytest.raises(match=r'...') <pytest.raises>{.interpreted-text role="func"} by providing a clear error message.#12580: Fixed a crash when using the cache class on Windows and the cache directory was created concurrently.
#6962: Parametrization parameters are now compared using [==]{.title-ref} instead of [is]{.title-ref} ([is]{.title-ref} is still used as a fallback if the parameter does not support [==]{.title-ref}).
This fixes use of parameters such as lists, which have a different [id]{.title-ref} but compare equal, causing fixtures to be re-computed instead of being cached.
#7166: Fixed progress percentages (the
[ 87%]at the edge of the screen) sometimes not aligning correctly when running with pytest-xdist-n.Improved documentation
#12153: Documented using
PYTEST_VERSION{.interpreted-text role="envvar"} to detect if code is running from within a pytest run.#12469: The external plugin mentions in the documentation now avoid mentioning
setuptools entry-points <setuptools:index>{.interpreted-text role="std:doc"} as the concept ismuch more generic nowadays. Instead, the terminology of "external",
"installed", or "third-party" plugins (or packages) replaces that.
-- by
webknjaz{.interpreted-text role="user"}#12577: [CI]{.title-ref} and [BUILD_NUMBER]{.title-ref} environment variables role is discribed in
the reference doc. They now also appear when doing [pytest -h]{.title-ref}
-- by
MarcBresson{.interpreted-text role="user"}.Contributor-facing changes
#12467: Migrated all internal type-annotations to the python3.10+ style by using the [annotations]{.title-ref} future import.
-- by
RonnyPfannschmidt{.interpreted-text role="user"}#11771, #12557: The PyPy runtime version has been updated to 3.9 from 3.8 that introduced
a flaky bug at the garbage collector which was not expected to fix there
as the 3.8 is EoL.
-- by
x612skm{.interpreted-text role="user"}#12493: The change log draft preview integration has been refactored to use a
third party extension
sphinxcontib-towncrier. The previous in-reposcript was putting the change log preview file at
doc/en/_changelog_towncrier_draft.rst{.interpreted-text role="file"}. Said file is no longerignored in Git and might show up among untracked files in the
development environments of the contributors. To address that, the
contributors can run the following command that will clean it up:
-- by
webknjaz{.interpreted-text role="user"}#12498: All the undocumented
toxenvironments now have descriptions.They can be listed in one's development environment by invoking
tox -avin a terminal.-- by
webknjaz{.interpreted-text role="user"}#12501: The changelog configuration has been updated to introduce more accurate
audience-tailored categories. Previously, there was a
trivialchange log fragment type with an unclear and broad meaning. It was
removed and we now have
contrib,miscandpackaginginplace of it.
The new change note types target the readers who are downstream
packagers and project contributors. Additionally, the miscellaneous
section is kept for unspecified updates that do not fit anywhere else.
-- by
webknjaz{.interpreted-text role="user"}#12502: The UX of the GitHub automation making pull requests to update the
plugin list has been updated. Previously, the maintainers had to close
the automatically created pull requests and re-open them to trigger the
CI runs. From now on, they only need to click the [Ready for review]{.title-ref}
button instead.
-- by
webknjaz{.interpreted-text role="user"}#12522: The
:pull:RST role has been replaced with a shorter:pr:due to starting to use the implementation fromthe third-party
sphinx-issues{.interpreted-text role="pypi"} Sphinx extension-- by
webknjaz{.interpreted-text role="user"}.#12531: The coverage reporting configuration has been updated to exclude
pytest's own tests marked as expected to fail from the coverage
report. This has an effect of reducing the influence of flaky
tests on the resulting number.
-- by
webknjaz{.interpreted-text role="user"}#12533: The
extlinksSphinx extension is no longer enabled. The:bpo:role it used to declare has been removed with that. BPO itself has
migrated to GitHub some years ago and it is possible to link the
respective issues by using their GitHub issue numbers and the
:issue:role that thesphinx-issuesextension implements.-- by
webknjaz{.interpreted-text role="user"}#12562: Possible typos in using the
:user:RST role is now being lintedthrough the pre-commit tool integration -- by
webknjaz{.interpreted-text role="user"}.v8.2.2Compare Source
pytest 8.2.2 (2024-06-04)
Bug Fixes
.pytest_cache) creation. Regressed in pytest 8.2.0.Improved Documentation
lack of thread safety in pytest as a possible source of flakyness.
v8.2.1Compare Source
pytest 8.2.1 (2024-05-19)
Improvements
Bug Fixes
.pytest_cachedirectories becamerwx------instead of the expectedrwxr-xr-x.Trivial/Internal Changes
v8.2.0Compare Source
pytest 8.2.0 (2024-04-27)
Deprecations
#12069: A deprecation warning is now raised when implementations of one of the following hooks request a deprecated
py.path.localparameter instead of thepathlib.Pathparameter which replaced it:pytest_ignore_collect{.interpreted-text role="hook"} - thepathparameter - usecollection_pathinstead.pytest_collect_file{.interpreted-text role="hook"} - thepathparameter - usefile_pathinstead.pytest_pycollect_makemodule{.interpreted-text role="hook"} - thepathparameter - usemodule_pathinstead.pytest_report_header{.interpreted-text role="hook"} - thestartdirparameter - usestart_pathinstead.pytest_report_collectionfinish{.interpreted-text role="hook"} - thestartdirparameter - usestart_pathinstead.The replacement parameters are available since pytest 7.0.0.
The old parameters will be removed in pytest 9.0.0.
See
legacy-path-hooks-deprecated{.interpreted-text role="ref"} for more details.Features
#11871: Added support for reading command line arguments from a file using the prefix character
@, like e.g.:pytest @​tests.txt. The file must have one argument per line.See
Read arguments from file <args-from-file>{.interpreted-text role="ref"} for details.Improvements
#11523:
pytest.importorskip{.interpreted-text role="func"} will now issue a warning if the module could be found, but raisedImportError{.interpreted-text role="class"} instead ofModuleNotFoundError{.interpreted-text role="class"}.The warning can be suppressed by passing
exc_type=ImportErrortopytest.importorskip{.interpreted-text role="func"}.See
import-or-skip-import-error{.interpreted-text role="ref"} for details.#11728: For
unittest-based tests, exceptions during class cleanup (as raised by functions registered withTestCase.addClassCleanup <unittest.TestCase.addClassCleanup>{.interpreted-text role="meth"}) are now reported instead of silently failing.#11777: Text is no longer truncated in the
short test summary infosection when-vvis given.#12112: Improved namespace packages detection when
consider_namespace_packages{.interpreted-text role="confval"} is enabled, covering more situations (like editable installs).#9502: Added
PYTEST_VERSION{.interpreted-text role="envvar"} environment variable which is defined at the start of the pytest session and undefined afterwards. It contains the value ofpytest.__version__, and among other things can be used to easily check if code is running from within a pytest run.Bug Fixes
#12065: Fixed a regression in pytest 8.0.0 where test classes containing
setup_methodand tests using@staticmethodor@classmethodwould crash withAttributeError: 'NoneType' object has no attribute 'setup_method'.Now the
request.instance <pytest.FixtureRequest.instance>{.interpreted-text role="attr"} attribute of tests using@staticmethodand@classmethodis no longerNone, but a fresh instance of the class, like in non-static methods.Previously it was
None, and all fixtures of such tests would share a singleself.#12135: Fixed issue where fixtures adding their finalizer multiple times to fixtures they request would cause unreliable and non-intuitive teardown ordering in some instances.
#12194: Fixed a bug with
--importmode=importliband--doctest-moduleswhere child modules did not appear as attributes in parent modules.#1489: Fixed some instances where teardown of higher-scoped fixtures was not happening in the reverse order they were initialized in.
Trivial/Internal Changes
pluggy>=1.5.0is now required.cache <cache>{.interpreted-text role="ref"}: create supporting files (CACHEDIR.TAG,.gitignore, etc.) in a temporary directory to provide atomic semantics.v8.1.2Compare Source
pytest 8.1.2 (2024-04-26)
Bug Fixes
pytest.approx{.interpreted-text role="func"} when used with [numpy]{.title-ref} arrays and comparing with other types.v8.1.1Compare Source
pytest 8.1.1 (2024-03-08)
::: {.note}
::: {.title}
Note
:::
This release is not a usual bug fix release -- it contains features and improvements, being a follow up
to
8.1.0, which has been yanked from PyPI.:::
Features
#11475: Added the new
consider_namespace_packages{.interpreted-text role="confval"} configuration option, defaulting toFalse.If set to
True, pytest will attempt to identify modules that are part of namespace packages when importing modules.#11653: Added the new
verbosity_test_cases{.interpreted-text role="confval"} configuration option for fine-grained control of test execution verbosity.See
Fine-grained verbosity <pytest.fine_grained_verbosity>{.interpreted-text role="ref"} for more details.Improvements
#10865:
pytest.warns{.interpreted-text role="func"} now validates thatwarnings.warn{.interpreted-text role="func"} was called with a [str]{.title-ref} or a [Warning]{.title-ref}.Currently in Python it is possible to use other types, however this causes an exception when
warnings.filterwarnings{.interpreted-text role="func"} is used to filter those warnings (see CPython #103577 for a discussion).While this can be considered a bug in CPython, we decided to put guards in pytest as the error message produced without this check in place is confusing.
#11311: When using
--override-inifor paths in invocations without a configuration file defined, the current working directory is usedas the relative directory.
Previoulsy this would raise an
AssertionError{.interpreted-text role="class"}.#11475:
--import-mode=importlib <import-mode-importlib>{.interpreted-text role="ref"} now tries to import modules using the standard import mechanism (but still without changing :pysys.path{.interpreted-text role="data"}), falling back to importing modules directly only if that fails.This means that installed packages will be imported under their canonical name if possible first, for example
app.core.models, instead of having the module name always be derived from their path (for example.env310.lib.site_packages.app.core.models).#11801: Added the
iter_parents() <_pytest.nodes.Node.iter_parents>{.interpreted-text role="func"} helper method on nodes.It is similar to
listchain <_pytest.nodes.Node.listchain>{.interpreted-text role="func"}, but goes from bottom to top, and returns an iterator, not a list.#11850: Added support for
sys.last_exc{.interpreted-text role="data"} for post-mortem debugging on Python>=3.12.#11962: In case no other suitable candidates for configuration file are found, a
pyproject.toml(even without a[tool.pytest.ini_options]table) will be considered as the configuration file and define therootdir.#11978: Add
--log-file-modeoption to the logging plugin, enabling appending to log-files. This option accepts either"w"or"a"and defaults to"w".Previously, the mode was hard-coded to be
"w"which truncates the file before logging.#12047: When multiple finalizers of a fixture raise an exception, now all exceptions are reported as an exception group.
Previously, only the first exception was reported.
Bug Fixes
#11475: Fixed regression where
--importmode=importlibwould import non-test modules more than once.#11904: Fixed a regression in pytest 8.0.0 that would cause test collection to fail due to permission errors when using
--pyargs.This change improves the collection tree for tests specified using
--pyargs, see12043{.interpreted-text role="pull"} for a comparison with pytest 8.0 and <8.#12011: Fixed a regression in 8.0.1 whereby
setup_modulexunit-style fixtures are not executed when--doctest-modulesis passed.#12014: Fix the
stacklevelused when warning about marks used on fixtures.#12039: Fixed a regression in
8.0.2where tests created usingtmp_path{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.Improved Documentation
tmp_pathfixture in more detail.Trivial/Internal Changes
#11785: Some changes were made to private functions which may affect plugins which access them:
FixtureManager._getautousenames()now takes aNodeitself instead of the nodeid.FixtureManager.getfixturedefs()now takes theNodeitself instead of the nodeid._pytest.nodes.iterparentnodeids()function is removed without replacement.Prefer to traverse the node hierarchy itself instead.
If you really need to, copy the function from the previous pytest release.
#12069: Delayed the deprecation of the following features to
9.0.0:node-ctor-fspath-deprecation{.interpreted-text role="ref"}.legacy-path-hooks-deprecated{.interpreted-text role="ref"}.It was discovered after
8.1.0was released that the warnings about the impeding removal were not being displayed, so the team decided to revert the removal.This is the reason for
8.1.0being yanked.pytest 8.1.0 (YANKED)
::: {.note}
::: {.title}
Note
:::
This release has been yanked: it broke some plugins without the proper warning period, due to
some warnings not showing up as expected.
See #12069.
:::
v8.1.0Compare Source
pytest 8.1.0 (YANKED)
Features
#11475: Added the new
consider_namespace_packages{.interpreted-text role="confval"} configuration option, defaulting toFalse.If set to
True, pytest will attempt to identify modules that are part of namespace packages when importing modules.#11653: Added the new
verbosity_test_cases{.interpreted-text role="confval"} configuration option for fine-grained control of test execution verbosity.See
Fine-grained verbosity <pytest.fine_grained_verbosity>{.interpreted-text role="ref"} for more details.Improvements
#10865:
pytest.warns{.interpreted-text role="func"} now validates thatwarnings.warn{.interpreted-text role="func"} was called with a [str]{.title-ref} or a [Warning]{.title-ref}.Currently in Python it is possible to use other types, however this causes an exception when
warnings.filterwarnings{.interpreted-text role="func"} is used to filter those warnings (see CPython #103577 for a discussion).While this can be considered a bug in CPython, we decided to put guards in pytest as the error message produced without this check in place is confusing.
#11311: When using
--override-inifor paths in invocations without a configuration file defined, the current working directory is usedas the relative directory.
Previoulsy this would raise an
AssertionError{.interpreted-text role="class"}.#11475:
--import-mode=importlib <import-mode-importlib>{.interpreted-text role="ref"} now tries to import modules using the standard import mechanism (but still without changing :pysys.path{.interpreted-text role="data"}), falling back to importing modules directly only if that fails.This means that installed packages will be imported under their canonical name if possible first, for example
app.core.models, instead of having the module name always be derived from their path (for example.env310.lib.site_packages.app.core.models).#11801: Added the
iter_parents() <_pytest.nodes.Node.iter_parents>{.interpreted-text role="func"} helper method on nodes.It is similar to
listchain <_pytest.nodes.Node.listchain>{.interpreted-text role="func"}, but goes from bottom to top, and returns an iterator, not a list.#11850: Added support for
sys.last_exc{.interpreted-text role="data"} for post-mortem debugging on Python>=3.12.#11962: In case no other suitable candidates for configuration file are found, a
pyproject.toml(even without a[tool.pytest.ini_options]table) will be considered as the configuration file and define therootdir.#11978: Add
--log-file-modeoption to the logging plugin, enabling appending to log-files. This option accepts either"w"or"a"and defaults to"w".Previously, the mode was hard-coded to be
"w"which truncates the file before logging.#12047: When multiple finalizers of a fixture raise an exception, now all exceptions are reported as an exception group.
Previously, only the first exception was reported.
Bug Fixes
#11904: Fixed a regression in pytest 8.0.0 that would cause test collection to fail due to permission errors when using
--pyargs.This change improves the collection tree for tests specified using
--pyargs, see12043{.interpreted-text role="pull"} for a comparison with pytest 8.0 and <8.#12011: Fixed a regression in 8.0.1 whereby
setup_modulexunit-style fixtures are not executed when--doctest-modulesis passed.#12014: Fix the
stacklevelused when warning about marks used on fixtures.#12039: Fixed a regression in
8.0.2where tests created usingtmp_path{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.Improved Documentation
tmp_pathfixture in more detail.Trivial/Internal Changes
FixtureManager._getautousenames()now takes aNodeitself instead of the nodeid.FixtureManager.getfixturedefs()now takes theNodeitself instead of the nodeid._pytest.nodes.iterparentnodeids()function is removed without replacement.Prefer to traverse the node hierarchy itself instead.
If you really need to, copy the function from the previous pytest release.
v8.0.2Compare Source
pytest 8.0.2 (2024-02-24)
Bug Fixes
c:\PROGRA~1\tests).IndexErrorcrash raising fromgetstatementrange_ast.v8.0.1Compare Source
pytest 8.0.1 (2024-02-16)
Bug Fixes
getpass.getuser{.interpreted-text role="func"} in Python 3.13.ExceptionInfo._stringify_exceptioncould 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
reasonof askip <pytest.mark.skip ref>{.interpreted-text role="ref"} mark when writing JUnit XML files.1_000_000when usinglog-date-formatwith%fspecifier, which might cause the test suite to crash.v7.4.4: pytest 7.4.4 (2023-12-31)Compare Source
Bug Fixes
sys.stderr{.interpreted-text role="data"} andsys.__stderr__{.interpreted-text role="data"} might already be closed whenfaulthandler{.interpreted-text role="ref"} is tearing down.__iter__methods. Now they are treated un-iterable instead.Improved Documentation
--junitxmlwith--junit-xmland--collectonlywith--collect-only.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.stderrmight already be closed when :ref:faulthandleris tearing down.v7.4.2: pytest 7.4.2 (2023-09-07)Compare Source
Bug Fixes
#11237: Fix doctest collection of
functools.cached_propertyobjects.#11306: Fixed bug using
--importmode=importlibwhich would cause package__init__.pyfiles to be imported more than once in some cases.#11367: Fixed bug where
user_propertieswhere 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=importlibwould not include thechild modules as attributes of the parent modules.
#10702: Fixed error assertion handling in
pytest.approxwhenNoneis an expected or received value when comparing dictionaries.#10811: Fixed issue when using
--import-mode=importlibtogether with--doctest-modulesthat caused modulesto be imported more than once, causing problems with modules that have import side effects.
v7.4.0Compare 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) ofskipandxfailreasons 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
%fdirective 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
leveliflevelwas disabled globally vialogging.disable(LEVEL).Bug Fixes
--tb=linemode wherepytest.fail(pytrace=False)tests reportNone.--last-failedwhole-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
testpathsare only considered when they are in use.__tracebackhide__ = Truestill 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
-cto now include--config-fileto make it clear that this flag applies to the usage of a custom config file.v7.3.2Compare Source
pytest 7.3.2 (2023-06-10)
Bug Fixes
OSError: [Errno 36] File name too longon 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.1Compare Source
pytest 7.3.1 (2023-04-14)
Improvements
RuntimeError: TestResult has no addDuration methodwhen runningunittesttests.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 rangewhich 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.0Compare Source
pytest 7.3.0 (2023-04-08)
Features
@classmethodcan 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-noto 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-disableCLI 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
ExceptionGroupof them instead of discarding all but the last.-parguments to include spaces (eg:-p no:logginginstead of-pno:logging). Mostly useful in theaddoptssection of the configurationfile.
startandstoptimestamps toTestReportobjects.rootdir,config fileandtestpathsso 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"} onemscriptenplatform due to missingos.getuid{.interpreted-text role="func"}.__tracebackhide__for chained exceptions.Improved Documentation
goodpractices{.interpreted-text role="ref"}:pip install -e .requires aversionentry inpyproject.tomlto run successfully.Trivial/Internal Changes
v7.2.2Compare 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}.teardownwould be called as part ofnoseteardown stage.--fixturesand--helpare 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.1Compare Source
pytest 7.2.1 (2023-01-13)
Bug Fixes
rootdir <rootdir>{.interpreted-text role="ref"} on Windows.v7.2.0Compare 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
pylibrary.pytestprovides a vendored copy ofpy.errorandpy.pathmodules but will use thepylibrary if it is installed. If you need otherpy.*modules, continue to install the deprecatedpylibrary 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
nosehas been officially deprecated.This includes:
setupandteardownfunctions and methods: this might catch users by surprise, assetup()andteardown()are not pytest idioms, but part of thenosesupport.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-showlocalsflag has been added. This can be passed directly to tests to override--showlocalsdeclared 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.inias 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
ExceptionGroupseven 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.tomlinstead 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-Nonefrom tests an error in the future._pytest.doctest.DoctestItemexportpytest.DoctestItemfortype check and runtime purposes. Made [_pytest.doctest]{.title-ref} use internal APIs
to avoid circular imports.
_pytest.compatre-exportimportlib_metadatain the eyes of type checkers.EncodingWarning) incacheprovidertorn down.
Add an additional sentence to the docstring explaining when it's not a good
idea to call getfixturevalue.
v7.1.3Compare Source
pytest 7.1.3 (2022-08-31)
Bug Fixes
--pdb,TestCase.tearDownis no longer called for tests when the class has been skipped viaunittest.skiporpytest.mark.skip..pyfiles created bypyproject.toml-based editable builds introduced in pip 21.3.--import-modeflag.FixtureRequest.paramasAnyas a stop gap measure until8073{.interpreted-text role="issue"} is fixed.rewrite.pythat 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.2Compare Source
pytest 7.1.2 (2022-04-23)
Bug Fixes
numpyimport insidepytest.approx{.interpreted-text role="func"} was removed.dataclasseswithInitVar.stacklevelfor theNODE_CTOR_FSPATH_ARGdeprecation to point to theuser's code, not pytest.
an internal error while attempting to get the current user's username.
v7.1.1Compare Source
pytest 7.1.1 (2022-03-17)
Bug Fixes
v7.1.0Compare 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._fillfuncargsfunction.pytest_warning_capturedhook - usepytest_warning_recordedinstead.-k -foobarsyntax - use-k 'not foobar'instead.-k foobar:syntax.pytest.collectmodule - import frompytestdirectly.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
-vwould show less information.Also, when showing diffs for sequences,
-qwould 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 inattrsordataclasses.#9536: When
-vvis 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
idsargument 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 testsnow imports the conftest twice, once astests/real/conftest.pyand 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=importlibused 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.tomlfiles now produce a clearer error message.v7.0.1Compare Source
pytest 7.0.1 (2022-02-11)
Bug Fixes
importlib.readersin 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.
pythonpathplugin was renamed topython_path. This avoids a conflict with thepytest-pythonpathplugin.::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.0Compare 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:
--versionnow writes version information tostdoutrather 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.approxlike this:While the correct usage is:
The new error message helps catch those mistakes.
#9277: The
pytest.Instancecollector type has been removed.Importing
pytest.Instanceor_pytest.python.Instancereturns 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
PytestRemovedIn7Warningnow 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.Xseries, it is possible to change the errors back into warnings as astopgap measure by adding this to your
pytest.inifile:But this will stop working when pytest
7.1is 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.localarguments for hooks have been deprecated. Seethe deprecation note <legacy-path-hooks-deprecated>{.interpreted-text role="ref"} for full details.py.path.localarguments 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.HookRecorderThese 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)sinstead.parser.addoption(..., type="int/string/float/complex")- usetype=intetc. 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
reasonargument instead ofmsg. Usingmsgstill 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 acceptreasonas an argument.#8174: The following changes have been made to types reachable through
pytest.ExceptionInfo.traceback{.interpreted-text role="attr"}:pathproperty of_pytest.code.CodereturnsPathinstead ofpy.path.local.pathproperty of_pytest.code.TracebackEntryreturnsPathinstead 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
pathstype 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.ConfigforConfig <pytest.Config>{.interpreted-text role="class"}.pytest.Markformarks <pytest.Mark>{.interpreted-text role="class"}.pytest.MarkDecoratorformark decorators <pytest.MarkDecorator>{.interpreted-text role="class"}.pytest.MarkGeneratorfor thepytest.mark <pytest.MarkGenerator>{.interpreted-text role="class"} singleton.pytest.Metafuncfor themetafunc <pytest.MarkGenerator>{.interpreted-text role="class"} argument to thepytest_generate_tests{.interpreted-text role="hook"} hook.pytest.CallInfofor theCallInfo <pytest.CallInfo>{.interpreted-text role="class"} type passed to various hooks.pytest.PytestPluginManagerforPytestPluginManager <pytest.PytestPluginManager>{.interpreted-text role="class"}.pytest.ExceptionInfofor theExceptionInfo <pytest.ExceptionInfo>{.interpreted-text role="class"} type returned frompytest.raises{.interpreted-text role="func"} and passed to various hooks.pytest.Parserfor theParser <pytest.Parser>{.interpreted-text role="class"} type passed to thepytest_addoption{.interpreted-text role="hook"} hook.pytest.OptionGroupfor theOptionGroup <pytest.OptionGroup>{.interpreted-text role="class"} type returned from theparser.addgroup <pytest.Parser.getgroup>{.interpreted-text role="func"} method.pytest.HookRecorderfor theHookRecorder <pytest.HookRecorder>{.interpreted-text role="class"} type returned from~pytest.Pytester{.interpreted-text role="class"}.pytest.RecordedHookCallfor theRecordedHookCall <pytest.HookRecorder>{.interpreted-text role="class"} type returned from~pytest.HookRecorder{.interpreted-text role="class"}.pytest.RunResultfor theRunResult <pytest.RunResult>{.interpreted-text role="class"} type returned from~pytest.Pytester{.interpreted-text role="class"}.pytest.LineMatcherfor theLineMatcher <pytest.RunResult>{.interpreted-text role="class"} type used in~pytest.RunResult{.interpreted-text role="class"} and others.pytest.TestReportfor theTestReport <pytest.TestReport>{.interpreted-text role="class"} type used in various hooks.pytest.CollectReportfor 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.Pathargument, equivalent to an existingpy.path.localargument:pytest_ignore_collect{.interpreted-text role="hook"} - Thecollection_pathparameter (equivalent to existingpathparameter).pytest_collect_file{.interpreted-text role="hook"} - Thefile_pathparameter (equivalent to existingpathparameter).pytest_pycollect_makemodule{.interpreted-text role="hook"} - Themodule_pathparameter (equivalent to existingpathparameter).pytest_report_header{.interpreted-text role="hook"} - Thestart_pathparameter (equivalent to existingstartdirparameter).pytest_report_collectionfinish{.interpreted-text role="hook"} - Thestart_pathparameter (equivalent to existingstartdirparameter).::: {.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.pathas apathlib.Path. Both the oldfspathand this new attribute gets set no matter whetherpathorfspath(deprecated) is passed to the constructor. It is a replacement for thefspathattribute (which represents the same path aspy.path.local). Whilefspathis 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-testand--fixtureshave been enriched with:--verboseoption.#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
tomltotomlifor 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 awarningsargument to assert the total number of warnings captured.#8954:
--debugflag 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
#9113:
RunResult <_pytest.pytester.RunResult>{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>{.interpreted-text role="meth"} now accepts adeselectedargument 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
ImportErrorwhile 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
240characters by default.However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using
-vwillnow increase the truncation threshold to
2400characters, and-vvor 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_itin 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_configurehook, 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-skipnow implicitly enables--stepwiseand 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__.pywould raise anImportErrorwhen--doctest-moduleswas provided.#8061: Fixed failing
staticmethodtest cases if they are inherited from a parent test class.#8192:
testdir.makefilenow silently accepts values which don't start with.to maintain backward compatibility with older pytest versions.pytester.makefilenow issues a clearer error if the.is missing in theextargument.#8258: Fixed issue where pytest's
faulthandlersupport would not dump traceback on crashesif the
faulthandler{.interpreted-text role="mod"} module was already enabled during pytest startup (usingpython -X dev -m pytestfor example).#8317: Fixed an issue where illegal directory characters derived from
getpass.getuser()raised anOSError.#8367: Fix
Class.from_parentso it forwards extra keyword arguments to the constructor.#8377: The test selection options
pytest -kandpytest -mnow support matchingnames containing forward slash (
/) characters.#8384: The
@pytest.mark.skipdecorator now correctly handles its arguments. When thereasonargument is accidentally given both positional and as a keyword (e.g. because it was confused withskipif), aTypeErrornow occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally,reasonis 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
--fixturesinvocation (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 definesrootdiras the directory that contains<config file>.#8503:
pytest.MonkeyPatch.syspath_prepend{.interpreted-text role="meth"} no longer fails whensetuptoolsis not installed.It now only calls
pkg_resources.fixup_namespace_packages{.interpreted-text role="func"} ifpkg_resourceswas previously imported, because it is not needed otherwise.#8548: Introduce fix to handle precision width in
log-cli-formatin turn to fix output coloring for certain formats.#8796: Fixed internal error when skipping doctests.
#8983: The test selection options
pytest -kandpytest -mnow 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.pathwas accessed from a session-scoped fixture.#9131: Fixed the URL used by
--pastebinto use bpa.st.#9163: The end line number and end column offset are now properly set for rewritten assert statements.
#9169: Support for the
filesAPI fromimportlib.resourceswithin 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.--pdbclsmore accurately reflects the option's behavior.confcutdirbeing a configuration option: it can only be set through the--confcutdircommand-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_scm6.x to useSETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTESTfor more robust release tooling._pytest.code.getfslineno()function returnsPathinstead ofpy.path.local._pytest.python.path_matches_patterns()function takesPathinstead ofpy.path.local._pytest._code.Traceback.cut()function accepts anyos.PathLike[str], not justpy.path.local.python.PyObjMixininherit fromnodes.Nodeto carry over typing information.pytest.skip{.interpreted-text role="func"} is used at module level without passing [allow_module_level=True]{.title-ref}.regendocopts out ofTOX_ENVcachedir selection to ensure independent example test runs.CallSpec2._arg2scopenumattribute 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.5Compare Source
pytest 6.2.5 (2021-08-29)
Trivial/Internal Changes
pluggy 1.0or later.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.
⚠ Artifact update problem
Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.
♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
The artifact failure details are included below:
File name: poetry.lock
Checkout
From your project repository, check out a new branch and test the changes.