Skip to main content

Deal with request params for Flask

Project description

https://raw.githubusercontent.com/Eastwu5788/pre-request/master/docs/static/logo.jpg https://www.travis-ci.org/Eastwu5788/pre-request.svg?branch=master https://coveralls.io/repos/github/Eastwu5788/pre-request/badge.svg?branch=master PyPI - License Documentation Status PyPI Im

欢迎您使用pre-request框架,pre-request致力于简化请求参数验证工作。为Flask的 网络请求参数验证提供了解决方案。

pre-request提供了非常方便的使用的方法,也提供了灵活的扩展接口方便您实现自定义的 业务逻辑。

特点

  1. 验证邮箱、手机号等特殊字段是否符合要求

  2. 格式限制和转换处理,如果类型不符合或者无法转换成需求的类型,则抛出错误

  3. 取值范围限制,显示参数的取值内容的范围

  4. 请求参数为空和默认值处理,如果允许为空则可以设置默认值

  5. 用户可以自定义callback, 自己处理任何参数(callback的调用在所有filter处理之后)

  6. 可以将字段映射为内部使用的字段

安装

pip install pre-request

快速使用

集成pre-request到您的请求中非常简单

from flask import Flask

from pre_request import pre
from pre_request import Rule

app = Flask(__name__)

args = {
   "userId": Rule(type=int, required=True)
}

@app.route("/")
@pre.catch(args)
def hello_world(params):
   from flask import g
   return params == g.params

上面的代码中发生了什么呢?

  1. 首先我们从 pre-request 库中引入全局 pre 对象,使用该对象来过滤用户参数

  2. 我们定义了一个请求参数 userId 并规定该参数的目标类型为 int ,并且不允许为空

  3. 使用 @pre.catch(req_params) 将参数规则赋值给装饰器,并装饰处理函数

  4. 格式化后的参数置于 ~flask.g 中,同时尝试将格式化后的参数置于原函数的 params 参数中。

Rule 规则概览

# 字段目标数据类型
self.direct_type = kwargs.get("type", str)
# 不进行过滤,仅把参数加到结果集中
self.skip = kwargs.get("skip", False)

# 当前字段是否是必填项
self.required = kwargs.get("required", True)
self.required_with = kwargs.get("required_with", None)

# 当前字段默认值,如果不允许为空,则次字段无意义
self.default = kwargs.get("default", None)
# 去除前后的空格
self.trim = kwargs.get("trim", False)

# 字段枚举值设置
self.enum = kwargs.get("enum", list())

# 正则表达式
self.reg = kwargs.get("reg", None)
# Email判断
self.email = kwargs.get("email", False)
# 手机号判断
self.mobile = kwargs.get("mobile", False)

# 判断字符串中包含某个子串
self.contains = kwargs.get("contains", list())
# 判断字符串包含任意子串
self.contains_any = kwargs.get("contains_any", list())
# 判断字符串中禁止包括某个子串
self.excludes = kwargs.get("excludes", list())
# 判断字符串开头
self.startswith = kwargs.get("startswith", None)
# 判断字符串结尾
self.endswith = kwargs.get("endswith", None)
# 字符串小写
self.lower = kwargs.get("lower", False)
# 字符串大写
self.upper = kwargs.get("upper", False)

# 判断入参是否为ipv4/ipv6
self.ipv4 = kwargs.get("ipv4", False)
self.ipv6 = kwargs.get("ipv6", False)
self.mac = kwargs.get("mac", False)

# 判断入参是否为地理坐标 经度/维度
self.latitude = kwargs.get("latitude", False)
self.longitude = kwargs.get("longitude", False)

# 跨字段验证
self.eq_key = kwargs.get("eq_key", None)
self.neq_key = kwargs.get("neq_key", None)
self.gt_key = kwargs.get("gt_key", None)
self.gte_key = kwargs.get("gte_key", None)
self.lt_key = kwargs.get("lt_key", None)
self.lte_key = kwargs.get("lte_key", None)

# 等于/不等于
self.eq = kwargs.get("eq", None)
self.neq = kwargs.get("neq", None)

# 范围限定 direct_type 为数字时限定数字大小,为字符串时限定字符串长度
self.gt = kwargs.get("gt", None)
self.gte = kwargs.get("gte", None)
self.lt = kwargs.get("lt", None)
self.lte = kwargs.get("lte", None)

# key映射
self.key_map = kwargs.get("dest", None)

# 是否需要进行json解析
self.json_load = kwargs.get("json", False)

# 自定义处理callback, 在所有的filter处理完成后,通过callback回调给用户进行自定义处理
self.callback = kwargs.get("callback", None)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pre_request-2.0.7.tar.gz (15.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page