Skip to content
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
6 changes: 5 additions & 1 deletion dargs/dargs.py
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,11 @@ def _assign_default(self, argdict: dict, path: list[str] | None = None) -> None:
and self.optional
and self.default is not _Flags.NONE
):
default = self.default if self.default != {} else _Flags.EMPTY_DICT
# Defaults belong to the schema and must not be shared with caller-owned
# normalized data. Deep-copying also protects nested mutable objects.
default = (
deepcopy(self.default) if self.default != {} else _Flags.EMPTY_DICT
)
argdict[self.name] = default

def _handle_empty_dict(self, argdict: dict, path: list[str] | None = None) -> None:
Expand Down
20 changes: 20 additions & 0 deletions tests/test_normalizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ def make_arguments() -> list[Argument]:
data = base.normalize_value({})
self.assertDictEqual(data, {"bar": {}})

def test_mutable_defaults_are_copied(self) -> None:
"""Mutating normalized defaults must not change later results or schemas."""
items = Argument("items", list, optional=True, default=[])
settings = Argument(
"settings",
dict,
optional=True,
default={"labels": []},
)
base = Argument("base", dict, [items, settings])

first = base.normalize_value({})
first["items"].append("changed")
first["settings"]["labels"].append("changed")
second = base.normalize_value({})

self.assertEqual(second, {"items": [], "settings": {"labels": []}})
self.assertEqual(items.default, [])
self.assertEqual(settings.default, {"labels": []})

def test_alias(self) -> None:
ca = Argument("Key1", int, alias=["Old1", "Old2"])
beg = {"Old1": 1}
Expand Down
Loading