Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustpilot/python-sanicargs
Parses query args in Sanic using type annotations
https://github.com/trustpilot/python-sanicargs
public
Last synced: 30 days ago
JSON representation
Parses query args in Sanic using type annotations
- Host: GitHub
- URL: https://github.com/trustpilot/python-sanicargs
- Owner: trustpilot
- License: mit
- Created: 2018-01-11T12:48:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T02:53:31.000Z (8 months ago)
- Last Synced: 2024-04-30T06:40:35.782Z (8 months ago)
- Topics: public
- Language: Python
- Homepage: https://pypi.python.org/pypi/sanicargs
- Size: 154 KB
- Stars: 17
- Watchers: 47
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sanic - Python-Sanicargs
README
[](https://github.com/trustpilot/python-sanicargs/actions/workflows/tox.yaml) [](https://pypi.python.org/pypi/sanicargs) [](https://pypi.python.org/pypi/sanicargs)
# Sanicargs
Parses query parameters and json body parameters for [Sanic](https://github.com/channelcat/sanic) using type annotations.
## Survey
Please fill out [this survey](https://docs.google.com/forms/d/e/1FAIpQLSdNLvB7NEJQhUyVdaZpBAgS0f1k9OywZp8xDqhaNY0rl-unZA/viewform?usp=sf_link) 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](https://github.com/channelcat/sanic)'s routes or blueprints like in this [example](https://github.com/trustpilot/python-sanicargs/tree/master/examples/simple.py) below:
```python
import datetime
from sanic import Sanic, response
from sanicargs import parse_parameters
app = Sanic("test_sanic_app")
@app.route("/me//birthdate", methods=['GET'])
@parse_parameters
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
```bash
$ 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()](https://docs.python.org/3/library/datetime.html#datetime.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.