- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
我需要用 Django 的 REST Framwork 实现一个注重模型继承的 RESTful API。我想this是构建 API 的一种巧妙方法。基本思想是仅通过呈现的属性集来区分对象类。但是 Django 如何做到这一点呢?让我们坚持一个简单的示例场景:
Animal
具有属性 age
。Bird
通过属性 wing
扩展了 Animal
,例如它的大小。Dog
通过 tail
属性扩展了 Animal
,例如它的长度。示例要求:
/animals/
列出所有动物及其一般属性就足够了,即它们的年龄。ID=1
的动物是一只鸟,/animals/1
应该给出如下内容:
{
'age': '3',
'class': 'Bird',
'wing': 'big'
}
ID=2
的动物是一只狗,/animals/2
应该给出如下内容:
{
'age': '8',
'class': 'Dog',
'tail': 'long'
}
我没有成功实现 Django 的 REST 框架,主要是因为我没有成功添加/删除特定于类的字段。我特别想知道,在这种情况下,create 操作是如何实现的?
最佳答案
tl;dr: 它并不像看起来那么复杂。该解决方案提出了一个完全可重用的类,它以最少的代码实现了请求的用例,正如您可以从下面的 示例性用法 中看到的那样。
经过一些摆弄,我想出了以下解决方案,我相信,这是非常令人满意的。为此,我们将需要一个辅助函数和两个类,没有其他依赖项。
HyperlinkedModelSerializer
假设查询从 Animal
类返回一个对象,实际上 是一只Bird
。 get_actual
会将 Animal
解析为对象形式 Bird
类:
def get_actual(obj):
"""Expands `obj` to the actual object type.
"""
for name in dir(obj):
try:
attr = getattr(obj, name)
if isinstance(attr, obj.__class__):
return attr
except:
pass
return obj
ModelField
定义了一个字段,该字段命名了序列化程序下的模型:
class ModelField(serializers.ChoiceField):
"""Defines field that names the model that underlies a serializer.
"""
def __init__(self, *args, **kwargs):
super(ModelField, self).__init__(*args, allow_null=True, **kwargs)
def get_attribute(self, obj):
return get_actual(obj)
def to_representation(self, obj):
return obj.__class__.__name__
HyperlinkedModelHierarchySerializer
的神奇之处在于:
class HyperlinkedModelHierarchySerializer(serializers.HyperlinkedModelSerializer):
"""Extends the `HyperlinkedModelSerializer` to properly handle class hierearchies.
For an hypothetical model `BaseModel`, serializers from this
class are capable of also handling those models that are derived
from `BaseModel`.
The `Meta` class must whitelist the derived `models` to be
allowed. It also must declare the `model_dependent_fields`
attribute and those fields must also be added to its `fields`
attribute, for example:
wing = serializers.CharField(allow_null=True)
tail = serializers.CharField(allow_null=True)
class Meta:
model = Animal
models = (Bird, Dog)
model_dependent_fields = ('wing', 'tail')
fields = ('model', 'id', 'name') + model_dependent_fields
read_only_fields = ('id',)
The `model` field is defined by this class.
"""
model = ModelField(choices=[])
def __init__(self, *args, **kwargs):
"""Instantiates and filters fields.
Keeps all fields if this serializer is processing a CREATE
request. Retains only those fields that are independent of
the particular model implementation otherwise.
"""
super(HyperlinkedModelHierarchySerializer, self).__init__(*args, **kwargs)
# complete the meta data
self.Meta.models_by_name = {model.__name__: model for model in self.Meta.models}
self.Meta.model_names = self.Meta.models_by_name.keys()
# update valid model choices,
# mark the model as writable if this is a CREATE request
self.fields['model'] = ModelField(choices=self.Meta.model_names, read_only=bool(self.instance))
def remove_missing_fields(obj):
# drop those fields model-dependent fields that `obj` misses
unused_field_keys = set()
for field_key in self.Meta.model_dependent_fields:
if not hasattr(obj, field_key):
unused_field_keys |= {field_key}
for unused_field_key in unused_field_keys:
self.fields.pop(unused_field_key)
if not self.instance is None:
# processing an UPDATE, LIST, RETRIEVE or DELETE request
if not isinstance(self.instance, QuerySet):
# this is an UPDATE, RETRIEVE or DELETE request,
# retain only those fields that are present on the processed instance
self.instance = get_actual(self.instance)
remove_missing_fields(self.instance)
else:
# this is a LIST request, retain only those fields
# that are independent of the particular model implementation
for field_key in self.Meta.model_dependent_fields:
self.fields.pop(field_key)
def validate_model(self, value):
"""Validates the `model` field.
"""
if self.instance is None:
# validate for CREATE
if value not in self.Meta.model_names:
raise serializers.ValidationError('Must be one of: ' + (', '.join(self.Meta.model_names)))
else:
return value
else:
# model cannot be changed
return get_actual(self.instance).__class__.__name__
def create(self, validated_data):
"""Creates instance w.r.t. the value of the `model` field.
"""
model = self.Meta.models_by_name[validated_data.pop('model')]
for field_key in self.Meta.model_dependent_fields:
if not field_key in model._meta.get_all_field_names():
validated_data.pop(field_key)
self.fields.pop(field_key)
return model.objects.create(**validated_data)
这就是我们如何使用它。在 serializers.py
中:
class AnimalSerializer(HyperlinkedModelHierarchySerializer):
wing = serializers.CharField(allow_null=True)
tail = serializers.CharField(allow_null=True)
class Meta:
model = Animal
models = (Bird, Dog)
model_dependent_fields = ('wing', 'tail')
fields = ('model', 'id', 'name') + model_dependent_fields
read_only_fields = ('id',)
在 views.py
中:
class AnimalViewSet(viewsets.ModelViewSet):
queryset = Animal.objects.all()
serializer_class = AnimalSerializer
关于django - Django 中具有模型继承的 RESTful API,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/31923568/
我对 Python-Django 和 web 开发还很陌生,我被困在这个使用 POST 创建新资源的特殊问题上。 我正在为 REST API 使用 Django REST 框架,我正在尝试创建一个新资
我已经使用 Django-storages 成功地将 Word 文档存储到 S3。 class Document(TitleSlugDescriptionModel, TimeStampedModel
我有 2 个关于模型代理的问题, 如何从模型对象创建代理对象? 如何从模型查询集创建代理查询集? 例如,假设我们定义了: from django.contrib.auth.models import
我想编写一个直接执行 HTTP 请求的单元测试(而不是使用 django.test.client.Client)。 如果您好奇为什么 - 那是因为我想测试我从 Django 应用程序公开的 Thrif
我为我的个人网站启动了一个 django 项目来学习 django。到目前为止,我已经将我的开发环境设置为我需要的一切,并遵循 this很棒的教程来创建一些基本的数据结构和模板。现在我想开始使用我之前
我已经阅读了很多关于如何在使用 Django 注册时添加额外字段的信息,例如 here 、 here 和 here 。代码片段是: forms.py(来自注册应用程序) class Registrat
我正在编写小型社交应用程序。功能之一是在网站标题中写入用户名。因此,例如,如果我登录并且我的名字是Oleg(用户名),那么我应该看到: Hello, Oleg | Click to edit prof
我有一个使用 Django 和 Django Rest 框架开发的应用程序。我想将 django-reversion 功能添加到我的应用程序中。 我已经尝试过http://django-reversi
我有一个简单的 HTML 表单,我没有使用 Django 表单,但现在我想添加一个选择。 选择最容易创建为 Django ChoiceField (与通过循环等手动创建选择相反),但是,如果没有在 D
我不明白为什么人们以两种方式编写外键,这样做的目的是什么?它们是相同还是不同? 我注意到有些人这样写: author = models.ForeignKey(Author, on_delete=mod
我想在我的 Django 应用程序中获取评论最多的十个帖子,但我做不到,因为我想不出合适的方法。 我目前正在使用 django 评论框架,并且我已经看到使用 aggregate or annotate
这对于 Django 1.2 仍然有效吗? Custom Filter in Django Admin on Django 1.3 or below 我已经尝试过,但管理类中的 list_filter
问题在于,当 django-compressor 编译为 .js 文件的 CoffeeScript 文件中引用 {{ STATIC_URL }} 时,它无法正确加载。 在我的 django 模板中,我
我正在尝试将一些字段从一个 django 模型移动到一个新模型。假设我有一个书籍模型: class Book(models.Model): title = models.CharField(max
我想在我的 Django 应用程序中获取评论最多的十个帖子,但我做不到,因为我想不出合适的方法。 我目前正在使用 django 评论框架,并且我已经看到使用 aggregate or annotate
目前我正在寻找在 Django 中实现访问控制。我已经阅读了有关内置权限的内容,但它并不关心每个对象的基础。例如,我想要“只有创建者可以删除自己的项目”之类的权限。所以我读到了 django-guar
嗨,我正在将我的 Django 模型的一个字段的值设置为其他模型的另一个字段的值。这个值应该是动态变化的。 这是我的第一个模型 class MainModel(AbstractBaseUser, Pe
我正在尝试为我的模型创建一个编辑表单。我没有使用模型表单,因为根据模型类型,用户可以使用不同的表单。 (例如,其中一个表单有 Tinymce 小部件,而另一个没有。) 有没有什么方法可以使用模型设置表
Django 模板中的搜索字段 如何在类似于此图像的 Django 模板中创建搜索字段 http://asciicasts.com/system/photos/1204/original/E354I0
根据 Django documentation ,如果 Django 安装激活了 AuthenticationMiddleware,HttpRequest 对象有一个“user”属性代表当前登录的用户
我是一名优秀的程序员,十分优秀!