Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Sanicargs

Parses query parameters and json body parameters for Sanic using type annotations.

Survey

Please fill out this survey if you are using Sanicargs, we are gathering feedback :-)

Install

Install with pip

$ pip install sanicargs

Usage

Use the parse_parameters decorator to parse query parameters (GET) or body parameters (POST) and type cast them together with path params in Sanic's routes or blueprints like in this example below:

importdatetimefromsanicimportSanic, responsefromsanicargsimportparse_parametersapp=Sanic("test_sanic_app")
@app.route("/me/<id>/birthdate", methods=['GET'])@parse_parametersasyncdeftest_datetime(req, id: str, birthdate: datetime.datetime):
returnresponse.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'

Query parameters

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

JSON body parameters

{ "message": "hello word", "age": 100, "missing": false, "currentDate": "2017-10-30", "currentDateTime": "2017-10-30T10:10:30", "words": ["you", "me", "them", "we"] }

Note about datetimes

Dates and datetimes are parsed without timezone information giving you a "naive datetime" object. See the note on datetime.timestamp() about handling timezones if you require epoch format timestamps.

Important notice about decorators

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

You need to apply the parse_parameters 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_parameters.

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

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
sanicargs		sanicargs
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
sanicargs		sanicargs
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
sanicargs		sanicargs
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
sanicargs		sanicargs
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
examples		examples
sanicargs		sanicargs
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
tox.ini		tox.ini

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Sanicargs

Survey

Install

Usage

Query parameters

JSON body parameters

Note about datetimes

Important notice about decorators

request is mandatory!

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Sanicargs

Survey

Install

Usage

Query parameters

JSON body parameters

Note about datetimes

Important notice about decorators

request is mandatory!

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Sanicargs

Survey

Install

Usage

Query parameters

JSON body parameters

Note about datetimes

Important notice about decorators

request is mandatory!

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

`request` is mandatory!

`request` is mandatory!

`request` is mandatory!

`request` is mandatory!

`request` is mandatory!