|
def | __init__ (self, typing.Union[SchemaABC, type, str, typing.Callable[[], SchemaABC]] nested, str field_name, **kwargs) |
|
def | __init__ (self, typing.Union[SchemaABC, type, str, typing.Callable[[], SchemaABC]] nested, *typing.Any default=missing_, typing.Optional[types.StrSequenceOrSet] only=None, types.StrSequenceOrSet exclude=(), bool many=False, typing.Optional[str] unknown=None, **kwargs) |
|
def | schema (self) |
|
None | __init__ (self, *typing.Any default=missing_, typing.Any missing=missing_, typing.Optional[str] data_key=None, typing.Optional[str] attribute=None, typing.Optional[typing.Union[typing.Callable[[typing.Any], typing.Any], typing.Iterable[typing.Callable[[typing.Any], typing.Any]],]] validate=None, bool required=False, typing.Optional[bool] allow_none=None, bool load_only=False, bool dump_only=False, typing.Optional[typing.Dict[str, str]] error_messages=None, typing.Optional[typing.Mapping[str, typing.Any]] metadata=None, **additional_metadata) |
|
str | __repr__ (self) |
|
def | __deepcopy__ (self, memo) |
|
def | get_value (self, obj, attr, accessor=None, default=missing_) |
|
ValidationError | make_error (self, str key, **kwargs) |
|
def | fail (self, str key, **kwargs) |
|
def | serialize (self, str attr, typing.Any obj, typing.Optional[typing.Callable[[typing.Any, str, typing.Any], typing.Any]] accessor=None, **kwargs) |
|
def | deserialize (self, typing.Any value, typing.Optional[str] attr=None, typing.Optional[typing.Mapping[str, typing.Any]] data=None, **kwargs) |
|
def | context (self) |
|
def | serialize (self, attr, obj, accessor=None) |
|
def | deserialize (self, value) |
|
Allows you to replace nested data with one of the data's fields.
Example: ::
from marshmallow import Schema, fields
class ArtistSchema(Schema):
id = fields.Int()
name = fields.Str()
class AlbumSchema(Schema):
artist = fields.Pluck(ArtistSchema, 'id')
in_data = {'artist': 42}
loaded = AlbumSchema().load(in_data) # => {'artist': {'id': 42}}
dumped = AlbumSchema().dump(loaded) # => {'artist': 42}
:param Schema nested: The Schema class or class name (string)
to nest, or ``"self"`` to nest the :class:`Schema` within itself.
:param str field_name: The key to pluck a value from.
:param kwargs: The same keyword arguments that :class:`Nested` receives.