Skip to content

Releases: pytest-dev/pytest

7.0.1

11 Feb 18:49
Compare
Choose a tag to compare

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

04 Feb 10:21
Compare
Choose a tag to compare

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

Read more

7.0.0rc1

07 Dec 08:35
Compare
Choose a tag to compare
Prepare release version 7.0.0rc1

6.2.5

30 Aug 17:39
Compare
Choose a tag to compare

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

04 May 16:22
Compare
Choose a tag to compare

pytest 6.2.4 (2021-05-04)

Bug Fixes

  • #8539: Fixed assertion rewriting on Python 3.10.

6.2.3

03 Apr 22:06
Compare
Choose a tag to compare

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

6.2.2

25 Jan 14:52
Compare
Choose a tag to compare

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 with twisted.logger and using pytest --capture=no.

6.2.1

15 Dec 15:38
Compare
Choose a tag to compare

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.0 approx no longer raises
    TypeError 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 from numpy.ndarray.

    approx now converts arguments to numpy.ndarray if they expose the array
    protocol and are not scalars. This treats array-like objects like numpy arrays,
    regardless of size.

6.2.0

12 Dec 21:18
Compare
Choose a tag to compare

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 for fixture 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 use
    MonkeyPatch directly, since unlike the monkeypatch fixture, an instance created directly
    is not undo()-ed automatically.

Improvements

  • #1265: Added an __str__ implementation to the ~pytest.pytester.LineMatcher class which is returned from pytester.run_pytest().stdout and similar. It returns the entire output, like the existing str() 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 <pytest.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 explicit None 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.)

6.1.2

28 Oct 17:21
Compare
Choose a tag to compare

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