Skip to main content

Simple wrap django views to render json

Project description

Wrap view functions, allowng them render python native and custom objects to json

Usage

Simple wrap returning data into json

from jsonresponse import to_json

@to_json('plain')
def hello(request):
   return dict(hello='world')
GET /hello/
{"hello": "world"}

Result can be wraped in some api manier. Note, you can pass debug=1 to pretty print response. Use JSONRESPONSE_DEFAULT_DEBUG=True to enable by default.

@to_json('api')
def goodbye(request):
   return dict(good='bye')
GET /goodbye/?debug=1
{
    "data": {
        "good": "bye"
    },
    "err": 0
}

Automaticaly error handling, note response code is 500 here

@to_json('api')
def error(request):
   raise Exception('Wooot!??')
GET /error/
{
    "err_class": "Exception",
    "err_desc": "Wooot!??",
    "data": null,
    "err": 1
}

You can pass raise=1 to raise exceptions in debug purposes instead of passing info to json response

GET /error/?raise=1
Traceback (most recent call last):
Exception: Wooot!??

You can pass custom kwargs to json.dumps, just give them to constructor:

@to_json('plain', separators=(',', ':'))
def custom_kwargs(request):
   return ['a', { 'b': 1 }]
GET /
["a",{"b":1}]

You can serialize not only pure python data types. Implement serialize method on toplevel object or each element of toplevel array. Note, that request object is passed to serialize method.

class User(object):
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def serialize(self, request):
        if request.GET.get('with_age', False):
            return dict(name=self.name, age=self.age)
        else:
            return dict(name=self.name)

@to_json('objects')
def users(request):
   return [User('Bob', 10), User('Anna', 12)]
GET /users/?with_age=1
{
    "data": [
        {
            "age": 10,
            "name": "Bob"
        },
        {
            "age": 12,
            "name": "Anna"
        }
    ],
    "err": 0
}

It is easy to use jsonp, just pass format=jsonp

GET /users/?format=jsonp
callback({
    "data": [
        {
            "name": "Bob"
        },
        {
            "name": "Anna"
        }
    ],
    "err": 0
});

You can override the name of callback method using JSONRESPONSE_CALLBACK_NAME option or query arg callback=another_callback

GET /users/?format=jsonp&callback=my_callback
my_callback({
    "data": [
        {
            "name": "Bob"
        },
        {
            "name": "Anna"
        }
    ],
    "err": 0
});

Project details


Download files

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

Files for django-jsonresponse, version 0.10.0
Filename, size File type Python version Upload date Hashes
Filename, size django-jsonresponse-0.10.0.tar.gz (4.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page