Bug fixes:
- Allow timestamp 0 in
fields.DateTime
(2133
). Thanksflydzen
for reporting.
Bug fixes:
- Fix error message when field is declared as a class and not an instance (
2245
). Thankstravnick
for reporting.
Bug fixes:
- Fix validation of
URL
fields to allow missing user field, per NWG RFC 3986 (2232
). Thanksddennerline3
for reporting anddeckar01
for the PR.
Other changes:
- Backwards-incompatible:
__version__
,__parsed_version__
, and__version_info__
attributes are deprecated (2227
). Use feature detection orimportlib.metadata.version("marshmallow")
instead.
Bug fixes:
- Fix
Nested
field type hint for lambdaSchema
types (2164
). Thankssomethingnew2-0
for the PR.
Other changes:
- Officially support Python 3.12 (
2188
). Thankshugovk
for the PR.
Bug fixes:
- Fix call to
get_declared_fields
: passdict_cls
again (2152
). ThanksCheaterman
for reporting.
Features:
- Add
absolute
parameter toURL
validator andUrl
field (2123
). Thankssirosen
for the PR. - Use Abstract Base Classes to define
FieldABC
andSchemaABC
(1449
). Thanksaditkumar72
for the PR. - Use OrderedSet as default set_class. Schemas are now ordered by default. (
1744
)
Bug fixes:
- Handle
OSError
andOverflowError
inutils.from_timestamp
(2102
). ThanksTheBigRoomXXL
for the PR. - Fix the default inheritance of nested partial schemas (
2149
). Thanksmatejsp
for reporting.
Other changes:
- Officially support Python 3.11 (
2067
). - Drop support for Python 3.7 (
2135
).
Features:
- Add
timestamp
andtimestamp_ms
formats tofields.DateTime
(612
). Thanksvgavro
for the suggestion and thanksvanHoi
for the PR.
Features:
- Add
Enum
field (2017
) and (2044
).
Bug fixes:
- Fix typing in
Field._serialize
signature (2046
).
Bug fixes:
- Add return type to
fields.Email.__init__
(2018
). Thankskkirsche
for the PR. - Add missing type hint to IPInterface __init__ (
2036
).
Features:
- Support serialization as float in
TimeDelta
field (1998
). Thanksmarcosatti
for the PR. - Add
messages_dict
property toValidationError
to facilitate type checking (1976
). Thankssirosen
for the PR.
Features:
- Raise
ValueError
if an invalid value is passed to theunknown
argument (1721
,1732
). Thankssirosen
for the PR.
Other changes:
- Set lower bound for
packaging
requirement (1957
). ThanksMatthewNicolTR
for reporting and thankssirosen
for the PR. - Improve warning messages by passing
stacklevel
(1986
). Thankstirkarthi
for the PR.
Features:
- Allow passing a
dict
tofields.Nested
(1935
). Thankssirosen
for the PR.
Other changes:
- Address distutils deprecation warning in Python 3.10 (
1903
). Thankskkirsche
for the PR. - Add py310 to black target-version (
1921
). - Drop support for Python 3.6 (
1923
). - Use postponed evaluation of annotations (
1932
). ThanksIsira-Seneviratne
for the PR.
Bug fixes:
- Fix publishing type hints per PEP-561 (
1905
). Thanksbwindsor
for the catch and patch.
Bug fixes:
- Fix
fields.TimeDelta
serialization precision (1865
). Thanksyarsanich
for reporting.
Other changes:
- Fix type-hints for
data
arg inSchema.validate
to accept list of dictionaries (1790
,1868
). Thanksyourun-proger
for PR. - Improve warning when passing metadata as keyword arguments (
1882
). Thankstraherom
for the PR. - Don't build universal wheels. We don't support Python 2 anymore. (
1860
) ThanksYKdvd
for reporting. - Make the build reproducible (
1862
). - Drop support for Python 3.5 (
1863
). - Test against Python 3.10 (
1888
).
Features:
- Replace
missing
/default
field parameters withload_default
/dump_default
(1742
). Thankssirosen
for the PR.
Deprecations:
- The use of
missing
/default
field parameters is deprecated and will be removed in marshmallow 4.load_default
/dump_default
should be used instead.
Bug fixes:
- Don't expose
Field
s asSchema
attributes. This reverts a change introduced in 3.12.0 that causes issues when field names conflict withSchema
attributes or methods.Fields
s are still accessible on aSchema
instance through thefields
attribute. (1843
)
Bug fixes:
- Fix bug that raised an
AttributeError
when instantiating aSchema
with a field namedparent
(1808
). Thanksflying-sheep
for reporting and helping with the fix.
Features:
- Add
validate.And
(1768
). Thanksrugleb
for the suggestion. - Add type annotations to
marshmallow.decorators
(1788
,1789
). Thanksmichaeldimchuk
for the PR. - Let
Field
s be accessed by name asSchema
attributes (1631
).
Other changes:
- Improve types in
marshmallow.validate
(1786
). - Make
marshmallow.validate.Validator
an abstract base class (1786
). - Remove unnecessary list cast (
1785
).
Bug fixes:
- Fix treatment of dotted keys when
unknown=INCLUDE
(1506
). Thanksrbu
for reporting and thankssirosen
for the fix (1745
).
Features:
- Add
fields.IPInterface
,fields.IPv4Interface
, andIPv6Interface
(1733
). Thanksmadeinoz67
for the suggestion and the PR. - Raise
AttributeError
for missing methods when usingfields.Method
(1675
). Thankslassandroan
.
Other changes:
- Remove unnecessary
hasattr
andgetattr
checks inField
(1770
).
Deprecations:
- Passing field metadata via keyword arguments is deprecated and will be removed in marshmallow 4 (
1350
). Use the explicitmetadata=...
argument instead. Thankssirosen
.
Bug fixes:
- Cast to mapping type in
Mapping.serialize
andMapping.deserialize
(1685
). - Fix bug letting
Dict
pass invalid dict on deserialization when no key or valueField
is specified (1685
).
Features:
- Add
format
argument tofields.Time
andtimeformat
class Meta
option (686
). ThanksBennyAlex
for the suggestion and thanksinfinityxxx
for the PR.
Other changes:
- Remove usage of implicit
typing.Optional
(1663
). Thanksnadega
for the PR.
Features:
- Add
fields.IP
,fields.IPv4
andfields.IPv6
(1485
). Thanksmgetka
for the PR.
Bug fixes:
- Fix typing in
AwareDateTime
(1658
). Thanksadithyabsk
for reporting.
Bug fixes:
fields.Boolean
correctly serializes non-hashable types (1633
). Thanksjun0jang
for the PR.
Deprecations:
marshmallow.pprint
is deprecated and will be removed in marshmallow 4 (1588
).
Support:
- Document
default_error_messages
on field classes (1619
). Thanksweeix
.
Bug fixes:
- Fix passing
only
andexclude
toNested
with an orderedSchema
(1627
). Thanksjuannorris
for the PR.
No code changes--only docs and contributor-facing updates in this release.
Support:
- Documentation: improve custom fields example (
1538
). Thankspablospizzamiglio
for reporting the problem with the old example and thanksResinderate
for the PR. - Documentation: Split up API reference into multiple pages and add summary tables (
1587
). ThanksEpicWink
for the PR.
Features:
- Add
validate.ContainsNoneOf
(1528
). ThanksResinderate
for the suggestion and the PR.
Bug fixes:
- Fix typing in
class_registry
(1574
). Thanksmahenzon
.
Bug fixes:
- Includes bug fix from 2.21.0.
Bug fixes:
- Fix list of nullable nested fields
List(Nested(Field, allow_none=True)
(1497
). Because this fix reverts an optimization introduced to speed-up serialization and deserialization of lists of nested fields, a negative impact on performance in this specific case is expected.
Features:
- Improve type coverage (
1479
). ThanksReskov
.
Bug fixes:
- Fix typing for
data
param ofSchema.load
andValidationError
(1492
). Thanksmehdigmira
for reporting and thanksdfirst
for the PR.
Other changes:
- Remove unnecessary typecasts (
1500
). Thankshukkinj1
. - Remove useless
_serialize
override inUUID
field (1489
).
Features:
fields.Nested
may take a callable that returns a schema instance. Use this to resolve order-of-declaration issues when schemas nest each other (1146
).
# <3.3
class AlbumSchema(Schema):
title = fields.Str()
artist = fields.Nested("ArtistSchema", only=("name",))
class ArtistSchema(Schema):
name = fields.Str()
albums = fields.List(fields.Nested(AlbumSchema))
# >=3.3
class AlbumSchema(Schema):
title = fields.Str()
artist = fields.Nested(lambda: ArtistSchema(only=("name",)))
class ArtistSchema(Schema):
name = fields.Str()
albums = fields.List(fields.Nested(AlbumSchema))
Deprecations:
- Passing the string
"self"
tofields.Nested
is deprecated. Use a callable instead.
from marshmallow import Schema, fields
# <3.3
class PersonSchema(Schema):
partner = fields.Nested("self", exclude=("partner",))
friends = fields.List(fields.Nested("self"))
# >=3.3
class PersonSchema(Schema):
partner = fields.Nested(lambda: PersonSchema(exclude=("partner")))
friends = fields.List(fields.Nested(lambda: PersonSchema()))
Other changes:
- Fix typing for
Number._format_num
(1466
). Thankshukkinj1
. - Make mypy stricter and remove dead code (
1467
). Thanks again,hukkinj1
.
Bug fixes:
- Don't load fields for which
load_only
anddump_only
are bothTrue
(1448
). - Fix types in
marshmallow.validate
(1446
).
Support:
- Test against Python 3.8 (
1431
).
Bug fixes:
- Fix typing for
Schema.dump[s]
(1416
).
Features:
- Add type annotations to
marshmallow.schema
andmarshmallow.validate
(1407
,663
).
Bug fixes:
- Fix compatibility with Python < 3.5.3 (
1409
). Thankslukaszdudek-silvair
for reporting.
Refactoring:
- Remove unnecessary
BaseSchema
superclass (1406
).
Bug fixes:
- Restore inheritance hierarchy of
Number
fields (1403
).fields.Integer
andfields.Decimal
inherit fromfields.Number
. - Fix bug that raised an uncaught error when a nested schema instance had an unpickleable object in its context (
1404
). Thanksmetheoryt
for reporting.
Features:
- Add more type annotations (
663
). Type information is distributed per PEP 561 . Thanksfuhrysteve
for helping with this.
Bug fixes:
- Includes bug fix from 2.20.5.
Bug fixes:
- Fix bug that raised an uncaught error when passing both a schema instance and
only
toNested
(1395
). This bug also affected passing a schema instance tofields.Pluck
.
Bug fixes:
- Fix propagating dot-delimited
only
andexclude
parameters to nested schema instances (1384
). - Includes bug fix from 2.20.4 (
1160
).
Bug fixes:
- Handle when
data_key
is an empty string (1378
). Thanksjtrakk
for reporting.
Bug fixes:
- Includes bug fix from 2.20.3 (
1376
). - Fix incorrect
super()
call inSchemaMeta.__init__
(1362
).
Bug fixes:
- Fix bug when nesting
fields.DateTime
withinfields.List
orfields.Tuple
(1357
). This bug was introduced in 3.0.0rc9. Thankszblz
for reporting.
Features:
- Optimize
List(Nested(...))
(779
). - Minor performance improvements and cleanup (
1328
). - Add
Schema.from_dict
(1312
).
Deprecations/Removals:
Field.fail
is deprecated. UseField.make_error
instead.- Remove UUID validation from
fields.UUID
, for consistency with other fields (1132
).
Support:
- Various docs improvements (
1329
).
Features:
- Backwards-incompatible: Validation does not occur on serialization (
1132
). This significantly improves serialization performance. - Backwards-incompatible:
DateTime
does not affect timezone information on serialization and deserialization (1234
,1278
). - Add
NaiveDateTime
andAwareDateTime
to enforce timezone awareness (1234
,1287
). - Backwards-incompatible:
List
does not wrap single values in a list on serialization (1307
). - Backwards-incompatible:
Schema.handle_error
receivesmany
andpartial
as keyword arguments (1321
). - Use
raise from
more uniformly to improve stack traces (1313
). - Rename
Nested.__schema
toNested._schema
to prevent name mangling (1289
). - Performance improvements (
1309
).
Deprecations/Removals:
LocalDateTime
is removed (1234
).marshmallow.utils.utc
is removed. Usedatetime.timezone.utc
instead.
Bug fixes:
- Fix behavior of
List(Nested("self"))
(#779 (comment)).
Support:
- Document usage of
validate.Regexp
's usagere.search
(1285
). Thanksmacdonaldezra
.
Features:
- Propagate
only
andexclude
parameters toNested
fields withinList
andDict
(779
,946
). - Use
email.utils.parsedate_to_datetime
instead of conditionally using dateutil for parsing RFC dates (1246
). - Use internal util functions instead of conditionally using dateutil for parsing ISO 8601 datetimes, dates and times. Timezone info is now correctly deserialized whether or not dateutil is installed. (
1265
) - Improve error messages for
validate.Range
. - Use
raise from error
for better stack traces (1254
). Thanksfuhrysteve
. - python-dateutil is no longer used. This resolves the inconsistent behavior based on the presence of python-dateutil (
497
,1234
).
Bug fixes:
- Fix method resolution for
__init__
method offields.Email
andfields.URL
(1268
). Thanksdursk
for the catch and patch. - Includes bug fixes from 2.19.4 and 2.19.5.
Other changes:
- Backwards-incompatible: Rename
fields.List.container
tofields.List.inner
,fields.Dict.key_container
tofields.Dict.key_field
, andfields.Dict.value_container
tofields.Dict.value_field
. - Switch to Azure Pipelines for CI (
1261
).
Features:
- Backwards-incompatible:
many
is passed as a keyword argument to methods decorated withpre_load
,post_load
,pre_dump
,post_dump
, andvalidates_schema
.partial
is passed as a keyword argument to methods decorated withpre_load
,post_load
andvalidates_schema
.**kwargs
should be added to all decorated methods. - Add
min_inclusive
andmax_exclusive
parameters tovalidate.Range
(1221
). Thankskdop
for the PR.
Bug fixes:
- Fix propagation of
partial
toNested
containers (part of779
). - Includes bug fix from 2.19.3.
Other changes:
- Backwards-incompatible: Use keyword-only arguments (
1216
).
Support:
- Backwards-incompatible: Remove support for Python 2 (
1120
). Only Python>=3.5 is supported. Thank yourooterkyberian
for the suggestion and the PR. - Backwards-incompatible: Remove special-casing in
fields.List
andfields.Tuple
for accessing nested attributes (1188
). Usefields.List(fields.Pluck(...))
instead. - Add
python_requires
tosetup.py
(1194
). Thankshugovk
. - Upgrade syntax with
pyupgrade
in pre-commit (1195
). Thanks againhugovk
.
Features:
- Allow input value to be included in error messages for a number of fields (
1129
). Thankshdoupe
for the PR. - Improve default error messages for
OneOf
andContainsOnly
(885
). Thanksmcgfeller
for the suggestion andmaxalbert
for the PR.
Deprecations/Removals:
- Remove
fields.FormattedString
(1141
). Usefields.Function
orfields.Method
instead.
Bug fixes:
- Includes bug fix from 2.19.2.
Features:
- Add
fields.Tuple
(1103
) Thankszblz
for the PR. - Add
fields.Mapping
, which makes it easier to support other mapping types (e.g.OrderedDict
) (1092
). Thanksayanarijit
for the suggestion and the PR.
Features:
- Make the error messages for "unknown fields" and "invalid data type" configurable (
852
). ThanksDunstrom
for the PR. fields.Boolean
parses"yes"
/"no"
values (1081
). Thanksr1b
.
Other changes:
- Backwards-incompatible with previous 3.x versions: Change ordering of
keys
andvalues
arguments tofields.Dict
. - Remove unused code in
marshmallow.utils
:is_indexable_but_not_string
,float_to_decimal
,decimal_to_fixed
,from_iso
(1088
). - Remove unused
marshmallow.compat.string_types
.
Bug fixes:
- Includes bug fix from 2.18.0.
Features:
- Add
register
class Meta option to allow bypassing marshmallow's internal class registry when memory usage is critical (660
).
Bug fixes:
- Fix serializing dict-like objects with properties (
1060
). Thankstaion
for the fix. - Fix populating
ValidationError.valid_data
forList
andDict
fields (766
).
Other changes:
- Add
marshmallow.__version_info__
(1074
). - Remove the
marshmallow.marshalling
internal module (1070
). - A
ValueError
is raised when themissing
parameter is passed for required fields (1040
). - Extra keyword arguments passed to
ValidationError
in validators are no longer passed to the finalValidationError
raised upon validation completion (996
).
Features:
- Backwards-incompatible: Rework
ValidationError
API. It now expects a single field name, and error structures are merged in the finalValidationError
raised when validation completes. This allows schema-level validators to raise errors for individual fields (441
). Thanksmaximkulkin
for writing the originalmerge_errors
implementation in442
and thankslafrech
for completing the implementation in1026
.
Bug fixes:
- Fix
TypeError
when serializingNone
withPluck
(1049
). Thankstoffan
for the catch and patch.
Bug fixes:
- Includes bug fixes from 2.16.2 and 2.16.3.
Features:
- Support partial loading of nested fields (
438
). Thanksarbor-dwatson
for the PR. Note: Subclasses offields.Nested
now take an additionalpartial
parameter in the_deserialize
method.
Bug fixes:
- Restore
Schema.TYPE_MAPPING
, which was removed in 3.0.0b17 (1012
).
Other changes:
- Backwards-incompatible: _serialize
and _deserialize
methods of all fields.Field
subclasses must accept **kwargs
(1007
).
Bug fixes:
- Fix
Date
deserialization when using custom format (1001
). ThanksOndkloss
for reporting.
Deprecations/Removals:
prefix
parameter orSchema
class is removed (991
). The same can be achieved using a@post_dump
method.
Features:
- Add
format
option toDate
field (869
). - Backwards-incompatible: Rename
DateTime
'sdateformat
Meta option todatetimeformat
.dateformat
now applies toDate
(869
). Thanksknagra
for implementing these changes. - Enforce ISO 8601 when deserializing date and time (
899
). Thanksdushr
for the report and the work on the PR. - Backwards-incompatible: Raise
ValueError
onSchema
instantiation in case ofattribute
ordata_key
collision (992
).
Bug fixes:
- Fix inconsistencies in field inference by refactoring the inference feature into a dedicated field (
809
). Thankstaion
for the PR. - When
unknown
is not passed toNested
, default to nestedSchema
unknown
meta option rather thanRAISE
(963
). Thanksvgavro
for the PR. - Fix loading behavior of
fields.Pluck
(990
). - Includes bug fix from 2.16.0.
Bug fixes:
- Fix
root
attribute for nested container fields on inheriting schemas (956
). Thanksbmcbu
for reporting.
Bug fixes:
- Raise
ValidationError
instead ofTypeError
when non-iterable types are validated withmany=True
(851
). many=True
no longer iterates overstr
andcollections.abc.Mapping
objects and instead raises aValidationError
with{'_schema': ['Invalid input type.']}
(930
).- Return
[]
asValidationError.valid_data
instead of{}
whenmany=True
(907
).
Thanks tuukkamustonen
for implementing these changes.
Features:
- Add
fields.Pluck
for serializing a single field from a nested object (800
). Thankstimc13
for the feedback anddeckar01
for the implementation. - Backwards-incompatible: Passing a string argument as
only
tofields.Nested
is no longer supported. Usefields.Pluck
instead (800
). - Raise a
StringNotCollectionError
ifonly
orexclude
is passed as a string tofields.Nested
(931
). - Backwards-incompatible:
Float
takes anallow_nan
parameter to explicitly allow serializing and deserializing special values (nan
,inf
and-inf
).allow_nan
defaults toFalse
.
Other changes:
- Backwards-incompatible:
Nested
field now defaults tounknown=RAISE
instead ofEXCLUDE
. This harmonizes behavior withSchema
that already defaults toRAISE
(908
). Thankstuukkamustonen
. - Tested against Python 3.7.
Bug fixes:
- Errors reported by a schema-level validator for a field in a
Nested
field are stored under corresponding field name, not_schema
key (862
). - Includes bug fix from 2.15.4.
Other changes:
- Backwards-incompatible: The
unknown
option now defaults toRAISE
(#524 (comment),851
). - Backwards-incompatible: When a schema error is raised with a
dict
as payload, thedict
overwrites any existing error list. Before this change, it would be appended to the list. - Raise a StringNotCollectionError if
only
orexclude
is passed as a string (316
). Thankspaulocheque
for reporting.
Features:
- The behavior to apply when encountering unknown fields while deserializing can be controlled with the
unknown
option (524
,747
,127
). It makes it possible to either "include", "exclude", or "raise". Thankstuukkamustonen
for the suggestion and thanksramnes
for the PR.
Warning
The default for unknown
will be changed to RAISE
in the next release.
Other changes:
- Backwards-incompatible: Pre/Post-processors MUST return modified data. Returning
None
does not imply data were mutated (347
). Thankstdevelioglu
for reporting. - Backwards-incompatible:
only
andexclude
are bound by declared and additional fields. AValueError
is raised if invalid fields are passed (636
). Thanksjan-23
for reporting. Thanksikilledthecat
anddeckar01
for the PRs. - Format code using pre-commit (
855
).
Deprecations/Removals:
ValidationError.fields
is removed (840
). Access field instances fromSchema.fields
.
Features:
- Clean up code for schema hooks (
814
). Thankstaion
. - Minor performance improvement from simplifying
utils.get_value
(811
). Thanks againtaion
. - Add
require_tld
argument tofields.URL
(749
). ThanksDenerKup
for reporting and thankssurik00
for the PR. fields.UUID
deserializesbytes
strings usingUUID(bytes=b'...')
(625
). ThanksJeffBerger
for the suggestion and the PR.
Bug fixes:
- Fields nested within
Dict
correctly inherit context from their parent schema (820
). ThanksRosanneZe
for reporting anddeckar01
for the PR. - Includes bug fix from 2.15.3.
Bug fixes:
- Includes bugfixes from 2.15.2.
Features:
- Backwards-incompatible:
missing
anddefault
values are passed in deserialized form (378
). Thankschadrik
for the suggestion and thankslafrech
for the PR.
Bug fixes:
- Includes the bugfix from 2.15.1.
Features:
- Backwards-incompatible: Add
data_key
parameter to fields for specifying the key in the input and output data dict. This parameter replaces bothload_from
anddump_to
(717
). Thankslafrech
. - Backwards-incompatible: When
pass_original=True
is passed to one of the decorators and a collection is being (de)serialized, theoriginal_data
argument will be a single object unlesspass_many=True
is also passed to the decorator (315
,743
). Thanksstj
for the PR. - Backwards-incompatible: Don't recursively check nested required fields when the
Nested
field's key is missing (319
). This reverts235
. Thankschekunkov
reporting and thankslafrech
for the PR. - Backwards-incompatible: Change error message collection for
Dict
field (730
). Note: this is backwards-incompatible with previous 3.0.0bX versions. Thanksshabble
for the report and thankslafrech
for the PR.
Features:
- Backwards-incompatible: Schemas are always strict (
377
). Thestrict
parameter is removed. - Backwards-incompatible:
Schema().load
andSchema().dump
returndata
instead of a(data, errors)
tuple (598
). - Backwards-incomaptible:
Schema().load(None)
raises aValidationError
(511
).
See upgrading_3_0
for a guide on updating your code.
Thanks lafrech
for implementing these changes. Special thanks to MichalKononenko
, douglas-treadwell
, and maximkulkin
for the discussions on these changes.
Other changes:
- Backwards-incompatible: Field name is not checked when
load_from
is specified (714
). Thankslafrech
.
Support:
- Add Code of Conduct.
Bug fixes:
- Fixes
ValidationError.valid_data
when a nested field contains errors (710
). This bug was introduced in 3.0.0b3. Thankslafrech
.
Other changes:
- Backwards-incompatible:
Email
andURL
fields don't validate on serialization (608
). This makes them more consistent with the other fields and improves serialization performance. Thanks againlafrech
. validate.URL
requires square brackets around IPv6 URLs (707
). Thanksharlov
.
Features:
- Add support for structured dictionaries by providing values and keys arguments to the
Dict
field's constructor. This mirrors theList
field's ability to validate its items (483
). Thanksdeckar01
.
Other changes:
- Backwards-incompatible:
utils.from_iso
is deprecated in favor ofutils.from_iso_datetime
(694
). Thankssklarsa
.
Features:
- Add support for millisecond, minute, hour, and week precisions to
fields.TimeDelta
(537
). ThanksFedalto
for the suggestion and the PR. - Includes features from release 2.14.0.
Support:
- Copyright year in docs uses
CHANGELOG.rst
's modified date for reproducible builds (679
). Thanksbmwiedemann
. - Test against Python 3.6 in tox. Thanks
Fedalto
. - Fix typo in exception message (
659
). Thankswonderbeyond
for reporting and thanksyoichi
for the PR.
Features:
- Add
valid_data
attribute toValidationError
. - Add
strict
parameter toInteger
(667
). Thanksyoichi
.
Deprecations/Removals:
- Deprecate
json_module
option in favor ofrender_module
(364
,130
). Thanksjustanr
for the suggestion.
Bug fixes:
- Includes bug fixes from releases 2.13.5 and 2.13.6.
- Backwards-incompatible:
Number
fields don't accept booleans as valid input (623
). Thankstuukkamustonen
for the suggestion and thanksrowillia
for the PR.
Support:
- Add benchmark script. Thanks
rowillia
.
Features:
- Add
truthy
andfalsy
params tofields.Boolean
(580
). Thankszwack
for the PR. Note: This is potentially a breaking change if your code passes the default parameter positionally. Pass default as a keyword argument instead, e.g.fields.Boolean(default=True)
.
Other changes:
- Backwards-incompatible:
validate.ContainsOnly
allows empty and duplicate values (516
,603
). Thanksmaximkulkin
for the suggestion and thankslafrech
for the PR.
Bug fixes:
- Includes bug fixes from release 2.13.4.
Features:
fields.Nested
respectsonly='field'
when deserializing (307
). Thankserlingbo
for the suggestion and the PR.fields.Boolean
parses"on"
/"off"
(580
). Thanksmarcellarius
for the suggestion.
Other changes:
- Includes changes from release 2.13.2.
- Backwards-incompatible:
skip_on_field_errors
defaults toTrue
forvalidates_schema
(352
).
Features:
dump_only
andload_only
forFunction
andMethod
are set based onserialize
anddeserialize
arguments (328
).
Other changes:
- Backwards-incompatible:
fields.Method
andfields.Function
no longer swallowAttributeErrors
(395
). Thanksbereal
for the suggestion. - Backwards-incompatible:
validators.Length
is no longer a subclass ofvalidators.Range
(458
). Thanksdeckar01
for the catch and patch. - Backwards-incompatible:
utils.get_func_args
no longer returns bound arguments. This is consistent with the behavior ofinspect.signature
. This change prevents a DeprecationWarning on Python 3.5 (415
,479
). Thanksdeckar01
for the PR. - Backwards-incompatible: Change the signature of
utils.get_value
andSchema.get_attribute
for consistency with Python builtins (e.g.getattr
) (341
). Thanksstas
for reporting and thanksdeckar01
for the PR. - Backwards-incompatible: Don't unconditionally call callable attributes (
430
, reverts242
). Thanksmirko
for the suggestion. - Drop support for Python 2.6 and 3.3.
Deprecation/Removals:
- Remove
__error_handler__
,__accessor__
,@Schema.error_handler
, and@Schema.accessor
. OverrideSchema.handle_error
andSchema.get_attribute
instead. - Remove
func
parameter offields.Function
. Removemethod_name
parameter offields.Method
(issue:325). Use theserialize
parameter instead. - Remove
extra
parameter fromSchema
. Use a@post_dump
method to add additional data.
Bug fixes:
- Don't match string-ending newlines in
URL
andEmail
fields (1522
). Thanksnbanmp
for the PR.
Other changes:
- Drop support for Python 3.4 (
1525
).
Bug fixes:
- Fix behavior when a non-list collection is passed to the
validate
argument offields.Email
andfields.URL
(1400
).
Bug fixes:
- Respect the
many
value onSchema
instances passed toNested
(1160
). ThanksKamforka
for reporting.
Bug fixes:
- Don't swallow
TypeError
exceptions raised byField._bind_to_schema
orSchema.on_bind_field
(1376
).
Bug fixes:
- Prevent warning about importing from
collections
on Python 3.7 (1354
). Thanksnicktimko
for the PR.
Bug fixes:
- Fix bug that raised
TypeError
when invalid data type is passed to a nested schema with@validates
(1342
).
Bug fixes:
- Fix deprecated functions' compatibility with Python 2 (
1337
). Thanksairstandley
for the catch and patch. - Fix error message consistency for invalid input types on nested fields (
1303
). This is a backport of the fix in857
. Thankscristi23
for the thorough bug report and the PR.
Deprecation/Removal:
- Python 2.6 is no longer officially supported (
1274
).
Bug fixes:
- Fix deserializing ISO8601-formatted datetimes with less than 6-digit miroseconds (
1251
). Thanksdiego-plan9
for reporting.
Bug fixes:
- Microseconds no longer gets lost when deserializing datetimes without dateutil installed (
1147
).
Bug fixes:
- Fix bug where nested fields in
Meta.exclude
would not work on multiple instantiations (1212
). ThanksMHannila
for reporting.
Bug fixes:
- Handle
OverflowError
when (de)serializing large integers withfields.Float
(1177
). Thanksbrycedrennan
for the PR.
Bug fixes:
- Fix bug where
Nested(many=True)
would skip first element when serializing a generator (1163
). Thankskhvn26
for the catch and patch.
Deprecation/Removal:
- A
RemovedInMarshmallow3
warning is raised when usingfields.FormattedString
. Usefields.Method
orfields.Function
instead (1141
).
Bug fixes:
- A
ChangedInMarshmallow3Warning
is no longer raised whenstrict=False
(1108
). ThanksAegdesil
for reporting.
Features:
- Add warnings for functions in
marshmallow.utils
that are removed in marshmallow 3.
Bug fixes:
- Copying
missing
withcopy.copy
orcopy.deepcopy
will not duplicate it (1099
).
Features:
- Add
marshmallow.__version_info__
(1074
). - Add warnings for API that is deprecated or changed to help users prepare for marshmallow 3 (
1075
).
Bug fixes:
- Prevent memory leak when dynamically creating classes with
type()
(732
). Thanksasmodehn
for writing the tests to reproduce this issue.
Bug fixes:
- Prevent warning about importing from
collections
on Python 3.7 (1027
). Thanksnkonin
for reporting andjmargeta
for the PR.
Bug fixes:
- Remove spurious warning about implicit collection handling (
998
). Thankslalvarezguillen
for reporting.
Bug fixes:
- Allow username without password in basic auth part of the url in
fields.Url
(982
). Thanks user:alefnula for the PR.
Other changes:
- Drop support for Python 3.3 (
987
).
Bug fixes:
- Prevent
TypeError
when a non-collection is passed to aSchema
withmany=True
. Instead, raiseValidationError
with{'_schema': ['Invalid input type.']}
(906
). - Fix
root
attribute for nested container fields on list on inheriting schemas (956
). Thanksbmcbu
for reporting.
These fixes were backported from 3.0.0b15 and 3.0.0b16.
Bug fixes:
- Handle empty SQLAlchemy lazy lists gracefully when dumping (
948
). Thanksvke-code
for the catch andYuriHeupa
for the patch.
Bug fixes:
- Respect
load_from
when reporting errors for@validates('field_name')
(748
). Thanksm-novikov
for the catch and patch.
Bug fixes:
- Fix passing
only
as a string tonested
when the passed field definesdump_to
(800
,822
). Thanksdeckar01
for the catch and patch.
Bug fixes:
- Fix a race condition in validation when concurrent threads use the same
Schema
instance (783
). Thanksyupeng0921
andlafrech
for the fix. - Fix serialization behavior of
fields.List(fields.Integer(as_string=True))
(788
). Thankscactus
for reporting andlafrech
for the fix. - Fix behavior of
exclude
parameter when passed from parent to nested schemas (728
). Thankstimc13
for reporting anddeckar01
for the fix.
Bug fixes:
CVE-2018-17175
: Fix behavior when an empty list is passed as theonly
argument (772
). Thanksdeckar01
for reporting and thankslafrech
for the fix.
Bug fixes:
- Handle
UnicodeDecodeError
when deserializingbytes
with aString
field (650
). Thanksdan-blanchard
for the suggestion and thanks4lissonsilveira
for the PR.
Features:
- Add
require_tld
parameter tovalidate.URL
(664
). Thankssduthil
for the suggestion and the PR.
Bug fixes:
- Fix serialization of types that implement __getitem__ (
669
). ThanksMichalKononenko
.
Bug fixes:
- Fix validation of iso8601-formatted dates (
556
). Thankslafrech
for reporting.
Bug fixes:
- Fix symmetry of serialization and deserialization behavior when passing a dot-delimited path to the
attribute
parameter of fields (450
). Thanksitajaja
for reporting.
Bug fixes:
- Restore backwards-compatibility of
SchemaOpts
constructor (597
). ThanksWesmania
for reporting and thanksfrol
for the fix.
Bug fixes:
- Fix inheritance of
ordered
option whenSchema
subclasses defineclass Meta
(593
). Thanksfrol
.
Support:
- Update contributing docs.
Bug fixes:
- Fix sorting on Schema subclasses when
ordered=True
(592
). Thanksfrol
.
Features:
- Minor optimizations (
577
). Thanksrowillia
for the PR.
Bug fixes:
- Unbound fields return None rather returning the field itself. This fixes a corner case introduced in
572
. ThankstouilleMan
for reporting andYuriHeupa
for the fix.
Bug fixes:
- Fix behavior when a
Nested
field is composed within aList
field (572
). Thanksavish
for reporting andYuriHeupa
for the PR.
Features:
- Allow passing nested attributes (e.g.
'child.field'
) to thedump_only
andload_only
parameters ofSchema
(572
). ThanksYuriHeupa
for the PR. - Add
schemes
parameter tofields.URL
(574
). Thanksmosquito
for the PR.
Bug fixes:
- Allow
strict
class Meta option to be overridden by constructor (550
). Thanksdouglas-treadwell
for reporting and thankspodhmo
for the PR.
Features:
- Import
marshmallow.fields
inmarshmallow/__init__.py
to save an import when importing themarshmallow
module (557
). Thanksmindojo-victor
.
Support:
- Documentation: Improve example in "Validating Original Input Data" (
558
). Thanksaltaurog
. - Test against Python 3.6.
Bug fixes:
- Reset user-defined kwargs passed to
ValidationError
on eachSchema.load
call (565
). Thanksjbasko
for the catch and patch.
Support:
- Tests: Fix redefinition of
test_utils.test_get_value()
(562
). Thanksnelfin
.
Bug fixes:
- Function field works with callables that use Python 3 type annotations (
540
). Thanksmartinstein
for reporting and thankssabinem
,lafrech
, andmaximkulkin
for the work on the PR.
Bug fixes:
- Fix behavior for serializing missing data with
Number
fields whenas_string=True
is passed (538
). Thanksjessemyers
for reporting.
Bug fixes:
- Use fixed-point notation rather than engineering notation when serializing with
Decimal
(534
). Thanksgdub
. - Fix UUID validation on serialization and deserialization of
uuid.UUID
objects (532
). Thankspauljz
.
Bug fixes:
- Fix behavior when using
validate.Equal(False)
(484
). Thankspktangyue
for reporting and thankstuukkamustonen
for the fix. - Fix
strict
behavior when errors are raised inpre_dump
/post_dump
processors (521
). Thankstvuotila
for the catch and patch. - Fix validation of nested fields on dumping (
528
). Thanks againtvuotila
.
Features:
- Errors raised by pre/post-load/dump methods will be added to a schema's errors dictionary (
472
). Thanksdbertouille
for the suggestion and for the PR.
Bug fixes:
- Fix serialization of
datetime.time
objects with microseconds (464
). ThanksTim-Erwin
for reporting and thanksvuonghv
for the fix. - Make
@validates
consistent with field validator behavior: if validation fails, the field will not be included in the deserialized output (391
). Thanksmartinstein
for reporting and thanksvuonghv
for the fix.
Decimal
field coerces input values to a string before deserializing to a decimal.Decimal object in order to avoid transformation of float values under 12 significant digits (434
,435
). Thanksdavidthornton
for the PR.
Features:
- Allow
only
andexclude
parameters to take nested fields, using dot-delimited syntax (e.g.only=['blog.author.email']
) (402
). ThanksTim-Erwin
anddeckar01
for the discussion and implementation.
Support:
- Update tasks.py for compatibility with invoke>=0.13.0. Thanks
deckar01
.
- Make
field.parent
andfield.name
accessible toon_bind_field
(449
). Thanksimmerrr
.
No code changes in this release. This is a reupload in order to distribute an sdist for the last hotfix release. See 443
.
Support:
- Update license entry in setup.py to fix RPM distributions (
433
). Thanksrrajaravi
for reporting.
Bug fixes:
- Only add Schemas to class registry if a class name is provided. This allows Schemas to be constructed dynamically using the
type
constructor without getting added to the class registry (which is useful for saving memory).
Features:
- Make context available to
Nested
field'son_bind_field
method (408
). Thanksimmerrr
for the PR. - Pass through user
ValidationError
kwargs (418
). Thanksrusselldavies
for helping implement this.
Other changes:
- Remove unused attributes
root
,parent
, andname
fromSchemaABC
(410
). ThanksTim-Erwin
for the PR.
Bug fixes:
- Respect
load_from
when reporting errors for nested required fields (414
). Thanksyumike
.
Features:
- Add
partial
argument toSchema.validate
(379
). Thankstdevelioglu
for the PR. - Add
equal
argument tovalidate.Length
. Thanksdaniloakamine
. - Collect all validation errors for each item deserialized by a
List
field (345
). Thanksmaximkulkin
for the report and the PR.
Features:
- Allow a tuple of field names to be passed as the
partial
argument toSchema.load
(369
). Thankstdevelioglu
for the PR. - Add
schemes
argument tovalidate.URL
(356
).
Bug fixes:
- Prevent duplicate error messages when validating nested collections (
360
). Thanksalexmorken
for the catch and patch.
Bug fixes:
- Serializing an iterator will not drop the first item (
343
,353
). Thanksjmcarp
for the patch. Thanksedgarallang
andjmcarp
for reporting.
Features:
- Add
skip_on_field_errors
parameter tovalidates_schema
(323
). Thanksjjvattamattom
for the suggestion andd-sutherland
for the PR.
Bug fixes:
- Fix
FormattedString
serialization (348
). Thanksacaird
for reporting. - Fix
@validates
behavior when used whenattribute
is specified andstrict=True
(350
). Thanksdensity
for reporting.
Features:
- Add
dump_to
parameter to fields (310
). ThanksShayanArmanPercolate
for the suggestion. Thanksfranciscod
andewang
for the PRs. - The
deserialize
function passed tofields.Function
can optionally receive acontext
argument (324
). ThanksDamianHeard
. - The
serialize
function passed tofields.Function
is optional (325
). Thanks againDamianHeard
. - The
serialize
function passed tofields.Method
is optional (329
). Thanksjustanr
.
Deprecation/Removal:
- The
func
argument offields.Function
has been renamed toserialize
. - The
method_name
argument offields.Method
has been renamed toserialize
.
func
and method_name
are still present for backwards-compatibility, but they will both be removed in marshmallow 3.0.
Bug fixes:
- Skip field validators for fields that aren't included in
only
(320
). Thankscarlos-alberto
for reporting andeprikazc
for the PR.
Features:
- Add support for partial deserialization with the
partial
argument toSchema
andSchema.load
(290
). Thankstaion
.
Deprecation/Removals:
Query
andQuerySelect
fields are removed.- Passing of strings to
required
andallow_none
is removed. Pass theerror_messages
argument instead.
Support:
- Add example of Schema inheritance in docs (
225
). Thanksmartinstein
for the suggestion andjuanrossi
for the PR. - Add "Customizing Error Messages" section to custom fields docs.
Bug fixes:
- Fix serialization of collections for which
iter
will modify position, e.g. Pymongo cursors (303
). ThanksMise
for the catch and patch.
Bug fixes:
- Fix passing data to schema validator when using
@validates_schema(many=True)
(297
). Thanksd-sutherland
for reporting. - Fix usage of
@validates
with a nested field whenmany=True
(298
). Thanksnelfin
for the catch and patch.
Bug fixes:
Constant
field deserializes to its value regardless of whether its field name is present in input data (291
). Thanksfayazkhan
for reporting.
Features:
- Add
Dict
field for arbitrary mapping data (251
). Thanksdwieeb
for adding this andDowwie
for the suggestion. - Add
Field.root
property, which references the field's Schema.
Deprecation/Removals:
- The
extra
param ofSchema
is deprecated. Add extra data in apost_load
method instead. UnmarshallingError
andMarshallingError
are removed.
Bug fixes:
- Fix storing multiple schema-level validation errors (
287
). Thanksevgeny-sureev
for the patch. - If
missing=None
on a field,allow_none
will be set toTrue
.
Other changes:
- A
List's
inner field will have the list field set as its parent. Useroot
to access theSchema
.
Features:
- Make error messages configurable at the class level and instance level (
Field.default_error_messages
attribute anderror_messages
parameter, respectively).
Deprecation/Removals:
- Remove
make_object
. Use apost_load
method instead (277
). - Remove the
error
parameter and attribute ofField
. - Passing string arguments to
required
andallow_none
is deprecated. Pass theerror_messages
argument instead. This API will be removed in version 2.2. - Remove
Arbitrary
,Fixed
, andPrice
fields (86
). UseDecimal
instead. - Remove
Select
/Enum
fields (135
). Use theOneOf
validator instead.
Bug fixes:
- Fix error format for
Nested
fields whenmany=True
. Thanksalexmorken
. pre_dump
methods are invoked before implicit field creation. Thanksmakmanalp
for reporting.- Return correct "required" error message for
Nested
field. - The
only
argument passed to aSchema
is bounded by thefields
option (183
). Thankslustdante
for the suggestion.
Changes from 2.0.0rc2:
error_handler
andaccessor
options are replaced with thehandle_error
andget_attribute
methods284
.- Remove
marshmallow.compat.plain_function
since it is no longer used. - Non-collection values are invalid input for
List
field (231
). Thanksdensity
for reporting. - Bug fix: Prevent infinite loop when validating a required, self-nested field. Thanks
Bachmann1234
for the fix.
Deprecation/Removals:
make_object
is deprecated. Use apost_load
method instead (277
). This method will be removed in the final 2.0 release.Schema.accessor
andSchema.error_handler
decorators are deprecated. Define theaccessor
anderror_handler
class Meta options instead.
Bug fixes:
- Allow non-field names to be passed to
ValidationError
(273
). Thanksevgeny-sureev
for the catch and patch.
Changes from 2.0.0rc1:
- The
raw
parameter of thepre_*
,post_*
,validates_schema
decorators was renamed topass_many
(276
). - Add
pass_original
parameter topost_load
andpost_dump
(216
). - Methods decorated with the
pre_*
,post_*
, andvalidates_*
decorators must be instance methods. Class methods and instance methods are not supported at this time.
Features:
- Backwards-incompatible:
fields.Field._deserialize
now takesattr
anddata
as arguments (172
). Thanksalexmic
andkevinastone
for the suggestion. - Allow a
Field's
attribute
to be modified during deserialization (266
). Thanksfloqqi
. - Allow partially-valid data to be returned for
Nested
fields (269
). Thanksjomag
for the suggestion. - Add
Schema.on_bind_field
hook which allows aSchema
to modify its fields when they are bound. - Stricter validation of string, boolean, and number fields (
231
). ThankstouilleMan
for the suggestion. - Improve consistency of error messages.
Deprecation/Removals:
Schema.validator
,Schema.preprocessor
, andSchema.data_handler
are removed. Usevalidates_schema
,pre_load
, andpost_dump
instead.QuerySelect
andQuerySelectList
are deprecated (227
). These fields will be removed in version 2.1.utils.get_callable_name
is removed.
Bug fixes:
- If a date format string is passed to a
DateTime
field, it is always used for deserialization (248
). Thanksbartaelterman
andpraveen-p
.
Support:
- Documentation: Add "Using Context" section to "Extending Schemas" page (
224
). - Include tests and docs in release tarballs (
201
). - Test against Python 3.5.
Features:
- If a field corresponds to a callable attribute, it will be called upon serialization. Thanks
alexmorken
. - Add
load_only
anddump_only
class Meta
options. Thankskelvinhammond
. - If a
Nested
field is required, recursively validate any required fields in the nested schema (235
). Thanksmax-orhai
. - Improve error message if a list of dicts is not passed to a
Nested
field for whichmany=True
. Thanks againmax-orhai
.
Bug fixes:
make_object
is only called after all validators and postprocessors have finished (253
). Thankssunsongxp
for reporting.- If an invalid type is passed to
Schema
andstrict=False
, store a_schema
error in the errors dict rather than raise an exception (261
). Thanksdensity
for reporting.
Other changes:
make_object
is only called when input data are completely valid (243
). Thankskissgyorgy
for reporting.- Change default error messages for
URL
andEmail
validators so that they don't include user input (255
). Email
validator permits email addresses with non-ASCII characters, as per RFC 6530 (221
). Thankslextoumbourou
for reporting andmwstobo
for sending the patch.
Features:
List
field respects theattribute
argument of the inner field. Thanksjmcarp
.- The
container
fieldList
field has access to its parentSchema
via itsparent
attribute. Thanks againjmcarp
.
Deprecation/Removals:
- Legacy validator functions have been removed (
73
). Use the class-based validators inmarshmallow.validate
instead.
Bug fixes:
fields.Nested
correctly serializes nestedsets
(233
). Thankstraut
.
Changes from 2.0.0b3:
- If
load_from
is used on deserialization, the value ofload_from
is used as the key in the errors dict (232
). Thanksalexmorken
.
Features:
- Add
marshmallow.validates_schema
decorator for defining schema-level validators (116
). - Add
marshmallow.validates
decorator for defining field validators as Schema methods (116
). Thanksphiltay
. - Performance improvements.
- Defining
__marshallable__
on complex objects is no longer necessary. - Add
fields.Constant
. Thankskevinastone
.
Deprecation/Removals:
- Remove
skip_missing
class Meta option. By default, missing inputs are excluded from serialized output (211
). - Remove optional
context
parameter that gets passed to methods forMethod
fields. Schema.validator
is deprecated. Usemarshmallow.validates_schema
instead.utils.get_func_name
is removed. Useutils.get_callable_name
instead.
Bug fixes:
- Fix serializing values from keyed tuple types (regression of
28
). Thanksmakmanalp
for reporting.
Other changes:
- Remove unnecessary call to
utils.get_value
forFunction
andMethod
fields (208
). Thanksjmcarp
. - Serializing a collection without passing
many=True
will not result in an error. Be very careful to pass themany
argument when necessary.
Support:
- Documentation: Update Flask and Peewee examples. Update Quickstart.
Changes from 2.0.0b2:
Boolean
field serializesNone
toNone
, for consistency with other fields (213
). Thankscmanallen
for reporting.- Bug fix:
load_only
fields do not get validated during serialization. - Implicit passing of original, raw data to Schema validators is removed. Use
@marshmallow.validates_schema(pass_original=True)
instead.
Features:
- Add useful
__repr__
methods to validators (204
). Thanksphiltay
. - Backwards-incompatible: By default,
NaN
,Infinity
, and-Infinity
are invalid values forfields.Decimal
. Passallow_nan=True
to allow these values. Thanksphiltay
.
Changes from 2.0.0b1:
- Fix serialization of
None
forTime
,TimeDelta
, andDate
fields (a regression introduced in 2.0.0a1).
Includes bug fixes from 1.2.6.
Features:
- Errored fields will not appear in (de)serialized output dictionaries (
153
,202
). - Instantiate
OPTIONS_CLASS
inSchemaMeta
. This makesSchema.opts
available in metaclass methods. It also causes validation to occur earlier (uponSchema
class declaration rather than instantiation). - Add
SchemaMeta.get_declared_fields
class method to support adding additional declared fields.
Deprecation/Removals:
- Remove
allow_null
parameter offields.Nested
(203
).
Changes from 2.0.0a1:
- Fix serialization of None for
fields.Email
.
Features:
- Backwards-incompatible: When
many=True
, the errors dictionary returned bydump
andload
will be keyed on the indices of invalid items in the (de)serialized collection (75
). Addindex_errors=False
on a Schema'sclass Meta
options to disable this behavior. - Backwards-incompatible: By default, fields will raise a ValidationError if the input is
None
. Theallow_none
parameter can override this behavior. - Backwards-incompatible: A
Field's
default
parameter is only used if explicitly set and the field's value is missing in the input to Schema.dump. If not set, the key will not be present in the serialized output for missing values . This is the behavior for all fields.fields.Str
no longer defaults to''
,fields.Int
no longer defaults to0
, etc. (199
). Thanksjmcarp
for the feedback. - In
strict
mode, aValidationError
is raised. Error messages are accessed via theValidationError's
messages
attribute (128
). - Add
allow_none
parameter tofields.Field
. IfFalse
(the default), validation fails when the field's value isNone
(76
,111
). Ifallow_none
isTrue
,None
is considered valid and will deserialize toNone
. - Schema-level validators can store error messages for multiple fields (
118
). Thanksksesong
for the suggestion. - Add
pre_load
,post_load
,pre_dump
, andpost_dump
Schema method decorators for defining pre- and post- processing routines (153
,179
). Thanksdavidism
,taion
, andjmcarp
for the suggestions and feedback. Thankstaion
for the implementation. - Error message for
required
validation is configurable. (78
). Thankssvenstaro
for the suggestion. Thanks0xDCA
for the implementation. - Add
load_from
parameter to fields (125
). Thankshakjoon
. - Add
load_only
anddump_only
parameters to fields (61
,87
). Thanksphiltay
. - Add missing parameter to fields (
115
). Thanksphiltay
. - Schema validators can take an optional
raw_data
argument which contains raw input data, incl. data not specified in the schema (127
). Thanksryanlowe0
. - Add
validate.OneOf
(135
) andvalidate.ContainsOnly
(149
) validators. Thanksphiltay
. - Error messages for validators can be interpolated with {input} and other values (depending on the validator).
fields.TimeDelta
always serializes to an integer value in order to avoid rounding errors (105
). Thanksphiltay
.- Add
include
class Meta option to support field names which are Python keywords (139
). Thanksnickretallack
for the suggestion. exclude
parameter is respected when used together withonly
parameter (165
). Thankslustdante
for the catch and patch.fields.List
works as expected with generators and sets (185
). Thankssergey-aganezov-jr
.
Deprecation/Removals:
MarshallingError
andUnmarshallingError
error are deprecated in favor of a singleValidationError
(160
).context
argument passed to Method fields is deprecated. Useself.context
instead (184
).- Remove
ForcedError
. - Remove support for generator functions that yield validators (
74
). Plain generators of validators are still supported. - The
Select/Enum
field is deprecated in favor of usingvalidate.OneOf
validator (135
). - Remove legacy, pre-1.0 API (
Schema.data
andSchema.errors
properties) (73
). - Remove
null
value.
Other changes:
Marshaller
,Unmarshaller
were moved tomarshmallow.marshalling
. These should be considered private API (129
).- Make
allow_null=True
the default forNested
fields. This will makeNone
serialize toNone
rather than a dictionary with empty values (132
). Thanksnickrellack
for the suggestion.
Bug fixes:
- Fix validation error message for
fields.Decimal
. - Allow error message for
fields.Boolean
to be customized with theerror
parameter (like other fields).
Bug fixes:
- Fix validation of invalid types passed to a
Nested
field whenmany=True
(188
). Thanksjuanrossi
for reporting.
Support:
- Fix pep8 dev dependency for flake8. Thanks
taion
.
Bug fixes:
- Fix behavior of
as_string
onfields.Integer
(173
). Thankstaion
for the catch and patch.
Other changes:
- Remove dead code from
fields.Field
. Thankstaion
.
Support:
- Correction to
_postprocess
method in docs. Thanks againtaion
.
Bug fixes:
- Fix inheritance of
ordered
class Meta option (162
). Thanksstephenfin
for reporting.
Bug fixes:
- Fix behavior of
skip_missing
andaccessor
options whenmany=True
(137
). Thanks3rdcycle
. - Fix bug that could cause an
AttributeError
when nesting schemas with schema-level validators (144
). Thanksvovanbo
for reporting.
Bug fixes:
- A
Schema's
error_handler
--if defined--will execute ifSchema.validate
returns validation errors (121
). - Deserializing None returns None rather than raising an
AttributeError
(123
). ThanksRealSalmon
for the catch and patch.
Features:
- Add
QuerySelect
andQuerySelectList
fields (84
). - Convert validators in
marshmallow.validate
into class-based callables to make them easier to use when declaring fields (85
). - Add
Decimal
field which is safe to use when dealing with precise numbers (86
).
Thanks philtay
for these contributions.
Bug fixes:
Date
fields correctly deserializes to adatetime.date
object whenpython-dateutil
is not installed (79
). Thanksmalexer
for the catch and patch.- Fix bug that raised an
AttributeError
when using a class-based validator. - Fix
as_string
behavior of Number fields when serializing to default value. - Deserializing
None
or the empty string with either aDateTime
,Date
,Time
orTimeDelta
results in the correct unmarshalling errors (96
). Thankssvenstaro
for reporting and helping with this. - Fix error handling when deserializing invalid UUIDs (
106
). Thanksvesauimonen
for the catch and patch. Schema.loads
correctly defaults to use the value ofself.many
rather than defaulting toFalse
(108
). Thanksdavidism
for the catch and patch.- Validators, data handlers, and preprocessors are no longer shared between schema subclasses (
88
). Thanksamikholap
for reporting. - Fix error handling when passing a
dict
orlist
to aValidationError
(110
). Thanksksesong
for reporting.
Deprecation:
- The validator functions in the
validate
module are deprecated in favor of the class-based validators (85
). - The
Arbitrary
,Price
, andFixed
fields are deprecated in favor of theDecimal
field (86
).
Support:
- Update docs theme.
- Update contributing docs (
77
). - Fix namespacing example in "Extending Schema" docs. Thanks
Ch00k
. - Exclude virtualenv directories from syntax checking (
99
). Thankssvenstaro
.
Features:
- Add
Schema.validate
method which validates input data against a schema. Similar toSchema.load
, but does not callmake_object
and only returns the errors dictionary. - Add several validation functions to the
validate
module. Thanksphiltay
. - Store field name and instance on exceptions raised in
strict
mode.
Bug fixes:
- Fix serializing dictionaries when field names are methods of
dict
(e.g."items"
). Thanksrozenm
for reporting. - If a Nested field is passed
many=True
,None
serializes to an empty list. Thanksnickretallack
for reporting. - Fix behavior of
many
argument passed todump
andload
. Thankssvenstaro
for reporting and helping with this. - Fix
skip_missing
behavior forString
andList
fields. Thanksmalexer
for reporting. - Fix compatibility with python-dateutil 2.3.
- More consistent error messages across
DateTime
,TimeDelta
,Date
, andTime
fields.
Support:
- Update Flask and Peewee examples.
Hotfix release.
- Ensure that errors dictionary is correctly cleared on each call to
Schema.dump
andSchema.load
.
Adds new features, speed improvements, better error handling, and updated documentation.
- Add
skip_missing
class Meta
option. - A field's
default
may be a callable. - Allow accessor function to be configured via the
Schema.accessor
decorator or the__accessor__
class member. URL
andEmail
fields are validated upon serialization.dump
andload
can receive themany
argument.- Move a number of utility functions from fields.py to utils.py.
- More useful
repr
forField
classes. - If a field's default is
fields.missing
and its serialized value isNone
, it will not be included in the final serialized result. - Schema.dumps no longer coerces its result to a binary string on Python 3.
- Backwards-incompatible: Schema output is no longer an
OrderedDict
by default. If you want ordered field output, you must explicitly set theordered
option toTrue
. - Backwards-incompatible:
error
parameter of theField
constructor is deprecated. Raise aValidationError
instead. - Expanded test coverage.
- Updated docs.
Major reworking and simplification of the public API, centered around support for deserialization, improved validation, and a less stateful Schema
class.
- Rename
Serializer
toSchema
. - Support for deserialization.
- Use the
Schema.dump
andSchema.load
methods for serializing and deserializing, respectively. - Backwards-incompatible: Remove
Serializer.json
andSerializer.to_json
. UseSchema.dumps
instead. - Reworked fields interface.
- Backwards-incompatible:
Field
classes implement_serialize
and_deserialize
methods.serialize
anddeserialize
comprise the public API for aField
.Field.format
andField.output
have been removed. - Add
exceptions.ForcedError
which allows errors to be raised during serialization (instead of storing errors in theerrors
dict). - Backwards-incompatible:
DateTime
field serializes to ISO8601 format by default (instead of RFC822). - Backwards-incompatible: Remove
Serializer.factory
method. It is no longer necessary with thedump
method. - Backwards-incompatible: Allow nesting a serializer within itself recursively. Use
exclude
oronly
to prevent infinite recursion. - Backwards-incompatible: Multiple errors can be stored for a single field. The errors dictionary returned by
load
anddump
have lists of error messages keyed by field name. - Remove
validated
decorator. Validation occurs withinField
methods. Function
field raises aValueError
if an uncallable object is passed to its constructor.Nested
fields inherit context from their parent.- Add
Schema.preprocessor
andSchema.validator
decorators for registering preprocessing and schema-level validation functions respectively. - Custom error messages can be specified by raising a
ValidationError
within a validation function. - Extra keyword arguments passed to a Field are stored as metadata.
- Fix ordering of field output.
- Fix behavior of the
required
parameter onNested
fields. - Fix serializing keyed tuple types (e.g.
namedtuple
) withclass Meta
options. - Fix default value for
Fixed
andPrice
fields. - Fix serialization of binary strings.
Schemas
can inherit fields from non-Schema
base classes (e.g. mixins). Also, fields are inherited according to the MRO (rather than recursing over base classes). Thanksjmcarp
.- Add
Str
,Bool
, andInt
field class aliases.
- Add
Serializer.error_handler
decorator that registers a custom error handler. - Add
Serializer.data_handler
decorator that registers data post-processing callbacks. - Backwards-incompatible:
process_data
method is deprecated. Use thedata_handler
decorator instead. - Fix bug that raised error when passing
extra
data together withmany=True
. Thanksbuttsicles
for reporting. - If
required=True
validation is violated for a givenField
, it will raise an error message that is different from the message specified by theerror
argument. Thanksasteinlein
. - More generic error message raised when required field is missing.
validated
decorator should only wrap aField
class'soutput
method.
- Fix bug in serializing keyed tuple types, e.g.
namedtuple
andKeyedTuple
. - Nested field can load a serializer by its class name as a string. This makes it easier to implement 2-way nesting.
- Make
Serializer.data
override-able.
- Add
Serializer.factory
for creating a factory function that returns a Serializer instance. MarshallingError
stores its underlying exception as an instance variable. This is useful for inspecting errors.fields.Select
is aliased tofields.Enum
.- Add
fields.__all__
andmarshmallow.__all__
so that the modules can be more easily extended. - Expose
Serializer.OPTIONS_CLASS
as a class variable so that options defaults can be overridden. - Add
Serializer.process_data
hook that allows subclasses to manipulate the final output data.
- Add
json_module
class Meta option. - Add
required
option to fields . ThanksDeaconDesperado
. - Tested on Python 3.4 and PyPy.
- Fix
Integer
field default. It is now0
instead of0.0
. Thankskalasjocke
. - Add
context
param toSerializer
. Allows accessing arbitrary objects inFunction
andMethod
fields. Function
andMethod
fields raiseMarshallingError
if their argument is uncallable.
- Enable custom field validation via the
validate
parameter. - Add
utils.from_rfc
for parsing RFC datestring to Python datetime object.
- Avoid unnecessary attribute access in
utils.to_marshallable_type
for improved performance. - Fix RFC822 formatting for localized datetimes.
- Can customize validation error messages by passing the
error
parameter to a field. - Backwards-incompatible: Rename
fields.NumberField
->fields.Number
. - Add
fields.Select
. Thanksecarreras
. - Support nesting a Serializer within itself by passing
"self"
intofields.Nested
(only up to depth=1). - Backwards-incompatible: No implicit serializing of collections. Must set
many=True
if serializing to a list. This ensures that marshmallow handles singular objects correctly, even if they are iterable. - If Nested field
only
parameter is a field name, only return a single value for the nested object (instead of a dict) or a flat list of values. - Improved performance and stability.
- An object's
__marshallable__
method, if defined, takes precedence over__getitem__
. - Generator expressions can be passed to a serializer.
- Better support for serializing list-like collections (e.g. ORM querysets).
- Other minor bugfixes.
- Add
additional
class Meta option. - Add
dateformat
class Meta option. - Support for serializing UUID, date, time, and timedelta objects.
- Remove
Serializer.to_data
method. Just useSerialize.data
property. - String field defaults to empty string instead of
None
. - Backwards-incompatible:
isoformat
andrfcformat
functions moved to utils.py. - Backwards-incompatible: Validation functions moved to validate.py.
- Backwards-incompatible: Remove types.py.
- Reorder parameters to
DateTime
field (first parameter is dateformat). - Ensure that
to_json
returns bytestrings. - Fix bug with including an object property in
fields
Meta option. - Fix bug with passing
None
to a serializer.
- Fix bug with serializing dictionaries.
- Fix error raised when serializing empty list.
- Add
only
andexclude
parameters to Serializer constructor. - Add
strict
parameter and option: causes Serializer to raise an error if invalid data are passed in, rather than storing errors. - Updated Flask + SQLA example in docs.
- Declaring Serializers just got easier. The
class Meta
paradigm allows you to specify fields more concisely. Can specifyfields
andexclude
options. - Allow date formats to be changed by passing
format
parameter toDateTime
field constructor. Can either be"rfc"
(default),"iso"
, or a date format string. - More useful error message when declaring fields as classes (instead of an instance, which is the correct usage).
- Rename
MarshallingException
->MarshallingError
. - Rename
marshmallow.core
->marshmallow.serializer
.
- Allow prefixing field names.
- Fix storing errors on Nested Serializers.
- Python 2.6 support.
- Field-level validation.
- Add
fields.Method
. - Add
fields.Function
. - Allow binding of extra data to a serialized object by passing the
extra
param when initializing aSerializer
. - Add
relative
parameter tofields.Url
that allows for relative URLs.
- First release.