文档章节

marshmallow轻量自动化验证和序列化

AllenOR灵感
 AllenOR灵感
发布于 2017/09/10 01:17
字数 1098
阅读 4
收藏 0

源代码

import functools
from tornado.web import HTTPError
from marshmallow_peewee import ModelSchema
from marshmallow.fields import Field
from marshmallow_peewee import Related
from marshmallow.validate import (
    URL, Email, Range, Length, Equal, Regexp,
    Predicate, NoneOf, OneOf, ContainsOnly
)

URL.default_message = '无效的链接'
Email.default_message = '无效的邮箱地址'
Range.message_min = '不能小于{min}'
Range.message_max = '不能小于{max}'
Range.message_all = '不能超过{min}和{max}这个范围'
Length.message_min = '长度不得小于{min}位'
Length.message_max = '长度不得大于{max}位'
Length.message_all = '长度不能超过{min}和{max}这个范围'
Length.message_equal = '长度必须等于{equal}位'
Equal.default_message = '必须等于{other}'
Regexp.default_message = '非法输入'
Predicate.default_message = '非法输入'
NoneOf.default_message = '非法输入'
OneOf.default_message = '无效的选择'
ContainsOnly.default_message = '一个或多个无效的选择'
Field.default_error_messages = {
        'required': '该字段是必填字段',
        'type': '无效的输入类型',
        'null': '字段不能为空',
        'validator_failed': '无效的值'
}


def validate_schema(_model, **schema_kwargs):

    """
    用于检查参数正确性。

    :param _model: 数据库模块,用于绑定字段校验。
    :param schema_kwargs:  根据marshmallow.schema.Schema的
                            参数要求进行要求,下面是详细参数列表:
                            extra=None
                            only=()
                            exclude=()
                            prefix=''
                            strict=None
                            many=False
                            context=None
                            load_only=()
                            dump_only=()
                            partial=False
    :return: 校验正确则执行handler,校验失败则返回错误信息。
    """

    def decorator(f):
        @functools.wraps(f)
        def wrapper(self, *args, **kwargs):

            class CommonSchema(ModelSchema):

                class Meta:
                    model = _model

            # 检查验证结果
            result, errors = (CommonSchema(**schema_kwargs)
                              .load(self.plain_arguments()))

            # 当验证结果存在错误时, 返回错误信息.
            if errors:
                msg = ['{}{}'.format(getattr(_model, k).verbose_name, v[0])
                       for k, v in errors.items()]
                raise HTTPError(status_code=400, log_message='\n'.join(msg))

            # 当验证结果正确时, 执行handler.
            return f(self, *args, **kwargs)
        return wrapper
    return decorator


def serializer_schema(_model, *related, **schema_kwargs):
    """
    用于序列化。
    :param _model: 数据库模块,用于绑定字段校验。
    :param related: 声明那些关联字段是需要一起序列化的,参数格式如下:
                     [
                     # 表示外键
                     (field_name, None),
                     # 表示该字段为不是关联字段,但序列化需要存在的字段.
                     (field_name, callback)
                     ]
    :param schema_kwargs: 根据marshmallow.schema.Schema的
                            参数要求进行要求,下面是详细参数列表:
                            extra=None
                            only=()
                            exclude=()
                            prefix=''
                            strict=None
                            many=False
                            context=None
                            load_only=()
                            dump_only=()
                            partial=False
    :return: 返回经过序列化后的数据集。
    """

    class CommonSchema:
        class Meta:
            model = None

    # 绑定类对象
    CommonSchema.Meta.model = _model
    [setattr(CommonSchema, field, callback())
     if callback else setattr(CommonSchema, field, Related())
     for field, callback in related]

    # 混入
    schema_cls = type(
        str('CommonSchema'), (CommonSchema, ModelSchema), {}
    )

    return schema_cls(**schema_kwargs)

目的

针对marshmallow和peewee进行数据库字段整合,便于自动映射、验证和序列化行为。
通过下面的实现,可以简化一些简单的定义工作(复杂的暂时不支持),例如: 验证post
表单参数可以通过指定validate_schema来自动完成检查行为,而不需要去定义
ValidateSchema;序列化peewee查询结果可以通过serializer_schema来自动完成结构
体自动绑定,而不需要去定义serializerSchema结构体。(警告: 目前这两个方法只
支持简单的自动检查和序列化,非常复杂的场景还是需要手动去定义结构体),这里
列出一些使用方法:

验证案例

利用validate_schema对登录页面提交的参数进行验证。
validate_schema的第一个参数 User 是一个models对象,装饰器默认会根据这个User。 对象自动映射和验证全部字段,通过利用only参数可以通知验证器仅验证哪几个字段。除了only参数之外,常用的还有 exclude和many参数。

@route('/login')
class Login(BaseHandler):
    # 装饰器在这里工作
    @validate_schema(User, only=('mobile', 'password'))      
    def post(self):
        # 验证用户名是否存在。

        # 验证密码是否正确。

        # local.storage/cookie/session保存用户信息。
        self.write('ok')

序列化案例:

from marshmallow import pprint
s = (User.select()
     .where(User.id=='1')
     .get())

result, errors = serializer_schema(User).dump(s)
pprint(result)


# 输出结果
{
 'created_at': 'XXX',
 'email': None,
 'id': '1',
 'is_active': True,
 'mobile': 'XXXXXX',
 'name': 'XX',
 'password': 'XXXXXXXXXX'
}

利用only参数来控制数据结果

result, errors = serializer_schema(User, only=('mobile', 'email', 'name')).dump(s)
pprint(result)
# 输出结果
{'email': None, 'mobile': 'XXXXXX', 'name': 'XX'}

利用exclude参数来控制数据结果

result, errors = serializer_schema(User, exclude=('mobile', )).dump(s)
pprint(result)
# 输出结果
{
 'created_at': 'XXX',
 'email': None,
 'id': '1',
 'is_active': True,
 'name': 'XX',
 'password': 'XXXXXXXXXX'
}

一对多关系处理

result, errors = serializer_schema(User, *[('logs', None), ], exclude=('password', )).dump(s)
pprint(result)


# 查看结果
{
 'created_at': 'XX',
 'email': None,
 'id': 1,
 'is_active': True,
 'logs': [{'created_at': 'XX',
           'id': 1,
           'ip': '111',
           'user': 1}],
 'mobile': 'XXXXXX',
 'name': 'XX',
}

多对一关系处理

s = (UserLog.select().where(UserLog.id=='1').get())
pprint(serializer_schema(UserLog, *[('user', None)]).dump(s)[0])
# 查看结果
{'created_at': 'XX',
 'id': 1,
 'ip': '111',
 'user': {
          'created_at': '2017-01-23T11:40:19.534108+00:00',
          'email': None,
          'id': 1,
          'is_active': True,
          'mobile': 'XXXXXX',
          'name': 'XX',
          'password': 'XXXXXXXXXX'}}

未完待续(多对多关系处理)

未完待续(复杂的多表联合处理)

本文转载自:http://www.jianshu.com/p/6e91863008b3

共有 人打赏支持
AllenOR灵感
粉丝 11
博文 2635
码字总数 83001
作品 0
程序员
私信 提问
说一下Python项目中的验参

在积累了一定的工作与项目实战经验后,越来越意识到验参的重要性。 前几天又重读总结了一下【程序员修炼之道】,书中提到,卓有成效的程序员从不相信任何人,包括自己。 关于这句话的一个很重...

古二白
2018/08/19
0
0
CRUD并不易-- --谈微服务中的序列化场景

在上一篇文章中说到了验参,现在接着说另一个微服务中的工程性问题,序列化。 作为编写业务的程序员,常被戏称为CRUD程序写,会增删改查,给个if else给个for就能混碗饭吃。此话倒不假。 在面...

古二白
2018/08/19
0
0
ServiceStack 项目实例 000 简介

ServiceStack 是一个功能齐全的服务开发套件,接近Java下的SSH的结构和思路,整体类似轻量级的SSH,主要是用于REST模式的接口服务的开发,后文中简称SS。 和SS功能相似的框架有WCF、WebAPI,...

鼎六智能
2016/10/02
54
0
揭示汽车制造行业未来,尽在广州自动化展!

广州国际工业自动化及装备展览会 (SIAF) 将于2018年3月4至6日再度于广州中国进出口商品交易会展馆举行。 展会是德国纽伦堡SPS IPC Drives电气自动化展会在亚洲的系列展,也是华南地区大型的工...

行者武松
2018/04/10
0
0
高性能JSON库--commons.json

commons.json 是Java的序列化与反序列化JSON格式的类库,commons.json非常轻量,且性能比Jackson和Gson好,并且支持缓存。 示例: Java Object to JSON: String json = Json.serialize(obje...

元彦
2011/05/23
4.3K
1

没有更多内容

加载失败,请刷新页面

加载更多

安卓constraintLayout中app:srcCompat设置的图片显示不出来

使用 app:srcCompat 的时候 引入的图片显示不出来的解决方案 首先查看的你的Activity 继承的是那个Activity 如果是继承AppcompatActivity 使用 ImageView的 app:srcCompat 是没有问题的 如果...

雨焰
39分钟前
1
0
MySQL mysqldump数据导出详解

MySQL mysqldump数据导出详解 2016-04-07 11:14 by pursuer.chen, 114348 阅读, 0 评论, 收藏, 编辑 介绍 在日常维护工作当中经常会需要对数据进行导出操作,而mysqldump是导出数据过程中使用...

linjin200
40分钟前
0
0
Lucene 检索时的步骤

用户输入查询语句:lucene AND learned NOT hadoop 搜索主要分为以下几步 第一步、对查询语句进行词法分析,语法分析,及语言处理 词法分析主要用来识别单词和关键字 语法分析主要是根据查询...

kdy1994
40分钟前
2
0
Gradle Implementation vs API configuration

注: 可以把 Implementation理解为java类的private, 使用Implementation则外部依赖本库的代码引用不到本库Implementation的代码, 也就是降低依赖树的层级, 这样就可以避免外部代码编译时候, 导...

SuShine
44分钟前
2
0
pdf安卓手机适配以及ie的兼容 以及隐藏掉下载打印按钮的方式

这是我目前遇到pdf方面最多的问题。 在百度上搜了很多答案,结果都是建议使用插件。而目前百度能搜的插件基本上都是有缺陷的。自己测试了很多插件。最后使用了pdf.js这个插件。这个插件目前完...

流年那么伤
50分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部