Update dependency pytest to v7
This MR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
pytest (source, changelog) |
^5.2 -> ^7.1
|
Release Notes
pytest-dev/pytest
v7.1.1
pytest 7.1.1 (2022-03-17)
Bug Fixes
- #9767: Fixed a regression in pytest 7.1.0 where some conftest.py files outside of the source tree (e.g. in the [site-packages]{.title-ref} directory) were not picked up.
v7.1.0
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 now be obtained by enablingtracemalloc
{.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 of tests 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
tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real
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 (see6523
{.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
pytest 7.0.1 (2022-02-11)
Bug Fixes
-
#9608: Fix invalid importing of
importlib.readers
in Python 3.9. - #9610: Restore [UnitTestFunction.obj]{.title-ref} to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default [__init__]{.title-ref}. Regressed in pytest 7.0.0.
-
#9636: The
pythonpath
plugin was renamed topython_path
. This avoids a conflict with thepytest-pythonpath
plugin. -
#9642: Fix running tests by id with
::
in the parametrize portion. -
#9643: Delay issuing a
~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
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
- #9355: Fixed error message prints function decorators when using assert in Python 3.8 and above.
-
#9396: Ensure
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
- #9404: Added extra documentation on alternatives to common misuses of [pytest.warns(None)]{.title-ref} ahead of its deprecation.
- #9505: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository.
Trivial/Internal Changes
- #9521: Add test coverage to assertion rewrite path.
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:assert pytest.approx(actual, expected)
While the correct usage is:
assert actual == pytest.approx(expected)
The new error message helps catch those mistakes.
-
#9277: The
pytest.Instance
collector type has been removed. Importingpytest.Instance
or_pytest.python.Instance
returns a dummy type and emits a deprecation warning. Seeinstance-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 errors instead 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 a stopgap measure by adding this to yourpytest.ini
file:[pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning
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 (the new attribute beingpath
) is the opposite of the situation for hooks (the old argument beingpath
).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 (see9283
{.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 the pytest collection phase is deprecated. Usepytest.skip
{.interpreted-text role="func"} instead.Note: This deprecation only relates to using
unittest.SkipTest
{.interpreted-text role="class"} during test collection. You are probably not doing that. Ordinary usage ofunittest.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 now scheduled 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 used it 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 - likepytest.warns()
orpytest.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 areason
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"}:- The
path
property of_pytest.code.Code
returnsPath
instead ofpy.path.local
. - The
path
property of_pytest.code.TracebackEntry
returnsPath
instead ofpy.path.local
.
There was no deprecation period for this change (sorry!).
- The
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 apathlib.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 inparser.addini("mypaths", "my paths", type="paths")
, which is similar to the existingpathlist
, but returns a list ofpathlib.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 that depend on modules being on :pysys.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 (the new attribute beingpath
) is the opposite of the situation for hooks (the old argument beingpath
).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 (see9283
{.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 yet due 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 (the new attribute beingpath
) is the opposite of the situation for hooks (the old argument beingpath
).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 (see9283
{.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:- Fixture location path printed with the fixture name.
- First section of the fixture's docstring printed under the fixture name.
- Whole of fixture's docstring printed under the fixture name using
--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. Seeplugin-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't used. -
#9113:
RunResult <_pytest.pytester.RunResult>
{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>
{.interpreted-text role="meth"} now accepts adeselected
argument to assert the total number of deselected tests. -
#9114: Added
pythonpath
{.interpreted-text role="confval"} setting that adds listed paths tosys.path
{.interpreted-text role="data"} for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in [pythonpath]{.title-ref} setting.
Improvements
-
#7480: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category [PytestRemovedInXWarning]{.title-ref}, a subclass of
~pytest.PytestDeprecationWarning
{.interpreted-text role="class"}, instead ofPytestDeprecationWarning
{.interpreted-text role="class"} directly.See
backwards-compatibility
{.interpreted-text role="ref"} for more details. -
#7864: Improved error messages when parsing warning filters.
Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an
ImportError
while importing a specific warning type). -
#8335: Improved
pytest.approx
{.interpreted-text role="func"} assertion messages for sequences of numbers.The assertion messages now dumps a table with the index and the error of each diff. Example:
> assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06
-
#8403: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at
240
characters by default.However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using
-v
will now increase the truncation threshold to2400
characters, and-vv
or higher will disable truncation entirely. -
#8509: Fixed issue where
unittest.TestCase.setUpClass
{.interpreted-text role="meth"} is not called when a test has [/]{.title-ref} in its name since pytest 6.2.0.This refers to the path part in pytest node IDs, e.g.
TestClass::test_it
in the node IDtests/test_file.py::TestClass::test_it
.Now, instead of assuming that the test name does not contain
/
, it is assumed that test path does not contain::
. We plan to hopefully make both of these work in the future. -
#8803: It is now possible to add colors to custom log levels on cli log.
By using
add_color_level <_pytest.logging.add_color_level>
{.interpreted-text role="func"} from apytest_configure
hook, colors can be added:logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue')
See
log_colors
{.interpreted-text role="ref"} for more information. -
#8822: When showing fixture paths in [--fixtures]{.title-ref} or [--fixtures-by-test]{.title-ref}, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the [site-packages]{.title-ref} directory.
-
#8898: Complex numbers are now treated like floats and integers when generating parameterization IDs.
-
#9062:
--stepwise-skip
now implicitly enables--stepwise
and can be used on its own. -
#9205:
pytest.Cache.set
{.interpreted-text role="meth"} now preserves key order when saving dicts.
Bug Fixes
-
#7124: Fixed an issue where
__main__.py
would raise anImportError
when--doctest-modules
was provided. -
#8061: Fixed failing
staticmethod
test cases if they are inherited from a parent test class. -
#8192:
testdir.makefile
now silently accepts values which don't start with.
to maintain backward compatibility with older pytest versions.pytester.makefile
now issues a clearer error if the.
is missing in theext
argument. -
#8258: Fixed issue where pytest's
faulthandler
support would not dump traceback on crashes if thefaulthandler
{.interpreted-text role="mod"} module was already enabled during pytest startup (usingpython -X dev -m pytest
for example). -
#8317: Fixed an issue where illegal directory characters derived from
getpass.getuser()
raised anOSError
. -
#8367: Fix
Class.from_parent
so it forwards extra keyword arguments to the constructor. -
#8377: The test selection options
pytest -k
andpytest -m
now support matching names containing forward slash (/
) characters. -
#8384: The
@pytest.mark.skip
decorator now correctly handles its arguments. When thereason
argument is accidentally given both positional and as a keyword (e.g. because it was confused withskipif
), aTypeError
now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally,reason
is now documented correctly as positional or keyword (rather than keyword-only). -
#8394: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default
--fixtures
invocation (but they still show up with--fixtures -v
). -
#8456: The
required_plugins
{.interpreted-text role="confval"} config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. -
#8464:
-c <config file>
now also properly definesrootdir
as the directory that contains<config file>
. -
#8503:
pytest.MonkeyPatch.syspath_prepend
{.interpreted-text role="meth"} no longer fails whensetuptools
is not installed. It now only callspkg_resources.fixup_namespace_packages
{.interpreted-text role="func"} ifpkg_resources
was previously imported, because it is not needed otherwise. -
#8548: Introduce fix to handle precision width in
log-cli-format
in turn to fix output coloring for certain formats. -
#8796: Fixed internal error when skipping doctests.
-
#8983: The test selection options
pytest -k
andpytest -m
now support matching names containing backslash ([\]{.title-ref}) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). -
#8990: Fix [pytest -vv]{.title-ref} crashing with an internal exception [AttributeError: 'str' object has no attribute 'relative_to']{.title-ref} in some cases.
-
#9077: Fixed confusing error message when
request.fspath
/request.path
was accessed from a session-scoped fixture. -
#9163: The end line number and end column offset are now properly set for rewritten assert statements.
-
#9169: Support for the
files
API fromimportlib.resources
within rewritten files. -
#9272: The nose compatibility module-level fixtures [setup()]{.title-ref} and [teardown()]{.title-ref} are now only called once per module, instead of for each test function. They are now called even if object-level [setup]{.title-ref}/[teardown]{.title-ref} is defined.
Improved Documentation
- #4320: Improved docs for [pytester.copy_example]{.title-ref}.
-
#5105: Add automatically generated
plugin-list
{.interpreted-text role="ref"}. The list is updated on a periodic schedule. -
#8337: Recommend numpy.testing module on
pytest.approx
{.interpreted-text role="func"} documentation. -
#8655: Help text for
--pdbcls
more accurately reflects the option's behavior. -
#9210: Remove incorrect docs about
confcutdir
being a configuration option: it can only be set through the--confcutdir
command-line option. - #9242: Upgrade readthedocs configuration to use a newer Ubuntu version` with better unicode support for PDF docs.
-
#9341: Various methods commonly used for
non-python tests
{.interpreted-text role="ref"} are now correctly documented in the reference docs. They were undocumented previously.
Trivial/Internal Changes
-
#8133: Migrate to
setuptools_scm
6.x to useSETUPTOOLS_SCM_MRETEND_VERSION_FOR_PYTEST
for more robust release tooling. -
#8174: The following changes have been made to internal pytest types/functions:
- The
_pytest.code.getfslineno()
function returnsPath
instead ofpy.path.local
. - The
_pytest.python.path_matches_patterns()
function takesPath
instead ofpy.path.local
. - The
_pytest._code.Traceback.cut()
function accepts anyos.PathLike[str]
, not justpy.path.local
.
- The
-
#8248: Internal Restructure: let
python.PyObjMixin
inherit fromnodes.Node
to carry over typing information. -
#8432: Improve error message when
pytest.skip
{.interpreted-text role="func"} is used at module level without passing [allow_module_level=True]{.title-ref}. -
#8818: Ensure
regendoc
opts out ofTOX_ENV
cachedir selection to ensure independent example test runs. -
#8913: The private
CallSpec2._arg2scopenum
attribute has been removed after an internal refactoring. -
#8967:
pytest_assertion_pass
{.interpreted-text role="hook"} is no longer considered experimental and future changes to it will be considered more carefully. - #9202: Add github action to upload coverage report to codecov instead of bash uploader.
- #9225: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py.
- #9351: Correct minor typos in doc/en/example/special.rst.
v6.2.5
pytest 6.2.5 (2021-08-29)
Trivial/Internal Changes
v6.2.4
pytest 6.2.4 (2021-05-04)
Bug Fixes
- #8539: Fixed assertion rewriting on Python 3.10.
v6.2.3
pytest 6.2.3 (2021-04-03)
Bug Fixes
-
#8414: pytest used to create directories under
/tmp
with world-readable permissions. This means that any user in the system was able to read information written by tests in temporary directories (such as those created by thetmp_path
/tmpdir
fixture). Now the directories are created with private permissions.pytest used silenty use a pre-existing
/tmp/pytest-of-<username>
directory, even if owned by another user. This means another user could pre-create such a directory and gain control of another user's temporary directory. Now such a condition results in an error.
v6.2.2
pytest 6.2.2 (2021-01-25)
Bug Fixes
- #8152: Fixed "(<Skipped instance>)" being shown as a skip reason in the verbose test summary line when the reason is empty.
-
#8249: Fix the
faulthandler
plugin for occasions when running withtwisted.logger
and usingpytest --capture=no
.
v6.2.1
pytest 6.2.1 (2020-12-15)
Bug Fixes
-
#7678: Fixed bug where
ImportPathMismatchError
would be raised for files compiled in the host and loaded later from an UNC mounted path (Windows). -
#8132: Fixed regression in
approx
: in 6.2.0approx
no longer raisesTypeError
when dealing with non-numeric types, falling back to normal comparison. Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case, and happened to compare correctly to a scalar if they had only one element. After 6.2.0, these types began failing, because they inherited neither from standard Python number hierarchy nor fromnumpy.ndarray
.approx
now converts arguments tonumpy.ndarray
if they expose the array protocol and are not scalars. This treats array-like objects like numpy arrays, regardless of size.
v6.2.0
pytest 6.2.0 (2020-12-12)
Breaking Changes
- #7808: pytest now supports python3.6+ only.
Deprecations
-
#7469: Directly constructing/calling the following classes/functions is now deprecated:
_pytest.cacheprovider.Cache
_pytest.cacheprovider.Cache.for_config()
_pytest.cacheprovider.Cache.clear_cache()
_pytest.cacheprovider.Cache.cache_dir_from_config()
_pytest.capture.CaptureFixture
_pytest.fixtures.FixtureRequest
_pytest.fixtures.SubRequest
_pytest.logging.LogCaptureFixture
_pytest.pytester.Pytester
_pytest.pytester.Testdir
_pytest.recwarn.WarningsRecorder
_pytest.recwarn.WarningsChecker
_pytest.tmpdir.TempPathFactory
_pytest.tmpdir.TempdirFactory
These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 7.0.0.
-
#7530: The
--strict
command-line option has been deprecated, use--strict-markers
instead.We have plans to maybe in the future to reintroduce
--strict
and make it an encompassing flag for all strictness related options (--strict-markers
and--strict-config
at the moment, more might be introduced in the future). -
#7988: The
@pytest.yield_fixture
decorator/function is now deprecated. Use pytest.fixture instead.yield_fixture
has been an alias forfixture
for a very long time, so can be search/replaced safely.
Features
-
#5299: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8. See unraisable for more information.
-
#7425: New pytester fixture, which is identical to testdir but its methods return pathlib.Path when appropriate instead of
py.path.local
.This is part of the movement to use pathlib.Path objects internally, in order to remove the dependency to
py
in the future.Internally, the old Testdir <_pytest.pytester.Testdir> is now a thin wrapper around Pytester <_pytest.pytester.Pytester>, preserving the old interface.
-
#7695: A new hook was added, pytest_markeval_namespace which should return a dictionary. This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers.
Pseudo example
conftest.py
:def pytest_markeval_namespace(): return {"color": "red"}
test_func.py
:@​pytest.mark.skipif("color == 'blue'", reason="Color is not red") def test_func(): assert False
-
#8006: It is now possible to construct a ~pytest.MonkeyPatch object directly as
pytest.MonkeyPatch()
, in cases when the monkeypatch fixture cannot be used. Previously some users imported it from the private _pytest.monkeypatch.MonkeyPatch namespace.Additionally, MonkeyPatch.context <pytest.MonkeyPatch.context> is now a classmethod, and can be used as
with MonkeyPatch.context() as mp: ...
. This is the recommended way to useMonkeyPatch
directly, since unlike themonkeypatch
fixture, an instance created directly is notundo()
-ed automatically.
Improvements
-
#1265: Added an
__str__
implementation to the ~pytest.pytester.LineMatcher class which is returned frompytester.run_pytest().stdout
and similar. It returns the entire output, like the existingstr()
method. -
#2044: Verbose mode now shows the reason that a test was skipped in the test's terminal line after the "SKIPPED", "XFAIL" or "XPASS".
-
#7469 The types of builtin pytest fixtures are now exported so they may be used in type annotations of test functions. The newly-exported types are:
-
pytest.FixtureRequest
for the request fixture. -
pytest.Cache
for the cache fixture. -
pytest.CaptureFixture[str]
for the capfd and capsys fixtures. -
pytest.CaptureFixture[bytes]
for the capfdbinary and capsysbinary fixtures. -
pytest.LogCaptureFixture
for the caplog fixture. -
pytest.Pytester
for the pytester fixture. -
pytest.Testdir
for the testdir fixture. -
pytest.TempdirFactory
for the tmpdir_factory fixture. -
pytest.TempPathFactory
for the tmp_path_factory fixture. -
pytest.MonkeyPatch
for the monkeypatch fixture. -
pytest.WarningsRecorder
for the recwarn fixture.
Constructing them is not supported (except for MonkeyPatch); they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 7.0.
Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.
-
-
#7527: When a comparison between namedtuple <collections.namedtuple> instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes.
-
#7615: Node.warn <_pytest.nodes.Node.warn> now permits any subclass of Warning, not just PytestWarning .
-
#7701: Improved reporting when using
--collected-only
. It will now show the number of collected tests in the summary stats. -
#7710: Use strict equality comparison for non-numeric types in pytest.approx instead of raising TypeError.
This was the undocumented behavior before 3.7, but is now officially a supported feature.
-
#7938: New
--sw-skip
argument which is a shorthand for--stepwise-skip
. -
#8023: Added
'node_modules'
to default value for norecursedirs. -
#8032: doClassCleanups <unittest.TestCase.doClassCleanups> (introduced in unittest in Python and 3.8) is now called appropriately.
Bug Fixes
- #4824: Fixed quadratic behavior and improved performance of collection of items using autouse fixtures and xunit fixtures.
-
#7758: Fixed an issue where some files in packages are getting lost from
--lf
even though they contain tests that failed. Regressed in pytest 5.4.0. - #7911: Directories created by by tmp_path and tmpdir are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.
- #7913: Fixed a crash or hang in pytester.spawn <_pytest.pytester.Pytester.spawn> when the readline module is involved.
- #7951: Fixed handling of recursive symlinks when collecting tests.
- #7981: Fixed symlinked directories not being followed during collection. Regressed in pytest 6.1.0.
-
#8016: Fixed only one doctest being collected when using
pytest --doctest-modules path/to/an/__init__.py
.
Improved Documentation
- #7429: Add more information and use cases about skipping doctests.
-
#7780: Classes which should not be inherited from are now marked
final class
in the API reference. -
#7872:
_pytest.config.argparsing.Parser.addini()
accepts explicitNone
and"string"
. - #7878: In pull request section, ask to commit after editing changelog and authors file.
Trivial/Internal Changes
-
#7802: The
attrs
dependency requirement is now >=19.2.0 instead of >=17.4.0. - #8014: .pyc files created by pytest's assertion rewriting now conform to the newer PEP-552 format on Python>=3.7. (These files are internal and only interpreted by pytest itself.)
v6.1.2
pytest 6.1.2 (2020-10-28)
Bug Fixes
-
#7758: Fixed an issue where some files in packages are getting lost from
--lf
even though they contain tests that failed. Regressed in pytest 5.4.0. - #7911: Directories created by tmpdir are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.
Improved Documentation
-
#7815: Improve deprecation warning message for
pytest._fillfuncargs()
.
v6.1.1
pytest 6.1.1 (2020-10-03)
Bug Fixes
- #7807: Fixed regression in pytest 6.1.0 causing incorrect rootdir to be determined in some non-trivial cases where parent directories have config files as well.
- #7814: Fixed crash in header reporting when testpaths is used and contains absolute paths (regression in 6.1.0).
v6.1.0
pytest 6.1.0 (2020-09-26)
Breaking Changes
-
#5585: As per our policy, the following features which have been deprecated in the 5.X series are now removed:
- The
funcargnames
read-only property ofFixtureRequest
,Metafunc
, andFunction
classes. Usefixturenames
attribute. -
@pytest.fixture
no longer supports positional arguments, pass all arguments by keyword instead. - Direct construction of
Node
subclasses now raise an error, usefrom_parent
instead. - The default value for
junit_family
has changed toxunit2
. If you require the old format, addjunit_family=xunit1
to your configuration file. - The
TerminalReporter
no longer has awriter
attribute. Plugin authors may use the public functions of theTerminalReporter
instead of accessing theTerminalWriter
object directly. - The
--result-log
option has been removed. Users are recommended to use the pytest-reportlog plugin instead.
For more information consult Deprecations and Removals in the docs.
- The
Deprecations
-
#6981: The
pytest.collect
module is deprecated: all its names can be imported frompytest
directly. -
#7097: The
pytest._fillfuncargs
function is deprecated. This function was kept for backward compatibility with an older plugin.It's functionality is not meant to be used directly, but if you must replace it, use function._request._fillfixtures() instead, though note this is not a public API and may break in the future.
-
#7210: The special
-k '-expr'
syntax to-k
is deprecated. Use-k 'not expr'
instead.The special
-k 'expr:'
syntax to-k
is deprecated. Please open an issue if you use this and want a replacement. -
#7255: The pytest_warning_captured <_pytest.hookspec.pytest_warning_captured> hook is deprecated in favor of pytest_warning_recorded <_pytest.hookspec.pytest_warning_recorded>, and will be removed in a future version.
-
#7648: The
gethookproxy()
andisinitpath()
methods ofFSCollector
andPackage
are deprecated; useself.session.gethookproxy()
andself.session.isinitpath()
instead. This should work on all pytest versions.
Features
-
#7667: New
--durations-min
command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by--durations
. Previously this was hard-coded to0.005s
.
Improvements
-
#6681: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through filterwarnings or
--pythonwarnings/-W
.This also fixes a number of long standing issues: #2891, #7620, #7426.
-
#7572: When a plugin listed in
required_plugins
is missing or an unknown config key is used with--strict-config
, a simple error message is now shown instead of a stacktrace. -
#7685: Added two new attributes rootpath <_pytest.config.Config.rootpath> and inipath <_pytest.config.Config.inipath> to Config <_pytest.config.Config>. These attributes are pathlib.Path versions of the existing rootdir <_pytest.config.Config.rootdir> and inifile <_pytest.config.Config.inifile> attributes, and should be preferred over them when possible.
-
#7780: Public classes which are not designed to be inherited from are now marked @final. Code which inherits from these classes will trigger a type-checking (e.g. mypy) error, but will still work in runtime. Currently the
final
designation does not appear in the API Reference but hopefully will in the future.
Bug Fixes
-
#1953: Fixed error when overwriting a parametrized fixture, while also reusing the super fixture value.
conftest.py
import pytest
@​pytest.fixture(params=[1, 2])
def foo(request):
return request.param
test_foo.py
import pytest
@​pytest.fixture
def foo(foo):
return foo * 2
```
-
#4984: Fixed an internal error crash with
IndexError: list index out of range
when collecting a module which starts with a decorated function, the decorator raises, and assertion rewriting is enabled. - #7591: pylint shouldn't complain anymore about unimplemented abstract methods when inheriting from File <non-python tests>.
-
#7628: Fixed test collection when a full path without a drive letter was passed to pytest on Windows (for example
\projects\tests\test.py
instead ofc:\projects\tests\pytest.py
). -
#7638: Fix handling of command-line options that appear as paths but trigger an OS-level syntax error on Windows, such as the options used internally by
pytest-xdist
. -
#7742: Fixed INTERNALERROR when accessing locals / globals with faulty
exec
.
Improved Documentation
- #1477: Removed faq.rst and its reference in contents.rst.
Trivial/Internal Changes
-
#7536: The internal
junitxml
plugin has rewritten to usexml.etree.ElementTree
. The order of attributes in XML elements might differ. Some unneeded escaping is no longer performed. -
#7587: The dependency on the
more-itertools
package has been removed. - #7631: The result type of capfd.readouterr() <_pytest.capture.CaptureFixture.readouterr> (and similar) is no longer a namedtuple, but should behave like one in all respects. This was done for technical reasons.
-
#7671: When collecting tests, pytest finds test classes and functions by examining the
attributes of python objects (modules, classes and instances). To speed up this
process, pytest now ignores builtin attributes (like
__class__
,__delattr__
and__new__
) without consulting the python_classes and python_functions configuration options and without passing them to plugins using the pytest_pycollect_makeitem <_pytest.hookspec.pytest_pycollect_makeitem> hook.
v6.0.2
pytest 6.0.2 (2020-09-04)
Bug Fixes
-
#7148: Fixed
--log-cli
potentially causing unrelatedprint
output to be swallowed. -
#7672: Fixed log-capturing level restored incorrectly if
caplog.set_level
is called more than once. - #7686: Fixed NotSetType.token being used as the parameter ID when the parametrization list is empty. Regressed in pytest 6.0.0.
-
#7707: Fix internal error when handling some exceptions that contain multiple lines or the style uses multiple lines (
--tb=line
for example).
v6.0.1
pytest 6.0.1 (2020-07-30)
Bug Fixes
-
#7394: Passing an empty
help
value toParser.add_option
is now accepted instead of crashing when runningpytest --help
. PassingNone
raises a more informativeTypeError
. -
#7558: Fix pylint
not-callable
lint onpytest.mark.parametrize()
and the other builtin marks:skip
,skipif
,xfail
,usefixtures
,filterwarnings
. -
#7559: Fix regression in plugins using
TestReport.longreprtext
(such aspytest-html
) whenTestReport.longrepr
is not a string. -
#7569: Fix logging capture handler's level not reset on teardown after a call to
caplog.set_level()
.
v6.0.0
pytest 6.0.0 (2020-07-28)
(Please see the full set of changes for this release also in the 6.0.0rc1 notes below)
Breaking Changes
-
#5584: PytestDeprecationWarning are now errors by default.
Following our plan to remove deprecated features with as little disruption as possible, all warnings of type
PytestDeprecationWarning
now generate errors instead of warning messages.The affected features will be effectively removed in pytest 6.1, so please consult the Deprecations and Removals section in the docs for directions on how to update existing code.
In the pytest
6.0.X
series, it is possible to change the errors back into warnings as a stopgap measure by adding this to yourpytest.ini
file:[pytest] filterwarnings = ignore::pytest.PytestDeprecationWarning
But this will stop working when pytest
6.1
is released.If you have concerns about the removal of a specific feature, please add a comment to #5584.
-
#7472: The
exec_()
andis_true()
methods of_pytest._code.Frame
have been removed.
Features
- #7464: Added support for NO_COLOR and FORCE_COLOR environment variables to control colored output.
Improvements
-
#7467:
--log-file
CLI option andlog_file
ini marker now create subdirectories if needed. -
#7489: The pytest.raises function has a clearer error message when
match
equals the obtained string but is not a regex match. In this case it is suggested to escape the regex.
Bug Fixes
-
#7392: Fix the reported location of tests skipped with
@pytest.mark.skip
when--runxfail
is used. - #7491: tmpdir and tmp_path no longer raise an error if the lock to check for stale temporary directories is not accessible.
-
#7517: Preserve line endings when captured via
capfd
. -
#7534: Restored the previous formatting of
TracebackEntry.__str__
which was changed by accident.
Improved Documentation
-
#7422: Clarified when the
usefixtures
mark can apply fixtures to test. -
#7441: Add a note about
-q
option used in getting started guide.
Trivial/Internal Changes
-
#7389: Fixture scope
package
is no longer considered experimental.
pytest 6.0.0rc1 (2020-07-08)
Breaking Changes
-
#1316:
TestReport.longrepr
is now always an instance ofReprExceptionInfo
. Previously it was astr
when a test failed withpytest.fail(..., pytrace=False)
. -
#5965: symlinks are no longer resolved during collection and matching conftest.py files with test file paths.
Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms.
The team decided to step back on resolving symlinks at all, planning to review this in the future with a more solid solution (see discussion in #6523 for details).
This might break test suites which made use of this feature; the fix is to create a symlink for the entire test tree, and not only to partial files/tress as it was possible previously.
-
#6505:
Testdir.run().parseoutcomes()
now always returns the parsed nouns in plural form.Originally
parseoutcomes()
would always returns the nouns in plural form, but a change meant to improve the terminal summary by using singular form single items (1 warning
or1 error
) caused an unintended regression by changing the keys returned byparseoutcomes()
.Now the API guarantees to always return the plural form, so calls like this:
result = testdir.runpytest() result.assert_outcomes(error=1)
Need to be changed to:
result = testdir.runpytest() result.assert_outcomes(errors=1)
-
#6903: The
os.dup()
function is now assumed to exist. We are not aware of any supported Python 3 implementations which do not provide it. -
#7040:
-k
no longer matches against the names of the directories outside the test session root.Also,
pytest.Package.name
is now just the name of the directory containing the package's__init__.py
file, instead of the full path. This is consistent with how the other nodes are named, and also one of the reasons why-k
would match against any directory containing the test suite. -
#7122: Expressions given to the
-m
and-k
options are no longer evaluated using Python's eval. The format supportsor
,and
,not
, parenthesis and general identifiers to match against. Python constants, keywords or other operators are no longer evaluated differently. -
#7135: Pytest now uses its own
TerminalWriter
class instead of using the one from thepy
library. Plugins generally access this class throughTerminalReporter.writer
,TerminalReporter.write()
(and similar methods), or_pytest.config.create_terminal_writer()
.The following breaking changes were made:
- Output (
write()
method and others) no longer flush implicitly; the flushing behavior of the underlying file is respected. To flush explicitly (for example, if you want output to be shown before an end-of-line is printed), usewrite(flush=True)
orterminal_writer.flush()
. - Explicit Windows console support was removed, delegated to the colorama library.
- Support for writing
bytes
was removed. - The
reline
method andchars_on_current_line
property were removed. - The
stringio
andencoding
arguments was removed. - Support for passing a callable instead of a file was removed.
- Output (
-
#7224: The item.catch_log_handler and item.catch_log_handlers attributes, set by the logging plugin and never meant to be public , are no longer available.
The deprecated
--no-print-logs
option is removed. Use--show-capture
instead. -
#7226: Removed the unused
args
parameter frompytest.Function.__init__
. -
#7418: Removed the pytest_doctest_prepare_content hook specification. This hook hasn't been triggered by pytest for at least 10 years.
-
#7438: Some changes were made to the internal
_pytest._code.source
, listed here for the benefit of plugin authors who may be using it:- The
deindent
argument toSource()
has been removed, now it is always true. - Support for zero or multiple arguments to
Source()
has been removed. - Support for comparing
Source
with anstr
has been removed. - The methods
Source.isparseable()
andSource.putaround()
have been removed. - The method
Source.compile()
and function_pytest._code.compile()
have been removed; use plaincompile()
instead. - The function
_pytest._code.source.getsource()
has been removed; useSource()
directly instead.
- The
Deprecations
-
#7210: The special
-k '-expr'
syntax to-k
is deprecated. Use-k 'not expr'
instead.The special
-k 'expr:'
syntax to-k
is deprecated. Please open an issue if you use this and want a replacement. -
#4049:
pytest_warning_captured
is deprecated in favor of thepytest_warning_recorded
hook.
Features
-
#1556: pytest now supports
pyproject.toml
files for configuration.The configuration options is similar to the one available in other formats, but must be defined in a
[tool.pytest.ini_options]
table to be picked up by pytest:
pyproject.toml
[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = [
"tests",
"integration",
]
```
More information can be found [in the docs](https://docs.pytest.org/en/stable/customize.html#configuration-file-formats).
-
#3342: pytest now includes inline type annotations and exposes them to user programs. Most of the user-facing API is covered, as well as internal code.
If you are running a type checker such as mypy on your tests, you may start noticing type errors indicating incorrect usage. If you run into an error that you believe to be incorrect, please let us know in an issue.
The types were developed against mypy version 0.780. Versions before 0.750 are known not to work. We recommend using the latest version. Other type checkers may work as well, but they are not officially verified to work by pytest yet.
-
#4049: Introduced a new hook named pytest_warning_recorded to convey information about warnings captured by the internal pytest warnings plugin.
This hook is meant to replace pytest_warning_captured, which is deprecated and will be removed in a future release.
-
#6471: New command-line flags:
- `--no-header`: disables the initial header, including platform, version, and plugins.
- `--no-summary`: disables the final test summary, including warnings.
-
#6856: A warning is now shown when an unknown key is read from a config INI file.
The --strict-config flag has been added to treat these warnings as errors.
-
#6906: Added --code-highlight command line option to enable/disable code highlighting in terminal output.
-
#7245: New
--import-mode=importlib
option that uses importlib to import test modules.Traditionally pytest used
__import__
while changingsys.path
to import test modules (which also changessys.modules
as a side-effect), which works but has a number of drawbacks, like requiring test modules that don't live in packages to have unique names (as they need to reside under a unique name insys.modules
).--import-mode=importlib
uses more fine grained import mechanisms fromimportlib
which don't require pytest to changesys.path
orsys.modules
at all, eliminating much of the drawbacks of the previous mode.We intend to make
--import-mode=importlib
the default in future versions, so users are encouraged to try the new mode and provide feedback (both positive or negative) in issue #7245.You can read more about this option in the documentation.
-
#7305: New
required_plugins
configuration option allows the user to specify a list of plugins, including version information, that are required for pytest to run. An error is raised if any required plugins are not found when running pytest.
Improvements
-
#4375: The
pytest
command now suppresses theBrokenPipeError
error message that is printed to stderr when the output ofpytest
is piped and and the pipe is closed by the piped-to program (common examples areless
andhead
). -
#4391: Improved precision of test durations measurement.
CallInfo
items now have a new<CallInfo>.duration
attribute, created usingtime.perf_counter()
. This attribute is used to fill the<TestReport>.duration
attribute, which is more accurate than the previous<CallInfo>.stop - <CallInfo>.start
(as these are based ontime.time()
). -
#4675: Rich comparison for dataclasses and attrs-classes is now recursive.
-
#6285: Exposed the pytest.FixtureLookupError exception which is raised by request.getfixturevalue() (where request is a FixtureRequest fixture) when a fixture with the given name cannot be returned.
-
#6433: If an error is encountered while formatting the message in a logging call, for example
logging.warning("oh no!: %s: %s", "first")
(a second argument is missing), pytest now propagates the error, likely causing the test to fail.Previously, such a mistake would cause an error to be printed to stderr, which is not displayed by default for passing tests. This change makes the mistake visible during testing.
You may supress this behavior temporarily or permanently by setting
logging.raiseExceptions = False
. -
#6817: Explicit new-lines in help texts of command-line options are preserved, allowing plugins better control of the help displayed to users.
-
#6940: When using the
--duration
option, the terminal message output is now more precise about the number and duration of hidden items. -
#6991: Collected files are displayed after any reports from hooks, e.g. the status from
--lf
. -
#7091: When
fd
capturing is used, through--capture=fd
or thecapfd
andcapfdbinary
fixtures, and the file descriptor (0, 1, 2) cannot be duplicated, FD capturing is still performed. Previously, direct writes to the file descriptors would fail or be lost in this case. -
#7119: Exit with an error if the
--basetemp
argument is empty, is the current working directory or is one of the parent directories. This is done to protect against accidental data loss, as any directory passed to this argument is cleared. -
#7128: pytest --version now displays just the pytest version, while pytest --version --version displays more verbose information including plugins. This is more consistent with how other tools show --version.
-
#7133: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> will now override any log_level set via the CLI or configuration file.
-
#7159: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> and caplog.at_level() <_pytest.logging.LogCaptureFixture.at_level> no longer affect the level of logs that are shown in the Captured log report report section.
-
#7348: Improve recursive diff report for comparison asserts on dataclasses / attrs.
-
#7385:
--junitxml
now includes the exception cause in themessage
XML attribute for failures during setup and teardown.Previously:
<error message="test setup failure">
Now:
<error message="failed on setup with "ValueError: Some error during setup"">
Bug Fixes
-
#1120: Fix issue where directories from tmpdir are not removed properly when multiple instances of pytest are running in parallel.
-
#4583: Prevent crashing and provide a user-friendly error when a marker expression (-m) invoking of eval raises any exception.
-
#4677: The path shown in the summary report for SKIPPED tests is now always relative. Previously it was sometimes absolute.
-
#5456: Fix a possible race condition when trying to remove lock files used to control access to folders created by tmp_path and tmpdir.
-
#6240: Fixes an issue where logging during collection step caused duplication of log messages to stderr.
-
#6428: Paths appearing in error messages are now correct in case the current working directory has changed since the start of the session.
-
#6755: Support deleting paths longer than 260 characters on windows created inside tmpdir.
-
#6871: Fix crash with captured output when using capsysbinary.
-
#6909: Revert the change introduced by #6330, which required all arguments to
@pytest.mark.parametrize
to be explicitly defined in the function signature.The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.
-
#6910: Fix crash when plugins return an unknown stats while using the
--reportlog
option. -
#6924: Ensure a
unittest.IsolatedAsyncioTestCase
is actually awaited. -
#6925: Fix TerminalRepr instances to be hashable again.
-
#6947: Fix regression where functions registered with unittest.TestCase.addCleanup were not being called on test failures.
-
#6951: Allow users to still set the deprecated
TerminalReporter.writer
attribute. -
#6956: Prevent pytest from printing ConftestImportFailure traceback to stdout.
-
#6991: Fix regressions with --lf filtering too much since pytest 5.4.
-
#6992: Revert "tmpdir: clean up indirection via config for factories" #6767 as it breaks pytest-xdist.
-
#7061: When a yielding fixture fails to yield a value, report a test setup error instead of crashing.
-
#7076: The path of file skipped by
@pytest.mark.skip
in the SKIPPED report is now relative to invocation directory. Previously it was relative to root directory. -
#7110: Fixed regression:
asyncbase.TestCase
tests are executed correctly again. -
#7126:
--setup-show
now doesn't raise an error when a bytes value is used as aparametrize
parameter when Python is called with the-bb
flag. -
#7143: Fix pytest.File.from_parent so it forwards extra keyword arguments to the constructor.
-
#7145: Classes with broken
__getattribute__
methods are displayed correctly during failures. -
#7150: Prevent hiding the underlying exception when
ConfTestImportFailure
is raised. -
#7180: Fix
_is_setup_py
for files encoded differently than locale. -
#7215: Fix regression where running with
--pdb
would call unittest.TestCase.tearDown for skipped tests. -
#7253: When using
pytest.fixture
on a function directly, as inpytest.fixture(func)
, if theautouse
orparams
arguments are also passed, the function is no longer ignored, but is marked as a fixture. -
#7360: Fix possibly incorrect evaluation of string expressions passed to
pytest.mark.skipif
andpytest.mark.xfail
, in rare circumstances where the exact same string is used but refers to different global values. -
#7383: Fixed exception causes all over the codebase, i.e. use raise new_exception from old_exception when wrapping an exception.
Improved Documentation
- #7202: The development guide now links to the contributing section of the docs and RELEASING.rst on GitHub.
-
#7233: Add a note about
--strict
and--strict-markers
and the preference for the latter one. - #7345: Explain indirect parametrization and markers for fixtures.
Trivial/Internal Changes
-
#7035: The
originalname
attribute of_pytest.python.Function
now defaults toname
if not provided explicitly, and is always set. -
#7264: The dependency on the
wcwidth
package has been removed. -
#7291: Replaced
py.iniconfig
with iniconfig. -
#7295:
src/_pytest/config/__init__.py
now uses thewarnings
module to report warnings instead ofsys.stderr.write
. -
#7356: Remove last internal uses of deprecated slave term from old
pytest-xdist
. -
#7357:
py
>=1.8.2 is now required.
Configuration
-
If you want to rebase/retry this MR, click this checkbox.
This MR has been generated by Renovate Bot.