From 49f934618c79465ba960f238d6ed35c151489dd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oleg=20H=C3=B6fling?= Date: Sat, 6 Nov 2021 10:16:11 +0100 Subject: [PATCH] Replace hardcoded links to Github issues with extlinks (#9234) --- doc/en/adopt.rst | 3 +- doc/en/announce/release-2.9.0.rst | 28 +- doc/en/announce/release-2.9.1.rst | 13 +- doc/en/announce/release-2.9.2.rst | 6 +- doc/en/backwards-compatibility.rst | 9 +- doc/en/changelog.rst | 2516 ++++++++++++---------------- doc/en/conf.py | 2 + doc/en/deprecations.rst | 2 +- doc/en/explanation/fixtures.rst | 2 +- doc/en/historical-notes.rst | 26 +- doc/en/how-to/capture-warnings.rst | 3 +- doc/en/how-to/fixtures.rst | 2 +- doc/en/how-to/logging.rst | 3 +- doc/en/how-to/monkeypatch.rst | 2 +- doc/en/how-to/nose.rst | 5 +- doc/en/py27-py34-deprecation.rst | 2 +- doc/en/reference/customize.rst | 2 +- doc/en/reference/reference.rst | 3 +- src/_pytest/junitxml.py | 4 +- src/_pytest/monkeypatch.py | 2 +- 20 files changed, 1160 insertions(+), 1475 deletions(-) diff --git a/doc/en/adopt.rst b/doc/en/adopt.rst index 82e2111ed..13d82bf01 100644 --- a/doc/en/adopt.rst +++ b/doc/en/adopt.rst @@ -10,10 +10,9 @@ Are you an enthusiastic pytest user, the local testing guru in your workplace? O We will pair experienced pytest users with open source projects, for a month's effort of getting new development teams started with pytest. -In 2015 we are trying this for the first time. In February and March 2015 we will gather volunteers on both sides, in April we will do the work, and in May we will evaluate how it went. This effort is being coordinated by Brianna Laugher. If you have any questions or comments, you can raise them on the `@pytestdotorg twitter account `_ the `issue tracker`_ or the `pytest-dev mailing list`_. +In 2015 we are trying this for the first time. In February and March 2015 we will gather volunteers on both sides, in April we will do the work, and in May we will evaluate how it went. This effort is being coordinated by Brianna Laugher. If you have any questions or comments, you can raise them on the `@pytestdotorg twitter account `_\, the :issue:`issue tracker <676>` or the `pytest-dev mailing list`_. -.. _`issue tracker`: https://github.com/pytest-dev/pytest/issues/676 .. _`pytest-dev mailing list`: https://mail.python.org/mailman/listinfo/pytest-dev diff --git a/doc/en/announce/release-2.9.0.rst b/doc/en/announce/release-2.9.0.rst index 9448af58c..1d2608800 100644 --- a/doc/en/announce/release-2.9.0.rst +++ b/doc/en/announce/release-2.9.0.rst @@ -56,17 +56,17 @@ The py.test Development Team * ``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`_). + Thanks `@rabbbit`_ for the request and `@nicoddemus`_ for the PR (:issue:`1355`). * ``Parser.addini`` now supports options of type ``bool``. Thanks `@nicoddemus`_ for the PR. * New ``ALLOW_BYTES`` doctest option strips ``b`` prefixes from byte strings in doctest output (similar to ``ALLOW_UNICODE``). - Thanks `@jaraco`_ for the request and `@nicoddemus`_ for the PR (`#1287`_). + Thanks `@jaraco`_ for the request and `@nicoddemus`_ for the PR (:issue:`1287`). * give a hint on KeyboardInterrupt to use the --fulltrace option to show the errors, - this fixes `#1366`_. + this fixes :issue:`1366`. Thanks to `@hpk42`_ for the report and `@RonnyPfannschmidt`_ for the PR. * catch IndexError exceptions when getting exception source location. This fixes @@ -95,7 +95,7 @@ The py.test Development Team * 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`_). + Thanks `@nicoddemus`_ for the PR (:issue:`1226`). * Comparisons now always show up in full when ``CI`` or ``BUILD_NUMBER`` is found in the environment, even when -vv isn't used. @@ -109,40 +109,32 @@ The py.test Development Team * 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`_). + colors in CI integrations systems (:issue:`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`_). + Thanks to `@bukzor`_ for the complete PR (:issue:`680`). -* Fix (`#1290`_): support Python 3.5's ``@`` operator in assertion rewriting. +* Fix (:issue:`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`_). +* Fix formatting utf-8 explanation messages (:issue:`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 +* Fix (:issue:`1422`): junit record_xml_property doesn't allow multiple records with same name. .. _`traceback style docs`: https://pytest.org/en/stable/how-to/output.html#modifying-python-traceback-printing -.. _#1422: https://github.com/pytest-dev/pytest/issues/1422 -.. _#1379: https://github.com/pytest-dev/pytest/issues/1379 -.. _#1366: https://github.com/pytest-dev/pytest/issues/1366 .. _#1040: https://github.com/pytest-dev/pytest/pull/1040 -.. _#680: https://github.com/pytest-dev/pytest/issues/680 -.. _#1287: https://github.com/pytest-dev/pytest/pull/1287 -.. _#1226: https://github.com/pytest-dev/pytest/pull/1226 -.. _#1290: https://github.com/pytest-dev/pytest/pull/1290 -.. _#1355: https://github.com/pytest-dev/pytest/pull/1355 -.. _#1397: https://github.com/pytest-dev/pytest/issues/1397 + .. _@biern: https://github.com/biern .. _@MichaelAquilina: https://github.com/MichaelAquilina .. _@bukzor: https://github.com/bukzor diff --git a/doc/en/announce/release-2.9.1.rst b/doc/en/announce/release-2.9.1.rst index 47bc2e6d3..8b9a62fe2 100644 --- a/doc/en/announce/release-2.9.1.rst +++ b/doc/en/announce/release-2.9.1.rst @@ -39,28 +39,25 @@ The py.test Development Team * Improve error message when a plugin fails to load. Thanks `@nicoddemus`_ for the PR. -* Fix (`#1178 `_): +* Fix (:issue:`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 +* Fix (:issue:`469`): junit parses report.nodeid incorrectly, when params IDs contain ``::``. Thanks `@tomviner`_ for the PR (`#1431`_). -* Fix (`#578 `_): SyntaxErrors +* Fix (:issue:`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 +* Fix (:issue:`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 (:issue:`649`): parametrized test nodes cannot be specified to run on the command line. -.. _#1437: https://github.com/pytest-dev/pytest/issues/1437 -.. _#469: https://github.com/pytest-dev/pytest/issues/469 .. _#1431: https://github.com/pytest-dev/pytest/pull/1431 -.. _#649: https://github.com/pytest-dev/pytest/issues/649 .. _@asottile: https://github.com/asottile .. _@nicoddemus: https://github.com/nicoddemus diff --git a/doc/en/announce/release-2.9.2.rst b/doc/en/announce/release-2.9.2.rst index ffd8dc58e..eb9a1b0dc 100644 --- a/doc/en/announce/release-2.9.2.rst +++ b/doc/en/announce/release-2.9.2.rst @@ -39,11 +39,11 @@ The py.test Development Team **Bug Fixes** -* fix `#510`_: skip tests where one parameterize dimension was empty +* fix :issue:`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`_ + Thanks `@astraw38`_ for reporting the issue (:issue:`1496`) and `@tomviner`_ for PR the (`#1524`_). * Fix win32 path issue when putting custom config file with absolute path @@ -64,9 +64,7 @@ The py.test Development Team one per fixture name. Thanks to `@hackebrot`_ for the PR. -.. _#510: https://github.com/pytest-dev/pytest/issues/510 .. _#1506: https://github.com/pytest-dev/pytest/pull/1506 -.. _#1496: https://github.com/pytest-dev/pytest/issues/1496 .. _#1524: https://github.com/pytest-dev/pytest/pull/1524 .. _@astraw38: https://github.com/astraw38 diff --git a/doc/en/backwards-compatibility.rst b/doc/en/backwards-compatibility.rst index 7b3027e79..0c3521533 100644 --- a/doc/en/backwards-compatibility.rst +++ b/doc/en/backwards-compatibility.rst @@ -30,15 +30,15 @@ c) true breakage: should only be considered when normal transition is unreasonab Examples for such upcoming changes: - * removal of ``pytest_runtest_protocol/nextitem`` - `#895`_ + * removal of ``pytest_runtest_protocol/nextitem`` - :issue:`895` * rearranging of the node tree to include ``FunctionDefinition`` - * rearranging of ``SetupState`` `#895`_ + * rearranging of ``SetupState`` :issue:`895` True breakages must be announced first in an issue containing: * Detailed description of the change * Rationale - * Expected impact on users and plugin authors (example in `#895`_) + * Expected impact on users and plugin authors (example in :issue:`895`) After there's no hard *-1* on the issue it should be followed up by an initial proof-of-concept Pull Request. @@ -75,6 +75,3 @@ Deprecation Roadmap Features currently deprecated and removed in previous releases can be found in :ref:`deprecations`. We track future deprecation and removal of features using milestones and the `deprecation `_ and `removal `_ labels on GitHub. - - -.. _`#895`: https://github.com/pytest-dev/pytest/issues/895 diff --git a/doc/en/changelog.rst b/doc/en/changelog.rst index 8736ac4b6..2d11fb5cf 100644 --- a/doc/en/changelog.rst +++ b/doc/en/changelog.rst @@ -35,10 +35,10 @@ pytest 6.2.5 (2021-08-29) Trivial/Internal Changes ------------------------ -- `#8494 `_: Python 3.10 is now supported. +- :issue:`8494`: Python 3.10 is now supported. -- `#9040 `_: Enable compatibility with ``pluggy 1.0`` or later. +- :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. pytest 6.2.4 (2021-05-04) @@ -47,7 +47,7 @@ pytest 6.2.4 (2021-05-04) Bug Fixes --------- -- `#8539 `_: Fixed assertion rewriting on Python 3.10. +- :issue:`8539`: Fixed assertion rewriting on Python 3.10. pytest 6.2.3 (2021-04-03) @@ -56,7 +56,7 @@ pytest 6.2.3 (2021-04-03) Bug Fixes --------- -- `#8414 `_: pytest used to create directories under ``/tmp`` with world-readable +- :issue:`8414`: pytest used to create directories under ``/tmp`` with world-readable permissions. This means that any user in the system was able to read information written by tests in temporary directories (such as those created by the ``tmp_path``/``tmpdir`` fixture). Now the directories are created with @@ -74,10 +74,10 @@ pytest 6.2.2 (2021-01-25) Bug Fixes --------- -- `#8152 `_: Fixed "()" being shown as a skip reason in the verbose test summary line when the reason is empty. +- :issue:`8152`: Fixed "()" being shown as a skip reason in the verbose test summary line when the reason is empty. -- `#8249 `_: Fix the ``faulthandler`` plugin for occasions when running with ``twisted.logger`` and using ``pytest --capture=no``. +- :issue:`8249`: Fix the ``faulthandler`` plugin for occasions when running with ``twisted.logger`` and using ``pytest --capture=no``. pytest 6.2.1 (2020-12-15) @@ -86,11 +86,11 @@ pytest 6.2.1 (2020-12-15) Bug Fixes --------- -- `#7678 `_: Fixed bug where ``ImportPathMismatchError`` would be raised for files compiled in +- :issue:`7678`: Fixed bug where ``ImportPathMismatchError`` would be raised for files compiled in the host and loaded later from an UNC mounted path (Windows). -- `#8132 `_: Fixed regression in ``approx``: in 6.2.0 ``approx`` no longer raises +- :issue:`8132`: Fixed regression in ``approx``: in 6.2.0 ``approx`` no longer raises ``TypeError`` when dealing with non-numeric types, falling back to normal comparison. Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case, and happened to compare correctly to a scalar if they had only one element. @@ -108,14 +108,14 @@ pytest 6.2.0 (2020-12-12) Breaking Changes ---------------- -- `#7808 `_: pytest now supports python3.6+ only. +- :issue:`7808`: pytest now supports python3.6+ only. Deprecations ------------ -- `#7469 `_: Directly constructing/calling the following classes/functions is now deprecated: +- :issue:`7469`: Directly constructing/calling the following classes/functions is now deprecated: - ``_pytest.cacheprovider.Cache`` - ``_pytest.cacheprovider.Cache.for_config()`` @@ -135,13 +135,13 @@ Deprecations These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8.0.0. -- `#7530 `_: The ``--strict`` command-line option has been deprecated, use ``--strict-markers`` instead. +- :issue:`7530`: The ``--strict`` command-line option has been deprecated, use ``--strict-markers`` instead. We have plans to maybe in the future to reintroduce ``--strict`` and make it an encompassing flag for all strictness related options (``--strict-markers`` and ``--strict-config`` at the moment, more might be introduced in the future). -- `#7988 `_: The ``@pytest.yield_fixture`` decorator/function is now deprecated. Use :func:`pytest.fixture` instead. +- :issue:`7988`: The ``@pytest.yield_fixture`` decorator/function is now deprecated. Use :func:`pytest.fixture` instead. ``yield_fixture`` has been an alias for ``fixture`` for a very long time, so can be search/replaced safely. @@ -150,18 +150,18 @@ Deprecations Features -------- -- `#5299 `_: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8. +- :issue:`5299`: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8. See :ref:`unraisable` for more information. -- `#7425 `_: New :fixture:`pytester` fixture, which is identical to :fixture:`testdir` but its methods return :class:`pathlib.Path` when appropriate instead of ``py.path.local``. +- :issue:`7425`: New :fixture:`pytester` fixture, which is identical to :fixture:`testdir` but its methods return :class:`pathlib.Path` when appropriate instead of ``py.path.local``. This is part of the movement to use :class:`pathlib.Path` objects internally, in order to remove the dependency to ``py`` in the future. Internally, the old :class:`Testdir <_pytest.pytester.Testdir>` is now a thin wrapper around :class:`Pytester <_pytest.pytester.Pytester>`, preserving the old interface. -- `#7695 `_: A new hook was added, `pytest_markeval_namespace` which should return a dictionary. +- :issue:`7695`: A new hook was added, `pytest_markeval_namespace` which should return a dictionary. This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers. Pseudo example @@ -182,7 +182,7 @@ Features assert False -- `#8006 `_: It is now possible to construct a :class:`~pytest.MonkeyPatch` object directly as ``pytest.MonkeyPatch()``, +- :issue:`8006`: It is now possible to construct a :class:`~pytest.MonkeyPatch` object directly as ``pytest.MonkeyPatch()``, in cases when the :fixture:`monkeypatch` fixture cannot be used. Previously some users imported it from the private `_pytest.monkeypatch.MonkeyPatch` namespace. @@ -196,13 +196,13 @@ Features Improvements ------------ -- `#1265 `_: Added an ``__str__`` implementation to the :class:`~pytest.pytester.LineMatcher` class which is returned from ``pytester.run_pytest().stdout`` and similar. It returns the entire output, like the existing ``str()`` method. +- :issue:`1265`: Added an ``__str__`` implementation to the :class:`~pytest.pytester.LineMatcher` class which is returned from ``pytester.run_pytest().stdout`` and similar. It returns the entire output, like the existing ``str()`` method. -- `#2044 `_: Verbose mode now shows the reason that a test was skipped in the test's terminal line after the "SKIPPED", "XFAIL" or "XPASS". +- :issue:`2044`: Verbose mode now shows the reason that a test was skipped in the test's terminal line after the "SKIPPED", "XFAIL" or "XPASS". -- `#7469 `_ The types of builtin pytest fixtures are now exported so they may be used in type annotations of test functions. +- :issue:`7469` The types of builtin pytest fixtures are now exported so they may be used in type annotations of test functions. The newly-exported types are: - ``pytest.FixtureRequest`` for the :fixture:`request` fixture. @@ -223,79 +223,79 @@ Improvements Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. -- `#7527 `_: When a comparison between :func:`namedtuple ` instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes. +- :issue:`7527`: When a comparison between :func:`namedtuple ` instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes. -- `#7615 `_: :meth:`Node.warn <_pytest.nodes.Node.warn>` now permits any subclass of :class:`Warning`, not just :class:`PytestWarning `. +- :issue:`7615`: :meth:`Node.warn <_pytest.nodes.Node.warn>` now permits any subclass of :class:`Warning`, not just :class:`PytestWarning `. -- `#7701 `_: Improved reporting when using ``--collected-only``. It will now show the number of collected tests in the summary stats. +- :issue:`7701`: Improved reporting when using ``--collected-only``. It will now show the number of collected tests in the summary stats. -- `#7710 `_: Use strict equality comparison for non-numeric types in :func:`pytest.approx` instead of +- :issue:`7710`: Use strict equality comparison for non-numeric types in :func:`pytest.approx` instead of raising :class:`TypeError`. This was the undocumented behavior before 3.7, but is now officially a supported feature. -- `#7938 `_: New ``--sw-skip`` argument which is a shorthand for ``--stepwise-skip``. +- :issue:`7938`: New ``--sw-skip`` argument which is a shorthand for ``--stepwise-skip``. -- `#8023 `_: Added ``'node_modules'`` to default value for :confval:`norecursedirs`. +- :issue:`8023`: Added ``'node_modules'`` to default value for :confval:`norecursedirs`. -- `#8032 `_: :meth:`doClassCleanups ` (introduced in :mod:`unittest` in Python and 3.8) is now called appropriately. +- :issue:`8032`: :meth:`doClassCleanups ` (introduced in :mod:`unittest` in Python and 3.8) is now called appropriately. Bug Fixes --------- -- `#4824 `_: Fixed quadratic behavior and improved performance of collection of items using autouse fixtures and xunit fixtures. +- :issue:`4824`: Fixed quadratic behavior and improved performance of collection of items using autouse fixtures and xunit fixtures. -- `#7758 `_: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0. +- :issue:`7758`: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0. -- `#7911 `_: Directories created by by :fixture:`tmp_path` and :fixture:`tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites. +- :issue:`7911`: Directories created by by :fixture:`tmp_path` and :fixture:`tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites. -- `#7913 `_: Fixed a crash or hang in :meth:`pytester.spawn <_pytest.pytester.Pytester.spawn>` when the :mod:`readline` module is involved. +- :issue:`7913`: Fixed a crash or hang in :meth:`pytester.spawn <_pytest.pytester.Pytester.spawn>` when the :mod:`readline` module is involved. -- `#7951 `_: Fixed handling of recursive symlinks when collecting tests. +- :issue:`7951`: Fixed handling of recursive symlinks when collecting tests. -- `#7981 `_: Fixed symlinked directories not being followed during collection. Regressed in pytest 6.1.0. +- :issue:`7981`: Fixed symlinked directories not being followed during collection. Regressed in pytest 6.1.0. -- `#8016 `_: Fixed only one doctest being collected when using ``pytest --doctest-modules path/to/an/__init__.py``. +- :issue:`8016`: Fixed only one doctest being collected when using ``pytest --doctest-modules path/to/an/__init__.py``. Improved Documentation ---------------------- -- `#7429 `_: Add more information and use cases about skipping doctests. +- :issue:`7429`: Add more information and use cases about skipping doctests. -- `#7780 `_: Classes which should not be inherited from are now marked ``final class`` in the API reference. +- :issue:`7780`: Classes which should not be inherited from are now marked ``final class`` in the API reference. -- `#7872 `_: ``_pytest.config.argparsing.Parser.addini()`` accepts explicit ``None`` and ``"string"``. +- :issue:`7872`: ``_pytest.config.argparsing.Parser.addini()`` accepts explicit ``None`` and ``"string"``. -- `#7878 `_: In pull request section, ask to commit after editing changelog and authors file. +- :issue:`7878`: In pull request section, ask to commit after editing changelog and authors file. Trivial/Internal Changes ------------------------ -- `#7802 `_: The ``attrs`` dependency requirement is now >=19.2.0 instead of >=17.4.0. +- :issue:`7802`: The ``attrs`` dependency requirement is now >=19.2.0 instead of >=17.4.0. -- `#8014 `_: `.pyc` files created by pytest's assertion rewriting now conform to the newer :pep:`552` format on Python>=3.7. +- :issue:`8014`: `.pyc` files created by pytest's assertion rewriting now conform to the newer :pep:`552` format on Python>=3.7. (These files are internal and only interpreted by pytest itself.) @@ -305,17 +305,17 @@ pytest 6.1.2 (2020-10-28) Bug Fixes --------- -- `#7758 `_: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0. +- :issue:`7758`: Fixed an issue where some files in packages are getting lost from ``--lf`` even though they contain tests that failed. Regressed in pytest 5.4.0. -- `#7911 `_: Directories created by `tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites. +- :issue:`7911`: Directories created by `tmpdir` are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites. Improved Documentation ---------------------- -- `#7815 `_: Improve deprecation warning message for ``pytest._fillfuncargs()``. +- :issue:`7815`: Improve deprecation warning message for ``pytest._fillfuncargs()``. pytest 6.1.1 (2020-10-03) @@ -324,10 +324,10 @@ pytest 6.1.1 (2020-10-03) Bug Fixes --------- -- `#7807 `_: Fixed regression in pytest 6.1.0 causing incorrect rootdir to be determined in some non-trivial cases where parent directories have config files as well. +- :issue:`7807`: Fixed regression in pytest 6.1.0 causing incorrect rootdir to be determined in some non-trivial cases where parent directories have config files as well. -- `#7814 `_: Fixed crash in header reporting when :confval:`testpaths` is used and contains absolute paths (regression in 6.1.0). +- :issue:`7814`: Fixed crash in header reporting when :confval:`testpaths` is used and contains absolute paths (regression in 6.1.0). pytest 6.1.0 (2020-09-26) @@ -336,7 +336,7 @@ pytest 6.1.0 (2020-09-26) Breaking Changes ---------------- -- `#5585 `_: As per our policy, the following features which have been deprecated in the 5.X series are now +- :issue:`5585`: As per our policy, the following features which have been deprecated in the 5.X series are now removed: * The ``funcargnames`` read-only property of ``FixtureRequest``, ``Metafunc``, and ``Function`` classes. Use ``fixturenames`` attribute. @@ -359,10 +359,10 @@ Breaking Changes Deprecations ------------ -- `#6981 `_: The ``pytest.collect`` module is deprecated: all its names can be imported from ``pytest`` directly. +- :issue:`6981`: The ``pytest.collect`` module is deprecated: all its names can be imported from ``pytest`` directly. -- `#7097 `_: The ``pytest._fillfuncargs`` function is deprecated. This function was kept +- :issue:`7097`: The ``pytest._fillfuncargs`` function is deprecated. This function was kept for backward compatibility with an older plugin. It's functionality is not meant to be used directly, but if you must replace @@ -370,18 +370,18 @@ Deprecations a public API and may break in the future. -- `#7210 `_: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'`` +- :issue:`7210`: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'`` instead. The special ``-k 'expr:'`` syntax to ``-k`` is deprecated. Please open an issue if you use this and want a replacement. -- `#7255 `_: The :func:`pytest_warning_captured <_pytest.hookspec.pytest_warning_captured>` hook is deprecated in favor +- :issue:`7255`: The :func:`pytest_warning_captured <_pytest.hookspec.pytest_warning_captured>` hook is deprecated in favor of :func:`pytest_warning_recorded <_pytest.hookspec.pytest_warning_recorded>`, and will be removed in a future version. -- `#7648 `_: The ``gethookproxy()`` and ``isinitpath()`` methods of ``FSCollector`` and ``Package`` are deprecated; +- :issue:`7648`: The ``gethookproxy()`` and ``isinitpath()`` methods of ``FSCollector`` and ``Package`` are deprecated; use ``self.session.gethookproxy()`` and ``self.session.isinitpath()`` instead. This should work on all pytest versions. @@ -390,27 +390,27 @@ Deprecations Features -------- -- `#7667 `_: New ``--durations-min`` command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by ``--durations``. Previously this was hard-coded to ``0.005s``. +- :issue:`7667`: New ``--durations-min`` command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by ``--durations``. Previously this was hard-coded to ``0.005s``. Improvements ------------ -- `#6681 `_: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through :confval:`filterwarnings` or ``--pythonwarnings/-W``. +- :issue:`6681`: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through :confval:`filterwarnings` or ``--pythonwarnings/-W``. - This also fixes a number of long standing issues: `#2891 `__, `#7620 `__, `#7426 `__. + This also fixes a number of long standing issues: :issue:`2891`, :issue:`7620`, :issue:`7426`. -- `#7572 `_: When a plugin listed in ``required_plugins`` is missing or an unknown config key is used with ``--strict-config``, a simple error message is now shown instead of a stacktrace. +- :issue:`7572`: When a plugin listed in ``required_plugins`` is missing or an unknown config key is used with ``--strict-config``, a simple error message is now shown instead of a stacktrace. -- `#7685 `_: Added two new attributes :attr:`rootpath <_pytest.config.Config.rootpath>` and :attr:`inipath <_pytest.config.Config.inipath>` to :class:`Config <_pytest.config.Config>`. +- :issue:`7685`: Added two new attributes :attr:`rootpath <_pytest.config.Config.rootpath>` and :attr:`inipath <_pytest.config.Config.inipath>` to :class:`Config <_pytest.config.Config>`. These attributes are :class:`pathlib.Path` versions of the existing :attr:`rootdir <_pytest.config.Config.rootdir>` and :attr:`inifile <_pytest.config.Config.inifile>` attributes, and should be preferred over them when possible. -- `#7780 `_: Public classes which are not designed to be inherited from are now marked :func:`@final `. +- :issue:`7780`: Public classes which are not designed to be inherited from are now marked :func:`@final `. Code which inherits from these classes will trigger a type-checking (e.g. mypy) error, but will still work in runtime. Currently the ``final`` designation does not appear in the API Reference but hopefully will in the future. @@ -419,7 +419,7 @@ Improvements Bug Fixes --------- -- `#1953 `_: Fixed error when overwriting a parametrized fixture, while also reusing the super fixture value. +- :issue:`1953`: Fixed error when overwriting a parametrized fixture, while also reusing the super fixture value. .. code-block:: python @@ -441,47 +441,47 @@ Bug Fixes return foo * 2 -- `#4984 `_: Fixed an internal error crash with ``IndexError: list index out of range`` when +- :issue:`4984`: Fixed an internal error crash with ``IndexError: list index out of range`` when collecting a module which starts with a decorated function, the decorator raises, and assertion rewriting is enabled. -- `#7591 `_: pylint shouldn't complain anymore about unimplemented abstract methods when inheriting from :ref:`File `. +- :issue:`7591`: pylint shouldn't complain anymore about unimplemented abstract methods when inheriting from :ref:`File `. -- `#7628 `_: Fixed test collection when a full path without a drive letter was passed to pytest on Windows (for example ``\projects\tests\test.py`` instead of ``c:\projects\tests\pytest.py``). +- :issue:`7628`: Fixed test collection when a full path without a drive letter was passed to pytest on Windows (for example ``\projects\tests\test.py`` instead of ``c:\projects\tests\pytest.py``). -- `#7638 `_: Fix handling of command-line options that appear as paths but trigger an OS-level syntax error on Windows, such as the options used internally by ``pytest-xdist``. +- :issue:`7638`: Fix handling of command-line options that appear as paths but trigger an OS-level syntax error on Windows, such as the options used internally by ``pytest-xdist``. -- `#7742 `_: Fixed INTERNALERROR when accessing locals / globals with faulty ``exec``. +- :issue:`7742`: Fixed INTERNALERROR when accessing locals / globals with faulty ``exec``. Improved Documentation ---------------------- -- `#1477 `_: Removed faq.rst and its reference in contents.rst. +- :issue:`1477`: Removed faq.rst and its reference in contents.rst. Trivial/Internal Changes ------------------------ -- `#7536 `_: The internal ``junitxml`` plugin has rewritten to use ``xml.etree.ElementTree``. +- :issue:`7536`: The internal ``junitxml`` plugin has rewritten to use ``xml.etree.ElementTree``. The order of attributes in XML elements might differ. Some unneeded escaping is no longer performed. -- `#7587 `_: The dependency on the ``more-itertools`` package has been removed. +- :issue:`7587`: The dependency on the ``more-itertools`` package has been removed. -- `#7631 `_: The result type of :meth:`capfd.readouterr() <_pytest.capture.CaptureFixture.readouterr>` (and similar) is no longer a namedtuple, +- :issue:`7631`: The result type of :meth:`capfd.readouterr() <_pytest.capture.CaptureFixture.readouterr>` (and similar) is no longer a namedtuple, but should behave like one in all respects. This was done for technical reasons. -- `#7671 `_: When collecting tests, pytest finds test classes and functions by examining the +- :issue:`7671`: When collecting tests, pytest finds test classes and functions by examining the attributes of python objects (modules, classes and instances). To speed up this process, pytest now ignores builtin attributes (like ``__class__``, ``__delattr__`` and ``__new__``) without consulting the :confval:`python_classes` and @@ -495,17 +495,17 @@ pytest 6.0.2 (2020-09-04) Bug Fixes --------- -- `#7148 `_: Fixed ``--log-cli`` potentially causing unrelated ``print`` output to be swallowed. +- :issue:`7148`: Fixed ``--log-cli`` potentially causing unrelated ``print`` output to be swallowed. -- `#7672 `_: Fixed log-capturing level restored incorrectly if ``caplog.set_level`` is called more than once. +- :issue:`7672`: Fixed log-capturing level restored incorrectly if ``caplog.set_level`` is called more than once. -- `#7686 `_: Fixed `NotSetType.token` being used as the parameter ID when the parametrization list is empty. +- :issue:`7686`: Fixed `NotSetType.token` being used as the parameter ID when the parametrization list is empty. Regressed in pytest 6.0.0. -- `#7707 `_: Fix internal error when handling some exceptions that contain multiple lines or the style uses multiple lines (``--tb=line`` for example). +- :issue:`7707`: Fix internal error when handling some exceptions that contain multiple lines or the style uses multiple lines (``--tb=line`` for example). pytest 6.0.1 (2020-07-30) @@ -514,18 +514,18 @@ pytest 6.0.1 (2020-07-30) Bug Fixes --------- -- `#7394 `_: Passing an empty ``help`` value to ``Parser.add_option`` is now accepted instead of crashing when running ``pytest --help``. +- :issue:`7394`: Passing an empty ``help`` value to ``Parser.add_option`` is now accepted instead of crashing when running ``pytest --help``. Passing ``None`` raises a more informative ``TypeError``. -- `#7558 `_: Fix pylint ``not-callable`` lint on ``pytest.mark.parametrize()`` and the other builtin marks: +- :issue:`7558`: Fix pylint ``not-callable`` lint on ``pytest.mark.parametrize()`` and the other builtin marks: ``skip``, ``skipif``, ``xfail``, ``usefixtures``, ``filterwarnings``. -- `#7559 `_: Fix regression in plugins using ``TestReport.longreprtext`` (such as ``pytest-html``) when ``TestReport.longrepr`` is not a string. +- :issue:`7559`: Fix regression in plugins using ``TestReport.longreprtext`` (such as ``pytest-html``) when ``TestReport.longrepr`` is not a string. -- `#7569 `_: Fix logging capture handler's level not reset on teardown after a call to ``caplog.set_level()``. +- :issue:`7569`: Fix logging capture handler's level not reset on teardown after a call to ``caplog.set_level()``. pytest 6.0.0 (2020-07-28) @@ -536,7 +536,7 @@ pytest 6.0.0 (2020-07-28) Breaking Changes ---------------- -- `#5584 `_: **PytestDeprecationWarning are now errors by default.** +- :issue:`5584`: **PytestDeprecationWarning are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestDeprecationWarning`` now generate errors @@ -557,61 +557,61 @@ Breaking Changes But this will stop working when pytest ``6.1`` is released. **If you have concerns** about the removal of a specific feature, please add a - comment to `#5584 `__. + comment to :issue:`5584`. -- `#7472 `_: The ``exec_()`` and ``is_true()`` methods of ``_pytest._code.Frame`` have been removed. +- :issue:`7472`: The ``exec_()`` and ``is_true()`` methods of ``_pytest._code.Frame`` have been removed. Features -------- -- `#7464 `_: Added support for :envvar:`NO_COLOR` and :envvar:`FORCE_COLOR` environment variables to control colored output. +- :issue:`7464`: Added support for :envvar:`NO_COLOR` and :envvar:`FORCE_COLOR` environment variables to control colored output. Improvements ------------ -- `#7467 `_: ``--log-file`` CLI option and ``log_file`` ini marker now create subdirectories if needed. +- :issue:`7467`: ``--log-file`` CLI option and ``log_file`` ini marker now create subdirectories if needed. -- `#7489 `_: The :func:`pytest.raises` function has a clearer error message when ``match`` equals the obtained string but is not a regex match. In this case it is suggested to escape the regex. +- :issue:`7489`: The :func:`pytest.raises` function has a clearer error message when ``match`` equals the obtained string but is not a regex match. In this case it is suggested to escape the regex. Bug Fixes --------- -- `#7392 `_: Fix the reported location of tests skipped with ``@pytest.mark.skip`` when ``--runxfail`` is used. +- :issue:`7392`: Fix the reported location of tests skipped with ``@pytest.mark.skip`` when ``--runxfail`` is used. -- `#7491 `_: :fixture:`tmpdir` and :fixture:`tmp_path` no longer raise an error if the lock to check for +- :issue:`7491`: :fixture:`tmpdir` and :fixture:`tmp_path` no longer raise an error if the lock to check for stale temporary directories is not accessible. -- `#7517 `_: Preserve line endings when captured via ``capfd``. +- :issue:`7517`: Preserve line endings when captured via ``capfd``. -- `#7534 `_: Restored the previous formatting of ``TracebackEntry.__str__`` which was changed by accident. +- :issue:`7534`: Restored the previous formatting of ``TracebackEntry.__str__`` which was changed by accident. Improved Documentation ---------------------- -- `#7422 `_: Clarified when the ``usefixtures`` mark can apply fixtures to test. +- :issue:`7422`: Clarified when the ``usefixtures`` mark can apply fixtures to test. -- `#7441 `_: Add a note about ``-q`` option used in getting started guide. +- :issue:`7441`: Add a note about ``-q`` option used in getting started guide. Trivial/Internal Changes ------------------------ -- `#7389 `_: Fixture scope ``package`` is no longer considered experimental. +- :issue:`7389`: Fixture scope ``package`` is no longer considered experimental. pytest 6.0.0rc1 (2020-07-08) @@ -620,10 +620,10 @@ pytest 6.0.0rc1 (2020-07-08) Breaking Changes ---------------- -- `#1316 `_: ``TestReport.longrepr`` is now always an instance of ``ReprExceptionInfo``. Previously it was a ``str`` when a test failed with ``pytest.fail(..., pytrace=False)``. +- :issue:`1316`: ``TestReport.longrepr`` is now always an instance of ``ReprExceptionInfo``. Previously it was a ``str`` when a test failed with ``pytest.fail(..., pytrace=False)``. -- `#5965 `_: symlinks are no longer resolved during collection and matching `conftest.py` files with test file paths. +- :issue:`5965`: symlinks are no longer resolved during collection and matching `conftest.py` files with test file paths. Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms. @@ -634,7 +634,7 @@ Breaking Changes for the entire test tree, and not only to partial files/tress as it was possible previously. -- `#6505 `_: ``Testdir.run().parseoutcomes()`` now always returns the parsed nouns in plural form. +- :issue:`6505`: ``Testdir.run().parseoutcomes()`` now always returns the parsed nouns in plural form. Originally ``parseoutcomes()`` would always returns the nouns in plural form, but a change meant to improve the terminal summary by using singular form single items (``1 warning`` or ``1 error``) @@ -656,11 +656,11 @@ Breaking Changes result.assert_outcomes(errors=1) -- `#6903 `_: The ``os.dup()`` function is now assumed to exist. We are not aware of any +- :issue:`6903`: The ``os.dup()`` function is now assumed to exist. We are not aware of any supported Python 3 implementations which do not provide it. -- `#7040 `_: ``-k`` no longer matches against the names of the directories outside the test session root. +- :issue:`7040`: ``-k`` no longer matches against the names of the directories outside the test session root. Also, ``pytest.Package.name`` is now just the name of the directory containing the package's ``__init__.py`` file, instead of the full path. This is consistent with how the other nodes @@ -668,12 +668,12 @@ Breaking Changes the test suite. -- `#7122 `_: Expressions given to the ``-m`` and ``-k`` options are no longer evaluated using Python's :func:`eval`. +- :issue:`7122`: Expressions given to the ``-m`` and ``-k`` options are no longer evaluated using Python's :func:`eval`. The format supports ``or``, ``and``, ``not``, parenthesis and general identifiers to match against. Python constants, keywords or other operators are no longer evaluated differently. -- `#7135 `_: Pytest now uses its own ``TerminalWriter`` class instead of using the one from the ``py`` library. +- :issue:`7135`: Pytest now uses its own ``TerminalWriter`` class instead of using the one from the ``py`` library. Plugins generally access this class through ``TerminalReporter.writer``, ``TerminalReporter.write()`` (and similar methods), or ``_pytest.config.create_terminal_writer()``. @@ -690,20 +690,20 @@ Breaking Changes - Support for passing a callable instead of a file was removed. -- `#7224 `_: The `item.catch_log_handler` and `item.catch_log_handlers` attributes, set by the +- :issue:`7224`: The `item.catch_log_handler` and `item.catch_log_handlers` attributes, set by the logging plugin and never meant to be public, are no longer available. The deprecated ``--no-print-logs`` option and ``log_print`` ini option are removed. Use ``--show-capture`` instead. -- `#7226 `_: Removed the unused ``args`` parameter from ``pytest.Function.__init__``. +- :issue:`7226`: Removed the unused ``args`` parameter from ``pytest.Function.__init__``. -- `#7418 `_: Removed the `pytest_doctest_prepare_content` hook specification. This hook +- :issue:`7418`: Removed the `pytest_doctest_prepare_content` hook specification. This hook hasn't been triggered by pytest for at least 10 years. -- `#7438 `_: Some changes were made to the internal ``_pytest._code.source``, listed here +- :issue:`7438`: Some changes were made to the internal ``_pytest._code.source``, listed here for the benefit of plugin authors who may be using it: - The ``deindent`` argument to ``Source()`` has been removed, now it is always true. @@ -720,19 +720,19 @@ Breaking Changes Deprecations ------------ -- `#7210 `_: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'`` +- :issue:`7210`: The special ``-k '-expr'`` syntax to ``-k`` is deprecated. Use ``-k 'not expr'`` instead. The special ``-k 'expr:'`` syntax to ``-k`` is deprecated. Please open an issue if you use this and want a replacement. -- `#4049 `_: ``pytest_warning_captured`` is deprecated in favor of the ``pytest_warning_recorded`` hook. +- :issue:`4049`: ``pytest_warning_captured`` is deprecated in favor of the ``pytest_warning_recorded`` hook. Features -------- -- `#1556 `_: pytest now supports ``pyproject.toml`` files for configuration. +- :issue:`1556`: pytest now supports ``pyproject.toml`` files for configuration. The configuration options is similar to the one available in other formats, but must be defined in a ``[tool.pytest.ini_options]`` table to be picked up by pytest: @@ -751,7 +751,7 @@ Features More information can be found :ref:`in the docs `. -- `#3342 `_: pytest now includes inline type annotations and exposes them to user programs. +- :issue:`3342`: pytest now includes inline type annotations and exposes them to user programs. Most of the user-facing API is covered, as well as internal code. If you are running a type checker such as mypy on your tests, you may start @@ -764,26 +764,26 @@ Features pytest yet. -- `#4049 `_: Introduced a new hook named `pytest_warning_recorded` to convey information about warnings captured by the internal `pytest` warnings plugin. +- :issue:`4049`: Introduced a new hook named `pytest_warning_recorded` to convey information about warnings captured by the internal `pytest` warnings plugin. This hook is meant to replace `pytest_warning_captured`, which is deprecated and will be removed in a future release. -- `#6471 `_: New command-line flags: +- :issue:`6471`: New command-line flags: * `--no-header`: disables the initial header, including platform, version, and plugins. * `--no-summary`: disables the final test summary, including warnings. -- `#6856 `_: A warning is now shown when an unknown key is read from a config INI file. +- :issue:`6856`: A warning is now shown when an unknown key is read from a config INI file. The `--strict-config` flag has been added to treat these warnings as errors. -- `#6906 `_: Added `--code-highlight` command line option to enable/disable code highlighting in terminal output. +- :issue:`6906`: Added `--code-highlight` command line option to enable/disable code highlighting in terminal output. -- `#7245 `_: New ``--import-mode=importlib`` option that uses :mod:`importlib` to import test modules. +- :issue:`7245`: New ``--import-mode=importlib`` option that uses :mod:`importlib` to import test modules. Traditionally pytest used ``__import__`` while changing ``sys.path`` to import test modules (which also changes ``sys.modules`` as a side-effect), which works but has a number of drawbacks, like requiring test modules @@ -794,33 +794,33 @@ Features of the previous mode. We intend to make ``--import-mode=importlib`` the default in future versions, so users are encouraged - to try the new mode and provide feedback (both positive or negative) in issue `#7245 `__. + to try the new mode and provide feedback (both positive or negative) in issue :issue:`7245`. You can read more about this option in :std:ref:`the documentation `. -- `#7305 `_: New ``required_plugins`` configuration option allows the user to specify a list of plugins, including version information, that are required for pytest to run. An error is raised if any required plugins are not found when running pytest. +- :issue:`7305`: New ``required_plugins`` configuration option allows the user to specify a list of plugins, including version information, that are required for pytest to run. An error is raised if any required plugins are not found when running pytest. Improvements ------------ -- `#4375 `_: The ``pytest`` command now suppresses the ``BrokenPipeError`` error message that +- :issue:`4375`: The ``pytest`` command now suppresses the ``BrokenPipeError`` error message that is printed to stderr when the output of ``pytest`` is piped and and the pipe is closed by the piped-to program (common examples are ``less`` and ``head``). -- `#4391 `_: Improved precision of test durations measurement. ``CallInfo`` items now have a new ``.duration`` attribute, created using ``time.perf_counter()``. This attribute is used to fill the ``.duration`` attribute, which is more accurate than the previous ``.stop - .start`` (as these are based on ``time.time()``). +- :issue:`4391`: Improved precision of test durations measurement. ``CallInfo`` items now have a new ``.duration`` attribute, created using ``time.perf_counter()``. This attribute is used to fill the ``.duration`` attribute, which is more accurate than the previous ``.stop - .start`` (as these are based on ``time.time()``). -- `#4675 `_: Rich comparison for dataclasses and `attrs`-classes is now recursive. +- :issue:`4675`: Rich comparison for dataclasses and `attrs`-classes is now recursive. -- `#6285 `_: Exposed the `pytest.FixtureLookupError` exception which is raised by `request.getfixturevalue()` +- :issue:`6285`: Exposed the `pytest.FixtureLookupError` exception which is raised by `request.getfixturevalue()` (where `request` is a `FixtureRequest` fixture) when a fixture with the given name cannot be returned. -- `#6433 `_: If an error is encountered while formatting the message in a logging call, for +- :issue:`6433`: If an error is encountered while formatting the message in a logging call, for example ``logging.warning("oh no!: %s: %s", "first")`` (a second argument is missing), pytest now propagates the error, likely causing the test to fail. @@ -832,40 +832,40 @@ Improvements ``logging.raiseExceptions = False``. -- `#6817 `_: Explicit new-lines in help texts of command-line options are preserved, allowing plugins better control +- :issue:`6817`: Explicit new-lines in help texts of command-line options are preserved, allowing plugins better control of the help displayed to users. -- `#6940 `_: When using the ``--duration`` option, the terminal message output is now more precise about the number and duration of hidden items. +- :issue:`6940`: When using the ``--duration`` option, the terminal message output is now more precise about the number and duration of hidden items. -- `#6991 `_: Collected files are displayed after any reports from hooks, e.g. the status from ``--lf``. +- :issue:`6991`: Collected files are displayed after any reports from hooks, e.g. the status from ``--lf``. -- `#7091 `_: When ``fd`` capturing is used, through ``--capture=fd`` or the ``capfd`` and +- :issue:`7091`: When ``fd`` capturing is used, through ``--capture=fd`` or the ``capfd`` and ``capfdbinary`` fixtures, and the file descriptor (0, 1, 2) cannot be duplicated, FD capturing is still performed. Previously, direct writes to the file descriptors would fail or be lost in this case. -- `#7119 `_: Exit with an error if the ``--basetemp`` argument is empty, is the current working directory or is one of the parent directories. +- :issue:`7119`: Exit with an error if the ``--basetemp`` argument is empty, is the current working directory or is one of the parent directories. This is done to protect against accidental data loss, as any directory passed to this argument is cleared. -- `#7128 `_: `pytest --version` now displays just the pytest version, while `pytest --version --version` displays more verbose information including plugins. This is more consistent with how other tools show `--version`. +- :issue:`7128`: `pytest --version` now displays just the pytest version, while `pytest --version --version` displays more verbose information including plugins. This is more consistent with how other tools show `--version`. -- `#7133 `_: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` will now override any :confval:`log_level` set via the CLI or configuration file. +- :issue:`7133`: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` will now override any :confval:`log_level` set via the CLI or configuration file. -- `#7159 `_: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` and :meth:`caplog.at_level() <_pytest.logging.LogCaptureFixture.at_level>` no longer affect +- :issue:`7159`: :meth:`caplog.set_level() <_pytest.logging.LogCaptureFixture.set_level>` and :meth:`caplog.at_level() <_pytest.logging.LogCaptureFixture.at_level>` no longer affect the level of logs that are shown in the *Captured log report* report section. -- `#7348 `_: Improve recursive diff report for comparison asserts on dataclasses / attrs. +- :issue:`7348`: Improve recursive diff report for comparison asserts on dataclasses / attrs. -- `#7385 `_: ``--junitxml`` now includes the exception cause in the ``message`` XML attribute for failures during setup and teardown. +- :issue:`7385`: ``--junitxml`` now includes the exception cause in the ``message`` XML attribute for failures during setup and teardown. Previously: @@ -884,136 +884,136 @@ Improvements Bug Fixes --------- -- `#1120 `_: Fix issue where directories from :fixture:`tmpdir` are not removed properly when multiple instances of pytest are running in parallel. +- :issue:`1120`: Fix issue where directories from :fixture:`tmpdir` are not removed properly when multiple instances of pytest are running in parallel. -- `#4583 `_: Prevent crashing and provide a user-friendly error when a marker expression (`-m`) invoking of :func:`eval` raises any exception. +- :issue:`4583`: Prevent crashing and provide a user-friendly error when a marker expression (`-m`) invoking of :func:`eval` raises any exception. -- `#4677 `_: The path shown in the summary report for SKIPPED tests is now always relative. Previously it was sometimes absolute. +- :issue:`4677`: The path shown in the summary report for SKIPPED tests is now always relative. Previously it was sometimes absolute. -- `#5456 `_: Fix a possible race condition when trying to remove lock files used to control access to folders +- :issue:`5456`: Fix a possible race condition when trying to remove lock files used to control access to folders created by :fixture:`tmp_path` and :fixture:`tmpdir`. -- `#6240 `_: Fixes an issue where logging during collection step caused duplication of log +- :issue:`6240`: Fixes an issue where logging during collection step caused duplication of log messages to stderr. -- `#6428 `_: Paths appearing in error messages are now correct in case the current working directory has +- :issue:`6428`: Paths appearing in error messages are now correct in case the current working directory has changed since the start of the session. -- `#6755 `_: Support deleting paths longer than 260 characters on windows created inside :fixture:`tmpdir`. +- :issue:`6755`: Support deleting paths longer than 260 characters on windows created inside :fixture:`tmpdir`. -- `#6871 `_: Fix crash with captured output when using :fixture:`capsysbinary`. +- :issue:`6871`: Fix crash with captured output when using :fixture:`capsysbinary`. -- `#6909 `_: Revert the change introduced by `#6330 `_, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature. +- :issue:`6909`: Revert the change introduced by `#6330 `_, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature. The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted. -- `#6910 `_: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option. +- :issue:`6910`: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option. -- `#6924 `_: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited. +- :issue:`6924`: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited. -- `#6925 `_: Fix `TerminalRepr` instances to be hashable again. +- :issue:`6925`: Fix `TerminalRepr` instances to be hashable again. -- `#6947 `_: Fix regression where functions registered with :meth:`unittest.TestCase.addCleanup` were not being called on test failures. +- :issue:`6947`: Fix regression where functions registered with :meth:`unittest.TestCase.addCleanup` were not being called on test failures. -- `#6951 `_: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute. +- :issue:`6951`: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute. -- `#6956 `_: Prevent pytest from printing `ConftestImportFailure` traceback to stdout. +- :issue:`6956`: Prevent pytest from printing `ConftestImportFailure` traceback to stdout. -- `#6991 `_: Fix regressions with `--lf` filtering too much since pytest 5.4. +- :issue:`6991`: Fix regressions with `--lf` filtering too much since pytest 5.4. -- `#6992 `_: Revert "tmpdir: clean up indirection via config for factories" `#6767 `_ as it breaks pytest-xdist. +- :issue:`6992`: Revert "tmpdir: clean up indirection via config for factories" :issue:`6767` as it breaks pytest-xdist. -- `#7061 `_: When a yielding fixture fails to yield a value, report a test setup error instead of crashing. +- :issue:`7061`: When a yielding fixture fails to yield a value, report a test setup error instead of crashing. -- `#7076 `_: The path of file skipped by ``@pytest.mark.skip`` in the SKIPPED report is now relative to invocation directory. Previously it was relative to root directory. +- :issue:`7076`: The path of file skipped by ``@pytest.mark.skip`` in the SKIPPED report is now relative to invocation directory. Previously it was relative to root directory. -- `#7110 `_: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again. +- :issue:`7110`: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again. -- `#7126 `_: ``--setup-show`` now doesn't raise an error when a bytes value is used as a ``parametrize`` +- :issue:`7126`: ``--setup-show`` now doesn't raise an error when a bytes value is used as a ``parametrize`` parameter when Python is called with the ``-bb`` flag. -- `#7143 `_: Fix :meth:`pytest.File.from_parent` so it forwards extra keyword arguments to the constructor. +- :issue:`7143`: Fix :meth:`pytest.File.from_parent` so it forwards extra keyword arguments to the constructor. -- `#7145 `_: Classes with broken ``__getattribute__`` methods are displayed correctly during failures. +- :issue:`7145`: Classes with broken ``__getattribute__`` methods are displayed correctly during failures. -- `#7150 `_: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised. +- :issue:`7150`: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised. -- `#7180 `_: Fix ``_is_setup_py`` for files encoded differently than locale. +- :issue:`7180`: Fix ``_is_setup_py`` for files encoded differently than locale. -- `#7215 `_: Fix regression where running with ``--pdb`` would call :meth:`unittest.TestCase.tearDown` for skipped tests. +- :issue:`7215`: Fix regression where running with ``--pdb`` would call :meth:`unittest.TestCase.tearDown` for skipped tests. -- `#7253 `_: When using ``pytest.fixture`` on a function directly, as in ``pytest.fixture(func)``, +- :issue:`7253`: When using ``pytest.fixture`` on a function directly, as in ``pytest.fixture(func)``, if the ``autouse`` or ``params`` arguments are also passed, the function is no longer ignored, but is marked as a fixture. -- `#7360 `_: Fix possibly incorrect evaluation of string expressions passed to ``pytest.mark.skipif`` and ``pytest.mark.xfail``, +- :issue:`7360`: Fix possibly incorrect evaluation of string expressions passed to ``pytest.mark.skipif`` and ``pytest.mark.xfail``, in rare circumstances where the exact same string is used but refers to different global values. -- `#7383 `_: Fixed exception causes all over the codebase, i.e. use `raise new_exception from old_exception` when wrapping an exception. +- :issue:`7383`: Fixed exception causes all over the codebase, i.e. use `raise new_exception from old_exception` when wrapping an exception. Improved Documentation ---------------------- -- `#7202 `_: The development guide now links to the contributing section of the docs and `RELEASING.rst` on GitHub. +- :issue:`7202`: The development guide now links to the contributing section of the docs and `RELEASING.rst` on GitHub. -- `#7233 `_: Add a note about ``--strict`` and ``--strict-markers`` and the preference for the latter one. +- :issue:`7233`: Add a note about ``--strict`` and ``--strict-markers`` and the preference for the latter one. -- `#7345 `_: Explain indirect parametrization and markers for fixtures. +- :issue:`7345`: Explain indirect parametrization and markers for fixtures. Trivial/Internal Changes ------------------------ -- `#7035 `_: The ``originalname`` attribute of ``_pytest.python.Function`` now defaults to ``name`` if not +- :issue:`7035`: The ``originalname`` attribute of ``_pytest.python.Function`` now defaults to ``name`` if not provided explicitly, and is always set. -- `#7264 `_: The dependency on the ``wcwidth`` package has been removed. +- :issue:`7264`: The dependency on the ``wcwidth`` package has been removed. -- `#7291 `_: Replaced ``py.iniconfig`` with :pypi:`iniconfig`. +- :issue:`7291`: Replaced ``py.iniconfig`` with :pypi:`iniconfig`. -- `#7295 `_: ``src/_pytest/config/__init__.py`` now uses the ``warnings`` module to report warnings instead of ``sys.stderr.write``. +- :issue:`7295`: ``src/_pytest/config/__init__.py`` now uses the ``warnings`` module to report warnings instead of ``sys.stderr.write``. -- `#7356 `_: Remove last internal uses of deprecated *slave* term from old ``pytest-xdist``. +- :issue:`7356`: Remove last internal uses of deprecated *slave* term from old ``pytest-xdist``. -- `#7357 `_: ``py``>=1.8.2 is now required. +- :issue:`7357`: ``py``>=1.8.2 is now required. pytest 5.4.3 (2020-06-02) @@ -1022,20 +1022,20 @@ pytest 5.4.3 (2020-06-02) Bug Fixes --------- -- `#6428 `_: Paths appearing in error messages are now correct in case the current working directory has +- :issue:`6428`: Paths appearing in error messages are now correct in case the current working directory has changed since the start of the session. -- `#6755 `_: Support deleting paths longer than 260 characters on windows created inside tmpdir. +- :issue:`6755`: Support deleting paths longer than 260 characters on windows created inside tmpdir. -- `#6956 `_: Prevent pytest from printing ConftestImportFailure traceback to stdout. +- :issue:`6956`: Prevent pytest from printing ConftestImportFailure traceback to stdout. -- `#7150 `_: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised. +- :issue:`7150`: Prevent hiding the underlying exception when ``ConfTestImportFailure`` is raised. -- `#7215 `_: Fix regression where running with ``--pdb`` would call the ``tearDown`` methods of ``unittest.TestCase`` +- :issue:`7215`: Fix regression where running with ``--pdb`` would call the ``tearDown`` methods of ``unittest.TestCase`` subclasses for skipped tests. @@ -1045,34 +1045,34 @@ pytest 5.4.2 (2020-05-08) Bug Fixes --------- -- `#6871 `_: Fix crash with captured output when using the :fixture:`capsysbinary fixture `. +- :issue:`6871`: Fix crash with captured output when using the :fixture:`capsysbinary fixture `. -- `#6924 `_: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited. +- :issue:`6924`: Ensure a ``unittest.IsolatedAsyncioTestCase`` is actually awaited. -- `#6925 `_: Fix TerminalRepr instances to be hashable again. +- :issue:`6925`: Fix TerminalRepr instances to be hashable again. -- `#6947 `_: Fix regression where functions registered with ``TestCase.addCleanup`` were not being called on test failures. +- :issue:`6947`: Fix regression where functions registered with ``TestCase.addCleanup`` were not being called on test failures. -- `#6951 `_: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute. +- :issue:`6951`: Allow users to still set the deprecated ``TerminalReporter.writer`` attribute. -- `#6992 `_: Revert "tmpdir: clean up indirection via config for factories" #6767 as it breaks pytest-xdist. +- :issue:`6992`: Revert "tmpdir: clean up indirection via config for factories" #6767 as it breaks pytest-xdist. -- `#7110 `_: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again. +- :issue:`7110`: Fixed regression: ``asyncbase.TestCase`` tests are executed correctly again. -- `#7143 `_: Fix ``File.from_parent`` so it forwards extra keyword arguments to the constructor. +- :issue:`7143`: Fix ``File.from_parent`` so it forwards extra keyword arguments to the constructor. -- `#7145 `_: Classes with broken ``__getattribute__`` methods are displayed correctly during failures. +- :issue:`7145`: Classes with broken ``__getattribute__`` methods are displayed correctly during failures. -- `#7180 `_: Fix ``_is_setup_py`` for files encoded differently than locale. +- :issue:`7180`: Fix ``_is_setup_py`` for files encoded differently than locale. pytest 5.4.1 (2020-03-13) @@ -1081,12 +1081,12 @@ pytest 5.4.1 (2020-03-13) Bug Fixes --------- -- `#6909 `_: Revert the change introduced by `#6330 `_, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature. +- :issue:`6909`: Revert the change introduced by `#6330 `_, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature. The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted. -- `#6910 `_: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option. +- :issue:`6910`: Fix crash when plugins return an unknown stats while using the ``--reportlog`` option. pytest 5.4.0 (2020-03-12) @@ -1095,23 +1095,23 @@ pytest 5.4.0 (2020-03-12) Breaking Changes ---------------- -- `#6316 `_: Matching of ``-k EXPRESSION`` to test names is now case-insensitive. +- :issue:`6316`: Matching of ``-k EXPRESSION`` to test names is now case-insensitive. -- `#6443 `_: Plugins specified with ``-p`` are now loaded after internal plugins, which results in their hooks being called *before* the internal ones. +- :issue:`6443`: Plugins specified with ``-p`` are now loaded after internal plugins, which results in their hooks being called *before* the internal ones. This makes the ``-p`` behavior consistent with ``PYTEST_PLUGINS``. -- `#6637 `_: Removed the long-deprecated ``pytest_itemstart`` hook. +- :issue:`6637`: Removed the long-deprecated ``pytest_itemstart`` hook. This hook has been marked as deprecated and not been even called by pytest for over 10 years now. -- `#6673 `_: Reversed / fix meaning of "+/-" in error diffs. "-" means that sth. expected is missing in the result and "+" means that there are unexpected extras in the result. +- :issue:`6673`: Reversed / fix meaning of "+/-" in error diffs. "-" means that sth. expected is missing in the result and "+" means that there are unexpected extras in the result. -- `#6737 `_: The ``cached_result`` attribute of ``FixtureDef`` is now set to ``None`` when +- :issue:`6737`: The ``cached_result`` attribute of ``FixtureDef`` is now set to ``None`` when the result is unavailable, instead of being deleted. If your plugin performs checks like ``hasattr(fixturedef, 'cached_result')``, @@ -1124,19 +1124,19 @@ Breaking Changes Deprecations ------------ -- `#3238 `_: Option ``--no-print-logs`` is deprecated and meant to be removed in a future release. If you use ``--no-print-logs``, please try out ``--show-capture`` and +- :issue:`3238`: Option ``--no-print-logs`` is deprecated and meant to be removed in a future release. If you use ``--no-print-logs``, please try out ``--show-capture`` and provide feedback. ``--show-capture`` command-line option was added in ``pytest 3.5.0`` and allows to specify how to display captured output when tests fail: ``no``, ``stdout``, ``stderr``, ``log`` or ``all`` (the default). -- `#571 `_: Deprecate the unused/broken `pytest_collect_directory` hook. +- :issue:`571`: Deprecate the unused/broken `pytest_collect_directory` hook. It was misaligned since the removal of the ``Directory`` collector in 2010 and incorrect/unusable as soon as collection was split from test execution. -- `#5975 `_: Deprecate using direct constructors for ``Nodes``. +- :issue:`5975`: Deprecate using direct constructors for ``Nodes``. Instead they are now constructed via ``Node.from_parent``. @@ -1148,7 +1148,7 @@ Deprecations Subclasses are expected to use `super().from_parent` if they intend to expand the creation of `Nodes`. -- `#6779 `_: The ``TerminalReporter.writer`` attribute has been deprecated and should no longer be used. This +- :issue:`6779`: The ``TerminalReporter.writer`` attribute has been deprecated and should no longer be used. This was inadvertently exposed as part of the public API of that plugin and ties it too much with ``py.io.TerminalWriter``. @@ -1157,153 +1157,153 @@ Deprecations Features -------- -- `#4597 `_: New :ref:`--capture=tee-sys ` option to allow both live printing and capturing of test output. +- :issue:`4597`: New :ref:`--capture=tee-sys ` option to allow both live printing and capturing of test output. -- `#5712 `_: Now all arguments to ``@pytest.mark.parametrize`` need to be explicitly declared in the function signature or via ``indirect``. +- :issue:`5712`: Now all arguments to ``@pytest.mark.parametrize`` need to be explicitly declared in the function signature or via ``indirect``. Previously it was possible to omit an argument if a fixture with the same name existed, which was just an accident of implementation and was not meant to be a part of the API. -- `#6454 `_: Changed default for `-r` to `fE`, which displays failures and errors in the :ref:`short test summary `. `-rN` can be used to disable it (the old behavior). +- :issue:`6454`: Changed default for `-r` to `fE`, which displays failures and errors in the :ref:`short test summary `. `-rN` can be used to disable it (the old behavior). -- `#6469 `_: New options have been added to the :confval:`junit_logging` option: ``log``, ``out-err``, and ``all``. +- :issue:`6469`: New options have been added to the :confval:`junit_logging` option: ``log``, ``out-err``, and ``all``. -- `#6834 `_: Excess warning summaries are now collapsed per file to ensure readable display of warning summaries. +- :issue:`6834`: Excess warning summaries are now collapsed per file to ensure readable display of warning summaries. Improvements ------------ -- `#1857 `_: ``pytest.mark.parametrize`` accepts integers for ``ids`` again, converting it to strings. +- :issue:`1857`: ``pytest.mark.parametrize`` accepts integers for ``ids`` again, converting it to strings. -- `#449 `_: Use "yellow" main color with any XPASSED tests. +- :issue:`449`: Use "yellow" main color with any XPASSED tests. -- `#4639 `_: Revert "A warning is now issued when assertions are made for ``None``". +- :issue:`4639`: Revert "A warning is now issued when assertions are made for ``None``". The warning proved to be less useful than initially expected and had quite a few false positive cases. -- `#5686 `_: ``tmpdir_factory.mktemp`` now fails when given absolute and non-normalized paths. +- :issue:`5686`: ``tmpdir_factory.mktemp`` now fails when given absolute and non-normalized paths. -- `#5984 `_: The ``pytest_warning_captured`` hook now receives a ``location`` parameter with the code location that generated the warning. +- :issue:`5984`: The ``pytest_warning_captured`` hook now receives a ``location`` parameter with the code location that generated the warning. -- `#6213 `_: pytester: the ``testdir`` fixture respects environment settings from the ``monkeypatch`` fixture for inner runs. +- :issue:`6213`: pytester: the ``testdir`` fixture respects environment settings from the ``monkeypatch`` fixture for inner runs. -- `#6247 `_: ``--fulltrace`` is honored with collection errors. +- :issue:`6247`: ``--fulltrace`` is honored with collection errors. -- `#6384 `_: Make `--showlocals` work also with `--tb=short`. +- :issue:`6384`: Make `--showlocals` work also with `--tb=short`. -- `#6653 `_: Add support for matching lines consecutively with :attr:`LineMatcher <_pytest.pytester.LineMatcher>`'s :func:`~_pytest.pytester.LineMatcher.fnmatch_lines` and :func:`~_pytest.pytester.LineMatcher.re_match_lines`. +- :issue:`6653`: Add support for matching lines consecutively with :attr:`LineMatcher <_pytest.pytester.LineMatcher>`'s :func:`~_pytest.pytester.LineMatcher.fnmatch_lines` and :func:`~_pytest.pytester.LineMatcher.re_match_lines`. -- `#6658 `_: Code is now highlighted in tracebacks when ``pygments`` is installed. +- :issue:`6658`: Code is now highlighted in tracebacks when ``pygments`` is installed. Users are encouraged to install ``pygments`` into their environment and provide feedback, because the plan is to make ``pygments`` a regular dependency in the future. -- `#6795 `_: Import usage error message with invalid `-o` option. +- :issue:`6795`: Import usage error message with invalid `-o` option. -- `#759 `_: ``pytest.mark.parametrize`` supports iterators and generators for ``ids``. +- :issue:`759`: ``pytest.mark.parametrize`` supports iterators and generators for ``ids``. Bug Fixes --------- -- `#310 `_: Add support for calling `pytest.xfail()` and `pytest.importorskip()` with doctests. +- :issue:`310`: Add support for calling `pytest.xfail()` and `pytest.importorskip()` with doctests. -- `#3823 `_: ``--trace`` now works with unittests. +- :issue:`3823`: ``--trace`` now works with unittests. -- `#4445 `_: Fixed some warning reports produced by pytest to point to the correct location of the warning in the user's code. +- :issue:`4445`: Fixed some warning reports produced by pytest to point to the correct location of the warning in the user's code. -- `#5301 `_: Fix ``--last-failed`` to collect new tests from files with known failures. +- :issue:`5301`: Fix ``--last-failed`` to collect new tests from files with known failures. -- `#5928 `_: Report ``PytestUnknownMarkWarning`` at the level of the user's code, not ``pytest``'s. +- :issue:`5928`: Report ``PytestUnknownMarkWarning`` at the level of the user's code, not ``pytest``'s. -- `#5991 `_: Fix interaction with ``--pdb`` and unittests: do not use unittest's ``TestCase.debug()``. +- :issue:`5991`: Fix interaction with ``--pdb`` and unittests: do not use unittest's ``TestCase.debug()``. -- `#6334 `_: Fix summary entries appearing twice when ``f/F`` and ``s/S`` report chars were used at the same time in the ``-r`` command-line option (for example ``-rFf``). +- :issue:`6334`: Fix summary entries appearing twice when ``f/F`` and ``s/S`` report chars were used at the same time in the ``-r`` command-line option (for example ``-rFf``). The upper case variants were never documented and the preferred form should be the lower case. -- `#6409 `_: Fallback to green (instead of yellow) for non-last items without previous passes with colored terminal progress indicator. +- :issue:`6409`: Fallback to green (instead of yellow) for non-last items without previous passes with colored terminal progress indicator. -- `#6454 `_: `--disable-warnings` is honored with `-ra` and `-rA`. +- :issue:`6454`: `--disable-warnings` is honored with `-ra` and `-rA`. -- `#6497 `_: Fix bug in the comparison of request key with cached key in fixture. +- :issue:`6497`: Fix bug in the comparison of request key with cached key in fixture. A construct ``if key == cached_key:`` can fail either because ``==`` is explicitly disallowed, or for, e.g., NumPy arrays, where the result of ``a == b`` cannot generally be converted to :class:`bool`. The implemented fix replaces `==` with ``is``. -- `#6557 `_: Make capture output streams ``.write()`` method return the same return value from original streams. +- :issue:`6557`: Make capture output streams ``.write()`` method return the same return value from original streams. -- `#6566 `_: Fix ``EncodedFile.writelines`` to call the underlying buffer's ``writelines`` method. +- :issue:`6566`: Fix ``EncodedFile.writelines`` to call the underlying buffer's ``writelines`` method. -- `#6575 `_: Fix internal crash when ``faulthandler`` starts initialized +- :issue:`6575`: Fix internal crash when ``faulthandler`` starts initialized (for example with ``PYTHONFAULTHANDLER=1`` environment variable set) and ``faulthandler_timeout`` defined in the configuration file. -- `#6597 `_: Fix node ids which contain a parametrized empty-string variable. +- :issue:`6597`: Fix node ids which contain a parametrized empty-string variable. -- `#6646 `_: Assertion rewriting hooks are (re)stored for the current item, which fixes them being still used after e.g. pytester's :func:`testdir.runpytest <_pytest.pytester.Testdir.runpytest>` etc. +- :issue:`6646`: Assertion rewriting hooks are (re)stored for the current item, which fixes them being still used after e.g. pytester's :func:`testdir.runpytest <_pytest.pytester.Testdir.runpytest>` etc. -- `#6660 `_: :py:func:`pytest.exit` is handled when emitted from the :func:`pytest_sessionfinish <_pytest.hookspec.pytest_sessionfinish>` hook. This includes quitting from a debugger. +- :issue:`6660`: :py:func:`pytest.exit` is handled when emitted from the :func:`pytest_sessionfinish <_pytest.hookspec.pytest_sessionfinish>` hook. This includes quitting from a debugger. -- `#6752 `_: When :py:func:`pytest.raises` is used as a function (as opposed to a context manager), +- :issue:`6752`: When :py:func:`pytest.raises` is used as a function (as opposed to a context manager), a `match` keyword argument is now passed through to the tested function. Previously it was swallowed and ignored (regression in pytest 5.1.0). -- `#6801 `_: Do not display empty lines inbetween traceback for unexpected exceptions with doctests. +- :issue:`6801`: Do not display empty lines inbetween traceback for unexpected exceptions with doctests. -- `#6802 `_: The :fixture:`testdir fixture ` works within doctests now. +- :issue:`6802`: The :fixture:`testdir fixture ` works within doctests now. Improved Documentation ---------------------- -- `#6696 `_: Add list of fixtures to start of fixture chapter. +- :issue:`6696`: Add list of fixtures to start of fixture chapter. -- `#6742 `_: Expand first sentence on fixtures into a paragraph. +- :issue:`6742`: Expand first sentence on fixtures into a paragraph. Trivial/Internal Changes ------------------------ -- `#6404 `_: Remove usage of ``parser`` module, deprecated in Python 3.9. +- :issue:`6404`: Remove usage of ``parser`` module, deprecated in Python 3.9. pytest 5.3.5 (2020-01-29) @@ -1312,7 +1312,7 @@ pytest 5.3.5 (2020-01-29) Bug Fixes --------- -- `#6517 `_: Fix regression in pytest 5.3.4 causing an INTERNALERROR due to a wrong assertion. +- :issue:`6517`: Fix regression in pytest 5.3.4 causing an INTERNALERROR due to a wrong assertion. pytest 5.3.4 (2020-01-20) @@ -1321,7 +1321,7 @@ pytest 5.3.4 (2020-01-20) Bug Fixes --------- -- `#6496 `_: Revert `#6436 `__: unfortunately this change has caused a number of regressions in many suites, +- :issue:`6496`: Revert :issue:`6436`: unfortunately this change has caused a number of regressions in many suites, so the team decided to revert this change and make a new release while we continue to look for a solution. @@ -1331,26 +1331,26 @@ pytest 5.3.3 (2020-01-16) Bug Fixes --------- -- `#2780 `_: Captured output during teardown is shown with ``-rP``. +- :issue:`2780`: Captured output during teardown is shown with ``-rP``. -- `#5971 `_: Fix a ``pytest-xdist`` crash when dealing with exceptions raised in subprocesses created by the +- :issue:`5971`: Fix a ``pytest-xdist`` crash when dealing with exceptions raised in subprocesses created by the ``multiprocessing`` module. -- `#6436 `_: :class:`FixtureDef <_pytest.fixtures.FixtureDef>` objects now properly register their finalizers with autouse and +- :issue:`6436`: :class:`FixtureDef <_pytest.fixtures.FixtureDef>` objects now properly register their finalizers with autouse and parameterized fixtures that execute before them in the fixture stack so they are torn down at the right times, and in the right order. -- `#6532 `_: Fix parsing of outcomes containing multiple errors with ``testdir`` results (regression in 5.3.0). +- :issue:`6532`: Fix parsing of outcomes containing multiple errors with ``testdir`` results (regression in 5.3.0). Trivial/Internal Changes ------------------------ -- `#6350 `_: Optimized automatic renaming of test parameter IDs. +- :issue:`6350`: Optimized automatic renaming of test parameter IDs. pytest 5.3.2 (2019-12-13) @@ -1359,7 +1359,7 @@ pytest 5.3.2 (2019-12-13) Improvements ------------ -- `#4639 `_: Revert "A warning is now issued when assertions are made for ``None``". +- :issue:`4639`: Revert "A warning is now issued when assertions are made for ``None``". The warning proved to be less useful than initially expected and had quite a few false positive cases. @@ -1369,13 +1369,13 @@ Improvements Bug Fixes --------- -- `#5430 `_: junitxml: Logs for failed test are now passed to junit report in case the test fails during call phase. +- :issue:`5430`: junitxml: Logs for failed test are now passed to junit report in case the test fails during call phase. -- `#6290 `_: The supporting files in the ``.pytest_cache`` directory are kept with ``--cache-clear``, which only clears cached values now. +- :issue:`6290`: The supporting files in the ``.pytest_cache`` directory are kept with ``--cache-clear``, which only clears cached values now. -- `#6301 `_: Fix assertion rewriting for egg-based distributions and ``editable`` installs (``pip install --editable``). +- :issue:`6301`: Fix assertion rewriting for egg-based distributions and ``editable`` installs (``pip install --editable``). pytest 5.3.1 (2019-11-25) @@ -1384,26 +1384,26 @@ pytest 5.3.1 (2019-11-25) Improvements ------------ -- `#6231 `_: Improve check for misspelling of :ref:`pytest.mark.parametrize ref`. +- :issue:`6231`: Improve check for misspelling of :ref:`pytest.mark.parametrize ref`. -- `#6257 `_: Handle :py:func:`pytest.exit` being used via :py:func:`~_pytest.hookspec.pytest_internalerror`, e.g. when quitting pdb from post mortem. +- :issue:`6257`: Handle :py:func:`pytest.exit` being used via :py:func:`~_pytest.hookspec.pytest_internalerror`, e.g. when quitting pdb from post mortem. Bug Fixes --------- -- `#5914 `_: pytester: fix :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` when used after positive matching. +- :issue:`5914`: pytester: fix :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` when used after positive matching. -- `#6082 `_: Fix line detection for doctest samples inside :py:class:`python:property` docstrings, as a workaround to `bpo-17446 `__. +- :issue:`6082`: Fix line detection for doctest samples inside :py:class:`python:property` docstrings, as a workaround to `bpo-17446 `__. -- `#6254 `_: Fix compatibility with pytest-parallel (regression in pytest 5.3.0). +- :issue:`6254`: Fix compatibility with pytest-parallel (regression in pytest 5.3.0). -- `#6255 `_: Clear the :py:data:`sys.last_traceback`, :py:data:`sys.last_type` +- :issue:`6255`: Clear the :py:data:`sys.last_traceback`, :py:data:`sys.last_type` and :py:data:`sys.last_value` attributes by deleting them instead of setting them to ``None``. This better matches the behaviour of the Python standard library. @@ -1415,7 +1415,7 @@ pytest 5.3.0 (2019-11-19) Deprecations ------------ -- `#6179 `_: The default value of :confval:`junit_family` option will change to ``"xunit2"`` in pytest 6.0, given +- :issue:`6179`: The default value of :confval:`junit_family` option will change to ``"xunit2"`` in pytest 6.0, given that this is the version supported by default in modern tools that manipulate this type of file. In order to smooth the transition, pytest will issue a warning in case the ``--junitxml`` option @@ -1428,7 +1428,7 @@ Deprecations Features -------- -- `#4488 `_: The pytest team has created the `pytest-reportlog `__ +- :issue:`4488`: The pytest team has created the `pytest-reportlog `__ plugin, which provides a new ``--report-log=FILE`` option that writes *report logs* into a file as the test session executes. Each line of the report log contains a self contained JSON object corresponding to a testing event, @@ -1440,12 +1440,12 @@ Features provide feedback. -- `#4730 `_: When :py:data:`sys.pycache_prefix` (Python 3.8+) is set, it will be used by pytest to cache test files changed by the assertion rewriting mechanism. +- :issue:`4730`: When :py:data:`sys.pycache_prefix` (Python 3.8+) is set, it will be used by pytest to cache test files changed by the assertion rewriting mechanism. This makes it easier to benefit of cached ``.pyc`` files even on file systems without permissions. -- `#5515 `_: Allow selective auto-indentation of multiline log messages. +- :issue:`5515`: Allow selective auto-indentation of multiline log messages. Adds command line option ``--log-auto-indent``, config option :confval:`log_auto_indent` and support for per-entry configuration of @@ -1458,7 +1458,7 @@ Features rather than implicitly. -- `#5914 `_: :fixture:`testdir` learned two new functions, :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` and +- :issue:`5914`: :fixture:`testdir` learned two new functions, :py:func:`~_pytest.pytester.LineMatcher.no_fnmatch_line` and :py:func:`~_pytest.pytester.LineMatcher.no_re_match_line`. The functions are used to ensure the captured text *does not* match the given @@ -1481,12 +1481,12 @@ Features But the new functions produce best output on failure. -- `#6057 `_: Added tolerances to complex values when printing ``pytest.approx``. +- :issue:`6057`: Added tolerances to complex values when printing ``pytest.approx``. For example, ``repr(pytest.approx(3+4j))`` returns ``(3+4j) ± 5e-06 ∠ ±180°``. This is polar notation indicating a circle around the expected value, with a radius of 5e-06. For ``approx`` comparisons to return ``True``, the actual value should fall within this circle. -- `#6061 `_: Added the pluginmanager as an argument to ``pytest_addoption`` +- :issue:`6061`: Added the pluginmanager as an argument to ``pytest_addoption`` so that hooks can be invoked when setting up command line options. This is useful for having one plugin communicate things to another plugin, such as default values or which set of command line options to add. @@ -1496,13 +1496,13 @@ Features Improvements ------------ -- `#5061 `_: Use multiple colors with terminal summary statistics. +- :issue:`5061`: Use multiple colors with terminal summary statistics. -- `#5630 `_: Quitting from debuggers is now properly handled in ``doctest`` items. +- :issue:`5630`: Quitting from debuggers is now properly handled in ``doctest`` items. -- `#5924 `_: Improved verbose diff output with sequences. +- :issue:`5924`: Improved verbose diff output with sequences. Before: @@ -1538,80 +1538,80 @@ Improvements E ] -- `#5934 `_: ``repr`` of ``ExceptionInfo`` objects has been improved to honor the ``__repr__`` method of the underlying exception. +- :issue:`5934`: ``repr`` of ``ExceptionInfo`` objects has been improved to honor the ``__repr__`` method of the underlying exception. -- `#5936 `_: Display untruncated assertion message with ``-vv``. +- :issue:`5936`: Display untruncated assertion message with ``-vv``. -- `#5990 `_: Fixed plurality mismatch in test summary (e.g. display "1 error" instead of "1 errors"). +- :issue:`5990`: Fixed plurality mismatch in test summary (e.g. display "1 error" instead of "1 errors"). -- `#6008 `_: ``Config.InvocationParams.args`` is now always a ``tuple`` to better convey that it should be +- :issue:`6008`: ``Config.InvocationParams.args`` is now always a ``tuple`` to better convey that it should be immutable and avoid accidental modifications. -- `#6023 `_: ``pytest.main`` returns a ``pytest.ExitCode`` instance now, except for when custom exit codes are used (where it returns ``int`` then still). +- :issue:`6023`: ``pytest.main`` returns a ``pytest.ExitCode`` instance now, except for when custom exit codes are used (where it returns ``int`` then still). -- `#6026 `_: Align prefixes in output of pytester's ``LineMatcher``. +- :issue:`6026`: Align prefixes in output of pytester's ``LineMatcher``. -- `#6059 `_: Collection errors are reported as errors (and not failures like before) in the terminal's short test summary. +- :issue:`6059`: Collection errors are reported as errors (and not failures like before) in the terminal's short test summary. -- `#6069 `_: ``pytester.spawn`` does not skip/xfail tests on FreeBSD anymore unconditionally. +- :issue:`6069`: ``pytester.spawn`` does not skip/xfail tests on FreeBSD anymore unconditionally. -- `#6097 `_: The "[...%]" indicator in the test summary is now colored according to the final (new) multi-colored line's main color. +- :issue:`6097`: The "[...%]" indicator in the test summary is now colored according to the final (new) multi-colored line's main color. -- `#6116 `_: Added ``--co`` as a synonym to ``--collect-only``. +- :issue:`6116`: Added ``--co`` as a synonym to ``--collect-only``. -- `#6148 `_: ``atomicwrites`` is now only used on Windows, fixing a performance regression with assertion rewriting on Unix. +- :issue:`6148`: ``atomicwrites`` is now only used on Windows, fixing a performance regression with assertion rewriting on Unix. -- `#6152 `_: Now parametrization will use the ``__name__`` attribute of any object for the id, if present. Previously it would only use ``__name__`` for functions and classes. +- :issue:`6152`: Now parametrization will use the ``__name__`` attribute of any object for the id, if present. Previously it would only use ``__name__`` for functions and classes. -- `#6176 `_: Improved failure reporting with pytester's ``Hookrecorder.assertoutcome``. +- :issue:`6176`: Improved failure reporting with pytester's ``Hookrecorder.assertoutcome``. -- `#6181 `_: The reason for a stopped session, e.g. with ``--maxfail`` / ``-x``, now gets reported in the test summary. +- :issue:`6181`: The reason for a stopped session, e.g. with ``--maxfail`` / ``-x``, now gets reported in the test summary. -- `#6206 `_: Improved ``cache.set`` robustness and performance. +- :issue:`6206`: Improved ``cache.set`` robustness and performance. Bug Fixes --------- -- `#2049 `_: Fixed ``--setup-plan`` showing inaccurate information about fixture lifetimes. +- :issue:`2049`: Fixed ``--setup-plan`` showing inaccurate information about fixture lifetimes. -- `#2548 `_: Fixed line offset mismatch of skipped tests in terminal summary. +- :issue:`2548`: Fixed line offset mismatch of skipped tests in terminal summary. -- `#6039 `_: The ``PytestDoctestRunner`` is now properly invalidated when unconfiguring the doctest plugin. +- :issue:`6039`: The ``PytestDoctestRunner`` is now properly invalidated when unconfiguring the doctest plugin. This is important when used with ``pytester``'s ``runpytest_inprocess``. -- `#6047 `_: BaseExceptions are now handled in ``saferepr``, which includes ``pytest.fail.Exception`` etc. +- :issue:`6047`: BaseExceptions are now handled in ``saferepr``, which includes ``pytest.fail.Exception`` etc. -- `#6074 `_: pytester: fixed order of arguments in ``rm_rf`` warning when cleaning up temporary directories, and do not emit warnings for errors with ``os.open``. +- :issue:`6074`: pytester: fixed order of arguments in ``rm_rf`` warning when cleaning up temporary directories, and do not emit warnings for errors with ``os.open``. -- `#6189 `_: Fixed result of ``getmodpath`` method. +- :issue:`6189`: Fixed result of ``getmodpath`` method. Trivial/Internal Changes ------------------------ -- `#4901 `_: ``RunResult`` from ``pytester`` now displays the mnemonic of the ``ret`` attribute when it is a +- :issue:`4901`: ``RunResult`` from ``pytester`` now displays the mnemonic of the ``ret`` attribute when it is a valid ``pytest.ExitCode`` value. @@ -1621,10 +1621,10 @@ pytest 5.2.4 (2019-11-15) Bug Fixes --------- -- `#6194 `_: Fix incorrect discovery of non-test ``__init__.py`` files. +- :issue:`6194`: Fix incorrect discovery of non-test ``__init__.py`` files. -- `#6197 `_: Revert "The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped.". +- :issue:`6197`: Revert "The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped.". pytest 5.2.3 (2019-11-14) @@ -1633,13 +1633,13 @@ pytest 5.2.3 (2019-11-14) Bug Fixes --------- -- `#5830 `_: The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped. +- :issue:`5830`: The first test in a package (``__init__.py``) marked with ``@pytest.mark.skip`` is now correctly skipped. -- `#6099 `_: Fix ``--trace`` when used with parametrized functions. +- :issue:`6099`: Fix ``--trace`` when used with parametrized functions. -- `#6183 `_: Using ``request`` as a parameter name in ``@pytest.mark.parametrize`` now produces a more +- :issue:`6183`: Using ``request`` as a parameter name in ``@pytest.mark.parametrize`` now produces a more user-friendly error. @@ -1649,16 +1649,16 @@ pytest 5.2.2 (2019-10-24) Bug Fixes --------- -- `#5206 `_: Fix ``--nf`` to not forget about known nodeids with partial test selection. +- :issue:`5206`: Fix ``--nf`` to not forget about known nodeids with partial test selection. -- `#5906 `_: Fix crash with ``KeyboardInterrupt`` during ``--setup-show``. +- :issue:`5906`: Fix crash with ``KeyboardInterrupt`` during ``--setup-show``. -- `#5946 `_: Fixed issue when parametrizing fixtures with numpy arrays (and possibly other sequence-like types). +- :issue:`5946`: Fixed issue when parametrizing fixtures with numpy arrays (and possibly other sequence-like types). -- `#6044 `_: Properly ignore ``FileNotFoundError`` exceptions when trying to remove old temporary directories, +- :issue:`6044`: Properly ignore ``FileNotFoundError`` exceptions when trying to remove old temporary directories, for instance when multiple processes try to remove the same directory (common with ``pytest-xdist`` for example). @@ -1669,7 +1669,7 @@ pytest 5.2.1 (2019-10-06) Bug Fixes --------- -- `#5902 `_: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``. +- :issue:`5902`: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``. pytest 5.2.0 (2019-09-28) @@ -1678,7 +1678,7 @@ pytest 5.2.0 (2019-09-28) Deprecations ------------ -- `#1682 `_: Passing arguments to pytest.fixture() as positional arguments is deprecated - pass them +- :issue:`1682`: Passing arguments to pytest.fixture() as positional arguments is deprecated - pass them as a keyword argument instead. @@ -1686,29 +1686,29 @@ Deprecations Features -------- -- `#1682 `_: The ``scope`` parameter of ``@pytest.fixture`` can now be a callable that receives +- :issue:`1682`: The ``scope`` parameter of ``@pytest.fixture`` can now be a callable that receives the fixture name and the ``config`` object as keyword-only parameters. See :ref:`the docs ` for more information. -- `#5764 `_: New behavior of the ``--pastebin`` option: failures to connect to the pastebin server are reported, without failing the pytest run +- :issue:`5764`: New behavior of the ``--pastebin`` option: failures to connect to the pastebin server are reported, without failing the pytest run Bug Fixes --------- -- `#5806 `_: Fix "lexer" being used when uploading to bpaste.net from ``--pastebin`` to "text". +- :issue:`5806`: Fix "lexer" being used when uploading to bpaste.net from ``--pastebin`` to "text". -- `#5884 `_: Fix ``--setup-only`` and ``--setup-show`` for custom pytest items. +- :issue:`5884`: Fix ``--setup-only`` and ``--setup-show`` for custom pytest items. Trivial/Internal Changes ------------------------ -- `#5056 `_: The HelpFormatter uses ``py.io.get_terminal_width`` for better width detection. +- :issue:`5056`: The HelpFormatter uses ``py.io.get_terminal_width`` for better width detection. pytest 5.1.3 (2019-09-18) @@ -1717,13 +1717,13 @@ pytest 5.1.3 (2019-09-18) Bug Fixes --------- -- `#5807 `_: Fix pypy3.6 (nightly) on windows. +- :issue:`5807`: Fix pypy3.6 (nightly) on windows. -- `#5811 `_: Handle ``--fulltrace`` correctly with ``pytest.raises``. +- :issue:`5811`: Handle ``--fulltrace`` correctly with ``pytest.raises``. -- `#5819 `_: Windows: Fix regression with conftest whose qualified name contains uppercase +- :issue:`5819`: Windows: Fix regression with conftest whose qualified name contains uppercase characters (introduced by #5792). @@ -1733,22 +1733,22 @@ pytest 5.1.2 (2019-08-30) Bug Fixes --------- -- `#2270 `_: Fixed ``self`` reference in function-scoped fixtures defined plugin classes: previously ``self`` +- :issue:`2270`: Fixed ``self`` reference in function-scoped fixtures defined plugin classes: previously ``self`` would be a reference to a *test* class, not the *plugin* class. -- `#570 `_: Fixed long standing issue where fixture scope was not respected when indirect fixtures were used during +- :issue:`570`: Fixed long standing issue where fixture scope was not respected when indirect fixtures were used during parametrization. -- `#5782 `_: Fix decoding error when printing an error response from ``--pastebin``. +- :issue:`5782`: Fix decoding error when printing an error response from ``--pastebin``. -- `#5786 `_: Chained exceptions in test and collection reports are now correctly serialized, allowing plugins like +- :issue:`5786`: Chained exceptions in test and collection reports are now correctly serialized, allowing plugins like ``pytest-xdist`` to display them properly. -- `#5792 `_: Windows: Fix error that occurs in certain circumstances when loading +- :issue:`5792`: Windows: Fix error that occurs in certain circumstances when loading ``conftest.py`` from a working directory that has casing other than the one stored in the filesystem (e.g., ``c:\test`` instead of ``C:\test``). @@ -1759,7 +1759,7 @@ pytest 5.1.1 (2019-08-20) Bug Fixes --------- -- `#5751 `_: Fixed ``TypeError`` when importing pytest on Python 3.5.0 and 3.5.1. +- :issue:`5751`: Fixed ``TypeError`` when importing pytest on Python 3.5.0 and 3.5.1. pytest 5.1.0 (2019-08-15) @@ -1768,7 +1768,7 @@ pytest 5.1.0 (2019-08-15) Removals -------- -- `#5180 `_: As per our policy, the following features have been deprecated in the 4.X series and are now +- :issue:`5180`: As per our policy, the following features have been deprecated in the 4.X series and are now removed: * ``Request.getfuncargvalue``: use ``Request.getfixturevalue`` instead. @@ -1795,7 +1795,7 @@ Removals For more information consult :std:doc:`deprecations` in the docs. -- `#5565 `_: Removed unused support code for :pypi:`unittest2`. +- :issue:`5565`: Removed unused support code for :pypi:`unittest2`. The ``unittest2`` backport module is no longer necessary since Python 3.3+, and the small amount of code in pytest to support it also doesn't seem @@ -1806,11 +1806,10 @@ Removals at all (even if ``unittest2`` is used by a test suite executed by pytest), it was decided to remove it in this release. - If you experience a regression because of this, please - `file an issue `__. + If you experience a regression because of this, please :issue:`file an issue `. -- `#5615 `_: ``pytest.fail``, ``pytest.xfail`` and ``pytest.skip`` no longer support bytes for the message argument. +- :issue:`5615`: ``pytest.fail``, ``pytest.xfail`` and ``pytest.skip`` no longer support bytes for the message argument. This was supported for Python 2 where it was tempting to use ``"message"`` instead of ``u"message"``. @@ -1823,10 +1822,10 @@ Removals Features -------- -- `#5564 `_: New ``Config.invocation_args`` attribute containing the unchanged arguments passed to ``pytest.main()``. +- :issue:`5564`: New ``Config.invocation_args`` attribute containing the unchanged arguments passed to ``pytest.main()``. -- `#5576 `_: New :ref:`NUMBER ` +- :issue:`5576`: New :ref:`NUMBER ` option for doctests to ignore irrelevant differences in floating-point numbers. Inspired by Sébastien Boisgérault's `numtest `__ extension for doctest. @@ -1836,10 +1835,10 @@ Features Improvements ------------ -- `#5471 `_: JUnit XML now includes a timestamp and hostname in the testsuite tag. +- :issue:`5471`: JUnit XML now includes a timestamp and hostname in the testsuite tag. -- `#5707 `_: Time taken to run the test suite now includes a human-readable representation when it takes over +- :issue:`5707`: Time taken to run the test suite now includes a human-readable representation when it takes over 60 seconds, for example:: ===== 2 failed in 102.70s (0:01:42) ===== @@ -1849,71 +1848,71 @@ Improvements Bug Fixes --------- -- `#4344 `_: Fix RuntimeError/StopIteration when trying to collect package with "__init__.py" only. +- :issue:`4344`: Fix RuntimeError/StopIteration when trying to collect package with "__init__.py" only. -- `#5115 `_: Warnings issued during ``pytest_configure`` are explicitly not treated as errors, even if configured as such, because it otherwise completely breaks pytest. +- :issue:`5115`: Warnings issued during ``pytest_configure`` are explicitly not treated as errors, even if configured as such, because it otherwise completely breaks pytest. -- `#5477 `_: The XML file produced by ``--junitxml`` now correctly contain a ```` root element. +- :issue:`5477`: The XML file produced by ``--junitxml`` now correctly contain a ```` root element. -- `#5524 `_: Fix issue where ``tmp_path`` and ``tmpdir`` would not remove directories containing files marked as read-only, +- :issue:`5524`: Fix issue where ``tmp_path`` and ``tmpdir`` would not remove directories containing files marked as read-only, which could lead to pytest crashing when executed a second time with the ``--basetemp`` option. -- `#5537 `_: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the +- :issue:`5537`: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the standard library on Python 3.8+. -- `#5578 `_: Improve type checking for some exception-raising functions (``pytest.xfail``, ``pytest.skip``, etc) +- :issue:`5578`: Improve type checking for some exception-raising functions (``pytest.xfail``, ``pytest.skip``, etc) so they provide better error messages when users meant to use marks (for example ``@pytest.xfail`` instead of ``@pytest.mark.xfail``). -- `#5606 `_: Fixed internal error when test functions were patched with objects that cannot be compared +- :issue:`5606`: Fixed internal error when test functions were patched with objects that cannot be compared for truth values against others, like ``numpy`` arrays. -- `#5634 `_: ``pytest.exit`` is now correctly handled in ``unittest`` cases. +- :issue:`5634`: ``pytest.exit`` is now correctly handled in ``unittest`` cases. This makes ``unittest`` cases handle ``quit`` from pytest's pdb correctly. -- `#5650 `_: Improved output when parsing an ini configuration file fails. +- :issue:`5650`: Improved output when parsing an ini configuration file fails. -- `#5701 `_: Fix collection of ``staticmethod`` objects defined with ``functools.partial``. +- :issue:`5701`: Fix collection of ``staticmethod`` objects defined with ``functools.partial``. -- `#5734 `_: Skip async generator test functions, and update the warning message to refer to ``async def`` functions. +- :issue:`5734`: Skip async generator test functions, and update the warning message to refer to ``async def`` functions. Improved Documentation ---------------------- -- `#5669 `_: Add docstring for ``Testdir.copy_example``. +- :issue:`5669`: Add docstring for ``Testdir.copy_example``. Trivial/Internal Changes ------------------------ -- `#5095 `_: XML files of the ``xunit2`` family are now validated against the schema by pytest's own test suite +- :issue:`5095`: XML files of the ``xunit2`` family are now validated against the schema by pytest's own test suite to avoid future regressions. -- `#5516 `_: Cache node splitting function which can improve collection performance in very large test suites. +- :issue:`5516`: Cache node splitting function which can improve collection performance in very large test suites. -- `#5603 `_: Simplified internal ``SafeRepr`` class and removed some dead code. +- :issue:`5603`: Simplified internal ``SafeRepr`` class and removed some dead code. -- `#5664 `_: When invoking pytest's own testsuite with ``PYTHONDONTWRITEBYTECODE=1``, +- :issue:`5664`: When invoking pytest's own testsuite with ``PYTHONDONTWRITEBYTECODE=1``, the ``test_xfail_handling`` test no longer fails. -- `#5684 `_: Replace manual handling of ``OSError.errno`` in the codebase by new ``OSError`` subclasses (``PermissionError``, ``FileNotFoundError``, etc.). +- :issue:`5684`: Replace manual handling of ``OSError.errno`` in the codebase by new ``OSError`` subclasses (``PermissionError``, ``FileNotFoundError``, etc.). pytest 5.0.1 (2019-07-04) @@ -1922,20 +1921,20 @@ pytest 5.0.1 (2019-07-04) Bug Fixes --------- -- `#5479 `_: Improve quoting in ``raises`` match failure message. +- :issue:`5479`: Improve quoting in ``raises`` match failure message. -- `#5523 `_: Fixed using multiple short options together in the command-line (for example ``-vs``) in Python 3.8+. +- :issue:`5523`: Fixed using multiple short options together in the command-line (for example ``-vs``) in Python 3.8+. -- `#5547 `_: ``--step-wise`` now handles ``xfail(strict=True)`` markers properly. +- :issue:`5547`: ``--step-wise`` now handles ``xfail(strict=True)`` markers properly. Improved Documentation ---------------------- -- `#5517 `_: Improve "Declaring new hooks" section in chapter "Writing Plugins" +- :issue:`5517`: Improve "Declaring new hooks" section in chapter "Writing Plugins" pytest 5.0.0 (2019-06-28) @@ -1951,16 +1950,16 @@ For more details, see our :std:doc:`Python 2.7 and 3.4 support plan `_: Pytest no longer accepts prefixes of command-line arguments, for example +- :issue:`1149`: Pytest no longer accepts prefixes of command-line arguments, for example typing ``pytest --doctest-mod`` inplace of ``--doctest-modules``. This was previously allowed where the ``ArgumentParser`` thought it was unambiguous, but this could be incorrect due to delayed parsing of options for plugins. - See for example issues `#1149 `__, - `#3413 `__, and - `#4009 `__. + See for example issues :issue:`1149`, + :issue:`3413`, and + :issue:`4009`. -- `#5402 `_: **PytestDeprecationWarning are now errors by default.** +- :issue:`5402`: **PytestDeprecationWarning are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestDeprecationWarning`` now generate errors @@ -1981,10 +1980,10 @@ Removals But this will stop working when pytest ``5.1`` is released. **If you have concerns** about the removal of a specific feature, please add a - comment to `#5402 `__. + comment to :issue:`5402`. -- `#5412 `_: ``ExceptionInfo`` objects (returned by ``pytest.raises``) now have the same ``str`` representation as ``repr``, which +- :issue:`5412`: ``ExceptionInfo`` objects (returned by ``pytest.raises``) now have the same ``str`` representation as ``repr``, which avoids some confusion when users use ``print(e)`` to inspect the object. This means code like: @@ -2010,11 +2009,11 @@ Removals Deprecations ------------ -- `#4488 `_: The removal of the ``--result-log`` option and module has been postponed to (tentatively) pytest 6.0 as +- :issue:`4488`: The removal of the ``--result-log`` option and module has been postponed to (tentatively) pytest 6.0 as the team has not yet got around to implement a good alternative for it. -- `#466 `_: The ``funcargnames`` attribute has been an alias for ``fixturenames`` since +- :issue:`466`: The ``funcargnames`` attribute has been an alias for ``fixturenames`` since pytest 2.3, and is now deprecated in code too. @@ -2022,13 +2021,13 @@ Deprecations Features -------- -- `#3457 `_: New :func:`~_pytest.hookspec.pytest_assertion_pass` +- :issue:`3457`: New :func:`~_pytest.hookspec.pytest_assertion_pass` hook, called with context information when an assertion *passes*. This hook is still **experimental** so use it with caution. -- `#5440 `_: The :mod:`faulthandler` standard library +- :issue:`5440`: The :mod:`faulthandler` standard library module is now enabled by default to help users diagnose crashes in C modules. This functionality was provided by integrating the external @@ -2038,10 +2037,10 @@ Features For more information see the docs: :ref:`faulthandler`. -- `#5452 `_: When warnings are configured as errors, pytest warnings now appear as originating from ``pytest.`` instead of the internal ``_pytest.warning_types.`` module. +- :issue:`5452`: When warnings are configured as errors, pytest warnings now appear as originating from ``pytest.`` instead of the internal ``_pytest.warning_types.`` module. -- `#5125 `_: ``Session.exitcode`` values are now coded in ``pytest.ExitCode``, an ``IntEnum``. This makes the exit code available for consumer code and are more explicit other than just documentation. User defined exit codes are still valid, but should be used with caution. +- :issue:`5125`: ``Session.exitcode`` values are now coded in ``pytest.ExitCode``, an ``IntEnum``. This makes the exit code available for consumer code and are more explicit other than just documentation. User defined exit codes are still valid, but should be used with caution. The team doesn't expect this change to break test suites or plugins in general, except in esoteric/specific scenarios. @@ -2052,20 +2051,20 @@ Features Bug Fixes --------- -- `#1403 `_: Switch from ``imp`` to ``importlib``. +- :issue:`1403`: Switch from ``imp`` to ``importlib``. -- `#1671 `_: The name of the ``.pyc`` files cached by the assertion writer now includes the pytest version +- :issue:`1671`: The name of the ``.pyc`` files cached by the assertion writer now includes the pytest version to avoid stale caches. -- `#2761 `_: Honor :pep:`235` on case-insensitive file systems. +- :issue:`2761`: Honor :pep:`235` on case-insensitive file systems. -- `#5078 `_: Test module is no longer double-imported when using ``--pyargs``. +- :issue:`5078`: Test module is no longer double-imported when using ``--pyargs``. -- `#5260 `_: Improved comparison of byte strings. +- :issue:`5260`: Improved comparison of byte strings. When comparing bytes, the assertion message used to show the byte numeric value when showing the differences:: @@ -2084,60 +2083,60 @@ Bug Fixes E Use -v to get the full diff -- `#5335 `_: Colorize level names when the level in the logging format is formatted using +- :issue:`5335`: Colorize level names when the level in the logging format is formatted using '%(levelname).Xs' (truncated fixed width alignment), where X is an integer. -- `#5354 `_: Fix ``pytest.mark.parametrize`` when the argvalues is an iterator. +- :issue:`5354`: Fix ``pytest.mark.parametrize`` when the argvalues is an iterator. -- `#5370 `_: Revert unrolling of ``all()`` to fix ``NameError`` on nested comprehensions. +- :issue:`5370`: Revert unrolling of ``all()`` to fix ``NameError`` on nested comprehensions. -- `#5371 `_: Revert unrolling of ``all()`` to fix incorrect handling of generators with ``if``. +- :issue:`5371`: Revert unrolling of ``all()`` to fix incorrect handling of generators with ``if``. -- `#5372 `_: Revert unrolling of ``all()`` to fix incorrect assertion when using ``all()`` in an expression. +- :issue:`5372`: Revert unrolling of ``all()`` to fix incorrect assertion when using ``all()`` in an expression. -- `#5383 `_: ``-q`` has again an impact on the style of the collected items +- :issue:`5383`: ``-q`` has again an impact on the style of the collected items (``--collect-only``) when ``--log-cli-level`` is used. -- `#5389 `_: Fix regressions of `#5063 `__ for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``. +- :issue:`5389`: Fix regressions of `#5063 `__ for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``. -- `#5390 `_: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods. +- :issue:`5390`: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods. -- `#5404 `_: Emit a warning when attempting to unwrap a broken object raises an exception, - for easier debugging (`#5080 `__). +- :issue:`5404`: Emit a warning when attempting to unwrap a broken object raises an exception, + for easier debugging (:issue:`5080`). -- `#5432 `_: Prevent "already imported" warnings from assertion rewriter when invoking pytest in-process multiple times. +- :issue:`5432`: Prevent "already imported" warnings from assertion rewriter when invoking pytest in-process multiple times. -- `#5433 `_: Fix assertion rewriting in packages (``__init__.py``). +- :issue:`5433`: Fix assertion rewriting in packages (``__init__.py``). -- `#5444 `_: Fix ``--stepwise`` mode when the first file passed on the command-line fails to collect. +- :issue:`5444`: Fix ``--stepwise`` mode when the first file passed on the command-line fails to collect. -- `#5482 `_: Fix bug introduced in 4.6.0 causing collection errors when passing +- :issue:`5482`: Fix bug introduced in 4.6.0 causing collection errors when passing more than 2 positional arguments to ``pytest.mark.parametrize``. -- `#5505 `_: Fix crash when discovery fails while using ``-p no:terminal``. +- :issue:`5505`: Fix crash when discovery fails while using ``-p no:terminal``. Improved Documentation ---------------------- -- `#5315 `_: Expand docs on mocking classes and dictionaries with ``monkeypatch``. +- :issue:`5315`: Expand docs on mocking classes and dictionaries with ``monkeypatch``. -- `#5416 `_: Fix PytestUnknownMarkWarning in run/skip example. +- :issue:`5416`: Fix PytestUnknownMarkWarning in run/skip example. pytest 4.6.11 (2020-06-04) @@ -2146,12 +2145,12 @@ pytest 4.6.11 (2020-06-04) Bug Fixes --------- -- `#6334 `_: Fix summary entries appearing twice when ``f/F`` and ``s/S`` report chars were used at the same time in the ``-r`` command-line option (for example ``-rFf``). +- :issue:`6334`: Fix summary entries appearing twice when ``f/F`` and ``s/S`` report chars were used at the same time in the ``-r`` command-line option (for example ``-rFf``). The upper case variants were never documented and the preferred form should be the lower case. -- `#7310 `_: Fix ``UnboundLocalError: local variable 'letter' referenced before +- :issue:`7310`: Fix ``UnboundLocalError: local variable 'letter' referenced before assignment`` in ``_pytest.terminal.pytest_report_teststatus()`` when plugins return report objects in an unconventional state. @@ -2168,14 +2167,14 @@ pytest 4.6.10 (2020-05-08) Features -------- -- `#6870 `_: New ``Config.invocation_args`` attribute containing the unchanged arguments passed to ``pytest.main()``. +- :issue:`6870`: New ``Config.invocation_args`` attribute containing the unchanged arguments passed to ``pytest.main()``. Remark: while this is technically a new feature and according to our :ref:`policy ` it should not have been backported, we have opened an exception in this particular case because it fixes a serious interaction with ``pytest-xdist``, so it can also be considered a bugfix. Trivial/Internal Changes ------------------------ -- `#6404 `_: Remove usage of ``parser`` module, deprecated in Python 3.9. +- :issue:`6404`: Remove usage of ``parser`` module, deprecated in Python 3.9. pytest 4.6.9 (2020-01-04) @@ -2184,7 +2183,7 @@ pytest 4.6.9 (2020-01-04) Bug Fixes --------- -- `#6301 `_: Fix assertion rewriting for egg-based distributions and ``editable`` installs (``pip install --editable``). +- :issue:`6301`: Fix assertion rewriting for egg-based distributions and ``editable`` installs (``pip install --editable``). pytest 4.6.8 (2019-12-19) @@ -2193,21 +2192,21 @@ pytest 4.6.8 (2019-12-19) Features -------- -- `#5471 `_: JUnit XML now includes a timestamp and hostname in the testsuite tag. +- :issue:`5471`: JUnit XML now includes a timestamp and hostname in the testsuite tag. Bug Fixes --------- -- `#5430 `_: junitxml: Logs for failed test are now passed to junit report in case the test fails during call phase. +- :issue:`5430`: junitxml: Logs for failed test are now passed to junit report in case the test fails during call phase. Trivial/Internal Changes ------------------------ -- `#6345 `_: Pin ``colorama`` to ``0.4.1`` only for Python 3.4 so newer Python versions can still receive colorama updates. +- :issue:`6345`: Pin ``colorama`` to ``0.4.1`` only for Python 3.4 so newer Python versions can still receive colorama updates. pytest 4.6.7 (2019-12-05) @@ -2216,10 +2215,10 @@ pytest 4.6.7 (2019-12-05) Bug Fixes --------- -- `#5477 `_: The XML file produced by ``--junitxml`` now correctly contain a ```` root element. +- :issue:`5477`: The XML file produced by ``--junitxml`` now correctly contain a ```` root element. -- `#6044 `_: Properly ignore ``FileNotFoundError`` (``OSError.errno == NOENT`` in Python 2) exceptions when trying to remove old temporary directories, +- :issue:`6044`: Properly ignore ``FileNotFoundError`` (``OSError.errno == NOENT`` in Python 2) exceptions when trying to remove old temporary directories, for instance when multiple processes try to remove the same directory (common with ``pytest-xdist`` for example). @@ -2230,24 +2229,24 @@ pytest 4.6.6 (2019-10-11) Bug Fixes --------- -- `#5523 `_: Fixed using multiple short options together in the command-line (for example ``-vs``) in Python 3.8+. +- :issue:`5523`: Fixed using multiple short options together in the command-line (for example ``-vs``) in Python 3.8+. -- `#5537 `_: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the +- :issue:`5537`: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the standard library on Python 3.8+. -- `#5806 `_: Fix "lexer" being used when uploading to bpaste.net from ``--pastebin`` to "text". +- :issue:`5806`: Fix "lexer" being used when uploading to bpaste.net from ``--pastebin`` to "text". -- `#5902 `_: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``. +- :issue:`5902`: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``. Trivial/Internal Changes ------------------------ -- `#5801 `_: Fixes python version checks (detected by ``flake8-2020``) in case python4 becomes a thing. +- :issue:`5801`: Fixes python version checks (detected by ``flake8-2020``) in case python4 becomes a thing. pytest 4.6.5 (2019-08-05) @@ -2256,20 +2255,20 @@ pytest 4.6.5 (2019-08-05) Bug Fixes --------- -- `#4344 `_: Fix RuntimeError/StopIteration when trying to collect package with "__init__.py" only. +- :issue:`4344`: Fix RuntimeError/StopIteration when trying to collect package with "__init__.py" only. -- `#5478 `_: Fix encode error when using unicode strings in exceptions with ``pytest.raises``. +- :issue:`5478`: Fix encode error when using unicode strings in exceptions with ``pytest.raises``. -- `#5524 `_: Fix issue where ``tmp_path`` and ``tmpdir`` would not remove directories containing files marked as read-only, +- :issue:`5524`: Fix issue where ``tmp_path`` and ``tmpdir`` would not remove directories containing files marked as read-only, which could lead to pytest crashing when executed a second time with the ``--basetemp`` option. -- `#5547 `_: ``--step-wise`` now handles ``xfail(strict=True)`` markers properly. +- :issue:`5547`: ``--step-wise`` now handles ``xfail(strict=True)`` markers properly. -- `#5650 `_: Improved output when parsing an ini configuration file fails. +- :issue:`5650`: Improved output when parsing an ini configuration file fails. pytest 4.6.4 (2019-06-28) ========================= @@ -2277,18 +2276,18 @@ pytest 4.6.4 (2019-06-28) Bug Fixes --------- -- `#5404 `_: Emit a warning when attempting to unwrap a broken object raises an exception, - for easier debugging (`#5080 `__). +- :issue:`5404`: Emit a warning when attempting to unwrap a broken object raises an exception, + for easier debugging (:issue:`5080`). -- `#5444 `_: Fix ``--stepwise`` mode when the first file passed on the command-line fails to collect. +- :issue:`5444`: Fix ``--stepwise`` mode when the first file passed on the command-line fails to collect. -- `#5482 `_: Fix bug introduced in 4.6.0 causing collection errors when passing +- :issue:`5482`: Fix bug introduced in 4.6.0 causing collection errors when passing more than 2 positional arguments to ``pytest.mark.parametrize``. -- `#5505 `_: Fix crash when discovery fails while using ``-p no:terminal``. +- :issue:`5505`: Fix crash when discovery fails while using ``-p no:terminal``. pytest 4.6.3 (2019-06-11) @@ -2297,14 +2296,14 @@ pytest 4.6.3 (2019-06-11) Bug Fixes --------- -- `#5383 `_: ``-q`` has again an impact on the style of the collected items +- :issue:`5383`: ``-q`` has again an impact on the style of the collected items (``--collect-only``) when ``--log-cli-level`` is used. -- `#5389 `_: Fix regressions of `#5063 `__ for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``. +- :issue:`5389`: Fix regressions of `#5063 `__ for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``. -- `#5390 `_: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods. +- :issue:`5390`: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods. pytest 4.6.2 (2019-06-03) @@ -2313,13 +2312,13 @@ pytest 4.6.2 (2019-06-03) Bug Fixes --------- -- `#5370 `_: Revert unrolling of ``all()`` to fix ``NameError`` on nested comprehensions. +- :issue:`5370`: Revert unrolling of ``all()`` to fix ``NameError`` on nested comprehensions. -- `#5371 `_: Revert unrolling of ``all()`` to fix incorrect handling of generators with ``if``. +- :issue:`5371`: Revert unrolling of ``all()`` to fix incorrect handling of generators with ``if``. -- `#5372 `_: Revert unrolling of ``all()`` to fix incorrect assertion when using ``all()`` in an expression. +- :issue:`5372`: Revert unrolling of ``all()`` to fix incorrect assertion when using ``all()`` in an expression. pytest 4.6.1 (2019-06-02) @@ -2328,10 +2327,10 @@ pytest 4.6.1 (2019-06-02) Bug Fixes --------- -- `#5354 `_: Fix ``pytest.mark.parametrize`` when the argvalues is an iterator. +- :issue:`5354`: Fix ``pytest.mark.parametrize`` when the argvalues is an iterator. -- `#5358 `_: Fix assertion rewriting of ``all()`` calls to deal with non-generators. +- :issue:`5358`: Fix assertion rewriting of ``all()`` calls to deal with non-generators. pytest 4.6.0 (2019-05-31) @@ -2348,68 +2347,68 @@ For more details, see our :std:doc:`Python 2.7 and 3.4 support plan `_: Added the ``junit_log_passing_tests`` ini value which can be used to enable or disable logging of passing test output in the Junit XML file. +- :issue:`4559`: Added the ``junit_log_passing_tests`` ini value which can be used to enable or disable logging of passing test output in the Junit XML file. -- `#4956 `_: pytester's ``testdir.spawn`` uses ``tmpdir`` as HOME/USERPROFILE directory. +- :issue:`4956`: pytester's ``testdir.spawn`` uses ``tmpdir`` as HOME/USERPROFILE directory. -- `#5062 `_: Unroll calls to ``all`` to full for-loops with assertion rewriting for better failure messages, especially when using Generator Expressions. +- :issue:`5062`: Unroll calls to ``all`` to full for-loops with assertion rewriting for better failure messages, especially when using Generator Expressions. -- `#5063 `_: Switch from ``pkg_resources`` to ``importlib-metadata`` for entrypoint detection for improved performance and import time. +- :issue:`5063`: Switch from ``pkg_resources`` to ``importlib-metadata`` for entrypoint detection for improved performance and import time. -- `#5091 `_: The output for ini options in ``--help`` has been improved. +- :issue:`5091`: The output for ini options in ``--help`` has been improved. -- `#5269 `_: ``pytest.importorskip`` includes the ``ImportError`` now in the default ``reason``. +- :issue:`5269`: ``pytest.importorskip`` includes the ``ImportError`` now in the default ``reason``. -- `#5311 `_: Captured logs that are output for each failing test are formatted using the +- :issue:`5311`: Captured logs that are output for each failing test are formatted using the ColoredLevelFormatter. -- `#5312 `_: Improved formatting of multiline log messages in Python 3. +- :issue:`5312`: Improved formatting of multiline log messages in Python 3. Bug Fixes --------- -- `#2064 `_: The debugging plugin imports the wrapped ``Pdb`` class (``--pdbcls``) on-demand now. +- :issue:`2064`: The debugging plugin imports the wrapped ``Pdb`` class (``--pdbcls``) on-demand now. -- `#4908 `_: The ``pytest_enter_pdb`` hook gets called with post-mortem (``--pdb``). +- :issue:`4908`: The ``pytest_enter_pdb`` hook gets called with post-mortem (``--pdb``). -- `#5036 `_: Fix issue where fixtures dependent on other parametrized fixtures would be erroneously parametrized. +- :issue:`5036`: Fix issue where fixtures dependent on other parametrized fixtures would be erroneously parametrized. -- `#5256 `_: Handle internal error due to a lone surrogate unicode character not being representable in Jython. +- :issue:`5256`: Handle internal error due to a lone surrogate unicode character not being representable in Jython. -- `#5257 `_: Ensure that ``sys.stdout.mode`` does not include ``'b'`` as it is a text stream. +- :issue:`5257`: Ensure that ``sys.stdout.mode`` does not include ``'b'`` as it is a text stream. -- `#5278 `_: Pytest's internal python plugin can be disabled using ``-p no:python`` again. +- :issue:`5278`: Pytest's internal python plugin can be disabled using ``-p no:python`` again. -- `#5286 `_: Fix issue with ``disable_test_id_escaping_and_forfeit_all_rights_to_community_support`` option not working when using a list of test IDs in parametrized tests. +- :issue:`5286`: Fix issue with ``disable_test_id_escaping_and_forfeit_all_rights_to_community_support`` option not working when using a list of test IDs in parametrized tests. -- `#5330 `_: Show the test module being collected when emitting ``PytestCollectionWarning`` messages for +- :issue:`5330`: Show the test module being collected when emitting ``PytestCollectionWarning`` messages for test classes with ``__init__`` and ``__new__`` methods to make it easier to pin down the problem. -- `#5333 `_: Fix regression in 4.5.0 with ``--lf`` not re-running all tests with known failures from non-selected tests. +- :issue:`5333`: Fix regression in 4.5.0 with ``--lf`` not re-running all tests with known failures from non-selected tests. Improved Documentation ---------------------- -- `#5250 `_: Expand docs on use of ``setenv`` and ``delenv`` with ``monkeypatch``. +- :issue:`5250`: Expand docs on use of ``setenv`` and ``delenv`` with ``monkeypatch``. pytest 4.5.0 (2019-05-11) @@ -2418,44 +2417,44 @@ pytest 4.5.0 (2019-05-11) Features -------- -- `#4826 `_: A warning is now emitted when unknown marks are used as a decorator. +- :issue:`4826`: A warning is now emitted when unknown marks are used as a decorator. This is often due to a typo, which can lead to silently broken tests. -- `#4907 `_: Show XFail reason as part of JUnitXML message field. +- :issue:`4907`: Show XFail reason as part of JUnitXML message field. -- `#5013 `_: Messages from crash reports are displayed within test summaries now, truncated to the terminal width. +- :issue:`5013`: Messages from crash reports are displayed within test summaries now, truncated to the terminal width. -- `#5023 `_: New flag ``--strict-markers`` that triggers an error when unknown markers (e.g. those not registered using the :confval:`markers` option in the configuration file) are used in the test suite. +- :issue:`5023`: New flag ``--strict-markers`` that triggers an error when unknown markers (e.g. those not registered using the :confval:`markers` option in the configuration file) are used in the test suite. The existing ``--strict`` option has the same behavior currently, but can be augmented in the future for additional checks. -- `#5026 `_: Assertion failure messages for sequences and dicts contain the number of different items now. +- :issue:`5026`: Assertion failure messages for sequences and dicts contain the number of different items now. -- `#5034 `_: Improve reporting with ``--lf`` and ``--ff`` (run-last-failure). +- :issue:`5034`: Improve reporting with ``--lf`` and ``--ff`` (run-last-failure). -- `#5035 `_: The ``--cache-show`` option/action accepts an optional glob to show only matching cache entries. +- :issue:`5035`: The ``--cache-show`` option/action accepts an optional glob to show only matching cache entries. -- `#5059 `_: Standard input (stdin) can be given to pytester's ``Testdir.run()`` and ``Testdir.popen()``. +- :issue:`5059`: Standard input (stdin) can be given to pytester's ``Testdir.run()`` and ``Testdir.popen()``. -- `#5068 `_: The ``-r`` option learnt about ``A`` to display all reports (including passed ones) in the short test summary. +- :issue:`5068`: The ``-r`` option learnt about ``A`` to display all reports (including passed ones) in the short test summary. -- `#5108 `_: The short test summary is displayed after passes with output (``-rP``). +- :issue:`5108`: The short test summary is displayed after passes with output (``-rP``). -- `#5172 `_: The ``--last-failed`` (``--lf``) option got smarter and will now skip entire files if all tests +- :issue:`5172`: The ``--last-failed`` (``--lf``) option got smarter and will now skip entire files if all tests of that test file have passed in previous runs, greatly speeding up collection. -- `#5177 `_: Introduce new specific warning ``PytestWarning`` subclasses to make it easier to filter warnings based on the class, rather than on the message. The new subclasses are: +- :issue:`5177`: Introduce new specific warning ``PytestWarning`` subclasses to make it easier to filter warnings based on the class, rather than on the message. The new subclasses are: * ``PytestAssertRewriteWarning`` @@ -2471,14 +2470,14 @@ Features * ``PytestUnknownMarkWarning`` -- `#5202 `_: New ``record_testsuite_property`` session-scoped fixture allows users to log ```` tags at the ``testsuite`` +- :issue:`5202`: New ``record_testsuite_property`` session-scoped fixture allows users to log ```` tags at the ``testsuite`` level with the ``junitxml`` plugin. The generated XML is compatible with the latest xunit standard, contrary to the properties recorded by ``record_property`` and ``record_xml_attribute``. -- `#5214 `_: The default logging format has been changed to improve readability. Here is an +- :issue:`5214`: The default logging format has been changed to improve readability. Here is an example of a previous logging message:: test_log_cli_enabled_disabled.py 3 CRITICAL critical message logged by test @@ -2490,55 +2489,55 @@ Features The formatting can be changed through the :confval:`log_format` configuration option. -- `#5220 `_: ``--fixtures`` now also shows fixture scope for scopes other than ``"function"``. +- :issue:`5220`: ``--fixtures`` now also shows fixture scope for scopes other than ``"function"``. Bug Fixes --------- -- `#5113 `_: Deselected items from plugins using ``pytest_collect_modifyitems`` as a hookwrapper are correctly reported now. +- :issue:`5113`: Deselected items from plugins using ``pytest_collect_modifyitems`` as a hookwrapper are correctly reported now. -- `#5144 `_: With usage errors ``exitstatus`` is set to ``EXIT_USAGEERROR`` in the ``pytest_sessionfinish`` hook now as expected. +- :issue:`5144`: With usage errors ``exitstatus`` is set to ``EXIT_USAGEERROR`` in the ``pytest_sessionfinish`` hook now as expected. -- `#5235 `_: ``outcome.exit`` is not used with ``EOF`` in the pdb wrapper anymore, but only with ``quit``. +- :issue:`5235`: ``outcome.exit`` is not used with ``EOF`` in the pdb wrapper anymore, but only with ``quit``. Improved Documentation ---------------------- -- `#4935 `_: Expand docs on registering marks and the effect of ``--strict``. +- :issue:`4935`: Expand docs on registering marks and the effect of ``--strict``. Trivial/Internal Changes ------------------------ -- `#4942 `_: ``logging.raiseExceptions`` is not set to ``False`` anymore. +- :issue:`4942`: ``logging.raiseExceptions`` is not set to ``False`` anymore. -- `#5013 `_: pytest now depends on :pypi:`wcwidth` to properly track unicode character sizes for more precise terminal output. +- :issue:`5013`: pytest now depends on :pypi:`wcwidth` to properly track unicode character sizes for more precise terminal output. -- `#5059 `_: pytester's ``Testdir.popen()`` uses ``stdout`` and ``stderr`` via keyword arguments with defaults now (``subprocess.PIPE``). +- :issue:`5059`: pytester's ``Testdir.popen()`` uses ``stdout`` and ``stderr`` via keyword arguments with defaults now (``subprocess.PIPE``). -- `#5069 `_: The code for the short test summary in the terminal was moved to the terminal plugin. +- :issue:`5069`: The code for the short test summary in the terminal was moved to the terminal plugin. -- `#5082 `_: Improved validation of kwargs for various methods in the pytester plugin. +- :issue:`5082`: Improved validation of kwargs for various methods in the pytester plugin. -- `#5202 `_: ``record_property`` now emits a ``PytestWarning`` when used with ``junit_family=xunit2``: the fixture generates +- :issue:`5202`: ``record_property`` now emits a ``PytestWarning`` when used with ``junit_family=xunit2``: the fixture generates ``property`` tags as children of ``testcase``, which is not permitted according to the most `recent schema `__. -- `#5239 `_: Pin ``pluggy`` to ``< 1.0`` so we don't update to ``1.0`` automatically when +- :issue:`5239`: Pin ``pluggy`` to ``< 1.0`` so we don't update to ``1.0`` automatically when it gets released: there are planned breaking changes, and we want to ensure pytest properly supports ``pluggy 1.0``. @@ -2549,13 +2548,13 @@ pytest 4.4.2 (2019-05-08) Bug Fixes --------- -- `#5089 `_: Fix crash caused by error in ``__repr__`` function with both ``showlocals`` and verbose output enabled. +- :issue:`5089`: Fix crash caused by error in ``__repr__`` function with both ``showlocals`` and verbose output enabled. -- `#5139 `_: Eliminate core dependency on 'terminal' plugin. +- :issue:`5139`: Eliminate core dependency on 'terminal' plugin. -- `#5229 `_: Require ``pluggy>=0.11.0`` which reverts a dependency to ``importlib-metadata`` added in ``0.10.0``. +- :issue:`5229`: Require ``pluggy>=0.11.0`` which reverts a dependency to ``importlib-metadata`` added in ``0.10.0``. The ``importlib-metadata`` package cannot be imported when installed as an egg and causes issues when relying on ``setup.py`` to install test dependencies. @@ -2563,17 +2562,17 @@ Bug Fixes Improved Documentation ---------------------- -- `#5171 `_: Doc: ``pytest_ignore_collect``, ``pytest_collect_directory``, ``pytest_collect_file`` and ``pytest_pycollect_makemodule`` hooks's 'path' parameter documented type is now ``py.path.local`` +- :issue:`5171`: Doc: ``pytest_ignore_collect``, ``pytest_collect_directory``, ``pytest_collect_file`` and ``pytest_pycollect_makemodule`` hooks's 'path' parameter documented type is now ``py.path.local`` -- `#5188 `_: Improve help for ``--runxfail`` flag. +- :issue:`5188`: Improve help for ``--runxfail`` flag. Trivial/Internal Changes ------------------------ -- `#5182 `_: Removed internal and unused ``_pytest.deprecated.MARK_INFO_ATTRIBUTE``. +- :issue:`5182`: Removed internal and unused ``_pytest.deprecated.MARK_INFO_ATTRIBUTE``. pytest 4.4.1 (2019-04-15) @@ -2582,16 +2581,16 @@ pytest 4.4.1 (2019-04-15) Bug Fixes --------- -- `#5031 `_: Environment variables are properly restored when using pytester's ``testdir`` fixture. +- :issue:`5031`: Environment variables are properly restored when using pytester's ``testdir`` fixture. -- `#5039 `_: Fix regression with ``--pdbcls``, which stopped working with local modules in 4.0.0. +- :issue:`5039`: Fix regression with ``--pdbcls``, which stopped working with local modules in 4.0.0. -- `#5092 `_: Produce a warning when unknown keywords are passed to ``pytest.param(...)``. +- :issue:`5092`: Produce a warning when unknown keywords are passed to ``pytest.param(...)``. -- `#5098 `_: Invalidate import caches with ``monkeypatch.syspath_prepend``, which is required with namespace packages being used. +- :issue:`5098`: Invalidate import caches with ``monkeypatch.syspath_prepend``, which is required with namespace packages being used. pytest 4.4.0 (2019-03-29) @@ -2600,16 +2599,16 @@ pytest 4.4.0 (2019-03-29) Features -------- -- `#2224 `_: ``async`` test functions are skipped and a warning is emitted when a suitable +- :issue:`2224`: ``async`` test functions are skipped and a warning is emitted when a suitable async plugin is not installed (such as ``pytest-asyncio`` or ``pytest-trio``). Previously ``async`` functions would not execute at all but still be marked as "passed". -- `#2482 `_: Include new ``disable_test_id_escaping_and_forfeit_all_rights_to_community_support`` option to disable ascii-escaping in parametrized values. This may cause a series of problems and as the name makes clear, use at your own risk. +- :issue:`2482`: Include new ``disable_test_id_escaping_and_forfeit_all_rights_to_community_support`` option to disable ascii-escaping in parametrized values. This may cause a series of problems and as the name makes clear, use at your own risk. -- `#4718 `_: The ``-p`` option can now be used to early-load plugins also by entry-point name, instead of just +- :issue:`4718`: The ``-p`` option can now be used to early-load plugins also by entry-point name, instead of just by module name. This makes it possible to early load external plugins like ``pytest-cov`` in the command-line:: @@ -2617,52 +2616,52 @@ Features pytest -p pytest_cov -- `#4855 `_: The ``--pdbcls`` option handles classes via module attributes now (e.g. +- :issue:`4855`: The ``--pdbcls`` option handles classes via module attributes now (e.g. ``pdb:pdb.Pdb`` with :pypi:`pdbpp`), and its validation was improved. -- `#4875 `_: The :confval:`testpaths` configuration option is now displayed next +- :issue:`4875`: The :confval:`testpaths` configuration option is now displayed next to the ``rootdir`` and ``inifile`` lines in the pytest header if the option is in effect, i.e., directories or file names were not explicitly passed in the command line. Also, ``inifile`` is only displayed if there's a configuration file, instead of an empty ``inifile:`` string. -- `#4911 `_: Doctests can be skipped now dynamically using ``pytest.skip()``. +- :issue:`4911`: Doctests can be skipped now dynamically using ``pytest.skip()``. -- `#4920 `_: Internal refactorings have been made in order to make the implementation of the +- :issue:`4920`: Internal refactorings have been made in order to make the implementation of the `pytest-subtests `__ plugin possible, which adds unittest sub-test support and a new ``subtests`` fixture as discussed in - `#1367 `__. + :issue:`1367`. For details on the internal refactorings, please see the details on the related PR. -- `#4931 `_: pytester's ``LineMatcher`` asserts that the passed lines are a sequence. +- :issue:`4931`: pytester's ``LineMatcher`` asserts that the passed lines are a sequence. -- `#4936 `_: Handle ``-p plug`` after ``-p no:plug``. +- :issue:`4936`: Handle ``-p plug`` after ``-p no:plug``. This can be used to override a blocked plugin (e.g. in "addopts") from the command line etc. -- `#4951 `_: Output capturing is handled correctly when only capturing via fixtures (capsys, capfs) with ``pdb.set_trace()``. +- :issue:`4951`: Output capturing is handled correctly when only capturing via fixtures (capsys, capfs) with ``pdb.set_trace()``. -- `#4956 `_: ``pytester`` sets ``$HOME`` and ``$USERPROFILE`` to the temporary directory during test runs. +- :issue:`4956`: ``pytester`` sets ``$HOME`` and ``$USERPROFILE`` to the temporary directory during test runs. This ensures to not load configuration files from the real user's home directory. -- `#4980 `_: Namespace packages are handled better with ``monkeypatch.syspath_prepend`` and ``testdir.syspathinsert`` (via ``pkg_resources.fixup_namespace_packages``). +- :issue:`4980`: Namespace packages are handled better with ``monkeypatch.syspath_prepend`` and ``testdir.syspathinsert`` (via ``pkg_resources.fixup_namespace_packages``). -- `#4993 `_: The stepwise plugin reports status information now. +- :issue:`4993`: The stepwise plugin reports status information now. -- `#5008 `_: If a ``setup.cfg`` file contains ``[tool:pytest]`` and also the no longer supported ``[pytest]`` section, pytest will use ``[tool:pytest]`` ignoring ``[pytest]``. Previously it would unconditionally error out. +- :issue:`5008`: If a ``setup.cfg`` file contains ``[tool:pytest]`` and also the no longer supported ``[pytest]`` section, pytest will use ``[tool:pytest]`` ignoring ``[pytest]``. Previously it would unconditionally error out. This makes it simpler for plugins to support old pytest versions. @@ -2671,70 +2670,70 @@ Features Bug Fixes --------- -- `#1895 `_: Fix bug where fixtures requested dynamically via ``request.getfixturevalue()`` might be teardown +- :issue:`1895`: Fix bug where fixtures requested dynamically via ``request.getfixturevalue()`` might be teardown before the requesting fixture. -- `#4851 `_: pytester unsets ``PYTEST_ADDOPTS`` now to not use outer options with ``testdir.runpytest()``. +- :issue:`4851`: pytester unsets ``PYTEST_ADDOPTS`` now to not use outer options with ``testdir.runpytest()``. -- `#4903 `_: Use the correct modified time for years after 2038 in rewritten ``.pyc`` files. +- :issue:`4903`: Use the correct modified time for years after 2038 in rewritten ``.pyc`` files. -- `#4928 `_: Fix line offsets with ``ScopeMismatch`` errors. +- :issue:`4928`: Fix line offsets with ``ScopeMismatch`` errors. -- `#4957 `_: ``-p no:plugin`` is handled correctly for default (internal) plugins now, e.g. with ``-p no:capture``. +- :issue:`4957`: ``-p no:plugin`` is handled correctly for default (internal) plugins now, e.g. with ``-p no:capture``. Previously they were loaded (imported) always, making e.g. the ``capfd`` fixture available. -- `#4968 `_: The pdb ``quit`` command is handled properly when used after the ``debug`` command with :pypi:`pdbpp`. +- :issue:`4968`: The pdb ``quit`` command is handled properly when used after the ``debug`` command with :pypi:`pdbpp`. -- `#4975 `_: Fix the interpretation of ``-qq`` option where it was being considered as ``-v`` instead. +- :issue:`4975`: Fix the interpretation of ``-qq`` option where it was being considered as ``-v`` instead. -- `#4978 `_: ``outcomes.Exit`` is not swallowed in ``assertrepr_compare`` anymore. +- :issue:`4978`: ``outcomes.Exit`` is not swallowed in ``assertrepr_compare`` anymore. -- `#4988 `_: Close logging's file handler explicitly when the session finishes. +- :issue:`4988`: Close logging's file handler explicitly when the session finishes. -- `#5003 `_: Fix line offset with mark collection error (off by one). +- :issue:`5003`: Fix line offset with mark collection error (off by one). Improved Documentation ---------------------- -- `#4974 `_: Update docs for ``pytest_cmdline_parse`` hook to note availability liminations +- :issue:`4974`: Update docs for ``pytest_cmdline_parse`` hook to note availability liminations Trivial/Internal Changes ------------------------ -- `#4718 `_: ``pluggy>=0.9`` is now required. +- :issue:`4718`: ``pluggy>=0.9`` is now required. -- `#4815 `_: ``funcsigs>=1.0`` is now required for Python 2.7. +- :issue:`4815`: ``funcsigs>=1.0`` is now required for Python 2.7. -- `#4829 `_: Some left-over internal code related to ``yield`` tests has been removed. +- :issue:`4829`: Some left-over internal code related to ``yield`` tests has been removed. -- `#4890 `_: Remove internally unused ``anypython`` fixture from the pytester plugin. +- :issue:`4890`: Remove internally unused ``anypython`` fixture from the pytester plugin. -- `#4912 `_: Remove deprecated Sphinx directive, ``add_description_unit()``, +- :issue:`4912`: Remove deprecated Sphinx directive, ``add_description_unit()``, pin sphinx-removed-in to >= 0.2.0 to support Sphinx 2.0. -- `#4913 `_: Fix pytest tests invocation with custom ``PYTHONPATH``. +- :issue:`4913`: Fix pytest tests invocation with custom ``PYTHONPATH``. -- `#4965 `_: New ``pytest_report_to_serializable`` and ``pytest_report_from_serializable`` **experimental** hooks. +- :issue:`4965`: New ``pytest_report_to_serializable`` and ``pytest_report_from_serializable`` **experimental** hooks. These hooks will be used by ``pytest-xdist``, ``pytest-subtests``, and the replacement for resultlog to serialize and customize reports. @@ -2745,7 +2744,7 @@ Trivial/Internal Changes Feedback is welcome from plugin authors and users alike. -- `#4987 `_: ``Collector.repr_failure`` respects the ``--tb`` option, but only defaults to ``short`` now (with ``auto``). +- :issue:`4987`: ``Collector.repr_failure`` respects the ``--tb`` option, but only defaults to ``short`` now (with ``auto``). pytest 4.3.1 (2019-03-11) @@ -2754,20 +2753,20 @@ pytest 4.3.1 (2019-03-11) Bug Fixes --------- -- `#4810 `_: Logging messages inside ``pytest_runtest_logreport()`` are now properly captured and displayed. +- :issue:`4810`: Logging messages inside ``pytest_runtest_logreport()`` are now properly captured and displayed. -- `#4861 `_: Improve validation of contents written to captured output so it behaves the same as when capture is disabled. +- :issue:`4861`: Improve validation of contents written to captured output so it behaves the same as when capture is disabled. -- `#4898 `_: Fix ``AttributeError: FixtureRequest has no 'confg' attribute`` bug in ``testdir.copy_example``. +- :issue:`4898`: Fix ``AttributeError: FixtureRequest has no 'confg' attribute`` bug in ``testdir.copy_example``. Trivial/Internal Changes ------------------------ -- `#4768 `_: Avoid pkg_resources import at the top-level. +- :issue:`4768`: Avoid pkg_resources import at the top-level. pytest 4.3.0 (2019-02-16) @@ -2776,7 +2775,7 @@ pytest 4.3.0 (2019-02-16) Deprecations ------------ -- `#4724 `_: ``pytest.warns()`` now emits a warning when it receives unknown keyword arguments. +- :issue:`4724`: ``pytest.warns()`` now emits a warning when it receives unknown keyword arguments. This will be changed into an error in the future. @@ -2785,31 +2784,31 @@ Deprecations Features -------- -- `#2753 `_: Usage errors from argparse are mapped to pytest's ``UsageError``. +- :issue:`2753`: Usage errors from argparse are mapped to pytest's ``UsageError``. -- `#3711 `_: Add the ``--ignore-glob`` parameter to exclude test-modules with Unix shell-style wildcards. +- :issue:`3711`: Add the ``--ignore-glob`` parameter to exclude test-modules with Unix shell-style wildcards. Add the :globalvar:`collect_ignore_glob` for ``conftest.py`` to exclude test-modules with Unix shell-style wildcards. -- `#4698 `_: The warning about Python 2.7 and 3.4 not being supported in pytest 5.0 has been removed. +- :issue:`4698`: The warning about Python 2.7 and 3.4 not being supported in pytest 5.0 has been removed. In the end it was considered to be more of a nuisance than actual utility and users of those Python versions shouldn't have problems as ``pip`` will not install pytest 5.0 on those interpreters. -- `#4707 `_: With the help of new ``set_log_path()`` method there is a way to set ``log_file`` paths from hooks. +- :issue:`4707`: With the help of new ``set_log_path()`` method there is a way to set ``log_file`` paths from hooks. Bug Fixes --------- -- `#4651 `_: ``--help`` and ``--version`` are handled with ``UsageError``. +- :issue:`4651`: ``--help`` and ``--version`` are handled with ``UsageError``. -- `#4782 `_: Fix ``AssertionError`` with collection of broken symlinks with packages. +- :issue:`4782`: Fix ``AssertionError`` with collection of broken symlinks with packages. pytest 4.2.1 (2019-02-12) @@ -2818,45 +2817,45 @@ pytest 4.2.1 (2019-02-12) Bug Fixes --------- -- `#2895 `_: The ``pytest_report_collectionfinish`` hook now is also called with ``--collect-only``. +- :issue:`2895`: The ``pytest_report_collectionfinish`` hook now is also called with ``--collect-only``. -- `#3899 `_: Do not raise ``UsageError`` when an imported package has a ``pytest_plugins.py`` child module. +- :issue:`3899`: Do not raise ``UsageError`` when an imported package has a ``pytest_plugins.py`` child module. -- `#4347 `_: Fix output capturing when using pdb++ with recursive debugging. +- :issue:`4347`: Fix output capturing when using pdb++ with recursive debugging. -- `#4592 `_: Fix handling of ``collect_ignore`` via parent ``conftest.py``. +- :issue:`4592`: Fix handling of ``collect_ignore`` via parent ``conftest.py``. -- `#4700 `_: Fix regression where ``setUpClass`` would always be called in subclasses even if all tests +- :issue:`4700`: Fix regression where ``setUpClass`` would always be called in subclasses even if all tests were skipped by a ``unittest.skip()`` decorator applied in the subclass. -- `#4739 `_: Fix ``parametrize(... ids=)`` when the function returns non-strings. +- :issue:`4739`: Fix ``parametrize(... ids=)`` when the function returns non-strings. -- `#4745 `_: Fix/improve collection of args when passing in ``__init__.py`` and a test file. +- :issue:`4745`: Fix/improve collection of args when passing in ``__init__.py`` and a test file. -- `#4770 `_: ``more_itertools`` is now constrained to <6.0.0 when required for Python 2.7 compatibility. +- :issue:`4770`: ``more_itertools`` is now constrained to <6.0.0 when required for Python 2.7 compatibility. -- `#526 `_: Fix "ValueError: Plugin already registered" exceptions when running in build directories that symlink to actual source. +- :issue:`526`: Fix "ValueError: Plugin already registered" exceptions when running in build directories that symlink to actual source. Improved Documentation ---------------------- -- `#3899 `_: Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins. +- :issue:`3899`: Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins. -- `#4324 `_: Document how to use ``raises`` and ``does_not_raise`` to write parametrized tests with conditional raises. +- :issue:`4324`: Document how to use ``raises`` and ``does_not_raise`` to write parametrized tests with conditional raises. -- `#4709 `_: Document how to customize test failure messages when using +- :issue:`4709`: Document how to customize test failure messages when using ``pytest.warns``. @@ -2864,7 +2863,7 @@ Improved Documentation Trivial/Internal Changes ------------------------ -- `#4741 `_: Some verbosity related attributes of the TerminalReporter plugin are now +- :issue:`4741`: Some verbosity related attributes of the TerminalReporter plugin are now read only properties. @@ -2874,79 +2873,79 @@ pytest 4.2.0 (2019-01-30) Features -------- -- `#3094 `_: :doc:`Classic xunit-style ` functions and methods +- :issue:`3094`: :doc:`Classic xunit-style ` functions and methods now obey the scope of *autouse* fixtures. This fixes a number of surprising issues like ``setup_method`` being called before session-scoped - autouse fixtures (see `#517 `__ for an example). + autouse fixtures (see :issue:`517` for an example). -- `#4627 `_: Display a message at the end of the test session when running under Python 2.7 and 3.4 that pytest 5.0 will no longer +- :issue:`4627`: Display a message at the end of the test session when running under Python 2.7 and 3.4 that pytest 5.0 will no longer support those Python versions. -- `#4660 `_: The number of *selected* tests now are also displayed when the ``-k`` or ``-m`` flags are used. +- :issue:`4660`: The number of *selected* tests now are also displayed when the ``-k`` or ``-m`` flags are used. -- `#4688 `_: ``pytest_report_teststatus`` hook now can also receive a ``config`` parameter. +- :issue:`4688`: ``pytest_report_teststatus`` hook now can also receive a ``config`` parameter. -- `#4691 `_: ``pytest_terminal_summary`` hook now can also receive a ``config`` parameter. +- :issue:`4691`: ``pytest_terminal_summary`` hook now can also receive a ``config`` parameter. Bug Fixes --------- -- `#3547 `_: ``--junitxml`` can emit XML compatible with Jenkins xUnit. +- :issue:`3547`: ``--junitxml`` can emit XML compatible with Jenkins xUnit. ``junit_family`` INI option accepts ``legacy|xunit1``, which produces old style output, and ``xunit2`` that conforms more strictly to https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd -- `#4280 `_: Improve quitting from pdb, especially with ``--trace``. +- :issue:`4280`: Improve quitting from pdb, especially with ``--trace``. Using ``q[quit]`` after ``pdb.set_trace()`` will quit pytest also. -- `#4402 `_: Warning summary now groups warnings by message instead of by test id. +- :issue:`4402`: Warning summary now groups warnings by message instead of by test id. This makes the output more compact and better conveys the general idea of how much code is actually generating warnings, instead of how many tests call that code. -- `#4536 `_: ``monkeypatch.delattr`` handles class descriptors like ``staticmethod``/``classmethod``. +- :issue:`4536`: ``monkeypatch.delattr`` handles class descriptors like ``staticmethod``/``classmethod``. -- `#4649 `_: Restore marks being considered keywords for keyword expressions. +- :issue:`4649`: Restore marks being considered keywords for keyword expressions. -- `#4653 `_: ``tmp_path`` fixture and other related ones provides resolved path (a.k.a real path) +- :issue:`4653`: ``tmp_path`` fixture and other related ones provides resolved path (a.k.a real path) -- `#4667 `_: ``pytest_terminal_summary`` uses result from ``pytest_report_teststatus`` hook, rather than hardcoded strings. +- :issue:`4667`: ``pytest_terminal_summary`` uses result from ``pytest_report_teststatus`` hook, rather than hardcoded strings. -- `#4669 `_: Correctly handle ``unittest.SkipTest`` exception containing non-ascii characters on Python 2. +- :issue:`4669`: Correctly handle ``unittest.SkipTest`` exception containing non-ascii characters on Python 2. -- `#4680 `_: Ensure the ``tmpdir`` and the ``tmp_path`` fixtures are the same folder. +- :issue:`4680`: Ensure the ``tmpdir`` and the ``tmp_path`` fixtures are the same folder. -- `#4681 `_: Ensure ``tmp_path`` is always a real path. +- :issue:`4681`: Ensure ``tmp_path`` is always a real path. Trivial/Internal Changes ------------------------ -- `#4643 `_: Use ``a.item()`` instead of the deprecated ``np.asscalar(a)`` in ``pytest.approx``. +- :issue:`4643`: Use ``a.item()`` instead of the deprecated ``np.asscalar(a)`` in ``pytest.approx``. ``np.asscalar`` has been :doc:`deprecated ` in ``numpy 1.16.``. -- `#4657 `_: Copy saferepr from pylib +- :issue:`4657`: Copy saferepr from pylib -- `#4668 `_: The verbose word for expected failures in the teststatus report changes from ``xfail`` to ``XFAIL`` to be consistent with other test outcomes. +- :issue:`4668`: The verbose word for expected failures in the teststatus report changes from ``xfail`` to ``XFAIL`` to be consistent with other test outcomes. pytest 4.1.1 (2019-01-12) @@ -2955,30 +2954,30 @@ pytest 4.1.1 (2019-01-12) Bug Fixes --------- -- `#2256 `_: Show full repr with ``assert a==b`` and ``-vv``. +- :issue:`2256`: Show full repr with ``assert a==b`` and ``-vv``. -- `#3456 `_: Extend Doctest-modules to ignore mock objects. +- :issue:`3456`: Extend Doctest-modules to ignore mock objects. -- `#4617 `_: Fixed ``pytest.warns`` bug when context manager is reused (e.g. multiple parametrization). +- :issue:`4617`: Fixed ``pytest.warns`` bug when context manager is reused (e.g. multiple parametrization). -- `#4631 `_: Don't rewrite assertion when ``__getattr__`` is broken +- :issue:`4631`: Don't rewrite assertion when ``__getattr__`` is broken Improved Documentation ---------------------- -- `#3375 `_: Document that using ``setup.cfg`` may crash other tools or cause hard to track down problems because it uses a different parser than ``pytest.ini`` or ``tox.ini`` files. +- :issue:`3375`: Document that using ``setup.cfg`` may crash other tools or cause hard to track down problems because it uses a different parser than ``pytest.ini`` or ``tox.ini`` files. Trivial/Internal Changes ------------------------ -- `#4602 `_: Uninstall ``hypothesis`` in regen tox env. +- :issue:`4602`: Uninstall ``hypothesis`` in regen tox env. pytest 4.1.0 (2019-01-05) @@ -2987,106 +2986,106 @@ pytest 4.1.0 (2019-01-05) Removals -------- -- `#2169 `_: ``pytest.mark.parametrize``: in previous versions, errors raised by id functions were suppressed and changed into warnings. Now the exceptions are propagated, along with a pytest message informing the node, parameter value and index where the exception occurred. +- :issue:`2169`: ``pytest.mark.parametrize``: in previous versions, errors raised by id functions were suppressed and changed into warnings. Now the exceptions are propagated, along with a pytest message informing the node, parameter value and index where the exception occurred. -- `#3078 `_: Remove legacy internal warnings system: ``config.warn``, ``Node.warn``. The ``pytest_logwarning`` now issues a warning when implemented. +- :issue:`3078`: Remove legacy internal warnings system: ``config.warn``, ``Node.warn``. The ``pytest_logwarning`` now issues a warning when implemented. See our :ref:`docs ` on information on how to update your code. -- `#3079 `_: Removed support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated. +- :issue:`3079`: Removed support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated. See our :ref:`docs ` on information on how to update your code. -- `#3082 `_: Removed support for applying marks directly to values in ``@pytest.mark.parametrize``. Use ``pytest.param`` instead. +- :issue:`3082`: Removed support for applying marks directly to values in ``@pytest.mark.parametrize``. Use ``pytest.param`` instead. See our :ref:`docs ` on information on how to update your code. -- `#3083 `_: Removed ``Metafunc.addcall``. This was the predecessor mechanism to ``@pytest.mark.parametrize``. +- :issue:`3083`: Removed ``Metafunc.addcall``. This was the predecessor mechanism to ``@pytest.mark.parametrize``. See our :ref:`docs ` on information on how to update your code. -- `#3085 `_: Removed support for passing strings to ``pytest.main``. Now, always pass a list of strings instead. +- :issue:`3085`: Removed support for passing strings to ``pytest.main``. Now, always pass a list of strings instead. See our :ref:`docs ` on information on how to update your code. -- `#3086 `_: ``[pytest]`` section in **setup.cfg** files is no longer supported, use ``[tool:pytest]`` instead. ``setup.cfg`` files +- :issue:`3086`: ``[pytest]`` section in **setup.cfg** files is no longer supported, use ``[tool:pytest]`` instead. ``setup.cfg`` files are meant for use with ``distutils``, and a section named ``pytest`` has notoriously been a source of conflicts and bugs. Note that for **pytest.ini** and **tox.ini** files the section remains ``[pytest]``. -- `#3616 `_: Removed the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now. +- :issue:`3616`: Removed the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now. See our :ref:`docs ` on information on how to update your code. -- `#4421 `_: Removed the implementation of the ``pytest_namespace`` hook. +- :issue:`4421`: Removed the implementation of the ``pytest_namespace`` hook. See our :ref:`docs ` on information on how to update your code. -- `#4489 `_: Removed ``request.cached_setup``. This was the predecessor mechanism to modern fixtures. +- :issue:`4489`: Removed ``request.cached_setup``. This was the predecessor mechanism to modern fixtures. See our :ref:`docs ` on information on how to update your code. -- `#4535 `_: Removed the deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago. +- :issue:`4535`: Removed the deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago. -- `#4543 `_: Removed support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``@pytest.fixture`` decorator instead. +- :issue:`4543`: Removed support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``@pytest.fixture`` decorator instead. See our :ref:`docs ` on information on how to update your code. -- `#4545 `_: Calling fixtures directly is now always an error instead of a warning. +- :issue:`4545`: Calling fixtures directly is now always an error instead of a warning. See our :ref:`docs ` on information on how to update your code. -- `#4546 `_: Remove ``Node.get_marker(name)`` the return value was not usable for more than a existence check. +- :issue:`4546`: Remove ``Node.get_marker(name)`` the return value was not usable for more than a existence check. Use ``Node.get_closest_marker(name)`` as a replacement. -- `#4547 `_: The deprecated ``record_xml_property`` fixture has been removed, use the more generic ``record_property`` instead. +- :issue:`4547`: The deprecated ``record_xml_property`` fixture has been removed, use the more generic ``record_property`` instead. See our :ref:`docs ` for more information. -- `#4548 `_: An error is now raised if the ``pytest_plugins`` variable is defined in a non-top-level ``conftest.py`` file (i.e., not residing in the ``rootdir``). +- :issue:`4548`: An error is now raised if the ``pytest_plugins`` variable is defined in a non-top-level ``conftest.py`` file (i.e., not residing in the ``rootdir``). See our :ref:`docs ` for more information. -- `#891 `_: Remove ``testfunction.markername`` attributes - use ``Node.iter_markers(name=None)`` to iterate them. +- :issue:`891`: Remove ``testfunction.markername`` attributes - use ``Node.iter_markers(name=None)`` to iterate them. Deprecations ------------ -- `#3050 `_: Deprecated the ``pytest.config`` global. +- :issue:`3050`: Deprecated the ``pytest.config`` global. See :ref:`pytest.config global deprecated` for rationale. -- `#3974 `_: Passing the ``message`` parameter of ``pytest.raises`` now issues a ``DeprecationWarning``. +- :issue:`3974`: Passing the ``message`` parameter of ``pytest.raises`` now issues a ``DeprecationWarning``. It is a common mistake to think this parameter will match the exception message, while in fact it only serves to provide a custom message in case the ``pytest.raises`` check fails. To avoid this mistake and because it is believed to be little used, pytest is deprecating it without providing an alternative for the moment. - If you have concerns about this, please comment on `issue #3974 `__. + If you have concerns about this, please comment on :issue:`3974`. -- `#4435 `_: Deprecated ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``. +- :issue:`4435`: Deprecated ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``. See :std:ref:`raises-warns-exec` for rationale and examples. @@ -3095,7 +3094,7 @@ Deprecations Features -------- -- `#3191 `_: A warning is now issued when assertions are made for ``None``. +- :issue:`3191`: A warning is now issued when assertions are made for ``None``. This is a common source of confusion among new users, which write: @@ -3120,25 +3119,25 @@ Features will not issue the warning. -- `#3632 `_: Richer equality comparison introspection on ``AssertionError`` for objects created using `attrs `__ or :mod:`dataclasses` (Python 3.7+, :pypi:`backported to 3.6 `). +- :issue:`3632`: Richer equality comparison introspection on ``AssertionError`` for objects created using `attrs `__ or :mod:`dataclasses` (Python 3.7+, :pypi:`backported to 3.6 `). -- `#4278 `_: ``CACHEDIR.TAG`` files are now created inside cache directories. +- :issue:`4278`: ``CACHEDIR.TAG`` files are now created inside cache directories. Those files are part of the `Cache Directory Tagging Standard `__, and can be used by backup or synchronization programs to identify pytest's cache directory as such. -- `#4292 `_: ``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``. This allows us to better handle ``pdb`` exiting. +- :issue:`4292`: ``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``. This allows us to better handle ``pdb`` exiting. -- `#4371 `_: Updated the ``--collect-only`` option to display test descriptions when ran using ``--verbose``. +- :issue:`4371`: Updated the ``--collect-only`` option to display test descriptions when ran using ``--verbose``. -- `#4386 `_: Restructured ``ExceptionInfo`` object construction and ensure incomplete instances have a ``repr``/``str``. +- :issue:`4386`: Restructured ``ExceptionInfo`` object construction and ensure incomplete instances have a ``repr``/``str``. -- `#4416 `_: pdb: added support for keyword arguments with ``pdb.set_trace``. +- :issue:`4416`: pdb: added support for keyword arguments with ``pdb.set_trace``. It handles ``header`` similar to Python 3.7 does it, and forwards any other keyword arguments to the ``Pdb`` constructor. @@ -3146,7 +3145,7 @@ Features This allows for ``__import__("pdb").set_trace(skip=["foo.*"])``. -- `#4483 `_: Added ini parameter ``junit_duration_report`` to optionally report test call durations, excluding setup and teardown times. +- :issue:`4483`: Added ini parameter ``junit_duration_report`` to optionally report test call durations, excluding setup and teardown times. The JUnit XML specification and the default pytest behavior is to include setup and teardown times in the test duration report. You can include just the call durations instead (excluding setup and teardown) by adding this to your ``pytest.ini`` file: @@ -3157,12 +3156,12 @@ Features junit_duration_report = call -- `#4532 `_: ``-ra`` now will show errors and failures last, instead of as the first items in the summary. +- :issue:`4532`: ``-ra`` now will show errors and failures last, instead of as the first items in the summary. This makes it easier to obtain a list of errors and failures to run tests selectively. -- `#4599 `_: ``pytest.importorskip`` now supports a ``reason`` parameter, which will be shown when the +- :issue:`4599`: ``pytest.importorskip`` now supports a ``reason`` parameter, which will be shown when the requested module cannot be imported. @@ -3170,39 +3169,39 @@ Features Bug Fixes --------- -- `#3532 `_: ``-p`` now accepts its argument without a space between the value, for example ``-pmyplugin``. +- :issue:`3532`: ``-p`` now accepts its argument without a space between the value, for example ``-pmyplugin``. -- `#4327 `_: ``approx`` again works with more generic containers, more precisely instances of ``Iterable`` and ``Sized`` instead of more restrictive ``Sequence``. +- :issue:`4327`: ``approx`` again works with more generic containers, more precisely instances of ``Iterable`` and ``Sized`` instead of more restrictive ``Sequence``. -- `#4397 `_: Ensure that node ids are printable. +- :issue:`4397`: Ensure that node ids are printable. -- `#4435 `_: Fixed ``raises(..., 'code(string)')`` frame filename. +- :issue:`4435`: Fixed ``raises(..., 'code(string)')`` frame filename. -- `#4458 `_: Display actual test ids in ``--collect-only``. +- :issue:`4458`: Display actual test ids in ``--collect-only``. Improved Documentation ---------------------- -- `#4557 `_: Markers example documentation page updated to support latest pytest version. +- :issue:`4557`: Markers example documentation page updated to support latest pytest version. -- `#4558 `_: Update cache documentation example to correctly show cache hit and miss. +- :issue:`4558`: Update cache documentation example to correctly show cache hit and miss. -- `#4580 `_: Improved detailed summary report documentation. +- :issue:`4580`: Improved detailed summary report documentation. Trivial/Internal Changes ------------------------ -- `#4447 `_: Changed the deprecation type of ``--result-log`` to ``PytestDeprecationWarning``. +- :issue:`4447`: Changed the deprecation type of ``--result-log`` to ``PytestDeprecationWarning``. It was decided to remove this feature at the next major revision. @@ -3213,23 +3212,23 @@ pytest 4.0.2 (2018-12-13) Bug Fixes --------- -- `#4265 `_: Validate arguments from the ``PYTEST_ADDOPTS`` environment variable and the ``addopts`` ini option separately. +- :issue:`4265`: Validate arguments from the ``PYTEST_ADDOPTS`` environment variable and the ``addopts`` ini option separately. -- `#4435 `_: Fix ``raises(..., 'code(string)')`` frame filename. +- :issue:`4435`: Fix ``raises(..., 'code(string)')`` frame filename. -- `#4500 `_: When a fixture yields and a log call is made after the test runs, and, if the test is interrupted, capture attributes are ``None``. +- :issue:`4500`: When a fixture yields and a log call is made after the test runs, and, if the test is interrupted, capture attributes are ``None``. -- `#4538 `_: Raise ``TypeError`` for ``with raises(..., match=)``. +- :issue:`4538`: Raise ``TypeError`` for ``with raises(..., match=)``. Improved Documentation ---------------------- -- `#1495 `_: Document common doctest fixture directory tree structure pitfalls +- :issue:`1495`: Document common doctest fixture directory tree structure pitfalls pytest 4.0.1 (2018-11-23) @@ -3238,35 +3237,35 @@ pytest 4.0.1 (2018-11-23) Bug Fixes --------- -- `#3952 `_: Display warnings before "short test summary info" again, but still later warnings in the end. +- :issue:`3952`: Display warnings before "short test summary info" again, but still later warnings in the end. -- `#4386 `_: Handle uninitialized exceptioninfo in repr/str. +- :issue:`4386`: Handle uninitialized exceptioninfo in repr/str. -- `#4393 `_: Do not create ``.gitignore``/``README.md`` files in existing cache directories. +- :issue:`4393`: Do not create ``.gitignore``/``README.md`` files in existing cache directories. -- `#4400 `_: Rearrange warning handling for the yield test errors so the opt-out in 4.0.x correctly works. +- :issue:`4400`: Rearrange warning handling for the yield test errors so the opt-out in 4.0.x correctly works. -- `#4405 `_: Fix collection of testpaths with ``--pyargs``. +- :issue:`4405`: Fix collection of testpaths with ``--pyargs``. -- `#4412 `_: Fix assertion rewriting involving ``Starred`` + side-effects. +- :issue:`4412`: Fix assertion rewriting involving ``Starred`` + side-effects. -- `#4425 `_: Ensure we resolve the absolute path when the given ``--basetemp`` is a relative path. +- :issue:`4425`: Ensure we resolve the absolute path when the given ``--basetemp`` is a relative path. Trivial/Internal Changes ------------------------ -- `#4315 `_: Use ``pkg_resources.parse_version`` instead of ``LooseVersion`` in minversion check. +- :issue:`4315`: Use ``pkg_resources.parse_version`` instead of ``LooseVersion`` in minversion check. -- `#4440 `_: Adjust the stack level of some internal pytest warnings. +- :issue:`4440`: Adjust the stack level of some internal pytest warnings. pytest 4.0.0 (2018-11-13) @@ -3275,7 +3274,7 @@ pytest 4.0.0 (2018-11-13) Removals -------- -- `#3737 `_: **RemovedInPytest4Warnings are now errors by default.** +- :issue:`3737`: **RemovedInPytest4Warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``RemovedInPytest4Warnings`` now generate errors @@ -3296,10 +3295,10 @@ Removals But this will stop working when pytest ``4.1`` is released. **If you have concerns** about the removal of a specific feature, please add a - comment to `#4348 `__. + comment to :issue:`4348`. -- `#4358 `_: Remove the ``::()`` notation to denote a test class instance in node ids. +- :issue:`4358`: Remove the ``::()`` notation to denote a test class instance in node ids. Previously, node ids that contain test instances would use ``::()`` to denote the instance like this:: @@ -3314,7 +3313,7 @@ Removals The extra ``::()`` might have been removed in some places internally already, which then led to confusion in places where it was expected, e.g. with - ``--deselect`` (`#4127 `_). + ``--deselect`` (:issue:`4127`). Test class instances are also not listed with ``--collect-only`` anymore. @@ -3323,7 +3322,7 @@ Removals Features -------- -- `#4270 `_: The ``cache_dir`` option uses ``$TOX_ENV_DIR`` as prefix (if set in the environment). +- :issue:`4270`: The ``cache_dir`` option uses ``$TOX_ENV_DIR`` as prefix (if set in the environment). This uses a different cache per tox environment by default. @@ -3332,7 +3331,7 @@ Features Bug Fixes --------- -- `#3554 `_: Fix ``CallInfo.__repr__`` for when the call is not finished yet. +- :issue:`3554`: Fix ``CallInfo.__repr__`` for when the call is not finished yet. pytest 3.10.1 (2018-11-11) @@ -3341,32 +3340,32 @@ pytest 3.10.1 (2018-11-11) Bug Fixes --------- -- `#4287 `_: Fix nested usage of debugging plugin (pdb), e.g. with pytester's ``testdir.runpytest``. +- :issue:`4287`: Fix nested usage of debugging plugin (pdb), e.g. with pytester's ``testdir.runpytest``. -- `#4304 `_: Block the ``stepwise`` plugin if ``cacheprovider`` is also blocked, as one depends on the other. +- :issue:`4304`: Block the ``stepwise`` plugin if ``cacheprovider`` is also blocked, as one depends on the other. -- `#4306 `_: Parse ``minversion`` as an actual version and not as dot-separated strings. +- :issue:`4306`: Parse ``minversion`` as an actual version and not as dot-separated strings. -- `#4310 `_: Fix duplicate collection due to multiple args matching the same packages. +- :issue:`4310`: Fix duplicate collection due to multiple args matching the same packages. -- `#4321 `_: Fix ``item.nodeid`` with resolved symlinks. +- :issue:`4321`: Fix ``item.nodeid`` with resolved symlinks. -- `#4325 `_: Fix collection of direct symlinked files, where the target does not match ``python_files``. +- :issue:`4325`: Fix collection of direct symlinked files, where the target does not match ``python_files``. -- `#4329 `_: Fix TypeError in report_collect with _collect_report_last_write. +- :issue:`4329`: Fix TypeError in report_collect with _collect_report_last_write. Trivial/Internal Changes ------------------------ -- `#4305 `_: Replace byte/unicode helpers in test_capture with python level syntax. +- :issue:`4305`: Replace byte/unicode helpers in test_capture with python level syntax. pytest 3.10.0 (2018-11-03) @@ -3375,19 +3374,19 @@ pytest 3.10.0 (2018-11-03) Features -------- -- `#2619 `_: Resume capturing output after ``continue`` with ``__import__("pdb").set_trace()``. +- :issue:`2619`: Resume capturing output after ``continue`` with ``__import__("pdb").set_trace()``. This also adds a new ``pytest_leave_pdb`` hook, and passes in ``pdb`` to the existing ``pytest_enter_pdb`` hook. -- `#4147 `_: Add ``--sw``, ``--stepwise`` as an alternative to ``--lf -x`` for stopping at the first failure, but starting the next test invocation from that test. See :ref:`the documentation ` for more info. +- :issue:`4147`: Add ``--sw``, ``--stepwise`` as an alternative to ``--lf -x`` for stopping at the first failure, but starting the next test invocation from that test. See :ref:`the documentation ` for more info. -- `#4188 `_: Make ``--color`` emit colorful dots when not running in verbose mode. Earlier, it would only colorize the test-by-test output if ``--verbose`` was also passed. +- :issue:`4188`: Make ``--color`` emit colorful dots when not running in verbose mode. Earlier, it would only colorize the test-by-test output if ``--verbose`` was also passed. -- `#4225 `_: Improve performance with collection reporting in non-quiet mode with terminals. +- :issue:`4225`: Improve performance with collection reporting in non-quiet mode with terminals. The "collecting …" message is only printed/updated every 0.5s. @@ -3396,45 +3395,45 @@ Features Bug Fixes --------- -- `#2701 `_: Fix false ``RemovedInPytest4Warning: usage of Session... is deprecated, please use pytest`` warnings. +- :issue:`2701`: Fix false ``RemovedInPytest4Warning: usage of Session... is deprecated, please use pytest`` warnings. -- `#4046 `_: Fix problems with running tests in package ``__init__.py`` files. +- :issue:`4046`: Fix problems with running tests in package ``__init__.py`` files. -- `#4260 `_: Swallow warnings during anonymous compilation of source. +- :issue:`4260`: Swallow warnings during anonymous compilation of source. -- `#4262 `_: Fix access denied error when deleting stale directories created by ``tmpdir`` / ``tmp_path``. +- :issue:`4262`: Fix access denied error when deleting stale directories created by ``tmpdir`` / ``tmp_path``. -- `#611 `_: Naming a fixture ``request`` will now raise a warning: the ``request`` fixture is internal and +- :issue:`611`: Naming a fixture ``request`` will now raise a warning: the ``request`` fixture is internal and should not be overwritten as it will lead to internal errors. -- `#4266 `_: Handle (ignore) exceptions raised during collection, e.g. with Django's LazySettings proxy class. +- :issue:`4266`: Handle (ignore) exceptions raised during collection, e.g. with Django's LazySettings proxy class. Improved Documentation ---------------------- -- `#4255 `_: Added missing documentation about the fact that module names passed to filter warnings are not regex-escaped. +- :issue:`4255`: Added missing documentation about the fact that module names passed to filter warnings are not regex-escaped. Trivial/Internal Changes ------------------------ -- `#4272 `_: Display cachedir also in non-verbose mode if non-default. +- :issue:`4272`: Display cachedir also in non-verbose mode if non-default. -- `#4277 `_: pdb: improve message about output capturing with ``set_trace``. +- :issue:`4277`: pdb: improve message about output capturing with ``set_trace``. Do not display "IO-capturing turned off/on" when ``-s`` is used to avoid confusion. -- `#4279 `_: Improve message and stack level of warnings issued by ``monkeypatch.setenv`` when the value of the environment variable is not a ``str``. +- :issue:`4279`: Improve message and stack level of warnings issued by ``monkeypatch.setenv`` when the value of the environment variable is not a ``str``. pytest 3.9.3 (2018-10-27) @@ -3443,36 +3442,36 @@ pytest 3.9.3 (2018-10-27) Bug Fixes --------- -- `#4174 `_: Fix "ValueError: Plugin already registered" with conftest plugins via symlink. +- :issue:`4174`: Fix "ValueError: Plugin already registered" with conftest plugins via symlink. -- `#4181 `_: Handle race condition between creation and deletion of temporary folders. +- :issue:`4181`: Handle race condition between creation and deletion of temporary folders. -- `#4221 `_: Fix bug where the warning summary at the end of the test session was not showing the test where the warning was originated. +- :issue:`4221`: Fix bug where the warning summary at the end of the test session was not showing the test where the warning was originated. -- `#4243 `_: Fix regression when ``stacklevel`` for warnings was passed as positional argument on python2. +- :issue:`4243`: Fix regression when ``stacklevel`` for warnings was passed as positional argument on python2. Improved Documentation ---------------------- -- `#3851 `_: Add reference to ``empty_parameter_set_mark`` ini option in documentation of ``@pytest.mark.parametrize`` +- :issue:`3851`: Add reference to ``empty_parameter_set_mark`` ini option in documentation of ``@pytest.mark.parametrize`` Trivial/Internal Changes ------------------------ -- `#4028 `_: Revert patching of ``sys.breakpointhook`` since it appears to do nothing. +- :issue:`4028`: Revert patching of ``sys.breakpointhook`` since it appears to do nothing. -- `#4233 `_: Apply an import sorter (``reorder-python-imports``) to the codebase. +- :issue:`4233`: Apply an import sorter (``reorder-python-imports``) to the codebase. -- `#4248 `_: Remove use of unnecessary compat shim, six.binary_type +- :issue:`4248`: Remove use of unnecessary compat shim, six.binary_type pytest 3.9.2 (2018-10-22) @@ -3481,29 +3480,29 @@ pytest 3.9.2 (2018-10-22) Bug Fixes --------- -- `#2909 `_: Improve error message when a recursive dependency between fixtures is detected. +- :issue:`2909`: Improve error message when a recursive dependency between fixtures is detected. -- `#3340 `_: Fix logging messages not shown in hooks ``pytest_sessionstart()`` and ``pytest_sessionfinish()``. +- :issue:`3340`: Fix logging messages not shown in hooks ``pytest_sessionstart()`` and ``pytest_sessionfinish()``. -- `#3533 `_: Fix unescaped XML raw objects in JUnit report for skipped tests +- :issue:`3533`: Fix unescaped XML raw objects in JUnit report for skipped tests -- `#3691 `_: Python 2: safely format warning message about passing unicode strings to ``warnings.warn``, which may cause +- :issue:`3691`: Python 2: safely format warning message about passing unicode strings to ``warnings.warn``, which may cause surprising ``MemoryError`` exception when monkey patching ``warnings.warn`` itself. -- `#4026 `_: Improve error message when it is not possible to determine a function's signature. +- :issue:`4026`: Improve error message when it is not possible to determine a function's signature. -- `#4177 `_: Pin ``setuptools>=40.0`` to support ``py_modules`` in ``setup.cfg`` +- :issue:`4177`: Pin ``setuptools>=40.0`` to support ``py_modules`` in ``setup.cfg`` -- `#4179 `_: Restore the tmpdir behaviour of symlinking the current test run. +- :issue:`4179`: Restore the tmpdir behaviour of symlinking the current test run. -- `#4192 `_: Fix filename reported by ``warnings.warn`` when using ``recwarn`` under python2. +- :issue:`4192`: Fix filename reported by ``warnings.warn`` when using ``recwarn`` under python2. pytest 3.9.1 (2018-10-16) @@ -3512,7 +3511,7 @@ pytest 3.9.1 (2018-10-16) Features -------- -- `#4159 `_: For test-suites containing test classes, the information about the subclassed +- :issue:`4159`: For test-suites containing test classes, the information about the subclassed module is now output only if a higher verbosity level is specified (at least "-vv"). @@ -3523,7 +3522,7 @@ pytest 3.9.0 (2018-10-15 - not published due to a release automation bug) Deprecations ------------ -- `#3616 `_: The following accesses have been documented as deprecated for years, but are now actually emitting deprecation warnings. +- :issue:`3616`: The following accesses have been documented as deprecated for years, but are now actually emitting deprecation warnings. * Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances. Now users will this warning:: @@ -3547,121 +3546,121 @@ Deprecations getfuncargvalue is deprecated, use getfixturevalue -- `#3988 `_: Add a Deprecation warning for pytest.ensuretemp as it was deprecated since a while. +- :issue:`3988`: Add a Deprecation warning for pytest.ensuretemp as it was deprecated since a while. Features -------- -- `#2293 `_: Improve usage errors messages by hiding internal details which can be distracting and noisy. +- :issue:`2293`: Improve usage errors messages by hiding internal details which can be distracting and noisy. This has the side effect that some error conditions that previously raised generic errors (such as ``ValueError`` for unregistered marks) are now raising ``Failed`` exceptions. -- `#3332 `_: Improve the error displayed when a ``conftest.py`` file could not be imported. +- :issue:`3332`: Improve the error displayed when a ``conftest.py`` file could not be imported. In order to implement this, a new ``chain`` parameter was added to ``ExceptionInfo.getrepr`` to show or hide chained tracebacks in Python 3 (defaults to ``True``). -- `#3849 `_: Add ``empty_parameter_set_mark=fail_at_collect`` ini option for raising an exception when parametrize collects an empty set. +- :issue:`3849`: Add ``empty_parameter_set_mark=fail_at_collect`` ini option for raising an exception when parametrize collects an empty set. -- `#3964 `_: Log messages generated in the collection phase are shown when +- :issue:`3964`: Log messages generated in the collection phase are shown when live-logging is enabled and/or when they are logged to a file. -- `#3985 `_: Introduce ``tmp_path`` as a fixture providing a Path object. Also introduce ``tmp_path_factory`` as +- :issue:`3985`: Introduce ``tmp_path`` as a fixture providing a Path object. Also introduce ``tmp_path_factory`` as a session-scoped fixture for creating arbitrary temporary directories from any other fixture or test. -- `#4013 `_: Deprecation warnings are now shown even if you customize the warnings filters yourself. In the previous version +- :issue:`4013`: Deprecation warnings are now shown even if you customize the warnings filters yourself. In the previous version any customization would override pytest's filters and deprecation warnings would fall back to being hidden by default. -- `#4073 `_: Allow specification of timeout for ``Testdir.runpytest_subprocess()`` and ``Testdir.run()``. +- :issue:`4073`: Allow specification of timeout for ``Testdir.runpytest_subprocess()`` and ``Testdir.run()``. -- `#4098 `_: Add returncode argument to pytest.exit() to exit pytest with a specific return code. +- :issue:`4098`: Add returncode argument to pytest.exit() to exit pytest with a specific return code. -- `#4102 `_: Reimplement ``pytest.deprecated_call`` using ``pytest.warns`` so it supports the ``match='...'`` keyword argument. +- :issue:`4102`: Reimplement ``pytest.deprecated_call`` using ``pytest.warns`` so it supports the ``match='...'`` keyword argument. This has the side effect that ``pytest.deprecated_call`` now raises ``pytest.fail.Exception`` instead of ``AssertionError``. -- `#4149 `_: Require setuptools>=30.3 and move most of the metadata to ``setup.cfg``. +- :issue:`4149`: Require setuptools>=30.3 and move most of the metadata to ``setup.cfg``. Bug Fixes --------- -- `#2535 `_: Improve error message when test functions of ``unittest.TestCase`` subclasses use a parametrized fixture. +- :issue:`2535`: Improve error message when test functions of ``unittest.TestCase`` subclasses use a parametrized fixture. -- `#3057 `_: ``request.fixturenames`` now correctly returns the name of fixtures created by ``request.getfixturevalue()``. +- :issue:`3057`: ``request.fixturenames`` now correctly returns the name of fixtures created by ``request.getfixturevalue()``. -- `#3946 `_: Warning filters passed as command line options using ``-W`` now take precedence over filters defined in ``ini`` +- :issue:`3946`: Warning filters passed as command line options using ``-W`` now take precedence over filters defined in ``ini`` configuration files. -- `#4066 `_: Fix source reindenting by using ``textwrap.dedent`` directly. +- :issue:`4066`: Fix source reindenting by using ``textwrap.dedent`` directly. -- `#4102 `_: ``pytest.warn`` will capture previously-warned warnings in Python 2. Previously they were never raised. +- :issue:`4102`: ``pytest.warn`` will capture previously-warned warnings in Python 2. Previously they were never raised. -- `#4108 `_: Resolve symbolic links for args. +- :issue:`4108`: Resolve symbolic links for args. This fixes running ``pytest tests/test_foo.py::test_bar``, where ``tests`` is a symlink to ``project/app/tests``: previously ``project/app/conftest.py`` would be ignored for fixtures then. -- `#4132 `_: Fix duplicate printing of internal errors when using ``--pdb``. +- :issue:`4132`: Fix duplicate printing of internal errors when using ``--pdb``. -- `#4135 `_: pathlib based tmpdir cleanup now correctly handles symlinks in the folder. +- :issue:`4135`: pathlib based tmpdir cleanup now correctly handles symlinks in the folder. -- `#4152 `_: Display the filename when encountering ``SyntaxWarning``. +- :issue:`4152`: Display the filename when encountering ``SyntaxWarning``. Improved Documentation ---------------------- -- `#3713 `_: Update usefixtures documentation to clarify that it can't be used with fixture functions. +- :issue:`3713`: Update usefixtures documentation to clarify that it can't be used with fixture functions. -- `#4058 `_: Update fixture documentation to specify that a fixture can be invoked twice in the scope it's defined for. +- :issue:`4058`: Update fixture documentation to specify that a fixture can be invoked twice in the scope it's defined for. -- `#4064 `_: According to unittest.rst, setUpModule and tearDownModule were not implemented, but it turns out they are. So updated the documentation for unittest. +- :issue:`4064`: According to unittest.rst, setUpModule and tearDownModule were not implemented, but it turns out they are. So updated the documentation for unittest. -- `#4151 `_: Add tempir testing example to CONTRIBUTING.rst guide +- :issue:`4151`: Add tempir testing example to CONTRIBUTING.rst guide Trivial/Internal Changes ------------------------ -- `#2293 `_: The internal ``MarkerError`` exception has been removed. +- :issue:`2293`: The internal ``MarkerError`` exception has been removed. -- `#3988 `_: Port the implementation of tmpdir to pathlib. +- :issue:`3988`: Port the implementation of tmpdir to pathlib. -- `#4063 `_: Exclude 0.00 second entries from ``--duration`` output unless ``-vv`` is passed on the command-line. +- :issue:`4063`: Exclude 0.00 second entries from ``--duration`` output unless ``-vv`` is passed on the command-line. -- `#4093 `_: Fixed formatting of string literals in internal tests. +- :issue:`4093`: Fixed formatting of string literals in internal tests. pytest 3.8.2 (2018-10-02) @@ -3670,7 +3669,7 @@ pytest 3.8.2 (2018-10-02) Deprecations and Removals ------------------------- -- `#4036 `_: The ``item`` parameter of ``pytest_warning_captured`` hook is now documented as deprecated. We realized only after +- :issue:`4036`: The ``item`` parameter of ``pytest_warning_captured`` hook is now documented as deprecated. We realized only after the ``3.8`` release that this parameter is incompatible with ``pytest-xdist``. Our policy is to not deprecate features during bug-fix releases, but in this case we believe it makes sense as we are @@ -3685,25 +3684,25 @@ Deprecations and Removals Bug Fixes --------- -- `#3539 `_: Fix reload on assertion rewritten modules. +- :issue:`3539`: Fix reload on assertion rewritten modules. -- `#4034 `_: The ``.user_properties`` attribute of ``TestReport`` objects is a list +- :issue:`4034`: The ``.user_properties`` attribute of ``TestReport`` objects is a list of (name, value) tuples, but could sometimes be instantiated as a tuple of tuples. It is now always a list. -- `#4039 `_: No longer issue warnings about using ``pytest_plugins`` in non-top-level directories when using ``--pyargs``: the +- :issue:`4039`: No longer issue warnings about using ``pytest_plugins`` in non-top-level directories when using ``--pyargs``: the current ``--pyargs`` mechanism is not reliable and might give false negatives. -- `#4040 `_: Exclude empty reports for passed tests when ``-rP`` option is used. +- :issue:`4040`: Exclude empty reports for passed tests when ``-rP`` option is used. -- `#4051 `_: Improve error message when an invalid Python expression is passed to the ``-m`` option. +- :issue:`4051`: Improve error message when an invalid Python expression is passed to the ``-m`` option. -- `#4056 `_: ``MonkeyPatch.setenv`` and ``MonkeyPatch.delenv`` issue a warning if the environment variable name is not ``str`` on Python 2. +- :issue:`4056`: ``MonkeyPatch.setenv`` and ``MonkeyPatch.delenv`` issue a warning if the environment variable name is not ``str`` on Python 2. In Python 2, adding ``unicode`` keys to ``os.environ`` causes problems with ``subprocess`` (and possible other modules), making this a subtle bug specially susceptible when used with ``from __future__ import unicode_literals``. @@ -3713,7 +3712,7 @@ Bug Fixes Improved Documentation ---------------------- -- `#3928 `_: Add possible values for fixture scope to docs. +- :issue:`3928`: Add possible values for fixture scope to docs. pytest 3.8.1 (2018-09-22) @@ -3722,31 +3721,31 @@ pytest 3.8.1 (2018-09-22) Bug Fixes --------- -- `#3286 `_: ``.pytest_cache`` directory is now automatically ignored by Git. Users who would like to contribute a solution for other SCMs please consult/comment on this issue. +- :issue:`3286`: ``.pytest_cache`` directory is now automatically ignored by Git. Users who would like to contribute a solution for other SCMs please consult/comment on this issue. -- `#3749 `_: Fix the following error during collection of tests inside packages:: +- :issue:`3749`: Fix the following error during collection of tests inside packages:: TypeError: object of type 'Package' has no len() -- `#3941 `_: Fix bug where indirect parametrization would consider the scope of all fixtures used by the test function to determine the parametrization scope, and not only the scope of the fixtures being parametrized. +- :issue:`3941`: Fix bug where indirect parametrization would consider the scope of all fixtures used by the test function to determine the parametrization scope, and not only the scope of the fixtures being parametrized. -- `#3973 `_: Fix crash of the assertion rewriter if a test changed the current working directory without restoring it afterwards. +- :issue:`3973`: Fix crash of the assertion rewriter if a test changed the current working directory without restoring it afterwards. -- `#3998 `_: Fix issue that prevented some caplog properties (for example ``record_tuples``) from being available when entering the debugger with ``--pdb``. +- :issue:`3998`: Fix issue that prevented some caplog properties (for example ``record_tuples``) from being available when entering the debugger with ``--pdb``. -- `#3999 `_: Fix ``UnicodeDecodeError`` in python2.x when a class returns a non-ascii binary ``__repr__`` in an assertion which also contains non-ascii text. +- :issue:`3999`: Fix ``UnicodeDecodeError`` in python2.x when a class returns a non-ascii binary ``__repr__`` in an assertion which also contains non-ascii text. Improved Documentation ---------------------- -- `#3996 `_: New :std:doc:`deprecations` page shows all currently +- :issue:`3996`: New :std:doc:`deprecations` page shows all currently deprecated features, the rationale to do so, and alternatives to update your code. It also list features removed from pytest in past major releases to help those with ancient pytest versions to upgrade. @@ -3755,10 +3754,10 @@ Improved Documentation Trivial/Internal Changes ------------------------ -- `#3955 `_: Improve pre-commit detection for changelog filenames +- :issue:`3955`: Improve pre-commit detection for changelog filenames -- `#3975 `_: Remove legacy code around im_func as that was python2 only +- :issue:`3975`: Remove legacy code around im_func as that was python2 only pytest 3.8.0 (2018-09-05) @@ -3767,11 +3766,11 @@ pytest 3.8.0 (2018-09-05) Deprecations and Removals ------------------------- -- `#2452 `_: ``Config.warn`` and ``Node.warn`` have been +- :issue:`2452`: ``Config.warn`` and ``Node.warn`` have been deprecated, see :ref:`config.warn and node.warn deprecated` for rationale and examples. -- `#3936 `_: ``@pytest.mark.filterwarnings`` second parameter is no longer regex-escaped, +- :issue:`3936`: ``@pytest.mark.filterwarnings`` second parameter is no longer regex-escaped, making it possible to actually use regular expressions to check the warning message. **Note**: regex-escaping the match string was an implementation oversight that might break test suites which depend @@ -3782,60 +3781,60 @@ Deprecations and Removals Features -------- -- `#2452 `_: Internal pytest warnings are now issued using the standard ``warnings`` module, making it possible to use +- :issue:`2452`: Internal pytest warnings are now issued using the standard ``warnings`` module, making it possible to use the standard warnings filters to manage those warnings. This introduces ``PytestWarning``, ``PytestDeprecationWarning`` and ``RemovedInPytest4Warning`` warning types as part of the public API. Consult :ref:`the documentation ` for more info. -- `#2908 `_: ``DeprecationWarning`` and ``PendingDeprecationWarning`` are now shown by default if no other warning filter is +- :issue:`2908`: ``DeprecationWarning`` and ``PendingDeprecationWarning`` are now shown by default if no other warning filter is configured. This makes pytest more compliant with :pep:`506#recommended-filter-settings-for-test-runners`. See :ref:`the docs ` for more info. -- `#3251 `_: Warnings are now captured and displayed during test collection. +- :issue:`3251`: Warnings are now captured and displayed during test collection. -- `#3784 `_: ``PYTEST_DISABLE_PLUGIN_AUTOLOAD`` environment variable disables plugin auto-loading when set. +- :issue:`3784`: ``PYTEST_DISABLE_PLUGIN_AUTOLOAD`` environment variable disables plugin auto-loading when set. -- `#3829 `_: Added the ``count`` option to ``console_output_style`` to enable displaying the progress as a count instead of a percentage. +- :issue:`3829`: Added the ``count`` option to ``console_output_style`` to enable displaying the progress as a count instead of a percentage. -- `#3837 `_: Added support for 'xfailed' and 'xpassed' outcomes to the ``pytester.RunResult.assert_outcomes`` signature. +- :issue:`3837`: Added support for 'xfailed' and 'xpassed' outcomes to the ``pytester.RunResult.assert_outcomes`` signature. Bug Fixes --------- -- `#3911 `_: Terminal writer now takes into account unicode character width when writing out progress. +- :issue:`3911`: Terminal writer now takes into account unicode character width when writing out progress. -- `#3913 `_: Pytest now returns with correct exit code (EXIT_USAGEERROR, 4) when called with unknown arguments. +- :issue:`3913`: Pytest now returns with correct exit code (EXIT_USAGEERROR, 4) when called with unknown arguments. -- `#3918 `_: Improve performance of assertion rewriting. +- :issue:`3918`: Improve performance of assertion rewriting. Improved Documentation ---------------------- -- `#3566 `_: Added a blurb in usage.rst for the usage of -r flag which is used to show an extra test summary info. +- :issue:`3566`: Added a blurb in usage.rst for the usage of -r flag which is used to show an extra test summary info. -- `#3907 `_: Corrected type of the exceptions collection passed to ``xfail``: ``raises`` argument accepts a ``tuple`` instead of ``list``. +- :issue:`3907`: Corrected type of the exceptions collection passed to ``xfail``: ``raises`` argument accepts a ``tuple`` instead of ``list``. Trivial/Internal Changes ------------------------ -- `#3853 `_: Removed ``"run all (no recorded failures)"`` message printed with ``--failed-first`` and ``--last-failed`` when there are no failed tests. +- :issue:`3853`: Removed ``"run all (no recorded failures)"`` message printed with ``--failed-first`` and ``--last-failed`` when there are no failed tests. pytest 3.7.4 (2018-08-29) @@ -3844,23 +3843,23 @@ pytest 3.7.4 (2018-08-29) Bug Fixes --------- -- `#3506 `_: Fix possible infinite recursion when writing ``.pyc`` files. +- :issue:`3506`: Fix possible infinite recursion when writing ``.pyc`` files. -- `#3853 `_: Cache plugin now obeys the ``-q`` flag when ``--last-failed`` and ``--failed-first`` flags are used. +- :issue:`3853`: Cache plugin now obeys the ``-q`` flag when ``--last-failed`` and ``--failed-first`` flags are used. -- `#3883 `_: Fix bad console output when using ``console_output_style=classic``. +- :issue:`3883`: Fix bad console output when using ``console_output_style=classic``. -- `#3888 `_: Fix macOS specific code using ``capturemanager`` plugin in doctests. +- :issue:`3888`: Fix macOS specific code using ``capturemanager`` plugin in doctests. Improved Documentation ---------------------- -- `#3902 `_: Fix pytest.org links +- :issue:`3902`: Fix pytest.org links pytest 3.7.3 (2018-08-26) @@ -3869,52 +3868,52 @@ pytest 3.7.3 (2018-08-26) Bug Fixes --------- -- `#3033 `_: Fixtures during teardown can again use ``capsys`` and ``capfd`` to inspect output captured during tests. +- :issue:`3033`: Fixtures during teardown can again use ``capsys`` and ``capfd`` to inspect output captured during tests. -- `#3773 `_: Fix collection of tests from ``__init__.py`` files if they match the ``python_files`` configuration option. +- :issue:`3773`: Fix collection of tests from ``__init__.py`` files if they match the ``python_files`` configuration option. -- `#3796 `_: Fix issue where teardown of fixtures of consecutive sub-packages were executed once, at the end of the outer +- :issue:`3796`: Fix issue where teardown of fixtures of consecutive sub-packages were executed once, at the end of the outer package. -- `#3816 `_: Fix bug where ``--show-capture=no`` option would still show logs printed during fixture teardown. +- :issue:`3816`: Fix bug where ``--show-capture=no`` option would still show logs printed during fixture teardown. -- `#3819 `_: Fix ``stdout/stderr`` not getting captured when real-time cli logging is active. +- :issue:`3819`: Fix ``stdout/stderr`` not getting captured when real-time cli logging is active. -- `#3843 `_: Fix collection error when specifying test functions directly in the command line using ``test.py::test`` syntax together with ``--doctest-modules``. +- :issue:`3843`: Fix collection error when specifying test functions directly in the command line using ``test.py::test`` syntax together with ``--doctest-modules``. -- `#3848 `_: Fix bugs where unicode arguments could not be passed to ``testdir.runpytest`` on Python 2. +- :issue:`3848`: Fix bugs where unicode arguments could not be passed to ``testdir.runpytest`` on Python 2. -- `#3854 `_: Fix double collection of tests within packages when the filename starts with a capital letter. +- :issue:`3854`: Fix double collection of tests within packages when the filename starts with a capital letter. Improved Documentation ---------------------- -- `#3824 `_: Added example for multiple glob pattern matches in ``python_files``. +- :issue:`3824`: Added example for multiple glob pattern matches in ``python_files``. -- `#3833 `_: Added missing docs for ``pytester.Testdir``. +- :issue:`3833`: Added missing docs for ``pytester.Testdir``. -- `#3870 `_: Correct documentation for setuptools integration. +- :issue:`3870`: Correct documentation for setuptools integration. Trivial/Internal Changes ------------------------ -- `#3826 `_: Replace broken type annotations with type comments. +- :issue:`3826`: Replace broken type annotations with type comments. -- `#3845 `_: Remove a reference to issue `#568 `_ from the documentation, which has since been +- :issue:`3845`: Remove a reference to issue :issue:`568` from the documentation, which has since been fixed. @@ -3924,32 +3923,32 @@ pytest 3.7.2 (2018-08-16) Bug Fixes --------- -- `#3671 `_: Fix ``filterwarnings`` not being registered as a builtin mark. +- :issue:`3671`: Fix ``filterwarnings`` not being registered as a builtin mark. -- `#3768 `_, `#3789 `_: Fix test collection from packages mixed with normal directories. +- :issue:`3768`, :issue:`3789`: Fix test collection from packages mixed with normal directories. -- `#3771 `_: Fix infinite recursion during collection if a ``pytest_ignore_collect`` hook returns ``False`` instead of ``None``. +- :issue:`3771`: Fix infinite recursion during collection if a ``pytest_ignore_collect`` hook returns ``False`` instead of ``None``. -- `#3774 `_: Fix bug where decorated fixtures would lose functionality (for example ``@mock.patch``). +- :issue:`3774`: Fix bug where decorated fixtures would lose functionality (for example ``@mock.patch``). -- `#3775 `_: Fix bug where importing modules or other objects with prefix ``pytest_`` prefix would raise a ``PluginValidationError``. +- :issue:`3775`: Fix bug where importing modules or other objects with prefix ``pytest_`` prefix would raise a ``PluginValidationError``. -- `#3788 `_: Fix ``AttributeError`` during teardown of ``TestCase`` subclasses which raise an exception during ``__init__``. +- :issue:`3788`: Fix ``AttributeError`` during teardown of ``TestCase`` subclasses which raise an exception during ``__init__``. -- `#3804 `_: Fix traceback reporting for exceptions with ``__cause__`` cycles. +- :issue:`3804`: Fix traceback reporting for exceptions with ``__cause__`` cycles. Improved Documentation ---------------------- -- `#3746 `_: Add documentation for ``metafunc.config`` that had been mistakenly hidden. +- :issue:`3746`: Add documentation for ``metafunc.config`` that had been mistakenly hidden. pytest 3.7.1 (2018-08-02) @@ -3958,26 +3957,26 @@ pytest 3.7.1 (2018-08-02) Bug Fixes --------- -- `#3473 `_: Raise immediately if ``approx()`` is given an expected value of a type it doesn't understand (e.g. strings, nested dicts, etc.). +- :issue:`3473`: Raise immediately if ``approx()`` is given an expected value of a type it doesn't understand (e.g. strings, nested dicts, etc.). -- `#3712 `_: Correctly represent the dimensions of a numpy array when calling ``repr()`` on ``approx()``. +- :issue:`3712`: Correctly represent the dimensions of a numpy array when calling ``repr()`` on ``approx()``. -- `#3742 `_: Fix incompatibility with third party plugins during collection, which produced the error ``object has no attribute '_collectfile'``. +- :issue:`3742`: Fix incompatibility with third party plugins during collection, which produced the error ``object has no attribute '_collectfile'``. -- `#3745 `_: Display the absolute path if ``cache_dir`` is not relative to the ``rootdir`` instead of failing. +- :issue:`3745`: Display the absolute path if ``cache_dir`` is not relative to the ``rootdir`` instead of failing. -- `#3747 `_: Fix compatibility problem with plugins and the warning code issued by fixture functions when they are called directly. +- :issue:`3747`: Fix compatibility problem with plugins and the warning code issued by fixture functions when they are called directly. -- `#3748 `_: Fix infinite recursion in ``pytest.approx`` with arrays in ``numpy<1.13``. +- :issue:`3748`: Fix infinite recursion in ``pytest.approx`` with arrays in ``numpy<1.13``. -- `#3757 `_: Pin pathlib2 to ``>=2.2.0`` as we require ``__fspath__`` support. +- :issue:`3757`: Pin pathlib2 to ``>=2.2.0`` as we require ``__fspath__`` support. -- `#3763 `_: Fix ``TypeError`` when the assertion message is ``bytes`` in python 3. +- :issue:`3763`: Fix ``TypeError`` when the assertion message is ``bytes`` in python 3. pytest 3.7.0 (2018-07-30) @@ -3986,57 +3985,57 @@ pytest 3.7.0 (2018-07-30) Deprecations and Removals ------------------------- -- `#2639 `_: ``pytest_namespace`` has been :ref:`deprecated `. +- :issue:`2639`: ``pytest_namespace`` has been :ref:`deprecated `. -- `#3661 `_: Calling a fixture function directly, as opposed to request them in a test function, now issues a ``RemovedInPytest4Warning``. See :ref:`the documentation for rationale and examples `. +- :issue:`3661`: Calling a fixture function directly, as opposed to request them in a test function, now issues a ``RemovedInPytest4Warning``. See :ref:`the documentation for rationale and examples `. Features -------- -- `#2283 `_: New ``package`` fixture scope: fixtures are finalized when the last test of a *package* finishes. This feature is considered **experimental**, so use it sparingly. +- :issue:`2283`: New ``package`` fixture scope: fixtures are finalized when the last test of a *package* finishes. This feature is considered **experimental**, so use it sparingly. -- `#3576 `_: ``Node.add_marker`` now supports an ``append=True/False`` parameter to determine whether the mark comes last (default) or first. +- :issue:`3576`: ``Node.add_marker`` now supports an ``append=True/False`` parameter to determine whether the mark comes last (default) or first. -- `#3579 `_: Fixture ``caplog`` now has a ``messages`` property, providing convenient access to the format-interpolated log messages without the extra data provided by the formatter/handler. +- :issue:`3579`: Fixture ``caplog`` now has a ``messages`` property, providing convenient access to the format-interpolated log messages without the extra data provided by the formatter/handler. -- `#3610 `_: New ``--trace`` option to enter the debugger at the start of a test. +- :issue:`3610`: New ``--trace`` option to enter the debugger at the start of a test. -- `#3623 `_: Introduce ``pytester.copy_example`` as helper to do acceptance tests against examples from the project. +- :issue:`3623`: Introduce ``pytester.copy_example`` as helper to do acceptance tests against examples from the project. Bug Fixes --------- -- `#2220 `_: Fix a bug where fixtures overridden by direct parameters (for example parametrization) were being instantiated even if they were not being used by a test. +- :issue:`2220`: Fix a bug where fixtures overridden by direct parameters (for example parametrization) were being instantiated even if they were not being used by a test. -- `#3695 `_: Fix ``ApproxNumpy`` initialisation argument mixup, ``abs`` and ``rel`` tolerances were flipped causing strange comparison results. +- :issue:`3695`: Fix ``ApproxNumpy`` initialisation argument mixup, ``abs`` and ``rel`` tolerances were flipped causing strange comparison results. Add tests to check ``abs`` and ``rel`` tolerances for ``np.array`` and test for expecting ``nan`` with ``np.array()`` -- `#980 `_: Fix truncated locals output in verbose mode. +- :issue:`980`: Fix truncated locals output in verbose mode. Improved Documentation ---------------------- -- `#3295 `_: Correct the usage documentation of ``--last-failed-no-failures`` by adding the missing ``--last-failed`` argument in the presented examples, because they are misleading and lead to think that the missing argument is not needed. +- :issue:`3295`: Correct the usage documentation of ``--last-failed-no-failures`` by adding the missing ``--last-failed`` argument in the presented examples, because they are misleading and lead to think that the missing argument is not needed. Trivial/Internal Changes ------------------------ -- `#3519 `_: Now a ``README.md`` file is created in ``.pytest_cache`` to make it clear why the directory exists. +- :issue:`3519`: Now a ``README.md`` file is created in ``.pytest_cache`` to make it clear why the directory exists. pytest 3.6.4 (2018-07-28) @@ -4045,25 +4044,25 @@ pytest 3.6.4 (2018-07-28) Bug Fixes --------- -- Invoke pytest using ``-mpytest`` so ``sys.path`` does not get polluted by packages installed in ``site-packages``. (`#742 `_) +- Invoke pytest using ``-mpytest`` so ``sys.path`` does not get polluted by packages installed in ``site-packages``. (:issue:`742`) Improved Documentation ---------------------- -- Use ``smtp_connection`` instead of ``smtp`` in fixtures documentation to avoid possible confusion. (`#3592 `_) +- Use ``smtp_connection`` instead of ``smtp`` in fixtures documentation to avoid possible confusion. (:issue:`3592`) Trivial/Internal Changes ------------------------ -- Remove obsolete ``__future__`` imports. (`#2319 `_) +- Remove obsolete ``__future__`` imports. (:issue:`2319`) -- Add CITATION to provide information on how to formally cite pytest. (`#3402 `_) +- Add CITATION to provide information on how to formally cite pytest. (:issue:`3402`) -- Replace broken type annotations with type comments. (`#3635 `_) +- Replace broken type annotations with type comments. (:issue:`3635`) -- Pin ``pluggy`` to ``<0.8``. (`#3727 `_) +- Pin ``pluggy`` to ``<0.8``. (:issue:`3727`) pytest 3.6.3 (2018-07-04) @@ -4073,43 +4072,37 @@ Bug Fixes --------- - Fix ``ImportWarning`` triggered by explicit relative imports in - assertion-rewritten package modules. (`#3061 - `_) + assertion-rewritten package modules. (:issue:`3061`) - Fix error in ``pytest.approx`` when dealing with 0-dimension numpy - arrays. (`#3593 `_) + arrays. (:issue:`3593`) -- No longer raise ``ValueError`` when using the ``get_marker`` API. (`#3605 - `_) +- No longer raise ``ValueError`` when using the ``get_marker`` API. (:issue:`3605`) - Fix problem where log messages with non-ascii characters would not appear in the output log file. - (`#3630 `_) + (:issue:`3630`) - No longer raise ``AttributeError`` when legacy marks can't be stored in - functions. (`#3631 `_) + functions. (:issue:`3631`) Improved Documentation ---------------------- - The description above the example for ``@pytest.mark.skipif`` now better - matches the code. (`#3611 - `_) + matches the code. (:issue:`3611`) Trivial/Internal Changes ------------------------ - Internal refactoring: removed unused ``CallSpec2tox ._globalid_args`` - attribute and ``metafunc`` parameter from ``CallSpec2.copy()``. (`#3598 - `_) + attribute and ``metafunc`` parameter from ``CallSpec2.copy()``. (:issue:`3598`) -- Silence usage of ``reduce`` warning in Python 2 (`#3609 - `_) +- Silence usage of ``reduce`` warning in Python 2 (:issue:`3609`) -- Fix usage of ``attr.ib`` deprecated ``convert`` parameter. (`#3653 - `_) +- Fix usage of ``attr.ib`` deprecated ``convert`` parameter. (:issue:`3653`) pytest 3.6.2 (2018-06-20) @@ -4119,43 +4112,35 @@ Bug Fixes --------- - Fix regression in ``Node.add_marker`` by extracting the mark object of a - ``MarkDecorator``. (`#3555 - `_) + ``MarkDecorator``. (:issue:`3555`) - Warnings without ``location`` were reported as ``None``. This is corrected to - now report ````. (`#3563 - `_) + now report ````. (:issue:`3563`) - Continue to call finalizers in the stack when a finalizer in a former scope - raises an exception. (`#3569 - `_) + raises an exception. (:issue:`3569`) -- Fix encoding error with ``print`` statements in doctests (`#3583 - `_) +- Fix encoding error with ``print`` statements in doctests (:issue:`3583`) Improved Documentation ---------------------- -- Add documentation for the ``--strict`` flag. (`#3549 - `_) +- Add documentation for the ``--strict`` flag. (:issue:`3549`) Trivial/Internal Changes ------------------------ -- Update old quotation style to parens in fixture.rst documentation. (`#3525 - `_) +- Update old quotation style to parens in fixture.rst documentation. (:issue:`3525`) - Improve display of hint about ``--fulltrace`` with ``KeyboardInterrupt``. - (`#3545 `_) + (:issue:`3545`) - pytest's testsuite is no longer runnable through ``python setup.py test`` -- - instead invoke ``pytest`` or ``tox`` directly. (`#3552 - `_) + instead invoke ``pytest`` or ``tox`` directly. (:issue:`3552`) -- Fix typo in documentation (`#3567 - `_) +- Fix typo in documentation (:issue:`3567`) pytest 3.6.1 (2018-06-05) @@ -4165,41 +4150,35 @@ Bug Fixes --------- - Fixed a bug where stdout and stderr were logged twice by junitxml when a test - was marked xfail. (`#3491 - `_) + was marked xfail. (:issue:`3491`) - Fix ``usefixtures`` mark applyed to unittest tests by correctly instantiating - ``FixtureInfo``. (`#3498 - `_) + ``FixtureInfo``. (:issue:`3498`) - Fix assertion rewriter compatibility with libraries that monkey patch - ``file`` objects. (`#3503 - `_) + ``file`` objects. (:issue:`3503`) Improved Documentation ---------------------- - Added a section on how to use fixtures as factories to the fixture - documentation. (`#3461 `_) + documentation. (:issue:`3461`) Trivial/Internal Changes ------------------------ - Enable caching for pip/pre-commit in order to reduce build time on - travis/appveyor. (`#3502 - `_) + travis/appveyor. (:issue:`3502`) - Switch pytest to the src/ layout as we already suggested it for good practice - - now we implement it as well. (`#3513 - `_) + - now we implement it as well. (:issue:`3513`) - Fix if in tests to support 3.7.0b5, where a docstring handling in AST got - reverted. (`#3530 `_) + reverted. (:issue:`3530`) -- Remove some python2.5 compatibility code. (`#3529 - `_) +- Remove some python2.5 compatibility code. (:issue:`3529`) pytest 3.6.0 (2018-05-23) @@ -4215,75 +4194,68 @@ Features read the :ref:`reasons for the revamp in the docs `, or jump over to details about :ref:`updating existing code to use the new APIs `. - (`#3317 `_) + (:issue:`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 - `_) + and if was working for a test suite it was mostly by accident. (:issue:`2334`) - Support for Python 3.7's builtin ``breakpoint()`` method, see :ref:`Using the builtin breakpoint function ` for - details. (`#3180 `_) + details. (:issue:`3180`) - ``monkeypatch`` now supports a ``context()`` function which acts as a context - manager which undoes all patching done within the ``with`` block. (`#3290 - `_) + manager which undoes all patching done within the ``with`` block. (:issue:`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 - `_) + exits the debugger. On python 3.2 and higher, use CTRL+D. (:issue:`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 `_) + in user code. (:issue:`3307`) Bug Fixes --------- - A rare race-condition which might result in corrupted ``.pyc`` files on - Windows has been hopefully solved. (`#3008 - `_) + Windows has been hopefully solved. (:issue:`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 `_) + (:issue:`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 `_) + differences. (:issue:`3443`) Improved Documentation ---------------------- - Change documentation copyright year to a range which auto-updates itself each - time it is published. (`#3303 - `_) + time it is published. (:issue:`3303`) Trivial/Internal Changes ------------------------ - ``pytest`` now depends on the `python-atomicwrites - `_ library. (`#3008 - `_) + `_ library. (:issue:`3008`) -- Update all pypi.python.org URLs to pypi.org. (`#3431 - `_) +- Update all pypi.python.org URLs to pypi.org. (:issue:`3431`) - Detect `pytest_` prefixed hooks using the internal plugin manager since ``pluggy`` is deprecating the ``implprefix`` argument to ``PluginManager``. - (`#3487 `_) + (:issue:`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 `_) + 3.7 or newer. (:issue:`3497`) pytest 3.5.1 (2018-04-23) @@ -4297,45 +4269,39 @@ Bug Fixes 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 - `_) + reclaimed by the garbage collector. (:issue:`2798`) - ``pytest.raises`` now raises ``TypeError`` when receiving an unknown keyword - argument. (`#3348 `_) + argument. (:issue:`3348`) - ``pytest.raises`` now works with exception classes that look like iterables. - (`#3372 `_) + (:issue:`3372`) Improved Documentation ---------------------- - Fix typo in ``caplog`` fixture documentation, which incorrectly identified - certain attributes as methods. (`#3406 - `_) + certain attributes as methods. (:issue:`3406`) Trivial/Internal Changes ------------------------ - Added a more indicative error message when parametrizing a function whose - argument takes a default value. (`#3221 - `_) + argument takes a default value. (:issue:`3221`) - Remove internal ``_pytest.terminal.flatten`` function in favor of - ``more_itertools.collapse``. (`#3330 - `_) + ``more_itertools.collapse``. (:issue:`3330`) - Import some modules from ``collections.abc`` instead of ``collections`` as - the former modules trigger ``DeprecationWarning`` in Python 3.7. (`#3339 - `_) + the former modules trigger ``DeprecationWarning`` in Python 3.7. (:issue:`3339`) - record_property is no longer experimental, removing the warnings was - forgotten. (`#3360 `_) + forgotten. (:issue:`3360`) - Mention in documentation and CLI help that fixtures with leading ``_`` are - printed by ``pytest --fixtures`` only if the ``-v`` option is added. (`#3398 - `_) + printed by ``pytest --fixtures`` only if the ``-v`` option is added. (:issue:`3398`) pytest 3.5.0 (2018-03-21) @@ -4345,13 +4311,12 @@ Deprecations and Removals ------------------------- - ``record_xml_property`` fixture is now deprecated in favor of the more - generic ``record_property``. (`#2770 - `_) + generic ``record_property``. (:issue:`2770`) - Defining ``pytest_plugins`` is now deprecated in non-top-level conftest.py files, because they "leak" to the entire directory tree. :ref:`See the docs ` - for the rationale behind this decision (`#3084 `_) + for the rationale behind this decision (:issue:`3084`) Features @@ -4359,135 +4324,114 @@ 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 - `_) + ``log`` or ``all`` (the default). (:issue:`1478`) - New ``--rootdir`` command-line option to override the rules for discovering the root directory. See :doc:`customize ` in the documentation for - details. (`#1642 `_) + details. (:issue:`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 `_) + dependencies. (:issue:`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 `_) + deprecated. (:issue:`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 - `_) + time, with more recent files coming first. (:issue:`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 `_) + default). (:issue:`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 `_) + failure. (:issue:`3149`) - Captured log messages are added to the ```` 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 ````. The default value for ``junit_logging`` is ``no``, meaning - captured logs are not written to the output file. (`#3156 - `_) + captured logs are not written to the output file. (:issue:`3156`) - Allow the logging plugin to handle ``pytest_runtest_logstart`` and - ``pytest_runtest_logfinish`` hooks when live logs are enabled. (`#3189 - `_) + ``pytest_runtest_logfinish`` hooks when live logs are enabled. (:issue:`3189`) - Passing ``--log-cli-level`` in the command-line now automatically activates - live logging. (`#3190 `_) + live logging. (:issue:`3190`) - Add command line option ``--deselect`` to allow deselection of individual - tests at collection time. (`#3198 - `_) + tests at collection time. (:issue:`3198`) -- Captured logs are printed before entering pdb. (`#3204 - `_) +- Captured logs are printed before entering pdb. (:issue:`3204`) - Deselected item count is now shown before tests are run, e.g. ``collected X - items / Y deselected``. (`#3213 - `_) + items / Y deselected``. (:issue:`3213`) - The builtin module ``platform`` is now available for use in expressions in - ``pytest.mark``. (`#3236 - `_) + ``pytest.mark``. (:issue:`3236`) - The *short test summary info* section now is displayed after tracebacks and - warnings in the terminal. (`#3255 - `_) + warnings in the terminal. (:issue:`3255`) -- New ``--verbosity`` flag to set verbosity level explicitly. (`#3296 - `_) +- New ``--verbosity`` flag to set verbosity level explicitly. (:issue:`3296`) -- ``pytest.approx`` now accepts comparing a numpy array with a scalar. (`#3312 - `_) +- ``pytest.approx`` now accepts comparing a numpy array with a scalar. (:issue:`3312`) Bug Fixes --------- - Suppress ``IOError`` when closing the temporary file used for capturing - streams in Python 2.7. (`#2370 - `_) + streams in Python 2.7. (:issue:`2370`) - Fixed ``clear()`` method on ``caplog`` fixture which cleared ``records``, but - not the ``text`` property. (`#3297 - `_) + not the ``text`` property. (:issue:`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 - `_) + to an iterator without crashing. (:issue:`3314`) Improved Documentation ---------------------- - Added a :doc:`reference ` page - to the docs. (`#1713 `_) + to the docs. (:issue:`1713`) Trivial/Internal Changes ------------------------ -- Change minimum requirement of ``attrs`` to ``17.4.0``. (`#3228 - `_) +- Change minimum requirement of ``attrs`` to ``17.4.0``. (:issue:`3228`) - Renamed example directories so all tests pass when ran from the base - directory. (`#3245 `_) + directory. (:issue:`3245`) -- Internal ``mark.py`` module has been turned into a package. (`#3250 - `_) +- Internal ``mark.py`` module has been turned into a package. (:issue:`3250`) - ``pytest`` now depends on the `more-itertools - `_ package. (`#3265 - `_) + `_ package. (:issue:`3265`) - Added warning when ``[pytest]`` section is used in a ``.cfg`` file passed - with ``-c`` (`#3268 `_) + with ``-c`` (:issue:`3268`) - ``nodeids`` can now be passed explicitly to ``FSCollector`` and ``Node`` - constructors. (`#3291 `_) + constructors. (:issue:`3291`) - Internal refactoring of ``FormattedExcinfo`` to use ``attrs`` facilities and - remove old support code for legacy Python versions. (`#3292 - `_) + remove old support code for legacy Python versions. (:issue:`3292`) -- Refactoring to unify how verbosity is handled internally. (`#3296 - `_) +- Refactoring to unify how verbosity is handled internally. (:issue:`3296`) -- Internal refactoring to better integrate with argparse. (`#3304 - `_) +- Internal refactoring to better integrate with argparse. (:issue:`3304`) -- Fix a python example when calling a fixture in doc/en/usage.rst (`#3308 - `_) +- Fix a python example when calling a fixture in doc/en/usage.rst (:issue:`3308`) pytest 3.4.2 (2018-03-04) @@ -4496,35 +4440,29 @@ pytest 3.4.2 (2018-03-04) Bug Fixes --------- -- Removed progress information when capture option is ``no``. (`#3203 - `_) +- Removed progress information when capture option is ``no``. (:issue:`3203`) -- Refactor check of bindir from ``exists`` to ``isdir``. (`#3241 - `_) +- Refactor check of bindir from ``exists`` to ``isdir``. (:issue:`3241`) - Fix ``TypeError`` issue when using ``approx`` with a ``Decimal`` value. - (`#3247 `_) + (:issue:`3247`) -- Fix reference cycle generated when using the ``request`` fixture. (`#3249 - `_) +- Fix reference cycle generated when using the ``request`` fixture. (:issue:`3249`) - ``[tool:pytest]`` sections in ``*.cfg`` files passed by the ``-c`` option are - now properly recognized. (`#3260 - `_) + now properly recognized. (:issue:`3260`) Improved Documentation ---------------------- -- Add logging plugin to plugins list. (`#3209 - `_) +- Add logging plugin to plugins list. (:issue:`3209`) Trivial/Internal Changes ------------------------ -- Fix minor typo in fixture.rst (`#3259 - `_) +- Fix minor typo in fixture.rst (:issue:`3259`) pytest 3.4.1 (2018-02-20) @@ -4534,58 +4472,47 @@ Bug Fixes --------- - Move import of ``doctest.UnexpectedException`` to top-level to avoid possible - errors when using ``--pdb``. (`#1810 - `_) + errors when using ``--pdb``. (:issue:`1810`) - Added printing of captured stdout/stderr before entering pdb, and improved a - test which was giving false negatives about output capturing. (`#3052 - `_) + test which was giving false negatives about output capturing. (:issue:`3052`) - Fix ordering of tests using parametrized fixtures which can lead to fixtures - being created more than necessary. (`#3161 - `_) + being created more than necessary. (:issue:`3161`) - Fix bug where logging happening at hooks outside of "test run" hooks would - cause an internal error. (`#3184 - `_) + cause an internal error. (:issue:`3184`) - Detect arguments injected by ``unittest.mock.patch`` decorator correctly when - pypi ``mock.patch`` is installed and imported. (`#3206 - `_) + pypi ``mock.patch`` is installed and imported. (:issue:`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 - `_) + the unmatched text. (:issue:`3222`) -- Fixed output capture handling in doctests on macOS. (`#985 - `_) +- Fixed output capture handling in doctests on macOS. (:issue:`985`) Improved Documentation ---------------------- - Add Sphinx parameter docs for ``match`` and ``message`` args to - ``pytest.raises``. (`#3202 - `_) + ``pytest.raises``. (:issue:`3202`) Trivial/Internal Changes ------------------------ - pytest has changed the publication procedure and is now being published to - PyPI directly from Travis. (`#3060 - `_) + PyPI directly from Travis. (:issue:`3060`) - Rename ``ParameterSet._for_parameterize()`` to ``_for_parametrize()`` in - order to comply with the naming convention. (`#3166 - `_) + order to comply with the naming convention. (:issue:`3166`) -- Skip failing pdb/doctest test on mac. (`#985 - `_) +- Skip failing pdb/doctest test on mac. (:issue:`985`) pytest 3.4.0 (2018-01-30) @@ -4595,8 +4522,7 @@ 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 - `_) + This should not affect user code except in very rare edge cases. (:issue:`2147`) Features @@ -4606,95 +4532,81 @@ Features 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 - `_) + less error prone. (:issue:`2527`) - **Incompatible change**: after community feedback the :doc:`logging ` functionality has undergone some changes. Please consult the :ref:`logging documentation ` - for details. (`#3013 `_) + for details. (:issue:`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 - `_) + otherwise the output gets garbled to the point of being useless. (:issue:`3038`) - New :func:`~_pytest.hookspec.pytest_runtest_logfinish` hook which is called when a test item has finished executing, analogous to :func:`~_pytest.hookspec.pytest_runtest_logstart`. - (`#3101 `_) + (:issue:`3101`) -- Improve performance when collecting tests using many fixtures. (`#3107 - `_) +- Improve performance when collecting tests using many fixtures. (:issue:`3107`) - New ``caplog.get_records(when)`` method which provides access to the captured records for the ``"setup"``, ``"call"`` and ``"teardown"`` - testing stages. (`#3117 `_) + testing stages. (:issue:`3117`) - New fixture ``record_xml_attribute`` that allows modifying and inserting - attributes on the ```` xml node in JUnit reports. (`#3130 - `_) + attributes on the ```` xml node in JUnit reports. (:issue:`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 - `_) + make it clear that it was used by pytest. (:issue:`3138`) -- Colorize the levelname column in the live-log output. (`#3142 - `_) +- Colorize the levelname column in the live-log output. (:issue:`3142`) Bug Fixes --------- - Fix hanging pexpect test on MacOS by using flush() instead of wait(). - (`#2022 `_) + (:issue:`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 `_) + changes. (:issue:`3016`) - Fix skipping plugin reporting hook when test aborted before plugin setup - hook. (`#3074 `_) + hook. (:issue:`3074`) -- Fix progress percentage reported when tests fail during teardown. (`#3088 - `_) +- Fix progress percentage reported when tests fail during teardown. (:issue:`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 - `_) + multiple ``-o`` flags: ``pytest -o foo=1 -o bar=2``. (:issue:`3103`) Improved Documentation ---------------------- - Document hooks (defined with ``historic=True``) which cannot be used with - ``hookwrapper=True``. (`#2423 - `_) + ``hookwrapper=True``. (:issue:`2423`) - Clarify that warning capturing doesn't change the warning filter by default. - (`#2457 `_) + (:issue:`2457`) - Clarify a possible confusion when using pytest_fixture_setup with fixture - functions that return None. (`#2698 - `_) + functions that return None. (:issue:`2698`) -- Fix the wording of a sentence on doctest flags used in pytest. (`#3076 - `_) +- Fix the wording of a sentence on doctest flags used in pytest. (:issue:`3076`) - Prefer ``https://*.readthedocs.io`` over ``http://*.rtfd.org`` for links in - the documentation. (`#3092 - `_) + the documentation. (:issue:`3092`) -- Improve readability (wording, grammar) of Getting Started guide (`#3131 - `_) +- Improve readability (wording, grammar) of Getting Started guide (:issue:`3131`) - Added note that calling pytest.main multiple times from the same process is - not recommended because of import caching. (`#3143 - `_) + not recommended because of import caching. (:issue:`3143`) Trivial/Internal Changes @@ -4702,18 +4614,15 @@ Trivial/Internal Changes - Show a simple and easy error when keyword expressions trigger a syntax error (for example, ``"-k foo and import"`` will show an error that you can not use - the ``import`` keyword in expressions). (`#2953 - `_) + the ``import`` keyword in expressions). (:issue:`2953`) - Change parametrized automatic test id generation to use the ``__name__`` attribute of functions instead of the fallback argument name plus counter. - (`#2976 `_) + (:issue:`2976`) -- Replace py.std with stdlib imports. (`#3067 - `_) +- Replace py.std with stdlib imports. (:issue:`3067`) -- Corrected 'you' to 'your' in logging docs. (`#3129 - `_) +- Corrected 'you' to 'your' in logging docs. (:issue:`3129`) pytest 3.3.2 (2017-12-25) @@ -4723,34 +4632,31 @@ Bug Fixes --------- - pytester: ignore files used to obtain current user metadata in the fd leak - detector. (`#2784 `_) + detector. (:issue:`2784`) - Fix **memory leak** where objects returned by fixtures were never destructed - by the garbage collector. (`#2981 - `_) + by the garbage collector. (:issue:`2981`) -- Fix conversion of pyargs to filename to not convert symlinks on Python 2. (`#2985 - `_) +- Fix conversion of pyargs to filename to not convert symlinks on Python 2. (:issue:`2985`) - ``PYTEST_DONT_REWRITE`` is now checked for plugins too rather than only for - test modules. (`#2995 `_) + test modules. (:issue:`2995`) Improved Documentation ---------------------- -- Add clarifying note about behavior of multiple parametrized arguments (`#3001 - `_) +- Add clarifying note about behavior of multiple parametrized arguments (:issue:`3001`) Trivial/Internal Changes ------------------------ -- Code cleanup. (`#3015 `_, - `#3021 `_) +- Code cleanup. (:issue:`3015`, + :issue:`3021`) - Clean up code by replacing imports and references of ``_ast`` to ``ast``. - (`#3018 `_) + (:issue:`3018`) pytest 3.3.1 (2017-12-05) @@ -4759,40 +4665,34 @@ pytest 3.3.1 (2017-12-05) Bug Fixes --------- -- Fix issue about ``-p no:`` having no effect. (`#2920 - `_) +- Fix issue about ``-p no:`` having no effect. (:issue:`2920`) - Fix regression with warnings that contained non-strings in their arguments in - Python 2. (`#2956 `_) + Python 2. (:issue:`2956`) -- Always escape null bytes when setting ``PYTEST_CURRENT_TEST``. (`#2957 - `_) +- Always escape null bytes when setting ``PYTEST_CURRENT_TEST``. (:issue:`2957`) - Fix ``ZeroDivisionError`` when using the ``testmon`` plugin when no tests - were actually collected. (`#2971 - `_) + were actually collected. (:issue:`2971`) - Bring back ``TerminalReporter.writer`` as an alias to ``TerminalReporter._tw``. This alias was removed by accident in the ``3.3.0`` - release. (`#2984 `_) + release. (:issue:`2984`) - The ``pytest-capturelog`` plugin is now also blacklisted, avoiding errors when - running pytest with it still installed. (`#3004 - `_) + running pytest with it still installed. (:issue:`3004`) Improved Documentation ---------------------- -- Fix broken link to plugin ``pytest-localserver``. (`#2963 - `_) +- Fix broken link to plugin ``pytest-localserver``. (:issue:`2963`) Trivial/Internal Changes ------------------------ -- Update github "bugs" link in ``CONTRIBUTING.rst`` (`#2949 - `_) +- Update github "bugs" link in ``CONTRIBUTING.rst`` (:issue:`2949`) pytest 3.3.0 (2017-11-23) @@ -4805,55 +4705,47 @@ Deprecations and Removals 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 - `_) + which still require those versions should pin pytest to ``<3.3``. (:issue:`2812`) - Remove internal ``_preloadplugins()`` function. This removal is part of the - ``pytest_namespace()`` hook deprecation. (`#2636 - `_) + ``pytest_namespace()`` hook deprecation. (:issue:`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 - `_) + ``CallSpec2`` class. (:issue:`2672`) - Remove ParameterSet.deprecated_arg_dict - its not a public api and the lack - of the underscore was a naming error. (`#2675 - `_) + of the underscore was a naming error. (:issue:`2675`) - Remove the internal multi-typed attribute ``Node._evalskip`` and replace it - with the boolean ``Node._skipped_by_mark``. (`#2767 - `_) + with the boolean ``Node._skipped_by_mark``. (:issue:`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 `_ + some internal cleanup. See issue :issue:`2959` for details and a recommended workaround. Features -------- - ``pytest_fixture_post_finalizer`` hook can now receive a ``request`` - argument. (`#2124 `_) + argument. (:issue:`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 - `_) + declarations on functions. (:issue:`2267`) -- Report tests with global ``pytestmark`` variable only once. (`#2549 - `_) +- Report tests with global ``pytestmark`` variable only once. (:issue:`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 `_) + setting to ``classic``. (:issue:`2657`) -- Match ``warns`` signature to ``raises`` by adding ``match`` keyword. (`#2708 - `_) +- Match ``warns`` signature to ``raises`` by adding ``match`` keyword. (:issue:`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 @@ -4864,110 +4756,91 @@ Features introduced by merging the popular :pypi:`pytest-catchlog` plugin, thanks to `Thomas Hisch `_. Be advised that during the merging the backward compatibility interface with the defunct ``pytest-capturelog`` has - been dropped. (`#2794 `_) + been dropped. (:issue:`2794`) - Add ``allow_module_level`` kwarg to ``pytest.skip()``, enabling to skip the - whole module. (`#2808 `_) + whole module. (:issue:`2808`) -- Allow setting ``file_or_dir``, ``-c``, and ``-o`` in PYTEST_ADDOPTS. (`#2824 - `_) +- Allow setting ``file_or_dir``, ``-c``, and ``-o`` in PYTEST_ADDOPTS. (:issue:`2824`) - Return stdout/stderr capture results as a ``namedtuple``, so ``out`` and - ``err`` can be accessed by attribute. (`#2879 - `_) + ``err`` can be accessed by attribute. (:issue:`2879`) - Add ``capfdbinary``, a version of ``capfd`` which returns bytes from - ``readouterr()``. (`#2923 - `_) + ``readouterr()``. (:issue:`2923`) - Add ``capsysbinary`` a version of ``capsys`` which returns bytes from - ``readouterr()``. (`#2934 - `_) + ``readouterr()``. (:issue:`2934`) - Implement feature to skip ``setup.py`` files when run with - ``--doctest-modules``. (`#502 - `_) + ``--doctest-modules``. (:issue:`502`) Bug Fixes --------- - Resume output capturing after ``capsys/capfd.disabled()`` context manager. - (`#1993 `_) + (:issue:`1993`) - ``pytest_fixture_setup`` and ``pytest_fixture_post_finalizer`` hooks are now - called for all ``conftest.py`` files. (`#2124 - `_) + called for all ``conftest.py`` files. (:issue:`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 - `_) + exception that pytest throws about loading a plugin. (:issue:`2491`) -- ``capsys`` and ``capfd`` can now be used by other fixtures. (`#2709 - `_) +- ``capsys`` and ``capfd`` can now be used by other fixtures. (:issue:`2709`) - Internal ``pytester`` plugin properly encodes ``bytes`` arguments to - ``utf-8``. (`#2738 `_) + ``utf-8``. (:issue:`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 - `_) + avoids a number of potential problems. (:issue:`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 `_) + for safety. (:issue:`2809`) - Change return value of pytest command when ``--maxfail`` is reached from - ``2`` (interrupted) to ``1`` (failed). (`#2845 - `_) + ``2`` (interrupted) to ``1`` (failed). (:issue:`2845`) - Fix issue in assertion rewriting which could lead it to rewrite modules which - should not be rewritten. (`#2939 - `_) + should not be rewritten. (:issue:`2939`) -- Handle marks without description in ``pytest.ini``. (`#2942 - `_) +- Handle marks without description in ``pytest.ini``. (:issue:`2942`) Trivial/Internal Changes ------------------------ - pytest now depends on :pypi:`attrs` for internal - structures to ease code maintainability. (`#2641 - `_) + structures to ease code maintainability. (:issue:`2641`) -- Refactored internal Python 2/3 compatibility code to use ``six``. (`#2642 - `_) +- Refactored internal Python 2/3 compatibility code to use ``six``. (:issue:`2642`) - Stop vendoring ``pluggy`` - we're missing out on its latest changes for not - much benefit (`#2719 `_) + much benefit (:issue:`2719`) - Internal refactor: simplify ascii string escaping by using the - backslashreplace error handler in newer Python 3 versions. (`#2734 - `_) + backslashreplace error handler in newer Python 3 versions. (:issue:`2734`) -- Remove unnecessary mark evaluator in unittest plugin (`#2767 - `_) +- Remove unnecessary mark evaluator in unittest plugin (:issue:`2767`) - Calls to ``Metafunc.addcall`` now emit a deprecation warning. This function - is scheduled to be removed in ``pytest-4.0``. (`#2876 - `_) + is scheduled to be removed in ``pytest-4.0``. (:issue:`2876`) - Internal move of the parameterset extraction to a more maintainable place. - (`#2877 `_) + (:issue:`2877`) -- Internal refactoring to simplify scope node lookup. (`#2910 - `_) +- Internal refactoring to simplify scope node lookup. (:issue:`2910`) - Configure ``pytest`` to prevent pip from installing pytest in unsupported - Python versions. (`#2922 - `_) + Python versions. (:issue:`2922`) pytest 3.2.5 (2017-11-15) @@ -4977,8 +4850,7 @@ Bug Fixes --------- - Remove ``py<1.5`` restriction from ``pytest`` as this can cause version - conflicts in some installations. (`#2926 - `_) + conflicts in some installations. (:issue:`2926`) pytest 3.2.4 (2017-11-13) @@ -4988,46 +4860,37 @@ 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 - `_) + empty ``parent.nodeid`` if run from a different root directory. (:issue:`2775`) - Fix issue with ``@pytest.parametrize`` if argnames was specified as keyword arguments. - (`#2819 `_) + (:issue:`2819`) -- Strip whitespace from marker names when reading them from INI config. (`#2856 - `_) +- Strip whitespace from marker names when reading them from INI config. (:issue:`2856`) - Show full context of doctest source in the pytest output, if the line number of - failed example in the docstring is < 9. (`#2882 - `_) + failed example in the docstring is < 9. (:issue:`2882`) - Match fixture paths against actual path segments in order to avoid matching folders which share a prefix. - (`#2836 `_) + (:issue:`2836`) Improved Documentation ---------------------- -- Introduce a dedicated section about conftest.py. (`#1505 - `_) +- Introduce a dedicated section about conftest.py. (:issue:`1505`) -- Explicitly mention ``xpass`` in the documentation of ``xfail``. (`#1997 - `_) +- Explicitly mention ``xpass`` in the documentation of ``xfail``. (:issue:`1997`) -- Append example for pytest.param in the example/parametrize document. (`#2658 - `_) +- Append example for pytest.param in the example/parametrize document. (:issue:`2658`) -- Clarify language of proposal for fixtures parameters (`#2893 - `_) +- Clarify language of proposal for fixtures parameters (:issue:`2893`) - List python 3.6 in the documented supported versions in the getting started - document. (`#2903 `_) + document. (:issue:`2903`) -- Clarify the documentation of available fixture scopes. (`#538 - `_) +- Clarify the documentation of available fixture scopes. (:issue:`538`) - Add documentation about the ``python -m pytest`` invocation adding the - current directory to sys.path. (`#911 - `_) + current directory to sys.path. (:issue:`911`) pytest 3.2.3 (2017-10-03) @@ -5036,38 +4899,33 @@ pytest 3.2.3 (2017-10-03) Bug Fixes --------- -- Fix crash in tab completion when no prefix is given. (`#2748 - `_) +- Fix crash in tab completion when no prefix is given. (:issue:`2748`) - The equality checking function (``__eq__``) of ``MarkDecorator`` returns - ``False`` if one object is not an instance of ``MarkDecorator``. (`#2758 - `_) + ``False`` if one object is not an instance of ``MarkDecorator``. (:issue:`2758`) - When running ``pytest --fixtures-per-test``: don't crash if an item has no - _fixtureinfo attribute (e.g. doctests) (`#2788 - `_) + _fixtureinfo attribute (e.g. doctests) (:issue:`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 - `_) + certain tests whose names match the provided expression. (:issue:`1442`) - Add note in ``parametrize.rst`` about calling ``metafunc.parametrize`` - multiple times. (`#1548 `_) + multiple times. (:issue:`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 - `_) + failures as soon as they start to pass. (:issue:`2722`) - Fix typo in example of passing a callable to markers (in example/markers.rst) - (`#2765 `_) + (:issue:`2765`) pytest 3.2.2 (2017-09-06) @@ -5077,17 +4935,14 @@ Bug Fixes --------- - Calling the deprecated ``request.getfuncargvalue()`` now shows the source of - the call. (`#2681 `_) + the call. (:issue:`2681`) -- Allow tests declared as ``@staticmethod`` to use fixtures. (`#2699 - `_) +- Allow tests declared as ``@staticmethod`` to use fixtures. (:issue:`2699`) - Fixed edge-case during collection: attributes which raised ``pytest.fail`` - when accessed would abort the entire collection. (`#2707 - `_) + when accessed would abort the entire collection. (:issue:`2707`) -- Fix ``ReprFuncArgs`` with mixed unicode and UTF-8 args. (`#2731 - `_) +- Fix ``ReprFuncArgs`` with mixed unicode and UTF-8 args. (:issue:`2731`) Improved Documentation @@ -5095,26 +4950,23 @@ 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 - `_) + ``pytest.mark.MARKER_NAME.__call__`` (:issue:`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 `_) + (:issue:`2653`) Trivial/Internal Changes ------------------------ - Fixed minor error in 'Good Practices/Manual Integration' code snippet. - (`#2691 `_) + (:issue:`2691`) -- Fixed typo in goodpractices.rst. (`#2721 - `_) +- Fixed typo in goodpractices.rst. (:issue:`2721`) -- Improve user guidance regarding ``--resultlog`` deprecation. (`#2739 - `_) +- Improve user guidance regarding ``--resultlog`` deprecation. (:issue:`2739`) pytest 3.2.1 (2017-08-08) @@ -5123,28 +4975,24 @@ pytest 3.2.1 (2017-08-08) Bug Fixes --------- -- Fixed small terminal glitch when collecting a single test item. (`#2579 - `_) +- Fixed small terminal glitch when collecting a single test item. (:issue:`2579`) - Correctly consider ``/`` as the file separator to automatically mark plugin - files for rewrite on Windows. (`#2591 `_) + files for rewrite on Windows. (:issue:`2591`) - Properly escape test names when setting ``PYTEST_CURRENT_TEST`` environment - variable. (`#2644 `_) + variable. (:issue:`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 `_) + aforementioned platform. (:issue:`2666`) Improved Documentation ---------------------- -- Explicitly document which pytest features work with ``unittest``. (`#2626 - `_) +- Explicitly document which pytest features work with ``unittest``. (:issue:`2626`) pytest 3.2.0 (2017-07-30) @@ -5155,158 +5003,133 @@ Deprecations and Removals - ``pytest.approx`` no longer supports ``>``, ``>=``, ``<`` and ``<=`` operators to avoid surprising/inconsistent behavior. See the :func:`~pytest.approx` docs for more - information. (`#2003 `_) + information. (:issue:`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 - `_) + This affects Python 2 users only and in rare situations. (:issue:`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 `_) + parameters instead. (:issue:`2427`) Features -------- -- Add support for numpy arrays (and dicts) to approx. (`#1994 - `_) +- Add support for numpy arrays (and dicts) to approx. (:issue:`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 `_) + from parent classes or modules. (:issue:`2516`) - Collection ignores local virtualenvs by default; ``--collect-in-virtualenv`` - overrides this behavior. (`#2518 `_) + overrides this behavior. (:issue:`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 `_) + will still ignore static methods.) (:issue:`2528`) - Introduce ``mark.with_args`` in order to allow passing functions/classes as - sole argument to marks. (`#2540 `_) + sole argument to marks. (:issue:`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 `_) + runtime. (:issue:`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 :ref:`documentation ` - for more info. (`#2583 `_) + for more info. (:issue:`2583`) - Introduced ``@pytest.mark.filterwarnings`` mark which allows overwriting the warnings filter on a per test, class or module level. See the :ref:`docs ` - for more information. (`#2598 `_) + for more information. (:issue:`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 - `_) + selectively running files and fixing tests incrementally. (:issue:`2621`) - New ``pytest_report_collectionfinish`` hook which allows plugins to add messages to the terminal reporting after collection has been finished - successfully. (`#2622 `_) + successfully. (:issue:`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 - `_) + The behavior now matches Python's traceback behavior. (:issue:`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 `_) + by normal code. (:issue:`580`) Bug Fixes --------- - Set ``stdin`` to a closed ``PIPE`` in ``pytester.py.Testdir.popen()`` for - avoid unwanted interactive ``pdb`` (`#2023 `_) + avoid unwanted interactive ``pdb`` (:issue:`2023`) - Add missing ``encoding`` attribute to ``sys.std*`` streams when using - ``capsys`` capture mode. (`#2375 `_) + ``capsys`` capture mode. (:issue:`2375`) - Fix terminal color changing to black on Windows if ``colorama`` is imported - in a ``conftest.py`` file. (`#2510 `_) + in a ``conftest.py`` file. (:issue:`2510`) -- Fix line number when reporting summary of skipped tests. (`#2548 - `_) +- Fix line number when reporting summary of skipped tests. (:issue:`2548`) -- capture: ensure that EncodedFile.name is a string. (`#2555 - `_) +- capture: ensure that EncodedFile.name is a string. (:issue:`2555`) - The options ``--fixtures`` and ``--fixtures-per-test`` will now keep - indentation within docstrings. (`#2574 `_) + indentation within docstrings. (:issue:`2574`) - doctests line numbers are now reported correctly, fixing `pytest-sugar#122 - `_. (`#2610 - `_) + `_. (:issue:`2610`) - Fix non-determinism in order of fixture collection. Adds new dependency - (ordereddict) for Python 2.6. (`#920 `_) + (ordereddict) for Python 2.6. (:issue:`920`) Improved Documentation ---------------------- -- Clarify ``pytest_configure`` hook call order. (`#2539 - `_) +- Clarify ``pytest_configure`` hook call order. (:issue:`2539`) - Extend documentation for testing plugin code with the ``pytester`` plugin. - (`#971 `_) + (:issue:`971`) Trivial/Internal Changes ------------------------ - Update help message for ``--strict`` to make it clear it only deals with - unregistered markers, not warnings. (`#2444 `_) + unregistered markers, not warnings. (:issue:`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 `_) + order to cut down the size of python.py (:issue:`2489`) - Renamed the utility function ``_pytest.compat._escape_strings`` to - ``_ascii_escaped`` to better communicate the function's purpose. (`#2533 - `_) + ``_ascii_escaped`` to better communicate the function's purpose. (:issue:`2533`) -- Improve error message for CollectError with skip/skipif. (`#2546 - `_) +- Improve error message for CollectError with skip/skipif. (:issue:`2546`) - Emit warning about ``yield`` tests being deprecated only once per generator. - (`#2562 `_) + (:issue:`2562`) - Ensure final collected line doesn't include artifacts of previous write. - (`#2571 `_) + (:issue:`2571`) -- Fixed all flake8 errors and warnings. (`#2581 `_) +- Fixed all flake8 errors and warnings. (:issue:`2581`) - Added ``fix-lint`` tox environment to run automatic pep8 fixes on the code. - (`#2582 `_) + (:issue:`2582`) - Turn warnings into errors in pytest's own test suite in order to catch - regressions due to deprecations more promptly. (`#2588 - `_) + regressions due to deprecations more promptly. (:issue:`2588`) -- Show multiple issue links in CHANGELOG entries. (`#2620 - `_) +- Show multiple issue links in CHANGELOG entries. (:issue:`2620`) pytest 3.1.3 (2017-07-03) @@ -5315,44 +5138,40 @@ pytest 3.1.3 (2017-07-03) Bug Fixes --------- -- Fix decode error in Python 2 for doctests in docstrings. (`#2434 - `_) +- Fix decode error in Python 2 for doctests in docstrings. (:issue:`2434`) - Exceptions raised during teardown by finalizers are now suppressed until all - finalizers are called, with the initial exception reraised. (`#2440 - `_) + finalizers are called, with the initial exception reraised. (:issue:`2440`) - Fix incorrect "collected items" report when specifying tests on the command- - line. (`#2464 `_) + line. (:issue:`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 - `_) + different messages in context-manager vs. function-call mode). (:issue:`2469`) - Fix issue where paths collected by pytest could have triple leading ``/`` - characters. (`#2475 `_) + characters. (:issue:`2475`) - Fix internal error when trying to detect the start of a recursive traceback. - (`#2486 `_) + (:issue:`2486`) Improved Documentation ---------------------- - Explicitly state for which hooks the calls stop after the first non-None - result. (`#2493 `_) + result. (:issue:`2493`) Trivial/Internal Changes ------------------------ -- Create invoke tasks for updating the vendored packages. (`#2474 - `_) +- Create invoke tasks for updating the vendored packages. (:issue:`2474`) - Update copyright dates in LICENSE, README.rst and in the documentation. - (`#2499 `_) + (:issue:`2499`) pytest 3.1.2 (2017-06-08) @@ -5438,7 +5257,7 @@ New Features Thanks `@nicoddemus`_ for the PR. -* Added ``junit_suite_name`` ini option to specify root ```` name for JUnit XML reports (`#533`_). +* Added ``junit_suite_name`` ini option to specify root ```` name for JUnit XML reports (:issue:`533`). * Added an ini option ``doctest_encoding`` to specify which encoding to use for doctest files. Thanks `@wheerd`_ for the PR (`#2101`_). @@ -5463,35 +5282,35 @@ Changes * 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 + ``__test__`` attribute to ``False`` in the class body (:issue:`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. + the failure. (:issue:`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`_). + assertion messages if verbosity < 2 (:issue:`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``, +* fix :issue:`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. +* fix :issue:`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`_). + ``pytest_plugins`` special variable (:issue:`1821`). Thanks `@nicoddemus`_ for the PR. * Modify ``pytest_make_parametrize_id()`` hook to accept ``argname`` as an @@ -5504,7 +5323,7 @@ Changes * ``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. +* fix :issue:`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. @@ -5512,7 +5331,7 @@ Changes the documentation on different platforms. Thanks `@RonnyPfannschmidt`_ for the PR. -* fix `#2391`_: consider pytest_plugins on all plugin modules +* fix :issue:`2391`: consider pytest_plugins on all plugin modules Thanks `@RonnyPfannschmidt`_ for the PR. @@ -5520,24 +5339,24 @@ Bug Fixes --------- * Fix ``AttributeError`` on ``sys.stdout.buffer`` / ``sys.stderr.buffer`` - while using ``capsys`` fixture in python 3. (`#1407`_). + while using ``capsys`` fixture in python 3. (:issue:`1407`). Thanks to `@asottile`_. * Change capture.py's ``DontReadFromInput`` class to throw ``io.UnsupportedOperation`` errors rather - than ValueErrors in the ``fileno`` method (`#2276`_). + than ValueErrors in the ``fileno`` method (:issue:`2276`). Thanks `@metasyn`_ and `@vlad-dragos`_ for the PR. * Fix exception formatting while importing modules when the exception message - contains non-ascii characters (`#2336`_). + contains non-ascii characters (:issue:`2336`). Thanks `@fabioz`_ for the report and `@nicoddemus`_ for the PR. -* Added documentation related to issue (`#1937`_) +* Added documentation related to issue (:issue:`1937`) Thanks `@skylarjhdownes`_ for the PR. -* Allow collecting files with any file extension as Python modules (`#2369`_). +* Allow collecting files with any file extension as Python modules (:issue:`2369`). Thanks `@Kodiologist`_ for the PR. -* Show the correct error message when collect "parametrize" func with wrong args (`#2383`_). +* Show the correct error message when collect "parametrize" func with wrong args (:issue:`2383`). Thanks `@The-Compiler`_ for the report and `@robin0371`_ for the PR. @@ -5559,25 +5378,10 @@ Bug Fixes .. _@wheerd: https://github.com/wheerd -.. _#1407: https://github.com/pytest-dev/pytest/issues/1407 -.. _#1512: https://github.com/pytest-dev/pytest/issues/1512 -.. _#1821: https://github.com/pytest-dev/pytest/issues/1821 .. _#1874: https://github.com/pytest-dev/pytest/pull/1874 -.. _#1937: https://github.com/pytest-dev/pytest/issues/1937 .. _#1952: https://github.com/pytest-dev/pytest/pull/1952 -.. _#2007: https://github.com/pytest-dev/pytest/issues/2007 -.. _#2013: https://github.com/pytest-dev/pytest/issues/2013 .. _#2101: https://github.com/pytest-dev/pytest/pull/2101 .. _#2166: https://github.com/pytest-dev/pytest/pull/2166 -.. _#2208: https://github.com/pytest-dev/pytest/issues/2208 -.. _#2228: https://github.com/pytest-dev/pytest/issues/2228 -.. _#2276: https://github.com/pytest-dev/pytest/issues/2276 -.. _#2308: https://github.com/pytest-dev/pytest/issues/2308 -.. _#2336: https://github.com/pytest-dev/pytest/issues/2336 -.. _#2369: https://github.com/pytest-dev/pytest/issues/2369 -.. _#2383: https://github.com/pytest-dev/pytest/issues/2383 -.. _#2391: https://github.com/pytest-dev/pytest/issues/2391 -.. _#533: https://github.com/pytest-dev/pytest/issues/533 @@ -5587,31 +5391,31 @@ Bug Fixes * Fix issue in assertion rewriting breaking due to modules silently discarding other modules when importing fails - Notably, importing the ``anydbm`` module is fixed. (`#2248`_). + Notably, importing the ``anydbm`` module is fixed. (:issue:`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. + (:issue:`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`_). +* Ignore exceptions raised from descriptors (e.g. properties) during Python test collection (:issue:`2234`). Thanks to `@bluetech`_. -* ``--override-ini`` now correctly overrides some fundamental options like ``python_files`` (`#2238`_). +* ``--override-ini`` now correctly overrides some fundamental options like ``python_files`` (:issue:`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`_). +* Replace ``raise StopIteration`` usages in the code by simple ``returns`` to finish generators, in accordance to :pep:`479` (:issue:`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`_). +* Skipping plugin now also works with test items generated by custom collectors (:issue:`2231`). Thanks to `@vidartf`_. -* Fix trailing whitespace in console output if no .ini file presented (`#2281`_). Thanks `@fbjorn`_ for the PR. +* Fix trailing whitespace in console output if no .ini file presented (:issue:`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 @@ -5628,42 +5432,34 @@ Bug Fixes .. _@omerhadari: https://github.com/omerhadari .. _@fbjorn: https://github.com/fbjorn -.. _#2248: https://github.com/pytest-dev/pytest/issues/2248 -.. _#2137: https://github.com/pytest-dev/pytest/issues/2137 -.. _#2160: https://github.com/pytest-dev/pytest/issues/2160 -.. _#2231: https://github.com/pytest-dev/pytest/issues/2231 -.. _#2234: https://github.com/pytest-dev/pytest/issues/2234 -.. _#2238: https://github.com/pytest-dev/pytest/issues/2238 -.. _#2281: https://github.com/pytest-dev/pytest/issues/2281 - 3.0.6 (2017-01-22) ================== -* pytest no longer generates ``PendingDeprecationWarning`` from its own operations, which was introduced by mistake in version ``3.0.5`` (`#2118`_). +* pytest no longer generates ``PendingDeprecationWarning`` from its own operations, which was introduced by mistake in version ``3.0.5`` (:issue:`2118`). Thanks to `@nicoddemus`_ for the report and `@RonnyPfannschmidt`_ for the PR. -* pytest no longer recognizes coroutine functions as yield tests (`#2129`_). +* pytest no longer recognizes coroutine functions as yield tests (:issue:`2129`). Thanks to `@malinoff`_ for the PR. * Plugins loaded by the ``PYTEST_PLUGINS`` environment variable are now automatically - considered for assertion rewriting (`#2185`_). + considered for assertion rewriting (:issue:`2185`). Thanks `@nicoddemus`_ for the PR. -* Improve error message when pytest.warns fails (`#2150`_). The type(s) of the +* Improve error message when pytest.warns fails (:issue:`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. + ``zope.interface`` (:issue:`1989`). Thanks `@nicoddemus`_ for the PR. -* Assert statements of the ``pytester`` plugin again benefit from assertion rewriting (`#1920`_). +* Assert statements of the ``pytester`` plugin again benefit from assertion rewriting (:issue:`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`_. + (:issue:`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. @@ -5675,43 +5471,34 @@ Bug Fixes .. _@pelme: https://github.com/pelme .. _@eli-b: https://github.com/eli-b -.. _#2118: https://github.com/pytest-dev/pytest/issues/2118 - -.. _#1989: https://github.com/pytest-dev/pytest/issues/1989 -.. _#1920: https://github.com/pytest-dev/pytest/issues/1920 -.. _#2129: https://github.com/pytest-dev/pytest/issues/2129 -.. _#2148: https://github.com/pytest-dev/pytest/issues/2148 -.. _#2150: https://github.com/pytest-dev/pytest/issues/2150 -.. _#2185: https://github.com/pytest-dev/pytest/issues/2185 - 3.0.5 (2016-12-05) ================== -* Add warning when not passing ``option=value`` correctly to ``-o/--override-ini`` (`#2105`_). +* Add warning when not passing ``option=value`` correctly to ``-o/--override-ini`` (:issue:`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. + and filenames, respectively (:issue:`2089` and :issue:`2078`). Thanks to `@lwm`_ for the PR. -* Add hint to error message hinting possible missing ``__init__.py`` (`#478`_). Thanks `@DuncanBetts`_. +* Add hint to error message hinting possible missing ``__init__.py`` (:issue:`478`). Thanks `@DuncanBetts`_. -* More accurately describe when fixture finalization occurs in documentation (`#687`_). Thanks `@DuncanBetts`_. +* More accurately describe when fixture finalization occurs in documentation (:issue:`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``). + which can result in bugs such as :issue:`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`_). + ``pytest.Function``, ``pytest.Module``, etc., instead (:issue:`2034`). Thanks `@nmundar`_ for the PR. -* Fix error message using ``approx`` with complex numbers (`#2082`_). +* Fix error message using ``approx`` with complex numbers (:issue:`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 @@ -5719,15 +5506,15 @@ Bug Fixes 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`_). + sub-directories to be called in other directories incorrectly (:issue:`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`_). + as a string to ``pytest.mark.skipif``)(:issue:`2103`). Thanks `@jaraco`_ for the report and `@nicoddemus`_ for the PR. -* Cope gracefully with a .pyc file with no matching .py file (`#2038`_). Thanks +* Cope gracefully with a .pyc file with no matching .py file (:issue:`2038`). Thanks `@nedbat`_. .. _@syre: https://github.com/syre @@ -5741,32 +5528,20 @@ Bug Fixes .. _@nedbat: https://github.com/nedbat .. _@nmundar: https://github.com/nmundar -.. _#2016: https://github.com/pytest-dev/pytest/issues/2016 -.. _#2034: https://github.com/pytest-dev/pytest/issues/2034 -.. _#2038: https://github.com/pytest-dev/pytest/issues/2038 -.. _#2078: https://github.com/pytest-dev/pytest/issues/2078 -.. _#2082: https://github.com/pytest-dev/pytest/issues/2082 -.. _#2089: https://github.com/pytest-dev/pytest/issues/2089 -.. _#2103: https://github.com/pytest-dev/pytest/issues/2103 -.. _#2105: https://github.com/pytest-dev/pytest/issues/2105 -.. _#2111: https://github.com/pytest-dev/pytest/issues/2111 -.. _#478: https://github.com/pytest-dev/pytest/issues/478 -.. _#687: https://github.com/pytest-dev/pytest/issues/687 - 3.0.4 (2016-11-09) ================== -* Import errors when collecting test modules now display the full traceback (`#1976`_). +* Import errors when collecting test modules now display the full traceback (:issue:`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`_). +* Fix confusing command-line help message for custom options with two or more ``metavar`` properties (:issue:`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`_). +* When loading plugins, import errors which contain non-ascii messages are now properly handled in Python 2 (:issue:`1998`). Thanks `@nicoddemus`_ for the PR. -* Fixed cyclic reference when ``pytest.raises`` is used in context-manager form (`#1965`_). Also as a +* Fixed cyclic reference when ``pytest.raises`` is used in context-manager form (:issue:`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. @@ -5774,19 +5549,19 @@ Bug Fixes * 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`_). + or implicitly as a plugin (:issue:`2005`). Thanks `@RonnyPfannschmidt`_ for the report and `@nicoddemus`_ for the PR. -* Report teardown output on test failure (`#442`_). +* Report teardown output on test failure (:issue:`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`_). +* Properly handle exceptions in ``multiprocessing`` tasks (:issue:`1984`). Thanks `@adborden`_ for the report and `@nicoddemus`_ for the PR. -* Clean up unittest TestCase objects after tests are complete (`#1649`_). +* Clean up unittest TestCase objects after tests are complete (:issue:`1649`). Thanks `@d_b_w`_ for the report and PR. @@ -5798,39 +5573,30 @@ Bug Fixes .. _@MSeifert04: https://github.com/MSeifert04 .. _@okulynyak: https://github.com/okulynyak -.. _#442: https://github.com/pytest-dev/pytest/issues/442 -.. _#1965: https://github.com/pytest-dev/pytest/issues/1965 -.. _#1976: https://github.com/pytest-dev/pytest/issues/1976 -.. _#1984: https://github.com/pytest-dev/pytest/issues/1984 -.. _#1998: https://github.com/pytest-dev/pytest/issues/1998 -.. _#2004: https://github.com/pytest-dev/pytest/issues/2004 -.. _#2005: https://github.com/pytest-dev/pytest/issues/2005 -.. _#1649: https://github.com/pytest-dev/pytest/issues/1649 - 3.0.3 (2016-09-28) ================== * The ``ids`` argument to ``parametrize`` again accepts ``unicode`` strings - in Python 2 (`#1905`_). + in Python 2 (:issue:`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`_). + (``pip install -e``) (:issue:`1934`). Thanks `@nicoddemus`_ for the PR. -* Fix pkg_resources import error in Jython projects (`#1853`_). +* Fix pkg_resources import error in Jython projects (:issue:`1853`). Thanks `@raquel-ucl`_ for the PR. * Got rid of ``AttributeError: 'Module' object has no attribute '_obj'`` exception - in Python 3 (`#1944`_). + in Python 3 (:issue:`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`_). + ``VersionConflict`` errors in plugins (:issue:`704`). Thanks `@nicoddemus`_ for the PR. @@ -5839,66 +5605,53 @@ Bug Fixes .. _@axil: https://github.com/axil .. _@vlad-dragos: https://github.com/vlad-dragos -.. _#1853: https://github.com/pytest-dev/pytest/issues/1853 -.. _#1905: https://github.com/pytest-dev/pytest/issues/1905 -.. _#1934: https://github.com/pytest-dev/pytest/issues/1934 -.. _#1944: https://github.com/pytest-dev/pytest/issues/1944 -.. _#704: https://github.com/pytest-dev/pytest/issues/704 - - - 3.0.2 (2016-09-01) ================== -* Improve error message when passing non-string ids to ``pytest.mark.parametrize`` (`#1857`_). +* Improve error message when passing non-string ids to ``pytest.mark.parametrize`` (:issue:`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`_) +* Fix ``UnicodeEncodeError`` when string comparison with unicode has failed. (:issue:`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`_). + if a test suite uses ``pytest_plugins`` to load internal plugins (:issue:`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 + which have significant logic in their tearDown machinery (:issue:`1890`). Thanks `@mbyt`_ for the PR. * Fix use of deprecated ``getfuncargvalue`` method in the internal doctest plugin. - Thanks `@ViviCoder`_ for the report (`#1898`_). + Thanks `@ViviCoder`_ for the report (:issue:`1898`). .. _@joguSD: https://github.com/joguSD .. _@AiOO: https://github.com/AiOO .. _@mbyt: https://github.com/mbyt .. _@ViviCoder: https://github.com/ViviCoder -.. _#1857: https://github.com/pytest-dev/pytest/issues/1857 -.. _#1864: https://github.com/pytest-dev/pytest/issues/1864 -.. _#1888: https://github.com/pytest-dev/pytest/issues/1888 .. _#1891: https://github.com/pytest-dev/pytest/pull/1891 -.. _#1890: https://github.com/pytest-dev/pytest/issues/1890 -.. _#1898: https://github.com/pytest-dev/pytest/issues/1898 3.0.1 (2016-08-23) ================== -* Fix regression when ``importorskip`` is used at module level (`#1822`_). +* Fix regression when ``importorskip`` is used at module level (:issue:`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`_). + with normal parameters in the same call (:issue:`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`_). +* Fix internal error when parametrizing tests or fixtures using an empty ``ids`` argument (:issue:`1849`). Thanks `@OPpuolitaival`_ for the report and `@nicoddemus`_ for the PR. * Fix loader error when running ``pytest`` embedded in a zipfile. @@ -5909,9 +5662,6 @@ Bug Fixes .. _@mbachry: https://github.com/mbachry .. _@OPpuolitaival: https://github.com/OPpuolitaival -.. _#1822: https://github.com/pytest-dev/pytest/issues/1822 -.. _#1832: https://github.com/pytest-dev/pytest/issues/1832 -.. _#1849: https://github.com/pytest-dev/pytest/issues/1849 .. _release-3.0.0: @@ -5942,23 +5692,23 @@ time or change existing behaviors in order to make them less surprising/more use 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. + pytest warning (:issue:`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`_). + removes a source of confusion for users (:issue:`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`_). + this usage would cause the entire module to be skipped (:issue:`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`_). + anyway as soon as they see collection errors, so pytest might as well make that the default behavior (:issue:`1421`). A ``--continue-on-collection-errors`` option has been added to restore the previous behaviour. Thanks `@olegpidsadnyi`_ and `@omarkohl`_ for the complete PR (`#1628`_). @@ -5988,7 +5738,7 @@ time or change existing behaviors in order to make them less surprising/more use 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`_). + when running (failing) doctests (implements :issue:`1749`). Thanks `@hartym`_ for the PR. * New ``name`` argument to ``pytest.fixture`` decorator which allows a custom name @@ -6004,7 +5754,7 @@ time or change existing behaviors in order to make them less surprising/more use Thanks `@tareqalayan`_ for the complete PR `#1454`_). * New ``ExceptionInfo.match()`` method to match a regular expression on the - string representation of an exception (`#372`_). + string representation of an exception (:issue:`372`). Thanks `@omarkohl`_ for the complete PR (`#1502`_). * ``__tracebackhide__`` can now also be set to a callable which then can decide @@ -6026,7 +5776,7 @@ time or change existing behaviors in order to make them less surprising/more use * 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 + :issue:`1629`. Thanks `@obestwalter`_ and `@davehunt`_ for the complete PR (`#1633`_). * New cli flags: @@ -6040,7 +5790,7 @@ time or change existing behaviors in order to make them less surprising/more use + ``--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`_); + argument (:issue:`1609`); Thanks `@d6e`_, `@kvas-it`_, `@sallner`_, `@ioggstream`_ and `@omarkohl`_ for the PRs. @@ -6058,7 +5808,7 @@ time or change existing behaviors in order to make them less surprising/more use * 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. + (see :issue:`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. @@ -6071,7 +5821,7 @@ time or change existing behaviors in order to make them less surprising/more use * 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`_). + (`#1795`_) and `@gprasad84`_ for report (:issue:`1546`). * Tests marked with ``xfail(strict=False)`` (the default) now appear in JUnitXML reports as passing tests instead of skipped. @@ -6086,7 +5836,7 @@ time or change existing behaviors in order to make them less surprising/more use 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`_). +* Explicitly passed parametrize ids do not get escaped to ascii (:issue:`1351`). Thanks `@ceridwen`_ for the PR. * Fixtures are now sorted in the error message displayed when an unknown @@ -6109,14 +5859,14 @@ time or change existing behaviors in order to make them less surprising/more use 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`_). + ``--disable-pytest-warnings`` to explicitly disable the warnings summary (:issue:`1668`). * Make ImportError during collection more explicit by reminding - the user to check the name of the test module/package(s) (`#1426`_). + the user to check the name of the test module/package(s) (:issue:`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`_). + `@mikofski`_ for the report and `@tomviner`_ for the PR (:issue:`1544`). * ``pytest.raises`` in the context manager form accepts a custom ``message`` to raise when no exception occurred. @@ -6124,7 +5874,7 @@ time or change existing behaviors in order to make them less surprising/more use * ``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`_). + `@nicoddemus`_ for the PR (:issue:`1619`). * Text documents without any doctests no longer appear as "skipped". Thanks `@graingert`_ for reporting and providing a full PR (`#1580`_). @@ -6135,11 +5885,11 @@ time or change existing behaviors in order to make them less surprising/more use * 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 + Thanks `@bagerard`_ for reporting (:issue:`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`_. + added before, to make it easier to track down issues like :issue:`1618`. Before, you only got exceptions later from ``argparse`` library, giving no clue about the actual reason for double-added options. @@ -6162,39 +5912,39 @@ time or change existing behaviors in order to make them less surprising/more use still present but is now considered deprecated. Thanks to `@RedBeardCode`_ and `@tomviner`_ for the PR (`#1626`_). -* ``optparse`` type usage now triggers DeprecationWarnings (`#1740`_). +* ``optparse`` type usage now triggers DeprecationWarnings (:issue:`1740`). -* ``optparse`` backward compatibility supports float/complex types (`#457`_). +* ``optparse`` backward compatibility supports float/complex types (:issue:`457`). * Refined logic for determining the ``rootdir``, considering only valid - paths which fixes a number of issues: `#1594`_, `#1435`_ and `#1471`_. + paths which fixes a number of issues: :issue:`1594`, :issue:`1435` and :issue:`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 + Thanks `@bagerard`_ for reporting (:issue:`1503`). Thanks to `@davehunt`_ and `@tomviner`_ for PR. -* Better message in case of not using parametrized variable (see `#1539`_). +* Better message in case of not using parametrized variable (see :issue:`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 + Thanks `@BeyondEvil`_ for reporting :issue:`1210`. Thanks to @jgsonesen and `@tomviner`_ for the PR. -* No longer display the incorrect test deselection reason (`#1372`_). +* No longer display the incorrect test deselection reason (:issue:`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`_). + and there are more modern and better alternatives (see :issue:`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 + line and '>' to the rest. Fixes :issue:`717`. Thanks `@blueyed`_ for reporting and a PR, `@eolo999`_ for the initial PR and `@tomviner`_ for his guidance during EuroPython2016 sprint. @@ -6204,16 +5954,16 @@ time or change existing behaviors in order to make them less surprising/more use * Parametrize now correctly handles duplicated test ids. * Fix internal error issue when the ``method`` argument is missing for - ``teardown_method()`` (`#1605`_). + ``teardown_method()`` (:issue:`1605`). * Fix exception visualization in case the current working directory (CWD) gets - deleted during testing (`#1235`_). Thanks `@bukzor`_ for reporting. PR by + deleted during testing (:issue:`1235`). Thanks `@bukzor`_ for reporting. PR by `@marscher`_. -* Improve test output for logical expression with brackets (`#925`_). +* Improve test output for logical expression with brackets (:issue:`925`). Thanks `@DRMacIver`_ for reporting and `@RedBeardCode`_ for the PR. -* Create correct diff for strings ending with newlines (`#1553`_). +* Create correct diff for strings ending with newlines (:issue:`1553`). Thanks `@Vogtinator`_ for reporting and `@RedBeardCode`_ and `@tomviner`_ for the PR. @@ -6225,9 +5975,9 @@ time or change existing behaviors in order to make them less surprising/more use 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. + Fixes :issue:`1579`. Thanks to `@Stranger6667`_ for the PR. -* Fixed scope overriding inside metafunc.parametrize (`#634`_). +* Fixed scope overriding inside metafunc.parametrize (:issue:`634`). Thanks to `@Stranger6667`_ for the PR. * Fixed the total tests tally in junit xml output (`#1798`_). @@ -6236,67 +5986,34 @@ time or change existing behaviors in order to make them less surprising/more use * Fixed off-by-one error with lines from ``request.node.warn``. Thanks to `@blueyed`_ for the PR. - -.. _#1210: https://github.com/pytest-dev/pytest/issues/1210 -.. _#1235: https://github.com/pytest-dev/pytest/issues/1235 -.. _#1351: https://github.com/pytest-dev/pytest/issues/1351 -.. _#1372: https://github.com/pytest-dev/pytest/issues/1372 -.. _#1421: https://github.com/pytest-dev/pytest/issues/1421 -.. _#1426: https://github.com/pytest-dev/pytest/issues/1426 .. _#1428: https://github.com/pytest-dev/pytest/pull/1428 -.. _#1435: https://github.com/pytest-dev/pytest/issues/1435 .. _#1441: https://github.com/pytest-dev/pytest/pull/1441 .. _#1444: https://github.com/pytest-dev/pytest/pull/1444 .. _#1454: https://github.com/pytest-dev/pytest/pull/1454 .. _#1461: https://github.com/pytest-dev/pytest/pull/1461 .. _#1468: https://github.com/pytest-dev/pytest/pull/1468 -.. _#1471: https://github.com/pytest-dev/pytest/issues/1471 .. _#1474: https://github.com/pytest-dev/pytest/pull/1474 -.. _#1479: https://github.com/pytest-dev/pytest/issues/1479 .. _#1502: https://github.com/pytest-dev/pytest/pull/1502 -.. _#1503: https://github.com/pytest-dev/pytest/issues/1503 .. _#1516: https://github.com/pytest-dev/pytest/pull/1516 .. _#1519: https://github.com/pytest-dev/pytest/pull/1519 .. _#1520: https://github.com/pytest-dev/pytest/pull/1520 .. _#1526: https://github.com/pytest-dev/pytest/pull/1526 -.. _#1539: https://github.com/pytest-dev/pytest/issues/1539 -.. _#1544: https://github.com/pytest-dev/pytest/issues/1544 -.. _#1546: https://github.com/pytest-dev/pytest/issues/1546 -.. _#1553: https://github.com/pytest-dev/pytest/issues/1553 -.. _#1562: https://github.com/pytest-dev/pytest/issues/1562 -.. _#1579: https://github.com/pytest-dev/pytest/issues/1579 .. _#1580: https://github.com/pytest-dev/pytest/pull/1580 -.. _#1594: https://github.com/pytest-dev/pytest/issues/1594 .. _#1597: https://github.com/pytest-dev/pytest/pull/1597 -.. _#1605: https://github.com/pytest-dev/pytest/issues/1605 .. _#1616: https://github.com/pytest-dev/pytest/pull/1616 -.. _#1618: https://github.com/pytest-dev/pytest/issues/1618 -.. _#1619: https://github.com/pytest-dev/pytest/issues/1619 .. _#1626: https://github.com/pytest-dev/pytest/pull/1626 .. _#1627: https://github.com/pytest-dev/pytest/pull/1627 .. _#1628: https://github.com/pytest-dev/pytest/pull/1628 -.. _#1629: https://github.com/pytest-dev/pytest/issues/1629 -.. _#1632: https://github.com/pytest-dev/pytest/issues/1632 .. _#1633: https://github.com/pytest-dev/pytest/pull/1633 .. _#1664: https://github.com/pytest-dev/pytest/pull/1664 -.. _#1668: https://github.com/pytest-dev/pytest/issues/1668 .. _#1684: https://github.com/pytest-dev/pytest/pull/1684 .. _#1723: https://github.com/pytest-dev/pytest/pull/1723 -.. _#1740: https://github.com/pytest-dev/pytest/issues/1740 -.. _#1749: https://github.com/pytest-dev/pytest/issues/1749 .. _#1778: https://github.com/pytest-dev/pytest/pull/1778 .. _#1795: https://github.com/pytest-dev/pytest/pull/1795 .. _#1798: https://github.com/pytest-dev/pytest/pull/1798 .. _#1809: https://github.com/pytest-dev/pytest/pull/1809 -.. _#372: https://github.com/pytest-dev/pytest/issues/372 -.. _#457: https://github.com/pytest-dev/pytest/issues/457 .. _#460: https://github.com/pytest-dev/pytest/pull/460 .. _#567: https://github.com/pytest-dev/pytest/pull/567 -.. _#607: https://github.com/pytest-dev/pytest/issues/607 -.. _#634: https://github.com/pytest-dev/pytest/issues/634 -.. _#717: https://github.com/pytest-dev/pytest/issues/717 -.. _#830: https://github.com/pytest-dev/pytest/issues/830 -.. _#925: https://github.com/pytest-dev/pytest/issues/925 .. _@anntzer: https://github.com/anntzer @@ -6345,11 +6062,11 @@ time or change existing behaviors in order to make them less surprising/more use **Bug Fixes** -* fix `#510`_: skip tests where one parameterize dimension was empty +* fix :issue:`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`_ + Thanks `@astraw38`_ for reporting the issue (:issue:`1496`) and `@tomviner`_ for PR the (`#1524`_). * Fix win32 path issue when putting custom config file with absolute path @@ -6370,9 +6087,7 @@ time or change existing behaviors in order to make them less surprising/more use one per fixture name. Thanks to `@hackebrot`_ for the PR. -.. _#510: https://github.com/pytest-dev/pytest/issues/510 .. _#1506: https://github.com/pytest-dev/pytest/pull/1506 -.. _#1496: https://github.com/pytest-dev/pytest/issues/1496 .. _#1524: https://github.com/pytest-dev/pytest/pull/1524 .. _@prusse-martin: https://github.com/prusse-martin @@ -6387,30 +6102,26 @@ time or change existing behaviors in order to make them less surprising/more use * Improve error message when a plugin fails to load. Thanks `@nicoddemus`_ for the PR. -* Fix (`#1178 `_): +* Fix (:issue:`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 +* Fix (:issue:`469`): junit parses report.nodeid incorrectly, when params IDs contain ``::``. Thanks `@tomviner`_ for the PR (`#1431`_). -* Fix (`#578 `_): SyntaxErrors +* Fix (:issue:`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 +* Fix (:issue:`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 (:issue:`649`): parametrized test nodes cannot be specified to run on the command line. -* Fix (`#138`_): better reporting for python 3.3+ chained exceptions +* Fix (:issue:`138`): better reporting for python 3.3+ chained exceptions -.. _#1437: https://github.com/pytest-dev/pytest/issues/1437 -.. _#469: https://github.com/pytest-dev/pytest/issues/469 .. _#1431: https://github.com/pytest-dev/pytest/pull/1431 -.. _#649: https://github.com/pytest-dev/pytest/issues/649 -.. _#138: https://github.com/pytest-dev/pytest/issues/138 .. _@asottile: https://github.com/asottile @@ -6442,7 +6153,7 @@ time or change existing behaviors in order to make them less surprising/more use 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`_. + Fixes :issue:`1366`. Thanks to `@hpk42`_ for the report and `@RonnyPfannschmidt`_ for the PR. * Catch ``IndexError`` exceptions when getting exception source location. @@ -6485,39 +6196,32 @@ time or change existing behaviors in order to make them less surprising/more use * 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`_). + colors in CI integrations systems (:issue:`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`_). + Thanks to `@bukzor`_ for the complete PR (:issue:`680`). -* Fix (`#1290`_): support Python 3.5's ``@`` operator in assertion rewriting. +* Fix (:issue:`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`_). +* Fix formatting utf-8 explanation messages (:issue:`1379`). Thanks `@biern`_ for the PR. * Fix :ref:`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 +* Fix (:issue:`1422`): junit record_xml_property doesn't allow multiple records with same name. -.. _#1609: https://github.com/pytest-dev/pytest/issues/1609 -.. _#1422: https://github.com/pytest-dev/pytest/issues/1422 -.. _#1379: https://github.com/pytest-dev/pytest/issues/1379 -.. _#1366: https://github.com/pytest-dev/pytest/issues/1366 .. _#1040: https://github.com/pytest-dev/pytest/pull/1040 -.. _#680: https://github.com/pytest-dev/pytest/issues/680 .. _#1287: https://github.com/pytest-dev/pytest/pull/1287 .. _#1226: https://github.com/pytest-dev/pytest/pull/1226 -.. _#1290: https://github.com/pytest-dev/pytest/pull/1290 .. _#1355: https://github.com/pytest-dev/pytest/pull/1355 -.. _#1397: https://github.com/pytest-dev/pytest/issues/1397 .. _@biern: https://github.com/biern .. _@MichaelAquilina: https://github.com/MichaelAquilina .. _@bukzor: https://github.com/bukzor diff --git a/doc/en/conf.py b/doc/en/conf.py index 4bb46b492..0e86a87b1 100644 --- a/doc/en/conf.py +++ b/doc/en/conf.py @@ -160,8 +160,10 @@ linkcheck_ignore = [ linkcheck_workers = 5 +_repo = "https://github.com/pytest-dev/pytest" extlinks = { "pypi": ("https://pypi.org/project/%s/", ""), + "issue": (f"{_repo}/issues/%s", "issue #"), } diff --git a/doc/en/deprecations.rst b/doc/en/deprecations.rst index b82dd8521..c47e9a703 100644 --- a/doc/en/deprecations.rst +++ b/doc/en/deprecations.rst @@ -367,7 +367,7 @@ Becomes: If you still have concerns about this deprecation and future removal, please comment on -`issue #3974 `__. +:issue:`3974`. .. _raises-warns-exec: diff --git a/doc/en/explanation/fixtures.rst b/doc/en/explanation/fixtures.rst index 2920cc200..194e57649 100644 --- a/doc/en/explanation/fixtures.rst +++ b/doc/en/explanation/fixtures.rst @@ -170,5 +170,5 @@ The reason pytest does not handle those signals to perform fixture cleanup is th and changing them might interfere with the code under execution. If fixtures in your suite need special care regarding termination in those scenarios, -see `this comment `__ in the issue +see :issue:`this comment <5243#issuecomment-491522595>` in the issue tracker for a possible workaround. diff --git a/doc/en/historical-notes.rst b/doc/en/historical-notes.rst index 3bfb81e4c..053f9fdfd 100644 --- a/doc/en/historical-notes.rst +++ b/doc/en/historical-notes.rst @@ -76,36 +76,36 @@ order doesn't even matter. You probably want to think of your marks as a set her If you are unsure or have any questions, please consider opening -`an issue `_. +:issue:`an issue `. Related issues ~~~~~~~~~~~~~~ Here is a non-exhaustive list of issues fixed by the new implementation: -* Marks don't pick up nested classes (`#199 `_). +* Marks don't pick up nested classes (:issue:`199`). -* Markers stain on all related classes (`#568 `_). +* Markers stain on all related classes (:issue:`568`). -* Combining marks - args and kwargs calculation (`#2897 `_). +* Combining marks - args and kwargs calculation (:issue:`2897`). -* ``request.node.get_marker('name')`` returns ``None`` for markers applied in classes (`#902 `_). +* ``request.node.get_marker('name')`` returns ``None`` for markers applied in classes (:issue:`902`). -* Marks applied in parametrize are stored as markdecorator (`#2400 `_). +* Marks applied in parametrize are stored as markdecorator (:issue:`2400`). -* Fix marker interaction in a backward incompatible way (`#1670 `_). +* Fix marker interaction in a backward incompatible way (:issue:`1670`). -* Refactor marks to get rid of the current "marks transfer" mechanism (`#2363 `_). +* Refactor marks to get rid of the current "marks transfer" mechanism (:issue:`2363`). -* Introduce FunctionDefinition node, use it in generate_tests (`#2522 `_). +* Introduce FunctionDefinition node, use it in generate_tests (:issue:`2522`). -* Remove named marker attributes and collect markers in items (`#891 `_). +* Remove named marker attributes and collect markers in items (:issue:`891`). -* skipif mark from parametrize hides module level skipif mark (`#1540 `_). +* skipif mark from parametrize hides module level skipif mark (:issue:`1540`). -* skipif + parametrize not skipping tests (`#1296 `_). +* skipif + parametrize not skipping tests (:issue:`1296`). -* Marker transfer incompatible with inheritance (`#535 `_). +* Marker transfer incompatible with inheritance (:issue:`535`). More details can be found in the `original PR `_. diff --git a/doc/en/how-to/capture-warnings.rst b/doc/en/how-to/capture-warnings.rst index 1a3d1873c..4c89905e2 100644 --- a/doc/en/how-to/capture-warnings.rst +++ b/doc/en/how-to/capture-warnings.rst @@ -199,8 +199,7 @@ the regular expression ``".*U.*mode is deprecated"``. Also pytest doesn't follow :pep:`506` suggestion of resetting all warning filters because it might break test suites that configure warning filters themselves - by calling :func:`warnings.simplefilter` (see issue `#2430 `_ - for an example of that). + by calling :func:`warnings.simplefilter` (see :issue:`2430` for an example of that). .. _`ensuring a function triggers a deprecation warning`: diff --git a/doc/en/how-to/fixtures.rst b/doc/en/how-to/fixtures.rst index db21a52e3..e0ac36e79 100644 --- a/doc/en/how-to/fixtures.rst +++ b/doc/en/how-to/fixtures.rst @@ -1668,7 +1668,7 @@ into an ini-file: ... Currently this will not generate any error or warning, but this is intended - to be handled by `#3664 `_. + to be handled by :issue:`3664`. .. _`override fixtures`: diff --git a/doc/en/how-to/logging.rst b/doc/en/how-to/logging.rst index 16879822d..2e8734fa6 100644 --- a/doc/en/how-to/logging.rst +++ b/doc/en/how-to/logging.rst @@ -289,5 +289,4 @@ file: log_cli=true log_level=NOTSET -More details about the discussion that lead to this changes can be read in -issue `#3013 `_. +More details about the discussion that lead to this changes can be read in :issue:`3013`. diff --git a/doc/en/how-to/monkeypatch.rst b/doc/en/how-to/monkeypatch.rst index 8c5f676b9..9c61233f7 100644 --- a/doc/en/how-to/monkeypatch.rst +++ b/doc/en/how-to/monkeypatch.rst @@ -252,7 +252,7 @@ so that any attempts within tests to create http requests will fail. m.setattr(functools, "partial", 3) assert functools.partial == 3 - See issue `#3290 `_ for details. + See :issue:`3290` for details. Monkeypatching environment variables diff --git a/doc/en/how-to/nose.rst b/doc/en/how-to/nose.rst index 486b3db75..4bf8b06c3 100644 --- a/doc/en/how-to/nose.rst +++ b/doc/en/how-to/nose.rst @@ -39,14 +39,13 @@ Unsupported idioms / known issues both support ``setup_class, teardown_class, setup_method, teardown_method`` it doesn't seem useful to duplicate the unittest-API like nose does. If you however rather think pytest should support the unittest-spelling on - plain classes please post `to this issue - `_. + plain classes please post to :issue:`377`. - nose imports test modules with the same import path (e.g. ``tests.test_mode``) but different file system paths (e.g. ``tests/test_mode.py`` and ``other/tests/test_mode.py``) by extending sys.path/import semantics. pytest does not do that - but there is discussion in `#268 `_ for adding some support. Note that + but there is discussion in :issue:`268` for adding some support. Note that `nose2 choose to avoid this sys.path/import hackery `_. If you place a conftest.py file in the root directory of your project diff --git a/doc/en/py27-py34-deprecation.rst b/doc/en/py27-py34-deprecation.rst index 7c1373cee..660b078e3 100644 --- a/doc/en/py27-py34-deprecation.rst +++ b/doc/en/py27-py34-deprecation.rst @@ -43,7 +43,7 @@ for critical bugs). Technical aspects ~~~~~~~~~~~~~~~~~ -(This section is a transcript from `#5275 `__). +(This section is a transcript from :issue:`5275`). In this section we describe the technical aspects of the Python 2.7 and 3.4 support plan. diff --git a/doc/en/reference/customize.rst b/doc/en/reference/customize.rst index 04845f935..22ce24b31 100644 --- a/doc/en/reference/customize.rst +++ b/doc/en/reference/customize.rst @@ -226,7 +226,7 @@ check for configuration files as follows: Custom pytest plugin commandline arguments may include a path, as in ``pytest --log-output ../../test.log args``. Then ``args`` is mandatory, otherwise pytest uses the folder of test.log for rootdir determination - (see also `issue 1435 `_). + (see also :issue:`1435`). A dot ``.`` for referencing to the current working directory is also possible. diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 00b9d308c..5750f81a5 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -1250,8 +1250,7 @@ passed multiple times. The expected format is ``name=value``. For example:: .. note:: The default value of this option is planned to change to ``xfail`` in future releases - as this is considered less error prone, see `#3155 `_ - for more details. + as this is considered less error prone, see :issue:`3155` for more details. .. confval:: faulthandler_timeout diff --git a/src/_pytest/junitxml.py b/src/_pytest/junitxml.py index 6d13e89a4..6a6161ecb 100644 --- a/src/_pytest/junitxml.py +++ b/src/_pytest/junitxml.py @@ -359,8 +359,8 @@ def record_testsuite_property(request: FixtureRequest) -> Callable[[str, object] .. warning:: Currently this fixture **does not work** with the - `pytest-xdist `__ plugin. See issue - `#7767 `__ for details. + `pytest-xdist `__ plugin. See + :issue:`7767` for details. """ __tracebackhide__ = True diff --git a/src/_pytest/monkeypatch.py b/src/_pytest/monkeypatch.py index e39712a90..31f95a95a 100644 --- a/src/_pytest/monkeypatch.py +++ b/src/_pytest/monkeypatch.py @@ -147,7 +147,7 @@ class MonkeyPatch: Useful in situations where it is desired to undo some patches before the test ends, such as mocking ``stdlib`` functions that might break pytest itself if mocked (for examples - of this see `#3290 `_. + of this see :issue:`3290`). """ m = cls() try: