Marshmallow及ORM小结

已于 2022-08-07 21:04:46 修改
阅读量268 收藏 1
点赞数
文章标签： python 开发语言
于 2022-08-07 21:04:04 首次发布
原文链接：https://www.cnblogs.com/xingxia/p/python_Marshmallow.html
版权

前记

自己总结使用的，有错误之处欢迎之处。
觉得没用请直接退出，不必浪费您的时间私信骂没用。

  • 一句话总结：
    • ORM可以实现用python语句操作数据库，而不用写相应的sql语句。
    • marshmallow可以将对应的数据（json形式）转换为python自己的数据类型从而存入生成的数据库中。
      或者将数据库的内容转换为对应的json格式传输到前端。

marshmallow是什么？

  • marshmallow是一个用来将复杂的orm对象与python原生数据类型之间相互转换的库。
  • 简而言之，就是实现：
    • object -> dict，
    • object -> json string，
    • object -> list,
    • json string -> dict，
    • json string -> list，
    • json string -> object,
    • dict -> object，
    • list -> object。

ORM是什么？

  • ORM（Object Relational Mapping）
  • 对象——关系（数据库）之间的映射
    • 可以通过简易的ORM框架的API进行数据库的操作。
    • 即通过在python中操作对象从而实现对数据库进行操作。
    • 定义一个对象，那就对应着一张表，这个对象的实例，就对应着表中的一条记录。
  • 作用：
    • 在关系型数据库和对象之间作一个映射，这样，我们在具体的操作数据库的时候，就不需要再去和复杂的SQL语句打交道，只要像平时操作对象一样操作它就可以了 。
  • 说人话：通过ORM可以将写成的python代码自动转换成对应的sql语句并自动添加对应的字段。（参照对应的函数写相应的python代码）
  • 写相应的python语句创造model的对象，然后第一次创建时会自动生成对应的SQL语句及字段（后续需要手动修改生成的内容）。
  • 可以参考Object Relational Mapping(ORM)及python_flask_ORM用法写的很详细。

marshmallow中的序列化与反序列化

  • 序列化：将数据对象转化为可存储或可传输的数据类型（例如json）
    • dump()/dumps()
  • 反序列化：将可存储或可传输的数据类型转化为数据对象
    • load()/loads()

创建一个object作为基础

import datetime as dt


class User:
    def __init__(self, name, email):
        self.name = name
        self.email = email
        self.created_time = dt.datetime.now()

中间载体shema

  • 数据结构之间的相互转换，需要有一个中间载体来实现，这个载体就是Schema类。
  • 因此需要创建一个继承自Schema的UserSchema类，有两种方式创建。
  • UserSchema类可以将User的属性名映射到Field对象。
# 定义一个类继承Schema
from marshmallow import Schema, fields


class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    created_at = fields.DateTime()

# 使用Schema的from_dict()方法
from marshmallow import Schema, fields


UserSchema = Schema.from_dict(
    {
        "name": fields.Str(), 
        "email": fields.Email(), 
        "created_at": fields.DateTime()
    }
)

简述Serializing（序列化对象）

  • 即把自定义的对象转换为Python内置的对象（dict, str, list）。
  • dump()方法：可以将一个object（对象）转换为一个dict（字典），示例如下：
user = User(name="TTY", email="tty@python.org")
schema = UserSchema()
res = schema.dump(user)
print(res)
# {'email': 'tty@python.org', 'name': 'TTY', 'created_time': '2019-08-05T14:43:51.168241+00:00'}
  • dumps()方法：可以将一个object（对象）转换为一个str（json格式字符串），示例如下：
res2 = schema.dumps(user)
print(res2)
# '{"name": "TTY", "created_time": "2019-08-05T14:46:07.111755+00:00", "email": "tty@python.org"}'

序列化相关参数

  • attribute
    schema默认会序列化传入对象和自身定义的fields相同的属性, 然而你也会有需求使用不同的fields和属性名。
    在这种情况下, 你需要明确定义这个fields将从什么属性名取值明确定义这个fields将从什么属性名取值。
    下面代码中：UserSchema中的full_name，email_address，created_at分别从User对象的name，email，created_time属性取值。
