python服务框架flask,request参数定义

Flask-RESTful官方文档参考：http://www.pythondoc.com/Flask-RESTful/index.html

或者直接看python库的底层代码定义，里面也有文档和安装包的目录链接
Requests官方文档参考：https://requests.readthedocs.io/en/latest/

或者直接看python库的底层代码定义，里面也有文档和安装包的目录链接

Flask是一个Python编写的Web 微框架，让我们可以使用Python语言快速实现一个网站或Web服务，

一. 前言

Flask_RESTful
是一个Flask 扩展，它添加了快速构建 REST APIs 的支持。其请求解析接口是模仿 argparse 接口。它设计成提供简单并且统一的访问 Flask中 flask.request对象里的任何变量的入口。如果不对应设置，就是按字符串的方式取，可以直接配置默认值，就跟启动python程序传参一样的本质。

parser = reqparse.RequestParser()
parser.add_argument('image_id')  # string
parser.add_argument('image')  # string
parser.add_argument('image_type')  # string
parser.add_argument('group_id_list')  # string
parser.add_argument('max_face_num', default=max_face_num, type=int)  # int
parser.add_argument('match_threshold', default=common['simi_thr'], type=int)  # int
parser.add_argument('max_user_num', default=top_k, type=int)  # int

二. 常见类型解析，收到数据后直接转换为python数据类型，所以把参数提前配置好 1. 基本参数

请求

{
  "username": "kuari",
  "info": "heihei"
}

解析

parse = reqparse.RequestParser()
parse.add_argument('username', type = str)
parse.add_argument('info', type = str)
args = parse.parse_args()

2. 必选参数

使用参数required
。

请求

{
  "username": "kuari",
  "info": "heihei"
}

解析

parse = reqparse.RequestParser()
parse.add_argument('username', type = str, required = True)
parse.add_argument('info', type = str, required = True)
args = parse.parse_args()

3. 列表[string]

使用参数action = ‘append’

请求

{
  "username": "kuari",
  "info": [
    "handsome", "cheerful", "optimism"
  ]
}

解析

parse = reqparse.RequestParser()
parse.add_argument('username', type = str, required = True)
parse.add_argument('info', type = str, action = 'append', required = True)
args = parse.parse_args()

4. 列表[dict]

使用参数action = ‘append’

请求

{
  "username": "kuari",
  "friends": [
    {
      "username": "tom",
      "age": 20
    },
    {
      "username": "jerry",
      "age": 20
    }
  ]
}

解析

parse = reqparse.RequestParser()
parse.add_argument('username', type = str, required = True)
parse.add_argument('info', type = dict, action = 'append', required = True)
args = parse.parse_args()

5. JSON，

请求

{
  "username": "kuari",
  "info": {
    "character": "optimism",
    "age": 20
  }
}

解析

parse = reqparse.RequestParser()
parse.add_argument('username', type = str, required = True)
parse.add_argument('info', type = dict, required = True)
args = parse.parse_args()

6. 文件

请求

def ocr_Paddle(root, name):
    # root = 'E:\png'
    # name = '2.png'
    file = os.path.join(root, name)
    files_t = {'file': (name, open(file, 'rb'))}
    headers = {'File-Name': name}

解析

parser = reqparse.RequestParser()
parser.add_argument(
    'file',
    required=False,
    type=FileStorage,
    location='files',
    help="file is wrong.")

三、自带类型 inputs

from flask import Flask,url_for,render_template 
from flask_restful import Api,Resource,reqparse,inputs 

app = Flask(__name__) 

api = Api(app) 

#Flask_RESTful功能之参数验证 
class RegisterView(Resource): 
	def post(self): 
		#用户名 密码 年龄 性别 出生日期 号码 个人主页 
		# 1.创建解析器对象 
		parser = reqparse.RequestParser() 

		#2.利用解析器对象添加 需要验证的参数
		parser.add_argument('uname',type=str,help='用户名验证错误！',required=True,trim=True) 
		parser.add_argument('pwd', type=str, help='密码验证错误！',default="123456") 
		parser.add_argument('age',type=int,help='年龄验证错误！')
		parser.add_argument('gender',type=str,choices=['男','女','双性'])
		parser.add_argument('birthday',type=inputs.date,help='生日字段验证错误！')
		parser.add_argument('phone',type=inputs.regex(r'1[3578]d{9}'))
		parser.add_argument('phomepage',type=inputs.url,help='个人中心链接验证错误！')

		#3.利用解析器对象进行验证
		args = parser.parse_args() 
		print(args) 
		return {"tips":"注册成功"} 

api.add_resource(RegisterView,'/register/') 

@app.route('/') 
def hello_world(): 
	return render_template('index.html') 

if __name__ == '__main__': 
	app.run(debug=True)

四、其他详情定义

一、Flask_RESTful——请求解析
Flask-RESTful 的请求解析接口是模仿 argparse 接口。
它设计成提供简单并且统一的访问 Flask 中 flask.request 对象里的任何变量的入口。

from flask.ext.restful import reqparse

创建参数解析对象，进行请求参数解析

parser = reqparse.RequestParser()

请求携带参数格式

parser.add_argument('rate', type=int, help='Rate cannot be converted')
parser.add_argument('name', type=str)

参数解析完成，获取参数解析数据。

args = parser.parse_args() # 返回结果是一个字典

1、add_argument中选项详解
必须的参数
1、要求一个值传递的参数，只需要添加 required=True 来调用 add_argument()。

parser.add_argument('name', type=str, required=True,help="Name cannot be blank!")

多个值&列表
1、如果你要接受一个键有多个值的话，你可以传入 action=‘append’

parser.add_argument(‘name’, type=str, action=‘append’)
解析替换目标
1、你想要以不同的名称存储你的参数一旦它被解析的时候，你可以使用 dest kwarg。

parser.add_argument('name', type=str, dest='public_name')

args = parser.parse_args()
args['public_name']

指定参数解析的位置
1、默认下，RequestParser 试着从 flask.Request.values，以及 flask.Request.json 解析值。
2、在 add_argument() 中使用 location 参数可以指定解析参数的位置。flask.Request 中任何变量都能被使用。

# Look only in the POST body
parser.add_argument('name', type=int, location='form')

# Look only in the querystring
parser.add_argument('PageSize', type=int, location='args')

# From the request headers
parser.add_argument('User-Agent', type=str, location='headers')

# From http cookies
parser.add_argument('session_id', type=str, location='cookies')

# From file uploads
parser.add_argument('picture', type=werkzeug.datastructures.FileStorage, location='files')

指定多个参数解析的位置
1、通过传入一个列表到 location 中可以指定多个参数位置:

parser.add_argument(‘text’, location=[‘headers’, ‘values’])
1
继承解析
1、编写一个包含所有共享参数的父解析器接着使用 copy() 扩充它。
2、你也可以使用 replace_argument() 覆盖父级的任何参数。
3、或者使用 remove_argument() 完全删除参数。

from flask.ext.restful import RequestParser

parser = RequestParser()
parser.add_argument('foo', type=int)

parser_copy = parser.copy()
parser_copy.add_argument('bar', type=int)

# parser_copy has both 'foo' and 'bar'

parser_copy.replace_argument('foo', type=str, required=True, location='json')
# 'foo' is now a required str located in json, not an int as defined
#  by original parser

parser_copy.remove_argument('foo')
# parser_copy no longer has 'foo' argument

暑期编程PK赛得CSDN机械键盘等精美礼品！

python服务框架flask,request参数定义

Python相关栏目本月热门文章