pytest

Bug Fixes

Invoke pytest using -mpytest so sys.path does not get polluted by packages installed in site-packages . ( #742 )

Improved Documentation

Use smtp_connection instead of smtp in fixtures documentation to avoid possible confusion. ( #3592 )

Trivial/Internal Changes

Remove obsolete future imports. ( #2319 )

Add CITATION to provide information on how to formally cite pytest. ( #3402 )

Replace broken type annotations with type comments. ( #3635 )

Pin pluggy to <0.8 . ( #3727 )

Bug Fixes

Fix ImportWarning triggered by explicit relative imports in assertion-rewritten package modules. ( #3061 )

Fix error in pytest.approx when dealing with 0-dimension numpy arrays. ( #3593 )

No longer raise ValueError when using the get_marker API. ( #3605 )

Fix problem where log messages with non-ascii characters would not appear in the output log file. ( #3630 )

No longer raise AttributeError when legacy marks can’t be stored in functions. ( #3631 )

Improved Documentation

The description above the example for @pytest.mark.skipif now better matches the code. ( #3611 )

Trivial/Internal Changes

Internal refactoring: removed unused CallSpec2tox ._globalid_args attribute and metafunc parameter from CallSpec2.copy() . ( #3598 )

Silence usage of reduce warning in Python 2 ( #3609 )

Fix usage of attr.ib deprecated convert parameter. ( #3653 )

Bug Fixes

Fix regression in Node.add_marker by extracting the mark object of a MarkDecorator . ( #3555 )

Warnings without location were reported as None . This is corrected to now report <undetermined location> . ( #3563 )

Continue to call finalizers in the stack when a finalizer in a former scope raises an exception. ( #3569 )

Fix encoding error with print statements in doctests ( #3583 )

Improved Documentation

Add documentation for the --strict flag. ( #3549 )

Trivial/Internal Changes

Update old quotation style to parens in fixture.rst documentation. ( #3525 )

Improve display of hint about --fulltrace with KeyboardInterrupt . ( #3545 )

pytest’s testsuite is no longer runnable through python setup.py test – instead invoke pytest or tox directly. ( #3552 )

Fix typo in documentation ( #3567 )

Bug Fixes

Fixed a bug where stdout and stderr were logged twice by junitxml when a test was marked xfail. ( #3491 )

Fix usefixtures mark applied to unittest tests by correctly instantiating FixtureInfo . ( #3498 )

Fix assertion rewriter compatibility with libraries that monkey patch file objects. ( #3503 )

Improved Documentation

Added a section on how to use fixtures as factories to the fixture documentation. ( #3461 )

Trivial/Internal Changes

Enable caching for pip/pre-commit in order to reduce build time on travis/appveyor. ( #3502 )

Switch pytest to the src/ layout as we already suggested it for good practice

• now we implement it as well. ( #3513 )

Fix if in tests to support 3.7.0b5, where a docstring handling in AST got reverted. ( #3530 )

Remove some python2.5 compatibility code. ( #3529 )

Features

Revamp the internals of the pytest.mark implementation with correct per node handling which fixes a number of long standing bugs caused by the old design. This introduces new Node.iter_markers(name) and Node.get_closest_marker(name) APIs. Users are strongly encouraged to read the reasons for the revamp in the docs , or jump over to details about updating existing code to use the new APIs . ( #3317 )

Now when @pytest.fixture is applied more than once to the same function a ValueError is raised. This buggy behavior would cause surprising problems and if was working for a test suite it was mostly by accident. ( #2334 )

Support for Python 3.7’s builtin breakpoint() method, see Using the builtin breakpoint function for details. ( #3180 )

monkeypatch now supports a context() function which acts as a context manager which undoes all patching done within the with block. ( #3290 )

The --pdb option now causes KeyboardInterrupt to enter the debugger, instead of stopping the test session. On python 2.7, hitting CTRL+C again exits the debugger. On python 3.2 and higher, use CTRL+D. ( #3299 )

pytest no longer changes the log level of the root logger when the log-level parameter has greater numeric value than that of the level of the root logger, which makes it play better with custom logging configuration in user code. ( #3307 )

Bug Fixes

A rare race-condition which might result in corrupted .pyc files on Windows has been hopefully solved. ( #3008 )

Also use iter_marker for discovering the marks applying for marker expressions from the cli to avoid the bad data from the legacy mark storage. ( #3441 )

When showing diffs of failed assertions where the contents contain only whitespace, escape them using repr() first to make it easy to spot the differences. ( #3443 )

Improved Documentation

Change documentation copyright year to a range which auto-updates itself each time it is published. ( #3303 )

Trivial/Internal Changes

pytest now depends on the python-atomicwrites library. ( #3008 )

Update all pypi.python.org URLs to pypi.org. ( #3431 )

Detect pytest_ prefixed hooks using the internal plugin manager since pluggy is deprecating the implprefix argument to PluginManager . ( #3487 )

Import Mapping and Sequence from _pytest.compat instead of directly from collections in python_api.py::approx . Add Mapping to _pytest.compat , import it from collections on python 2, but from collections.abc on Python 3 to avoid a DeprecationWarning on Python 3.7 or newer. ( #3497 )

Bug Fixes

Reset sys.last_type , sys.last_value and sys.last_traceback before each test executes. Those attributes are added by pytest during the test run to aid debugging, but were never reset so they would create a leaking reference to the last failing test’s frame which in turn could never be reclaimed by the garbage collector. ( #2798 )

pytest.raises now raises TypeError when receiving an unknown keyword argument. ( #3348 )

pytest.raises now works with exception classes that look like iterables. ( #3372 )

Improved Documentation

Fix typo in caplog fixture documentation, which incorrectly identified certain attributes as methods. ( #3406 )

Trivial/Internal Changes

Added a more indicative error message when parametrizing a function whose argument takes a default value. ( #3221 )

Remove internal _pytest.terminal.flatten function in favor of more_itertools.collapse . ( #3330 )

Import some modules from collections.abc instead of collections as the former modules trigger DeprecationWarning in Python 3.7. ( #3339 )

record_property is no longer experimental, removing the warnings was forgotten. ( #3360 )

Mention in documentation and CLI help that fixtures with leading _ are printed by pytest --fixtures only if the -v option is added. ( #3398 )

Deprecations and Removals

record_xml_property fixture is now deprecated in favor of the more generic record_property . ( #2770 )

Defining pytest_plugins is now deprecated in non-top-level conftest.py files, because they “leak” to the entire directory tree. See the docs for the rationale behind this decision ( #3084 )

Features

New --show-capture command-line option that allows to specify how to display captured output when tests fail: no , stdout , stderr , log or all (the default). ( #1478 )

New --rootdir command-line option to override the rules for discovering the root directory. See customize in the documentation for details. ( #1642 )

Fixtures are now instantiated based on their scopes, with higher-scoped fixtures (such as session ) being instantiated first than lower-scoped fixtures (such as function ). The relative order of fixtures of the same scope is kept unchanged, based in their declaration order and their dependencies. ( #2405 )

record_xml_property renamed to record_property and is now compatible with xdist, markers and any reporter. record_xml_property name is now deprecated. ( #2770 )

New --nf , --new-first options: run new tests first followed by the rest of the tests, in both cases tests are also sorted by the file modified time, with more recent files coming first. ( #3034 )

New --last-failed-no-failures command-line option that allows to specify the behavior of the cache plugin’s `--last-failed feature when no tests failed in the last run (or no cache was found): none or all (the default). ( #3139 )

New --doctest-continue-on-failure command-line option to enable doctests to show multiple failures for each snippet, instead of stopping at the first failure. ( #3149 )

Captured log messages are added to the <system-out> tag in the generated junit xml file if the junit_logging ini option is set to system-out . If the value of this ini option is system-err , the logs are written to <system-err> . The default value for junit_logging is no , meaning captured logs are not written to the output file. ( #3156 )

Allow the logging plugin to handle pytest_runtest_logstart and pytest_runtest_logfinish hooks when live logs are enabled. ( #3189 )

Passing --log-cli-level in the command-line now automatically activates live logging. ( #3190 )

Add command line option --deselect to allow deselection of individual tests at collection time. ( #3198 )

Captured logs are printed before entering pdb. ( #3204 )

Deselected item count is now shown before tests are run, e.g. collected X items / Y deselected . ( #3213 )

The builtin module platform is now available for use in expressions in pytest.mark . ( #3236 )

The short test summary info section now is displayed after tracebacks and warnings in the terminal. ( #3255 )

New --verbosity flag to set verbosity level explicitly. ( #3296 )

pytest.approx now accepts comparing a numpy array with a scalar. ( #3312 )

Bug Fixes

Suppress IOError when closing the temporary file used for capturing streams in Python 2.7. ( #2370 )

Fixed clear() method on caplog fixture which cleared records , but not the text property. ( #3297 )

During test collection, when stdin is not allowed to be read, the DontReadFromStdin object still allow itself to be iterable and resolved to an iterator without crashing. ( #3314 )

Improved Documentation

Added a reference page to the docs. ( #1713 )

Trivial/Internal Changes

Change minimum requirement of attrs to 17.4.0 . ( #3228 )

Renamed example directories so all tests pass when ran from the base directory. ( #3245 )

Internal mark.py module has been turned into a package. ( #3250 )

pytest now depends on the more-itertools package. ( #3265 )

Added warning when [pytest] section is used in a .cfg file passed with -c ( #3268 )

nodeids can now be passed explicitly to FSCollector and Node constructors. ( #3291 )

Internal refactoring of FormattedExcinfo to use attrs facilities and remove old support code for legacy Python versions. ( #3292 )

Refactoring to unify how verbosity is handled internally. ( #3296 )

Internal refactoring to better integrate with argparse. ( #3304 )

Fix a python example when calling a fixture in doc/en/usage.rst ( #3308 )

Bug Fixes

Removed progress information when capture option is no . ( #3203 )

Refactor check of bindir from exists to isdir . ( #3241 )

Fix TypeError issue when using approx with a Decimal value. ( #3247 )

Fix reference cycle generated when using the request fixture. ( #3249 )

[tool:pytest] sections in *.cfg files passed by the -c option are now properly recognized. ( #3260 )

Improved Documentation

Add logging plugin to plugins list. ( #3209 )

Trivial/Internal Changes

Fix minor typo in fixture.rst ( #3259 )

Bug Fixes

Move import of doctest.UnexpectedException to top-level to avoid possible errors when using --pdb . ( #1810 )

Added printing of captured stdout/stderr before entering pdb, and improved a test which was giving false negatives about output capturing. ( #3052 )

Fix ordering of tests using parametrized fixtures which can lead to fixtures being created more than necessary. ( #3161 )

Fix bug where logging happening at hooks outside of “test run” hooks would cause an internal error. ( #3184 )

Detect arguments injected by unittest.mock.patch decorator correctly when pypi mock.patch is installed and imported. ( #3206 )

Errors shown when a pytest.raises() with match= fails are now cleaner on what happened: When no exception was raised, the “matching ‘…’” part got removed as it falsely implies that an exception was raised but it didn’t match. When a wrong exception was raised, it’s now thrown (like pytest.raised() without match= would) instead of complaining about the unmatched text. ( #3222 )

Fixed output capture handling in doctests on macOS. ( #985 )

Improved Documentation

Add Sphinx parameter docs for match and message args to pytest.raises . ( #3202 )

Trivial/Internal Changes

pytest has changed the publication procedure and is now being published to PyPI directly from Travis. ( #3060 )

Rename ParameterSet._for_parameterize() to _for_parametrize() in order to comply with the naming convention. ( #3166 )

Skip failing pdb/doctest test on mac. ( #985 )

Deprecations and Removals

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 )

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 )

Incompatible change : after community feedback the logging functionality has undergone some changes. Please consult the logging documentation for details. ( #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 )

New pytest_runtest_logfinish hook which is called when a test item has finished executing, analogous to pytest_runtest_logstart . ( #3101 )

Improve performance when collecting tests using many fixtures. ( #3107 )

New caplog.get_records(when) method which provides access to the captured records for the "setup" , "call" and "teardown" testing stages. ( #3117 )

New fixture record_xml_attribute that allows modifying and inserting attributes on the <testcase> xml node in JUnit reports. ( #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 )

Colorize the levelname column in the live-log output. ( #3142 )

Bug Fixes

Fix hanging pexpect test on macOS by using flush() instead of wait(). ( #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 )

Fix skipping plugin reporting hook when test aborted before plugin setup hook. ( #3074 )

Fix progress percentage reported when tests fail during teardown. ( #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 )

Improved Documentation

Document hooks (defined with historic=True ) which cannot be used with hookwrapper=True . ( #2423 )

Clarify that warning capturing doesn’t change the warning filter by default. ( #2457 )

Clarify a possible confusion when using pytest_fixture_setup with fixture functions that return None. ( #2698 )

Fix the wording of a sentence on doctest flags used in pytest. ( #3076 )

Prefer https://.readthedocs.io over http://.rtfd.org for links in the documentation. ( #3092 )

Improve readability (wording, grammar) of Getting Started guide ( #3131 )

Added note that calling pytest.main multiple times from the same process is not recommended because of import caching. ( #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 cannot use the import keyword in expressions). ( #2953 )

Change parametrized automatic test id generation to use the name attribute of functions instead of the fallback argument name plus counter. ( #2976 )

Replace py.std with stdlib imports. ( #3067 )

Corrected ‘you’ to ‘your’ in logging docs. ( #3129 )

Bug Fixes

pytester: ignore files used to obtain current user metadata in the fd leak detector. ( #2784 )

Fix memory leak where objects returned by fixtures were never destructed by the garbage collector. ( #2981 )

Fix conversion of pyargs to filename to not convert symlinks on Python 2. ( #2985 )

PYTEST_DONT_REWRITE is now checked for plugins too rather than only for test modules. ( #2995 )

Improved Documentation

Add clarifying note about behavior of multiple parametrized arguments ( #3001 )

Trivial/Internal Changes

Code cleanup. ( #3015 , #3021 )

Clean up code by replacing imports and references of _ast to ast . ( #3018 )

Bug Fixes

Fix issue about -p no:<plugin> having no effect. ( #2920 )

Fix regression with warnings that contained non-strings in their arguments in Python 2. ( #2956 )

Always escape null bytes when setting PYTEST_CURRENT_TEST . ( #2957 )

Fix ZeroDivisionError when using the testmon plugin when no tests were actually collected. ( #2971 )

Bring back TerminalReporter.writer as an alias to TerminalReporter._tw . This alias was removed by accident in the 3.3.0 release. ( #2984 )

The pytest-capturelog plugin is now also blacklisted, avoiding errors when running pytest with it still installed. ( #3004 )

Improved Documentation

Fix broken link to plugin pytest-localserver . ( #2963 )

Trivial/Internal Changes

Update github “bugs” link in CONTRIBUTING.rst ( #2949 )

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 )

Remove internal _preloadplugins() function. This removal is part of the pytest_namespace() hook deprecation. ( #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 )

Remove ParameterSet.deprecated_arg_dict - its not a public api and the lack of the underscore was a naming error. ( #2675 )

Remove the internal multi-typed attribute Node._evalskip and replace it with the boolean Node._skipped_by_mark . ( #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 for details and a recommended workaround.

Features

pytest_fixture_post_finalizer hook can now receive a request argument. ( #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 )

Report tests with global pytestmark variable only once. ( #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 )

Match warns signature to raises by adding match keyword. ( #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 . This feature was introduced by merging the popular pytest-catchlog plugin, thanks to @thisch . Be advised that during the merging the backward compatibility interface with the defunct pytest-capturelog has been dropped. ( #2794 )

Add allow_module_level kwarg to pytest.skip() , enabling to skip the whole module. ( #2808 )

Allow setting file_or_dir , -c , and -o in PYTEST_ADDOPTS. ( #2824 )

Return stdout/stderr capture results as a namedtuple , so out and err can be accessed by attribute. ( #2879 )

Add capfdbinary , a version of capfd which returns bytes from readouterr() . ( #2923 )

Add capsysbinary a version of capsys which returns bytes from readouterr() . ( #2934 )

Implement feature to skip setup.py files when run with --doctest-modules . ( #502 )

Bug Fixes

Resume output capturing after capsys/capfd.disabled() context manager. ( #1993 )

pytest_fixture_setup and pytest_fixture_post_finalizer hooks are now called for all conftest.py files. ( #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 )

capsys and capfd can now be used by other fixtures. ( #2709 )

Internal pytester plugin properly encodes bytes arguments to utf-8 . ( #2738 )

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 )

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 )

Change return value of pytest command when --maxfail is reached from 2 (interrupted) to 1 (failed). ( #2845 )

Fix issue in assertion rewriting which could lead it to rewrite modules which should not be rewritten. ( #2939 )

Handle marks without description in pytest.ini . ( #2942 )

Trivial/Internal Changes

pytest now depends on attrs for internal structures to ease code maintainability. ( #2641 )

Refactored internal Python 2/3 compatibility code to use six . ( #2642 )

Stop vendoring pluggy - we’re missing out on its latest changes for not much benefit ( #2719 )

Internal refactor: simplify ascii string escaping by using the backslashreplace error handler in newer Python 3 versions. ( #2734 )

Remove unnecessary mark evaluator in unittest plugin ( #2767 )

Calls to Metafunc.addcall now emit a deprecation warning. This function is scheduled to be removed in pytest-4.0 . ( #2876 )

Internal move of the parameterset extraction to a more maintainable place. ( #2877 )

Internal refactoring to simplify scope node lookup. ( #2910 )

Configure pytest to prevent pip from installing pytest in unsupported Python versions. ( #2922 )

Bug Fixes

Remove py<1.5 restriction from pytest as this can cause version conflicts in some installations. ( #2926 )

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 )

Fix issue with @pytest.parametrize if argnames was specified as keyword arguments. ( #2819 )

Strip whitespace from marker names when reading them from INI config. ( #2856 )

Show full context of doctest source in the pytest output, if the line number of failed example in the docstring is < 9. ( #2882 )

Match fixture paths against actual path segments in order to avoid matching folders which share a prefix. ( #2836 )

Improved Documentation

Introduce a dedicated section about conftest.py. ( #1505 )

Explicitly mention xpass in the documentation of xfail . ( #1997 )

Append example for pytest.param in the example/parametrize document. ( #2658 )

Clarify language of proposal for fixtures parameters ( #2893 )

List python 3.6 in the documented supported versions in the getting started document. ( #2903 )

Clarify the documentation of available fixture scopes. ( #538 )

Add documentation about the python -m pytest invocation adding the current directory to sys.path. ( #911 )

Bug Fixes

Fix crash in tab completion when no prefix is given. ( #2748 )

The equality checking function ( eq ) of MarkDecorator returns False if one object is not an instance of MarkDecorator . ( #2758 )

When running pytest --fixtures-per-test : don’t crash if an item has no _fixtureinfo attribute (e.g. doctests) ( #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 )

Add note in parametrize.rst about calling metafunc.parametrize multiple times. ( #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 )

Fix typo in example of passing a callable to markers (in example/markers.rst) ( #2765 )

Bug Fixes

Calling the deprecated request.getfuncargvalue() now shows the source of the call. ( #2681 )

Allow tests declared as @staticmethod to use fixtures. ( #2699 )

Fixed edge-case during collection: attributes which raised pytest.fail when accessed would abort the entire collection. ( #2707 )

Fix ReprFuncArgs with mixed unicode and UTF-8 args. ( #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 )

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 accessing pytest.config before the argument parsing. ( #2653 )

Trivial/Internal Changes

Fixed minor error in ‘Good Practices/Manual Integration’ code snippet. ( #2691 )

Fixed typo in goodpractices.rst. ( #2721 )

Improve user guidance regarding --resultlog deprecation. ( #2739 )

Bug Fixes

Fixed small terminal glitch when collecting a single test item. ( #2579 )

Correctly consider / as the file separator to automatically mark plugin files for rewrite on Windows. ( #2591 )

Properly escape test names when setting PYTEST_CURRENT_TEST environment variable. ( #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 )

Improved Documentation

Explicitly document which pytest features work with unittest . ( #2626 )

Deprecations and Removals

pytest.approx no longer supports > , >= , < and <= operators to avoid surprising/inconsistent behavior. See the approx() docs for more information. ( #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 )

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 )

Features

Add support for numpy arrays (and dicts) to approx. ( #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 )

Collection ignores local virtualenvs by default; --collect-in-virtualenv overrides this behavior. ( #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 )

Introduce mark.with_args in order to allow passing functions/classes as sole argument to marks. ( #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 )

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 for more info. ( #2583 )

Introduced @pytest.mark.filterwarnings mark which allows overwriting the warnings filter on a per test, class or module level. See the docs for more information. ( #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 )

New pytest_report_collectionfinish hook which allows plugins to add messages to the terminal reporting after collection has been finished successfully. ( #2622 )

Added support for PEP 415 's 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 )

Exceptions raised by pytest.fail , pytest.skip and pytest.xfail now subclass BaseException, making them harder to be caught unintentionally by normal code. ( #580 )

Bug Fixes

Set stdin to a closed PIPE in pytester.py.Testdir.popen() for avoid unwanted interactive pdb ( #2023 )

Add missing encoding attribute to sys.std* streams when using capsys capture mode. ( #2375 )

Fix terminal color changing to black on Windows if colorama is imported in a conftest.py file. ( #2510 )

Fix line number when reporting summary of skipped tests. ( #2548 )

capture: ensure that EncodedFile.name is a string. ( #2555 )

The options --fixtures and --fixtures-per-test will now keep indentation within docstrings. ( #2574 )

doctests line numbers are now reported correctly, fixing pytest-sugar#122 . ( #2610 )

Fix non-determinism in order of fixture collection. Adds new dependency (ordereddict) for Python 2.6. ( #920 )

Improved Documentation

Clarify pytest_configure hook call order. ( #2539 )

Extend documentation for testing plugin code with the pytester plugin. ( #971 )

Trivial/Internal Changes

Update help message for --strict to make it clear it only deals with unregistered markers, not warnings. ( #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 )

Renamed the utility function _pytest.compat._escape_strings to _ascii_escaped to better communicate the function’s purpose. ( #2533 )

Improve error message for CollectError with skip/skipif. ( #2546 )

Emit warning about yield tests being deprecated only once per generator. ( #2562 )

Ensure final collected line doesn’t include artifacts of previous write. ( #2571 )

Fixed all flake8 errors and warnings. ( #2581 )

Added fix-lint tox environment to run automatic pep8 fixes on the code. ( #2582 )

Turn warnings into errors in pytest’s own test suite in order to catch regressions due to deprecations more promptly. ( #2588 )

Show multiple issue links in CHANGELOG entries. ( #2620 )

Bug Fixes

Fix decode error in Python 2 for doctests in docstrings. ( #2434 )

Exceptions raised during teardown by finalizers are now suppressed until all finalizers are called, with the initial exception reraised. ( #2440 )

Fix incorrect “collected items” report when specifying tests on the command- line. ( #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 )

Fix issue where paths collected by pytest could have triple leading / characters. ( #2475 )

Fix internal error when trying to detect the start of a recursive traceback. ( #2486 )

Improved Documentation

Explicitly state for which hooks the calls stop after the first non-None result. ( #2493 )

Trivial/Internal Changes

Create invoke tasks for updating the vendored packages. ( #2474 )

Update copyright dates in LICENSE, README.rst and in the documentation. ( #2499 )

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)

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)

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 :

[pytest] addopts = -p no:warnings

See the warnings documentation page 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 pytest_namespace 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 comparison 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 an iteration limit for _pytest.compat.get_real_func . 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 regenerate the documentation on different platforms. Thanks @RonnyPfannschmidt for the PR.

fix #2391 : consider pytest_plugins 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 occurred 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 to @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.

The ids argument to parametrize again accepts unicode strings in Python 2 ( #1905 ). Thanks @philpep for the report and @nicoddemus for the PR.

Assertions are now being rewritten for plugins in development mode ( pip install -e ) ( #1934 ). Thanks @nicoddemus for the PR.

Fix pkg_resources import error in Jython projects ( #1853 ). Thanks @raquelalegre for the PR.

Got rid of AttributeError: 'Module' object has no attribute '_obj' exception in Python 3 ( #1944 ). Thanks @axil for the PR.

Explain a bad scope value passed to @fixture declarations or a MetaFunc.parametrize() call.

This version includes pluggy-0.4.0 , which correctly handles VersionConflict errors in plugins ( #704 ). Thanks @nicoddemus for the 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.

Incompatible changes

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.

New hooks:

pytest_fixture_setup(fixturedef, request) : executes fixture setup;

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

The parameter to xunit-style setup/teardown methods ( setup_method , setup_module , etc.) is now optional and may be omitted. Thanks @okken for bringing this to attention and @nicoddemus for the PR.

Improved automatic id generation selection in case of duplicate ids in parametrize. Thanks @palaviv for the complete PR ( #1474 ).

Now pytest warnings summary is shown up by default. Added a new flag --disable-pytest-warnings to explicitly disable the warnings summary ( #1668 ).

Make ImportError during collection more explicit by reminding the user to check the name of the test module/package(s) ( #1426 ). Thanks @omarkohl for the complete PR ( #1520 ).

Add build/ and dist/ to the default --norecursedirs list. Thanks @mikofski for the report and @tomviner for the PR ( #1544 ).

pytest.raises in the context manager form accepts a custom message to raise when no exception occurred. Thanks @palaviv for the complete PR ( #1616 ).

conftest.py files now benefit from assertion rewriting; previously it was only available for test modules. Thanks @flub , @sober7 and @nicoddemus for the PR ( #1619 ).

Text documents without any doctests no longer appear as “skipped”. Thanks @graingert for reporting and providing a full PR ( #1580 ).

Ensure that a module within a namespace package can be found when it is specified on the command line together with the --pyargs option. Thanks to @taschini for the PR ( #1597 ).

Always include full assertion explanation during assertion rewriting. The previous behaviour was hiding sub-expressions that happened to be False , assuming this was redundant information. Thanks @bagerard for reporting ( #1503 ). Thanks to @davehunt and @tomviner for the PR.

OptionGroup.addoption() now checks if option names were already added before, to make it easier to track down issues like #1618 . Before, you only got exceptions later from argparse library, giving no clue about the actual reason for double-added options.

yield -based tests are considered deprecated and will be removed in pytest-4.0. Thanks @nicoddemus for the PR.

[pytest] sections in setup.cfg files should now be named [tool:pytest] to avoid conflicts with other distutils commands (see #567 ). [pytest] sections in pytest.ini or tox.ini files are supported and unchanged. Thanks @nicoddemus for the PR.

Using pytest_funcarg__ prefix to declare fixtures is considered deprecated and will be removed in pytest-4.0 ( #1684 ). Thanks @nicoddemus for the PR.

Passing a command-line string to pytest.main() is considered deprecated and scheduled for removal in pytest-4.0. It is recommended to pass a list of arguments instead ( #1723 ).

Rename getfuncargvalue to getfixturevalue . getfuncargvalue is still present but is now considered deprecated. Thanks to @RedBeardCode and @tomviner for the PR ( #1626 ).

optparse type usage now triggers DeprecationWarnings ( #1740 ).

optparse backward compatibility supports float/complex types ( #457 ).

Refined logic for determining the rootdir , considering only valid paths which fixes a number of issues: #1594 , #1435 and #1471 . Updated the documentation according to current behavior. Thanks to @blueyed , @davehunt and @matthiasha for the PR.

Always include full assertion explanation. The previous behaviour was hiding sub-expressions that happened to be False, assuming this was redundant information. Thanks @bagerard for reporting ( #1503 ). Thanks to @davehunt and @tomviner for PR.

Better message in case of not using parametrized variable (see #1539 ). Thanks to @tramwaj29 for the PR.

Updated docstrings with a more uniform style.

Add stderr write for pytest.exit(msg) during startup. Previously the message was never shown. Thanks @BeyondEvil for reporting #1210 . Thanks to @jgsonesen and @tomviner for the PR.

No longer display the incorrect test deselection reason ( #1372 ). Thanks @ronnypfannschmidt for the PR.

The --resultlog command line option has been deprecated: it is little used and there are more modern and better alternatives (see #830 ). Thanks @nicoddemus for the PR.

Improve error message with fixture lookup errors: add an ‘E’ to the first line and ‘>’ to the rest. Fixes #717 . Thanks @blueyed for reporting and a PR, @eolo999 for the initial PR and @tomviner for his guidance during EuroPython2016 sprint.

Bug Fixes

Parametrize now correctly handles duplicated test ids.

Fix internal error issue when the method argument is missing for teardown_method() ( #1605 ).

Fix exception visualization in case the current working directory (CWD) gets deleted during testing ( #1235 ). Thanks @bukzor for reporting. PR by @marscher .

Improve test output for logical expression with brackets ( #925 ). Thanks @DRMacIver for reporting and @RedBeardCode for the PR.

Create correct diff for strings ending with newlines ( #1553 ). Thanks @Vogtinator for reporting and @RedBeardCode and @tomviner for the PR.

ConftestImportFailure now shows the traceback making it easier to identify bugs in conftest.py files ( #1516 ). Thanks @txomon for the PR.

Text documents without any doctests no longer appear as “skipped”. Thanks @graingert for reporting and providing a full PR ( #1580 ).

Fixed collection of classes with custom new method. Fixes #1579 . Thanks to @Stranger6667 for the PR.

Fixed scope overriding inside metafunc.parametrize ( #634 ). Thanks to @Stranger6667 for the PR.

Fixed the total tests tally in junit xml output ( #1798 ). Thanks to @cboelsen for the PR.

Fixed off-by-one error with lines from request.node.warn . Thanks to @blueyed for the PR.

Bug Fixes

fix #510 : skip tests where one parameterize dimension was empty thanks Alex Stapleton for the Report and @RonnyPfannschmidt for the PR

Fix Xfail does not work with condition keyword argument. Thanks @astraw38 for reporting the issue ( #1496 ) and @tomviner for PR the ( #1524 ).

Fix win32 path issue when putting custom config file with absolute path in pytest.main("-c your_absolute_path") .

Fix maximum recursion depth detection when raised error class is not aware of unicode/encoded bytes. Thanks @prusse-martin for the PR ( #1506 ).

Fix pytest.mark.skip mark when used in strict mode. Thanks @pquentin for the PR and @RonnyPfannschmidt for showing how to fix the bug.

Minor improvements and fixes to the documentation. Thanks @omarkohl for the PR.

Fix --fixtures to show all fixture definitions as opposed to just one per fixture name. Thanks to @hackebrot for the PR.

Bug Fixes

Improve error message when a plugin fails to load. Thanks @nicoddemus for the PR.

Fix ( #1178 ): pytest.fail with non-ascii characters raises an internal pytest error. Thanks @nicoddemus for the PR.

Fix ( #469 ): junit parses report.nodeid incorrectly, when params IDs contain :: . Thanks @tomviner for the PR ( #1431 ).

Fix ( #578 ): SyntaxErrors containing non-ascii lines at the point of failure generated an internal py.test error. Thanks @asottile for the report and @nicoddemus for the PR.

Fix ( #1437 ): When passing in a bytestring regex pattern to parameterize attempt to decode it as utf-8 ignoring errors.

Fix ( #649 ): parametrized test nodes cannot be specified to run on the command line.

Fix ( #138 ): better reporting for python 3.3+ chained exceptions

New Features

New pytest.mark.skip mark, which unconditionally skips marked tests. Thanks @MichaelAquilina for the complete PR ( #1040 ).

--doctest-glob may now be passed multiple times in the command-line. Thanks @jab and @nicoddemus for the PR.

New -rp and -rP reporting options give the summary and full output of passing tests, respectively. Thanks to @codewarrior0 for the PR.

pytest.mark.xfail now has a strict option, which makes XPASS tests to fail the test suite (defaulting to False ). There’s also a xfail_strict ini option that can be used to configure it project-wise. Thanks @rabbbit for the request and @nicoddemus for the PR ( #1355 ).

Parser.addini now supports options of type bool . Thanks @nicoddemus for the PR.

New ALLOW_BYTES doctest option. This strips b prefixes from byte strings in doctest output (similar to ALLOW_UNICODE ). Thanks @jaraco for the request and @nicoddemus for the PR ( #1287 ).

Give a hint on KeyboardInterrupt to use the --fulltrace option to show the errors. Fixes #1366 . Thanks to @hpk42 for the report and @RonnyPfannschmidt for the PR.

Catch IndexError exceptions when getting exception source location. Fixes a pytest internal error for dynamically generated code (fixtures and tests) where source lines are fake by intention.

Changes

Important : py.code has been merged into the pytest repository as pytest._code . This decision was made because py.code had very few uses outside pytest and the fact that it was in a different repository made it difficult to fix bugs on its code in a timely manner. The team hopes with this to be able to better refactor out and improve that code. This change shouldn’t affect users, but it is useful to let users aware if they encounter any strange behavior.

Keep in mind that the code for pytest._code is private and experimental , so you definitely should not import it explicitly!

Please note that the original py.code is still available in pylib .

pytest_enter_pdb now optionally receives the pytest config object. Thanks @nicoddemus for the PR.

Removed code and documentation for Python 2.5 or lower versions, including removal of the obsolete _pytest.assertion.oldinterpret module. Thanks @nicoddemus for the PR ( #1226 ).

Comparisons now always show up in full when CI or BUILD_NUMBER is found in the environment, even when -vv isn’t used. Thanks @The-Compiler for the PR.

--lf and --ff now support long names: --last-failed and --failed-first respectively. Thanks @MichaelAquilina for the PR.

Added expected exceptions to pytest.raises fail message.

Collection only displays progress (“collecting X items”) when in a terminal. This avoids cluttering the output when using --color=yes to obtain colors in CI integrations systems ( #1397 ).

Bug Fixes

The -s and -c options should now work under xdist ; Config.fromdictargs now represents its input much more faithfully. Thanks to @bukzor for the complete PR ( #680 ).

Fix ( #1290 ): support Python 3.5’s @ operator in assertion rewriting. Thanks @Shinkenjoe for report with test case and @tomviner for the PR.

Fix formatting utf-8 explanation messages ( #1379 ). Thanks @biern for the PR.

Fix traceback style docs to describe all of the available options (auto/long/short/line/native/no), with auto being the default since v2.6. Thanks @hackebrot for the PR.

Fix ( #1422 ): junit record_xml_property doesn’t allow multiple records with same name.

fix #1338: use predictable object resolution for monkeypatch

fix #1259: allow for double nodeids in junitxml, this was a regression failing plugins combinations like pytest-pep8 + pytest-flakes

Workaround for exception that occurs in pyreadline when using --pdb with standard I/O capture enabled. Thanks Erik M. Bray for the PR.

fix #900: Better error message in case the target of a monkeypatch call raises an ImportError .

fix #1292: monkeypatch calls (setattr, setenv, etc.) are now O(1). Thanks David R. MacIver for the report and Bruno Oliveira for the PR.

fix #1223: captured stdout and stderr are now properly displayed before entering pdb when --pdb is used instead of being thrown away. Thanks Cal Leeming for the PR.

fix #1305: pytest warnings emitted during pytest_terminal_summary are now properly displayed. Thanks Ionel Maries Cristian for the report and Bruno Oliveira for the PR.

fix #628: fixed internal UnicodeDecodeError when doctests contain unicode. Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR.

fix #1334: Add captured stdout to jUnit XML report on setup error. Thanks Georgy Dyuldin for the PR.

fix #1243: fixed issue where class attributes injected during collection could break pytest. PR by Alexei Kozlenok, thanks Ronny Pfannschmidt and Bruno Oliveira for the review and help.

fix #1074: precompute junitxml chunks instead of storing the whole tree in objects Thanks Bruno Oliveira for the report and Ronny Pfannschmidt for the PR

fix #1238: fix pytest.deprecated_call() receiving multiple arguments (Regression introduced in 2.8.4). Thanks Alex Gaynor for the report and Bruno Oliveira for the PR.

fix #1190: deprecated_call() now works when the deprecated function has been already called by another test in the same module. Thanks Mikhail Chernykh for the report and Bruno Oliveira for the PR.

fix #1198: --pastebin option now works on Python 3. Thanks Mehdy Khoshnoody for the PR.

fix #1219: --pastebin now works correctly when captured output contains non-ascii characters. Thanks Bruno Oliveira for the PR.

fix #1204: another error when collecting with a nasty getattr(). Thanks Freya Bruhin for the PR.

fix the summary printed when no tests did run. Thanks Freya Bruhin for the PR.

fix #1185 - ensure MANIFEST.in exactly matches what should go to a sdist

a number of documentation modernizations wrt good practices. Thanks Bruno Oliveira for the PR.

fix #1169: add name attribute to testcases in TestCaseFunction to support the @unittest.skip decorator on functions and methods. Thanks Lee Kamentsky for the PR.

fix #1035: collecting tests if test module level obj has getattr(). Thanks Suor for the report and Bruno Oliveira / Tom Viner for the PR.

fix #331: don’t collect tests if their failure cannot be reported correctly e.g. they are a callable instance of a class.

fix #1133: fixed internal error when filtering tracebacks where one entry belongs to a file which is no longer available. Thanks Bruno Oliveira for the PR.

enhancement made to highlight in red the name of the failing tests so they stand out in the output. Thanks Gabriel Reis for the PR.

add more talks to the documentation

extend documentation on the –ignore cli option

use pytest-runner for setuptools integration

minor fixes for interaction with OS X El Capitan system integrity protection (thanks Florian)

fix #1085: proper handling of encoding errors when passing encoded byte strings to pytest.parametrize in Python 2. Thanks Themanwithoutaplan for the report and Bruno Oliveira for the PR.

fix #1087: handling SystemError when passing empty byte strings to pytest.parametrize in Python 3. Thanks Paul Kehrer for the report and Bruno Oliveira for the PR.

fix #995: fixed internal error when filtering tracebacks where one entry was generated by an exec() statement. Thanks Daniel Hahler, Ashley C Straw, Philippe Gauthier and Pavel Savchenko for contributing and Bruno Oliveira for the PR.

fix #1100 and #1057: errors when using autouse fixtures and doctest modules. Thanks Sergey B Kirpichev and Vital Kudzelka for contributing and Bruno Oliveira for the PR.

fix #1034: Add missing nodeid on pytest_logwarning call in addhook. Thanks Simon Gomizelj for the PR.

‘deprecated_call’ is now only satisfied with a DeprecationWarning or PendingDeprecationWarning. Before 2.8.0, it accepted any warning, and 2.8.0 made it accept only DeprecationWarning (but not PendingDeprecationWarning). Thanks Alex Gaynor for the issue and Eric Hunsberger for the PR.

fix issue #1073: avoid calling getattr on potential plugin objects. This fixes an incompatibility with pytest-django. Thanks Andreas Pelme, Bruno Oliveira and Ronny Pfannschmidt for contributing and Holger Krekel for the fix.

Fix issue #704: handle versionconflict during plugin loading more gracefully. Thanks Bruno Oliveira for the PR.

Fix issue #1064: “”–junitxml” regression when used with the “pytest-xdist” plugin, with test reports being assigned to the wrong tests. Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR.

(experimental) adapt more SEMVER style versioning and change meaning of master branch in git repo: “master” branch now keeps the bug fixes, changes aimed for micro releases. “features” branch will only be released with minor or major pytest releases.

Fix issue #766 by removing documentation references to distutils. Thanks Russel Winder.

Fix issue #1030: now byte-strings are escaped to produce item node ids to make them always serializable. Thanks Andy Freeland for the report and Bruno Oliveira for the PR.

Python 2: if unicode parametrized values are convertible to ascii, their ascii representation is used for the node id.

Fix issue #411: Add eq method to assertion comparison example. Thanks Ben Webb.

Fix issue #653: deprecated_call can be used as context manager.

fix issue 877: properly handle assertion explanations with non-ascii repr Thanks Mathieu Agopian for the report and Ronny Pfannschmidt for the PR.

fix issue 1029: transform errors when writing cache values into pytest-warnings

new --lf and -ff options to run only the last failing tests or “failing tests first” from the last run. This functionality is provided through porting the formerly external pytest-cache plugin into pytest core. BACKWARD INCOMPAT: if you used pytest-cache’s functionality to persist data between test runs be aware that we don’t serialize sets anymore. Thanks Ronny Pfannschmidt for most of the merging work.

“-r” option now accepts “a” to include all possible reports, similar to passing “fEsxXw” explicitly (issue960). Thanks Abhijeet Kasurde for the PR.

avoid python3.5 deprecation warnings by introducing version specific inspection helpers, thanks Michael Droettboom.

fix issue562: @nose.tools.istest now fully respected.

fix issue934: when string comparison fails and a diff is too large to display without passing -vv, still show a few lines of the diff. Thanks Freya Bruhin for the report and Bruno Oliveira for the PR.

fix issue736: Fix a bug where fixture params would be discarded when combined with parametrization markers. Thanks to Markus Unterwaditzer for the PR.

fix issue710: introduce ALLOW_UNICODE doctest option: when enabled, the u prefix is stripped from unicode strings in expected doctest output. This allows doctests which use unicode to run in Python 2 and 3 unchanged. Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR.

parametrize now also generates meaningful test IDs for enum, regex and class objects (as opposed to class instances). Thanks to Freya Bruhin for the PR.

Add ‘warns’ to assert that warnings are thrown (like ‘raises’). Thanks to Eric Hunsberger for the PR.

Fix issue683: Do not apply an already applied mark. Thanks ojake for the PR.

Deal with capturing failures better so fewer exceptions get lost to /dev/null. Thanks David Szotten for the PR.

fix issue730: deprecate and warn about the –genscript option. Thanks Ronny Pfannschmidt for the report and Christian Pommranz for the PR.

fix issue751: multiple parametrize with ids bug if it parametrizes class with two or more test methods. Thanks Sergey Chipiga for reporting and Jan Bednarik for PR.

fix issue82: avoid loading conftest files from setup.cfg/pytest.ini/tox.ini files and upwards by default (–confcutdir can still be set to override this). Thanks Bruno Oliveira for the PR.

fix issue768: docstrings found in python modules were not setting up session fixtures. Thanks Jason R. Coombs for reporting and Bruno Oliveira for the PR.

added tmpdir_factory , a session-scoped fixture that can be used to create directories under the base temporary directory. Previously this object was installed as a _tmpdirhandler attribute of the config object, but now it is part of the official API and using config._tmpdirhandler is deprecated. Thanks Bruno Oliveira for the PR.

fix issue808: pytest’s internal assertion rewrite hook now implements the optional PEP 302 get_data API so tests can access data files next to them. Thanks xmo-odoo for request and example and Bruno Oliveira for the PR.

rootdir and inifile are now displayed during usage errors to help users diagnose problems such as unexpected ini files which add unknown options being picked up by pytest. Thanks to Pavel Savchenko for bringing the problem to attention in #821 and Bruno Oliveira for the PR.

Summary bar now is colored yellow for warning situations such as: all tests either were skipped or xpass/xfailed, or no tests were run at all (this is a partial fix for issue500).

fix issue812: pytest now exits with status code 5 in situations where no tests were run at all, such as the directory given in the command line does not contain any tests or as result of a command line option filters all out all tests (-k for example). Thanks Eric Siegerman (issue812) and Bruno Oliveira for the PR.

Summary bar now is colored yellow for warning situations such as: all tests either were skipped or xpass/xfailed, or no tests were run at all (related to issue500). Thanks Eric Siegerman.

New testpaths ini option: list of directories to search for tests when executing pytest from the root directory. This can be used to speed up test collection when a project has well specified directories for tests, being usually more practical than configuring norecursedirs for all directories that do not contain tests. Thanks to Adrian for idea (#694) and Bruno Oliveira for the PR.

fix issue713: JUnit XML reports for doctest failures. Thanks Punyashloka Biswal.

fix issue970: internal pytest warnings now appear as “pytest-warnings” in the terminal instead of “warnings”, so it is clear for users that those warnings are from pytest and not from the builtin “warnings” module. Thanks Bruno Oliveira.

Include setup and teardown in junitxml test durations. Thanks Janne Vanhala.

fix issue735: assertion failures on debug versions of Python 3.4+

new option --import-mode to allow to change test module importing behaviour to append to sys.path instead of prepending. This better allows to run test modules against installed versions of a package even if the package under test has the same import root. In this example:

testing / init . py testing / test_pkg_under_test . py pkg_under_test /

the tests will run against the installed version of pkg_under_test when --import-mode=append is used whereas by default they would always pick up the local version. Thanks Holger Krekel.

pytester: add method TmpTestdir.delete_loaded_modules() , and call it from inline_run() to allow temporary modules to be reloaded. Thanks Eduardo Schettino.

internally refactor pluginmanager API and code so that there is a clear distinction between a pytest-agnostic rather simple pluginmanager and the PytestPluginManager which adds a lot of behaviour, among it handling of the local conftest files. In terms of documented methods this is a backward compatible change but it might still break 3rd party plugins which relied on details like especially the pluginmanager.add_shutdown() API. Thanks Holger Krekel.

pluginmanagement: introduce pytest.hookimpl and pytest.hookspec decorators for setting impl/spec specific parameters. This substitutes the previous now deprecated use of pytest.mark which is meant to contain markers for test functions only.

write/refine docs for “writing plugins” which now have their own page and are separate from the “using/installing plugins`` page.

fix issue732: properly unregister plugins from any hook calling sites allowing to have temporary plugins during test execution.

deprecate and warn about multicall argument in hook implementations. Use the hookwrapper mechanism instead already introduced with pytest-2.7.

speed up pytest’s own test suite considerably by using inprocess tests by default (testrun can be modified with –runpytest=subprocess to create subprocesses in many places instead). The main APIs to run pytest in a test is “runpytest()” or “runpytest_subprocess” and “runpytest_inprocess” if you need a particular way of running the test. In all cases you get back a RunResult but the inprocess one will also have a “reprec” attribute with the recorded events/reports.

fix monkeypatch.setattr(“x.y”, raising=False) to actually not raise if “y” is not a preexisting attribute. Thanks Freya Bruhin.

fix issue741: make running output from testdir.run copy/pasteable Thanks Bruno Oliveira.

add a new --noconftest argument which ignores all conftest.py files.

add file and line attributes to JUnit-XML output.

fix issue890: changed extension of all documentation files from txt to rst . Thanks to Abhijeet for the PR.

fix issue714: add ability to apply indirect=True parameter on particular argnames. Thanks Elizaveta239.

fix issue890: changed extension of all documentation files from txt to rst . Thanks to Abhijeet for the PR.

fix issue957: “# doctest: SKIP” option will now register doctests as SKIPPED rather than PASSED. Thanks Thomas Grainger for the report and Bruno Oliveira for the PR.

issue951: add new record_xml_property fixture, that supports logging additional information on xml output. Thanks David Diaz for the PR.

issue949: paths after normal options (for example -s , -v , etc) are now properly used to discover rootdir and ini files. Thanks Peter Lauri for the report and Bruno Oliveira for the PR.

Allow ‘dev’, ‘rc’, or other non-integer version strings in importorskip . Thanks to Eric Hunsberger for the PR.

fix issue856: consider –color parameter in all outputs (for example –fixtures). Thanks Barney Gale for the report and Bruno Oliveira for the PR.

fix issue855: passing str objects as plugins argument to pytest.main is now interpreted as a module name to be imported and registered as a plugin, instead of silently having no effect. Thanks xmo-odoo for the report and Bruno Oliveira for the PR.

fix issue744: fix for ast.Call changes in Python 3.5+. Thanks Guido van Rossum, Matthias Bussonnier, Stefan Zimmermann and Thomas Kluyver.

fix issue842: applying markers in classes no longer propagate this markers to superclasses which also have markers. Thanks xmo-odoo for the report and Bruno Oliveira for the PR.

preserve warning functions after call to pytest.deprecated_call. Thanks Pieter Mulder for PR.

fix issue854: autouse yield_fixtures defined as class members of unittest.TestCase subclasses now work as expected. Thanks xmo-odoo for the report and Bruno Oliveira for the PR.

fix issue833: –fixtures now shows all fixtures of collected test files, instead of just the fixtures declared on the first one. Thanks Freya Bruhin for reporting and Bruno Oliveira for the PR.

fix issue863: skipped tests now report the correct reason when a skip/xfail condition is met when using multiple markers. Thanks Raphael Pierzina for reporting and Bruno Oliveira for the PR.

optimized tmpdir fixture initialization, which should make test sessions faster (specially when using pytest-xdist). The only visible effect is that now pytest uses a subdirectory in the $TEMP directory for all directories created by this fixture (defaults to $TEMP/pytest-$USER). Thanks Bruno Oliveira for the PR.

fix issue767: pytest.raises value attribute does not contain the exception instance on Python 2.6. Thanks Eric Siegerman for providing the test case and Bruno Oliveira for PR.

Automatically create directory for junitxml and results log. Thanks Aron Curzon.

fix issue713: JUnit XML reports for doctest failures. Thanks Punyashloka Biswal.

fix issue735: assertion failures on debug versions of Python 3.4+ Thanks Benjamin Peterson.

fix issue114: skipif marker reports to internal skipping plugin; Thanks Floris Bruynooghe for reporting and Bruno Oliveira for the PR.

fix issue748: unittest.SkipTest reports to internal pytest unittest plugin. Thanks Thomas De Schampheleire for reporting and Bruno Oliveira for the PR.

fix issue718: failed to create representation of sets containing unsortable elements in python 2. Thanks Edison Gustavo Muenz.

fix issue756, fix issue752 (and similar issues): depend on py-1.4.29 which has a refined algorithm for traceback generation.

fix issue731: do not get confused by the braces which may be present and unbalanced in an object’s repr while collapsing False explanations. Thanks Carl Meyer for the report and test case.

fix issue553: properly handling inspect.getsourcelines failures in FixtureLookupError which would lead to an internal error, obfuscating the original problem. Thanks talljosh for initial diagnose/patch and Bruno Oliveira for final patch.

fix issue660: properly report scope-mismatch-access errors independently from ordering of fixture arguments. Also avoid the pytest internal traceback which does not provide information to the user. Thanks Holger Krekel.

streamlined and documented release process. Also all versions (in setup.py and documentation generation) are now read from _pytest/init.py. Thanks Holger Krekel.

fixed docs to remove the notion that yield-fixtures are experimental. They are here to stay :) Thanks Bruno Oliveira.

Support building wheels by using environment markers for the requirements. Thanks Ionel Maries Cristian.

fixed regression to 2.6.4 which surfaced e.g. in lost stdout capture printing when tests raised SystemExit. Thanks Holger Krekel.

reintroduced _pytest fixture of the pytester plugin which is used at least by pytest-xdist.

fix issue435: make reload() work when assert rewriting is active. Thanks Daniel Hahler.

fix issue616: conftest.py files and their contained fixtures are now properly considered for visibility, independently from the exact current working directory and test arguments that are used. Many thanks to Eric Siegerman and his PR235 which contains systematic tests for conftest visibility and now passes. This change also introduces the concept of a rootdir which is printed as a new pytest header and documented in the pytest customize web page.

change reporting of “diverted” tests, i.e. tests that are collected in one file but actually come from another (e.g. when tests in a test class come from a base class in a different file). We now show the nodeid and indicate via a postfix the other file.

add ability to set command line options by environment variable PYTEST_ADDOPTS.

added documentation on the new pytest-dev teams on bitbucket and github. See https://pytest.org/en/stable/contributing.html . Thanks to Anatoly for pushing and initial work on this.

fix issue650: new option --doctest-ignore-import-errors which will turn import errors in doctests into skips. Thanks Charles Cloud for the complete PR.

fix issue655: work around different ways that cause python2/3 to leak sys.exc_info into fixtures/tests causing failures in 3rd party code

fix issue615: assertion rewriting did not correctly escape % signs when formatting boolean operations, which tripped over mixing booleans with modulo operators. Thanks to Tom Viner for the report, triaging and fix.

implement issue351: add ability to specify parametrize ids as a callable to generate custom test ids. Thanks Brianna Laugher for the idea and implementation.

introduce and document new hookwrapper mechanism useful for plugins which want to wrap the execution of certain hooks for their purposes. This supersedes the undocumented multicall protocol which pytest itself and some external plugins use. Note that pytest-2.8 is scheduled to drop supporting the old multicall and only support the hookwrapper protocol.

majorly speed up invocation of plugin hooks

use hookwrapper mechanism in builtin pytest plugins.

add a doctest ini option for doctest flags, thanks Holger Peters.

add note to docs that if you want to mark a parameter and the parameter is a callable, you also need to pass in a reason to disambiguate it from the “decorator” case. Thanks Tom Viner.

“python_classes” and “python_functions” options now support glob-patterns for test discovery, as discussed in issue600. Thanks Ldiary Translations.

allow to override parametrized fixtures with non-parametrized ones and vice versa (bubenkoff).

fix issue463: raise specific error for ‘parameterize’ misspelling (pfctdayelise).

On failure, the sys.last_value , sys.last_type and sys.last_traceback are set, so that a user can inspect the error via postmortem debugging (almarklein).

Improve assertion failure reporting on iterables, by using ndiff and pprint.

removed outdated japanese docs from source tree.

docs for “pytest_addhooks” hook. Thanks Bruno Oliveira.

updated plugin index docs. Thanks Bruno Oliveira.

fix issue557: with “-k” we only allow the old style “-” for negation at the beginning of strings and even that is deprecated. Use “not” instead. This should allow to pick parametrized tests where “-” appeared in the parameter.

fix issue604: Escape % character in the assertion message.

fix issue620: add explanation in the –genscript target about what the binary blob means. Thanks Dinu Gherman.

fix issue614: fixed pastebin support.

fix issue620: add explanation in the –genscript target about what the binary blob means. Thanks Dinu Gherman.

fix issue614: fixed pastebin support.

fix issue575: xunit-xml was reporting collection errors as failures instead of errors, thanks Oleg Sinyavskiy.

fix issue582: fix setuptools example, thanks Laszlo Papp and Ronny Pfannschmidt.

Fix infinite recursion bug when pickling capture.EncodedFile, thanks Uwe Schmitt.

fix issue589: fix bad interaction with numpy and others when showing exceptions. Check for precise “maximum recursion depth exceed” exception instead of presuming any RuntimeError is that one (implemented in py dep). Thanks Charles Cloud for analysing the issue.

fix conftest related fixture visibility issue: when running with a CWD outside of a test package pytest would get fixture discovery wrong. Thanks to Wolfgang Schnerring for figuring out a reproducible example.

Introduce pytest_enter_pdb hook (needed e.g. by pytest_timeout to cancel the timeout when interactively entering pdb). Thanks Wolfgang Schnerring.

check xfail/skip also with non-python function test items. Thanks Floris Bruynooghe.

Added function pytest.freeze_includes(), which makes it easy to embed pytest into executables using tools like cx_freeze. See docs for examples and rationale. Thanks Bruno Oliveira.

Improve assertion rewriting cache invalidation precision.

fixed issue561: adapt autouse fixture example for python3.

fixed issue453: assertion rewriting issue with repr containing “n{”, “n}” and “n~”.

fix issue560: correctly display code if an “else:” or “finally:” is followed by statements on the same line.

Fix example in monkeypatch documentation, thanks t-8ch.

fix issue572: correct tmpdir doc example for python3.

Do not mark as universal wheel because Python 2.6 is different from other builds due to the extra argparse dependency. Fixes issue566. Thanks sontek.

Implement issue549: user-provided assertion messages now no longer replace the py.test introspection message but are shown in addition to them.

No longer show line numbers in the –verbose output, the output is now purely the nodeid. The line number is still shown in failure reports. Thanks Floris Bruynooghe.

fix issue437 where assertion rewriting could cause pytest-xdist worker nodes to collect different tests. Thanks Bruno Oliveira.

fix issue555: add “errors” attribute to capture-streams to satisfy some distutils and possibly other code accessing sys.stdout.errors.

fix issue547 capsys/capfd also work when output capturing (“-s”) is disabled.

address issue170: allow pytest.mark.xfail(…) to specify expected exceptions via an optional “raises=EXC” argument where EXC can be a single exception or a tuple of exception classes. Thanks David Mohr for the complete PR.

fix integration of pytest with unittest.mock.patch decorator when it uses the “new” argument. Thanks Nicolas Delaby for test and PR.

fix issue with detecting conftest files if the arguments contain “::” node id specifications (copy pasted from “-v” output)

fix issue544 by only removing “@NUM” at the end of “::” separated parts and if the part has a “.py” extension

don’t use py.std import helper, rather import things directly. Thanks Bruno Oliveira.

fix issue409 – better interoperate with cx_freeze by not trying to import from collections.abc which causes problems for py27/cx_freeze. Thanks Wolfgang L. for reporting and tracking it down.

fixed docs and code to use “pytest” instead of “py.test” almost everywhere. Thanks Jurko Gospodnetic for the complete PR.

fix issue425: mention at end of “py.test -h” that –markers and –fixtures work according to specified test path (or current dir)

fix issue413: exceptions with unicode attributes are now printed correctly also on python2 and with pytest-xdist runs. (the fix requires py-1.4.20)

copy, cleanup and integrate py.io capture from pylib 1.4.20.dev2 (rev 13d9af95547e)

address issue416: clarify docs as to conftest.py loading semantics

fix issue429: comparing byte strings with non-ascii chars in assert expressions now work better. Thanks Floris Bruynooghe.

make capfd/capsys.capture private, its unused and shouldn’t be exposed

merge new documentation styling PR from Tobias Bieniek.

fix issue403: allow parametrize of multiple same-name functions within a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting and analysis.

Allow parameterized fixtures to specify the ID of the parameters by adding an ids argument to pytest.fixture() and pytest.yield_fixture(). Thanks Floris Bruynooghe.

fix issue404 by always using the binary xml escape in the junitxml plugin. Thanks Ronny Pfannschmidt.

fix issue407: fix addoption docstring to point to argparse instead of optparse. Thanks Daniel D. Wright.

dropped python2.5 from automated release testing of pytest itself which means it’s probably going to break soon (but still works with this release we believe).

simplified and fixed implementation for calling finalizers when parametrized fixtures or function arguments are involved. finalization is now performed lazily at setup time instead of in the “teardown phase”. While this might sound odd at first, it helps to ensure that we are correctly handling setup/teardown even in complex code. User-level code should not be affected unless it’s implementing the pytest_runtest_teardown hook and expecting certain fixture instances are torn down within (very unlikely and would have been unreliable anyway).

PR90: add –color=yes|no|auto option to force terminal coloring mode (“auto” is default). Thanks Marc Abramowitz.

fix issue319 - correctly show unicode in assertion errors. Many thanks to Floris Bruynooghe for the complete PR. Also means we depend on py>=1.4.19 now.

fix issue396 - correctly sort and finalize class-scoped parametrized tests independently from number of methods on the class.

refix issue323 in a better way – parametrization should now never cause Runtime Recursion errors because the underlying algorithm for re-ordering tests per-scope/per-fixture is not recursive anymore (it was tail-call recursive before which could lead to problems for more than >966 non-function scoped parameters).

fix issue290 - there is preliminary support now for parametrizing with repeated same values (sometimes useful to test if calling a second time works as with the first time).

close issue240 - document precisely how pytest module importing works, discuss the two common test directory layouts, and how it interacts with PEP 420 -namespace packages.

fix issue246 fix finalizer order to be LIFO on independent fixtures depending on a parametrized higher-than-function scoped fixture. (was quite some effort so please bear with the complexity of this sentence :) Thanks Ralph Schmitt for the precise failure example.

fix issue244 by implementing special index for parameters to only use indices for parametrized test ids

fix issue287 by running all finalizers but saving the exception from the first failing finalizer and re-raising it so teardown will still have failed. We reraise the first failing exception because it might be the cause for other finalizers to fail.

fix ordering when mock.patch or other standard decorator-wrappings are used with test methods. This fixes issue346 and should help with random “xdist” collection failures. Thanks to Ronny Pfannschmidt and Donald Stufft for helping to isolate it.

fix issue357 - special case “-k” expressions to allow for filtering with simple strings that are not valid python expressions. Examples: “-k 1.3” matches all tests parametrized with 1.3. “-k None” filters all tests that have “None” in their name and conversely “-k ‘not None’”. Previously these examples would raise syntax errors.

fix issue384 by removing the trial support code since the unittest compat enhancements allow trial to handle it on its own

don’t hide an ImportError when importing a plugin produces one. fixes issue375.

fix issue275 - allow usefixtures and autouse fixtures for running doctest text files.

fix issue380 by making –resultlog only rely on longrepr instead of the “reprcrash” attribute which only exists sometimes.

address issue122: allow @pytest.fixture(params=iterator) by exploding into a list early on.

fix pexpect-3.0 compatibility for pytest’s own tests. (fixes issue386)

allow nested parametrize-value markers, thanks James Lan for the PR.

fix unicode handling with new monkeypatch.setattr(import_path, value) API. Thanks Rob Dennis. Fixes issue371.

fix unicode handling with junitxml, fixes issue368.

In assertion rewriting mode on Python 2, fix the detection of coding cookies. See issue #330.

make “–runxfail” turn imperative pytest.xfail calls into no ops (it already did neutralize pytest.mark.xfail markers)

refine pytest / pkg_resources interactions: The AssertionRewritingHook PEP 302 compliant loader now registers itself with setuptools/pkg_resources properly so that the pkg_resources.resource_stream method works properly. Fixes issue366. Thanks for the investigations and full PR to Jason R. Coombs.

pytestconfig fixture is now session-scoped as it is the same object during the whole test run. Fixes issue370.

avoid one surprising case of marker malfunction/confusion:

@pytest . mark . some ( lambda arg : ... ) def test_function ():

would not work correctly because pytest assumes @pytest.mark.some gets a function to be decorated already. We now at least detect if this arg is a lambda and thus the example will work. Thanks Alex Gaynor for bringing it up.

xfail a test on pypy that checks wrong encoding/ascii (pypy does not error out). fixes issue385.

internally make varnames() deal with classes’s init, although it’s not needed by pytest itself atm. Also fix caching. Fixes issue376.

fix issue221 - handle importing of namespace-package with no init.py properly.

refactor internal FixtureRequest handling to avoid monkeypatching. One of the positive user-facing effects is that the “request” object can now be used in closures.

fixed version comparison in pytest.importskip(modname, minverstring)

fix issue377 by clarifying in the nose-compat docs that pytest does not duplicate the unittest-API into the “plain” namespace.

fix verbose reporting for @mock’d test functions

on Windows require colorama and a newer py lib so that py.io.TerminalWriter() now uses colorama instead of its own ctypes hacks. (fixes issue365) thanks Paul Moore for bringing it up.

fix “-k” matching of tests where “repr” and “attr” and other names would cause wrong matches because of an internal implementation quirk (don’t ask) which is now properly implemented. fixes issue345.

avoid tmpdir fixture to create too long filenames especially when parametrization is used (issue354)

fix pytest-pep8 and pytest-flakes / pytest interactions (collection names in mark plugin was assuming an item always has a function which is not true for those plugins etc.) Thanks Andi Zeidler.

introduce node.get_marker/node.add_marker API for plugins like pytest-pep8 and pytest-flakes to avoid the messy details of the node.keywords pseudo-dicts. Adapted docs.

remove attempt to “dup” stdout at startup as it’s icky. the normal capturing should catch enough possibilities of tests messing up standard FDs.

add pluginmanager.do_configure(config) as a link to config.do_configure() for plugin-compatibility

When using parser.addoption() unicode arguments to the “type” keyword should also be converted to the respective types. thanks Floris Bruynooghe, @dnozay. (fixes issue360 and issue362)

fix dotted filename completion when using argcomplete thanks Anthon van der Neuth. (fixes issue361)

fix regression when a 1-tuple (“arg”,) is used for specifying parametrization (the values of the parametrization were passed nested in a tuple). Thanks Donald Stufft.

merge doc typo fixes, thanks Andy Dirnberger

fix issue169: respect –tb=style with setup/teardown errors as well.

never consider a fixture function for test function collection

allow re-running of test items / helps to fix pytest-reruntests plugin and also help to keep less fixture/resource references alive

put captured stdout/stderr into junitxml output even for passing tests (thanks Adam Goucher)

Issue 265 - integrate nose setup/teardown with setupstate so it doesn’t try to teardown if it did not setup

issue 271 - don’t write junitxml on worker nodes

Issue 274 - don’t try to show full doctest example when doctest does not know the example location

issue 280 - disable assertion rewriting on buggy CPython 2.6.0

inject “getfixture()” helper to retrieve fixtures from doctests, thanks Andreas Zeidler

issue 259 - when assertion rewriting, be consistent with the default source encoding of ASCII on Python 2

issue 251 - report a skip instead of ignoring classes with init

issue250 unicode/str mixes in parametrization names and values now works

issue257, assertion-triggered compilation of source ending in a comment line doesn’t blow up in python2.5 (fixed through py>=1.4.13.dev6)

fix –genscript option to generate standalone scripts that also work with python3.3 (importer ordering)

issue171 - in assertion rewriting, show the repr of some global variables

fix option help for “-k”

move long description of distribution into README.rst

improve docstring for metafunc.parametrize()

fix bug where using capsys with pytest.set_trace() in a test function would break when looking at capsys.readouterr()

allow to specify prefixes starting with “_” when customizing python_functions test discovery. (thanks Graham Horler)

improve PYTEST_DEBUG tracing output by putting extra data on a new lines with additional indent

ensure OutcomeExceptions like skip/fail have initialized exception attributes

issue 260 - don’t use nose special setup on plain unittest cases

fix issue134 - print the collect errors that prevent running specified test items

fix issue266 - accept unicode in MarkEvaluator expressions

yielded test functions will now have autouse-fixtures active but cannot accept fixtures as funcargs - it’s anyway recommended to rather use the post-2.0 parametrize features instead of yield, see: http://pytest.org/en/stable/example/how-to/parametrize.html

fix autouse-issue where autouse-fixtures would not be discovered if defined in an a/conftest.py file and tests in a/tests/test_some.py

fix issue226 - LIFO ordering for fixture teardowns

fix issue224 - invocations with >256 char arguments now work

fix issue91 - add/discuss package/directory level setups in example

allow to dynamically define markers via item.keywords[…]=assignment integrating with “-m” option

make “-k” accept an expressions the same as with “-m” so that one can write: -k “name1 or name2” etc. This is a slight incompatibility if you used special syntax like “TestClass.test_method” which you now need to write as -k “TestClass and test_method” to match a certain method in a certain test class.