Django बाकी फ्रेमवर्क - ModelSerializer में कस्टम फ़ील्ड कैसे जोड़ें

Question 1

मैंने एक बनाया ModelSerializerऔर एक कस्टम फ़ील्ड जोड़ना चाहता हूं जो मेरे मॉडल का हिस्सा नहीं है।

मुझे यहाँ अतिरिक्त फ़ील्ड जोड़ने का विवरण मिला और मैंने निम्नलिखित कोशिश की:

customField = CharField(source='my_field')

जब मैं इस क्षेत्र को जोड़ता हूं और अपने validate()कार्य को बुलाता हूं तो यह क्षेत्र attrतानाशाही का हिस्सा नहीं है । attrइसमें अतिरिक्त फ़ील्ड को छोड़कर निर्दिष्ट सभी मॉडल फ़ील्ड शामिल हैं। इसलिए मैं अपने अधिलेखित सत्यापन में इस क्षेत्र तक नहीं पहुँच सकता, क्या मैं कर सकता हूँ?

जब मैं इस फ़ील्ड को इस तरह फ़ील्ड सूची में जोड़ता हूँ:

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

फिर मुझे एक त्रुटि मिलती है क्योंकि customFieldमेरे मॉडल का हिस्सा नहीं है - क्या सही है क्योंकि मैं इसे इस धारावाहिक के लिए जोड़ना चाहता हूं।

क्या कोई कस्टम फ़ील्ड जोड़ने का कोई तरीका है?

Question 2

आप सही काम कर रहे हैं, सिवाय इसके कि CharField(और अन्य टाइप किए गए क्षेत्र) लेखन योग्य क्षेत्रों के लिए हैं।

इस मामले में आप केवल एक साधारण केवल-पढ़ने के लिए फ़ील्ड चाहते हैं, इसलिए इसके बजाय बस उपयोग करें:

customField = Field(source='get_absolute_url')

Question 3

वास्तव में सभी मॉडल को छूने के बिना एक समाधान है। आप का उपयोग कर सकते हैं SerializerMethodFieldजो आप अपने serializer के लिए किसी भी विधि को प्लग करने की अनुमति देते हैं।

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

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

Question 4

... स्पष्टता के लिए, यदि आपके पास एक मॉडल विधि निम्नलिखित तरीके से परिभाषित है:

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',
        )

Question 5

यहाँ आपके प्रश्न का उत्तर है। आपको अपने मॉडल में जोड़ना चाहिए खाता:

@property
def my_field(self):
    return None

अब आप उपयोग कर सकते हैं:

customField = CharField(source='my_field')

स्रोत: https://stackoverflow.com/a/18396622/3220916

Question 6

दिखाने के लिए 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')

Question 7

Django रेस्ट फ्रेमवर्क के अंतिम संस्करण के साथ, आपको अपने मॉडल में उस फ़ील्ड के नाम के साथ एक विधि बनाने की आवश्यकता है जिसे आप जोड़ना चाहते हैं।

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

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

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

Question 8

मैं एक मॉडल धारावाहिक के लिए एक लिखने योग्य कस्टम क्षेत्र को जोड़ने के लिए एक समाधान की तलाश कर रहा था। मैंने इसे पाया, जो इस प्रश्न के उत्तर में शामिल नहीं है।

ऐसा लगता है कि आपको वास्तव में अपना खुद का सरल सीरियल लिखने की ज़रूरत है।

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

यह भी काम करता है, अगर मॉडल में MyModelवास्तव में एक संपत्ति है, my_custom_fieldलेकिन आप इसके सत्यापनकर्ताओं को अनदेखा करना चाहते हैं।

Question 9

यहां सभी उत्तरों को पढ़ने के बाद मेरा निष्कर्ष यह है कि यह सफाई से करना असंभव है। आपको गंदा खेलना होगा और कुछ करना होगा जैसे कि राइट_ऑनली फ़ील्ड बनाना और फिर validateऔर to_representationतरीकों को ओवरराइड करना । इसी से मेरा काम बना है:

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