Skip to main content

Django RestFramework JSON Renderer Backed by orjson

Project description

Django Rest Framework ORJSON Renderer

DRF ORJSON Renderer Tests

drf_orjson_renderer is JSON renderer and parser for Django Rest Framework using the orjson library. Backed by Rust, 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

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

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

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:

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 you can get a small performance boost by passing None to the renderer_context:

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.

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 for more information

Project details


Download files

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

Source Distribution

drf_orjson_renderer-1.7.3.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

drf_orjson_renderer-1.7.3-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file drf_orjson_renderer-1.7.3.tar.gz.

File metadata

  • Download URL: drf_orjson_renderer-1.7.3.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for drf_orjson_renderer-1.7.3.tar.gz
Algorithm Hash digest
SHA256 0c49760fc415df8096c1ef05f029802f2e5862d4e15fe96066289b8c526835f1
MD5 1a85fc4b7481467d26799dd57ab5fefd
BLAKE2b-256 4d3e5cc16467d91087bf883cdbeb52a06f3a6fa59563ad09b9b84bac72d68716

See more details on using hashes here.

File details

Details for the file drf_orjson_renderer-1.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for drf_orjson_renderer-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9c3fe521b0e8c641b334c40bb81ecadb14519a27599a495d360385abe193a4b4
MD5 8e1508208b613003f0ea8098b5c8f168
BLAKE2b-256 3f8753e1a0e13f1d0247fe97e53619cff72181888a5bac8fd0401e5607c101b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page