Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions Doc/library/dataclasses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,19 @@ Module contents
ignored.

- *eq*: If true (the default), an :meth:`~object.__eq__` method will be
generated. This method compares the class as if it were a tuple
of its fields, in order. Both instances in the comparison must
be of the identical type.
generated.

.. versionchanged:: 3.13
The generated ``__eq__`` method now compares each field individually
(for example, ``self.a == other.a and self.b == other.b``), rather than
comparing tuples of fields as in previous versions.

This method compares the class by comparing each field in order. Both
instances in the comparison must be of the identical type.
Comment thread
vstinner marked this conversation as resolved.
Outdated

In Python 3.12 and earlier, the comparison was performed by creating
tuples of the fields and comparing them (for example,
``(self.a, self.b) == (other.a, other.b)``).
Comment thread
vstinner marked this conversation as resolved.
Outdated

If the class already defines :meth:`!__eq__`, this parameter is
ignored.
Expand Down
49 changes: 49 additions & 0 deletions Lib/test/test_dataclasses/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2597,6 +2597,55 @@ def __eq__(self, other):
self.assertEqual(C(1), 5)
self.assertNotEqual(C(1), 1)

def test_eq_field_by_field(self):
@dataclasses.dataclass
class Point:
x: int
y: int

p1 = Point(1, 2)
p2 = Point(1, 2)
p3 = Point(2, 1)
self.assertTrue(p1 == p2)
Comment thread
ericvsmith marked this conversation as resolved.
Outdated
self.assertFalse(p1 == p3)

def test_eq_type_check(self):
@dataclasses.dataclass
class A:
x: int

@dataclasses.dataclass
class B:
x: int

a = A(1)
b = B(1)
self.assertFalse(a == b)
Comment thread
ericvsmith marked this conversation as resolved.
Outdated

def test_eq_custom_field(self):
class AlwaysEqual(int):
def __eq__(self, other):
return True

@dataclasses.dataclass
class Foo:
x: AlwaysEqual
y: int

f1 = Foo(AlwaysEqual(1), 2)
f2 = Foo(AlwaysEqual(2), 2)
self.assertTrue(f1 == f2)

Comment thread
ericvsmith marked this conversation as resolved.
def test_eq_nan_field(self):
@dataclasses.dataclass
class D:
x: float

nan = float('nan')
d1 = D(nan)
d2 = D(nan)
self.assertFalse(d1 == d2)
Comment thread
ericvsmith marked this conversation as resolved.
Outdated


class TestOrdering(unittest.TestCase):
def test_functools_total_ordering(self):
Expand Down
Loading