chore(deps): update dependency pytest to v7 #117
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^6.0
->^7.0
Release Notes
pytest-dev/pytest
v7.0.1
Compare Source
pytest 7.0.1 (2022-02-11)
Bug Fixes
importlib.readers
in Python 3.9.Fixes a crash during a failed teardown in unittest TestCases with non-default [__init__]{.title-ref}.
Regressed in pytest 7.0.0.
pythonpath
plugin was renamed topython_path
. This avoids a conflict with thepytest-pythonpath
plugin.::
in the parametrize portion.~pytest.PytestWarning
{.interpreted-text role="class"} about diamond inheritance involving~pytest.Item
{.interpreted-text role="class"} and~pytest.Collector
{.interpreted-text role="class"} so it can be filtered usingstandard warning filters <warnings>
{.interpreted-text role="ref"}.v7.0.0
Compare Source
pytest 7.0.0 (2022-02-03)
(Please see the full set of changes for this release also in the 7.0.0rc1 notes below)
Deprecations
#9488: If custom subclasses of nodes like
pytest.Item
{.interpreted-text role="class"} override the__init__
method, they should take**kwargs
. Seeuncooperative-constructors-deprecated
{.interpreted-text role="ref"} for details.Note that a deprection warning is only emitted when there is a conflict in the
arguments pytest expected to pass. This deprecation was already part of pytest
7.0.0rc1 but wasn't documented.
Bug Fixes
pytest.Config.inifile
{.interpreted-text role="attr"} is available during thepytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>
{.interpreted-text role="func"} hook (regression during7.0.0rc1
).Improved Documentation
that configuration file is located in the root of the repository.
Trivial/Internal Changes
pytest 7.0.0rc1 (2021-12-06)
Breaking Changes
#7259: The
Node.reportinfo() <non-python tests>
{.interpreted-text role="ref"} function first return value type has been expanded from [py.path.local | str]{.title-ref} to [os.PathLike[str] | str]{.title-ref}.Most plugins which refer to [reportinfo()]{.title-ref} only define it as part of a custom
pytest.Item
{.interpreted-text role="class"} implementation.Since [py.path.local]{.title-ref} is a [os.PathLike[str]]{.title-ref}, these plugins are unaffacted.
Plugins and users which call [reportinfo()]{.title-ref}, use the first return value and interact with it as a [py.path.local]{.title-ref}, would need to adjust by calling [py.path.local(fspath)]{.title-ref}.
Although preferably, avoid the legacy [py.path.local]{.title-ref} and use [pathlib.Path]{.title-ref}, or use [item.location]{.title-ref} or [item.path]{.title-ref}, instead.
Note: pytest was not able to provide a deprecation period for this change.
#8246:
--version
now writes version information tostdout
rather thanstderr
.#8733: Drop a workaround for pyreadline that made it work with
--pdb
.The workaround was introduced in #1281 in 2015, however since then
pyreadline seems to have gone unmaintained, is generating
warnings, and will stop working on Python 3.10.
#9061: Using
pytest.approx
{.interpreted-text role="func"} in a boolean context now raises an error hinting at the proper usage.It is apparently common for users to mistakenly use
pytest.approx
like this:While the correct usage is:
The new error message helps catch those mistakes.
#9277: The
pytest.Instance
collector type has been removed.Importing
pytest.Instance
or_pytest.python.Instance
returns a dummy type and emits a deprecation warning.See
instance-collector-deprecation
{.interpreted-text role="ref"} for details.#9308: PytestRemovedIn7Warning deprecation warnings are now errors by default.
Following our plan to remove deprecated features with as little disruption as
possible, all warnings of type
PytestRemovedIn7Warning
now generate errorsinstead of warning messages by default.
The affected features will be effectively removed in pytest 7.1, so please consult the
deprecations
{.interpreted-text role="ref"} section in the docs for directions on how to update existing code.In the pytest
7.0.X
series, it is possible to change the errors back into warnings as astopgap measure by adding this to your
pytest.ini
file:But this will stop working when pytest
7.1
is released.If you have concerns about the removal of a specific feature, please add a
comment to
9308
{.interpreted-text role="issue"}.Deprecations
#7259:
py.path.local
arguments for hooks have been deprecated. Seethe deprecation note <legacy-path-hooks-deprecated>
{.interpreted-text role="ref"} for full details.py.path.local
arguments to Node constructors have been deprecated. Seethe deprecation note <node-ctor-fspath-deprecation>
{.interpreted-text role="ref"} for full details.::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#7469: Directly constructing the following classes is now deprecated:
_pytest.mark.structures.Mark
_pytest.mark.structures.MarkDecorator
_pytest.mark.structures.MarkGenerator
_pytest.python.Metafunc
_pytest.runner.CallInfo
_pytest._code.ExceptionInfo
_pytest.config.argparsing.Parser
_pytest.config.argparsing.OptionGroup
_pytest.pytester.HookRecorder
These constructors have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8.
#8242: Raising
unittest.SkipTest
{.interpreted-text role="class"} to skip collection of tests during thepytest collection phase is deprecated. Use
pytest.skip
{.interpreted-text role="func"} instead.Note: This deprecation only relates to using
unittest.SkipTest
{.interpreted-text role="class"} during testcollection. You are probably not doing that. Ordinary usage of
unittest.SkipTest
{.interpreted-text role="class"} /unittest.TestCase.skipTest
{.interpreted-text role="meth"} /unittest.skip
{.interpreted-text role="func"} in unittest test cases is fully supported.#8315: Several behaviors of
Parser.addoption <pytest.Parser.addoption>
{.interpreted-text role="meth"} are nowscheduled for removal in pytest 8 (deprecated since pytest 2.4.0):
parser.addoption(..., help=".. %default ..")
- use%(default)s
instead.parser.addoption(..., type="int/string/float/complex")
- usetype=int
etc. instead.#8447: Defining a custom pytest node type which is both an
pytest.Item <Item>
{.interpreted-text role="class"} and apytest.Collector <Collector>
{.interpreted-text role="class"} (e.g.pytest.File <File>
{.interpreted-text role="class"}) now issues a warning.It was never sanely supported and triggers hard to debug errors.
See
the deprecation note <diamond-inheritance-deprecated>
{.interpreted-text role="ref"} for full details.#8592:
pytest_cmdline_preparse
{.interpreted-text role="hook"} has been officially deprecated. It will be removed in a future release. Usepytest_load_initial_conftests
{.interpreted-text role="hook"} instead.See
the deprecation note <cmdline-preparse-deprecated>
{.interpreted-text role="ref"} for full details.#8645:
pytest.warns(None) <pytest.warns>
{.interpreted-text role="func"} is now deprecated because many people usedit to mean "this code does not emit warnings", but it actually had the effect of
checking that the code emits at least one warning of any type - like
pytest.warns()
or
pytest.warns(Warning)
.#8948:
pytest.skip(msg=...) <pytest.skip>
{.interpreted-text role="func"},pytest.fail(msg=...) <pytest.fail>
{.interpreted-text role="func"} andpytest.exit(msg=...) <pytest.exit>
{.interpreted-text role="func"}signatures now accept a
reason
argument instead ofmsg
. Usingmsg
still works, but is deprecated and will be removed in a future release.This was changed for consistency with
pytest.mark.skip <pytest.mark.skip>
{.interpreted-text role="func"} andpytest.mark.xfail <pytest.mark.xfail>
{.interpreted-text role="func"} which both acceptreason
as an argument.#8174: The following changes have been made to types reachable through
pytest.ExceptionInfo.traceback
{.interpreted-text role="attr"}:path
property of_pytest.code.Code
returnsPath
instead ofpy.path.local
.path
property of_pytest.code.TracebackEntry
returnsPath
instead ofpy.path.local
.There was no deprecation period for this change (sorry!).
Features
#5196: Tests are now ordered by definition order in more cases.
In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order).
#7132: Added two environment variables
PYTEST_THEME
{.interpreted-text role="envvar"} andPYTEST_THEME_MODE
{.interpreted-text role="envvar"} to let the users customize the pygments theme used.#7259: Added
cache.mkdir() <pytest.Cache.mkdir>
{.interpreted-text role="meth"}, which is similar to the existingcache.makedir() <pytest.Cache.makedir>
{.interpreted-text role="meth"},but returns a
pathlib.Path
{.interpreted-text role="class"} instead of a legacypy.path.local
.Added a
paths
type toparser.addini() <pytest.Parser.addini>
{.interpreted-text role="meth"},as in
parser.addini("mypaths", "my paths", type="paths")
,which is similar to the existing
pathlist
,but returns a list of
pathlib.Path
{.interpreted-text role="class"} instead of legacypy.path.local
.#7469: The types of objects used in pytest's API are now exported so they may be used in type annotations.
The newly-exported types are:
pytest.Config
forConfig <pytest.Config>
{.interpreted-text role="class"}.pytest.Mark
formarks <pytest.Mark>
{.interpreted-text role="class"}.pytest.MarkDecorator
formark decorators <pytest.MarkDecorator>
{.interpreted-text role="class"}.pytest.MarkGenerator
for thepytest.mark <pytest.MarkGenerator>
{.interpreted-text role="class"} singleton.pytest.Metafunc
for themetafunc <pytest.MarkGenerator>
{.interpreted-text role="class"} argument to thepytest_generate_tests
{.interpreted-text role="hook"} hook.pytest.CallInfo
for theCallInfo <pytest.CallInfo>
{.interpreted-text role="class"} type passed to various hooks.pytest.PytestPluginManager
forPytestPluginManager <pytest.PytestPluginManager>
{.interpreted-text role="class"}.pytest.ExceptionInfo
for theExceptionInfo <pytest.ExceptionInfo>
{.interpreted-text role="class"} type returned frompytest.raises
{.interpreted-text role="func"} and passed to various hooks.pytest.Parser
for theParser <pytest.Parser>
{.interpreted-text role="class"} type passed to thepytest_addoption
{.interpreted-text role="hook"} hook.pytest.OptionGroup
for theOptionGroup <pytest.OptionGroup>
{.interpreted-text role="class"} type returned from theparser.addgroup <pytest.Parser.getgroup>
{.interpreted-text role="func"} method.pytest.HookRecorder
for theHookRecorder <pytest.HookRecorder>
{.interpreted-text role="class"} type returned from~pytest.Pytester
{.interpreted-text role="class"}.pytest.RecordedHookCall
for theRecordedHookCall <pytest.HookRecorder>
{.interpreted-text role="class"} type returned from~pytest.HookRecorder
{.interpreted-text role="class"}.pytest.RunResult
for theRunResult <pytest.RunResult>
{.interpreted-text role="class"} type returned from~pytest.Pytester
{.interpreted-text role="class"}.pytest.LineMatcher
for theLineMatcher <pytest.RunResult>
{.interpreted-text role="class"} type used in~pytest.RunResult
{.interpreted-text role="class"} and others.pytest.TestReport
for theTestReport <pytest.TestReport>
{.interpreted-text role="class"} type used in various hooks.pytest.CollectReport
for theCollectReport <pytest.CollectReport>
{.interpreted-text role="class"} type used in various hooks.Constructing most of them directly is not supported; they are only meant for use in type annotations.
Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0.
Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.
#7856:
--import-mode=importlib <import-modes>
{.interpreted-text role="ref"} now works with features thatdepend on modules being on :py
sys.modules
{.interpreted-text role="data"}, such aspickle
{.interpreted-text role="mod"} anddataclasses
{.interpreted-text role="mod"}.#8144: The following hooks now receive an additional
pathlib.Path
argument, equivalent to an existingpy.path.local
argument:pytest_ignore_collect
{.interpreted-text role="hook"} - Thecollection_path
parameter (equivalent to existingpath
parameter).pytest_collect_file
{.interpreted-text role="hook"} - Thefile_path
parameter (equivalent to existingpath
parameter).pytest_pycollect_makemodule
{.interpreted-text role="hook"} - Themodule_path
parameter (equivalent to existingpath
parameter).pytest_report_header
{.interpreted-text role="hook"} - Thestart_path
parameter (equivalent to existingstartdir
parameter).pytest_report_collectionfinish
{.interpreted-text role="hook"} - Thestart_path
parameter (equivalent to existingstartdir
parameter).::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#8251: Implement
Node.path
as apathlib.Path
. Both the oldfspath
and this new attribute gets set no matter whetherpath
orfspath
(deprecated) is passed to the constructor. It is a replacement for thefspath
attribute (which represents the same path aspy.path.local
). Whilefspath
is not deprecated yetdue to the ongoing migration of methods like
~_pytest.Item.reportinfo
{.interpreted-text role="meth"}, we expect to deprecate it in a future release.::: {.note}
::: {.admonition-title}
Note
:::
The name of the
~_pytest.nodes.Node
{.interpreted-text role="class"} arguments and attributes (thenew attribute being
path
) is the opposite of the situation for hooks(the old argument being
path
).This is an unfortunate artifact due to historical reasons, which should be
resolved in future versions as we slowly get rid of the
py
{.interpreted-text role="pypi"}dependency (see
9283
{.interpreted-text role="issue"} for a longer discussion).:::
#8421:
pytest.approx
{.interpreted-text role="func"} now works on~decimal.Decimal
{.interpreted-text role="class"} within mappings/dicts and sequences/lists.#8606: pytest invocations with
--fixtures-per-test
and--fixtures
have been enriched with:--verbose
option.#8761: New
version-tuple
{.interpreted-text role="ref"} attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions).#8789: Switch TOML parser from
toml
totomli
for TOML v1.0.0 support inpyproject.toml
.#8920: Added
pytest.Stash
{.interpreted-text role="class"}, a facility for plugins to store their data on~pytest.Config
{.interpreted-text role="class"} and~_pytest.nodes.Node
{.interpreted-text role="class"}s in a type-safe and conflict-free manner.See
plugin-stash
{.interpreted-text role="ref"} for details.#8953:
RunResult <_pytest.pytester.RunResult>
{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>
{.interpreted-text role="meth"} now accepts awarnings
argument to assert the total number of warnings captured.#8954:
--debug
flag now accepts astr
{.interpreted-text role="class"} file to route debug logs into, remains defaulted to [pytestdebug.log]{.title-ref}.#9023: Full diffs are now always shown for equality assertions of iterables when
[CI]{.title-ref} or
BUILD_NUMBER
is found in the environment, even when-v
isn'tused.
#9113:
RunResult <_pytest.pytester.RunResult>
{.interpreted-text role="class"} methodassert_outcomes <_pytest.pytester.RunResult.assert_outcomes>
{.interpreted-text role="meth"} now accepts adeselected
argument to assert the total number of deselected tests.#9114: Added
pythonpath
{.interpreted-text role="confval"} setting that adds listed paths tosys.path
{.interpreted-text role="data"} for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in [pythonpath]{.title-ref} setting.Improvements
#7480: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category [PytestRemovedInXWarning]{.title-ref},
a subclass of
~pytest.PytestDeprecationWarning
{.interpreted-text role="class"},instead of
PytestDeprecationWarning
{.interpreted-text role="class"} directly.See
backwards-compatibility
{.interpreted-text role="ref"} for more details.#7864: Improved error messages when parsing warning filters.
Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause
of the problem (for example an
ImportError
while importing a specific warning type).#8335: Improved
pytest.approx
{.interpreted-text role="func"} assertion messages for sequences of numbers.The assertion messages now dumps a table with the index and the error of each diff.
Example:
#8403: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much,
currently at
240
characters by default.However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using
-v
willnow increase the truncation threshold to
2400
characters, and-vv
or higher will disable truncation entirely.#8509: Fixed issue where
unittest.TestCase.setUpClass
{.interpreted-text role="meth"} is not called when a test has [/]{.title-ref} in its name since pytest 6.2.0.This refers to the path part in pytest node IDs, e.g.
TestClass::test_it
in the node IDtests/test_file.py::TestClass::test_it
.Now, instead of assuming that the test name does not contain
/
, it is assumed that test path does not contain::
. We plan to hopefully make both of these work in the future.#8803: It is now possible to add colors to custom log levels on cli log.
By using
add_color_level <_pytest.logging.add_color_level>
{.interpreted-text role="func"} from apytest_configure
hook, colors can be added:See
log_colors
{.interpreted-text role="ref"} for more information.#8822: When showing fixture paths in [--fixtures]{.title-ref} or [--fixtures-by-test]{.title-ref}, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the [site-packages]{.title-ref} directory.
#8898: Complex numbers are now treated like floats and integers when generating parameterization IDs.
#9062:
--stepwise-skip
now implicitly enables--stepwise
and can be used on its own.#9205:
pytest.Cache.set
{.interpreted-text role="meth"} now preserves key order when saving dicts.Bug Fixes
#7124: Fixed an issue where
__main__.py
would raise anImportError
when--doctest-modules
was provided.#8061: Fixed failing
staticmethod
test cases if they are inherited from a parent test class.#8192:
testdir.makefile
now silently accepts values which don't start with.
to maintain backward compatibility with older pytest versions.pytester.makefile
now issues a clearer error if the.
is missing in theext
argument.#8258: Fixed issue where pytest's
faulthandler
support would not dump traceback on crashesif the
faulthandler
{.interpreted-text role="mod"} module was already enabled during pytest startup (usingpython -X dev -m pytest
for example).#8317: Fixed an issue where illegal directory characters derived from
getpass.getuser()
raised anOSError
.#8367: Fix
Class.from_parent
so it forwards extra keyword arguments to the constructor.#8377: The test selection options
pytest -k
andpytest -m
now support matchingnames containing forward slash (
/
) characters.#8384: The
@pytest.mark.skip
decorator now correctly handles its arguments. When thereason
argument is accidentally given both positional and as a keyword (e.g. because it was confused withskipif
), aTypeError
now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally,reason
is now documented correctly as positional or keyword (rather than keyword-only).#8394: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default
--fixtures
invocation (but they still show up with--fixtures -v
).#8456: The
required_plugins
{.interpreted-text role="confval"} config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all.#8464:
-c <config file>
now also properly definesrootdir
as the directory that contains<config file>
.#8503:
pytest.MonkeyPatch.syspath_prepend
{.interpreted-text role="meth"} no longer fails whensetuptools
is not installed.It now only calls
pkg_resources.fixup_namespace_packages
{.interpreted-text role="func"} ifpkg_resources
was previously imported, because it is not needed otherwise.#8548: Introduce fix to handle precision width in
log-cli-format
in turn to fix output coloring for certain formats.#8796: Fixed internal error when skipping doctests.
#8983: The test selection options
pytest -k
andpytest -m
now support matching names containing backslash ([\]{.title-ref}) characters.Backslashes are treated literally, not as escape characters (the values being matched against are already escaped).
#8990: Fix [pytest -vv]{.title-ref} crashing with an internal exception [AttributeError: 'str' object has no attribute 'relative_to']{.title-ref} in some cases.
#9077: Fixed confusing error message when
request.fspath
/request.path
was accessed from a session-scoped fixture.#9131: Fixed the URL used by
--pastebin
to use bpa.st.#9163: The end line number and end column offset are now properly set for rewritten assert statements.
#9169: Support for the
files
API fromimportlib.resources
within rewritten files.#9272: The nose compatibility module-level fixtures [setup()]{.title-ref} and [teardown()]{.title-ref} are now only called once per module, instead of for each test function.
They are now called even if object-level [setup]{.title-ref}/[teardown]{.title-ref} is defined.
Improved Documentation
plugin-list
{.interpreted-text role="ref"}. The list is updated on a periodic schedule.pytest.approx
{.interpreted-text role="func"} documentation.--pdbcls
more accurately reflects the option's behavior.confcutdir
being a configuration option: it can only be set through the--confcutdir
command-line option.non-python tests
{.interpreted-text role="ref"} are now correctly documented in the reference docs. They were undocumented previously.Trivial/Internal Changes
setuptools_scm
6.x to useSETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST
for more robust release tooling._pytest.code.getfslineno()
function returnsPath
instead ofpy.path.local
._pytest.python.path_matches_patterns()
function takesPath
instead ofpy.path.local
._pytest._code.Traceback.cut()
function accepts anyos.PathLike[str]
, not justpy.path.local
.python.PyObjMixin
inherit fromnodes.Node
to carry over typing information.pytest.skip
{.interpreted-text role="func"} is used at module level without passing [allow_module_level=True]{.title-ref}.regendoc
opts out ofTOX_ENV
cachedir selection to ensure independent example test runs.CallSpec2._arg2scopenum
attribute has been removed after an internal refactoring.pytest_assertion_pass
{.interpreted-text role="hook"} is no longer considered experimental andfuture changes to it will be considered more carefully.
Configuration
📅 Schedule: 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 WhiteSource Renovate. View repository job log here.