Peewee model to JSON

Question

I'm creating an API using peewee as the ORM and I need the ability to convert a peewee model object into a JSON object to send to the user. Does anyone know of a good way to do this?

Answer 1

Peewee has a model_to_dict and dict_to_model helpers in the playhouse.shortcuts extension module.

• http://docs.peewee-orm.com/en/latest/peewee/playhouse.html#model_to_dict
• http://docs.peewee-orm.com/en/latest/peewee/playhouse.html#dict_to_model

You could use these as follows:

from playhouse.shortcuts import model_to_dict, dict_to_model

user_obj = User.select().where(User.username == 'charlie').get()
json_data = json.dumps(model_to_dict(user_obj))

Also note that model_to_dict() can recurse through related models, include back-referenced models, and exclude certain fields from being serialized.