OpenQuizz
Une application de gestion des contenus pédagogiques
flask_restx.marshalling Namespace Reference

Data Structures

class  marshal_with
 
class  marshal_with_field
 

Functions

def make (cls)
 
def marshal (data, fields, envelope=None, skip_none=False, mask=None, ordered=False)
 

Function Documentation

◆ make()

def flask_restx.marshalling.make (   cls)

◆ marshal()

def flask_restx.marshalling.marshal (   data,
  fields,
  envelope = None,
  skip_none = False,
  mask = None,
  ordered = False 
)
Takes raw data (in the form of a dict, list, object) and a dict of
fields to output and filters the data based on those fields.

:param data: the actual object(s) from which the fields are taken from
:param fields: a dict of whose keys will make up the final serialized
               response output
:param envelope: optional key that will be used to envelop the serialized
                 response
:param bool skip_none: optional key will be used to eliminate fields
                       which value is None or the field's key not
                       exist in data
:param bool ordered: Wether or not to preserve order


>>> from flask_restx import fields, marshal
>>> data = { 'a': 100, 'b': 'foo', 'c': None }
>>> mfields = { 'a': fields.Raw, 'c': fields.Raw, 'd': fields.Raw }

>>> marshal(data, mfields)
{'a': 100, 'c': None, 'd': None}

>>> marshal(data, mfields, envelope='data')
{'data': {'a': 100, 'c': None, 'd': None}}

>>> marshal(data, mfields, skip_none=True)
{'a': 100}

>>> marshal(data, mfields, ordered=True)
OrderedDict([('a', 100), ('c', None), ('d', None)])

>>> marshal(data, mfields, envelope='data', ordered=True)
OrderedDict([('data', OrderedDict([('a', 100), ('c', None), ('d', None)]))])

>>> marshal(data, mfields, skip_none=True, ordered=True)
OrderedDict([('a', 100)])