class documentation

class Serializer:

Known subclasses: django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

View In Hierarchy

Abstract serializer base class.
Method end​_object Called when serializing of an object ends.
Method end​_serialization Called when serializing of the queryset ends.
Method getvalue Return the fully serialized queryset (or None if the output stream is not seekable).
Method handle​_field Called to handle each individual (non-relational) field on an object.
Method handle​_fk​_field Called to handle a ForeignKey field.
Method handle​_m2m​_field Called to handle a ManyToManyField.
Method serialize Serialize a queryset.
Method start​_object Called when serializing of an object starts.
Method start​_serialization Called when serializing of the queryset starts.
Class Variable internal​_use​_only Undocumented
Instance Variable first Undocumented
Instance Variable options Undocumented
Instance Variable selected​_fields Undocumented
Instance Variable stream Undocumented
Instance Variable use​_natural​_foreign​_keys Undocumented
Instance Variable use​_natural​_primary​_keys Undocumented
def end_object(self, obj):
Called when serializing of an object ends.
def end_serialization(self):
Called when serializing of the queryset ends.
def getvalue(self):
Return the fully serialized queryset (or None if the output stream is not seekable).
def handle_field(self, obj, field):
Called to handle each individual (non-relational) field on an object.
def handle_fk_field(self, obj, field):
def handle_m2m_field(self, obj, field):
def serialize(self, queryset, *, stream=None, fields=None, use_natural_foreign_keys=False, use_natural_primary_keys=False, progress_output=None, object_count=0, **options):
Serialize a queryset.
def start_object(self, obj):
Called when serializing of an object starts.
def start_serialization(self):
Called when serializing of the queryset starts.
internal_use_only: bool =

Undocumented

first =

Undocumented

options =

Undocumented

selected_fields =
stream =

Undocumented

use_natural_foreign_keys =

Undocumented

use_natural_primary_keys =

Undocumented