Skip to content

gh-144162: Allow for subclasses of a dataclass to define required fields when a parent has defined optional fields #133168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
19 changes: 14 additions & 5 deletions Lib/dataclasses.py
Original file line number Diff line number Diff line change
Expand Up @@ -409,12 +409,21 @@ def field(*, default=MISSING, default_factory=MISSING, init=True, repr=True,


def _fields_in_init_order(fields):
# Returns the fields as __init__ will output them. It returns 2 tuples:
# the first for normal args, and the second for keyword args.
required_fields = []
optional_fields = []
kw_fields = []
for f in fields:
if not f.init:
continue
if f.kw_only:
kw_fields.append(f)
elif f.default is MISSING and f.default_factory is MISSING:
required_fields.append(f)
else:
optional_fields.append(f)

return tuple(required_fields + optional_fields), tuple(kw_fields)

return (tuple(f for f in fields if f.init and not f.kw_only),
tuple(f for f in fields if f.init and f.kw_only)
)


def _tuple_str(obj_name, fields):
Expand Down
26 changes: 26 additions & 0 deletions Lib/test/test_dataclass.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import unittest
from dataclasses import dataclass

class TestDataclassInheritanceFieldOrder(unittest.TestCase):
def test_required_after_optional_in_subclass(self):
@dataclass
class Base:
x: int = 10 # optional field with default

@dataclass
class Sub(Base):
y: int # required field in subclass

# Should require y but allow optional x to be omitted
obj = Sub(y=5)
self.assertEqual(obj.x, 10)
self.assertEqual(obj.y, 5)

# Should allow overriding x
obj2 = Sub(x=42, y=9)
self.assertEqual(obj2.x, 42)
self.assertEqual(obj2.y, 9)

# Missing y should raise TypeError
with self.assertRaises(TypeError):
Sub()
Loading