Clarify is_dataclass Behavior for Subclasses in Documentation and Tests

adiaholic · adiaholic · commit 628bb9429af4 · 2024-05-23T15:07:12.000-07:00
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
@@ -461,8 +461,9 @@ 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, an instance of a dataclass,
+   or a subclass of a dataclass, otherwise return ``False``. Note that subclasses
+   of dataclasses inherit the properties of the dataclass so will return ``True``.
 
    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
diff --git a/Lib/test/test_dataclasses/__init__.py b/Lib/test/test_dataclasses/__init__.py
@@ -1524,6 +1524,24 @@ class A(types.GenericAlias):
         self.assertTrue(is_dataclass(type(a)))
         self.assertTrue(is_dataclass(a))
 
+    def test_is_dataclass_for_subclass(self):
+        # Test to ensure that inheritance from a dataclass works correctly
+        # and that the subclass is also recognized as a dataclass.
+        @dataclass
+        class X:
+            y: int
+
+        class Z(X):
+            z: int = 0  # Adding a default field to demonstrate inheritance and dataclass behavior
+
+        # Check if X is a dataclass
+        self.assertTrue(is_dataclass(X), "X should be a dataclass")
+        # Check if Z is a dataclass, it should inherit the dataclass behavior from X
+        self.assertTrue(is_dataclass(Z), "Z should be a dataclass because it inherits from X")
+        # Create an instance of Z and check if the default values are set correctly
+        z_instance = Z(y=5)
+        self.assertEqual(z_instance.y, 5, "The value of y should be set to 5")
+        self.assertEqual(z_instance.z, 0, "The default value of z should be 0")
 
     def test_helper_fields_with_class_instance(self):
         # Check that we can call fields() on either a class or instance,
