Closed jodal closed 8 months ago
Thanks for opening this - this should be fixed by #653. Note that for these cases specifying the default value by value (rather than via default_factory
) already works:
import msgspec
class Backpack(msgspec.Struct, omit_defaults=True):
a_list: list[str] = []
a_tuple: tuple[str, ...] = ()
a_frozenset: frozenset[str] = frozenset()
instance = Backpack()
print(msgspec.json.encode(instance))
#> b'{}'
The reason tuple
and frozenset
are the special cases here is that they're both immutable types and may always be specified by value. Since there's no functional reason to use a default_factory
for these types, we hadn't implemented the logic to check for equivalent defaults based on default_factory
for tuple
/frozenset
.
Thank you for the very swift fix! Especially useful with the tip on how to achieve this without waiting for a new release :-)
Description
When a struct has
omit_defaults=True
set, any fields defaulting todict
,list
, orset
is omitted from the serialization, as described in the docs.However, if one is using
tuple
instead oflist
andfrozenset
instead ofset
as default values, to make the struct as immutable as possible, those defaults are included in the encoded format.I think that
tuple
andfrozenset
should be handled in the same way asdict
,list, and
setby
omit_defaultsand
repr_omit_defaults`.Example
Output:
Expected: