8.0.0rc2

pytest 8.0.0rc2 (2024-01-17)

Improvements

• #11233: Improvements to -r for xfailures and xpasses:
  • Report tracebacks for xfailures when -rx is set.
  • Report captured output for xpasses when -rX is set.
  • For xpasses, add - in summary between test name and reason, to match how xfail is displayed.
• #11825: The pytest_plugin_registered{.interpreted-text role="hook"} hook has a new plugin_name parameter containing the name by which plugin is registered.

Bug Fixes

• #11706: Fix reporting of teardown errors in higher-scoped fixtures when using [--maxfail]{.title-ref} or [--stepwise]{.title-ref}.

• #11758: Fixed IndexError: string index out of range crash in if highlighted[-1] == "\n" and source[-1] != "\n".
  This bug was introduced in pytest 8.0.0rc1.

• #9765, #11816: Fixed a frustrating bug that afflicted some users with the only error being assert mod not in mods. The issue was caused by the fact that str(Path(mod)) and mod.__file__ don't necessarily produce the same string, and was being erroneously used interchangably in some places in the code.

  This fix also broke the internal API of PytestPluginManager.consider_conftest by introducing a new parameter -- we mention this in case it is being used by external code, even if marked as private.

pytest 8.0.0rc1 (2023-12-30)

See https://docs.pytest.org/en/latest/changelog.html#pytest-8-0-0rc1-2023-12-30 for the rendered changelog.

Breaking Changes

Old Deprecations Are Now Errors

• #7363: PytestRemovedIn8Warning deprecation warnings are now errors by default.

  Following our plan to remove deprecated features with as little disruption as possible, all warnings of type PytestRemovedIn8Warning now generate errors instead of warning messages by default.

  The affected features will be effectively removed in pytest 8.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 8.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.PytestRemovedIn8Warning

  But this will stop working when pytest 8.1 is released.

  If you have concerns about the removal of a specific feature, please add a comment to 7363{.interpreted-text role="issue"}.

Version Compatibility

• #11151: Dropped support for Python 3.7, which reached end-of-life on 2023-06-27.
• pluggy>=1.3.0 is now required.

Collection Changes

In this version we've made several breaking changes to pytest's collection phase, particularly around how filesystem directories and Python packages are collected, fixing deficiencies and allowing for cleanups and improvements to pytest's internals. A deprecation period for these changes was not possible.

• #7777: Files and directories are now collected in alphabetical order jointly, unless changed by a plugin.
  Previously, files were collected before directories.
  See below for an example.

• #8976: Running [pytest pkg/__init__.py]{.title-ref} now collects the [pkg/__init__.py]{.title-ref} file (module) only.
  Previously, it collected the entire [pkg]{.title-ref} package, including other test files in the directory, but excluding tests in the [__init__.py]{.title-ref} file itself
  (unless python_files{.interpreted-text role="confval"} was changed to allow [__init__.py]{.title-ref} file).

  To collect the entire package, specify just the directory: [pytest pkg]{.title-ref}.

• #11137: pytest.Package{.interpreted-text role="class"} is no longer a pytest.Module{.interpreted-text role="class"} or pytest.File{.interpreted-text role="class"}.

  The Package collector node designates a Python package, that is, a directory with an [__init__.py]{.title-ref} file.
  Previously Package was a subtype of pytest.Module (which represents a single Python module), the module being the [__init__.py]{.title-ref} file.
  This has been deemed a design mistake (see 11137{.interpreted-text role="issue"} and 7777{.interpreted-text role="issue"} for details).

  The path property of Package nodes now points to the package directory instead of the __init__.py file.

  Note that a Module node for __init__.py (which is not a Package) may still exist, if it is picked up during collection (e.g. if you configured python_files{.interpreted-text role="confval"} to include __init__.py files).

