marshmallow之自定義Field

AWang 發(fā)布于2019-07-31 10:28 / 1770人閱讀

摘要：有三種方式創(chuàng)建自定義的。下面的例子判斷某個(gè)對(duì)象是否是某個(gè)對(duì)象的作者，以及的屬性是否出現(xiàn)單詞自定義錯(cuò)誤信息字段驗(yàn)證產(chǎn)生的錯(cuò)誤信息可以在類級(jí)別或?qū)嵗?jí)別配置。在類級(jí)別時(shí)，可以定義為錯(cuò)誤碼和錯(cuò)誤信息的字典映射在類實(shí)例化時(shí)，給參數(shù)傳參對(duì)象

有三種方式創(chuàng)建自定義的field。

創(chuàng)建Field類的子類

創(chuàng)建繼承自marshmallow.fields.Field類的子類并實(shí)現(xiàn)_serialize和/或_deserialize方法：

from marshmallow import fields, Schema

class Titlecased(fields.Field):
    def _serialize(self, value, attr, obj):
        if value is None:
            return ""
        return value.title()

class UserSchema(Schema):
    name = fields.String()
    email = fields.String()
    created_at = fields.DateTime()
    titlename = TitleCased(attribute="name")

Method Fields

fields.Method將序列化schema中某個(gè)方法的返回值，該方法必須接收一個(gè)要進(jìn)行序列化的對(duì)象的參數(shù)obj：

class UserSchema(Schema):
    name = fields.String()
    email = fields.String()
    created_at = fields.DateTime()
    since_created = fields.Method("get_days_since_created")

    def get_days_since_created(self, obj):
        return dt.datetime.now().day - obj.created_at.day

Function Fields

fields.Function將序列化傳遞給它的函數(shù)的返回值，也接收一個(gè)obj參數(shù)：

class UserSchema(Schema):
    name = fields.String()
    email = fields.String()
    created_at = fields.DateTime()
    uppername = fields.Function(lambda obj: obj.name.upper())

Method和Function的反序列化

fields.Method和fields.Function都接收一個(gè)可選的deserialize參數(shù)，該參數(shù)定義了如何反序列化字段：

class UserSchema(Schema):
    # Method接收字符串類型的方法名, Function接收callable對(duì)象
    balance = fields.Method("get_balance", deserialize="load_balance")

    def get_balance(self, obj):
        return obj.income - obj.debt

    def load_balance(self, value):
        return float(value)

schema = UserSchema()
result = schema.load({"balance": "100.00"})
result.data["balance"]  # => 100.0

為Method和Function添加上下文

Function和Method序列化時(shí)可能需要相關(guān)環(huán)境信息。可以為schema設(shè)置context屬性(dict對(duì)象)，F(xiàn)unction和Method可以訪問此字典。

下面的例子判斷某個(gè)User對(duì)象是否是某個(gè)Blog對(duì)象的作者，以及Blog的title屬性是否出現(xiàn)bicycle單詞：

class UserSchema(Schema):
    name = fields.String()
    # Function fields optionally receive context argument
    is_author = fields.Function(lambda user, context: user == context["blog"].author)
    likes_bikes = fields.Method("writes_about_bikes")

    # Method fields also optionally receive context argument
    def writes_about_bikes(self, user):
        return "bicycle" in self.context["blog"].title.lower()

schema = UserSchema()

user = User("Freddie Mercury", "fred@queen.com")
blog = Blog("Bicycle Blog", author=user)

schema.context = {"blog": blog}
data, errors = schema.dump(user)
data["is_author"]  # => True
data["likes_bikes"]  # => True

自定義錯(cuò)誤信息

字段驗(yàn)證產(chǎn)生的錯(cuò)誤信息可以在類級(jí)別或?qū)嵗?jí)別配置。

在類級(jí)別時(shí)，default_error_messages可以定義為錯(cuò)誤碼和錯(cuò)誤信息的字典映射：

from marshmallow import fields

class MyDate(fields.Date):
    default_error_messages = {
        "400001": "Please provide a valid date.",
    }

在Field類實(shí)例化時(shí)，給error_messages參數(shù)傳參(dict對(duì)象)：

from marshmallow import Schema, fields

class UserSchema(Schema):

    name = fields.Str(
        required=True,
        error_messages={"required": "Please provide a name."}
    )