custom json encoders in python/tornado

Question

I'm building in tornado (cyclone, actually), and RequestHandler.write is choking on some of my objects. How do I write a JSONencoder for these objects in tornado?

One complication: some of the objects are borrowed from external libraries, so I don't really have access to their constructors.

Apologies for not posting code -- I'm just not sure how to begin here.

score 3 · Answer 1 · answered Nov 01 '13 at 08:38

3

Yes, you can change the default encoder, by adding this befor your mainloop

import json
json._default_encoder = YourJSONEncoder() #patch json

answered Nov 01 '13 at 08:38

Zhuo.M

466
3
18

score 2 · Accepted Answer · answered May 08 '12 at 17:05

2

Basically, the answer is that tornado doesn't support custom json formatting, so you have to use the json library. Here's the code I used in the end:

import json

class MongoEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, ObjectId):
            return str(obj)
        return json.JSONEncoder.default(self, obj)

print json.dumps(my_mong_obj, cls=MongoEncoder, indent=2)

answered May 08 '12 at 17:05

Abe

22,738
26
82
111

Is there a way to hook it up to be the default output for every handler in my application? – tutuca Apr 30 '13 at 18:28
1

@tutuca define it in one python class and import from that python class instead of `import json`. You also may try setting it within the handler object through inheritance. – NuclearPeon Dec 19 '17 at 20:17

score 1 · Answer 3 · answered May 03 '12 at 14:14

1

For datetime object with json formatting it would looks like this

    import json

    dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime) else None
    response = json.dumps(data, ensure_ascii=False, default=dthandler)

answered May 03 '12 at 14:14

Michael_XIII

175
1
14

score 0 · Answer 4 · answered Nov 19 '13 at 10:44

here's my monkey patch:

import json, datetime
from tornado import escape
DT_HANDLER = lambda obj: obj.isoformat() if isinstance(obj, datetime.datetime) or     isinstance(obj, datetime.date) else None
def json_encode(value):
    return json.dumps(value, default=DT_HANDLER).replace("</", "<\/")

escape.json_encode = json_encode

custom json encoders in python/tornado

4 Answers4