class UserSchema(Schema):
    full_name = fields.String(attribute="name")
    email_address = fields.Email(attribute="email")
    created_at = fields.DateTime(attribute="created_time")
  • dump_only——等同于只读字段。
    # created_at is "read-only"
    created_at = fields.DateTime(dump_only=True)
  • default——输入值缺失用default指定默认值
class UserSchema(Schema):
    birthdate = fields.DateTime(default=dt.datetime(2020, 9, 9))

简述Deserializing（反序列化）

  • 反序列化是将Python内置的对象转换为自定义的对象。
  • load()方法：它将输入的字典格式数据转换成应用层数据结构。他也能起到验证输入的字典格式数据的作用。默认情况下，load()方法返回一个字典，当输入的数据的值不匹配字段类型时，抛出 ValidationError 异常。
schema = UserSchema()
res = schema.load(user_data)
print(res)
# {'email': 'tty2@python.org', 'created_time': datetime.datetime(2019, 8, 5, 14, 46, 7), 'name': 'tty2'}
  • loads()方法：可将json字符串转换为dict
user_json = '{ "created_at": "2014-08-11T05:26:03.869245", "email": "ken@yahoo.com", "name": "Ken" }'
schema = UserSchema()
j2d = schema.loads(user_json)    # 此处传入的是一个json字符串，返回的一个字典
print('j2d:', type(j2d), j2d)

# 输出结果如下：
j2d: <class 'dict'> {'created_at': datetime.datetime(2021, 2, 26, 14, 46, 15, 787833), 'name': 'Monty', 'email': 'monty@python.org'}

反序列化参数

  • load_from
    Schema默认反序列化传入字典和输出字典中相同的字段名。
    如果你觉得数据不匹配你的schema, 可以传入load_from参数指定需要增加load的字段名。
    (原字段名也能load, 且优先load原字段名)
class UserSchema(Schema):
    full_name = fields.String(load_from="name")
    email_address = fields.Email(load_from="email")
    created_at = fields.DateTime(load_from="created_time")
  • load_only——等同于只写字段。
    # password is "write-only"
    password = fields.Str(load_only=True)
  • missing——输入值缺失用missing指定默认值。
class UserSchema(Schema):
    id = fields.UUID(missing=uuid.uuid1)

通用参数

  • many = True——处理多个对象的集合

    • 多个对象的集合如果是可迭代的，那么也可以直接对这个集合进行序列化或者反序列化。在实例化Scheme类时设置参数many=True
    • 也可以不在实例化类的时候设置，而在调用dump()方法的时候传入这个参数。
user1 = User(name="tty1", email="tty1@python.org")
user2 = User(name="tty2", email="tty2@python.org")
users = [user1, user2]

# 第一种方法
schema = UserSchema(many=True)
res = schema.dump(users)

# 第二种方法
# schema = UserSchema()
# res = schema.dump(users， many=True)

print(res)
# [{'created_time': '2019-08-05T15:09:19.781325+00:00', 'email': 'tty1@python.org', 'name': 'tty1'},
#  {'created_time': '2019-08-05T15:09:19.781325+00:00', 'email': 'tty2@python.org', 'name': 'tty2'}]
  • data_key——让key同时满足序列化与反序列化的方法
class UserSchema(Schema):
    full_name = fields.String(data_key="name")
    email_address = fields.Email(data_key="email")
    created_at = fields.DateTime(data_key="created_time")

必填字段校验——required=True

  • 必填字段的校验，可通过传入关键字参数required=True ，可以自定义缺失字段时抛出的异常信息：设置参数error_messages的值，示例：
from marshmallow import Schema, fields, ValidationError


class UserSchema(Schema):
    name = fields.String(required=True)
    age = fields.Integer(
        required=True, 
        error_messages={"required": "Age is required."})
    city = fields.String(
        required=True,
        error_messages={"required": {"message": "City required", "code": 400}},
    )
    email = fields.Email()


try:
    result = UserSchema().load({"email": "foo@bar.com"})
except ValidationError as err:
    print(err.messages)
    # {'age': ['Age is required.'],
    # 'city': {'code': 400, 'message': 'City required'},
    # 'name': ['Missing data for required field.']}

忽略部分字段——partial

  • 使用required之后我们还是可以在传入数据的时候忽略这个必填字段。
  • 只想校验部分的字段，可以通过传递partial参数来指定需要校验的字段，示例：
