A utility library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask and Django.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for lafrech from gravatar.com lafrech Avatar for sloria from gravatar.com sloria

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (Copyright 2014 Steven Loria)
  • Author: Steven Loria
  • Tags webargs , http , flask , django , bottle , request , arguments , parameters , rest , api
Classifiers
Report project as malware

Project description

https://badge.fury.io/py/webargs.png https://travis-ci.org/sloria/webargs.png?branch=master

Homepage: https://webargs.readthedocs.org/

Webargs is a Python utility library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask and Django.

from flask import Flask
from webargs import Arg
from webargs.flaskparser import use_args

app = Flask(__name__)

hello_args = {
    'name': Arg(str, required=True)
}

@app.route('/')
@use_args(hello_args)
def index(args):
    return 'Hello ' + args['name']

if __name__ == '__main__':
    app.run()

# curl http://localhost:5000/\?name\='World'
# Hello World

Install

pip install -U webargs

webargs supports Python >= 2.6 or >= 3.3.

Documentation

Full documentation is available at https://webargs.readthedocs.org/.

License

MIT licensed. See the LICENSE file for more details.

Changelog

0.3.0 (2014-03-02)

  • Add support for repeated parameters (#1).

  • Backwards-incompatible: All parse_* methods take arg as their fourth argument.

  • Add error_handler param to Parser.

0.2.0 (2014-02-26)

  • Bottle support.

  • Add targets param to Parser. Allows setting default targets.

  • Add files target.

0.1.0 (2014-02-16)

  • First release.

  • Parses JSON, querystring, forms, headers, and cookies.

  • Support for Flask and Django.

Supported by

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