Django Rest Framework - วิธีเพิ่มฟิลด์ที่กำหนดเองใน ModelSerializer

ฉันสร้างModelSerializerและต้องการเพิ่มฟิลด์ที่กำหนดเองซึ่งไม่ใช่ส่วนหนึ่งของโมเดลของฉัน

ฉันพบคำอธิบายเพื่อเพิ่มช่องพิเศษที่นี่และฉันได้ลองทำสิ่งต่อไปนี้:

customField = CharField(source='my_field')

เมื่อฉันเพิ่มฟิลด์นี้และเรียกvalidate()ใช้ฟังก์ชันของฉันฟิลด์นี้ไม่ได้เป็นส่วนหนึ่งของattrdict attrมีฟิลด์โมเดลทั้งหมดที่ระบุยกเว้นฟิลด์เพิ่มเติม ดังนั้นฉันจึงไม่สามารถเข้าถึงช่องนี้ในการตรวจสอบความถูกต้องที่เขียนทับได้ฉันจะทำได้หรือไม่?

เมื่อฉันเพิ่มฟิลด์นี้ในรายการฟิลด์ดังนี้:

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

จากนั้นฉันได้รับข้อผิดพลาดเนื่องจากcustomFieldไม่ใช่ส่วนหนึ่งของโมเดลของฉัน - สิ่งที่ถูกต้องเพราะฉันต้องการเพิ่มสำหรับซีเรียลไลเซอร์นี้เท่านั้น

มีวิธีใดในการเพิ่มฟิลด์ที่กำหนดเองหรือไม่?

คุณกำลังทำในสิ่งที่ถูกต้องยกเว้นสิ่งนั้น CharField (และช่องอื่น ๆ ที่พิมพ์) เป็นช่องที่เขียนได้

ในกรณีนี้คุณต้องการเพียงช่องอ่านอย่างเดียวธรรมดา ๆ ดังนั้นให้ใช้:

customField = Field(source='get_absolute_url')

ในความเป็นจริงมีวิธีแก้ปัญหาโดยไม่ต้องสัมผัสเลยทุกรุ่น คุณสามารถใช้SerializerMethodFieldซึ่งอนุญาตให้คุณเสียบวิธีใดก็ได้กับตัวต่ออนุกรมของคุณ

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

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

... เพื่อความชัดเจนหากคุณมี Model Method ที่กำหนดไว้ดังต่อไปนี้:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

คุณสามารถเพิ่มผลลัพธ์ของการเรียกวิธีการดังกล่าวไปยังเครื่องอนุกรมของคุณได้ดังนี้:

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

ps เนื่องจากฟิลด์ที่กำหนดเองไม่ใช่ฟิลด์ในโมเดลของคุณโดยทั่วไปคุณจะต้องทำให้เป็นแบบอ่านอย่างเดียวดังนี้:

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

ที่นี่ตอบคำถามของคุณ คุณควรเพิ่มลงในบัญชีรุ่นของคุณ:

@property
def my_field(self):
    return None

ตอนนี้คุณสามารถใช้:

customField = CharField(source='my_field')

แหล่งที่มา: https://stackoverflow.com/a/18396622/3220916

เพื่อแสดงให้ผมได้ข้อผิดพลาดกับself.author.full_name Fieldมันทำงานร่วมกับ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 เวอร์ชันล่าสุดคุณต้องสร้างเมธอดในโมเดลของคุณด้วยชื่อฟิลด์ที่คุณต้องการเพิ่ม

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

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

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

ฉันกำลังมองหาวิธีแก้ปัญหาสำหรับการเพิ่มฟิลด์แบบกำหนดเองที่สามารถเขียนได้ลงในเครื่องอนุกรมโมเดล ฉันพบข้อนี้ซึ่งยังไม่ครอบคลุมในคำตอบของคำถามนี้

ดูเหมือนว่าคุณจำเป็นต้องเขียน Serializer อย่างง่ายของคุณเอง

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

ตอนนี้คุณสามารถใช้ Serializer นี้เพื่อเพิ่มฟิลด์ที่กำหนดเองให้กับ ModelSerializer

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

นอกจากนี้ยังใช้งานได้หาก Model MyModelมีคุณสมบัติที่เรียกใช้จริงmy_custom_fieldแต่คุณต้องการละเว้น validators

หลังจากอ่านคำตอบทั้งหมดที่นี่ข้อสรุปของฉันคือมันเป็นไปไม่ได้ที่จะทำสิ่งนี้อย่างหมดจด คุณต้องเล่นสกปรกและทำอะไรบางอย่างที่ไม่น่าสนใจเช่นการสร้างฟิลด์ write_only จากนั้นแทนที่validateand to_representationmethod นี่คือสิ่งที่ใช้ได้ผลสำหรับฉัน:

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