• #7777: Added a new pytest.Directory{.interpreted-text role="class"} base collection node, which all collector nodes for filesystem directories are expected to subclass.
  This is analogous to the existing pytest.File{.interpreted-text role="class"} for file nodes.

  Changed pytest.Package{.interpreted-text role="class"} to be a subclass of pytest.Directory{.interpreted-text role="class"}.
  A Package represents a filesystem directory which is a Python package,
  i.e. contains an __init__.py file.

  pytest.Package{.interpreted-text role="class"} now only collects files in its own directory; previously it collected recursively.
  Sub-directories are collected as their own collector nodes, which then collect themselves, thus creating a collection tree which mirrors the filesystem hierarchy.

  Added a new pytest.Dir{.interpreted-text role="class"} concrete collection node, a subclass of pytest.Directory{.interpreted-text role="class"}.
  This node represents a filesystem directory, which is not a pytest.Package{.interpreted-text role="class"}, that is, does not contain an __init__.py file. Similarly to Package, it only collects the files in its own directory.

  pytest.Session{.interpreted-text role="class"} now only collects the initial arguments, without recursing into directories.
  This work is now done by the recursive expansion process <pytest.Collector.collect>{.interpreted-text role="func"} of directory collector nodes.

  session.name <pytest.Session.name>{.interpreted-text role="attr"} is now ""; previously it was the rootdir directory name.
  This matches session.nodeid <_pytest.nodes.Node.nodeid>{.interpreted-text role="attr"} which has always been [""]{.title-ref}.

  The collection tree now contains directories/packages up to the rootdir <rootdir>{.interpreted-text role="ref"}, for initial arguments that are found within the rootdir.
  For files outside the rootdir, only the immediate directory/package is collected --note however that collecting from outside the rootdir is discouraged.

  As an example, given the following filesystem tree:

  myroot/
      pytest.ini
      top/
      ├── aaa
      │   └── test_aaa.py
      ├── test_a.py
      ├── test_b
      │   ├── __init__.py
      │   └── test_b.py
      ├── test_c.py
      └── zzz
          ├── __init__.py
          └── test_zzz.py
  

  the collection tree, as shown by [pytest --collect-only top/]{.title-ref} but with the otherwise-hidden ~pytest.Session{.interpreted-text role="class"} node added for clarity, is now the following:

  <Session>
    <Dir myroot>
      <Dir top>
        <Dir aaa>
          <Module test_aaa.py>
            <Function test_it>
        <Module test_a.py>
          <Function test_it>
        <Package test_b>
          <Module test_b.py>
            <Function test_it>
        <Module test_c.py>
          <Function test_it>
        <Package zzz>
          <Module test_zzz.py>
            <Function test_it>
  

  Previously, it was:

  <Session>
    <Module top/test_a.py>
      <Function test_it>
    <Module top/test_c.py>
      <Function test_it>
    <Module top/aaa/test_aaa.py>
      <Function test_it>
    <Package test_b>
      <Module test_b.py>
        <Function test_it>
    <Package zzz>
      <Module test_zzz.py>
        <Function test_it>
  

  Code/plugins which rely on a specific shape of the collection tree might need to update.

• #11676: The classes ~_pytest.nodes.Node{.interpreted-text role="class"}, ~pytest.Collector{.interpreted-text role="class"}, ~pytest.Item{.interpreted-text role="class"}, ~pytest.File{.interpreted-text role="class"}, ~_pytest.nodes.FSCollector{.interpreted-text role="class"} are now marked abstract (see abc{.interpreted-text role="mod"}).

  We do not expect this change to affect users and plugin authors, it will only cause errors when the code is already wrong or problematic.

Other breaking changes

These are breaking changes where deprecation was not possible.

• #11282: Sanitized the handling of the default parameter when defining configuration options.

  Previously if default was not supplied for parser.addini <pytest.Parser.addini>{.interpreted-text role="meth"} and the configuration option value was not defined in a test session, then calls to config.getini <pytest.Config.getini>{.interpreted-text role="func"} returned an empty list or an empty string depending on whether type was supplied or not respectively, which is clearly incorrect. Also, None was not honored even if default=None was used explicitly while defining the option.

  Now the behavior of parser.addini <pytest.Parser.addini>{.interpreted-text role="meth"} is as follows:

  • If default is NOT passed but type is provided, then a type-specific default will be returned. For example type=bool will return False, type=str will return "", etc.
  • If default=None is passed and the option is not defined in a test session, then None will be returned, regardless of the type.
  • If neither default nor type are provided, assume type=str and return "" as default (this is as per previous behavior).

  The team decided to not introduce a deprecation period for this change, as doing so would be complicated both in terms of communicating this to the community as well as implementing it, and also because the team believes this change should not break existing plugins except in rare cases.

• #11667: pytest's setup.py file is removed.
  If you relied on this file, e.g. to install pytest using setup.py install, please see Why you shouldn't invoke setup.py directly for alte...

pytest 7.4.4 (2023-12-31)

Bug Fixes

• #11140: Fix non-string constants at the top of file being detected as docstrings on Python>=3.8.
• #11572: Handle an edge case where sys.stderr{.interpreted-text role="data"} and sys.__stderr__{.interpreted-text role="data"} might already be closed when faulthandler{.interpreted-text role="ref"} is tearing down.
• #11710: Fixed tracebacks from collection errors not getting pruned.
• #7966: Removed unhelpful error message from assertion rewrite mechanism when exceptions are raised in __iter__ methods. Now they are treated un-iterable instead.

