Python Marshmallow: Simplified Object Serialization

注:读书笔记而已,仅作总结、理解、补充,不作原创,谢谢。
原文地址:marshmallow: simplified object serialization


Marshmallow: converting complex datatypes (objects) to and from native Python datatypes.

  • Validate input data
  • Deserialize input data to app-level objects
  • Serialize app-level objects to primitive python types (Dict, Json) for use in an HTTP API

Examples

import datetime
from marshmallow import Schema, fields, pprint, post_load, ValidationError

# **************************Declaring Schemas**********************
class User(object):
   def __init__(self, name, email, age=25):
      self.name = name
      self.email = email
      self.age = age
      self.create_time = datetime.datetime.now()
   def  __report__(self):
      return '<User(name=(self.name!r)>'.format(self=self)

class UserSchema(Schema):
   name = fields.Str()
   email = fields.Email()
   age = fields.Integer()
   create_time = fields.DateTime()

# **************************Serializing Objects**********************
user = User(name="Violet", email="violet@email.com")
schema = UserSchema()
# serialize to JSON
serialization_result = schema.dump(user)  # serialization
pprint(serialization_result)
#Output:
#{
# "name": "Violet", 
#  "email": "violet@email.com", 
#  "age": 25
#  "created_time": "2018-05-08T21:47:16.049594+00:00"
#}

# serialize to JSON-encoded String
json_string = schema.dumps(user)
pprint(json_string)
#'{"name":"Violet, "email": "violet@email.com",  "age": 25, "created_time": "2018-05-08T21:47:16.049594+00:00"}'

# **************************Filtering Output**********************
filtered_schema = UserSchema(only=('name', 'email'))
filtered_schema.dump(user)
#'{"name": "Violet", "email": "violet@email.com"}'


#***************************Deserializing Objects**********************
user_data = {
    "name": "Violet",
    "email": "violet@email.com",
    "age": 20,
    "create_time": "2018-05-08T21:47:16.049594+00:00"
}
schema = UserSchema()
result = schema.load(user_data)
pprint(result)
#{
#   "name": "Violet",
#    "email": "violet@email.com",
#    "age": 20,
#    "create_time": datetime.datetime(xxxx, xx, xx, xx, xx, xx, xxxxxx)"
#}

# deserializing to objects!!!
class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    age = fields.Integer()
    create_time = fields.DateTime()

    @post_load
    def make_type(self, data):
        return User(**data)

schema = UserSchema()
result = schema.load(user_data)
result
#<User(name='Violet')>

#*********************Handling Collections of Objects********************
user1 = User(name="Violet", email="violet@email.com")
user2 = User(name="Sophia", email="sophia@email.com")
users = [user1, user2]
schema = UserSchema(many=True)
result = schema.dump(users)  # OR UserSchema().dump(users, many=True)

# ************************Validate Callable************************
def validate_age(age):
  if age < 0:
    raise ValidationError("Age must be equal or greater than 0")

class UserSchema(Schema):
   name = fields.Str()
   email = fields.Email()
   age = fields.Integer(validate=validate_age)  # if the value of age is less than 0, throw a ValidationError
   create_time = fields.DateTime()

#****************OR****************
class UserSchema(Schema):
   name = fields.Str()
   email = fields.Email()
   age = fields.Integer()
   create_time = fields.DateTime()

   @validates('age'):
   def validate_age(self, age):
      if age < 0:
        raise ValidationError("Age must be equal or greater than 0")

#*****************Schema.validate**********************
errors = UserSchema().validate({"name": "Violet", "email": "whatever"}
errors
# {"email": [' "whatever" is not a valid email address.']}

Available Field Classes

  • Parameters:
    • default: used to set a default value for this field. If not set, the field will be discarded from serialization. May be a value or a callable.
    • attribute (str): the name of the attribute to get the value from when serializing. If None, assumes the attribute has the same name as the field. -- That's why we usually take the same names of the class fields as field names!
    • data_key (str): the name of the attribute to get the value from when deserializing. If None, assumes the key has the same name as the field.
    • validate (callable): Validator or collection of validators that are called during deserialization.
      • callable validator: takes a field's input value as its only parameter and returns a boolean indicating the result of validation. If it returns false, an ValidationError is raised.
    • required: Indicates if the field is required. Default to True (I suppose). If required=True and the field value is not provided, an ValidationError is raised.
    • allow_none: Set this to True if None should be considered a valid value during validation / deserialization. Default to False!!! (except when missing=None and allow_none is unset)
    • load_only: If True, skip this field during serialization. (It means this field only applicable in deserialization)
    • dump_only: If True, skip this field during deserialization. (It means this field only applicable in serialization, which effectively marks the field as read-only)
    • missing: Default field value for deserialization. May be a value of a callable.
    • error_messages (dict): Overrides Field.default_error_messages.
    • metadata: Extra arguments to be stored as metadata.

For more information, see API Docs - Fields

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容