mirror of https://github.com/python/cpython
gh-119260: Clarify is_dataclass Behavior for Subclasses in Documentation and Tests (#119480)
Co-authored-by: Carl Meyer <carl@oddbird.net>
This commit is contained in:
parent
0751511d24
commit
bf4ff3ad2e
|
@ -461,8 +461,8 @@ Module contents
|
|||
|
||||
.. function:: is_dataclass(obj)
|
||||
|
||||
Return ``True`` if its parameter is a dataclass or an instance of one,
|
||||
otherwise return ``False``.
|
||||
Return ``True`` if its parameter is a dataclass (including subclasses of a
|
||||
dataclass) or an instance of one, otherwise return ``False``.
|
||||
|
||||
If you need to know if a class is an instance of a dataclass (and
|
||||
not a dataclass itself), then add a further check for ``not
|
||||
|
|
|
@ -1547,6 +1547,24 @@ class TestCase(unittest.TestCase):
|
|||
self.assertTrue(is_dataclass(type(a)))
|
||||
self.assertTrue(is_dataclass(a))
|
||||
|
||||
def test_is_dataclass_inheritance(self):
|
||||
@dataclass
|
||||
class X:
|
||||
y: int
|
||||
|
||||
class Z(X):
|
||||
pass
|
||||
|
||||
self.assertTrue(is_dataclass(X), "X should be a dataclass")
|
||||
self.assertTrue(
|
||||
is_dataclass(Z),
|
||||
"Z should be a dataclass because it inherits from X",
|
||||
)
|
||||
z_instance = Z(y=5)
|
||||
self.assertTrue(
|
||||
is_dataclass(z_instance),
|
||||
"z_instance should be a dataclass because it is an instance of Z",
|
||||
)
|
||||
|
||||
def test_helper_fields_with_class_instance(self):
|
||||
# Check that we can call fields() on either a class or instance,
|
||||
|
|
Loading…
Reference in New Issue