I love reqparse from Flask-RESTful for input validation, but I got sick of writing code like this in every endpoint:
parser = reqparse.RequestParser()
parser.add_argument(name='foo', type=int, help='An important foo')
parser.add_argument(name='baz')
args = parser.parse_args()
So I made flask_accepts, which allows you to decorate an endpoint with just the input parameter information and it will internally parse those arguments and attach the results to the Flask request object in request.parsed_args
Here is an example (first pip install flask_accepts)
from flask import Flask, jsonify, request
from flask_accepts import accepts
def create_app(env=None):
app = Flask(__name__)
@app.errorhandler(400)
def error(e):
return jsonify(e.data), 400
@app.route('/test')
@accepts(dict(name='foo', type=int))
def test():
print('foo = ', request.parsed_args.get('foo'))
return 'success'
return app
app = create_app()
print('Example with valid int param foo=3')
with app.test_client() as cl:
resp = cl.get('/test?foo=3')
print('Status: ', resp.status_code)
print('\n==========\n')
print('Example with invalid int param foo="baz"')
with app.test_client() as cl:
resp = cl.get('/test?foo=baz')
print('Status: ', resp.status_code)
print('Content: ', resp.get_json())Output:
Example with valid int param foo=3
foo = 3
Status: 200
==========
Example with invalid int param foo="baz"
Status: 400
Content: {'message': {'foo': "invalid literal for int() with base 10: 'baz'"}}
Both the accepts and responds decorators will accept a keyword argument schemas that
is a Marshmallow Schema.
For accepts, the schema will be used to parse the JSON body
of a request, and the result will be stored in the Flask request object at request.parsed_obj. Note that this input is the class of the schema, not an object of it. The object creation is handled internally. You can use the post_load decorator to control exactly what object is returned when the load method of the schema is called. See here for more information.
For responds, the schema will be used to dump the returned value from the decorated function. Note that this means you should return the object you want to serialize. You need not interact directly with the schema in any way other than passing it in the decorator.
class Widget:
def __init__(self, foo: str, baz: int):
self.foo = foo
self.baz = baz
def __repr__(self):
return f"<Widget(foo='{self.foo}', baz={self.baz})>"
class WidgetSchema(ma.Schema):
foo = ma.String(100)
baz = ma.Integer()
@post_load
def make(self, kwargs):
return Widget(**kwargs)
def create_app(env=None):
app = Flask(__name__)
ma.init_app(app)
@app.errorhandler(400)
def error(e):
return jsonify(e.data), 400
@app.route('/get_a_widget', methods=['GET'])
@responds(schema=WidgetSchema)
def get():
return request.parsed_obj
@app.route('/make_a_widget', methods=['POST'])
@accepts(dict(name='arg', type=int), schema=WidgetSchema)
def post():
print(request.parsed_args)
print(request.parsed_obj)
return jsonify('success')
return app