Serializing Foreign Key objects in Django

by

I had a similar requirement although not for RESTful purposes. I was able to achieve what I needed by using a “full” serializing module, in my case Django Full Serializers. This is part of wadofstuff and is distributed under the new BSD license.

Wadofstuff makes this quite easy. For e.g. in your case you’d need to do the following:

First, install wadofstuff.

Second, add the following setting to your settings.py file:

SERIALIZATION_MODULES = {
    'json': 'wadofstuff.django.serializers.json'
}

Third, make a slight change to the code used for serialization: 

artifact = Artifact.objects.select_related().get(pk=pk)
serializers.serialize( "json", [ artifact ], indent = 4, 
    relations = ('object_type', 'individual',))

The key change is the relations keyword parameter. The only (minor) gotcha is to use the name of the fields forming the relation not the names of the related models.

Caveat

From the documentation:

The Wad of Stuff serializers are 100% compatible with the Django serializers when serializing a model. When deserializing a data stream the the Deserializer class currently only works with serialized data returned by the standard Django serializers.

(Emphasis added)

Hope this helps.

More Related Contents:

  1. Convert Django Model object to dict with all of the fields intact
  2. What’s the difference between select_related and prefetch_related in Django ORM?
  3. Django Aggregation: Summation of Multiplication of two fields
  4. How to create an object for a Django model with a many to many field?
  5. How to execute a GROUP BY … COUNT or SUM in Django ORM?
  6. Django self-referential foreign key
  7. Django orm get latest for each group
  8. LEFT JOIN Django ORM
  9. Django Blob Model Field
  10. Direct assignment to the forward side of a many-to-many set is prohibited. Use emails_for_help.set() instead
  11. How to perform OR condition in django queryset?
  12. What is the default order of a list returned from a Django filter call?
  13. Datetime On Django on models?
  14. What is a “slug” in Django?
  15. How to manage local vs production settings in Django?
  16. Django upgrading to 1.9 error “AppRegistryNotReady: Apps aren’t loaded yet.”
  17. How do I change the range of the x-axis with datetimes in matplotlib?
  18. Django JSONField inside ArrayField
  19. NoReverseMatch with keyword argument uidb64 with Django 2.0
  20. How to expire session due to inactivity in Django?
  21. Django REST Framework serializer field required=false
  22. Django: adding an “Add new” button for a ForeignKey in a ModelForm
  23. Python – Converting XLSX to PDF
  24. How can I disable logging while running unit tests in Python Django?
  25. Format numbers in django templates
  26. How do i cast char to integer while querying in django ORM?
  27. How to find pg_config path
  28. Class Based Views VS Function Based Views
  29. Making moves w/ websockets and python / django ( / twisted? )
  30. Collectstatic error while deploying Django app to Heroku

Leave a Comment