7.2.0

pytest 7.2.0 (2022-10-23)

Deprecations

• #10012: Update pytest.PytestUnhandledCoroutineWarning{.interpreted-text role="class"} to a deprecation; it will raise an error in pytest 8.

• #10396: pytest no longer depends on the py library. pytest provides a vendored copy of py.error and py.path modules but will use the py library if it is installed. If you need other py.* modules, continue to install the deprecated py library separately, otherwise it can usually be removed as a dependency.

• #4562: Deprecate configuring hook specs/impls using attributes/marks.

  Instead use :pypytest.hookimpl{.interpreted-text role="func"} and :pypytest.hookspec{.interpreted-text role="func"}.
  For more details, see the docs <legacy-path-hooks-deprecated>{.interpreted-text role="ref"}.

• #9886: The functionality for running tests written for nose has been officially deprecated.

  This includes:

  • Plain setup and teardown functions and methods: this might catch users by surprise, as setup() and teardown() are not pytest idioms, but part of the nose support.
  • Setup/teardown using the @with_setup decorator.

  For more details, consult the deprecation docs <nose-deprecation>{.interpreted-text role="ref"}.

Features

• #9897: Added shell-style wildcard support to testpaths.

Improvements

• #10218: @pytest.mark.parametrize() (and similar functions) now accepts any Sequence[str] for the argument names,
  instead of just list[str] and tuple[str, ...].

  (Note that str, which is itself a Sequence[str], is still treated as a
  comma-delimited name list, as before).

• #10381: The --no-showlocals flag has been added. This can be passed directly to tests to override --showlocals declared through addopts.

• #3426: Assertion failures with strings in NFC and NFD forms that normalize to the same string now have a dedicated error message detailing the issue, and their utf-8 representation is expresed instead.

• #7337: A warning is now emitted if a test function returns something other than [None]{.title-ref}. This prevents a common mistake among beginners that expect that returning a [bool]{.title-ref} (for example [return foo(a, b) == result]{.title-ref}) would cause a test to pass or fail, instead of using [assert]{.title-ref}.

• #8508: Introduce multiline display for warning matching via :pypytest.warns{.interpreted-text role="func"} and
  enhance match comparison for :py_pytest._code.ExceptionInfo.match{.interpreted-text role="func"} as returned by :pypytest.raises{.interpreted-text role="func"}.

• #8646: Improve :pypytest.raises{.interpreted-text role="func"}. Previously passing an empty tuple would give a confusing
  error. We now raise immediately with a more helpful message.

