Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Parses query args in sanic using type annotations

Project description

Build Status Latest Version Python Support

Sanicargs

Parses query args in Sanic using type annotations.

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_query_args decorator to parse query args and type cast query args and path params with Sanic’s routes or blueprints like in the example below:

import datetime
from sanic import Sanic, response
from sanicargs import parse_query_args

app = Sanic("test_sanic_app")

@app.route("/me/<id>/birthdate", methods=['GET'])
@parse_query_args
async def test_datetime(req, id: str, birthdate: datetime.datetime):
    return response.json({
        'id': id,
        'birthdate': birthdate.isoformat()
    })

if __name__ == "__main__":
  app.run(host="0.0.0.0", port=8080, access_log=False, debug=False)

Test it running with

$ curl 'http://0.0.0.0:8080/me/123/birthdate?birthdate=2017-10-30'

Fields

  • str : ex: ?message=hello world
  • int : ex: ?age=100
  • bool : ex: ?missing=false
  • datetime.datetime : ex: ?currentdate=2017-10-30T10:10:30 or 2017-10-30
  • datetime.date : ex: ?birthdate=2017-10-30
  • List[str] : ex: ?words=you,me,them,we

Important notice about decorators

The sequence of decorators is, as usual, important in Python.

You need to apply the parse_query_args decorator as the first one executed which means closest to the def.

request is mandatory!

You should always have request as the first argument in your function in order to use parse_query_args.

Note that request arg can be renamed and even type-annotated as long as it is the first arg.

History

0.0.1 (2017-01-09)

  • git init

1.0.0(2017-01-12)

  • added test suite
  • added path_param type casting

1.1.0(2018-03-01)

  • request can be renamed and even type-annotated

1.2.0 (2018-03-01)

  • added support for boolean parameters

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sanicargs-1.2.0.tar.gz (5.3 kB) Copy SHA256 hash SHA256 Source None Mar 21, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page