OpenQuizz
Une application de gestion des contenus pédagogiques
marshmallow.decorators Namespace Reference

Data Structures

class  MarshmallowHook
 

Functions

Callable[..., Any] validates (str field_name)
 
Callable[..., Any] validates_schema (Optional[Callable[..., Any]] fn=None, bool pass_many=False, bool pass_original=False, bool skip_on_field_errors=True)
 
Callable[..., Any] pre_dump (Optional[Callable[..., Any]] fn=None, bool pass_many=False)
 
Callable[..., Any] post_dump (Optional[Callable[..., Any]] fn=None, bool pass_many=False, bool pass_original=False)
 
Callable[..., Any] pre_load (Optional[Callable[..., Any]] fn=None, bool pass_many=False)
 
Callable[..., Any] post_load (Optional[Callable[..., Any]] fn=None, bool pass_many=False, bool pass_original=False)
 
Callable[..., Any] set_hook (Optional[Callable[..., Any]] fn, Union[Tuple[str, bool], str] key, **Any kwargs)
 

Variables

 PRE_DUMP
 
 POST_DUMP
 
 PRE_LOAD
 
 POST_LOAD
 
 VALIDATES
 
 VALIDATES_SCHEMA
 

Detailed Description

Decorators for registering schema pre-processing and post-processing methods.
These should be imported from the top-level `marshmallow` module.

Methods decorated with
`pre_load <marshmallow.decorators.pre_load>`, `post_load <marshmallow.decorators.post_load>`,
`pre_dump <marshmallow.decorators.pre_dump>`, `post_dump <marshmallow.decorators.post_dump>`,
and `validates_schema <marshmallow.decorators.validates_schema>` receive
``many`` as a keyword argument. In addition, `pre_load <marshmallow.decorators.pre_load>`,
`post_load <marshmallow.decorators.post_load>`,
and `validates_schema <marshmallow.decorators.validates_schema>` receive
``partial``. If you don't need these arguments, add ``**kwargs`` to your method
signature.


Example: ::

from marshmallow import (
    Schema, pre_load, pre_dump, post_load, validates_schema,
    validates, fields, ValidationError
)

class UserSchema(Schema):

    email = fields.Str(required=True)
    age = fields.Integer(required=True)

    @post_load
    def lowerstrip_email(self, item, many, **kwargs):
        item['email'] = item['email'].lower().strip()
        return item

    @pre_load(pass_many=True)
    def remove_envelope(self, data, many, **kwargs):
        namespace = 'results' if many else 'result'
        return data[namespace]

    @post_dump(pass_many=True)
    def add_envelope(self, data, many, **kwargs):
        namespace = 'results' if many else 'result'
        return {namespace: data}

    @validates_schema
    def validate_email(self, data, **kwargs):
        if len(data['email']) < 3:
            raise ValidationError('Email must be more than 3 characters', 'email')

    @validates('age')
    def validate_age(self, data, **kwargs):
        if data < 14:
            raise ValidationError('Too young!')

.. note::
These decorators only work with instance methods. Class and static
methods are not supported.

.. warning::
The invocation order of decorated methods of the same type is not guaranteed.
If you need to guarantee order of different processing steps, you should put
them in the same processing method.

Function Documentation

◆ post_dump()

Callable[..., Any] marshmallow.decorators.post_dump ( Optional[Callable[..., Any]]   fn = None,
bool   pass_many = False,
bool   pass_original = False 
)
Register a method to invoke after serializing an object. The method
receives the serialized object and returns the processed object.

By default it receives a single object at a time, transparently handling the ``many``
argument passed to the `Schema`'s :func:`~marshmallow.Schema.dump` call.
If ``pass_many=True``, the raw data (which may be a collection) is passed.

If ``pass_original=True``, the original data (before serializing) will be passed as
an additional argument to the method.

.. versionchanged:: 3.0.0
    ``many`` is always passed as a keyword arguments to the decorated method.

◆ post_load()

Callable[..., Any] marshmallow.decorators.post_load ( Optional[Callable[..., Any]]   fn = None,
bool   pass_many = False,
bool   pass_original = False 
)
Register a method to invoke after deserializing an object. The method
receives the deserialized data and returns the processed data.

By default it receives a single object at a time, transparently handling the ``many``
argument passed to the `Schema`'s :func:`~marshmallow.Schema.load` call.
If ``pass_many=True``, the raw data (which may be a collection) is passed.

If ``pass_original=True``, the original data (before deserializing) will be passed as
an additional argument to the method.

.. versionchanged:: 3.0.0
    ``partial`` and ``many`` are always passed as keyword arguments to
    the decorated method.

◆ pre_dump()

Callable[..., Any] marshmallow.decorators.pre_dump ( Optional[Callable[..., Any]]   fn = None,
bool   pass_many = False 
)
Register a method to invoke before serializing an object. The method
receives the object to be serialized and returns the processed object.

By default it receives a single object at a time, transparently handling the ``many``
argument passed to the `Schema`'s :func:`~marshmallow.Schema.dump` call.
If ``pass_many=True``, the raw data (which may be a collection) is passed.

.. versionchanged:: 3.0.0
    ``many`` is always passed as a keyword arguments to the decorated method.

◆ pre_load()

Callable[..., Any] marshmallow.decorators.pre_load ( Optional[Callable[..., Any]]   fn = None,
bool   pass_many = False 
)
Register a method to invoke before deserializing an object. The method
receives the data to be deserialized and returns the processed data.

By default it receives a single object at a time, transparently handling the ``many``
argument passed to the `Schema`'s :func:`~marshmallow.Schema.load` call.
If ``pass_many=True``, the raw data (which may be a collection) is passed.

.. versionchanged:: 3.0.0
    ``partial`` and ``many`` are always passed as keyword arguments to
    the decorated method.

◆ set_hook()

Callable[..., Any] marshmallow.decorators.set_hook ( Optional[Callable[..., Any]]  fn,
Union[Tuple[str, bool], str]  key,
**Any   kwargs 
)
Mark decorated function as a hook to be picked up later.
You should not need to use this method directly.

.. note::
    Currently only works with functions and instance methods. Class and
    static methods are not supported.

:return: Decorated function if supplied, else this decorator with its args
    bound.

◆ validates()

Callable[..., Any] marshmallow.decorators.validates ( str  field_name)
Register a field validator.

:param str field_name: Name of the field that the method validates.

◆ validates_schema()

Callable[..., Any] marshmallow.decorators.validates_schema ( Optional[Callable[..., Any]]   fn = None,
bool   pass_many = False,
bool   pass_original = False,
bool   skip_on_field_errors = True 
)
Register a schema-level validator.

By default it receives a single object at a time, transparently handling the ``many``
argument passed to the `Schema`'s :func:`~marshmallow.Schema.validate` call.
If ``pass_many=True``, the raw data (which may be a collection) is passed.

If ``pass_original=True``, the original data (before unmarshalling) will be passed as
an additional argument to the method.

If ``skip_on_field_errors=True``, this validation method will be skipped whenever
validation errors have been detected when validating fields.

.. versionchanged:: 3.0.0b1
    ``skip_on_field_errors`` defaults to `True`.

.. versionchanged:: 3.0.0
    ``partial`` and ``many`` are always passed as keyword arguments to
    the decorated method.

Variable Documentation

◆ POST_DUMP

POST_DUMP

◆ POST_LOAD

POST_LOAD

◆ PRE_DUMP

PRE_DUMP

◆ PRE_LOAD

PRE_LOAD

◆ VALIDATES

VALIDATES

◆ VALIDATES_SCHEMA

VALIDATES_SCHEMA