• #9741: On Python 3.11, use the standard library's tomllib{.interpreted-text role="mod"} to parse TOML.

  tomli{.interpreted-text role="mod"}` is no longer a dependency on Python 3.11.

• #9742: Display assertion message without escaped newline characters with -vv.

• #9823: Improved error message that is shown when no collector is found for a given file.

• #9873: Some coloring has been added to the short test summary.

• #9883: Normalize the help description of all command-line options.

• #9920: Display full crash messages in short test summary info, when runng in a CI environment.

• #9987: Added support for hidden configuration file by allowing .pytest.ini as an alternative to pytest.ini.

Bug Fixes

• #10150: sys.stdin{.interpreted-text role="data"} now contains all expected methods of a file-like object when capture is enabled.

• #10382: Do not break into pdb when raise unittest.SkipTest() appears top-level in a file.

• #7792: Marks are now inherited according to the full MRO in test classes. Previously, if a test class inherited from two or more classes, only marks from the first super-class would apply.

  When inheriting marks from super-classes, marks from the sub-classes are now ordered before marks from the super-classes, in MRO order. Previously it was the reverse.

  When inheriting marks from super-classes, the [pytestmark]{.title-ref} attribute of the sub-class now only contains the marks directly applied to it. Previously, it also contained marks from its super-classes. Please note that this attribute should not normally be accessed directly; use pytest.Node.iter_markers{.interpreted-text role="func"} instead.

• #9159: Showing inner exceptions by forcing native display in ExceptionGroups even when using display options other than --tb=native. A temporary step before full implementation of pytest-native display for inner exceptions in ExceptionGroups.

• #9877: Ensure caplog.get_records(when) returns current/correct data after invoking caplog.clear().

Improved Documentation

• #10344: Update information on writing plugins to use pyproject.toml instead of setup.py.
• #9248: The documentation is now built using Sphinx 5.x (up from 3.x previously).
• #9291: Update documentation on how pytest.warns{.interpreted-text role="func"} affects DeprecationWarning{.interpreted-text role="class"}.

Trivial/Internal Changes

• #10196: ~pytest.PytestReturnNotNoneWarning{.interpreted-text role="class"} is now a subclass of ~pytest.PytestRemovedIn8Warning{.interpreted-text role="class"}: the plan is to make returning non-None from tests an error in the future.
• #10313: Made _pytest.doctest.DoctestItem export pytest.DoctestItem for
  type check and runtime purposes. Made [_pytest.doctest]{.title-ref} use internal APIs
  to avoid circular imports.
• #9906: Made _pytest.compat re-export importlib_metadata in the eyes of type checkers.
• #9910: Fix default encoding warning (EncodingWarning) in cacheprovider
• #9984: Improve the error message when we attempt to access a fixture that has been
  torn down.
  Add an additional sentence to the docstring explaining when it's not a good
  idea to call getfixturevalue.

7.1.3

pytest 7.1.3 (2022-08-31)

Bug Fixes

• #10060: When running with --pdb, TestCase.tearDown is no longer called for tests when the class has been skipped via unittest.skip or pytest.mark.skip.
• #10190: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports.
• #10230: Ignore .py files created by pyproject.toml-based editable builds introduced in pip 21.3.
• #3396: Doctests now respect the --import-mode flag.
• #9514: Type-annotate FixtureRequest.param as Any as a stop gap measure until 8073{.interpreted-text role="issue"} is fixed.
• #9791: Fixed a path handling code in rewrite.py that seems to work fine, but was incorrect and fails in some systems.
• #9917: Fixed string representation for pytest.approx{.interpreted-text role="func"} when used to compare tuples.

Improved Documentation

• #9937: Explicit note that tmpdir{.interpreted-text role="fixture"} fixture is discouraged in favour of tmp_path{.interpreted-text role="fixture"}.

Trivial/Internal Changes

• #10114: Replace atomicwrites dependency on windows with [os.replace]{.title-ref}.

7.1.2

pytest 7.1.2 (2022-04-23)

Bug Fixes

• #9726: An unnecessary numpy import inside pytest.approx{.interpreted-text role="func"} was removed.
• #9820: Fix comparison of dataclasses with InitVar.
• #9869: Increase stacklevel for the NODE_CTOR_FSPATH_ARG deprecation to point to the
  user's code, not pytest.
• #9871: Fix a bizarre (and fortunately rare) bug where the [temp_path]{.title-ref} fixture could raise
  an internal error while attempting to get the current user's username.

7.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.

7.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 - use pytest_warning_recorded instead.
  • -k -foobar syntax - use -k 'not foobar' instead.
  • -k foobar: syntax.
  • pytest.collect module - import from pytest 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 in attrs or dataclasses.

• #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 enabling tracemalloc{.interpreted-text role="mod"}.

  See resource-warnings{.interpreted-text role="ref"} for more information.

• #9678: More types are now accepted in the ids argument to @pytest.mark.parametrize.
  Previously only [str]{.title-ref}, [float]{.title-ref}, [int]{.title-ref} and [bool]{.title-ref} were accepted;
  now [bytes]{.title-ref}, [complex]{.title-ref}, [re.Pattern]{.title-ref}, [Enum]{.title-ref} and anything with a [__name__]{.title-ref} are also accepted.

• #9692: pytest.approx{.interpreted-text role="func"} now raises a TypeError{.interpreted-text role="class"} when given an unordered sequence (such as set{.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 as tests/real/conftest.py and once as tests/link/conftest.py.
  This is a fix to match a similar change made to test collection itself in pytest 6.0 (see 6523{.interpreted-text role="pull"} for details).

• #9626: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules.

  If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count.

• #9645: Fixed regression where --import-mode=importlib used together with PYTHONPATH{.interpreted-text role="envvar"} or pythonpath{.interpreted-text role="confval"} would cause import errors in test suites.

• #9708: pytester{.interpreted-text role="fixture"} now requests a monkeypatch{.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.

7.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 to python_path. This avoids a conflict with the pytest-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 using standard warning filters <warnings>{.interpreted-text role="ref"}.

7.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. See
  uncooperative-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 the pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>{.interpreted-text role="func"} hook (regression during 7.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 to stdout rather than stderr.

• #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.
  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 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 your pytest.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. See the deprecation note <legacy-path-hooks-deprecated>{.interpreted-text role="ref"} for full details.

  py.path.local arguments to Node constructors have been deprecated. See the 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 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 the
  pytest 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 test
  collection. 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 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") - use type=int etc. instead.

• #8447: Defining a custom pytest node type which is both an pytest.Item <Item>{.interpreted-text role="class"} and a pytest.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. Use pytest_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 - 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"} and pytest.exit(msg=...) <pytest.exit>{.interpreted-text role="func"}
  signatures now accept a reason argument instead of msg. Using msg 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"} and pytest.mark.xfail <pytest.mark.xfail>{.interpreted-text role="func"} which both accep...

7.0.0rc1

Prepare release version 7.0.0rc1

6.2.5

pytest 6.2.5 (2021-08-29)

Trivial/Internal Changes

• #8494: Python 3.10 is now supported.
• #9040: Enable compatibility with pluggy 1.0 or later.

6.2.4

pytest 6.2.4 (2021-05-04)

Bug Fixes

• #8539: Fixed assertion rewriting on Python 3.10.