--lf even though they contain tests that failed. Regressed in pytest 5.4.0.pytest._fillfuncargs().β
#5585: As per our policy, the following features which have been deprecated in the 5.X series are now
β removed:
funcargnames read-only property of FixtureRequest, Metafunc, and Function classes. Use fixturenames attribute.@pytest.fixture no longer supports positional arguments, pass all arguments by keyword instead.Node subclasses now raise an error, use from_parent instead.junit_family has changed to xunit2. If you require the old format, add junit_family=xunit1 to your configuration file.TerminalReporter no longer has a writer attribute. Plugin authors may use the public functions of the TerminalReporter instead of accessing the TerminalWriter object directly.--result-log option has been removed. Users are recommended to use the pytest-reportlog plugin instead.For more information consult
β
Deprecations and Removals in the docs.
β
#6981: The pytest.collect module is deprecated: all its names can be imported from pytest directly.
β
#7097: The pytest._fillfuncargs function 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 -k is deprecated. Use -k 'not expr'
instead.
π The special -k 'expr:' syntax to -k is 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() and isinitpath() methods of FSCollector and Package are deprecated;
π use self.session.gethookproxy() and self.session.isinitpath() instead.
β
This should work on all pytest versions.
--durations-min command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by --durations. Previously this was hard-coded to 0.005s.β
#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_plugins is 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 the final designation does not appear in the API Reference but hopefully will in the future.
β #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 range when
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.py instead of c:\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.
junitxml plugin has rewritten to use xml.etree.ElementTree.more-itertools package has been removed.__class__,__delattr__ and __new__) without consulting the python_classes and--log-cli potentially causing unrelated print output to be swallowed.caplog.set_level is called more than once.--tb=line for example).help value to Parser.add_option is now accepted instead of crashing when running pytest --help.None raises a more informative TypeError.not-callable lint on pytest.mark.parametrize() and the other builtin marks:skip, skipif, xfail, usefixtures, filterwarnings.TestReport.longreprtext (such as pytest-html) when TestReport.longrepr is not a string.caplog.set_level().π ( Please see the full set of changes for this release also in the 6.0.0rc1 notes below )
β #5584: PytestDeprecationWarning are now errors by default.
π Following our plan to remove deprecated features with as little disruption as
β
possible, all warnings of type PytestDeprecationWarning now generate errors
β instead of warning messages.
π The affected features will be effectively removed in pytest 6.1 , so please consult the
β
Deprecations and Removals
β‘οΈ section in the docs for directions on how to update existing code.
β
In the pytest 6.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.PytestDeprecationWarning
π But this will stop working when pytest 6.1 is released.
If you have concerns about the removal of a specific feature, please add a
β
comment to #5584.
#7472: The exec_() and is_true() methods of _pytest._code.Frame have been removed.
--log-file CLI option and log_file ini marker now create subdirectories if needed.match equals the obtained string but is not a regex match. In this case it is suggested to escape the regex.@pytest.mark.skip when --runxfail is used.capfd.TracebackEntry. __str__ which was changed by accident.usefixtures mark can apply fixtures to test.-q option used in getting started guide.package is no longer considered experimental.β
#1316: TestReport.longrepr is now always an instance of ReprExceptionInfo. Previously it was a str when a test failed with pytest.fail(..., pytrace=False).
β #5965: symlinks are no longer resolved during collection and matching conftest.py files with test file paths.
π Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms.
π The team decided to step back on resolving symlinks at all, planning to review this in the future with a more solid solution (see discussion in
β
#6523 for details).
β
This might break test suites which made use of this feature; the fix is to create a symlink
β
for the entire test tree, and not only to partial files/tress as it was possible previously.
β
#6505: Testdir.run().parseoutcomes() now always returns the parsed nouns in plural form.
π Originally parseoutcomes() would always returns the nouns in plural form, but a change
β meant to improve the terminal summary by using singular form single items (1 warning or 1 error)
π caused an unintended regression by changing the keys returned by parseoutcomes().
Now the API guarantees to always return the plural form, so calls like this:
result = testdir.runpytest()
result.assert_outcomes(error=1)
Need to be changed to:
result = testdir.runpytest()
result.assert_outcomes(errors=1)
β
#6903: The os.dup() function is now assumed to exist. We are not aware of any
π supported Python 3 implementations which do not provide it.
β
#7040: -k no longer matches against the names of the directories outside the test session root.
π¦ Also, pytest.Package.name is now just the name of the directory containing the package's
__init__.py file, instead of the full path. This is consistent with how the other nodes
are named, and also one of the reasons why -k would match against any directory containing
β
the test suite.
β
#7122: Expressions given to the -m and -k options are no longer evaluated using Python's eval.
π The format supports or, and, not, parenthesis and general identifiers to match against.
Python constants, keywords or other operators are no longer evaluated differently.
β
#7135: Pytest now uses its own TerminalWriter class instead of using the one from the py library.
π Plugins generally access this class through TerminalReporter.writer, TerminalReporter.write()
β
(and similar methods), or _pytest.config.create_terminal_writer().
The following breaking changes were made:
write() method and others) no longer flush implicitly; the flushing behaviorwrite(flush=True) orterminal_writer.flush().bytes was removed.reline method and chars_on_current_line property were removed.stringio and encoding arguments was removed.π² #7224: The item.catch_log_handler and item.catch_log_handlers attributes, set by the
π logging plugin and never meant to be public , are no longer available.
π The deprecated --no-print-logs option is removed. Use --show-capture instead.
#7226: Removed the unused args parameter from pytest.Function. __init__.
β
#7418: Removed the pytest_doctest_prepare_content hook specification. This hook
β
hasn't been triggered by pytest for at least 10 years.
β
#7438: Some changes were made to the internal _pytest._code.source, listed here
π for the benefit of plugin authors who may be using it:
deindent argument to Source() has been removed, now it is always true.Source() has been removed.Source with an str has been removed.Source.isparseable() and Source.putaround() have been removed.Source.compile() and function _pytest._code.compile() havecompile() instead._pytest._code.source.getsource() has been removed; useSource() directly instead.β
#7210: The special -k '-expr' syntax to -k is deprecated. Use -k 'not expr'
instead.
π The special -k 'expr:' syntax to -k is deprecated. Please open an issue
if you use this and want a replacement.
β #4049: pytest_warning_captured is deprecated in favor of the pytest_warning_recorded hook.
π§ #1556: pytest now supports pyproject.toml files for configuration.
π§ The configuration options is similar to the one available in other formats, but must be defined
β
in a [tool.pytest.ini_options] table to be picked up by pytest:
# pyproject.toml
[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = [
"tests",
"integration",
]
π§ More information can be found in the docs.
β
#3342: pytest now includes inline type annotations and exposes them to user programs.
Most of the user-facing API is covered, as well as internal code.
β
If you are running a type checker such as mypy on your tests, you may start
noticing type errors indicating incorrect usage. If you run into an error that
you believe to be incorrect, please let us know in an issue.
The types were developed against mypy version 0.780. Versions before 0.750
β
are known not to work. We recommend using the latest version. Other type
checkers may work as well, but they are not officially verified to work by
β
pytest yet.
β #4049: Introduced a new hook named pytest_warning_recorded to convey information about warnings captured by the internal pytest warnings plugin.
β This hook is meant to replace pytest_warning_captured, which is deprecated and will be removed in a future release.
β #6471: New command-line flags:
--no-header: disables the initial header, including platform, version, and plugins.--no-summary: disables the final test summary, including warnings.β #6856: A warning is now shown when an unknown key is read from a config INI file.
β The --strict-config flag has been added to treat these warnings as errors.
β #6906: Added --code-highlight command line option to enable/disable code highlighting in terminal output.
β
#7245: New --import-mode=importlib option that uses importlib to import test modules.
Traditionally pytest used __import__ while changing sys.path to import test modules (which
β
also changes sys.modules as a side-effect), which works but has a number of drawbacks, like requiring test modules
π¦ that don't live in packages to have unique names (as they need to reside under a unique name in sys.modules).
--import-mode=importlib uses more fine grained import mechanisms from importlib which don't
β
require pytest to change sys.path or sys.modules at all, eliminating much of the drawbacks
of the previous mode.
0οΈβ£ We intend to make --import-mode=importlib the default in future versions, so users are encouraged
β
to try the new mode and provide feedback (both positive or negative) in issue #7245.
π You can read more about this option in the documentation.
π§ #7305: New required_plugins configuration option allows the user to specify a list of plugins, including version information, that are required for pytest to run. An error is raised if any required plugins are not found when running pytest.
β
#4375: The pytest command now suppresses the BrokenPipeError error message that
β
is printed to stderr when the output of pytest is piped and and the pipe is
closed by the piped-to program (common examples are less and head).
β
#4391: Improved precision of test durations measurement. CallInfo items now have a new <CallInfo>.duration attribute, created using time.perf_counter(). This attribute is used to fill the <TestReport>.duration attribute, which is more accurate than the previous <CallInfo>.stop - <CallInfo>.start (as these are based on time.time()).
β #4675: Rich comparison for dataclasses and attrs-classes is now recursive.
β
#6285: Exposed the pytest.FixtureLookupError exception which is raised by request.getfixturevalue()
(where request is a FixtureRequest fixture) when a fixture with the given name cannot be returned.
β
#6433: If an error is encountered while formatting the message in a logging call, for
β example logging.warning("oh no!: %s: %s", "first") (a second argument is
β
missing), pytest now propagates the error, likely causing the test to fail.
π¨ Previously, such a mistake would cause an error to be printed to stderr, which
β
is not displayed by default for passing tests. This change makes the mistake
β
visible during testing.
You may supress this behavior temporarily or permanently by setting
π logging.raiseExceptions = False.
β
#6817: Explicit new-lines in help texts of command-line options are preserved, allowing plugins better control
of the help displayed to users.
β
#6940: When using the --duration option, the terminal message output is now more precise about the number and duration of hidden items.
β
#6991: Collected files are displayed after any reports from hooks, e.g. the status from --lf.
β
#7091: When fd capturing is used, through --capture=fd or the capfd and
capfdbinary fixtures, and the file descriptor (0, 1, 2) cannot be
duplicated, FD capturing is still performed. Previously, direct writes to the
file descriptors would fail or be lost in this case.
β
#7119: Exit with an error if the --basetemp argument is empty, is the current working directory or is one of the parent directories.
This is done to protect against accidental data loss, as any directory passed to this argument is cleared.
β #7128: pytest --version now displays just the pytest version, while pytest --version --version displays more verbose information including plugins. This is more consistent with how other tools show --version.
#7133: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> will now override any log_level set via the CLI or configuration file.
#7159: caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level> and caplog.at_level() <_pytest.logging.LogCaptureFixture.at_level> no longer affect
π² the level of logs that are shown in the Captured log report report section.
β #7348: Improve recursive diff report for comparison asserts on dataclasses / attrs.
β
#7385: --junitxml now includes the exception cause in the message XML attribute for failures during setup and teardown.
Previously:
<error message="test setup failure">
Now:
<error message="failed on setup with "ValueError: Some error during setup"">
π #1120: Fix issue where directories from tmpdir are not removed properly when multiple instances of pytest are running in parallel.
β #4583: Prevent crashing and provide a user-friendly error when a marker expression (-m) invoking of eval raises any exception.
β #4677: The path shown in the summary report for SKIPPED tests is now always relative. Previously it was sometimes absolute.
π #5456: Fix a possible race condition when trying to remove lock files used to control access to folders
created by tmp_path and tmpdir.
β
#6240: Fixes an issue where logging during collection step caused duplication of log
messages to stderr.
β
#6428: Paths appearing in error messages are now correct in case the current working directory has
π changed since the start of the session.
π #6755: Support deleting paths longer than 260 characters on windows created inside tmpdir.
β #6871: Fix crash with captured output when using capsysbinary.
βͺ #6909: Revert the change introduced by #6330, which required all arguments to @pytest.mark.parametrize to be explicitly defined in the function signature.
βͺ The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.
β
#6910: Fix crash when plugins return an unknown stats while using the --reportlog option.
β
#6924: Ensure a unittest.IsolatedAsyncioTestCase is actually awaited.
β #6925: Fix TerminalRepr instances to be hashable again.
β #6947: Fix regression where functions registered with unittest.TestCase.addCleanup were not being called on test failures.
β
#6951: Allow users to still set the deprecated TerminalReporter.writer attribute.
β #6956: Prevent pytest from printing ConftestImportFailure traceback to stdout.
β #6991: Fix regressions with --lf filtering too much since pytest 5.4.
βͺ #6992: Revert "tmpdir: clean up indirection via config for factories" #6767 as it breaks pytest-xdist.
β #7061: When a yielding fixture fails to yield a value, report a test setup error instead of crashing.
β
#7076: The path of file skipped by @pytest.mark.skip in the SKIPPED report is now relative to invocation directory. Previously it was relative to root directory.
β
#7110: Fixed regression: asyncbase.TestCase tests are executed correctly again.
β
#7126: --setup-show now doesn't raise an error when a bytes value is used as a parametrize
parameter when Python is called with the -bb flag.
β #7143: Fix pytest.File.from_parent so it forwards extra keyword arguments to the constructor.
#7145: Classes with broken __getattribute__ methods are displayed correctly during failures.
β
#7150: Prevent hiding the underlying exception when ConfTestImportFailure is raised.
#7180: Fix _is_setup_py for files encoded differently than locale.
β
#7215: Fix regression where running with --pdb would call unittest.TestCase.tearDown for skipped tests.
β
#7253: When using pytest.fixture on a function directly, as in pytest.fixture(func),
if the autouse or params arguments are also passed, the function is no longer
ignored, but is marked as a fixture.
β
#7360: Fix possibly incorrect evaluation of string expressions passed to pytest.mark.skipif and pytest.mark.xfail,
in rare circumstances where the exact same string is used but refers to different global values.
π» #7383: Fixed exception causes all over the codebase, i.e. use raise new_exception from old_exception when wrapping an exception.
--strict and --strict-markers and the preference for the latter one.originalname attribute of _pytest.python.Function now defaults to name if notwcwidth package has been removed.py.iniconfig with iniconfig.src/_pytest/config/ __init__.py now uses the warnings module to report warnings instead of sys.stderr.write.pytest-xdist.py>=1.8.2 is now required.ConfTestImportFailure is raised.--pdb would call the tearDown methods of unittest.TestCaseunittest.IsolatedAsyncioTestCase is actually awaited.TestCase.addCleanup were not being called on test failures.TerminalReporter.writer attribute.asyncbase.TestCase tests are executed correctly again.File.from_constructor so it forwards extra keyword arguments to the constructor.__getattribute__ methods are displayed correctly during failures._is_setup_py for files encoded differently than locale.