Skip to content
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

gh-124176: create_autospec must not change how dataclass defaults are mocked #124724

Open
wants to merge 3 commits 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
26 changes: 26 additions & 0 deletions Lib/test/test_unittest/testmock/testhelpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -1107,6 +1107,32 @@ class WithNonFields:
with self.assertRaisesRegex(AttributeError, msg):
mock.b

def test_dataclass_default_value_type_overrides_field_annotation(self):
# If field defines an actual default, we don't need to change
# the default type. Since this is how it used to work before #124176
@dataclass
class WithUnionAnnotation:
narrow_default: int | None = field(default=30)

for mock in [
create_autospec(WithUnionAnnotation, instance=True),
create_autospec(WithUnionAnnotation()),
]:
with self.subTest(mock=mock):
self.assertIs(mock.narrow_default.__class__, int)

def test_dataclass_field_with_no_default_value(self):
@dataclass
class WithUnionAnnotation:
no_default: int | None

mock = create_autospec(WithUnionAnnotation, instance=True)
self.assertIs(mock.no_default.__class__, type(int | None))

mock = create_autospec(WithUnionAnnotation(1))
self.assertIs(mock.no_default.__class__, int)


class TestCallList(unittest.TestCase):

def test_args_list_contains_call_list(self):
Expand Down
12 changes: 9 additions & 3 deletions Lib/unittest/mock.py
Original file line number Diff line number Diff line change
Expand Up @@ -2758,13 +2758,19 @@ def create_autospec(spec, spec_set=False, instance=False, _parent=None,
f'[object={spec!r}]')
is_async_func = _is_async_func(spec)

entries = [(entry, _missing) for entry in dir(spec)]
base_entries = {entry: _missing for entry in dir(spec)}
if is_type and instance and is_dataclass(spec):
# Dataclass instance mocks created from a class may not have all of their fields
# prepopulated with default values. Create an initial set of attribute entries from
# the dataclass field annotations, but override them with the actual attribute types
# when fields have already been populated.
dataclass_fields = fields(spec)
sobolevn marked this conversation as resolved.
Show resolved Hide resolved
entries.extend((f.name, f.type) for f in dataclass_fields)
entries = {f.name: f.type for f in dataclass_fields}
ncoghlan marked this conversation as resolved.
Show resolved Hide resolved
entries.update(base_entries)
_kwargs = {'spec': [f.name for f in dataclass_fields]}
else:
_kwargs = {'spec': spec}
entries = base_entries

if spec_set:
_kwargs = {'spec_set': spec}
Expand Down Expand Up @@ -2822,7 +2828,7 @@ def create_autospec(spec, spec_set=False, instance=False, _parent=None,
_name='()', _parent=mock,
wraps=wrapped)

for entry, original in entries:
for entry, original in entries.items():
if _is_magic(entry):
# MagicMock already does the useful magic methods for us
continue
Expand Down
Loading