Module serializers

django.core.serializers

Interfaces for serializing Django objects.

Usage::

    from django.core import serializers
    json = serializers.serialize("json", some_queryset)
    objects = list(serializers.deserialize("json", json))

To add your own serializers, use the SERIALIZATION_MODULES setting::

    SERIALIZATION_MODULES = {
        "csv": "path.to.csv.serializer",
        "txt": "path.to.txt.serializer",
    }

source link

Classes

class BadSerializer
Stub serializer to hold exception raised during registration

Re-exported Classes

class SerializerDoesNotExist
The requested serializer was not found.
[django.core.serializers.base.SerializerDoesNotExist]

Functions

▶ def deserialize(format, stream_or_string, **options)

Deserialize a stream or a string. Return an iterator that yields ``(obj,

source link

m2m_relation_dict)``, where ``obj`` is an instantiated -- but *unsaved* --
object, and ``m2m_relation_dict`` is a dictionary of ``{m2m_field_name :
list_of_related_objects}``.

▷ def get_deserializer(format)
source link
▷ def get_public_serializer_formats()
source link
▷ def get_serializer(format)
source link
▷ def get_serializer_formats()
source link

▶ def register_serializer(format, serializer_module, serializers=None)

source link

``serializer_module`` should be the fully qualified module name
for the serializer.

If ``serializers`` is provided, the registration will be added
to the provided dictionary.

If ``serializers`` is not provided, the registration will be made
directly into the global register of serializers. Adding serializers
directly is not a thread-safe operation.

▷ def serialize(format, queryset, **options)
Serialize a queryset (or any iterator that returns database objects) using a certain serializer.
source link

▶ def sort_dependencies(app_list, allow_cycles=False)

Sort a list of (app_config, models) pairs into a single list of models.

source link

The single list of models is sorted so that any model with a natural key
is serialized before a normal model, and any model with a natural key
dependency has it's dependencies serialized first.

If allow_cycles is True, return the best-effort ordering that will respect
most of dependencies but ignore some of them to break the cycles.

▷ def unregister_serializer(format)
Unregister a given serializer. This is not a thread-safe operation.
source link

Submodules

Module django.core.serializers.base
Module for abstract serializer/unserializer base classes.
Module django.core.serializers.json
Serialize data to/from JSON
Module django.core.serializers.jsonl
Serialize data to/from JSON Lines
Module django.core.serializers.python
A Python "serializer". Doesn't do much serializing per se -- just converts to and from basic Python data types (lists, dicts, strings, etc.). Useful as a basis for other serializers.
Module django.core.serializers.pyyaml
YAML serializer.
Module django.core.serializers.xml_serializer
XML serializer.