Preparing release version 5.1.0

pytest-dev · Aug 16, 2019 · eaf7ce9 · eaf7ce9
1 parent 409d61b
commit eaf7ce9
Show file tree

Hide file tree

Showing 50 changed files with 361 additions and 228 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -18,6 +18,164 @@ with advance notice in the **Deprecations** section of releases.
 
 .. towncrier release notes start
 
+pytest 5.1.0 (2019-08-15)
+=========================
+
+Removals
+--------
+
+- `#5180 <https://github.com/pytest-dev/pytest/issues/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.
+
+  * ``pytest.raises`` and ``pytest.warns`` no longer support strings as the second argument.
+
+  * ``message`` parameter of ``pytest.raises``.
+
+  * ``pytest.raises``, ``pytest.warns`` and ``ParameterSet.param`` now use native keyword-only
+    syntax. This might change the exception message from previous versions, but they still raise
+    ``TypeError`` on unknown keyword arguments as before.
+
+  * ``pytest.config`` global variable.
+
+  * ``tmpdir_factory.ensuretemp`` method.
+
+  * ``pytest_logwarning`` hook.
+
+  * ``RemovedInPytest4Warning`` warning type.
+
+  * ``request`` is now a reserved name for fixtures.
+
+
+  For more information consult
+  `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs.
+
+
+- `#5565 <https://github.com/pytest-dev/pytest/issues/5565>`_: Removed unused support code for `unittest2 <https://pypi.org/project/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
+  to be used: after removed, all tests still pass unchanged.
+
+  Although our policy is to introduce a deprecation period before removing any features or support
+  for third party libraries, because this code is apparently not used
+  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 <https://github.com/pytest-dev/pytest/issues/new>`__.
+
+
+- `#5615 <https://github.com/pytest-dev/pytest/issues/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"``.
+
+  Python 3 code is unlikely to pass ``bytes`` to these functions. If you do,
+  please decode it to an ``str`` beforehand.
+
+
+
+Features
+--------
+
+- `#5564 <https://github.com/pytest-dev/pytest/issues/5564>`_: New ``Config.invocation_args`` attribute containing the unchanged arguments passed to ``pytest.main()``.
+
+
+- `#5576 <https://github.com/pytest-dev/pytest/issues/5576>`_: New `NUMBER <https://docs.pytest.org/en/latest/doctest.html#using-doctest-options>`__
+  option for doctests to ignore irrelevant differences in floating-point numbers.
+  Inspired by Sébastien Boisgérault's `numtest <https://github.com/boisgera/numtest>`__
+  extension for doctest.
+
+
+
+Improvements
+------------
+
+- `#5471 <https://github.com/pytest-dev/pytest/issues/5471>`_: JUnit XML now includes a timestamp and hostname in the testsuite tag.
+
+
+- `#5707 <https://github.com/pytest-dev/pytest/issues/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) =====
+
+
+
+Bug Fixes
+---------
+
+- `#4344 <https://github.com/pytest-dev/pytest/issues/4344>`_: Fix RuntimeError/StopIteration when trying to collect package with "__init__.py" only.
+
+
+- `#5115 <https://github.com/pytest-dev/pytest/issues/5115>`_: Warnings issued during ``pytest_configure`` are explicitly not treated as errors, even if configured as such, because it otherwise completely breaks pytest.
+
+
+- `#5477 <https://github.com/pytest-dev/pytest/issues/5477>`_: The XML file produced by ``--junitxml`` now correctly contain a ``<testsuites>`` root element.
+
+
+- `#5523 <https://github.com/pytest-dev/pytest/issues/5523>`_: Fixed using multiple short options together in the command-line (for example ``-vs``) in Python 3.8+.
+
+
+- `#5524 <https://github.com/pytest-dev/pytest/issues/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 <https://github.com/pytest-dev/pytest/issues/5537>`_: Replace ``importlib_metadata`` backport with ``importlib.metadata`` from the
+  standard library on Python 3.8+.
+
+
+- `#5578 <https://github.com/pytest-dev/pytest/issues/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 <https://github.com/pytest-dev/pytest/issues/5606>`_: Fixed internal error when test functions were patched with objects that cannot be compared
+  for truth values against others, like ``numpy`` arrays.
+
+
+- `#5634 <https://github.com/pytest-dev/pytest/issues/5634>`_: ``pytest.exit`` is now correctly handled in ``unittest`` cases.
+  This makes ``unittest`` cases handle ``quit`` from pytest's pdb correctly.
+
+
+- `#5650 <https://github.com/pytest-dev/pytest/issues/5650>`_: Improved output when parsing an ini configuration file fails.
+
+
+- `#5701 <https://github.com/pytest-dev/pytest/issues/5701>`_: Fix collection of ``staticmethod`` objects defined with ``functools.partial``.
+
+
+- `#5734 <https://github.com/pytest-dev/pytest/issues/5734>`_: Skip async generator test functions, and update the warning message to refer to ``async def`` functions.
+
+
+
+Improved Documentation
+----------------------
+
+- `#5669 <https://github.com/pytest-dev/pytest/issues/5669>`_: Add docstring for ``Testdir.copy_example``.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#5095 <https://github.com/pytest-dev/pytest/issues/5095>`_: XML files of the ``xunit2`` family are now validated against the schema by pytest's own test suite
+  to avoid future regressions.
+
+
+- `#5516 <https://github.com/pytest-dev/pytest/issues/5516>`_: Cache node splitting function which can improve collection performance in very large test suites.
+
+
+- `#5603 <https://github.com/pytest-dev/pytest/issues/5603>`_: Simplified internal ``SafeRepr`` class and removed some dead code.
+
+
+- `#5664 <https://github.com/pytest-dev/pytest/issues/5664>`_: When invoking pytest's own testsuite with ``PYTHONDONTWRITEBYTECODE=1``,
+  the ``test_xfail_handling`` test no longer fails.
+
+
+- `#5684 <https://github.com/pytest-dev/pytest/issues/5684>`_: Replace manual handling of ``OSError.errno`` in the codebase by new ``OSError`` subclasses (``PermissionError``, ``FileNotFoundError``, etc.).
+
+
 pytest 5.0.1 (2019-07-04)
 =========================
 

