mirror of
https://github.com/not-kennethreitz/Flask-Caster.git
synced 2026-06-05 07:06:12 +00:00
master
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
✨🍰✨
Description
Languages
Python
100%