Как определить сериализацию для пользовательского типа, используемого в качестве значения для пользовательского поля Django

Question

Я сделал свой собственный подкласс models.TextField, который принимает классы в качестве значений и кодирует эти значения в качестве атрибута CODE данного класса в базе данных. Пока все это работает, но я хочу использовать реверсию Django, которая сериализует модели и сохраняет модель в таблице версий каждый раз, когда вносятся изменения. Я использую это для целей аудита в моем приложении.

Reversion не может сериализовать значения, которые я назначаю своему настраиваемому полю, утверждая, что они не сериализуемы. Как мне определить метод сериализации для моих объектов? Я не могу просто определить подкласс DjangoJSONEncoder (класс, который Django использует для сериализации по умолчанию), потому что у меня нет контроля над кодом, вызывающим его метод сериализации, потому что это часть реверсии Django. Это трассировка стека, которая в итоге завершается ошибкой в ​​json-кодере Python по умолчанию:

ERROR: Could not save initial version for AccessCircuitRTTicket 3.
Traceback (most recent call last):
  File "./manage.py", line 12, in <module>
    execute_from_command_line(sys.argv)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 399, in execute_from_command_line
    utility.execute()
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 392, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/management/base.py", line 242, in run_from_argv
    self.execute(*args, **options.__dict__)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/management/base.py", line 285, in execute
    output = self.handle(*args, **options)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/management/commands/createinitialrevisions.py", line 87, in handle
    self.create_initial_revisions(app, model_class, comment, batch_size, verbosity)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/management/commands/createinitialrevisions.py", line 123, in create_initial_revisions
    default_revision_manager.save_revision((obj,), comment=comment)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/revisions.py", line 430, in save_revision
    for obj in objects
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/revisions.py", line 430, in <genexpr>
    for obj in objects
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/revisions.py", line 108, in get_version_data
    "serialized_data": self.get_serialized_data(obj),
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/reversion/revisions.py", line 91, in get_serialized_data
    fields = list(self.get_fields_to_serialize()),
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/serializers/__init__.py", line 122, in serialize
    s.serialize(queryset, **options)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/serializers/base.py", line 58, in serialize
    self.end_object(obj)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/serializers/json.py", line 52, in end_object
    cls=DjangoJSONEncoder, **self.json_kwargs)
  File "/usr/lib/python2.7/json/__init__.py", line 181, in dump
    for chunk in iterable:
  File "/usr/lib/python2.7/json/encoder.py", line 427, in _iterencode
    for chunk in _iterencode_dict(o, _current_indent_level):
  File "/usr/lib/python2.7/json/encoder.py", line 401, in _iterencode_dict
    for chunk in chunks:
  File "/usr/lib/python2.7/json/encoder.py", line 401, in _iterencode_dict
    for chunk in chunks:
  File "/usr/lib/python2.7/json/encoder.py", line 435, in _iterencode
    o = _default(o)
  File "/home/sgalbraith/.python_virtualenvs/unleash/local/lib/python2.7/site-packages/django/core/serializers/json.py", line 104, in default
    return super(DjangoJSONEncoder, self).default(o)
  File "/usr/lib/python2.7/json/encoder.py", line 177, in default
    raise TypeError(repr(o) + " is not JSON serializable")
TypeError: <class 'console.broadband.enumerations.ProvisioningTicket'> is not JSON serializable

В определении LazyEncoder и в тексте, непосредственно предшествующем этому, есть смутное предложение относительно ответа.

Answer 1

После дня борьбы я придумала ответ. Я не особенно доволен этим, так как это отдаляет ответственность от типа, который я хочу сериализовать. Лучший ответ был бы хорош! Вот что я получил...

Обратите внимание, что у меня есть пользовательское поле Django, которое имеет значения, которые являются классами (т.е. они имеют тип type) и являются подклассами EnumMember, имея член класса с именем CODE, который дает их строковое представление.

Я создал следующий модуль crm.serializers.json и установил SERIALIZATION_MODULES в настройках

SERIALIZATION_MODULES = {
    'json': 'crm.serializers.json',
}

Далее следует код crm.serializers.json:

# Avoid shadowing the standard library json module
from __future__ import absolute_import

from django.core.serializers.json import DjangoJSONEncoder, Serializer, \
    Deserializer as DjangoDeserializer
from django.utils.encoding import force_text

from crm.enum import EnumMember
import json

####################################################################################################
#
#    Extension of Django serialization capability so that apps such as Django-reversion can deal
#    with custom fields.
#
####################################################################################################
class Serializer(Serializer):

    # Override
    # This is a copy paste of the superclass method, but with cls=ExtendedJSONEncoder
    # instead of cls=DjangoJSONEncoder below
    def end_object(self, obj):
        # self._current has the field data
        indent = self.options.get("indent")
        if not self.first:
            self.stream.write(",")
            if not indent:
                self.stream.write(" ")
        if indent:
            self.stream.write("\n")
        json.dump(self.get_dump_object(obj), self.stream,
                  cls=ExtendedJSONEncoder, **self.json_kwargs)
        self._current = None
        pass


Deserializer = DjangoDeserializer


class ExtendedJSONEncoder(DjangoJSONEncoder):
    """
    Provides default serialization for custom data types as well as default ones.
    """
    def default(self, obj):
        if type(obj) == type and issubclass(obj, EnumMember):
            return obj.CODE
        else:
            return super(ExtendedJSONEncoder, self).default(obj)

Answer 2

Не могу сказать наверняка, потому что я не вижу вашего подкласса TextField, но
value_to_string(self, obj)
используется в структуре сериализации, и вы можете переопределить этот метод класса Field.

нравится

def value_to_string(self, obj):
    return self.value_from_object(obj.CODE)

Для десериализации убедитесь, что ваш to_python(self, value) работает правильно