Releases: pytest-dev/pytest
8.2.2
pytest 8.2.2 (2024-06-04)
Bug Fixes
- #12355: Fix possible catastrophic performance slowdown on a certain parametrization pattern involving many higher-scoped parameters.
- #12367: Fix a regression in pytest 8.2.0 where unittest class instances (a fresh one is created for each test) were not released promptly on test teardown but only on session teardown.
- #12381: Fix possible "Directory not empty" crashes arising from concurent cache dir (
.pytest_cache
) creation. Regressed in pytest 8.2.0.
Improved Documentation
- #12290: Updated Sphinx theme to use Furo instead of Flask, enabling Dark mode theme.
- #12356: Added a subsection to the documentation for debugging flaky tests to mention
lack of thread safety in pytest as a possible source of flakyness. - #12363: The documentation webpages now links to a canonical version to reduce outdated documentation in search engine results.
8.2.1
pytest 8.2.1 (2024-05-19)
Improvements
- #12334: Support for Python 3.13 (beta1 at the time of writing).
Bug Fixes
- #12120: Fix [PermissionError]{.title-ref} crashes arising from directories which are not selected on the command-line.
- #12191: Keyboard interrupts and system exits are now properly handled during the test collection.
- #12300: Fixed handling of 'Function not implemented' error under squashfuse_ll, which is a different way to say that the mountpoint is read-only.
- #12308: Fix a regression in pytest 8.2.0 where the permissions of automatically-created
.pytest_cache
directories becamerwx------
instead of the expectedrwxr-xr-x
.
Trivial/Internal Changes
- #12333: pytest releases are now attested using the recent Artifact Attestation support from GitHub, allowing users to verify the provenance of pytest's sdist and wheel artifacts.
8.2.0
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.local
parameter instead of thepathlib.Path
parameter which replaced it:pytest_ignore_collect
{.interpreted-text role="hook"} - thepath
parameter - usecollection_path
instead.pytest_collect_file
{.interpreted-text role="hook"} - thepath
parameter - usefile_path
instead.pytest_pycollect_makemodule
{.interpreted-text role="hook"} - thepath
parameter - usemodule_path
instead.pytest_report_header
{.interpreted-text role="hook"} - thestartdir
parameter - usestart_path
instead.pytest_report_collectionfinish
{.interpreted-text role="hook"} - thestartdir
parameter - usestart_path
instead.
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=ImportError
topytest.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 info
section when-vv
is 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_method
and tests using@staticmethod
or@classmethod
would crash withAttributeError: 'NoneType' object has no attribute 'setup_method'
.Now the
request.instance <pytest.FixtureRequest.instance>
{.interpreted-text role="attr"} attribute of tests using@staticmethod
and@classmethod
is no longerNone
, but a fresh instance of the class, like in non-static methods.
Previously it wasNone
, 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=importlib
and--doctest-modules
where 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
8.1.2
8.1.1
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.
SeeFine-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 whenwarnings.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-ini
for paths in invocations without a configuration file defined, the current working directory is used
as 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 tolistchain <_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-mode
option 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=importlib
would 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_module
xunit-style fixtures are not executed when--doctest-modules
is passed. -
#12014: Fix the
stacklevel
used when warning about marks used on fixtures. -
#12039: Fixed a regression in
8.0.2
where tests created usingtmp_path
{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.
Improved Documentation
- #11790: Documented the retention of temporary directories created using the
tmp_path
fixture 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 aNode
itself instead of the nodeid.FixtureManager.getfixturedefs()
now takes theNode
itself instead of the nodeid.- The
_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.0
was 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.0
being 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.
:::
8.1.0
pytest 8.1.0 (YANKED)
Important
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.
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.
SeeFine-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 whenwarnings.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-ini
for paths in invocations without a configuration file defined, the current working directory is used
as 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 tolistchain <_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-mode
option 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_module
xunit-style fixtures are not executed when--doctest-modules
is passed. -
#12014: Fix the
stacklevel
used when warning about marks used on fixtures. -
#12039: Fixed a regression in
8.0.2
where tests created usingtmp_path
{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.
Improved Documentation
- #11790: Documented the retention of temporary directories created using the
tmp_path
fixture 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 aNode
itself instead of the nodeid.FixtureManager.getfixturedefs()
now takes theNode
itself instead of the nodeid.- The
_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.
8.0.2
pytest 8.0.2 (2024-02-24)
Bug Fixes
- #11895: Fix collection on Windows where initial paths contain the short version of a path (for example
c:\PROGRA~1\tests
). - #11953: Fix an
IndexError
crash raising fromgetstatementrange_ast
. - #12021: Reverted a fix to [--maxfail]{.title-ref} handling in pytest 8.0.0 because it caused a regression in pytest-xdist whereby session fixture teardowns may get executed multiple times when the max-fails is reached.
8.0.1
pytest 8.0.1 (2024-02-16)
Bug Fixes
- #11875: Correctly handle errors from
getpass.getuser
{.interpreted-text role="func"} in Python 3.13. - #11879: Fix an edge case where
ExceptionInfo._stringify_exception
could crashpytest.raises
{.interpreted-text role="func"}. - #11906: Fix regression with
pytest.warns
{.interpreted-text role="func"} using custom warning subclasses which have more than one parameter in their [__init__]{.title-ref}. - #11907: Fix a regression in pytest 8.0.0 whereby calling
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. - #11929: Fix a regression in pytest 8.0.0 whereby autouse fixtures defined in a module get ignored by the doctests in the module.
- #11937: Fix a regression in pytest 8.0.0 whereby items would be collected in reverse order in some circumstances.
pytest 8.0.0 (2024-01-27)
8.0.0rc2
pytest 8.0.0rc2 (2024-01-17)
Improvements
- #11233: Improvements to
-r
for xfailures and xpasses:- Report tracebacks for xfailures when
-rx
is set. - Report captured output for xpasses when
-rX
is set. - For xpasses, add
-
in summary between test name and reason, to match how xfail is displayed.
- Report tracebacks for xfailures when
- #11825: The
pytest_plugin_registered
{.interpreted-text role="hook"} hook has a newplugin_name
parameter containing the name by whichplugin
is registered.
Bug Fixes
-
#11706: Fix reporting of teardown errors in higher-scoped fixtures when using [--maxfail]{.title-ref} or [--stepwise]{.title-ref}.
-
#11758: Fixed
IndexError: string index out of range
crash inif highlighted[-1] == "\n" and source[-1] != "\n"
.
This bug was introduced in pytest 8.0.0rc1. -
#9765, #11816: Fixed a frustrating bug that afflicted some users with the only error being
assert mod not in mods
. The issue was caused by the fact thatstr(Path(mod))
andmod.__file__
don't necessarily produce the same string, and was being erroneously used interchangably in some places in the code.This fix also broke the internal API of
PytestPluginManager.consider_conftest
by introducing a new parameter -- we mention this in case it is being used by external code, even if marked as private.