]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-41910: specify the default implementations of object.__eq__ and object.__ne__...
authorBrett Cannon <brett@python.org>
Wed, 21 Oct 2020 23:24:38 +0000 (16:24 -0700)
committerGitHub <noreply@github.com>
Wed, 21 Oct 2020 23:24:38 +0000 (16:24 -0700)
See Objects/typeobject.c:object_richcompare() for the implementation of this in CPython.

Automerge-Triggered-By: GH:brettcannon
Doc/reference/datamodel.rst
Misc/NEWS.d/next/Core and Builtins/2020-10-21-14-40-54.bpo-41910.CzBMit.rst [new file with mode: 0644]

index ab4eb478efb8b2d2945fc4de69e8c8bf95b3baca..d92e19761a9654311f68523d58a746a3823f993b 100644 (file)
@@ -1395,12 +1395,14 @@ Basic customization
    context (e.g., in the condition of an ``if`` statement), Python will call
    :func:`bool` on the value to determine if the result is true or false.
 
-   By default, :meth:`__ne__` delegates to :meth:`__eq__` and
-   inverts the result unless it is ``NotImplemented``.  There are no other
-   implied relationships among the comparison operators, for example,
-   the truth of ``(x<y or x==y)`` does not imply ``x<=y``.
-   To automatically generate ordering operations from a single root operation,
-   see :func:`functools.total_ordering`.
+   By default, ``object`` implements :meth:`__eq__` by using ``is``, returning
+   ``NotImplemented`` in the case of a false comparison:
+   ``True if x is y else NotImplemented``. For :meth:`__ne__`, by default it
+   delegates to :meth:`__eq__` and inverts the result unless it is
+   ``NotImplemented``.  There are no other implied relationships among the
+   comparison operators or default implementations; for example, the truth of
+   ``(x<y or x==y)`` does not imply ``x<=y``. To automatically generate ordering
+   operations from a single root operation, see :func:`functools.total_ordering`.
 
    See the paragraph on :meth:`__hash__` for
    some important notes on creating :term:`hashable` objects which support
diff --git a/Misc/NEWS.d/next/Core and Builtins/2020-10-21-14-40-54.bpo-41910.CzBMit.rst b/Misc/NEWS.d/next/Core and Builtins/2020-10-21-14-40-54.bpo-41910.CzBMit.rst
new file mode 100644 (file)
index 0000000..a40e251
--- /dev/null
@@ -0,0 +1 @@
+Document the default implementation of `object.__eq__`.