Skip to content

ekampf/webapp2_restful

Repository files navigation

WebApp2 RequestParser

https://coveralls.io/repos/ekampf/webapp2_restful/badge.svg?branch=master&service=github

The webapp2_restful library is a Request parsing interface inspired by restful-flask's request parser.

Its interface is modeled after the argparse interface.

Its goal is to provide a uniform access to any variable on the webapp2.Request object and allowing handlers to provide a sort of "contract" where they specify the parameters they expect to be called with - making code easier to read and understand.

Basic Argument Parsing

Here’s a simple example of the request parser. It looks for two arguments in the webapp2.Request's json and params properties: one of type int, and the other of type str:

from webapp2_restful.parser import RequestParser

parser = RequestParser()
parser.add_argument('rate', type=int, help='Rate cannot be converted')
parser.add_argument('name', type=str)
args = parser.parse_args(self.request)

Special Google AppEngine Arguments

from webapp2_restful.parser import RequestParser
from webapp2_restful.arguments_ndb import EntityIDArgument

parser = RequestParser()
parser.add_argument('store_id', type=EntityIDArgument(Store), dest='store')
args = parser.parse_args(self.request)

# args.store is a Store instance
print(args.store)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published