Django Rest Framework ORJSON Renderer
=====================================
[](https://github.com/brianjbuck/drf_orjson_renderer/actions/workflows/main.yml)
`drf_orjson_renderer` is JSON renderer and parser for Django Rest Framework
using the [orjson](https://github.com/ijl/orjson) library. Backed by
[Rust](https://www.rust-lang.org/), orjson is safe, correct and _fast_. ⚡️
In addition, unlike some performance optimized DRF renderers, It also renders
pretty printed JSON when requests are made via RestFramework's BrowsableAPI.
You get:
- The safety of Rust
- The speed of orjson when requests are made with `Accept: appliation/json` HTTP
header or when requests are made with an unspecified `Accept` header.
- The convenience of formatted output when requested with `Accept: text/html`.
- The ability to pass your own `default` function definition.
## Installation
`pip install drf_orjson_renderer`
You can then set the `ORJSONRenderer` class as your default renderer in your `settings.py`
```Python
REST_FRAMEWORK = {
"DEFAULT_RENDERER_CLASSES": (
"drf_orjson_renderer.renderers.ORJSONRenderer",
"rest_framework.renderers.BrowsableAPIRenderer",
),
}
```
To modify how data is serialized, specify options in your `settings.py`
```Python
REST_FRAMEWORK = {
"ORJSON_RENDERER_OPTIONS": (
orjson.OPT_NON_STR_KEYS,
orjson.OPT_SERIALIZE_DATACLASS,
orjson.OPT_SERIALIZE_NUMPY,
),
}
```
Also you can set the `ORJSONParser` class as your default parser in your `settings.py`
```Python
REST_FRAMEWORK = {
"DEFAULT_PARSER_CLASSES": (
"drf_orjson_renderer.parsers.ORJSONParser",
),
}
```
## Passing Your Own `default` Function
By default, the `ORJSONRenderer` will pass a `default` function as a helper for
serializing objects that orjson doesn't recognize. That should cover the most
common cases found in a Django web application. If you find you have an object
it doesn't recognize you can pass your own default function by overriding the
`get_renderer_context()` method of your view:
```Python
from rest_framework.views import APIView
from rest_framework.response import Response
class MyView(APIView):
def default(self, obj):
if isinstance(obj, MyComplexData):
return dict(obj)
def get_renderer_context(self):
renderer_context = super().get_renderer_context()
renderer_context["default_function"] = self.default
return renderer_context
def get(self, request, *args, **kwargs):
my_complex_data = MyComplexData()
return Response(data=my_complex_data)
```
If you know your data is already in a format orjson natively
[recognizes](https://github.com/ijl/orjson/#types) you can get a small
performance boost by passing `None` to the `renderer_context`:
```Python
def get_renderer_context(self):
renderer_context = super().get_renderer_context()
renderer_context["default_function"] = None
return renderer_context
```
As of ORJSON version 3, 2-space indenting is supported in serialization. In
order to take advantage of the RestFramework Browsable API, when the
requested media type is not `application/json`, the ORJSON renderer will add
`orjson.OPT_INDENT_2` to the options mask to pretty print your output.
## Numpy
When this package was originally written ORJSON did not natively support
serializing numpy types. This package provided an encoder class that
overrides the DjangoJSONEncoder with support for numpy types. This encoder
is no longer necessary but included for backwards compatibility.
```Python
from drf_orjson_renderer.encoders import DjangoNumpyJSONEncoder
from rest_framework.views import APIView
class MyView(APIView):
def get_renderer_context(self):
renderer_context = super().get_renderer_context()
renderer_context["django_encoder_class"] = DjangoNumpyJSONEncoder
return renderer_context
```
## Benchmarks
See the [orjson Benchmarks](https://github.com/ijl/orjson#performance) for more information
Raw data
{
"_id": null,
"home_page": "https://github.com/brianjbuck/drf_orjson_renderer",
"name": "drf-orjson-renderer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": null,
"keywords": "drf_orjson_renderer, rest_framework, orjson",
"author": "brianjbuck",
"author_email": "brian@thebuckpasser.com",
"download_url": "https://files.pythonhosted.org/packages/4d/3e/5cc16467d91087bf883cdbeb52a06f3a6fa59563ad09b9b84bac72d68716/drf_orjson_renderer-1.7.3.tar.gz",
"platform": null,
"description": "Django Rest Framework ORJSON Renderer\n=====================================\n\n[](https://github.com/brianjbuck/drf_orjson_renderer/actions/workflows/main.yml)\n\n`drf_orjson_renderer` is JSON renderer and parser for Django Rest Framework\nusing the [orjson](https://github.com/ijl/orjson) library. Backed by\n[Rust](https://www.rust-lang.org/), orjson is safe, correct and _fast_. \u26a1\ufe0f\n\nIn addition, unlike some performance optimized DRF renderers, It also renders\npretty printed JSON when requests are made via RestFramework's BrowsableAPI.\n\nYou get:\n- The safety of Rust\n- The speed of orjson when requests are made with `Accept: appliation/json` HTTP\n header or when requests are made with an unspecified `Accept` header.\n- The convenience of formatted output when requested with `Accept: text/html`.\n- The ability to pass your own `default` function definition.\n\n\n## Installation\n\n`pip install drf_orjson_renderer`\n\nYou can then set the `ORJSONRenderer` class as your default renderer in your `settings.py`\n\n```Python\nREST_FRAMEWORK = {\n \"DEFAULT_RENDERER_CLASSES\": (\n \"drf_orjson_renderer.renderers.ORJSONRenderer\",\n \"rest_framework.renderers.BrowsableAPIRenderer\",\n ),\n}\n```\nTo modify how data is serialized, specify options in your `settings.py`\n```Python\nREST_FRAMEWORK = {\n \"ORJSON_RENDERER_OPTIONS\": (\n orjson.OPT_NON_STR_KEYS,\n orjson.OPT_SERIALIZE_DATACLASS,\n orjson.OPT_SERIALIZE_NUMPY,\n ),\n}\n```\n\nAlso you can set the `ORJSONParser` class as your default parser in your `settings.py`\n\n```Python\nREST_FRAMEWORK = {\n \"DEFAULT_PARSER_CLASSES\": (\n \"drf_orjson_renderer.parsers.ORJSONParser\",\n ),\n}\n```\n\n## Passing Your Own `default` Function\n\nBy default, the `ORJSONRenderer` will pass a `default` function as a helper for\nserializing objects that orjson doesn't recognize. That should cover the most\ncommon cases found in a Django web application. If you find you have an object\nit doesn't recognize you can pass your own default function by overriding the\n`get_renderer_context()` method of your view:\n\n```Python\nfrom rest_framework.views import APIView\nfrom rest_framework.response import Response\n\n\nclass MyView(APIView):\n def default(self, obj):\n if isinstance(obj, MyComplexData):\n return dict(obj)\n\n def get_renderer_context(self):\n renderer_context = super().get_renderer_context()\n renderer_context[\"default_function\"] = self.default\n return renderer_context\n\n def get(self, request, *args, **kwargs):\n my_complex_data = MyComplexData()\n return Response(data=my_complex_data)\n```\n\nIf you know your data is already in a format orjson natively\n[recognizes](https://github.com/ijl/orjson/#types) you can get a small\nperformance boost by passing `None` to the `renderer_context`:\n\n```Python\ndef get_renderer_context(self):\n renderer_context = super().get_renderer_context()\n renderer_context[\"default_function\"] = None\n return renderer_context\n```\n\nAs of ORJSON version 3, 2-space indenting is supported in serialization. In\norder to take advantage of the RestFramework Browsable API, when the\nrequested media type is not `application/json`, the ORJSON renderer will add\n`orjson.OPT_INDENT_2` to the options mask to pretty print your output.\n\n## Numpy\n\nWhen this package was originally written ORJSON did not natively support\nserializing numpy types. This package provided an encoder class that\noverrides the DjangoJSONEncoder with support for numpy types. This encoder\nis no longer necessary but included for backwards compatibility.\n\n```Python\nfrom drf_orjson_renderer.encoders import DjangoNumpyJSONEncoder\nfrom rest_framework.views import APIView\n\nclass MyView(APIView):\n\n\n def get_renderer_context(self):\n renderer_context = super().get_renderer_context()\n renderer_context[\"django_encoder_class\"] = DjangoNumpyJSONEncoder\n return renderer_context\n```\n\n## Benchmarks\nSee the [orjson Benchmarks](https://github.com/ijl/orjson#performance) for more information\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django RestFramework JSON Renderer Backed by orjson",
"version": "1.7.3",
"project_urls": {
"Homepage": "https://github.com/brianjbuck/drf_orjson_renderer"
},
"split_keywords": [
"drf_orjson_renderer",
" rest_framework",
" orjson"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f8753e1a0e13f1d0247fe97e53619cff72181888a5bac8fd0401e5607c101b6",
"md5": "8e1508208b613003f0ea8098b5c8f168",
"sha256": "9c3fe521b0e8c641b334c40bb81ecadb14519a27599a495d360385abe193a4b4"
},
"downloads": -1,
"filename": "drf_orjson_renderer-1.7.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e1508208b613003f0ea8098b5c8f168",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 7138,
"upload_time": "2024-08-22T02:44:26",
"upload_time_iso_8601": "2024-08-22T02:44:26.124651Z",
"url": "https://files.pythonhosted.org/packages/3f/87/53e1a0e13f1d0247fe97e53619cff72181888a5bac8fd0401e5607c101b6/drf_orjson_renderer-1.7.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d3e5cc16467d91087bf883cdbeb52a06f3a6fa59563ad09b9b84bac72d68716",
"md5": "1a85fc4b7481467d26799dd57ab5fefd",
"sha256": "0c49760fc415df8096c1ef05f029802f2e5862d4e15fe96066289b8c526835f1"
},
"downloads": -1,
"filename": "drf_orjson_renderer-1.7.3.tar.gz",
"has_sig": false,
"md5_digest": "1a85fc4b7481467d26799dd57ab5fefd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 8492,
"upload_time": "2024-08-22T02:44:27",
"upload_time_iso_8601": "2024-08-22T02:44:27.694291Z",
"url": "https://files.pythonhosted.org/packages/4d/3e/5cc16467d91087bf883cdbeb52a06f3a6fa59563ad09b9b84bac72d68716/drf_orjson_renderer-1.7.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 02:44:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brianjbuck",
"github_project": "drf_orjson_renderer",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "drf-orjson-renderer"
}
JSON
