No version for distro dashing. Known supported distros are highlighted in the buttons above.
No version for distro crystal. Known supported distros are highlighted in the buttons above.
No version for distro bouncy. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.

webargs package from webargs repo

webargs

Third-Party Package

This third-party package's source repository does not contain a package manifest. Instead, its package manifest is stored in its release repository. In order to build this package from source in a Catkin workspace, please download its package manifest.

Package Summary

Tags No category tags.
Version 1.5.3
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/sloria/webargs.git
VCS Type git
VCS Version dev
Last Updated 2019-07-15
Dev Status MAINTAINED
Released RELEASED

Package Description

A friendly library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

Additional Links

Maintainers

  • AlexV

Authors

  • Steven Loria

webargs

PyPI version

Build status

Documentation

marshmallow 2/3 compatible

code style: black

Homepage: https://webargs.readthedocs.io/

webargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

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

app = Flask(__name__)

hello_args = {"name": fields.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.7 or >= 3.5.

Documentation

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

Support webargs

webargs is maintained by a group of volunteers. If you\'d like to support the future of the project, please consider contributing to our Open Collective:

Donate to our collective{width="200px"}

Professional Support

Professionally-supported webargs is available through the Tidelift Subscription.

Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional-grade assurances from the experts who know it best, while seamlessly integrating with existing tools. [Get professional support]

Get supported marshmallow with Tidelift

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

License

MIT licensed. See the LICENSE file for more details.

CHANGELOG

Changelog

5.3.2 (2019-06-19)

Bug fixes:

  • marshmallow 3.0.0rc7 compatibility ([395]{role="pr"}).

5.3.1 (2019-05-05)

Bug fixes:

  • marshmallow 3.0.0rc6 compatibility ([384]{role="pr"}).

5.3.0 (2019-04-08)

Features:

  • Add \"path\" location to AIOHTTPParser, FlaskParser, and PyramidParser ([379]{role="pr"}). Thanks [zhenhua32]{role="user"} for the PR.
  • Add webargs.__version_info__.

5.2.0 (2019-03-16)

Features:

  • Make the schema class used when generating a schema from a dict overridable ([375]{role="issue"}). Thanks [ThiefMaster]{role="user"}.

5.1.3 (2019-03-11)

Bug fixes:

  • [CVE-2019-9710]{role="cve"}: Fix race condition between parallel requests when the cache is used ([371]{role="issue"}). Thanks [ThiefMaster]{role="user"} for reporting and fixing.

5.1.2 (2019-02-03)

Bug fixes:

  • Remove lingering usages of ValidationError.status_code ([365]{role="issue"}). Thanks [decaz]{role="user"} for reporting.
  • Avoid AttributeError on Python<3.5.4 ([366]{role="issue"}).
  • Fix incorrect type annotations for error_headers.
  • Fix outdated docs ([367]{role="issue"}). Thanks [alexandersoto]{role="user"} for reporting.

5.1.1.post0 (2019-01-30)

  • Include LICENSE in sdist ([364]{role="issue"}).

5.1.1 (2019-01-28)

Bug fixes:

  • Fix installing simplejson on Python 2 by distributing a Python 2-only wheel ([363]{role="issue"}).

5.1.0 (2019-01-11)

Features:

  • Error handlers for AsyncParser classes may be coroutine functions.
  • Add type annotations to AsyncParser and AIOHTTPParser.

Bug fixes:

  • Fix compatibility with Flask<1.0 ([355]{role="issue"}). Thanks [hoatle]{role="user"} for reporting.
  • Address warning on Python 3.7 about importing from collections.abc.

5.0.0 (2019-01-03)

Features:

  • Backwards-incompatible: A 400 HTTPError is raised when an invalid JSON payload is passed. ([329]{role="issue"}). Thanks [zedrdave]{role="user"} for reporting.

Other changes:

  • Backwards-incompatible: webargs.argmap2schema is removed. Use webargs.dict2schema instead.
  • Backwards-incompatible: webargs.ValidationError is removed. Use marshmallow.ValidationError instead.
# <5.0.0
from webargs import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed", status_code=401)


@use_args({"auth": fields.Field(validate=auth_validator)})
def auth_view(args):
    return jsonify(args)


# >=5.0.0
from marshmallow import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed")


@use_args({"auth": fields.Field(validate=auth_validator)}, error_status_code=401)
def auth_view(args):
    return jsonify(args)

  • Backwards-incompatible: Missing arguments will no longer be filled in when using @use_kwargs ([342,307,252]{role="issue"}). Use **kwargs to account for non-required fields.
# <5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, last_name):
    # last_name is webargs.missing if it's missing from the request
    return {"first_name": first_name}


# >=5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, **kwargs):
    # last_name will not be in kwargs if it's missing from the request
    return {"first_name": first_name}

  • simplejson is now a required dependency on Python 2 ([334]{role="pr"}). This ensures consistency of behavior across Python 2 and 3.

4.4.1 (2018-01-03)

Bug fixes:

  • Remove usages of argmap2schema from fields.Nested, AsyncParser, and PyramidParser.

4.4.0 (2019-01-03)

  • Deprecation: argmap2schema is deprecated in favor of dict2schema ([352]{role="pr"}).

4.3.1 (2018-12-31)

  • Add force_all param to PyramidParser.use_args.
  • Add warning about missing arguments to AsyncParser.

4.3.0 (2018-12-30)

  • Deprecation: Add warning about missing arguments getting added to parsed arguments dictionary ([342]{role="issue"}). This behavior will be removed in version 5.0.0.

4.2.0 (2018-12-27)

Features:

  • Add force_all argument to use_args and use_kwargs ([252]{role="issue"}, [307]{role="issue"}). Thanks [piroux]{role="user"} for reporting.
  • Deprecation: The status_code and headers arguments to ValidationError are deprecated. Pass error_status_code and error_headers to Parser.parse, Parser.use_args, and Parser.use_kwargs instead. ([327]{role="issue"}, [336]{role="issue"}).
  • Custom error handlers receive error_status_code and error_headers arguments. ([327]{role="issue"}).
# <4.2.0
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema):
        # ...
        raise CustomError(error.messages)


# >=4.2.0
@parser.error_handler
def handle_error(error, req, schema, status_code, headers):
    raise CustomError(error.messages)


# OR


@parser.error_handler
def handle_error(error, **kwargs):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema, status_code, headers):
        # ...
        raise CustomError(error.messages)

    # OR

    def handle_error(self, error, req, **kwargs):
        # ...
        raise CustomError(error.messages)

Legacy error handlers will be supported until version 5.0.0.

4.1.3 (2018-12-02)

Bug fixes:

  • Fix bug in AIOHTTParser that prevented calling use_args on the same view function multiple times ([273]{role="issue"}). Thanks to [dnp1]{role="user"} for reporting and [jangelo]{role="user"} for the fix.
  • Fix compatibility with marshmallow 3.0.0rc1 ([330]{role="pr"}).

4.1.2 (2018-11-03)

Bug fixes:

  • Fix serialization behavior of DelimitedList ([319]{role="pr"}). Thanks [lee3164]{role="user"} for the PR.

Other changes:

  • Test against Python 3.7.

4.1.1 (2018-10-25)

Bug fixes:

  • Fix bug in AIOHTTPParser that caused a JSONDecode error when parsing empty payloads ([229]{role="issue"}). Thanks [explosic4]{role="user"} for reporting and thanks user [kochab]{role="user"} for the PR.

4.1.0 (2018-09-17)

Features:

  • Add webargs.testing module, which exposes CommonTestCase to third-party parser libraries (see comments in [287]{role="pr"}).

4.0.0 (2018-07-15)

Features:

  • Backwards-incompatible: Custom error handlers receive the marshmallow.Schema instance as the third argument. Update any functions decorated with Parser.error_handler to take a schema argument, like so:
# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)


# 4.x
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)

See marshmallow-code/marshmallow#840 (comment) for more information about this change.

Bug fixes:

  • Backwards-incompatible: Rename webargs.async to webargs.asyncparser to fix compatibility with Python 3.7 ([240]{role="issue"}). Thanks [Reskov]{role="user"} for the catch and patch.

Other changes:

  • Backwards-incompatible: Drop support for Python 3.4 ([243]{role="pr"}). Python 2.7 and >=3.5 are supported.
  • Backwards-incompatible: Drop support for marshmallow<2.15.0. marshmallow>=2.15.0 and >=3.0.0b12 are officially supported.
  • Use black with pre-commit for code formatting ([244]{role="pr"}).

3.0.2 (2018-07-05)

Bug fixes:

  • Fix compatibility with marshmallow 3.0.0b12 ([242]{role="pr"}). Thanks [lafrech]{role="user"}.

3.0.1 (2018-06-06)

Bug fixes:

  • Respect Parser.DEFAULT_VALIDATION_STATUS when a status_code is not explicitly passed to ValidationError ([180]{role="issue"}). Thanks [foresmac]{role="user"} for finding this.

Support:

  • Add \"Returning HTTP 400 Responses\" section to docs ([180]{role="issue"}).

3.0.0 (2018-05-06)

Changes:

  • Backwards-incompatible: Custom error handlers receive the request object as the second argument. Update any functions decorated with Parser.error_handler to take a req argument, like so:
# 2.x
@parser.error_handler
def handle_error(error):
    raise CustomError(error.messages)


# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)

  • Backwards-incompatible: Remove unused instance and kwargs arguments of argmap2schema.
  • Backwards-incompatible: Remove Parser.load method (Parser now calls Schema.load directly).

These changes shouldn\'t affect most users. However, they might break custom parsers calling these methods. ([222]{role="pr"})

  • Drop support for aiohttp<3.0.0.

2.1.0 (2018-04-01)

Features:

  • Respect data_key field argument (in marshmallow 3). Thanks [lafrech]{role="user"}.

2.0.0 (2018-02-08)

Changes:

  • Drop support for aiohttp<2.0.0.
  • Remove use of deprecated Request.has_body attribute in aiohttpparser ([186]{role="issue"}). Thanks [ariddell]{role="user"} for reporting.

