Skip to content
This repository has been archived by the owner on Apr 24, 2018. It is now read-only.

A simple Flask extension for automatically casting the type of query arguments.

Notifications You must be signed in to change notification settings

not-kennethreitz/Flask-Caster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flask-Caster: Cast Types of Flask Query Parameters

This simple Flask extension allows you to cast the type of (and assign defaults to) request query parameters in Flask.

Example Usage

from flask import Flask
from flask_caster import FlaskCaster

app = Flask(__name__)

caster = FlaskCaster(app)
caster.ints = ['size']
caster.booleans = ['json']
caster.always = ['json']

This will do a few things:

  • Assure that the size query parameter is always an integer.
  • Assure that the json query parameter is always an boolean.
  • Assure that the json query parameter is always present, even if if it wasn't provided by the end-user.

Query parameters are accessable via request.args.

Assignable properties include ints, booleans, always, and always_default. The always_default property can be set to any value, or to a callable, which will receive one keyword argument: arg_name.

For boolean casting, 0, false, f, and null will automatically be converted to False.

Installation

$ pip install Flask-Caster

✨🍰✨

About

A simple Flask extension for automatically casting the type of query arguments.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages