Skip to main content

flask_verify

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.

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:

  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

Release files for flask_verify 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flask_verify 0.1.2
File Size Uploaded
flask_verify-0.1.2.tar.gz 25.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flask_verify 0.1.2
File Interpreter ABI Platform
flask_verify-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 29.8 kB

Release files / flask_verify-0.1.2.tar.gz

Download URL flask_verify-0.1.2.tar.gz
Size 25.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ac08b3710557b881863d2e129c4c2997ef5563de467364115ee0729686bbbabd
BLAKE2b-256 checksum
How to use checksums
d45a832c3772863eb7a035707d08715e39abb286a68f8aa778598fcf95b47e5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.25.1

Release files / flask_verify-0.1.2-py3-none-any.whl

Download URL flask_verify-0.1.2-py3-none-any.whl
Size 4.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e945dfeb6840d14aec51a5152c90d17755800b92355612ad9139be01753dc0e5
BLAKE2b-256 checksum
How to use checksums
0891b32c540170e1b617557ed6abc929669b3e44ddfe6ec2d58886389a2b511c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.25.1

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page