1.10.0 (2018-02-08)

Features:

  • Add support for marshmallow>=3.0.0b7 ([188]{role="pr"}). Thanks [lafrech]{role="user"}.

Deprecations:

  • Support for aiohttp<2.0.0 is deprecated and will be removed in webargs 2.0.0.

1.9.0 (2018-02-03)

Changes:

  • HTTPExceptions raised with webargs.flaskparser.abort will always have the data attribute, even if no additional keywords arguments are passed ([184]{role="pr"}). Thanks [lafrech]{role="user"}.

Support:

  • Fix examples in examples/ directory.

1.8.1 (2017-07-17)

Bug fixes:

  • Fix behavior of AIOHTTPParser.use_args when as_kwargs=True is passed with a Schema ([179]{role="issue"}). Thanks [Itayazolay]{role="user"}.

1.8.0 (2017-07-16)

Features:

  • AIOHTTPParser supports class-based views, i.e. aiohttp.web.View ([177]{role="issue"}). Thanks [daniel98321]{role="user"}.

1.7.0 (2017-06-03)

Features:

  • AIOHTTPParser.use_args and AIOHTTPParser.use_kwargs work with async def coroutines ([170]{role="issue"}). Thanks [zaro]{role="user"}.

1.6.3 (2017-05-18)

Support:

  • Fix Flask error handling docs in \"Framework support\" section ([168]{role="issue"}). Thanks [nebularazer]{role="user"}.

1.6.2 (2017-05-16)

Bug fixes:

  • Fix parsing multiple arguments in AIOHTTParser ([165]{role="issue"}). Thanks [ariddell]{role="user"} for reporting and thanks [zaro]{role="user"} for reporting.

1.6.1 (2017-04-30)

Bug fixes:

  • Fix form parsing in aiohttp>=2.0.0. Thanks [DmitriyS]{role="user"} for the PR.

1.6.0 (2017-03-14)

Bug fixes:

  • Fix compatibility with marshmallow 3.x.

Other changes:

  • Drop support for Python 2.6 and 3.3.
  • Support marshmallow>=2.7.0.

1.5.3 (2017-02-04)

Bug fixes:

  • Port fix from release 1.5.2 to AsyncParser. This fixes [146]{role="issue"} for AIOHTTPParser.
  • Handle invalid types passed to DelimitedList ([149]{role="issue"}). Thanks [psconnect-dev]{role="user"} for reporting.

1.5.2 (2017-01-08)

Bug fixes:

  • Don\'t add marshmallow.missing to original_data when using marshmallow.validates_schema(pass_original=True) ([146]{role="issue"}). Thanks [lafrech]{role="user"} for reporting and for the fix.

Other changes:

  • Test against Python 3.6.

1.5.1 (2016-11-27)

Bug fixes:

  • Fix handling missing nested args when many=True ([120]{role="issue"}, [145]{role="issue"}). Thanks [chavz]{role="user"} and [Bangertm]{role="user"} for reporting.
  • Fix behavior of load_from in AIOHTTPParser.

1.5.0 (2016-11-22)

Features:

  • The use_args and use_kwargs decorators add a reference to the undecorated function via the __wrapped__ attribute. This is useful for unit-testing purposes ([144]{role="issue"}). Thanks [EFF]{role="user"} for the PR.

Bug fixes:

  • If load_from is specified on a field, first check the field name before checking load_from ([118]{role="issue"}). Thanks [jasonab]{role="user"} for reporting.

1.4.0 (2016-09-29)

Bug fixes:

  • Prevent error when rendering validation errors to JSON in Flask (e.g. when using Flask-RESTful) ([122]{role="issue"}). Thanks [frol]{role="user"} for the catch and patch. NOTE: Though this is a bugfix, this is a potentially breaking change for code that needs to access the original ValidationError object.
# Before
@app.errorhandler(422)
def handle_validation_error(err):
    return jsonify({"errors": err.messages}), 422


# After
@app.errorhandler(422)
def handle_validation_error(err):
    # The marshmallow.ValidationError is available on err.exc
    return jsonify({"errors": err.exc.messages}), 422

1.3.4 (2016-06-11)

Bug fixes:

  • Fix bug in parsing form in Falcon>=1.0.

1.3.3 (2016-05-29)

Bug fixes:

  • Fix behavior for nullable List fields ([107]{role="issue"}). Thanks [shaicantor]{role="user"} for reporting.

1.3.2 (2016-04-14)

Bug fixes:

  • Fix passing a schema factory to use_kwargs ([103]{role="issue"}). Thanks [ksesong]{role="user"} for reporting.

1.3.1 (2016-04-13)

