django.core.serializers.base.Serializer

class documentation

class Serializer: (source)

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): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called when serializing of an object ends.

def end_serialization(self): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called when serializing of the queryset ends.

def getvalue(self): (source)
overridden in django.core.serializers.python.Serializer

Return the fully serialized queryset (or None if the output stream is not seekable).

def handle_field(self, obj, field): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called to handle each individual (non-relational) field on an object.

def handle_fk_field(self, obj, field): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called to handle a ForeignKey field.

def handle_m2m_field(self, obj, field): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called to handle a ManyToManyField.

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): (source)

Serialize a queryset.

def start_object(self, obj): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called when serializing of an object starts.

def start_serialization(self): (source)
overridden in django.core.serializers.python.Serializer, django.core.serializers.xml_serializer.Serializer

Called when serializing of the queryset starts.

internal_use_only: bool = (source)
overridden in django.core.serializers.python.Serializer

Undocumented

first = (source)

Undocumented

options = (source)

Undocumented

selected_fields = (source)
overridden in django.contrib.gis.serializers.geojson.Serializer

Undocumented

stream = (source)

Undocumented

use_natural_foreign_keys = (source)

Undocumented

use_natural_primary_keys = (source)

Undocumented