Releases: pytest-dev/pytest
6.2.5
6.2.4
6.2.3
pytest 6.2.3 (2021-04-03)
Bug Fixes
-
#8414: pytest used to create directories under
/tmpwith 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/tmpdirfixture). 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
6.2.1
pytest 6.2.1 (2020-12-15)
Bug Fixes
-
#7678: Fixed bug where
ImportPathMismatchErrorwould 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.0approxno longer raises
TypeErrorwhen 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.approxnow converts arguments tonumpy.ndarrayif they expose the array
protocol and are not scalars. This treats array-like objects like numpy arrays,
regardless of size.
6.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
--strictcommand-line option has been deprecated, use--strict-markersinstead.We have plans to maybe in the future to reintroduce
--strictand make it an encompassing flag for all strictness
related options (--strict-markersand--strict-configat the moment, more might be introduced in the future). -
#7988: The
@pytest.yield_fixturedecorator/function is now deprecated. Use pytest.fixture instead.yield_fixturehas been an alias forfixturefor 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
pyin 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 aswith MonkeyPatch.context() as mp: .... This is the recommended way to use
MonkeyPatchdirectly, since unlike themonkeypatchfixture, 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().stdoutand 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.FixtureRequestfor the request fixture.pytest.Cachefor the cache fixture.pytest.CaptureFixture[str]for the capfd and capsys fixtures.pytest.CaptureFixture[bytes]for the capfdbinary and capsysbinary fixtures.pytest.LogCaptureFixturefor the caplog fixture.pytest.Pytesterfor the pytester fixture.pytest.Testdirfor the testdir fixture.pytest.TempdirFactoryfor the tmpdir_factory fixture.pytest.TempPathFactoryfor the tmp_path_factory fixture.pytest.MonkeyPatchfor the monkeypatch fixture.pytest.WarningsRecorderfor 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-skipargument 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
--lfeven 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 classin the API reference. - #7872:
_pytest.config.argparsing.Parser.addini()accepts explicitNoneand"string". - #7878: In pull request section, ask to commit after editing changelog and authors file.
Trivial/Internal Changes
6.1.2
pytest 6.1.2 (2020-10-28)
Bug Fixes
- #7758: Fixed an issue where some files in packages are getting lost from
--lfeven 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().
6.1.1
pytest 6.1.1 (2020-10-03)
Bug Fixes
6.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
funcargnamesread-only property ofFixtureRequest,Metafunc, andFunctionclasses. Usefixturenamesattribute. @pytest.fixtureno longer supports positional arguments, pass all arguments by keyword instead.- Direct construction of
Nodesubclasses now raise an error, usefrom_parentinstead. - The default value for
junit_familyhas changed toxunit2. If you require the old format, addjunit_family=xunit1to your configuration file. - The
TerminalReporterno longer has awriterattribute. Plugin authors may use the public functions of theTerminalReporterinstead of accessing theTerminalWriterobject directly. - The
--result-logoption 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.collectmodule is deprecated: all its names can be imported frompytestdirectly. -
#7097: The
pytest._fillfuncargsfunction 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-kis deprecated. Use-k 'not expr'
instead.The special
-k 'expr:'syntax to-kis 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 ofFSCollectorandPackageare deprecated;
useself.session.gethookproxy()andself.session.isinitpath()instead.
This should work on all pytest versions.
Features
- #7667: New
--durations-mincommand-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_pluginsis 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 thefinaldesignation 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 rangewhen
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.pyinstead 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
junitxmlplugin 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-itertoolspackage 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.
6.0.2
pytest 6.0.2 (2020-09-04)
Bug Fixes
- #7148: Fixed
--log-clipotentially causing unrelatedprintoutput to be swallowed. - #7672: Fixed log-capturing level restored incorrectly if
caplog.set_levelis 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=linefor example).