OpenQuizz
Une application de gestion des contenus pédagogiques
Schema.Meta Class Reference

Detailed Description

Options object for a Schema.

Example usage: ::

    class Meta:
fields = ("id", "email", "date_created")
exclude = ("password", "secret_attribute")

Available options:

- ``fields``: Tuple or list of fields to include in the serialized result.
- ``additional``: Tuple or list of fields to include *in addition* to the
    explicitly declared fields. ``additional`` and ``fields`` are
    mutually-exclusive options.
- ``include``: Dictionary of additional fields to include in the schema. It is
    usually better to define fields as class variables, but you may need to
    use this option, e.g., if your fields are Python keywords. May be an
    `OrderedDict`.
- ``exclude``: Tuple or list of fields to exclude in the serialized result.
    Nested fields can be represented with dot delimiters.
- ``dateformat``: Default format for `Date <fields.Date>` fields.
- ``datetimeformat``: Default format for `DateTime <fields.DateTime>` fields.
- ``timeformat``: Default format for `Time <fields.Time>` fields.
- ``render_module``: Module to use for `loads <Schema.loads>` and `dumps <Schema.dumps>`.
    Defaults to `json` from the standard library.
- ``ordered``: If `True`, order serialization output according to the
    order in which fields were declared. Output of `Schema.dump` will be a
    `collections.OrderedDict`.
- ``index_errors``: If `True`, errors dictionaries will include the index
    of invalid items in a collection.
- ``load_only``: Tuple or list of fields to exclude from serialized results.
- ``dump_only``: Tuple or list of fields to exclude from deserialization
- ``unknown``: Whether to exclude, include, or raise an error for unknown
    fields in the data. Use `EXCLUDE`, `INCLUDE` or `RAISE`.
- ``register``: Whether to register the `Schema` with marshmallow's internal
    class registry. Must be `True` if you intend to refer to this `Schema`
    by class name in `Nested` fields. Only set this to `False` when memory
    usage is critical. Defaults to `True`.

The documentation for this class was generated from the following file: