Skip to main content

Used to verify Flask route Response and Request contents.

Project description


Python package Maintainability Test Coverage Documentation Status

A python package to verify the content of Requests and convert the return values of view functions in Flask applications.


You can install flask_verify

pip install flask_verify


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:

  1. Ensured that the Request is of type application/json and contains keys message and username, 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.
  2. Converted the return type to JSON, message object is an instance of the Message dataclass, thanks to our decorator, the Response will automatically be converted to a JSON containing the field names and values of the dataclass instance.

Read the Docs

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

flask_verify-0.1.2.tar.gz (25.3 kB view hashes)

Uploaded Source

Built Distribution

flask_verify-0.1.2-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page