diff --git a/changelog/4344.bugfix.rst b/changelog/4344.bugfix.rst
diff --git a/changelog/5095.trivial.rst b/changelog/5095.trivial.rst
diff --git a/changelog/5115.bugfix.rst b/changelog/5115.bugfix.rst
diff --git a/changelog/5180.removal.rst b/changelog/5180.removal.rst
diff --git a/changelog/5471.improvement.rst b/changelog/5471.improvement.rst
diff --git a/changelog/5477.bugfix.rst b/changelog/5477.bugfix.rst
diff --git a/changelog/5516.trivial.rst b/changelog/5516.trivial.rst
diff --git a/changelog/5523.bugfix.rst b/changelog/5523.bugfix.rst
diff --git a/changelog/5524.bugfix.rst b/changelog/5524.bugfix.rst
diff --git a/changelog/5537.bugfix.rst b/changelog/5537.bugfix.rst
diff --git a/changelog/5564.feature.rst b/changelog/5564.feature.rst
diff --git a/changelog/5565.removal.rst b/changelog/5565.removal.rst
diff --git a/changelog/5576.feature.rst b/changelog/5576.feature.rst
diff --git a/changelog/5578.bugfix.rst b/changelog/5578.bugfix.rst
diff --git a/changelog/5603.trivial.rst b/changelog/5603.trivial.rst
diff --git a/changelog/5606.bugfix.rst b/changelog/5606.bugfix.rst
diff --git a/changelog/5615.removal.rst b/changelog/5615.removal.rst
diff --git a/changelog/5634.bugfix.rst b/changelog/5634.bugfix.rst
diff --git a/changelog/5650.bugfix.rst b/changelog/5650.bugfix.rst
diff --git a/changelog/5664.trivial.rst b/changelog/5664.trivial.rst
diff --git a/changelog/5669.doc.rst b/changelog/5669.doc.rst
diff --git a/changelog/5684.trivial.rst b/changelog/5684.trivial.rst
diff --git a/changelog/5701.bugfix.rst b/changelog/5701.bugfix.rst
diff --git a/changelog/5707.improvement.rst b/changelog/5707.improvement.rst
diff --git a/changelog/5734.bugfix.rst b/changelog/5734.bugfix.rst
diff --git a/doc/en/announce/index.rst b/doc/en/announce/index.rst
@@ -6,6 +6,7 @@ Release announcements
    :maxdepth: 2
 
 
+   release-5.1.0
    release-5.0.1
    release-5.0.0
    release-4.6.5

diff --git a/doc/en/announce/release-5.1.0.rst b/doc/en/announce/release-5.1.0.rst
@@ -0,0 +1,56 @@
+pytest-5.1.0
+=======================================
+
+The pytest team is proud to announce the 5.1.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Albert Tugushev
+* Alexey Zankevich
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* David Röthlisberger
+* Florian Bruhin
+* Ilya Stepin
+* Jon Dufresne
+* Kaiqi
+* Max R
+* Miro Hrončok
+* Oliver Bestwalter
+* Ran Benita
+* Ronny Pfannschmidt
+* Samuel Searles-Bryant
+* Semen Zhydenko
+* Steffen Schroeder
+* Thomas Grainger
+* Tim Hoffmann
+* William Woodall
+* Wojtek Erbetowski
+* Xixi Zhao
+* Yash Todi
+* boris
+* dmitry.dygalo
+* helloocc
+* martbln
+* mei-li
+
+
+Happy testing,
+The Pytest Development Team
diff --git a/doc/en/assert.rst b/doc/en/assert.rst
@@ -47,7 +47,7 @@ you will see the return value of the function call:
     E        +  where 3 = f()
 
     test_assert1.py:6: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    ============================ 1 failed in 0.05s =============================
 
 ``pytest`` has support for showing the values of the most common subexpressions
 including calls, attributes, comparisons, and binary and unary
@@ -208,7 +208,7 @@ if you run this module:
     E         Use -v to get the full diff
 
     test_assert2.py:6: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    ============================ 1 failed in 0.05s =============================
 
 Special comparisons are done for a number of cases:
 
@@ -279,7 +279,7 @@ the conftest file:
    E            vals: 1 != 2
 
    test_foocompare.py:12: AssertionError
-   1 failed in 0.12 seconds
+   1 failed in 0.05s
 
 .. _assert-details:
 .. _`assert introspection`:

diff --git a/doc/en/builtin.rst b/doc/en/builtin.rst
@@ -160,7 +160,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
             in python < 3.6 this is a pathlib2.Path
 
 
-    no tests ran in 0.12 seconds
+    no tests ran in 0.01s
 
 You can also interactively ask for help, e.g. by typing on the Python interactive prompt something like: