app.serializers.document.DocumentSerializer

class app.serializers.document.DocumentSerializer(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: flask_marshmallow.schema.Schema

Attributes

DocumentSerializer.TYPE_MAPPING
DocumentSerializer.dict_class
DocumentSerializer.error_messages	Overrides for default schema-level error messages
DocumentSerializer.opts
DocumentSerializer.set_class

Methods

DocumentSerializer.__init__(*[, only, ...])
DocumentSerializer.dump(obj, *[, many])	Serialize an object to native Python data types according to this Schema's fields.
DocumentSerializer.dumps(obj, *args[, many])	Same as dump(), except return a JSON-encoded string.
DocumentSerializer.from_dict(fields, *[, name])	Generate a Schema class given a dictionary of fields.
DocumentSerializer.get_attribute(obj, attr, ...)	Defines how to pull values from an object to serialize.
DocumentSerializer.handle_error(error, data, ...)	Custom error handler function for the schema.
DocumentSerializer.jsonify(obj[, many])	Return a JSON response containing the serialized data.
DocumentSerializer.load(data, *[, many, ...])	Deserialize a data structure to an object defined by this Schema's fields.
DocumentSerializer.loads(json_data, *[, ...])	Same as load(), except it takes a JSON string as input.
DocumentSerializer.on_bind_field(field_name, ...)	Hook to modify a field when it is bound to the Schema.
DocumentSerializer.valid_request_file(data)
DocumentSerializer.validate(data, *[, many, ...])	Validate data against the schema, returning a dictionary of validation errors.
DocumentSerializer.validate_id(document_id)
DocumentSerializer.wrap(data, **kwargs)