Bug fixes:

  • Fix memory leak when calling parser.parse with a dict in a view ([101]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • aiohttpparser: Fix bug in handling bulk-type arguments.

Support:

  • Massive refactor of tests ([98]{role="issue"}).
  • Docs: Fix incorrect use_args example in Tornado section ([100]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • Docs: Add \"Mixing Locations\" section ([90]{role="issue"}). Thanks [tuukkamustonen]{role="user"}.

1.3.0 (2016-04-05)

Features:

  • Add bulk-type arguments support for JSON parsing by passing many=True to a Schema ([81]{role="issue"}). Thanks [frol]{role="user"}.

Bug fixes:

  • Fix JSON parsing in Flask<=0.9.0. Thanks [brettdh]{role="user"} for the PR.
  • Fix behavior of status_code argument to ValidationError ([85]{role="issue"}). This requires marshmallow>=2.7.0. Thanks [ParthGandhi]{role="user"} for reporting.

Support:

  • Docs: Add \"Custom Fields\" section with example of using a Function field ([94]{role="issue"}). Thanks [brettdh]{role="user"} for the suggestion.

1.2.0 (2016-01-04)

Features:

  • Add view_args request location to FlaskParser ([82]{role="issue"}). Thanks [oreza]{role="user"} for the suggestion.

Bug fixes:

  • Use the value of load_from as the key for error messages when it is provided ([83]{role="issue"}). Thanks [immerrr]{role="user"} for the catch and patch.

1.1.1 (2015-11-14)

Bug fixes:

  • aiohttpparser: Fix bug that raised a JSONDecodeError raised when parsing non-JSON requests using default locations ([80]{role="issue"}). Thanks [leonidumanskiy]{role="user"} for reporting.
  • Fix parsing JSON requests that have a vendor media type, e.g. application/vnd.api+json.

1.1.0 (2015-11-08)

Features:

  • Parser.parse, Parser.use_args and Parser.use_kwargs can take a Schema factory as the first argument ([73]{role="issue"}). Thanks [DamianHeard]{role="user"} for the suggestion and the PR.

Support:

  • Docs: Add \"Custom Parsers\" section with example of parsing nested querystring arguments ([74]{role="issue"}). Thanks [dwieeb]{role="user"}.
  • Docs: Add \"Advanced Usage\" page.

1.0.0 (2015-10-19)

Features:

  • Add AIOHTTPParser ([71]{role="issue"}).
  • Add webargs.async module with AsyncParser.

Bug fixes:

  • If an empty list is passed to a List argument, it will be parsed as an empty list rather than being excluded from the parsed arguments dict ([70]{role="issue"}). Thanks [mTatcher]{role="user"} for catching this.

Other changes:

  • Backwards-incompatible: When decorating resource methods with FalconParser.use_args, the parsed arguments dictionary will be positioned after the request and response arguments.
  • Backwards-incompatible: When decorating views with DjangoParser.use_args, the parsed arguments dictionary will be positioned after the request argument.
  • Backwards-incompatible: Parser.get_request_from_view_args gets passed a view function as its first argument.
  • Backwards-incompatible: Remove logging from default error handlers.

0.18.0 (2015-10-04)

Features:

  • Add FalconParser ([63]{role="issue"}).
  • Add fields.DelimitedList ([66]{role="issue"}). Thanks [jmcarp]{role="user"}.
  • TornadoParser will parse json with simplejson if it is installed.
  • BottleParser caches parsed json per-request for improved performance.

No breaking changes. Yay!

0.17.0 (2015-09-29)

Features:

  • TornadoParser returns unicode strings rather than bytestrings ([41]{role="issue"}). Thanks [thomasboyt]{role="user"} for the suggestion.
  • Add Parser.get_default_request and Parser.get_request_from_view_args hooks to simplify Parser implementations.
  • Backwards-compatible: webargs.core.get_value takes a Field as its last argument. Note: this is technically a breaking change, but this won\'t affect most users since get_value is only used internally by Parser classes.

Support:

  • Add examples/annotations_example.py (demonstrates using Python 3 function annotations to define request arguments).
  • Fix examples. Thanks [hyunchel]{role="user"} for catching an error in the Flask error handling docs.

Bug fixes:

  • Correctly pass validate and force_all params to PyramidParser.use_args.

0.16.0 (2015-09-27)

The major change in this release is that webargs now depends on marshmallow for defining arguments and validation.

Your code will need to be updated to use Fields rather than Args.

# Old API
from webargs import Arg

args = {
    "name": Arg(str, required=True),
    "password": Arg(str, validate=lambda p: len(p) >= 6),
    "display_per_page": Arg(int, default=10),
    "nickname": Arg(multiple=True),
    "Content-Type": Arg(dest="content_type", location="headers"),
    "location": Arg({"city": Arg(str), "state": Arg(str)}),
    "meta": Arg(dict),
}

# New API
from webargs import fields

args = {
    "name": fields.Str(required=True),
    "password": fields.Str(validate=lambda p: len(p) >= 6),
    "display_per_page": fields.Int(missing=10),
    "nickname": fields.List(fields.Str()),
    "content_type": fields.Str(load_from="Content-Type"),
    "location": fields.Nested({"city": fields.Str(), "state": fields.Str()}),
    "meta": fields.Dict(),
}

Features:

  • Error messages for all arguments are \"bundled\" ([58]{role="issue"}).

Changes:

  • Backwards-incompatible: Replace Args with marshmallow fields ([61]{role="issue"}).
  • Backwards-incompatible: When using use_kwargs, missing arguments will have the special value missing rather than None.
  • TornadoParser raises a custom HTTPError with a messages attribute when validation fails.

Bug fixes:

  • Fix required validation of nested arguments ([39]{role="issue"}, [51]{role="issue"}). These are fixed by virtue of using marshmallow\'s Nested field. Thanks [ewang]{role="user"} and [chavz]{role="user"} for reporting.

Support:

  • Updated docs.
  • Add examples/schema_example.py.
  • Tested against Python 3.5.

0.15.0 (2015-08-22)

Changes:

  • If a parsed argument is None, the type conversion function is not called [54]{role="issue"}. Thanks [marcellarius]{role="user"}.

Bug fixes:

  • Fix parsing nested Args when the argument is missing from the input ([52]{role="issue"}). Thanks [stas]{role="user"}.

0.14.0 (2015-06-28)

Features:

  • Add parsing of matchdict to PyramidParser. Thanks [hartror]{role="user"}.

Bug fixes:

  • Fix PyramidParser's use_kwargs method ([42]{role="issue"}). Thanks [hartror]{role="user"} for the catch and patch.
  • Correctly use locations passed to Parser\'s constructor when using use_args ([44]{role="issue"}). Thanks [jacebrowning]{role="user"} for the catch and patch.
  • Fix behavior of default and dest argument on nested Args ([40]{role="issue"} and [46]{role="issue"}). Thanks [stas]{role="user"}.

Changes:

  • A 422 response is returned to the client when a ValidationError is raised by a parser ([38]{role="issue"}).

0.13.0 (2015-04-05)

Features:

  • Support for webapp2 via the webargs.webapp2parser module. Thanks [Trii]{role="user"}.
  • Store argument name on RequiredArgMissingError. Thanks [stas]{role="user"}.
  • Allow error messages for required validation to be overriden. Thanks again [stas]{role="user"}.

Removals:

  • Remove source parameter from Arg.

0.12.0 (2015-03-22)

Features:

  • Store argument name on ValidationError ([32]{role="issue"}). Thanks [alexmic]{role="user"} for the suggestion. Thanks [stas]{role="user"} for the patch.
  • Allow nesting of dict subtypes.

0.11.0 (2015-03-01)

Changes:

  • Add dest parameter to Arg constructor which determines the key to be added to the parsed arguments dictionary ([32]{role="issue"}).
  • Backwards-incompatible: Rename targets parameter to locations in Parser constructor, Parser#parse_arg, Parser#parse, Parser#use_args, and Parser#use_kwargs.
  • Backwards-incompatible: Rename Parser#target_handler to Parser#location_handler.

Deprecation:

  • The source parameter is deprecated in favor of the dest parameter.

Bug fixes:

  • Fix validate parameter of DjangoParser#use_args.

0.10.0 (2014-12-23)

  • When parsing a nested Arg, filter out extra arguments that are not part of the Arg's nested dict ([28]{role="issue"}). Thanks Derrick Gilland for the suggestion.
  • Fix bug in parsing Args with both type coercion and multiple=True ([30]{role="issue"}). Thanks Steven Manuatu for reporting.
  • Raise RequiredArgMissingError when a required argument is missing on a request.

0.9.1 (2014-12-11)

  • Fix behavior of multiple=True when nesting Args ([29]{role="issue"}). Thanks Derrick Gilland for reporting.

0.9.0 (2014-12-08)

  • Pyramid support thanks to \@philtay.
  • User-friendly error messages when Arg type conversion/validation fails. Thanks Andriy Yurchuk.
  • Allow use argument to be a list of functions.
  • Allow Args to be nested within each other, e.g. for nested dict validation. Thanks \@saritasa for the suggestion.
  • Backwards-incompatible: Parser will only pass ValidationErrors to its error handler function, rather than catching all generic Exceptions.
  • Backwards-incompatible: Rename Parser.TARGET_MAP to Parser.__target_map__.
  • Add a short-lived cache to the Parser class that can be used to store processed request data for reuse.
  • Docs: Add example usage with Flask-RESTful.

0.8.1 (2014-10-28)

  • Fix bug in TornadoParser that raised an error when request body is not a string (e.g when it is a Future). Thanks Josh Carp.

0.8.0 (2014-10-26)

  • Fix Parser.use_kwargs behavior when an Arg is allowed missing. The allow_missing attribute is ignored when use_kwargs is called.
  • default may be a callable.
  • Allow ValidationError to specify a HTTP status code for the error response.
  • Improved error logging.
  • Add 'query' as a valid target name.
  • Allow a list of validators to be passed to an Arg or Parser.parse.
  • A more useful __repr__ for Arg.
  • Add examples and updated docs.

0.7.0 (2014-10-18)

  • Add source parameter to Arg constructor. Allows renaming of keys in the parsed arguments dictionary. Thanks Josh Carp.
  • FlaskParser's handle_error method attaches the string representation of validation errors on err.data['message']. The raised exception is stored on err.data['exc'].
  • Additional keyword arguments passed to Arg are stored as metadata.

0.6.2 (2014-10-05)

  • Fix bug in TornadoParser's handle_error method. Thanks Josh Carp.
  • Add error parameter to Parser constructor that allows a custom error message to be used if schema-level validation fails.
  • Fix bug that raised a UnicodeEncodeError on Python 2 when an Arg\'s validator function received non-ASCII input.

0.6.1 (2014-09-28)

  • Fix regression with parsing an Arg with both default and target set (see issue #11).

0.6.0 (2014-09-23)

  • Add validate parameter to Parser.parse and Parser.use_args. Allows validation of the full parsed output.
  • If allow_missing is True on an Arg for which None is explicitly passed, the value will still be present in the parsed arguments dictionary.
  • Backwards-incompatible: Parser's parse_* methods return webargs.core.Missing if the value cannot be found on the request. NOTE: webargs.core.Missing will not show up in the final output of Parser.parse.
  • Fix bug with parsing empty request bodies with TornadoParser.

0.5.1 (2014-08-30)

  • Fix behavior of Arg's allow_missing parameter when multiple=True.
  • Fix bug in tornadoparser that caused parsing JSON arguments to fail.

0.5.0 (2014-07-27)

  • Fix JSON parsing in Flask parser when Content-Type header contains more than just application/json. Thanks Samir Uppaluru for reporting.
  • Backwards-incompatible: The use parameter to Arg is called before type conversion occurs. Thanks Eric Wang for the suggestion.
  • Tested on Tornado>=4.0.

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.

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged webargs at answers.ros.org

No version for distro ardent. Known supported distros are highlighted in the buttons above.
No version for distro lunar. Known supported distros are highlighted in the buttons above.

webargs package from webargs repo

webargs

Third-Party Package

This third-party package's source repository does not contain a package manifest. Instead, its package manifest is stored in its release repository. In order to build this package from source in a Catkin workspace, please download its package manifest.

Package Summary

Tags No category tags.
Version 1.3.4
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/sloria/webargs.git
VCS Type git
VCS Version dev
Last Updated 2019-07-15
Dev Status MAINTAINED
Released RELEASED

Package Description

A friendly library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

Additional Links

Maintainers

  • AlexV

Authors

  • Steven Loria

webargs

PyPI version

Build status

Documentation

marshmallow 2/3 compatible

code style: black

Homepage: https://webargs.readthedocs.io/

webargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

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

app = Flask(__name__)

hello_args = {"name": fields.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.7 or >= 3.5.

Documentation

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

Support webargs

webargs is maintained by a group of volunteers. If you\'d like to support the future of the project, please consider contributing to our Open Collective:

Donate to our collective{width="200px"}

Professional Support

Professionally-supported webargs is available through the Tidelift Subscription.

Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional-grade assurances from the experts who know it best, while seamlessly integrating with existing tools. [Get professional support]

Get supported marshmallow with Tidelift

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

License

MIT licensed. See the LICENSE file for more details.

CHANGELOG

Changelog

5.3.2 (2019-06-19)

Bug fixes:

  • marshmallow 3.0.0rc7 compatibility ([395]{role="pr"}).

5.3.1 (2019-05-05)

Bug fixes:

  • marshmallow 3.0.0rc6 compatibility ([384]{role="pr"}).

5.3.0 (2019-04-08)

Features:

  • Add \"path\" location to AIOHTTPParser, FlaskParser, and PyramidParser ([379]{role="pr"}). Thanks [zhenhua32]{role="user"} for the PR.
  • Add webargs.__version_info__.

5.2.0 (2019-03-16)

Features:

  • Make the schema class used when generating a schema from a dict overridable ([375]{role="issue"}). Thanks [ThiefMaster]{role="user"}.

5.1.3 (2019-03-11)

Bug fixes:

  • [CVE-2019-9710]{role="cve"}: Fix race condition between parallel requests when the cache is used ([371]{role="issue"}). Thanks [ThiefMaster]{role="user"} for reporting and fixing.

5.1.2 (2019-02-03)

Bug fixes:

  • Remove lingering usages of ValidationError.status_code ([365]{role="issue"}). Thanks [decaz]{role="user"} for reporting.
  • Avoid AttributeError on Python<3.5.4 ([366]{role="issue"}).
  • Fix incorrect type annotations for error_headers.
  • Fix outdated docs ([367]{role="issue"}). Thanks [alexandersoto]{role="user"} for reporting.

5.1.1.post0 (2019-01-30)

  • Include LICENSE in sdist ([364]{role="issue"}).

5.1.1 (2019-01-28)

Bug fixes:

  • Fix installing simplejson on Python 2 by distributing a Python 2-only wheel ([363]{role="issue"}).

5.1.0 (2019-01-11)

Features:

  • Error handlers for AsyncParser classes may be coroutine functions.
  • Add type annotations to AsyncParser and AIOHTTPParser.

Bug fixes:

  • Fix compatibility with Flask<1.0 ([355]{role="issue"}). Thanks [hoatle]{role="user"} for reporting.
  • Address warning on Python 3.7 about importing from collections.abc.

5.0.0 (2019-01-03)

Features:

  • Backwards-incompatible: A 400 HTTPError is raised when an invalid JSON payload is passed. ([329]{role="issue"}). Thanks [zedrdave]{role="user"} for reporting.

Other changes:

  • Backwards-incompatible: webargs.argmap2schema is removed. Use webargs.dict2schema instead.
  • Backwards-incompatible: webargs.ValidationError is removed. Use marshmallow.ValidationError instead.
# <5.0.0
from webargs import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed", status_code=401)


@use_args({"auth": fields.Field(validate=auth_validator)})
def auth_view(args):
    return jsonify(args)


# >=5.0.0
from marshmallow import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed")


@use_args({"auth": fields.Field(validate=auth_validator)}, error_status_code=401)
def auth_view(args):
    return jsonify(args)

  • Backwards-incompatible: Missing arguments will no longer be filled in when using @use_kwargs ([342,307,252]{role="issue"}). Use **kwargs to account for non-required fields.
# <5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, last_name):
    # last_name is webargs.missing if it's missing from the request
    return {"first_name": first_name}


# >=5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, **kwargs):
    # last_name will not be in kwargs if it's missing from the request
    return {"first_name": first_name}

  • simplejson is now a required dependency on Python 2 ([334]{role="pr"}). This ensures consistency of behavior across Python 2 and 3.

4.4.1 (2018-01-03)

Bug fixes:

  • Remove usages of argmap2schema from fields.Nested, AsyncParser, and PyramidParser.

4.4.0 (2019-01-03)

  • Deprecation: argmap2schema is deprecated in favor of dict2schema ([352]{role="pr"}).

4.3.1 (2018-12-31)

  • Add force_all param to PyramidParser.use_args.
  • Add warning about missing arguments to AsyncParser.

4.3.0 (2018-12-30)

  • Deprecation: Add warning about missing arguments getting added to parsed arguments dictionary ([342]{role="issue"}). This behavior will be removed in version 5.0.0.

4.2.0 (2018-12-27)

Features:

  • Add force_all argument to use_args and use_kwargs ([252]{role="issue"}, [307]{role="issue"}). Thanks [piroux]{role="user"} for reporting.
  • Deprecation: The status_code and headers arguments to ValidationError are deprecated. Pass error_status_code and error_headers to Parser.parse, Parser.use_args, and Parser.use_kwargs instead. ([327]{role="issue"}, [336]{role="issue"}).
  • Custom error handlers receive error_status_code and error_headers arguments. ([327]{role="issue"}).
# <4.2.0
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema):
        # ...
        raise CustomError(error.messages)


# >=4.2.0
@parser.error_handler
def handle_error(error, req, schema, status_code, headers):
    raise CustomError(error.messages)


# OR


@parser.error_handler
def handle_error(error, **kwargs):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema, status_code, headers):
        # ...
        raise CustomError(error.messages)

    # OR

    def handle_error(self, error, req, **kwargs):
        # ...
        raise CustomError(error.messages)

Legacy error handlers will be supported until version 5.0.0.

4.1.3 (2018-12-02)

Bug fixes:

  • Fix bug in AIOHTTParser that prevented calling use_args on the same view function multiple times ([273]{role="issue"}). Thanks to [dnp1]{role="user"} for reporting and [jangelo]{role="user"} for the fix.
  • Fix compatibility with marshmallow 3.0.0rc1 ([330]{role="pr"}).

4.1.2 (2018-11-03)

Bug fixes:

  • Fix serialization behavior of DelimitedList ([319]{role="pr"}). Thanks [lee3164]{role="user"} for the PR.

Other changes:

  • Test against Python 3.7.

4.1.1 (2018-10-25)

Bug fixes:

  • Fix bug in AIOHTTPParser that caused a JSONDecode error when parsing empty payloads ([229]{role="issue"}). Thanks [explosic4]{role="user"} for reporting and thanks user [kochab]{role="user"} for the PR.

4.1.0 (2018-09-17)

Features:

  • Add webargs.testing module, which exposes CommonTestCase to third-party parser libraries (see comments in [287]{role="pr"}).

4.0.0 (2018-07-15)

Features:

  • Backwards-incompatible: Custom error handlers receive the marshmallow.Schema instance as the third argument. Update any functions decorated with Parser.error_handler to take a schema argument, like so:
# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)


# 4.x
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)

See marshmallow-code/marshmallow#840 (comment) for more information about this change.

Bug fixes:

  • Backwards-incompatible: Rename webargs.async to webargs.asyncparser to fix compatibility with Python 3.7 ([240]{role="issue"}). Thanks [Reskov]{role="user"} for the catch and patch.

Other changes:

  • Backwards-incompatible: Drop support for Python 3.4 ([243]{role="pr"}). Python 2.7 and >=3.5 are supported.
  • Backwards-incompatible: Drop support for marshmallow<2.15.0. marshmallow>=2.15.0 and >=3.0.0b12 are officially supported.
  • Use black with pre-commit for code formatting ([244]{role="pr"}).

3.0.2 (2018-07-05)

Bug fixes:

  • Fix compatibility with marshmallow 3.0.0b12 ([242]{role="pr"}). Thanks [lafrech]{role="user"}.

3.0.1 (2018-06-06)

Bug fixes:

  • Respect Parser.DEFAULT_VALIDATION_STATUS when a status_code is not explicitly passed to ValidationError ([180]{role="issue"}). Thanks [foresmac]{role="user"} for finding this.

Support:

  • Add \"Returning HTTP 400 Responses\" section to docs ([180]{role="issue"}).

3.0.0 (2018-05-06)

Changes:

  • Backwards-incompatible: Custom error handlers receive the request object as the second argument. Update any functions decorated with Parser.error_handler to take a req argument, like so:
# 2.x
@parser.error_handler
def handle_error(error):
    raise CustomError(error.messages)


# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)

  • Backwards-incompatible: Remove unused instance and kwargs arguments of argmap2schema.
  • Backwards-incompatible: Remove Parser.load method (Parser now calls Schema.load directly).

These changes shouldn\'t affect most users. However, they might break custom parsers calling these methods. ([222]{role="pr"})

  • Drop support for aiohttp<3.0.0.

2.1.0 (2018-04-01)

Features:

  • Respect data_key field argument (in marshmallow 3). Thanks [lafrech]{role="user"}.

2.0.0 (2018-02-08)

Changes:

  • Drop support for aiohttp<2.0.0.
  • Remove use of deprecated Request.has_body attribute in aiohttpparser ([186]{role="issue"}). Thanks [ariddell]{role="user"} for reporting.

1.10.0 (2018-02-08)

Features:

  • Add support for marshmallow>=3.0.0b7 ([188]{role="pr"}). Thanks [lafrech]{role="user"}.

Deprecations:

  • Support for aiohttp<2.0.0 is deprecated and will be removed in webargs 2.0.0.

1.9.0 (2018-02-03)

Changes:

  • HTTPExceptions raised with webargs.flaskparser.abort will always have the data attribute, even if no additional keywords arguments are passed ([184]{role="pr"}). Thanks [lafrech]{role="user"}.

Support:

  • Fix examples in examples/ directory.

1.8.1 (2017-07-17)

Bug fixes:

  • Fix behavior of AIOHTTPParser.use_args when as_kwargs=True is passed with a Schema ([179]{role="issue"}). Thanks [Itayazolay]{role="user"}.

1.8.0 (2017-07-16)

Features:

  • AIOHTTPParser supports class-based views, i.e. aiohttp.web.View ([177]{role="issue"}). Thanks [daniel98321]{role="user"}.

1.7.0 (2017-06-03)

Features:

  • AIOHTTPParser.use_args and AIOHTTPParser.use_kwargs work with async def coroutines ([170]{role="issue"}). Thanks [zaro]{role="user"}.

1.6.3 (2017-05-18)

Support:

  • Fix Flask error handling docs in \"Framework support\" section ([168]{role="issue"}). Thanks [nebularazer]{role="user"}.

1.6.2 (2017-05-16)

Bug fixes:

  • Fix parsing multiple arguments in AIOHTTParser ([165]{role="issue"}). Thanks [ariddell]{role="user"} for reporting and thanks [zaro]{role="user"} for reporting.

1.6.1 (2017-04-30)

Bug fixes:

  • Fix form parsing in aiohttp>=2.0.0. Thanks [DmitriyS]{role="user"} for the PR.

1.6.0 (2017-03-14)

Bug fixes:

  • Fix compatibility with marshmallow 3.x.

Other changes:

  • Drop support for Python 2.6 and 3.3.
  • Support marshmallow>=2.7.0.

1.5.3 (2017-02-04)

Bug fixes:

  • Port fix from release 1.5.2 to AsyncParser. This fixes [146]{role="issue"} for AIOHTTPParser.
  • Handle invalid types passed to DelimitedList ([149]{role="issue"}). Thanks [psconnect-dev]{role="user"} for reporting.

1.5.2 (2017-01-08)

Bug fixes:

  • Don\'t add marshmallow.missing to original_data when using marshmallow.validates_schema(pass_original=True) ([146]{role="issue"}). Thanks [lafrech]{role="user"} for reporting and for the fix.

Other changes:

  • Test against Python 3.6.

1.5.1 (2016-11-27)

Bug fixes:

  • Fix handling missing nested args when many=True ([120]{role="issue"}, [145]{role="issue"}). Thanks [chavz]{role="user"} and [Bangertm]{role="user"} for reporting.
  • Fix behavior of load_from in AIOHTTPParser.

1.5.0 (2016-11-22)

Features:

  • The use_args and use_kwargs decorators add a reference to the undecorated function via the __wrapped__ attribute. This is useful for unit-testing purposes ([144]{role="issue"}). Thanks [EFF]{role="user"} for the PR.

Bug fixes:

  • If load_from is specified on a field, first check the field name before checking load_from ([118]{role="issue"}). Thanks [jasonab]{role="user"} for reporting.

1.4.0 (2016-09-29)

Bug fixes:

  • Prevent error when rendering validation errors to JSON in Flask (e.g. when using Flask-RESTful) ([122]{role="issue"}). Thanks [frol]{role="user"} for the catch and patch. NOTE: Though this is a bugfix, this is a potentially breaking change for code that needs to access the original ValidationError object.
# Before
@app.errorhandler(422)
def handle_validation_error(err):
    return jsonify({"errors": err.messages}), 422


# After
@app.errorhandler(422)
def handle_validation_error(err):
    # The marshmallow.ValidationError is available on err.exc
    return jsonify({"errors": err.exc.messages}), 422

1.3.4 (2016-06-11)

Bug fixes:

  • Fix bug in parsing form in Falcon>=1.0.

1.3.3 (2016-05-29)

Bug fixes:

  • Fix behavior for nullable List fields ([107]{role="issue"}). Thanks [shaicantor]{role="user"} for reporting.

1.3.2 (2016-04-14)

Bug fixes:

  • Fix passing a schema factory to use_kwargs ([103]{role="issue"}). Thanks [ksesong]{role="user"} for reporting.

1.3.1 (2016-04-13)

Bug fixes:

  • Fix memory leak when calling parser.parse with a dict in a view ([101]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • aiohttpparser: Fix bug in handling bulk-type arguments.

Support:

  • Massive refactor of tests ([98]{role="issue"}).
  • Docs: Fix incorrect use_args example in Tornado section ([100]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • Docs: Add \"Mixing Locations\" section ([90]{role="issue"}). Thanks [tuukkamustonen]{role="user"}.

1.3.0 (2016-04-05)

Features:

  • Add bulk-type arguments support for JSON parsing by passing many=True to a Schema ([81]{role="issue"}). Thanks [frol]{role="user"}.

Bug fixes:

  • Fix JSON parsing in Flask<=0.9.0. Thanks [brettdh]{role="user"} for the PR.
  • Fix behavior of status_code argument to ValidationError ([85]{role="issue"}). This requires marshmallow>=2.7.0. Thanks [ParthGandhi]{role="user"} for reporting.

Support:

  • Docs: Add \"Custom Fields\" section with example of using a Function field ([94]{role="issue"}). Thanks [brettdh]{role="user"} for the suggestion.

1.2.0 (2016-01-04)

Features:

  • Add view_args request location to FlaskParser ([82]{role="issue"}). Thanks [oreza]{role="user"} for the suggestion.

Bug fixes:

  • Use the value of load_from as the key for error messages when it is provided ([83]{role="issue"}). Thanks [immerrr]{role="user"} for the catch and patch.

1.1.1 (2015-11-14)

Bug fixes:

  • aiohttpparser: Fix bug that raised a JSONDecodeError raised when parsing non-JSON requests using default locations ([80]{role="issue"}). Thanks [leonidumanskiy]{role="user"} for reporting.
  • Fix parsing JSON requests that have a vendor media type, e.g. application/vnd.api+json.

1.1.0 (2015-11-08)

Features:

  • Parser.parse, Parser.use_args and Parser.use_kwargs can take a Schema factory as the first argument ([73]{role="issue"}). Thanks [DamianHeard]{role="user"} for the suggestion and the PR.

Support:

  • Docs: Add \"Custom Parsers\" section with example of parsing nested querystring arguments ([74]{role="issue"}). Thanks [dwieeb]{role="user"}.
  • Docs: Add \"Advanced Usage\" page.

1.0.0 (2015-10-19)

Features:

  • Add AIOHTTPParser ([71]{role="issue"}).
  • Add webargs.async module with AsyncParser.

Bug fixes:

  • If an empty list is passed to a List argument, it will be parsed as an empty list rather than being excluded from the parsed arguments dict ([70]{role="issue"}). Thanks [mTatcher]{role="user"} for catching this.

Other changes:

  • Backwards-incompatible: When decorating resource methods with FalconParser.use_args, the parsed arguments dictionary will be positioned after the request and response arguments.
  • Backwards-incompatible: When decorating views with DjangoParser.use_args, the parsed arguments dictionary will be positioned after the request argument.
  • Backwards-incompatible: Parser.get_request_from_view_args gets passed a view function as its first argument.
  • Backwards-incompatible: Remove logging from default error handlers.

0.18.0 (2015-10-04)

Features:

  • Add FalconParser ([63]{role="issue"}).
  • Add fields.DelimitedList ([66]{role="issue"}). Thanks [jmcarp]{role="user"}.
  • TornadoParser will parse json with simplejson if it is installed.
  • BottleParser caches parsed json per-request for improved performance.

No breaking changes. Yay!

0.17.0 (2015-09-29)

Features:

  • TornadoParser returns unicode strings rather than bytestrings ([41]{role="issue"}). Thanks [thomasboyt]{role="user"} for the suggestion.
  • Add Parser.get_default_request and Parser.get_request_from_view_args hooks to simplify Parser implementations.
  • Backwards-compatible: webargs.core.get_value takes a Field as its last argument. Note: this is technically a breaking change, but this won\'t affect most users since get_value is only used internally by Parser classes.

Support:

  • Add examples/annotations_example.py (demonstrates using Python 3 function annotations to define request arguments).
  • Fix examples. Thanks [hyunchel]{role="user"} for catching an error in the Flask error handling docs.

Bug fixes:

  • Correctly pass validate and force_all params to PyramidParser.use_args.

0.16.0 (2015-09-27)

The major change in this release is that webargs now depends on marshmallow for defining arguments and validation.

Your code will need to be updated to use Fields rather than Args.

# Old API
from webargs import Arg

args = {
    "name": Arg(str, required=True),
    "password": Arg(str, validate=lambda p: len(p) >= 6),
    "display_per_page": Arg(int, default=10),
    "nickname": Arg(multiple=True),
    "Content-Type": Arg(dest="content_type", location="headers"),
    "location": Arg({"city": Arg(str), "state": Arg(str)}),
    "meta": Arg(dict),
}

# New API
from webargs import fields

args = {
    "name": fields.Str(required=True),
    "password": fields.Str(validate=lambda p: len(p) >= 6),
    "display_per_page": fields.Int(missing=10),
    "nickname": fields.List(fields.Str()),
    "content_type": fields.Str(load_from="Content-Type"),
    "location": fields.Nested({"city": fields.Str(), "state": fields.Str()}),
    "meta": fields.Dict(),
}

Features:

  • Error messages for all arguments are \"bundled\" ([58]{role="issue"}).

Changes:

  • Backwards-incompatible: Replace Args with marshmallow fields ([61]{role="issue"}).
  • Backwards-incompatible: When using use_kwargs, missing arguments will have the special value missing rather than None.
  • TornadoParser raises a custom HTTPError with a messages attribute when validation fails.

Bug fixes:

  • Fix required validation of nested arguments ([39]{role="issue"}, [51]{role="issue"}). These are fixed by virtue of using marshmallow\'s Nested field. Thanks [ewang]{role="user"} and [chavz]{role="user"} for reporting.

Support:

  • Updated docs.
  • Add examples/schema_example.py.
  • Tested against Python 3.5.

0.15.0 (2015-08-22)

Changes:

  • If a parsed argument is None, the type conversion function is not called [54]{role="issue"}. Thanks [marcellarius]{role="user"}.

Bug fixes:

  • Fix parsing nested Args when the argument is missing from the input ([52]{role="issue"}). Thanks [stas]{role="user"}.

0.14.0 (2015-06-28)

Features:

  • Add parsing of matchdict to PyramidParser. Thanks [hartror]{role="user"}.

Bug fixes:

  • Fix PyramidParser's use_kwargs method ([42]{role="issue"}). Thanks [hartror]{role="user"} for the catch and patch.
  • Correctly use locations passed to Parser\'s constructor when using use_args ([44]{role="issue"}). Thanks [jacebrowning]{role="user"} for the catch and patch.
  • Fix behavior of default and dest argument on nested Args ([40]{role="issue"} and [46]{role="issue"}). Thanks [stas]{role="user"}.

Changes:

  • A 422 response is returned to the client when a ValidationError is raised by a parser ([38]{role="issue"}).

0.13.0 (2015-04-05)

Features:

  • Support for webapp2 via the webargs.webapp2parser module. Thanks [Trii]{role="user"}.
  • Store argument name on RequiredArgMissingError. Thanks [stas]{role="user"}.
  • Allow error messages for required validation to be overriden. Thanks again [stas]{role="user"}.

Removals:

  • Remove source parameter from Arg.

0.12.0 (2015-03-22)

Features:

  • Store argument name on ValidationError ([32]{role="issue"}). Thanks [alexmic]{role="user"} for the suggestion. Thanks [stas]{role="user"} for the patch.
  • Allow nesting of dict subtypes.

0.11.0 (2015-03-01)

Changes:

  • Add dest parameter to Arg constructor which determines the key to be added to the parsed arguments dictionary ([32]{role="issue"}).
  • Backwards-incompatible: Rename targets parameter to locations in Parser constructor, Parser#parse_arg, Parser#parse, Parser#use_args, and Parser#use_kwargs.
  • Backwards-incompatible: Rename Parser#target_handler to Parser#location_handler.

Deprecation:

  • The source parameter is deprecated in favor of the dest parameter.

Bug fixes:

  • Fix validate parameter of DjangoParser#use_args.

0.10.0 (2014-12-23)

  • When parsing a nested Arg, filter out extra arguments that are not part of the Arg's nested dict ([28]{role="issue"}). Thanks Derrick Gilland for the suggestion.
  • Fix bug in parsing Args with both type coercion and multiple=True ([30]{role="issue"}). Thanks Steven Manuatu for reporting.
  • Raise RequiredArgMissingError when a required argument is missing on a request.

0.9.1 (2014-12-11)

  • Fix behavior of multiple=True when nesting Args ([29]{role="issue"}). Thanks Derrick Gilland for reporting.

0.9.0 (2014-12-08)

  • Pyramid support thanks to \@philtay.
  • User-friendly error messages when Arg type conversion/validation fails. Thanks Andriy Yurchuk.
  • Allow use argument to be a list of functions.
  • Allow Args to be nested within each other, e.g. for nested dict validation. Thanks \@saritasa for the suggestion.
  • Backwards-incompatible: Parser will only pass ValidationErrors to its error handler function, rather than catching all generic Exceptions.
  • Backwards-incompatible: Rename Parser.TARGET_MAP to Parser.__target_map__.
  • Add a short-lived cache to the Parser class that can be used to store processed request data for reuse.
  • Docs: Add example usage with Flask-RESTful.

0.8.1 (2014-10-28)

  • Fix bug in TornadoParser that raised an error when request body is not a string (e.g when it is a Future). Thanks Josh Carp.

0.8.0 (2014-10-26)

  • Fix Parser.use_kwargs behavior when an Arg is allowed missing. The allow_missing attribute is ignored when use_kwargs is called.
  • default may be a callable.
  • Allow ValidationError to specify a HTTP status code for the error response.
  • Improved error logging.
  • Add 'query' as a valid target name.
  • Allow a list of validators to be passed to an Arg or Parser.parse.
  • A more useful __repr__ for Arg.
  • Add examples and updated docs.

0.7.0 (2014-10-18)

  • Add source parameter to Arg constructor. Allows renaming of keys in the parsed arguments dictionary. Thanks Josh Carp.
  • FlaskParser's handle_error method attaches the string representation of validation errors on err.data['message']. The raised exception is stored on err.data['exc'].
  • Additional keyword arguments passed to Arg are stored as metadata.

0.6.2 (2014-10-05)

  • Fix bug in TornadoParser's handle_error method. Thanks Josh Carp.
  • Add error parameter to Parser constructor that allows a custom error message to be used if schema-level validation fails.
  • Fix bug that raised a UnicodeEncodeError on Python 2 when an Arg\'s validator function received non-ASCII input.

0.6.1 (2014-09-28)

  • Fix regression with parsing an Arg with both default and target set (see issue #11).

0.6.0 (2014-09-23)

  • Add validate parameter to Parser.parse and Parser.use_args. Allows validation of the full parsed output.
  • If allow_missing is True on an Arg for which None is explicitly passed, the value will still be present in the parsed arguments dictionary.
  • Backwards-incompatible: Parser's parse_* methods return webargs.core.Missing if the value cannot be found on the request. NOTE: webargs.core.Missing will not show up in the final output of Parser.parse.
  • Fix bug with parsing empty request bodies with TornadoParser.

0.5.1 (2014-08-30)

  • Fix behavior of Arg's allow_missing parameter when multiple=True.
  • Fix bug in tornadoparser that caused parsing JSON arguments to fail.

0.5.0 (2014-07-27)

  • Fix JSON parsing in Flask parser when Content-Type header contains more than just application/json. Thanks Samir Uppaluru for reporting.
  • Backwards-incompatible: The use parameter to Arg is called before type conversion occurs. Thanks Eric Wang for the suggestion.
  • Tested on Tornado>=4.0.

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.

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Dependant Packages

No known dependants.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged webargs at answers.ros.org

webargs package from webargs repo

webargs

Third-Party Package

This third-party package's source repository does not contain a package manifest. Instead, its package manifest is stored in its release repository. In order to build this package from source in a Catkin workspace, please download its package manifest.

Package Summary

Tags No category tags.
Version 1.3.4
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/sloria/webargs.git
VCS Type git
VCS Version dev
Last Updated 2019-07-15
Dev Status MAINTAINED
Released RELEASED

Package Description

A friendly library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

Additional Links

Maintainers

  • AlexV

Authors

  • Steven Loria

webargs

PyPI version

Build status

Documentation

marshmallow 2/3 compatible

code style: black

Homepage: https://webargs.readthedocs.io/

webargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

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

app = Flask(__name__)

hello_args = {"name": fields.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.7 or >= 3.5.

Documentation

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

Support webargs

webargs is maintained by a group of volunteers. If you\'d like to support the future of the project, please consider contributing to our Open Collective:

Donate to our collective{width="200px"}

Professional Support

Professionally-supported webargs is available through the Tidelift Subscription.

Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional-grade assurances from the experts who know it best, while seamlessly integrating with existing tools. [Get professional support]

Get supported marshmallow with Tidelift

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

License

MIT licensed. See the LICENSE file for more details.

CHANGELOG

Changelog

5.3.2 (2019-06-19)

Bug fixes:

  • marshmallow 3.0.0rc7 compatibility ([395]{role="pr"}).

5.3.1 (2019-05-05)

Bug fixes:

  • marshmallow 3.0.0rc6 compatibility ([384]{role="pr"}).

5.3.0 (2019-04-08)

Features:

  • Add \"path\" location to AIOHTTPParser, FlaskParser, and PyramidParser ([379]{role="pr"}). Thanks [zhenhua32]{role="user"} for the PR.
  • Add webargs.__version_info__.

5.2.0 (2019-03-16)

Features:

  • Make the schema class used when generating a schema from a dict overridable ([375]{role="issue"}). Thanks [ThiefMaster]{role="user"}.

5.1.3 (2019-03-11)

Bug fixes:

  • [CVE-2019-9710]{role="cve"}: Fix race condition between parallel requests when the cache is used ([371]{role="issue"}). Thanks [ThiefMaster]{role="user"} for reporting and fixing.

5.1.2 (2019-02-03)

Bug fixes:

  • Remove lingering usages of ValidationError.status_code ([365]{role="issue"}). Thanks [decaz]{role="user"} for reporting.
  • Avoid AttributeError on Python<3.5.4 ([366]{role="issue"}).
  • Fix incorrect type annotations for error_headers.
  • Fix outdated docs ([367]{role="issue"}). Thanks [alexandersoto]{role="user"} for reporting.

5.1.1.post0 (2019-01-30)

  • Include LICENSE in sdist ([364]{role="issue"}).

5.1.1 (2019-01-28)

Bug fixes:

  • Fix installing simplejson on Python 2 by distributing a Python 2-only wheel ([363]{role="issue"}).

5.1.0 (2019-01-11)

Features:

  • Error handlers for AsyncParser classes may be coroutine functions.
  • Add type annotations to AsyncParser and AIOHTTPParser.

Bug fixes:

  • Fix compatibility with Flask<1.0 ([355]{role="issue"}). Thanks [hoatle]{role="user"} for reporting.
  • Address warning on Python 3.7 about importing from collections.abc.

5.0.0 (2019-01-03)

Features:

  • Backwards-incompatible: A 400 HTTPError is raised when an invalid JSON payload is passed. ([329]{role="issue"}). Thanks [zedrdave]{role="user"} for reporting.

Other changes:

  • Backwards-incompatible: webargs.argmap2schema is removed. Use webargs.dict2schema instead.
  • Backwards-incompatible: webargs.ValidationError is removed. Use marshmallow.ValidationError instead.
# <5.0.0
from webargs import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed", status_code=401)


@use_args({"auth": fields.Field(validate=auth_validator)})
def auth_view(args):
    return jsonify(args)


# >=5.0.0
from marshmallow import ValidationError


def auth_validator(value):
    # ...
    raise ValidationError("Authentication failed")


@use_args({"auth": fields.Field(validate=auth_validator)}, error_status_code=401)
def auth_view(args):
    return jsonify(args)

  • Backwards-incompatible: Missing arguments will no longer be filled in when using @use_kwargs ([342,307,252]{role="issue"}). Use **kwargs to account for non-required fields.
# <5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, last_name):
    # last_name is webargs.missing if it's missing from the request
    return {"first_name": first_name}


# >=5.0.0
@use_kwargs(
    {"first_name": fields.Str(required=True), "last_name": fields.Str(required=False)}
)
def myview(first_name, **kwargs):
    # last_name will not be in kwargs if it's missing from the request
    return {"first_name": first_name}

  • simplejson is now a required dependency on Python 2 ([334]{role="pr"}). This ensures consistency of behavior across Python 2 and 3.

4.4.1 (2018-01-03)

Bug fixes:

  • Remove usages of argmap2schema from fields.Nested, AsyncParser, and PyramidParser.

4.4.0 (2019-01-03)

  • Deprecation: argmap2schema is deprecated in favor of dict2schema ([352]{role="pr"}).

4.3.1 (2018-12-31)

  • Add force_all param to PyramidParser.use_args.
  • Add warning about missing arguments to AsyncParser.

4.3.0 (2018-12-30)

  • Deprecation: Add warning about missing arguments getting added to parsed arguments dictionary ([342]{role="issue"}). This behavior will be removed in version 5.0.0.

4.2.0 (2018-12-27)

Features:

  • Add force_all argument to use_args and use_kwargs ([252]{role="issue"}, [307]{role="issue"}). Thanks [piroux]{role="user"} for reporting.
  • Deprecation: The status_code and headers arguments to ValidationError are deprecated. Pass error_status_code and error_headers to Parser.parse, Parser.use_args, and Parser.use_kwargs instead. ([327]{role="issue"}, [336]{role="issue"}).
  • Custom error handlers receive error_status_code and error_headers arguments. ([327]{role="issue"}).
# <4.2.0
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema):
        # ...
        raise CustomError(error.messages)


# >=4.2.0
@parser.error_handler
def handle_error(error, req, schema, status_code, headers):
    raise CustomError(error.messages)


# OR


@parser.error_handler
def handle_error(error, **kwargs):
    raise CustomError(error.messages)


class MyParser(FlaskParser):
    def handle_error(self, error, req, schema, status_code, headers):
        # ...
        raise CustomError(error.messages)

    # OR

    def handle_error(self, error, req, **kwargs):
        # ...
        raise CustomError(error.messages)

Legacy error handlers will be supported until version 5.0.0.

4.1.3 (2018-12-02)

Bug fixes:

  • Fix bug in AIOHTTParser that prevented calling use_args on the same view function multiple times ([273]{role="issue"}). Thanks to [dnp1]{role="user"} for reporting and [jangelo]{role="user"} for the fix.
  • Fix compatibility with marshmallow 3.0.0rc1 ([330]{role="pr"}).

4.1.2 (2018-11-03)

Bug fixes:

  • Fix serialization behavior of DelimitedList ([319]{role="pr"}). Thanks [lee3164]{role="user"} for the PR.

Other changes:

  • Test against Python 3.7.

4.1.1 (2018-10-25)

Bug fixes:

  • Fix bug in AIOHTTPParser that caused a JSONDecode error when parsing empty payloads ([229]{role="issue"}). Thanks [explosic4]{role="user"} for reporting and thanks user [kochab]{role="user"} for the PR.

4.1.0 (2018-09-17)

Features:

  • Add webargs.testing module, which exposes CommonTestCase to third-party parser libraries (see comments in [287]{role="pr"}).

4.0.0 (2018-07-15)

Features:

  • Backwards-incompatible: Custom error handlers receive the marshmallow.Schema instance as the third argument. Update any functions decorated with Parser.error_handler to take a schema argument, like so:
# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)


# 4.x
@parser.error_handler
def handle_error(error, req, schema):
    raise CustomError(error.messages)

See marshmallow-code/marshmallow#840 (comment) for more information about this change.

Bug fixes:

  • Backwards-incompatible: Rename webargs.async to webargs.asyncparser to fix compatibility with Python 3.7 ([240]{role="issue"}). Thanks [Reskov]{role="user"} for the catch and patch.

Other changes:

  • Backwards-incompatible: Drop support for Python 3.4 ([243]{role="pr"}). Python 2.7 and >=3.5 are supported.
  • Backwards-incompatible: Drop support for marshmallow<2.15.0. marshmallow>=2.15.0 and >=3.0.0b12 are officially supported.
  • Use black with pre-commit for code formatting ([244]{role="pr"}).

3.0.2 (2018-07-05)

Bug fixes:

  • Fix compatibility with marshmallow 3.0.0b12 ([242]{role="pr"}). Thanks [lafrech]{role="user"}.

3.0.1 (2018-06-06)

Bug fixes:

  • Respect Parser.DEFAULT_VALIDATION_STATUS when a status_code is not explicitly passed to ValidationError ([180]{role="issue"}). Thanks [foresmac]{role="user"} for finding this.

Support:

  • Add \"Returning HTTP 400 Responses\" section to docs ([180]{role="issue"}).

3.0.0 (2018-05-06)

Changes:

  • Backwards-incompatible: Custom error handlers receive the request object as the second argument. Update any functions decorated with Parser.error_handler to take a req argument, like so:
# 2.x
@parser.error_handler
def handle_error(error):
    raise CustomError(error.messages)


# 3.x
@parser.error_handler
def handle_error(error, req):
    raise CustomError(error.messages)

  • Backwards-incompatible: Remove unused instance and kwargs arguments of argmap2schema.
  • Backwards-incompatible: Remove Parser.load method (Parser now calls Schema.load directly).

These changes shouldn\'t affect most users. However, they might break custom parsers calling these methods. ([222]{role="pr"})

  • Drop support for aiohttp<3.0.0.

2.1.0 (2018-04-01)

Features:

  • Respect data_key field argument (in marshmallow 3). Thanks [lafrech]{role="user"}.

2.0.0 (2018-02-08)

Changes:

  • Drop support for aiohttp<2.0.0.
  • Remove use of deprecated Request.has_body attribute in aiohttpparser ([186]{role="issue"}). Thanks [ariddell]{role="user"} for reporting.

1.10.0 (2018-02-08)

Features:

  • Add support for marshmallow>=3.0.0b7 ([188]{role="pr"}). Thanks [lafrech]{role="user"}.

Deprecations:

  • Support for aiohttp<2.0.0 is deprecated and will be removed in webargs 2.0.0.

1.9.0 (2018-02-03)

Changes:

  • HTTPExceptions raised with webargs.flaskparser.abort will always have the data attribute, even if no additional keywords arguments are passed ([184]{role="pr"}). Thanks [lafrech]{role="user"}.

Support:

  • Fix examples in examples/ directory.

1.8.1 (2017-07-17)

Bug fixes:

  • Fix behavior of AIOHTTPParser.use_args when as_kwargs=True is passed with a Schema ([179]{role="issue"}). Thanks [Itayazolay]{role="user"}.

1.8.0 (2017-07-16)

Features:

  • AIOHTTPParser supports class-based views, i.e. aiohttp.web.View ([177]{role="issue"}). Thanks [daniel98321]{role="user"}.

1.7.0 (2017-06-03)

Features:

  • AIOHTTPParser.use_args and AIOHTTPParser.use_kwargs work with async def coroutines ([170]{role="issue"}). Thanks [zaro]{role="user"}.

1.6.3 (2017-05-18)

Support:

  • Fix Flask error handling docs in \"Framework support\" section ([168]{role="issue"}). Thanks [nebularazer]{role="user"}.

1.6.2 (2017-05-16)

Bug fixes:

  • Fix parsing multiple arguments in AIOHTTParser ([165]{role="issue"}). Thanks [ariddell]{role="user"} for reporting and thanks [zaro]{role="user"} for reporting.

1.6.1 (2017-04-30)

Bug fixes:

  • Fix form parsing in aiohttp>=2.0.0. Thanks [DmitriyS]{role="user"} for the PR.

1.6.0 (2017-03-14)

Bug fixes:

  • Fix compatibility with marshmallow 3.x.

Other changes:

  • Drop support for Python 2.6 and 3.3.
  • Support marshmallow>=2.7.0.

1.5.3 (2017-02-04)

Bug fixes:

  • Port fix from release 1.5.2 to AsyncParser. This fixes [146]{role="issue"} for AIOHTTPParser.
  • Handle invalid types passed to DelimitedList ([149]{role="issue"}). Thanks [psconnect-dev]{role="user"} for reporting.

1.5.2 (2017-01-08)

Bug fixes:

  • Don\'t add marshmallow.missing to original_data when using marshmallow.validates_schema(pass_original=True) ([146]{role="issue"}). Thanks [lafrech]{role="user"} for reporting and for the fix.

Other changes:

  • Test against Python 3.6.

1.5.1 (2016-11-27)

Bug fixes:

  • Fix handling missing nested args when many=True ([120]{role="issue"}, [145]{role="issue"}). Thanks [chavz]{role="user"} and [Bangertm]{role="user"} for reporting.
  • Fix behavior of load_from in AIOHTTPParser.

1.5.0 (2016-11-22)

Features:

  • The use_args and use_kwargs decorators add a reference to the undecorated function via the __wrapped__ attribute. This is useful for unit-testing purposes ([144]{role="issue"}). Thanks [EFF]{role="user"} for the PR.

Bug fixes:

  • If load_from is specified on a field, first check the field name before checking load_from ([118]{role="issue"}). Thanks [jasonab]{role="user"} for reporting.

1.4.0 (2016-09-29)

Bug fixes:

  • Prevent error when rendering validation errors to JSON in Flask (e.g. when using Flask-RESTful) ([122]{role="issue"}). Thanks [frol]{role="user"} for the catch and patch. NOTE: Though this is a bugfix, this is a potentially breaking change for code that needs to access the original ValidationError object.
# Before
@app.errorhandler(422)
def handle_validation_error(err):
    return jsonify({"errors": err.messages}), 422


# After
@app.errorhandler(422)
def handle_validation_error(err):
    # The marshmallow.ValidationError is available on err.exc
    return jsonify({"errors": err.exc.messages}), 422

1.3.4 (2016-06-11)

Bug fixes:

  • Fix bug in parsing form in Falcon>=1.0.

1.3.3 (2016-05-29)

Bug fixes:

  • Fix behavior for nullable List fields ([107]{role="issue"}). Thanks [shaicantor]{role="user"} for reporting.

1.3.2 (2016-04-14)

Bug fixes:

  • Fix passing a schema factory to use_kwargs ([103]{role="issue"}). Thanks [ksesong]{role="user"} for reporting.

1.3.1 (2016-04-13)

Bug fixes:

  • Fix memory leak when calling parser.parse with a dict in a view ([101]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • aiohttpparser: Fix bug in handling bulk-type arguments.

Support:

  • Massive refactor of tests ([98]{role="issue"}).
  • Docs: Fix incorrect use_args example in Tornado section ([100]{role="issue"}). Thanks [frankslaughter]{role="user"} for reporting.
  • Docs: Add \"Mixing Locations\" section ([90]{role="issue"}). Thanks [tuukkamustonen]{role="user"}.

1.3.0 (2016-04-05)

Features:

  • Add bulk-type arguments support for JSON parsing by passing many=True to a Schema ([81]{role="issue"}). Thanks [frol]{role="user"}.

Bug fixes:

  • Fix JSON parsing in Flask<=0.9.0. Thanks [brettdh]{role="user"} for the PR.
  • Fix behavior of status_code argument to ValidationError ([85]{role="issue"}). This requires marshmallow>=2.7.0. Thanks [ParthGandhi]{role="user"} for reporting.

Support:

  • Docs: Add \"Custom Fields\" section with example of using a Function field ([94]{role="issue"}). Thanks [brettdh]{role="user"} for the suggestion.

1.2.0 (2016-01-04)

Features:

  • Add view_args request location to FlaskParser ([82]{role="issue"}). Thanks [oreza]{role="user"} for the suggestion.

Bug fixes:

  • Use the value of load_from as the key for error messages when it is provided ([83]{role="issue"}). Thanks [immerrr]{role="user"} for the catch and patch.

1.1.1 (2015-11-14)

Bug fixes:

  • aiohttpparser: Fix bug that raised a JSONDecodeError raised when parsing non-JSON requests using default locations ([80]{role="issue"}). Thanks [leonidumanskiy]{role="user"} for reporting.
  • Fix parsing JSON requests that have a vendor media type, e.g. application/vnd.api+json.

1.1.0 (2015-11-08)

Features:

  • Parser.parse, Parser.use_args and Parser.use_kwargs can take a Schema factory as the first argument ([73]{role="issue"}). Thanks [DamianHeard]{role="user"} for the suggestion and the PR.

Support:

  • Docs: Add \"Custom Parsers\" section with example of parsing nested querystring arguments ([74]{role="issue"}). Thanks [dwieeb]{role="user"}.
  • Docs: Add \"Advanced Usage\" page.

1.0.0 (2015-10-19)

Features:

  • Add AIOHTTPParser ([71]{role="issue"}).
  • Add webargs.async module with AsyncParser.

Bug fixes:

  • If an empty list is passed to a List argument, it will be parsed as an empty list rather than being excluded from the parsed arguments dict ([70]{role="issue"}). Thanks [mTatcher]{role="user"} for catching this.

Other changes:

  • Backwards-incompatible: When decorating resource methods with FalconParser.use_args, the parsed arguments dictionary will be positioned after the request and response arguments.
  • Backwards-incompatible: When decorating views with DjangoParser.use_args, the parsed arguments dictionary will be positioned after the request argument.
  • Backwards-incompatible: Parser.get_request_from_view_args gets passed a view function as its first argument.
  • Backwards-incompatible: Remove logging from default error handlers.

0.18.0 (2015-10-04)

Features:

  • Add FalconParser ([63]{role="issue"}).
  • Add fields.DelimitedList ([66]{role="issue"}). Thanks [jmcarp]{role="user"}.
  • TornadoParser will parse json with simplejson if it is installed.
  • BottleParser caches parsed json per-request for improved performance.

No breaking changes. Yay!

0.17.0 (2015-09-29)

Features:

  • TornadoParser returns unicode strings rather than bytestrings ([41]{role="issue"}). Thanks [thomasboyt]{role="user"} for the suggestion.
  • Add Parser.get_default_request and Parser.get_request_from_view_args hooks to simplify Parser implementations.
  • Backwards-compatible: webargs.core.get_value takes a Field as its last argument. Note: this is technically a breaking change, but this won\'t affect most users since get_value is only used internally by Parser classes.

Support:

  • Add examples/annotations_example.py (demonstrates using Python 3 function annotations to define request arguments).
  • Fix examples. Thanks [hyunchel]{role="user"} for catching an error in the Flask error handling docs.

Bug fixes:

  • Correctly pass validate and force_all params to PyramidParser.use_args.

0.16.0 (2015-09-27)

The major change in this release is that webargs now depends on marshmallow for defining arguments and validation.

Your code will need to be updated to use Fields rather than Args.

# Old API
from webargs import Arg

args = {
    "name": Arg(str, required=True),
    "password": Arg(str, validate=lambda p: len(p) >= 6),
    "display_per_page": Arg(int, default=10),
    "nickname": Arg(multiple=True),
    "Content-Type": Arg(dest="content_type", location="headers"),
    "location": Arg({"city": Arg(str), "state": Arg(str)}),
    "meta": Arg(dict),
}

# New API
from webargs import fields

args = {
    "name": fields.Str(required=True),
    "password": fields.Str(validate=lambda p: len(p) >= 6),
    "display_per_page": fields.Int(missing=10),
    "nickname": fields.List(fields.Str()),
    "content_type": fields.Str(load_from="Content-Type"),
    "location": fields.Nested({"city": fields.Str(), "state": fields.Str()}),
    "meta": fields.Dict(),
}

Features:

  • Error messages for all arguments are \"bundled\" ([58]{role="issue"}).

Changes:

  • Backwards-incompatible: Replace Args with marshmallow fields ([61]{role="issue"}).
  • Backwards-incompatible: When using use_kwargs, missing arguments will have the special value missing rather than None.
  • TornadoParser raises a custom HTTPError with a messages attribute when validation fails.

Bug fixes:

  • Fix required validation of nested arguments ([39]{role="issue"}, [51]{role="issue"}). These are fixed by virtue of using marshmallow\'s Nested field. Thanks [ewang]{role="user"} and [chavz]{role="user"} for reporting.

Support:

  • Updated docs.
  • Add examples/schema_example.py.
  • Tested against Python 3.5.

0.15.0 (2015-08-22)

Changes:

  • If a parsed argument is None, the type conversion function is not called [54]{role="issue"}. Thanks [marcellarius]{role="user"}.

Bug fixes:

  • Fix parsing nested Args when the argument is missing from the input ([52]{role="issue"}). Thanks [stas]{role="user"}.

0.14.0 (2015-06-28)

Features:

  • Add parsing of matchdict to PyramidParser. Thanks [hartror]{role="user"}.

Bug fixes:

  • Fix PyramidParser's use_kwargs method ([42]{role="issue"}). Thanks [hartror]{role="user"} for the catch and patch.
  • Correctly use locations passed to Parser\'s constructor when using use_args ([44]{role="issue"}). Thanks [jacebrowning]{role="user"} for the catch and patch.
  • Fix behavior of default and dest argument on nested Args ([40]{role="issue"} and [46]{role="issue"}). Thanks [stas]{role="user"}.

Changes:

  • A 422 response is returned to the client when a ValidationError is raised by a parser ([38]{role="issue"}).

0.13.0 (2015-04-05)

Features:

  • Support for webapp2 via the webargs.webapp2parser module. Thanks [Trii]{role="user"}.
  • Store argument name on RequiredArgMissingError. Thanks [stas]{role="user"}.
  • Allow error messages for required validation to be overriden. Thanks again [stas]{role="user"}.

Removals:

  • Remove source parameter from Arg.

0.12.0 (2015-03-22)

Features:

  • Store argument name on ValidationError ([32]{role="issue"}). Thanks [alexmic]{role="user"} for the suggestion. Thanks [stas]{role="user"} for the patch.
  • Allow nesting of dict subtypes.

0.11.0 (2015-03-01)

Changes:

  • Add dest parameter to Arg constructor which determines the key to be added to the parsed arguments dictionary ([32]{role="issue"}).
  • Backwards-incompatible: Rename targets parameter to locations in Parser constructor, Parser#parse_arg, Parser#parse, Parser#use_args, and Parser#use_kwargs.
  • Backwards-incompatible: Rename Parser#target_handler to Parser#location_handler.

Deprecation:

  • The source parameter is deprecated in favor of the dest parameter.

Bug fixes:

  • Fix validate parameter of DjangoParser#use_args.

0.10.0 (2014-12-23)

  • When parsing a nested Arg, filter out extra arguments that are not part of the Arg's nested dict ([28]{role="issue"}). Thanks Derrick Gilland for the suggestion.
  • Fix bug in parsing Args with both type coercion and multiple=True ([30]{role="issue"}). Thanks Steven Manuatu for reporting.
  • Raise RequiredArgMissingError when a required argument is missing on a request.

0.9.1 (2014-12-11)

  • Fix behavior of multiple=True when nesting Args ([29]{role="issue"}). Thanks Derrick Gilland for reporting.

0.9.0 (2014-12-08)

  • Pyramid support thanks to \@philtay.
  • User-friendly error messages when Arg type conversion/validation fails. Thanks Andriy Yurchuk.
  • Allow use argument to be a list of functions.
  • Allow Args to be nested within each other, e.g. for nested dict validation. Thanks \@saritasa for the suggestion.
  • Backwards-incompatible: Parser will only pass ValidationErrors to its error handler function, rather than catching all generic Exceptions.
  • Backwards-incompatible: Rename Parser.TARGET_MAP to Parser.__target_map__.
  • Add a short-lived cache to the Parser class that can be used to store processed request data for reuse.
  • Docs: Add example usage with Flask-RESTful.

0.8.1 (2014-10-28)

  • Fix bug in TornadoParser that raised an error when request body is not a string (e.g when it is a Future). Thanks Josh Carp.

0.8.0 (2014-10-26)

  • Fix Parser.use_kwargs behavior when an Arg is allowed missing. The allow_missing attribute is ignored when use_kwargs is called.
  • default may be a callable.
  • Allow ValidationError to specify a HTTP status code for the error response.
  • Improved error logging.
  • Add 'query' as a valid target name.
  • Allow a list of validators to be passed to an Arg or Parser.parse.
  • A more useful __repr__ for Arg.
  • Add examples and updated docs.

0.7.0 (2014-10-18)

  • Add source parameter to Arg constructor. Allows renaming of keys in the parsed arguments dictionary. Thanks Josh Carp.
  • FlaskParser's handle_error method attaches the string representation of validation errors on err.data['message']. The raised exception is stored on err.data['exc'].
  • Additional keyword arguments passed to Arg are stored as metadata.

0.6.2 (2014-10-05)

  • Fix bug in TornadoParser's handle_error method. Thanks Josh Carp.
  • Add error parameter to Parser constructor that allows a custom error message to be used if schema-level validation fails.
  • Fix bug that raised a UnicodeEncodeError on Python 2 when an Arg\'s validator function received non-ASCII input.

0.6.1 (2014-09-28)

  • Fix regression with parsing an Arg with both default and target set (see issue #11).

0.6.0 (2014-09-23)

  • Add validate parameter to Parser.parse and Parser.use_args. Allows validation of the full parsed output.
  • If allow_missing is True on an Arg for which None is explicitly passed, the value will still be present in the parsed arguments dictionary.
  • Backwards-incompatible: Parser's parse_* methods return webargs.core.Missing if the value cannot be found on the request. NOTE: webargs.core.Missing will not show up in the final output of Parser.parse.
  • Fix bug with parsing empty request bodies with TornadoParser.

0.5.1 (2014-08-30)

  • Fix behavior of Arg's allow_missing parameter when multiple=True.
  • Fix bug in tornadoparser that caused parsing JSON arguments to fail.

0.5.0 (2014-07-27)

  • Fix JSON parsing in Flask parser when Content-Type header contains more than just application/json. Thanks Samir Uppaluru for reporting.
  • Backwards-incompatible: The use parameter to Arg is called before type conversion occurs. Thanks Eric Wang for the suggestion.
  • Tested on Tornado>=4.0.

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.

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Dependant Packages

No known dependants.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged webargs at answers.ros.org

No version for distro hydro. Known supported distros are highlighted in the buttons above.