mashumaro
Fast and well tested serialization library
APACHE-2.0 License
Bot releases are hidden (Show)
Changes
- Added support for associating multiple tags with a single variant by returning a list of tags from
variant_tagger_fn(#184) - Added support for locally defined types (#180, #182, #189)
- Added support for
ForwardRefin JSON Schema generation (#187) - Fixed serialization of
IntFlagwhenomit_defaultis enabled (#188) - Improved type annotations for
serialization_strategyconfig option
Changes
- Added "codecs" feature to separate data models from serialization and work with top-level lists, dataclasses without mixins etc. (#108, #69), see updated documentation
- Added new
allow_deserialization_not_by_aliasconfig option to allow deserialization by both alias and field name, see documentation (https://github.com/Fatal1ty/mashumaro/pull/175) - Fixed
UnserializableDataErrorfor generic serializable types and generic serialization strategies with postponed evaluation of annotations (#177) - Fixed regression when
ValueErrorwas not thrown if invalid value type was passed tofrom_*method - Added
serialize_by_aliasdialect option - Added
namedtuple_as_dictdialect option
Changes
- Added new
sort_keysconfig option to sort keys on serialization, see documentation (#157) - Added new
omit_defaultconfig and dialect options to exclude values equal to defaults on serialization, see documentation (#161) - Added
variant_tagger_fndiscriminator parameter to allow discrimination based on a key that is not part of the model, see documentation (#135) - Added new
no_copy_collectionsdialect option to avoid collection data types copying, see documentation (#163) - Added support for
LiteralString(#166) - Added initial support for
ForwardReftypes (#144) - Added ability to use basic types as serialization methods so that they will be reflected in the JSON schema (#148)
- Added ability to use slots in
SerializableTypeandGenericSerializableTypesubclasses (#156) - Added ability to use frozen dataclasses as dictionary keys (#160)
- Added support for Python 3.12 (#153)
- Dropped support for Python 3.7 (#147)
- Moved from
flake8toruff(#150)
Changes
- Fixed handling of collections of annotated with unhashable metadata types on python < 3.9 (#138)
- Fixed JSON Schema for inner dataclasses and optional fields with custom serialization methods (#139)
- Fixed JSON Schema for third-party types with default value (#141)
Changes
- Added support for inner dataclasses without mashumaro mixins (#109)
- Added support for
default_factoryby JSON Schema generator (#114) - Added ability to override
additionalPropertiesin JSON Schema (#123) - Added ability to add "description" keyword in JSON Schema by using "description" key in dataclass field metadata (#125)
- Fixed default reference prefix in JSON Schema 2022-12 dialect (#126)
- Fixed handling of
Annotatedtype with unhashable metadata (#133)
Changes
- Added new
Discriminatortype for discriminated unions and subclasses support, see documentation (#106) - Added ability to pass custom context from
to_*methods to the hooks, see documentation (#110) - Types enclosed in
Annotatedare now different from unenclosed ones inserialization_strategy, see documentation (#115) - Added new
lazy_compilationconfig option that can reduce import time and speed up deserialization, see documentation - Added support for
Finaltypes (#107) - Fixed support for
Literalon Python 3.9.0 (#103) - Added workaround for mypy problem https://github.com/python/mypy/issues/3186 in JSON Schema number constraints
- Fixed type substitutions in generic
SerializableTypewhen TypeVars were mixed with ordinary types in_serialize/_deserializeannotations - Fixed an issue where a sentinel value
dataclasses.KW_ONLYresulted inUnserializableDataError - Fixed an issue where passing a user-defined dict-like object to
from_dictmethod could result in unhandled exceptions - Speeded up dataclass instantiation
- Speeded up deserialization of fields with default values if they are missing in the input data
Changes
- Added
"omit"serialization engine to skip the field during serialization - Added
ref_prefixparameter tobuild_json_schemaandJSONSchemaBuilderto change reference prefix - Fixed adding dataclass field alias to JSON Schema "required" keyword value. See https://github.com/Fatal1ty/mashumaro/issues/101.
Changes
- Added JSON Schema generation functionality 🎉 (see documentation)
- Draft 2022-12 and OpenAPI Specification 3.1.0
- Validation keywords using typing.Annotated
- No mixin required
Changes
- Added possibility to define a generic serialization method for a generic type by registering a method for its origin type
- Improved support for third-party generic types by writing a generic
SerializationStrategy(details) - Improved writing
SerializationStrategymethods by optionaluse_annotations=True(details) - Classes defining
__class_getitem__methods will now be treated as generic types according to PEP 560
Changes
- Fixed
UnresolvedTypeReferenceErrorwhen postponed annotations were used and parent generic dataclass was defined in different module. See https://github.com/Fatal1ty/mashumaro/issues/90. - Fixed recursion error for self-referenced generic dataclasses. See https://github.com/Fatal1ty/mashumaro/issues/91.
- Fixed inconsistent application of serialization_strategy appeared in version 3.2. See https://github.com/Fatal1ty/mashumaro/issues/93.
Changes
- Added ability to use annotations inside
SerializableTypeto simplify dealing with generic types (see updated documentation) - Added support for user-defined variadic generic types and dataclasses,
TypeVarTupleandUnpackfrom PEP 646 - Fixed serialization / deserialization of
Tuple[()]on python 3.11 - Changed type name for
Tuple[T, ...]from"Tuple[T, Ellipsis]"to"Tuple[T, ...]"
Changes
- Added support for PEP 655
- Added skipping
Nonevalue fields on serialization to TOML format. See https://github.com/Fatal1ty/mashumaro/issues/85. - Added new
omit_noneconfig option - Added new
omit_nonedialect option - Removed allowance to pass
Nonevalues to fields that can't beNoneaccording to their type - Speeded up the generated code
- Dropped Python 3.6 support
Changes
- Fixed using compiled mixins with inheritance. See https://github.com/Fatal1ty/mashumaro/issues/87.
Changes
- Added support for Python 3.11
- Added support for
typing.Selfandtyping_extensions.Self - In addition to
from_dictandto_dict, methods in other mixins can also be compiled now - Increased speed of serialization and deserialization in MessagePack when using
DataClassMessagePackMixin:- Removed the implicit inclusion of the
ADD_DIALECT_SUPPORTconfig option when usingDataClassMessagePackMixin - Methods
from_msgpackandto_msgpackare now compiled
- Removed the implicit inclusion of the
- Added
DataClassORJSONMixinto use a third-partyorjsonlibrary that will handle supported data types by itself- Added new
orjson_optionsconfig option to change default options passing toorjson.dumpsmethod - Methods
to_jsonbandto_jsonhaveorjson_optionskeyword argument to override the default options
- Added new
- Added support for TOML format using
DataClassTOMLMixin
Changes
- Fixed using fields with
init=False— they are skipped during deserialization now. See https://github.com/Fatal1ty/mashumaro/issues/82.
Changes
- Fixed using dialects for
DataClassMessagePackMixin. See https://github.com/Fatal1ty/mashumaro/issues/76.
Changes
- Fixed using dialects with inheritance. See https://github.com/Fatal1ty/mashumaro/issues/78.
Changes
- Fixed using Optional in tuples, named tuples and typed dicts. See https://github.com/Fatal1ty/mashumaro/issues/73.
Package Rankings
Top 43.41% on Anaconda.org
Top 27.15% on Conda-forge.org
Top 1.8% on Pypi.org
Badges
Extracted from project README's
