semvec/pypi-packages huggingface dataset:
starlette-json 20.9.18
Custom json serializers for the Starlette web framework.
License: BSD
Requires Python: >=3.6.0
Keywords: starlette json ujson orjson rapidjson

# Starlette Json

## Introduction
Starlette json responses for various json serializers available in the python community.

### Why:
- Remove `ujson` dependency from core starlette package
- Add adaptors for other serializers
- Customize serializer rendering settings

## Requirements
- Python 3.6+
- [Starlette](https://github.com/encode/starlette)

## Installation
```console
$ pip install starlette-json
```

## Optional installs
Install at least one of these:
- [orjson](https://github.com/ijl/orjson) `pip install orjson`
- [Ultrajson](https://github.com/esnme/ultrajson) `pip install ujson`
- [Rapidjson](https://github.com/python-rapidjson/python-rapidjson) `pip install python-rapidjson`
- [SimpleJson](https://github.com/simplejson/simplejson) `pip install simplejson`

## Usage
### Response examples
```python
from starlette.applications import Starlette
from starlette.responses import JSONResponse

from starlette_json import ORJsonResponse, UJsonResponse, RapidJsonResponse, SimpleJsonResponse

app = Starlette()
data = {'Hello': 'World'}

@app.route('/json')
def json(request):
	return JSONResponse(data)

@app.route('/orjson')
def orjson(request):
	return ORJsonResponse(data)

@app.route('/ujson')
def ujson(request):
	return UJsonResponse(data)

@app.route('/rapidjson')
def rapidjson(request):
	return RapidJsonResponse(data)

@app.route('/simplejson')
def rapidjson(request):
	return SimpleJsonResponse(data)
```

### Custom response rendering options:
See the docs for the specific json serializer for available options

```python
from starlette.applications import Starlette
from starlette_json import ORJsonResponse, UJsonResponse, RapidJsonResponse
import orjson

app = Starlette()
data = {'Hello': 'World'}

@app.route('/orjson')
def orjson(request):
	return ORJsonResponse(
		data,
		default=lambda x: str(x),
		option=orjson.OPT_STRICT_INTEGER | orjson.OPT_NAIVE_UTC
	)

@app.route('/ujson')
def ujson(request):
	return UJsonResponse(
		data,
		encode_html_chars=True,
		ensure_ascii=False,
		escape_forward_slashes=False
	)

@app.route('/rapidjson')
def rapidjson(request):
	return RapidJsonResponse(data, sort_keys=True, indent=4)

@app.route('/simplejson')
def rapidjson(request):
	return SimpleJsonResponse(
		data,
		skipkeys=False,
		ensure_ascii=True,
		check_circular=True,
		allow_nan=True
	)
```

### Json request body parsing:
```python
from starlette.applications import Starlette
from starlette_json import ORJsonMiddleware, ORJsonResponse

app = Starlette()

app.add_middleware(ORJsonMiddleware)

@app.route('/orjson')
def orjson(request):
	body = await request.json() # Parsed with orjson
	return ORJsonResponse({'message':'ok'})
```

## Contributing
PRs very welcome.
[CONTRIBUTING.md](CONTRIBUTING.md)

### Todo
- Tests?