Skip to main content

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

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.4.0 (2014-05-04)

  • Custom target handlers can be defined using the Parser.target_handler decorator.

  • Error handler can be specified using the Parser.error_handler decorator.

  • Args can define their request target by passing in a target argument.

  • Backwards-incompatible: DEFAULT_TARGETS is now a class member of Parser. This allows subclasses to override it.

0.3.4 (2014-04-27)

  • Fix bug that caused use_args to fail on class-based views in Flask.

  • Add allow_missing parameter to Arg.

0.3.3 (2014-03-20)

  • Awesome contributions from the open-source community!

  • Add use_kwargs decorator. Thanks @venuatu.

  • Tornado support thanks to @jvrsantacruz.

  • Tested on Python 3.4.

0.3.2 (2014-03-04)

  • Fix bug with parsing JSON in Flask and Bottle.

0.3.1 (2014-03-03)

  • Remove print statements in core.py. Oops.

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.

Project details


Release history Release notifications | RSS feed

This version

0.4.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webargs-0.4.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

webargs-0.4.0-py2.py3-none-any.whl (14.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file webargs-0.4.0.tar.gz.

File metadata

  • Download URL: webargs-0.4.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for webargs-0.4.0.tar.gz
Algorithm Hash digest
SHA256 ffa9bdea1f2545090e6edd31e42e32c1ef01cb56258a8499658daff99cd67730
MD5 8ae874c9492412e69d5c31da6ab046fa
BLAKE2b-256 75bf74157dd1c3a0716710a0a951c02a44e11fc0fd6b39be44202648d804b163

See more details on using hashes here.

Provenance

File details

Details for the file webargs-0.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for webargs-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4f311c9f58793f081f1a99da15c88bc08aef24dc760b39c4e303bc581b983e2f
MD5 87a65fbc9c10fc3222dea9802d451ba9
BLAKE2b-256 3cd12d081cb3cd86a6a282ebd9daf3aeff52452097bef540b46b9e06b3eeca55

See more details on using hashes here.

Provenance

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