Preparing release version 5.2.1

Fix warnings with attrs 19.2 and fix object assertions

CHANGELOG.rst

@@ -18,6 +18,15 @@ with advance notice in the **Deprecations** section of releases.
 
 .. towncrier release notes start
 
+pytest 5.2.1 (2019-10-06)
+=========================
+
+Bug Fixes
+---------
+
+- `#5902 <https://github.com/pytest-dev/pytest/issues/5902>`_: Fix warnings about deprecated ``cmp`` attribute in ``attrs>=19.2``.
+
+
 pytest 5.2.0 (2019-09-28)
 =========================
 
@@ -34,7 +43,7 @@ Features
 
 - `#1682 <https://github.com/pytest-dev/pytest/issues/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 `the docs <https://docs.pytest.org/en/fixture.html#dynamic-scope>`__ for more information.
+  See `the docs <https://docs.pytest.org/en/latest/fixture.html#dynamic-scope>`__ for more information.
 
 
 - `#5764 <https://github.com/pytest-dev/pytest/issues/5764>`_: New behavior of the ``--pastebin`` option: failures to connect to the pastebin server are reported, without failing the pytest run

doc/en/announce/index.rst

@@ -6,6 +6,7 @@ Release announcements
    :maxdepth: 2
 
 
+   release-5.2.1
    release-5.2.0
    release-5.1.3
    release-5.1.2

doc/en/announce/release-5.2.1.rst

@@ -0,0 +1,23 @@
+pytest-5.2.1
+=======================================
+
+pytest 5.2.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Florian Bruhin
+* Hynek Schlawack
+* Kevin J. Foley
+* tadashigaki
+
+
+Happy testing,
+The pytest Development Team

doc/en/customize.rst

@@ -134,10 +134,13 @@ progress output, you can write it into a configuration file:
 .. code-block:: ini
 
     # content of pytest.ini or tox.ini
-    # setup.cfg files should use [tool:pytest] section instead
     [pytest]
     addopts = -ra -q
 
+    # content of setup.cfg
+    [tool:pytest]
+    addopts = -ra -q
+
 Alternatively, you can set a ``PYTEST_ADDOPTS`` environment variable to add command
 line options while the environment is in use:
 

doc/en/reference.rst

@@ -1003,7 +1003,7 @@ passed multiple times. The expected format is ``name=value``. For example::
         [pytest]
         addopts = --maxfail=2 -rf  # exit after 2 failures, report fail info
 
-   issuing ``pytest test_hello.py`` actually means::
+   issuing ``pytest test_hello.py`` actually means:
 
    .. code-block:: bash
 

src/_pytest/assertion/util.py

@@ -8,6 +8,7 @@ from typing import Optional
 import _pytest._code
 from _pytest import outcomes
 from _pytest._io.saferepr import saferepr
+from _pytest.compat import ATTRS_EQ_FIELD
 
 # The _reprcompare attribute on the util module is used by the new assertion
 # interpretation code and assertion rewriter to detect this plugin was
@@ -375,7 +376,9 @@ def _compare_eq_cls(left, right, verbose, type_fns):
         fields_to_check = [field for field, info in all_fields.items() if info.compare]
     elif isattrs(left):
         all_fields = left.__attrs_attrs__
-        fields_to_check = [field.name for field in all_fields if field.cmp]
+        fields_to_check = [
+            field.name for field in all_fields if getattr(field, ATTRS_EQ_FIELD)
+        ]
 
     same = []
     diff = []

src/_pytest/compat.py

@@ -354,3 +354,9 @@ if sys.version_info < (3, 5, 2):  # pragma: no cover
 
     def overload(f):  # noqa: F811
         return f
+
+
+if getattr(attr, "__version_info__", ()) >= (19, 2):
+    ATTRS_EQ_FIELD = "eq"
+else:
+    ATTRS_EQ_FIELD = "cmp"

src/_pytest/mark/structures.py

@@ -8,6 +8,7 @@ from typing import Set
 import attr
 
 from ..compat import ascii_escaped
+from ..compat import ATTRS_EQ_FIELD
 from ..compat import getfslineno
 from ..compat import NOTSET
 from _pytest.outcomes import fail
@@ -367,7 +368,8 @@ class NodeKeywords(MutableMapping):
         return "<NodeKeywords for node {}>".format(self.node)
 
 
-@attr.s(cmp=False, hash=False)
+# mypy cannot find this overload, remove when on attrs>=19.2
+@attr.s(hash=False, **{ATTRS_EQ_FIELD: False})  # type: ignore
 class NodeMarkers:
     """
     internal structure for storing marks belonging to a node

src/_pytest/pytester.py

@@ -351,15 +351,14 @@ class RunResult:
 
     Attributes:
 
-    :ret: the return value
-    :outlines: list of lines captured from stdout
-    :errlines: list of lines captures from stderr
-    :stdout: :py:class:`LineMatcher` of stdout, use ``stdout.str()`` to
+    :ivar ret: the return value
+    :ivar outlines: list of lines captured from stdout
+    :ivar errlines: list of lines captured from stderr
+    :ivar stdout: :py:class:`LineMatcher` of stdout, use ``stdout.str()`` to
        reconstruct stdout or the commonly used ``stdout.fnmatch_lines()``
        method
-    :stderr: :py:class:`LineMatcher` of stderr
-    :duration: duration in seconds
-
+    :ivar stderr: :py:class:`LineMatcher` of stderr
+    :ivar duration: duration in seconds
     """
 
     def __init__(self, ret, outlines, errlines, duration):
@@ -454,9 +453,9 @@ class Testdir:
 
     Attributes:
 
-    :tmpdir: The :py:class:`py.path.local` instance of the temporary directory.
+    :ivar tmpdir: The :py:class:`py.path.local` instance of the temporary directory.
 
-    :plugins: A list of plugins to use with :py:meth:`parseconfig` and
+    :ivar plugins: A list of plugins to use with :py:meth:`parseconfig` and
        :py:meth:`runpytest`.  Initially this is an empty list but plugins can
        be added to the list.  The type of items to add to the list depends on
        the method using them so refer to them for details.

testing/test_assertion.py

@@ -9,6 +9,7 @@ import pytest
 from _pytest import outcomes
 from _pytest.assertion import truncate
 from _pytest.assertion import util
+from _pytest.compat import ATTRS_EQ_FIELD
 
 
 def mock_config():
@@ -687,7 +688,7 @@ class TestAssert_reprcompare_attrsclass:
         @attr.s
         class SimpleDataObject:
             field_a = attr.ib()
-            field_b = attr.ib(cmp=False)
+            field_b = attr.ib(**{ATTRS_EQ_FIELD: False})
 
         left = SimpleDataObject(1, "b")
         right = SimpleDataObject(1, "b")