Django-REST框架restore_object attrs参数

时间:2013-03-14 20:23:15

标签: django django-rest-framework

找到Django-REST框架文档,尽管它有多长,但对我来说仍然太亮了。

restore_object方法的attrs功能有什么作用?

instance.title = attrs.get('title', instance.title)

第二个论点代表什么,以及我将如何在文档中寻找将来意味着什么?

也不确定return Snippet(**attrs)中的双星号是什么意思。这与** keywArgs不同?将哪些参数传递回反序列化的Snippet对象?

在文档的另一部分中,我在restore_object()instance.title = attrs['title']中看到,我希望有人能够看到我的困惑。

谢谢

class SnippetSerializer(serializers.Serializer):
    pk = serializers.Field()  # Note: `Field` is an untyped read-only field.
    title = serializers.CharField(required=False,
                                  max_length=100)
    code = serializers.CharField(widget=widgets.Textarea,
                                 max_length=100000)
    linenos = serializers.BooleanField(required=False)
    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES,
                                       default='python')
    style = serializers.ChoiceField(choices=STYLE_CHOICES,
                                    default='friendly')

    def restore_object(self, attrs, instance=None):
        """
        Create or update a new snippet instance.
        """
        if instance:
            # Update existing instance
            instance.title = attrs.get('title', instance.title)
            instance.code = attrs.get('code', instance.code)
            instance.linenos = attrs.get('linenos', instance.linenos)
            instance.language = attrs.get('language', instance.language)
            instance.style = attrs.get('style', instance.style)
            return instance

        # Create new instance
        return Snippet(**attrs)

2 个答案:

答案 0 :(得分:6)

我稍微更新了文档,旨在使其更加清晰......

http://django-rest-framework.org/tutorial/1-serialization.html#creating-a-serializer-class

该方法现在读取......

def restore_object(self, attrs, instance=None):
    """
    Create or update a new snippet instance, given a dictionary
    of deserialized field values.

    Note that if we don't define this method, then deserializing
    data will simply return a dictionary of items.
    """
    if instance:
        # Update existing instance
        instance.title = attrs.get('title', instance.title)
        instance.code = attrs.get('code', instance.code)
        instance.linenos = attrs.get('linenos', instance.linenos)
        instance.language = attrs.get('language', instance.language)
        instance.style = attrs.get('style', instance.style)
        return instance

    # Create new instance
    return Snippet(**attrs)

**attrs样式使用Python的标准关键字扩展。 有关详细说明,请参阅here

它最终会相当于Snippet(title=attrs['title'], code=attrs['code'], ...)

希望有所帮助!

答案 1 :(得分:2)

在DRF 3.0+中删除了restore_object方法。现在您可以使用两个单独的方法:.create和.update

def update(self, instance, validated_data): 
    instance.title = validated_data.get('title', instance.title) 
    instance.code = validated_data.get('code', instance.code) 
    instance.linenos = validated_data.get('linenos', instance.linenos)
    instance.language = validated_data.get('language', instance.language)         
    instance.style = validated_data.get('style', instance.style)  
    instance.save() 
    return instance 

def create(self, validated_data): 
    return Snippet.objects.create(**validated_data) 

发行说明:http://www.django-rest-framework.org/topics/3.0-announcement/