Django Rest Framework - ModelSerializer'da özel alan nasıl eklenir

Bir oluşturdum ModelSerializerve modelimin parçası olmayan özel bir alan eklemek istiyorum.

Fazladan alanlar eklemek için bir açıklama buldum burada ve ben aşağıdakileri denedim:

customField = CharField(source='my_field')

Bu alanı eklediğimde ve validate()işlevimi çağırdığımda bu alan attrdiktenin bir parçası değil . attrekstra alanlar dışında belirtilen tüm model alanlarını içerir. Bu yüzden üzerine yazdığım doğrulamada bu alana erişemiyorum, değil mi?

Bu alanı alan listesine şöyle eklediğimde:

class Meta:
    model = Account
    fields = ('myfield1', 'myfield2', 'customField')

sonra bir hata alıyorum çünkü customFieldmodelimin bir parçası değil - doğru olanı sadece bu serileştirici için eklemek istiyorum.

Özel alan eklemenin herhangi bir yolu var mı?

Doğru olanı yapıyorsunuz, bunun dışında CharField(ve diğer yazılan alanlar) yazılabilir alanlar içindir.

Bu durumda sadece basit bir salt okunur alan istiyorsunuz, bunun yerine şunu kullanın:

customField = Field(source='get_absolute_url')

Aslında hiçbir modele dokunmadan bir çözüm var. SerializerMethodFieldSerileştiricinize herhangi bir yöntemi takmanıza izin veren kullanabilirsiniz .

class FooSerializer(ModelSerializer):
    foo = serializers.SerializerMethodField()

    def get_foo(self, obj):
        return "Foo id: %i" % obj.pk

... netlik açısından, aşağıdaki şekilde tanımlanan bir Model Yönteminiz varsa:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

Söz konusu yöntemi çağırmanın sonucunu serileştiricinize şu şekilde ekleyebilirsiniz:

class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

ps Özel alan modelinizde gerçekten bir alan olmadığından, genellikle bunu salt okunur yapmak istersiniz, örneğin:

class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )

Sorunuzun cevabı burada. Model Hesabınıza eklemelisiniz:

@property
def my_field(self):
    return None

şimdi kullanabilirsiniz:

customField = CharField(source='my_field')

kaynak: https://stackoverflow.com/a/18396622/3220916

Göstermek self.author.full_nameiçin bir hata aldım Field. Şunlarla çalıştı ReadOnlyField:

class CommentSerializer(serializers.HyperlinkedModelSerializer):
    author_name = ReadOnlyField(source="author.full_name")
    class Meta:
        model = Comment
        fields = ('url', 'content', 'author_name', 'author')

Django Rest Framework'ün son sürümü ile modelinizde eklemek istediğiniz alanın adıyla bir yöntem oluşturmanız gerekir.

class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)

Bir model serileştiriciye yazılabilir bir özel alan eklemek için bir çözüm arıyordum. Bu sorunun yanıtlarında ele alınmayan bunu buldum.

Görünüşe göre gerçekten kendi basit Serileştiricinizi yazmanız gerekiyor.

class PassThroughSerializer(serializers.Field):
    def to_representation(self, instance):
        # This function is for the direction: Instance -> Dict
        # If you only need this, use a ReadOnlyField, or SerializerField
        return None

    def to_internal_value(self, data):
        # This function is for the direction: Dict -> Instance
        # Here you can manipulate the data if you need to.
        return data

Artık bu Serileştiriciyi bir ModelSerializer'a özel alanlar eklemek için kullanabilirsiniz.

class MyModelSerializer(serializers.ModelSerializer)
    my_custom_field = PassThroughSerializer()

    def create(self, validated_data):
        # now the key 'my_custom_field' is available in validated_data
        ...
        return instance

Bu aynı zamanda, Model MyModelgerçekten adlandırılan bir özelliğe sahipse, my_custom_fieldancak onun doğrulayıcılarını göz ardı etmek istiyorsanız da işe yarar .

Buradaki tüm cevapları okuduktan sonra, bunu temiz bir şekilde yapmanın imkansız olduğu sonucuna varıyorum. Kirli oynamalı ve bir write_only alanı oluşturmalı ve sonra validateve to_representationyöntemlerini geçersiz kılmalısınız . Bu benim için çalıştı:

class FooSerializer(ModelSerializer):

    foo = CharField(write_only=True)

    class Meta:
        model = Foo
        fields = ["foo", ...]

    def validate(self, data):
        foo = data.pop("foo", None)
        # Do what you want with your value
        return super().validate(data)

    def to_representation(self, instance):
        data = super().to_representation(instance)
        data["foo"] = whatever_you_want
        return data