Improved Documentation

• #11091: Updated documentation to refer to hyphenated options: replaced --junitxml with --junit-xml and --collectonly with --collect-only.

pytest 7.4.3 (2023-10-24)

Bug Fixes

• #10447: Markers are now considered in the reverse mro order to ensure base class markers are considered first -- this resolves a regression.

• #11239: Fixed := in asserts impacting unrelated test cases.

• #11439: Handled an edge case where :data:sys.stderr might already be closed when :ref:faulthandler is tearing down.

pytest 7.4.2 (2023-09-07)

Bug Fixes

• #11237: Fix doctest collection of functools.cached_property objects.

• #11306: Fixed bug using --importmode=importlib which would cause package __init__.py files to be imported more than once in some cases.

• #11367: Fixed bug where user_properties where not being saved in the JUnit XML file if a fixture failed during teardown.

• #11394: Fixed crash when parsing long command line arguments that might be interpreted as files.

Improved Documentation

• #11391: Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing.

pytest 7.4.1 (2023-09-02)

Bug Fixes

• #10337: Fixed bug where fake intermediate modules generated by --import-mode=importlib would not include the
  child modules as attributes of the parent modules.

• #10702: Fixed error assertion handling in pytest.approx when None is an expected or received value when comparing dictionaries.

• #10811: Fixed issue when using --import-mode=importlib together with --doctest-modules that caused modules
  to be imported more than once, causing problems with modules that have import side effects.

Prepare release version 7.4.0

pytest 7.4.0 (2023-06-23)

Features

• #10901: Added ExceptionInfo.from_exception() <pytest.ExceptionInfo.from_exception>{.interpreted-text role="func"}, a simpler way to create an ~pytest.ExceptionInfo{.interpreted-text role="class"} from an exception.
  This can replace ExceptionInfo.from_exc_info() <pytest.ExceptionInfo.from_exc_info()>{.interpreted-text role="func"} for most uses.

Improvements

• #10872: Update test log report annotation to named tuple and fixed inconsistency in docs for pytest_report_teststatus{.interpreted-text role="hook"} hook.

• #10907: When an exception traceback to be displayed is completely filtered out (by mechanisms such as __tracebackhide__, internal frames, and similar), now only the exception string and the following message are shown:

  "All traceback entries are hidden. Pass [--full-trace]{.title-ref} to see hidden and internal frames.".

  Previously, the last frame of the traceback was shown, even though it was hidden.

• #10940: Improved verbose output (-vv) of skip and xfail reasons by performing text wrapping while leaving a clear margin for progress output.

  Added TerminalReporter.wrap_write() as a helper for that.

• #10991: Added handling of %f directive to print microseconds in log format options, such as log-date-format.

• #11005: Added the underlying exception to the cache provider's path creation and write warning messages.

• #11013: Added warning when testpaths{.interpreted-text role="confval"} is set, but paths are not found by glob. In this case, pytest will fall back to searching from the current directory.

• #11043: When [--confcutdir]{.title-ref} is not specified, and there is no config file present, the conftest cutoff directory ([--confcutdir]{.title-ref}) is now set to the rootdir <rootdir>{.interpreted-text role="ref"}.
  Previously in such cases, [conftest.py]{.title-ref} files would be probed all the way to the root directory of the filesystem.
  If you are badly affected by this change, consider adding an empty config file to your desired cutoff directory, or explicitly set [--confcutdir]{.title-ref}.

• #11081: The norecursedirs{.interpreted-text role="confval"} check is now performed in a pytest_ignore_collect{.interpreted-text role="hook"} implementation, so plugins can affect it.

  If after updating to this version you see that your [norecursedirs]{.title-ref} setting is not being respected,
  it means that a conftest or a plugin you use has a bad [pytest_ignore_collect]{.title-ref} implementation.
  Most likely, your hook returns [False]{.title-ref} for paths it does not want to ignore,
  which ends the processing and doesn't allow other plugins, including pytest itself, to ignore the path.
  The fix is to return [None]{.title-ref} instead of [False]{.title-ref} for paths your hook doesn't want to ignore.

• #8711: caplog.set_level() <pytest.LogCaptureFixture.set_level>{.interpreted-text role="func"} and caplog.at_level() <pytest.LogCaptureFixture.at_level>{.interpreted-text role="func"}
  will temporarily enable the requested level if level was disabled globally via
  logging.disable(LEVEL).

Bug Fixes

