All pytest classes now subclass object for better Python 2/3 compatibility.
This should not affect user code except in very rare edge cases. (2147 <https://github.com/pytest-dev/pytest/issues/2147>_)
Features
Introduce empty_parameter_set_mark ini option to select which mark to
apply when pytest.mark.parametrize is given an empty set of parameters.
Valid options are skip (default) and xfail. Note that it is planned
to change the default to xfail in future releases as this is considered
less error prone. (2527 <https://github.com/pytest-dev/pytest/issues/2527>_)
Incompatible change: after community feedback the logging <https://docs.pytest.org/en/latest/logging.html> functionality has
undergone some changes. Please consult the logging documentation <https://docs.pytest.org/en/latest/logging.htmlincompatible-changes-in-pytest-3-4>
for details. (3013 <https://github.com/pytest-dev/pytest/issues/3013>_)
Console output falls back to "classic" mode when capturing is disabled (-s),
otherwise the output gets garbled to the point of being useless. (3038 <https://github.com/pytest-dev/pytest/issues/3038>_)
New pytest_runtest_logfinish <https://docs.pytest.org/en/latest/writing_plugins.html_pytest.hookspec.pytest_runtest_logfinish>_
hook which is called when a test item has finished executing, analogous to
pytest_runtest_logstart <https://docs.pytest.org/en/latest/writing_plugins.html_pytest.hookspec.pytest_runtest_start>.
(3101 <https://github.com/pytest-dev/pytest/issues/3101>)
Improve performance when collecting tests using many fixtures. (3107 <https://github.com/pytest-dev/pytest/issues/3107>_)
New caplog.get_records(when) method which provides access to the captured
records for the "setup", "call" and "teardown"
testing stages. (3117 <https://github.com/pytest-dev/pytest/issues/3117>_)
New fixture record_xml_attribute that allows modifying and inserting
attributes on the <testcase> xml node in JUnit reports. (3130 <https://github.com/pytest-dev/pytest/issues/3130>_)
The default cache directory has been renamed from .cache to
.pytest_cache after community feedback that the name .cache did not
make it clear that it was used by pytest. (3138 <https://github.com/pytest-dev/pytest/issues/3138>_)
Colorize the levelname column in the live-log output. (3142 <https://github.com/pytest-dev/pytest/issues/3142>_)
Bug Fixes
Fix hanging pexpect test on MacOS by using flush() instead of wait().
(2022 <https://github.com/pytest-dev/pytest/issues/2022>_)
Fix restoring Python state after in-process pytest runs with the
pytester plugin; this may break tests using multiple inprocess
pytest runs if later ones depend on earlier ones leaking global interpreter
changes. (3016 <https://github.com/pytest-dev/pytest/issues/3016>_)
Fix skipping plugin reporting hook when test aborted before plugin setup
hook. (3074 <https://github.com/pytest-dev/pytest/issues/3074>_)
Fix progress percentage reported when tests fail during teardown. (3088 <https://github.com/pytest-dev/pytest/issues/3088>_)
Incompatible change: -o/--override option no longer eats all the
remaining options, which can lead to surprising behavior: for example,
pytest -o foo=1 /path/to/test.py would fail because /path/to/test.py
would be considered as part of the -o command-line argument. One
consequence of this is that now multiple configuration overrides need
multiple -o flags: pytest -o foo=1 -o bar=2. (3103 <https://github.com/pytest-dev/pytest/issues/3103>_)
Improved Documentation
Document hooks (defined with historic=True) which cannot be used with
hookwrapper=True. (2423 <https://github.com/pytest-dev/pytest/issues/2423>_)
Clarify that warning capturing doesn't change the warning filter by default.
(2457 <https://github.com/pytest-dev/pytest/issues/2457>_)
Clarify a possible confusion when using pytest_fixturesetup with fixture
functions that return None. (2698 <https://github.com/pytest-dev/pytest/issues/2698>)
Fix the wording of a sentence on doctest flags used in pytest. (3076 <https://github.com/pytest-dev/pytest/issues/3076>_)
Prefer https://*.readthedocs.io over http://*.rtfd.org for links in
the documentation. (3092 <https://github.com/pytest-dev/pytest/issues/3092>_)
Improve readability (wording, grammar) of Getting Started guide (3131 <https://github.com/pytest-dev/pytest/issues/3131>_)
Added note that calling pytest.main multiple times from the same process is
not recommended because of import caching. (3143 <https://github.com/pytest-dev/pytest/issues/3143>_)
Trivial/Internal Changes
Show a simple and easy error when keyword expressions trigger a syntax error
(for example, "-k foo and import" will show an error that you can not use
the import keyword in expressions). (2953 <https://github.com/pytest-dev/pytest/issues/2953>_)
Change parametrized automatic test id generation to use the __name__
attribute of functions instead of the fallback argument name plus counter.
(2976 <https://github.com/pytest-dev/pytest/issues/2976>_)
Replace py.std with stdlib imports. (3067 <https://github.com/pytest-dev/pytest/issues/3067>_)
Corrected 'you' to 'your' in logging docs. (3129 <https://github.com/pytest-dev/pytest/issues/3129>_)
3.3.2
=========================
Bug Fixes
pytester: ignore files used to obtain current user metadata in the fd leak
detector. (2784 <https://github.com/pytest-dev/pytest/issues/2784>_)
Fix memory leak where objects returned by fixtures were never destructed
by the garbage collector. (2981 <https://github.com/pytest-dev/pytest/issues/2981>_)
Fix conversion of pyargs to filename to not convert symlinks on Python 2. (2985 <https://github.com/pytest-dev/pytest/issues/2985>_)
PYTEST_DONT_REWRITE is now checked for plugins too rather than only for
test modules. (2995 <https://github.com/pytest-dev/pytest/issues/2995>_)
Improved Documentation
Add clarifying note about behavior of multiple parametrized arguments (3001 <https://github.com/pytest-dev/pytest/issues/3001>_)
Clean up code by replacing imports and references of _ast to ast. (3018 <https://github.com/pytest-dev/pytest/issues/3018>_)
3.3.1
=========================
Bug Fixes
Fix issue about -p no:<plugin> having no effect. (2920 <https://github.com/pytest-dev/pytest/issues/2920>_)
Fix regression with warnings that contained non-strings in their arguments in
Python 2. (2956 <https://github.com/pytest-dev/pytest/issues/2956>_)
Always escape null bytes when setting PYTEST_CURRENT_TEST. (2957 <https://github.com/pytest-dev/pytest/issues/2957>_)
Fix ZeroDivisionError when using the testmon plugin when no tests
were actually collected. (2971 <https://github.com/pytest-dev/pytest/issues/2971>_)
Bring back TerminalReporter.writer as an alias to
TerminalReporter._tw. This alias was removed by accident in the 3.3.0
release. (2984 <https://github.com/pytest-dev/pytest/issues/2984>_)
The pytest-capturelog plugin is now also blacklisted, avoiding errors when
running pytest with it still installed. (3004 <https://github.com/pytest-dev/pytest/issues/3004>_)
Improved Documentation
Fix broken link to plugin pytest-localserver. (2963 <https://github.com/pytest-dev/pytest/issues/2963>_)
Trivial/Internal Changes
Update github "bugs" link in CONTRIBUTING.rst (2949 <https://github.com/pytest-dev/pytest/issues/2949>_)
3.3.0
=========================
Deprecations and Removals
Pytest no longer supports Python 2.6 and 3.3. Those Python versions
are EOL for some time now and incur maintenance and compatibility costs on
the pytest core team, and following up with the rest of the community we
decided that they will no longer be supported starting on this version. Users
which still require those versions should pin pytest to <3.3. (2812 <https://github.com/pytest-dev/pytest/issues/2812>_)
Remove internal _preloadplugins() function. This removal is part of the
pytest_namespace() hook deprecation. (2636 <https://github.com/pytest-dev/pytest/issues/2636>_)
Internally change CallSpec2 to have a list of marks instead of a broken
mapping of keywords. This removes the keywords attribute of the internal
CallSpec2 class. (2672 <https://github.com/pytest-dev/pytest/issues/2672>_)
Remove ParameterSet.deprecated_argdict - its not a public api and the lack
of the underscore was a naming error. (2675 <https://github.com/pytest-dev/pytest/issues/2675>)
Remove the internal multi-typed attribute Node._evalskip and replace it
with the boolean Node._skipped_by_mark. (2767 <https://github.com/pytest-dev/pytest/issues/2767>_)
The params list passed to pytest.fixture is now for
all effects considered immutable and frozen at the moment of the pytest.fixture
call. Previously the list could be changed before the first invocation of the fixture
allowing for a form of dynamic parametrization (for example, updated from command-line options),
but this was an unwanted implementation detail which complicated the internals and prevented
some internal cleanup. See issue 2959 <https://github.com/pytest-dev/pytest/issues/2959>_
for details and a recommended workaround.
Features
pytest_fixture_post_finalizer hook can now receive a request
argument. (2124 <https://github.com/pytest-dev/pytest/issues/2124>_)
Replace the old introspection code in compat.py that determines the available
arguments of fixtures with inspect.signature on Python 3 and
funcsigs.signature on Python 2. This should respect __signature__
declarations on functions. (2267 <https://github.com/pytest-dev/pytest/issues/2267>_)
Report tests with global pytestmark variable only once. (2549 <https://github.com/pytest-dev/pytest/issues/2549>_)
Now pytest displays the total progress percentage while running tests. The
previous output style can be set by configuring the console_output_style
setting to classic. (2657 <https://github.com/pytest-dev/pytest/issues/2657>_)
Match warns signature to raises by adding match keyword. (2708 <https://github.com/pytest-dev/pytest/issues/2708>_)
Pytest now captures and displays output from the standard logging module.
The user can control the logging level to be captured by specifying options
in pytest.ini, the command line and also during individual tests using
markers. Also, a caplog fixture is available that enables users to test
the captured log during specific tests (similar to capsys for example).
For more information, please see the logging docs <https://docs.pytest.org/en/latest/logging.html>. This feature was
introduced by merging the popular pytest-catchlog <https://pypi.org/project/pytest-catchlog/> plugin, thanks to Thomas Hisch <https://github.com/thisch>. Be advised that during the merging the
backward compatibility interface with the defunct pytest-capturelog has
been dropped. (2794 <https://github.com/pytest-dev/pytest/issues/2794>)
Add allow_module_level kwarg to pytest.skip(), enabling to skip the
whole module. (2808 <https://github.com/pytest-dev/pytest/issues/2808>_)
Allow setting file_or_dir, -c, and -o in PYTESTADDOPTS. (2824 <https://github.com/pytest-dev/pytest/issues/2824>)
Return stdout/stderr capture results as a namedtuple, so out and
err can be accessed by attribute. (2879 <https://github.com/pytest-dev/pytest/issues/2879>_)
Add capfdbinary, a version of capfd which returns bytes from
readouterr(). (2923 <https://github.com/pytest-dev/pytest/issues/2923>_)
Add capsysbinary a version of capsys which returns bytes from
readouterr(). (2934 <https://github.com/pytest-dev/pytest/issues/2934>_)
Implement feature to skip setup.py files when run with
--doctest-modules. (502 <https://github.com/pytest-dev/pytest/issues/502>_)
Bug Fixes
Resume output capturing after capsys/capfd.disabled() context manager.
(1993 <https://github.com/pytest-dev/pytest/issues/1993>_)
pytest_fixture_setup and pytest_fixture_post_finalizer hooks are now
called for all conftest.py files. (2124 <https://github.com/pytest-dev/pytest/issues/2124>_)
If an exception happens while loading a plugin, pytest no longer hides the
original traceback. In Python 2 it will show the original traceback with a new
message that explains in which plugin. In Python 3 it will show 2 canonized
exceptions, the original exception while loading the plugin in addition to an
exception that pytest throws about loading a plugin. (2491 <https://github.com/pytest-dev/pytest/issues/2491>_)
capsys and capfd can now be used by other fixtures. (2709 <https://github.com/pytest-dev/pytest/issues/2709>_)
testdir now uses use the same method used by tmpdir to create its
temporary directory. This changes the final structure of the testdir
directory slightly, but should not affect usage in normal scenarios and
avoids a number of potential problems. (2751 <https://github.com/pytest-dev/pytest/issues/2751>_)
Pytest no longer complains about warnings with unicode messages being
non-ascii compatible even for ascii-compatible messages. As a result of this,
warnings with unicode messages are converted first to an ascii representation
for safety. (2809 <https://github.com/pytest-dev/pytest/issues/2809>_)
Change return value of pytest command when --maxfail is reached from
2 (interrupted) to 1 (failed). (2845 <https://github.com/pytest-dev/pytest/issues/2845>_)
Fix issue in assertion rewriting which could lead it to rewrite modules which
should not be rewritten. (2939 <https://github.com/pytest-dev/pytest/issues/2939>_)
Handle marks without description in pytest.ini. (2942 <https://github.com/pytest-dev/pytest/issues/2942>_)
Trivial/Internal Changes
pytest now depends on attrs <https://pypi.org/project/attrs/> for internal
structures to ease code maintainability. (2641 <https://github.com/pytest-dev/pytest/issues/2641>)
Refactored internal Python 2/3 compatibility code to use six. (2642 <https://github.com/pytest-dev/pytest/issues/2642>_)
Stop vendoring pluggy - we're missing out on its latest changes for not
much benefit (2719 <https://github.com/pytest-dev/pytest/issues/2719>_)
Internal refactor: simplify ascii string escaping by using the
backslashreplace error handler in newer Python 3 versions. (2734 <https://github.com/pytest-dev/pytest/issues/2734>_)
Remove unnecessary mark evaluator in unittest plugin (2767 <https://github.com/pytest-dev/pytest/issues/2767>_)
Calls to Metafunc.addcall now emit a deprecation warning. This function
is scheduled to be removed in pytest-4.0. (2876 <https://github.com/pytest-dev/pytest/issues/2876>_)
Internal move of the parameterset extraction to a more maintainable place.
(2877 <https://github.com/pytest-dev/pytest/issues/2877>_)
Internal refactoring to simplify scope node lookup. (2910 <https://github.com/pytest-dev/pytest/issues/2910>_)
Configure pytest to prevent pip from installing pytest in unsupported
Python versions. (2922 <https://github.com/pytest-dev/pytest/issues/2922>_)
3.2.5
=========================
Bug Fixes
Remove py<1.5 restriction from pytest as this can cause version
conflicts in some installations. (2926 <https://github.com/pytest-dev/pytest/issues/2926>_)
3.2.4
=========================
Bug Fixes
Fix the bug where running with --pyargs will result in items with
empty parent.nodeid if run from a different root directory. (2775 <https://github.com/pytest-dev/pytest/issues/2775>_)
Fix issue with pytest.parametrize if argnames was specified as keyword arguments.
(2819 <https://github.com/pytest-dev/pytest/issues/2819>_)
Strip whitespace from marker names when reading them from INI config. (2856 <https://github.com/pytest-dev/pytest/issues/2856>_)
Show full context of doctest source in the pytest output, if the line number of
failed example in the docstring is < 9. (2882 <https://github.com/pytest-dev/pytest/issues/2882>_)
Match fixture paths against actual path segments in order to avoid matching folders which share a prefix.
(2836 <https://github.com/pytest-dev/pytest/issues/2836>_)
Improved Documentation
Introduce a dedicated section about conftest.py. (1505 <https://github.com/pytest-dev/pytest/issues/1505>_)
Explicitly mention xpass in the documentation of xfail. (1997 <https://github.com/pytest-dev/pytest/issues/1997>_)
Append example for pytest.param in the example/parametrize document. (2658 <https://github.com/pytest-dev/pytest/issues/2658>_)
Clarify language of proposal for fixtures parameters (2893 <https://github.com/pytest-dev/pytest/issues/2893>_)
List python 3.6 in the documented supported versions in the getting started
document. (2903 <https://github.com/pytest-dev/pytest/issues/2903>_)
Clarify the documentation of available fixture scopes. (538 <https://github.com/pytest-dev/pytest/issues/538>_)
Add documentation about the python -m pytest invocation adding the
current directory to sys.path. (911 <https://github.com/pytest-dev/pytest/issues/911>_)
3.2.3
=========================
Bug Fixes
Fix crash in tab completion when no prefix is given. (2748 <https://github.com/pytest-dev/pytest/issues/2748>_)
The equality checking function (__eq__) of MarkDecorator returns
False if one object is not an instance of MarkDecorator. (2758 <https://github.com/pytest-dev/pytest/issues/2758>_)
When running pytest --fixtures-per-test: don't crash if an item has no
fixtureinfo attribute (e.g. doctests) (2788 <https://github.com/pytest-dev/pytest/issues/2788>)
Improved Documentation
In help text of -k option, add example of using not to not select
certain tests whose names match the provided expression. (1442 <https://github.com/pytest-dev/pytest/issues/1442>_)
Add note in parametrize.rst about calling metafunc.parametrize
multiple times. (1548 <https://github.com/pytest-dev/pytest/issues/1548>_)
Trivial/Internal Changes
Set xfail_strict=True in pytest's own test suite to catch expected
failures as soon as they start to pass. (2722 <https://github.com/pytest-dev/pytest/issues/2722>_)
Fix typo in example of passing a callable to markers (in example/markers.rst)
(2765 <https://github.com/pytest-dev/pytest/issues/2765>_)
3.2.2
=========================
Bug Fixes
Calling the deprecated request.getfuncargvalue() now shows the source of
the call. (2681 <https://github.com/pytest-dev/pytest/issues/2681>_)
Allow tests declared as staticmethod to use fixtures. (2699 <https://github.com/pytest-dev/pytest/issues/2699>_)
Fixed edge-case during collection: attributes which raised pytest.fail
when accessed would abort the entire collection. (2707 <https://github.com/pytest-dev/pytest/issues/2707>_)
Fix ReprFuncArgs with mixed unicode and UTF-8 args. (2731 <https://github.com/pytest-dev/pytest/issues/2731>_)
Improved Documentation
In examples on working with custom markers, add examples demonstrating the
usage of pytest.mark.MARKER_NAME.with_args in comparison with
pytest.mark.MARKER_NAME.__call__ (2604 <https://github.com/pytest-dev/pytest/issues/2604>_)
In one of the simple examples, use pytest_collection_modifyitems() to skip
tests based on a command-line option, allowing its sharing while preventing a
user error when acessing pytest.config before the argument parsing. (2653 <https://github.com/pytest-dev/pytest/issues/2653>_)
Trivial/Internal Changes
Fixed minor error in 'Good Practices/Manual Integration' code snippet.
(2691 <https://github.com/pytest-dev/pytest/issues/2691>_)
Fixed typo in goodpractices.rst. (2721 <https://github.com/pytest-dev/pytest/issues/2721>_)
Improve user guidance regarding --resultlog deprecation. (2739 <https://github.com/pytest-dev/pytest/issues/2739>_)
3.2.1
=========================
Bug Fixes
Fixed small terminal glitch when collecting a single test item. (2579 <https://github.com/pytest-dev/pytest/issues/2579>_)
Correctly consider / as the file separator to automatically mark plugin
files for rewrite on Windows. (2591 <https://github.com/pytest- dev/pytest/issues/2591>_)
Properly escape test names when setting PYTEST_CURRENT_TEST environment
variable. (2644 <https://github.com/pytest-dev/pytest/issues/2644>_)
Fix error on Windows and Python 3.6+ when sys.stdout has been replaced
with a stream-like object which does not implement the full io module
buffer protocol. In particular this affects pytest-xdist users on the
aforementioned platform. (2666 <https://github.com/pytest- dev/pytest/issues/2666>_)
Improved Documentation
Explicitly document which pytest features work with unittest. (2626 <https://github.com/pytest-dev/pytest/issues/2626>_)
3.2.0
=========================
Deprecations and Removals
pytest.approx no longer supports >, >=, < and <=
operators to avoid surprising/inconsistent behavior. See the approx docs <https://docs.pytest.org/en/latest/builtin.htmlpytest.approx> for more
information. (2003 <https://github.com/pytest-dev/pytest/issues/2003>)
All old-style specific behavior in current classes in the pytest's API is
considered deprecated at this point and will be removed in a future release.
This affects Python 2 users only and in rare situations. (2147 <https://github.com/pytest-dev/pytest/issues/2147>_)
A deprecation warning is now raised when using marks for parameters
in pytest.mark.parametrize. Use pytest.param to apply marks to
parameters instead. (2427 <https://github.com/pytest-dev/pytest/issues/2427>_)
Features
Add support for numpy arrays (and dicts) to approx. (1994 <https://github.com/pytest-dev/pytest/issues/1994>_)
Now test function objects have a pytestmark attribute containing a list
of marks applied directly to the test function, as opposed to marks inherited
from parent classes or modules. (2516 <https://github.com/pytest- dev/pytest/issues/2516>_)
Collection ignores local virtualenvs by default; --collect-in-virtualenv
overrides this behavior. (2518 <https://github.com/pytest- dev/pytest/issues/2518>_)
Allow class methods decorated as staticmethod to be candidates for
collection as a test function. (Only for Python 2.7 and above. Python 2.6
will still ignore static methods.) (2528 <https://github.com/pytest- dev/pytest/issues/2528>_)
Introduce mark.with_args in order to allow passing functions/classes as
sole argument to marks. (2540 <https://github.com/pytest- dev/pytest/issues/2540>_)
New cache_dir ini option: sets the directory where the contents of the
cache plugin are stored. Directory may be relative or absolute path: if relative path, then
directory is created relative to rootdir, otherwise it is used as is.
Additionally path may contain environment variables which are expanded during
runtime. (2543 <https://github.com/pytest-dev/pytest/issues/2543>_)
Introduce the PYTEST_CURRENT_TEST environment variable that is set with
the nodeid and stage (setup, call and teardown) of the test
being currently executed. See the documentation <https://docs.pytest.org/en/latest/example/simple.htmlpytest-current-test- environment-variable> for more info. (2583 <https://github.com/pytest- dev/pytest/issues/2583>)
Introduced pytest.mark.filterwarnings mark which allows overwriting the
warnings filter on a per test, class or module level. See the docs <https://docs.pytest.org/en/latest/warnings.htmlpytest-mark- filterwarnings> for more information. (2598 <https://github.com/pytest- dev/pytest/issues/2598>)
--last-failed now remembers forever when a test has failed and only
forgets it if it passes again. This makes it easy to fix a test suite by
selectively running files and fixing tests incrementally. (2621 <https://github.com/pytest-dev/pytest/issues/2621>_)
New pytest_report_collectionfinish hook which allows plugins to add
messages to the terminal reporting after collection has been finished
successfully. (2622 <https://github.com/pytest-dev/pytest/issues/2622>_)
Added support for PEP-415's <https://www.python.org/dev/peps/pep-0415/>_
Exception.__suppress_context__. Now if a raise exception from None is
caught by pytest, pytest will no longer chain the context in the test report.
The behavior now matches Python's traceback behavior. (2631 <https://github.com/pytest-dev/pytest/issues/2631>_)
Exceptions raised by pytest.fail, pytest.skip and pytest.xfail
now subclass BaseException, making them harder to be caught unintentionally
by normal code. (580 <https://github.com/pytest-dev/pytest/issues/580>_)
Bug Fixes
Set stdin to a closed PIPE in pytester.py.Testdir.popen() for
avoid unwanted interactive pdb (2023 <https://github.com/pytest- dev/pytest/issues/2023>_)
Add missing encoding attribute to sys.std* streams when using
capsys capture mode. (2375 <https://github.com/pytest- dev/pytest/issues/2375>_)
Fix terminal color changing to black on Windows if colorama is imported
in a conftest.py file. (2510 <https://github.com/pytest- dev/pytest/issues/2510>_)
Fix line number when reporting summary of skipped tests. (2548 <https://github.com/pytest-dev/pytest/issues/2548>_)
capture: ensure that EncodedFile.name is a string. (2555 <https://github.com/pytest-dev/pytest/issues/2555>_)
The options --fixtures and --fixtures-per-test will now keep
indentation within docstrings. (2574 <https://github.com/pytest- dev/pytest/issues/2574>_)
doctests line numbers are now reported correctly, fixing pytest-sugar122 <https://github.com/Frozenball/pytest-sugar/issues/122>. (2610 <https://github.com/pytest-dev/pytest/issues/2610>)
Fix non-determinism in order of fixture collection. Adds new dependency
(ordereddict) for Python 2.6. (920 <https://github.com/pytest- dev/pytest/issues/920>_)
Extend documentation for testing plugin code with the pytester plugin.
(971 <https://github.com/pytest-dev/pytest/issues/971>_)
Trivial/Internal Changes
Update help message for --strict to make it clear it only deals with
unregistered markers, not warnings. (2444 <https://github.com/pytest- dev/pytest/issues/2444>_)
Internal code move: move code for pytest.approx/pytest.raises to own files in
order to cut down the size of python.py (2489 <https://github.com/pytest- dev/pytest/issues/2489>_)
Renamed the utility function _pytest.compat._escape_strings to
_ascii_escaped to better communicate the function's purpose. (2533 <https://github.com/pytest-dev/pytest/issues/2533>_)
Improve error message for CollectError with skip/skipif. (2546 <https://github.com/pytest-dev/pytest/issues/2546>_)
Emit warning about yield tests being deprecated only once per generator.
(2562 <https://github.com/pytest-dev/pytest/issues/2562>_)
Ensure final collected line doesn't include artifacts of previous write.
(2571 <https://github.com/pytest-dev/pytest/issues/2571>_)
Fixed all flake8 errors and warnings. (2581 <https://github.com/pytest- dev/pytest/issues/2581>_)
Added fix-lint tox environment to run automatic pep8 fixes on the code.
(2582 <https://github.com/pytest-dev/pytest/issues/2582>_)
Turn warnings into errors in pytest's own test suite in order to catch
regressions due to deprecations more promptly. (2588 <https://github.com/pytest-dev/pytest/issues/2588>_)
Show multiple issue links in CHANGELOG entries. (2620 <https://github.com/pytest-dev/pytest/issues/2620>_)
3.1.3
=========================
Bug Fixes
Fix decode error in Python 2 for doctests in docstrings. (2434 <https://github.com/pytest-dev/pytest/issues/2434>_)
Exceptions raised during teardown by finalizers are now suppressed until all
finalizers are called, with the initial exception reraised. (2440 <https://github.com/pytest-dev/pytest/issues/2440>_)
Fix incorrect "collected items" report when specifying tests on the command-
line. (2464 <https://github.com/pytest-dev/pytest/issues/2464>_)
deprecated_call in context-manager form now captures deprecation warnings
even if the same warning has already been raised. Also, deprecated_call
will always produce the same error message (previously it would produce
different messages in context-manager vs. function-call mode). (2469 <https://github.com/pytest-dev/pytest/issues/2469>_)
Fix issue where paths collected by pytest could have triple leading /
characters. (2475 <https://github.com/pytest-dev/pytest/issues/2475>_)
Fix internal error when trying to detect the start of a recursive traceback.
(2486 <https://github.com/pytest-dev/pytest/issues/2486>_)
Improved Documentation
Explicitly state for which hooks the calls stop after the first non-None
result. (2493 <https://github.com/pytest-dev/pytest/issues/2493>_)
Trivial/Internal Changes
Create invoke tasks for updating the vendored packages. (2474 <https://github.com/pytest-dev/pytest/issues/2474>_)
Update copyright dates in LICENSE, README.rst and in the documentation.
(2499 <https://github.com/pytest-dev/pytest/issues/2499>_)
3.1.2
=========================
Bug Fixes
Required options added via pytest_addoption will no longer prevent using
--help without passing them. (1999)
Respect python_files in assertion rewriting. (2121)
Fix recursion error detection when frames in the traceback contain objects
that can't be compared (like numpy arrays). (2459)
UnicodeWarning is issued from the internal pytest warnings plugin only
when the message contains non-ascii unicode (Python 2 only). (2463)
Added a workaround for Python 3.6 WindowsConsoleIO breaking due to Pytests's
FDCapture. Other code using console handles might still be affected by the
very same issue and might require further workarounds/fixes, i.e. colorama.
(2467)
Improved Documentation
Fix internal API links to pluggy objects. (2331)
Make it clear that pytest.xfail stops test execution at the calling point
and improve overall flow of the skipping docs. (810)
3.1.1
=========================
Bug Fixes
pytest warning capture no longer overrides existing warning filters. The
previous behaviour would override all filters and caused regressions in test
suites which configure warning filters to match their needs. Note that as a
side-effect of this is that DeprecationWarning and
PendingDeprecationWarning are no longer shown by default. (2430)
Fix issue with non-ascii contents in doctest text files. (2434)
Fix encoding errors for unicode warnings in Python 2. (2436)
pytest.deprecated_call now captures PendingDeprecationWarning in
context manager form. (2441)
Improved Documentation
Addition of towncrier for changelog management. (2390)
3.1.0
==================
New Features
The pytest-warnings plugin has been integrated into the core and now pytest automatically
captures and displays warnings at the end of the test session.
.. warning::
This feature may disrupt test suites which apply and treat warnings themselves, and can be
disabled in your pytest.ini:
.. code-block:: ini
[pytest]
addopts = -p no:warnings
See the warnings documentation page <https://docs.pytest.org/en/latest/warnings.html>_ for more
information.
Thanks nicoddemus_ for the PR.
Added junit_suite_name ini option to specify root <testsuite> name for JUnit XML reports (533_).
Added an ini option doctest_encoding to specify which encoding to use for doctest files.
Thanks wheerd for the PR (2101).
pytest.warns now checks for subclass relationship rather than
class equality. Thanks lesteve for the PR (2166)
pytest.raises now asserts that the error message matches a text or regex
with the match keyword argument. Thanks Kriechi_ for the PR.
pytest.param can be used to declare test parameter sets with marks and test ids.
Thanks RonnyPfannschmidt_ for the PR.
Changes
remove all internal uses of pytestnamespace hooks,
this is to prepare the removal of preloadconfig in pytest 4.0
Thanks to RonnyPfannschmidt for the PR.
pytest now warns when a callable ids raises in a parametrized test. Thanks fogo_ for the PR.
It is now possible to skip test classes from being collected by setting a
__test__ attribute to False in the class body (2007). Thanks
to syre for the report and lwm_ for the PR.
Change junitxml.py to produce reports that comply with Junitxml schema.
If the same test fails with failure in call and then errors in teardown
we split testcase element into two, one containing the error and the other
the failure. (2228) Thanks to kkoukiou for the PR.
Testcase reports with a url attribute will now properly write this to junitxml.
Thanks fushi for the PR (1874).
Remove common items from dict comparision output when verbosity=1. Also update
the truncation message to make it clearer that pytest truncates all
assertion messages if verbosity < 2 (1512).
Thanks mattduck for the PR
--pdbcls no longer implies --pdb. This makes it possible to use
addopts=--pdbcls=module.SomeClass on pytest.ini. Thanks davidszotten for
the PR (1952).
fix 2013_: turn RecordedWarning into namedtuple,
to give it a comprehensible repr while preventing unwarranted modification.
fix 2208_: ensure a iteration limit for _pytest.compat.get_realfunc.
Thanks RonnyPfannschmidt for the report and PR.
Hooks are now verified after collection is complete, rather than right after loading installed plugins. This
makes it easy to write hooks for plugins which will be loaded during collection, for example using the
pytest_plugins special variable (1821).
Thanks nicoddemus for the PR.
Modify pytest_make_parametrize_id() hook to accept argname as an
additional parameter.
Thanks unsignedint_ for the PR.
Add venv to the default norecursedirs setting.
Thanks The-Compiler_ for the PR.
PluginManager.import_plugin now accepts unicode plugin names in Python 2.
Thanks reutsharabani_ for the PR.
fix 2308: When using both --lf and --ff, only the last failed tests are run.
Thanks ojii for the PR.
Replace minor/patch level version numbers in the documentation with placeholders.
This significantly reduces change-noise as different contributors regnerate
the documentation on different platforms.
Thanks RonnyPfannschmidt_ for the PR.
fix 2391_: consider pytestplugins on all plugin modules
Thanks RonnyPfannschmidt for the PR.
Bug Fixes
Fix AttributeError on sys.stdout.buffer / sys.stderr.buffer
while using capsys fixture in python 3. (1407).
Thanks to asottile.
Change capture.py's DontReadFromInput class to throw io.UnsupportedOperation errors rather
than ValueErrors in the fileno method (2276).
Thanks metasyn and vlad-dragos_ for the PR.
Fix exception formatting while importing modules when the exception message
contains non-ascii characters (2336).
Thanks fabioz for the report and nicoddemus_ for the PR.
Added documentation related to issue (1937)
Thanks skylarjhdownes for the PR.
Allow collecting files with any file extension as Python modules (2369).
Thanks Kodiologist for the PR.
Show the correct error message when collect "parametrize" func with wrong args (2383).
Thanks The-Compiler for the report and robin0371_ for the PR.
Fix issue in assertion rewriting breaking due to modules silently discarding
other modules when importing fails
Notably, importing the anydbm module is fixed. (2248).
Thanks pfhayes for the PR.
junitxml: Fix problematic case where system-out tag occured twice per testcase
element in the XML report. Thanks kkoukiou_ for the PR.
Fix regression, pytest now skips unittest correctly if run with --pdb
(2137). Thanks to gst for the report and mbyt_ for the PR.
Ignore exceptions raised from descriptors (e.g. properties) during Python test collection (2234).
Thanks to bluetech.
--override-ini now correctly overrides some fundamental options like python_files (2238).
Thanks sirex for the report and nicoddemus_ for the PR.
Replace raise StopIteration usages in the code by simple returns to finish generators, in accordance to PEP-479 (2160).
Thanks tgoodlet for the report and nicoddemus for the PR.
Fix internal errors when an unprintable AssertionError is raised inside a test.
Thanks omerhadari_ for the PR.
Skipping plugin now also works with test items generated by custom collectors (2231).
Thanks to vidartf.
Fix trailing whitespace in console output if no .ini file presented (2281). Thanks fbjorn for the PR.
Conditionless xfail markers no longer rely on the underlying test item
being an instance of PyobjMixin, and can therefore apply to tests not
collected by the built-in python test collector. Thanks barneygale_ for the
PR.
pytest no longer generates PendingDeprecationWarning from its own operations, which was introduced by mistake in version 3.0.5 (2118).
Thanks to nicoddemus for the report and RonnyPfannschmidt_ for the PR.
pytest no longer recognizes coroutine functions as yield tests (2129).
Thanks to malinoff for the PR.
Plugins loaded by the PYTEST_PLUGINS environment variable are now automatically
considered for assertion rewriting (2185).
Thanks nicoddemus for the PR.
Improve error message when pytest.warns fails (2150). The type(s) of the
expected warnings and the list of caught warnings is added to the
error message. Thanks lesteve for the PR.
Fix pytester internal plugin to work correctly with latest versions of
zope.interface (1989). Thanks nicoddemus for the PR.
Assert statements of the pytester plugin again benefit from assertion rewriting (1920).
Thanks RonnyPfannschmidt for the report and nicoddemus_ for the PR.
Specifying tests with colons like test_foo.py::test_bar for tests in
subdirectories with ini configuration files now uses the correct ini file
(2148). Thanks pelme.
Fail testdir.runpytest().assert_outcomes() explicitly if the pytest
terminal output it relies on is missing. Thanks to eli-b_ for the PR.
Add warning when not passing option=value correctly to -o/--override-ini (2105).
Also improved the help documentation. Thanks to mbukatov for the report and
lwm_ for the PR.
Now --confcutdir and --junit-xml are properly validated if they are directories
and filenames, respectively (2089 and 2078). Thanks to lwm_ for the PR.
Add hint to error message hinting possible missing __init__.py (478). Thanks DuncanBetts.
More accurately describe when fixture finalization occurs in documentation (687). Thanks DuncanBetts.
Provide :ref: targets for recwarn.rst so we can use intersphinx referencing.
Thanks to dupuy for the report and lwm for the PR.
In Python 2, use a simple +- ASCII string in the string representation of pytest.approx (for example "4 +- 4.0e-06")
because it is brittle to handle that in different contexts and representations internally in pytest
which can result in bugs such as 2111. In Python 3, the representation still uses ± (for example 4 ± 4.0e-06).
Thanks kerrick-lyft for the report and nicoddemus_ for the PR.
Using item.Function, item.Module, etc., is now issuing deprecation warnings, prefer
pytest.Function, pytest.Module, etc., instead (2034).
Thanks nmundar for the PR.
Fix error message using approx with complex numbers (2082).
Thanks adler-j for the report and nicoddemus_ for the PR.
Fixed false-positives warnings from assertion rewrite hook for modules imported more than
once by the pytest_plugins mechanism.
Thanks nicoddemus_ for the PR.
Remove an internal cache which could cause hooks from conftest.py files in
sub-directories to be called in other directories incorrectly (2016).
Thanks d-b-w for the report and nicoddemus_ for the PR.
Remove internal code meant to support earlier Python 3 versions that produced the side effect
of leaving None in sys.modules when expressions were evaluated by pytest (for example passing a condition
as a string to pytest.mark.skipif)(2103).
Thanks jaraco for the report and nicoddemus_ for the PR.
Cope gracefully with a .pyc file with no matching .py file (2038). Thanks
nedbat.
Import errors when collecting test modules now display the full traceback (1976).
Thanks cwitty for the report and nicoddemus_ for the PR.
Fix confusing command-line help message for custom options with two or more metavar properties (2004).
Thanks okulynyak and davehunt for the report and nicoddemus for the PR.
When loading plugins, import errors which contain non-ascii messages are now properly handled in Python 2 (1998).
Thanks nicoddemus for the PR.
Fixed cyclic reference when pytest.raises is used in context-manager form (1965_). Also as a
result of this fix, sys.exc_info() is left empty in both context-manager and function call usages.
Previously, sys.exc_info would contain the exception caught by the context manager,
even when the expected exception occurred.
Thanks MSeifert04_ for the report and the PR.
Fixed false-positives warnings from assertion rewrite hook for modules that were rewritten but
were later marked explicitly by pytest.register_assert_rewrite
or implicitly as a plugin (2005).
Thanks RonnyPfannschmidt for the report and nicoddemus_ for the PR.
Report teardown output on test failure (442).
Thanks matclab for the PR.
Fix teardown error message in generated xUnit XML.
Thanks gdyuldin_ for the PR.
Properly handle exceptions in multiprocessing tasks (1984).
Thanks adborden for the report and nicoddemus_ for the PR.
Clean up unittest TestCase objects after tests are complete (1649_).
Thanks d_b_w_ for the report and PR.
Improve error message when passing non-string ids to pytest.mark.parametrize (1857).
Thanks okken for the report and nicoddemus_ for the PR.
Add buffer attribute to stdin stub class pytest.capture.DontReadFromInput
Thanks joguSD_ for the PR.
Fix UnicodeEncodeError when string comparison with unicode has failed. (1864)
Thanks AiOO for the PR.
pytest_plugins is now handled correctly if defined as a string (as opposed as
a sequence of strings) when modules are considered for assertion rewriting.
Due to this bug, much more modules were being rewritten than necessary
if a test suite uses pytest_plugins to load internal plugins (1888).
Thanks jaraco for the report and nicoddemus for the PR (1891).
Do not call tearDown and cleanups when running tests from
unittest.TestCase subclasses with --pdb
enabled. This allows proper post mortem debugging for all applications
which have significant logic in their tearDown machinery (1890). Thanks
mbyt for the PR.
Fix use of deprecated getfuncargvalue method in the internal doctest plugin.
Thanks ViviCoder for the report (1898).
Fix regression when importorskip is used at module level (1822).
Thanks jaraco and The-Compiler for the report and nicoddemus for the PR.
Fix parametrization scope when session fixtures are used in conjunction
with normal parameters in the same call (1832).
Thanks The-Compiler for the report, Kingdread and nicoddemus for the PR.
Fix internal error when parametrizing tests or fixtures using an empty ids argument (1849).
Thanks OPpuolitaival for the report and nicoddemus_ for the PR.
Fix loader error when running pytest embedded in a zipfile.
Thanks mbachry_ for the PR.
A number of incompatible changes were made in this release, with the intent of removing features deprecated for a long
time or change existing behaviors in order to make them less surprising/more useful.
Reinterpretation mode has now been removed. Only plain and rewrite
mode are available, consequently the --assert=reinterp option is
no longer available. This also means files imported from plugins or
conftest.py will not benefit from improved assertions by
default, you should use pytest.register_assert_rewrite() to
explicitly turn on assertion rewriting for those files. Thanks
flub_ for the PR.
The following deprecated commandline options were removed:
--genscript: no longer supported;
--no-assert: use --assert=plain instead;
--nomagic: use --assert=plain instead;
--report: use -r instead;
Thanks to RedBeardCode for the PR (1664).
ImportErrors in plugins now are a fatal error instead of issuing a
pytest warning (1479). Thanks to The-Compiler for the PR.
Removed support code for Python 3 versions < 3.3 (1627_).
Removed all py.test-X* entry points. The versioned, suffixed entry points
were never documented and a leftover from a pre-virtualenv era. These entry
points also created broken entry points in wheels, so removing them also
removes a source of confusion for users (1632).
Thanks obestwalter for the PR.
pytest.skip() now raises an error when used to decorate a test function,
as opposed to its original intent (to imperatively skip a test inside a test function). Previously
this usage would cause the entire module to be skipped (607).
Thanks omarkohl for the complete PR (1519_).
Exit tests if a collection error occurs. A poll indicated most users will hit CTRL-C
anyway as soon as they see collection errors, so pytest might as well make that the default behavior (1421).
A --continue-on-collection-errors option has been added to restore the previous behaviour.
Thanks olegpidsadnyi and omarkohl for the complete PR (1628).
Renamed the pytest pdb module (plugin) into debugging to avoid clashes with the builtin pdb module.
Raise a helpful failure message when requesting a parametrized fixture at runtime,
e.g. with request.getfixturevalue. Previously these parameters were simply
never defined, so a fixture decorated like pytest.fixture(params=[0, 1, 2])
only ran once (460).
Thanks to nikratio for the bug report, RedBeardCode and tomviner for the PR.
_pytest.monkeypatch.monkeypatch class has been renamed to _pytest.monkeypatch.MonkeyPatch
so it doesn't conflict with the monkeypatch fixture.
--exitfirst / -x can now be overridden by a following --maxfail=N
and is just a synonym for --maxfail=1.
New Features
Support nose-style __test__ attribute on methods of classes,
including unittest-style Classes. If set to False, the test will not be
collected.
New doctest_namespace fixture for injecting names into the
namespace in which doctests run.
Thanks milliams for the complete PR (1428).
New --doctest-report option available to change the output format of diffs
when running (failing) doctests (implements 1749).
Thanks hartym for the PR.
New name argument to pytest.fixture decorator which allows a custom name
for a fixture (to solve the funcarg-shadowing-fixture problem).
Thanks novas0x2a for the complete PR (1444).
New approx() function for easily comparing floating-point numbers in
tests.
Thanks kalekundert for the complete PR (1441).
Ability to add global properties in the final xunit output file by accessing
the internal junitxml plugin (experimental).
Thanks tareqalayan for the complete PR 1454).
New ExceptionInfo.match() method to match a regular expression on the
string representation of an exception (372).
Thanks omarkohl for the complete PR (1502_).
__tracebackhide__ can now also be set to a callable which then can decide
whether to filter the traceback based on the ExceptionInfo object passed
to it. Thanks The-Compiler for the complete PR (1526).
New pytest_make_parametrize_id(config, val) hook which can be used by plugins to provide
friendly strings for custom types.
Thanks palaviv_ for the PR.
capsys and capfd now have a disabled() context-manager method, which
can be used to temporarily disable capture within a test.
Thanks nicoddemus_ for the PR.
New cli flag --fixtures-per-test: shows which fixtures are being used
for each selected test item. Features doc strings of fixtures by default.
Can also show where fixtures are defined if combined with -v.
Thanks hackebrot_ for the PR.
Introduce pytest command as recommended entry point. Note that py.test
still works and is not scheduled for removal. Closes proposal
1629. Thanks obestwalter and davehunt for the complete PR
(1633).
New cli flags:
--setup-plan: performs normal collection and reports
the potential setup and teardown and does not execute any fixtures and tests;
--setup-only: performs normal collection, executes setup and teardown of
fixtures and reports them;
--setup-show: performs normal test execution and additionally shows
setup and teardown of fixtures;
--keep-duplicates: py.test now ignores duplicated paths given in the command
line. To retain the previous behavior where the same test could be run multiple
times by specifying it in the command-line multiple times, pass the --keep-duplicates
argument (1609_);
Thanks d6e, kvas-it, sallner, ioggstream and omarkohl_ for the PRs.
New CLI flag --override-ini/-o: overrides values from the ini file.
For example: "-o xfail_strict=True"'.
Thanks blueyed and fengxx for the PR.
pytest_fixture_post_finalizer(fixturedef): called after the fixture's
finalizer and has access to the fixture's result cache.
Thanks d6e, sallner.
Issue warnings for asserts whose test is a tuple literal. Such asserts will
never fail because tuples are always truthy and are usually a mistake
(see 1562). Thanks kvas-it, for the PR.
Allow passing a custom debugger class (e.g. --pdbcls=IPython.core.debugger:Pdb).
Thanks to anntzer_ for the PR.
Changes
Plugins now benefit from assertion rewriting. Thanks
sober7, nicoddemus and flub_ for the PR.
Change report.outcome for xpassed tests to "passed" in non-strict
mode and "failed" in strict mode. Thanks to hackebrot for the PR
(1795) and gprasad84 for report (1546).
Tests marked with xfail(strict=False) (the default) now appear in
JUnitXML reports as passing tests instead of skipped.
Thanks to hackebrot for the PR (1795).
Highlight path of the file location in the error report to make it easier to copy/paste.
Thanks suzaku for the PR (1778).
Fixtures marked with pytest.fixture can now use yield statements exactly like
those marked with the pytest.yield_fixture decorator. This change renders
pytest.yield_fixture deprecated and makes pytest.fixture with yield statements
the preferred way to write teardown code (1461).
Thanks csaftoiu for bringing this to attention and nicoddemus_ for the PR.
Explicitly passed parametrize ids do not get escaped to ascii (1351).
Thanks ceridwen for the PR.
Fixtures are now sorted in the error message displayed when an unknown
fixture is declared in a test function.
Thanks nicoddemus_ for the PR.
pytest_terminal_summary hook now receives the exitstatus
of the test session as argument. Thanks blueyed for the PR (1809).
Parametrize ids can accept None as specific test id, in which case the
automatically generated id for that argument will be used.
Thanks palaviv_ for the complete PR (1468
pytest is not pinned to a specific version.
I'm pinning it to the latest version 3.4.0 for now.
These links might come in handy: PyPI | Changelog | Repo | Homepage
Changelog