Used to verify Flask route Response and Request contents.
Project description
flask_verify
A python package to verify the content of Requests and convert the return values of view functions in Flask applications.
Installation
You can install flask_verify
pip install flask_verify
Example
Consider this minimal example, where Message is a simple dataclass.
from flask_verify.verify_json import verify_json_route
from flask import Flask, request
app = Flask(__name__)
@app.route('/example', methods=['POST'])
@verify_json_route(must_contain=('message', 'username'))
def example_route():
message = Message(request.json['username'], request.json['message'])
return message, 200
Just by writing a single decorator statement, we have:
- Ensured that the
Requestis of typeapplication/jsonand contains keysmessageandusername, if this is not true, our server will respond with a 400 status code Response explaining the issue to the server, including the name of the first missing key if that exists. - Converted the return type to JSON,
messageobject is an instance of theMessagedataclass, thanks to our decorator, the Response will automatically be converted to a JSON containing the field names and values of the dataclass instance.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flask_verify-0.1.2.tar.gz.
File metadata
- Download URL: flask_verify-0.1.2.tar.gz
- Upload date:
- Size: 25.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ac08b3710557b881863d2e129c4c2997ef5563de467364115ee0729686bbbabd
|
|
| MD5 |
b0b4d0b3dc35f86187f30e8cdbbfc774
|
|
| BLAKE2b-256 |
d45a832c3772863eb7a035707d08715e39abb286a68f8aa778598fcf95b47e5c
|
File details
Details for the file flask_verify-0.1.2-py3-none-any.whl.
File metadata
- Download URL: flask_verify-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e945dfeb6840d14aec51a5152c90d17755800b92355612ad9139be01753dc0e5
|
|
| MD5 |
57371eb792f2e5ed090b04d38febf42f
|
|
| BLAKE2b-256 |
0891b32c540170e1b617557ed6abc929669b3e44ddfe6ec2d58886389a2b511c
|