• #10831: Terminal Reporting: Fixed bug when running in --tb=line mode where pytest.fail(pytrace=False) tests report None.
• #11068: Fixed the --last-failed whole-file skipping functionality ("skipped N files") for non-python test files <non-python tests>{.interpreted-text role="ref"}.
• #11104: Fixed a regression in pytest 7.3.2 which caused to testpaths{.interpreted-text role="confval"} to be considered for loading initial conftests,
  even when it was not utilized (e.g. when explicit paths were given on the command line).
  Now the testpaths are only considered when they are in use.
• #1904: Fixed traceback entries hidden with __tracebackhide__ = True still being shown for chained exceptions (parts after "... the above exception ..." message).
• #7781: Fix writing non-encodable text to log file when using --debug.

Improved Documentation

• #9146: Improved documentation for caplog.set_level() <pytest.LogCaptureFixture.set_level>{.interpreted-text role="func"}.

Trivial/Internal Changes

• #11031: Enhanced the CLI flag for -c to now include --config-file to make it clear that this flag applies to the usage of a custom config file.

7.3.2

pytest 7.3.2 (2023-06-10)

Bug Fixes

• #10169: Fix bug where very long option names could cause pytest to break with OSError: [Errno 36] File name too long on some systems.
• #10894: Support for Python 3.12 (beta at the time of writing).
• #10987: testpaths{.interpreted-text role="confval"} is now honored to load root conftests.
• #10999: The [monkeypatch]{.title-ref} [setitem]{.title-ref}/[delitem]{.title-ref} type annotations now allow [TypedDict]{.title-ref} arguments.
• #11028: Fixed bug in assertion rewriting where a variable assigned with the walrus operator could not be used later in a function call.
• #11054: Fixed --last-failed's "(skipped N files)" functionality for files inside of packages (directories with [__init__.py]{.title-ref} files).

7.3.1

pytest 7.3.1 (2023-04-14)

Improvements

• #10875: Python 3.12 support: fixed RuntimeError: TestResult has no addDuration method when running unittest tests.
• #10890: Python 3.12 support: fixed shutil.rmtree(onerror=...) deprecation warning when using tmp_path{.interpreted-text role="fixture"}.

Bug Fixes

• #10896: Fixed performance regression related to tmp_path{.interpreted-text role="fixture"} and the new tmp_path_retention_policy{.interpreted-text role="confval"} option.
• #10903: Fix crash INTERNALERROR IndexError: list index out of range which happens when displaying an exception where all entries are hidden.
  This reverts the change "Correctly handle __tracebackhide__ for chained exceptions." introduced in version 7.3.0.

7.3.0

pytest 7.3.0 (2023-04-08)

Features

• #10525: Test methods decorated with @classmethod can now be discovered as tests, following the same rules as normal methods. This fills the gap that static methods were discoverable as tests but not class methods.
• #10755: console_output_style{.interpreted-text role="confval"} now supports progress-even-when-capture-no to force the use of the progress output even when capture is disabled. This is useful in large test suites where capture may have significant performance impact.
• #7431: --log-disable CLI option added to disable individual loggers.
• #8141: Added tmp_path_retention_count{.interpreted-text role="confval"} and tmp_path_retention_policy{.interpreted-text role="confval"} configuration options to control how directories created by the tmp_path{.interpreted-text role="fixture"} fixture are kept.

Improvements

• #10226: If multiple errors are raised in teardown, we now re-raise an ExceptionGroup of them instead of discarding all but the last.
• #10658: Allow -p arguments to include spaces (eg: -p no:logging instead of
  -pno:logging). Mostly useful in the addopts section of the configuration
  file.
• #10710: Added start and stop timestamps to TestReport objects.
• #10727: Split the report header for rootdir, config file and testpaths so each has its own line.
• #10840: pytest should no longer crash on AST with pathological position attributes, for example testing AST produced by [Hylang <https://github.com/hylang/hy>__]{.title-ref}.
• #6267: The full output of a test is no longer truncated if the truncation message would be longer than
  the hidden text. The line number shown has also been fixed.

Bug Fixes

• #10743: The assertion rewriting mechanism now works correctly when assertion expressions contain the walrus operator.
• #10765: Fixed tmp_path{.interpreted-text role="fixture"} fixture always raising OSError{.interpreted-text role="class"} on emscripten platform due to missing os.getuid{.interpreted-text role="func"}.
• #1904: Correctly handle __tracebackhide__ for chained exceptions.

Improved Documentation

• #10782: Fixed the minimal example in goodpractices{.interpreted-text role="ref"}: pip install -e . requires a version entry in pyproject.toml to run successfully.

Trivial/Internal Changes

• #10669: pytest no longer depends on the [attrs]{.title-ref} package (don't worry, nice diffs for attrs classes are still supported).