Добавить немодельное поле на ModelSerializer в DRF 3

Как добавить немодельное поле в ModelSerializer в DRF 3? т.е. добавить поле, которое не существует на моей фактической модели?

class TestSerializer(serializers.ModelSerializer):
    url = serializers.HyperlinkedIdentityField(view_name='vote_detail')
    non_field = serializers.CharField()  # no corresponding model property.


    class Meta:
        model = vote_model
        fields = ("url", "non_field")

    def create(self, validated_data):
      print(direction=validated_data['non_field'])

Но DRF 3 дает мне ошибку:

Got AttributeError when attempting to get a value for field `non_field` on serializer `TestSerializer`.
The serializer field might be named incorrectly and not match any attribute or key on the `Test` instance.
Original exception text was: 'Test' object has no attribute 'non_field'.

Я искал стек DRF - ModelSerializer с немодельным полем write_only и нашел несколько решений, но они относятся к DRF 2, где я использую DRF 3. Есть ли решение для этой версии в этой версии?

Ответы

Ответ 1

class TestSerializer(serializers.ModelSerializer):
    url = serializers.HyperlinkedIdentityField(view_name='vote_detail')
    non_field = serializers.SerializerMethodField()  # no corresponding model property.

    class Meta:
        model = vote_model
        fields = ("url", "non_field")

    def create(self, validated_data):
        print(direction=validated_data['non_field'])

http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

или перейдите по этой ссылке

Ответ 2

class MySerializer(serializers.ModelSerializer):
    write_only_char_field = serializers.CharField(write_only=True)
    write_only_list_char_field = serializers.ListField(child=serializers.CharField(max_length=100, default=''), write_only=True)
    empty_method_field = serializers.SerializerMethodField()
    read_only_custom_model_field = serializers.CharField(source='custom_property', read_only=True)

    def create(self, validated_data):
        validated_data.pop('write_only_char_field', None)
        validated_data.pop('write_only_list_char_field', None)
        return super().create(validated_data)

serializers.CharField(write_only=True) и serializers.ListField(...) - хорошее решение для предоставления дополнительных данных вашим методам .create() и .update() в виде одной строки или списка строк (вы можете смешать ListField с другим сериализатором) типы полей).
С помощью этого метода вы также можете определить def validate_write_only_char_field для быстрой и простой проверки.

serializers.SerializerMethodField() позволяет вам добавить некоторое настраиваемое поле только для чтения к выходу сериализатора с помощью метода, определенного на сериализаторе.

read_only_custom_model_field будет использовать метод вашей модели для чтения некоторых данных, не только поле модели, но и собственный метод. Т.е.

class MyModel(models.Model):
    my_field = models.CharField(max_length=100)

    @property
    def custom_property(self):
        return "Perform calculations, combine with related models, etc. etc."

Ответ 3

Только пример может помочь вам.

  class ExtensibleModelSerializerOptions(serializers.SerializerOptions):
    """
    Meta class options for ModelSerializer
    """
    def __init__(self, meta):
        super(ExtensibleModelSerializerOptions, self).__init__(meta)
        self.model = getattr(meta, 'model', None)
        self.read_only_fields = getattr(meta, 'read_only_fields', ())
        self.non_native_fields = getattr(meta, 'non_native_fields', ())


class ExtensibleModelSerializer(serializers.ModelSerializer):

    _options_class = ExtensibleModelSerializerOptions

    def restore_object(self, attrs, instance=None):
        """
        Deserialize a dictionary of attributes into an object instance.
        You should override this method to control how deserialized objects
        are instantiated.
        """
        for field in self.opts.non_native_fields:
            attrs.pop(field)

        return super(ExtensibleModelSerializer, self).restore_object(attrs, instance)

Источник: https://github.com/tomchristie/django-rest-framework/issues/951

Ответ 4

class Foo(models.Model):
    . . .
    @property
    def my_field(self):
        return stuff
    . . .

Источник:

Django REST Framework: добавление дополнительного поля в ModelSerializer

Ответ 5

Как уже упоминалось, есть два пути. (1) добавление свойства модели. (2) добавление модельного поля. Я чувствую, что добавление @property к модели было хорошо объяснено в этом посте. Если вы хотите, чтобы ваши модели были "худыми и подлыми", используйте поле "Метод". Ответ Чандуса опускает некоторые важные моменты, хотя:

class DeliveryItemSerializer(serializers.ModelSerializer):

    product_name = serializers.SerializerMethodField(read_only=True)

    def get_product_name(self, obj):
        return obj.product.name

    class Meta:
        model = DeliveryItem
        fields = (
            (...your field names),
            'product_name',)

Установить read_only
Поле и соответствующий метод не имеют одно и то же имя. Имя метода по умолчанию get_. Если вы используете другое имя, используйте method_name=method имя method_name=method в SerializerMethodField()