class UserSchema(Schema):
    name = fields.String(required=True)
    age = fields.Integer(required=True)

# 方法一：在load()方法设置partial参数的值（元组），表时忽略那些字段。
schema = UserSchema()
res = schema.load({"age": 42}, partial=("name",))
print(res)
# {'age': 42}

# 方法二：直接设置partial=True
schema = UserSchema()
res = schema.load({"age": 42}, partial=True)
print(res)
# {'age': 42}

参考文献

什么是ORM
Object Relational Mapping(ORM)
python_flask_ORM——用法很详细
python之Marshmallow
Marshmallow快速上手及参数校验

人间不想清醒
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
flask序列化框架之marshmallow详解
lienze.tech
10-28 1722
前言 这几年一直在it行业里摸爬滚打，一路走来，不少总结了一些python行业里的高频面试，看到大部分初入行的新鲜血液，还在为各样的面试题答案或收录有各种困难问题 于是乎，我自己开发了一款面试宝典，希望能帮到大家，也希望有更多的Python新人真正加入从事到这个行业里，让python火不只是停留在广告上。 微信小程序搜索：Python面试宝典 或可关注原创个人博客：https://lienze.tech 也可关注微信公众号，不定时发送各类有趣猎奇的技术文章：Python编程学习 marshmallow ht
flask---》Marshmallow介绍及基础使用
python_web全栈
04-09 6513
0.Marshmallow背景介绍 介绍 Marshmallow，中文译作：棉花糖。 是一个轻量级的数据格式转换的模块，也叫序列化和反序列化模块，常用于将复杂的orm模型对象与python原生数据类型之间相互转换。 一般用于flask marshmallow提供了丰富的api功能。如下： Serializing 序列化[可以把数据对象转化为可存储或可传输的数据类型，例如：objects/object->list/dict，dict/list->string] De.
Flask Marshmallow基本使用
yutu75的博客
12-01 6974
Marshmallow 官方文档：https://marshmallow.readthedocs.io/en/latest/ Marshmallow，中文译作：棉花糖。是一个轻量级的数据格式转换的模块，也叫序列化和反序列化模块，常用于将复杂的orm模型对象与python原生数据类型之间相互转换。marshmallow提供了丰富的api功能。如下： Serializing 序列化[可以把数据对象转化为可存储或可传输的数据类型，例如：objects/object->list/dict，dict/li
flask-serialize:使用SQLAlchemy的Flask应用程序的模型的读写JSON序列化
05-04
烧瓶序列化 使用SQLAlchemy对Flask应用程序进行PUT和POST写入的DB Model JSON序列化 安装 pip install flask-serialize 简单而快速地开始两个步骤。 .1。 导入FlaskSerializeMixin mixin并将其添加到模型中： from flask_serialize import FlaskSerialize # create a flask-serialize mixin instance from # the factory method `FlaskSerialize` fs_mixin = FlaskSerialize ( db ) class Item ( db . Model , fs_mixin ): id = db . Column ( db . Integer , primary_key = Tr
python flask-sqlalchemy flask-marshmallow基本使用
weixin_43632687的博客
03-26 2452
首先安装 pip install marshmallow-sqlalchemy pip install flask-sqlalchemy pip install flask-marshmallow 参考 app.py文件内容 from flask import Flask,jsonify import config from flask_sqlalchemy import SQLAlchemy ...
marshmallow_dataclass:从数据类自动生成棉花糖模式
05-13
import marshmallow . validate @ dataclass class Building : # field metadata is used to instantiate the marshmallow field height : float = field ( metadata = { "validate" : marshmallow . validate . ...
marshmallow: 简化的对象序列化-python
06-18
marshmallow是一个ORM / ODM /框架无关的库，用于将复杂数据类型（如对象）转换为原生Python数据类型以及从原生Python数据类型转换。 marshmallow：简化的对象序列化 marshmallow 是一个 ORM/ODM/framework-agnostic...
marshmallow-peewee:Peewee ORM与棉花糖（反）序列化库的集成
05-26
Marshmallow-Peewee- 与（反序列化）库的集成。 对于Marshmallow<3 / Python<3请使用Marshmallow-Peewee<3 。 import peewee as pw class Role ( pw . Model ): name = pw . CharField ( 255 , default...
marshmallow-sqlalchemy:SQLAlchemy 与棉花糖的集成
08-04
orm import scoped_session , sessionmaker , relationship , backref engine = sa . create_engine ( "sqlite:///:memory:" ) session = scoped_session ( sessionmaker ( bind = engine )) Base = declarative_...
Flask_使用flask_marshmallow序列化数据
GDYY3721的博客
07-16 1397
Flask_使用flask_marshmallow序列化数据
flask ORM 序列化和反序列化的两种方法
Gboys的博客
02-25 1371
flask ORM 序列化和反序列化的两种方法 使用marshmallow 对数据进行序列化和反序列化 from marshmallow import Schema, fields, post_load from SQLconfig.models import * class User_ser(Schema): # 建立和数据库模型一样的类继承marshmallow中的Schema类 id = fields.Integer() # 使用marshmallow中的fields来约束数
Flask-Restful超详解、序列化
lienze.tech
10-28 1271
前言 这几年一直在it行业里摸爬滚打，一路走来，不少总结了一些python行业里的高频面试，看到大部分初入行的新鲜血液，还在为各样的面试题答案或收录有各种困难问题 于是乎，我自己开发了一款面试宝典，希望能帮到大家，也希望有更多的Python新人真正加入从事到这个行业里，让python火不只是停留在广告上。 微信小程序搜索：Python面试宝典 或可关注原创个人博客：https://lienze.tech 也可关注微信公众号，不定时发送各类有趣猎奇的技术文章：Python编程学习 Flask-Restful
Flask SQLAlchemy_Serializer ORM模型序列化
weixin_47906106的博客
07-17 2037
在前后端分离项目中，经常需要把ORM模型转化为字典，再将字典转化为JSON格式的字符串。在遇到sqlalchemy_serializer之前，我都是通过类似Java中的反射原理，获取当前ORM模型的所有字段，然后写一个to_dict方法来将字段以及他的值封装成字典。这种做法虽然一定程度上方便了开发，但也是带着枷锁跳舞，存在以下几个弊端：无法优雅的排除不需要序列化的字段。无法优雅的序列化多表之间的关系。
Flask-REST接口开发 + marshmallow
黄雄进
12-10 711
Flask-REST接口开发 + marshmallow REST是Representational State Transfer三个单词的缩写，由Roy Fielding于2000年论文中提出，它代表着分布式服务的架构风格。 后端负责数据编造,而前端则负责数据渲染，前端静态页面调用指定api获取到有固定格式的数据，再将数据展示出来，这样呈现给用户的就是一个”动态“的过程。 REST设计原则 1 ...
Python之marshmallow
最爱吃大米的博客
05-29 2677
python之Marshmallow marshmallow是一个用来将复杂的orm对象与python原生数据类型之间相互转换的库，简而言之，就是实现object -> dict， objects -> list, string -> dict 和 string -> list。 序列化：序列化的意思是将数据对象转化为可存储或可传输的数据类型 反序列化：将可存储或可传输的数据类型转化为数据对象 要进行序列化或反序列化，首先我们需要一个用来操作的object，这里我们先定义一个类：
总结：Python 轻量级序列化和反序列化包 marshmallow 详细使用指南
haeasringnar的博客
10-28 3269
第一部分、marshmallow 基本的数据类型及基础属性介绍 1、基础数据类型 fields.String(*, default, missing, data_key, …) 字符串类型 fields.UUID(*, default, missing, data_key, …) UUID字符串类型 fields.Integer(*, strict, **kwargs) 整数类型 fields.Decimal(places, rounding, *, allow_nan, …) 支持Python中的deci
flask中将实例对象转化为json对象
小熊提伯斯的博客
10-15 3944
** 由于Flask中没有Django的JsonResponse()方法，所以我们如果要将User.query.all()这样查出来的结果集转化为json对象的时候,就需要自己去实现一个转化为json的方法 看代码 我们可以自己实现一个to_json()方法 这个方法也是在CSDN一个博主文章中看到的,很实用 收藏起来 class User(db.Model): """ 用户模型...
Python：使用marshmallow实现Python数据序列化、反序列化、数据验证
最新发布
彭世瑜的博客
11-12 306
marshmallow是一个python数据序列化、反序列化、数据验证的工具库文档安装定义一个Python类定义一个Schema通过Schema对Python类进行序列化。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值