在 Django 和 Django REST Framework 中使用保留字“class”作为字段名

Question

问题描述

分类学是基于共同特征定义和命名生物有机体群体的科学。有机体被归类为分类群（单数：分类单元），这些组被赋予分类等级。现代使用的主要等级是域、界、门、类、目、科、属和种。 更多关于维基百科中Taxonomy 和Taxonomic ranks 的信息。

按照 Wikipedia 中 Taxonomic rank 文章中 red fox 的示例，我需要创建一个这样的 JSON 输出：

{
    "species": "vulpes",
    "genus": "Vulpes",
    "family": "Canidae",
    "order": "Carnivora",
    "class": "Mammalia",
    "phylum": "Chordata",
    "kingdom": "Animalia",
    "domain": "Eukarya"
}

由于 Django REST 框架根据字段名称创建键，因此分类等级 class（示例中为粗体）会出现问题，因为它是 Python 中的保留字，不能用作变量名。

我尝试过的

在 Django 中创建的模型类如下所示：

class Species(models.Model):
    species = models.CharField()
    genus = models.CharField()
    family = models.CharField()
    # class = models.CharField() - class is reserved word in Python
    # class_ = models.CharField() - Django doesn't allow field names
    # ending with underscore. That wouldn't be either a satisfying solution.
    # further fields

问题

是否有任何可能的方法来解决此问题并生成所需的输出？ 如果不是，解决此问题的最佳做法是什么？

Answer 1

你可以在get_fields()方法的重载版本中重命名字段

class MySerializer(serializers.Serializer):
    class_ = serializers.ReadOnlyField()

    def get_fields(self):
        result = super().get_fields()
        # Rename `class_` to `class`
        class_ = result.pop('class_')
        result['class'] = class_
        return result

Answer 2

你可以像下面那样做

class SpeciesSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Species
        fields = (
            'url', 'id', 'canonical_name', 'slug',  'species', 'genus',
            'subfamily', 'family', 'order','class', 'phylum',
            'ncbi_id', 'ncbi_taxonomy',
        )
        read_only_fields = ('slug',)
        extra_kwargs = {
            'url': {'lookup_field': 'slug'}
        }

SpeciesSerializer._declared_fields["class"] = serializers.CharField(source="class_name")

如下回答所述

https://stackoverflow.com/a/47717441/2830850

Answer 3

生物信息学领域的其他软件开发人员可能对此问题的解决方案感兴趣，因此我在此处发布了我的方法，这是 Alasdair 建议的。

我们的目标是为一个活的物种创建一个模型，为了简单起见，假设是一种动物，并使用 Django REST 框架创建一个代表正确分类等级的端点。

models.py

from django.db import models

class Animal(models.Model):
    canonical_name = models.CharField(max_length=100, unique=True)
    species = models.CharField(max_length=60, unique=True)
    genus = models.CharField(max_length=30)
    family = models.CharField(max_length=30)
    order = models.CharField(max_length=30)
    # we can't use class as field name
    class_name = models.CharField('Class', db_column='class', max_length=30)
    phylum = models.CharField(max_length=30)
    # we don't need to define kingdom and domain
    # it's clear that it is an animal and eukaryote

    def __str__(self):
        return '{} ({})'.format(self.canonical_name, self.species)

serializers.py

from collections import OrderedDict

from rest_framework import serializers

from .models import Species

class SpeciesSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Animal
        fields = ('url', 'id', 'canonical_name', 'species', 'genus',
            'subfamily', 'family', 'order', 'class_name', 'phylum')

    def to_representation(self, obj):
        # call the parent method and get an OrderedDict
        data = super(SpeciesSerializer, self).to_representation(obj)
        # generate a list of the keys and replace the key 'class_name'
        keys = list(data.keys())
        keys.insert(keys.index('class_name'), 'class')
        keys.remove('class_name')
        # remove 'class_name' and assign its value to a new key 'class'
        class_name = data.pop('class_name')
        data.update({'class': class_name})
        # create new OrderedDict with the order given by the keys
        response = OrderedDict((k, data[k]) for k in keys)
        return response

to_representation 方法帮助我们操作输出。我在这里做了一些额外的工作，以使分类等级按所需的顺序排列。

因此对于red fox，输出如下所示：

赤狐（Vulpes vulpes）

{
    "url": "http://localhost:8000/animal/1",
    "id": 1,
    "canonical_name": "Red fox",
    "species": "Vulpes vulpes",
    "genus": "Vulpes",
    "family": "Canidae",
    "order": "Carnivora",
    "class": "Mammalia",
    "phylum": "Chordata"
}

这是一个简化的示例，实际上您将拥有更多字段，或者可能为每个分类等级提供一个模型，但在某处您可能会遇到保留字 class 和分类等级 class 之间的冲突。
我希望这也可以帮助其他人。

Answer 4

你可以像这样通过字符串设置类的属性：

class SpeciesSerializer(serializers.Serializer):
    species = serializers.CharField()
    genus = serializers.CharField()
    family = serializers.CharField()
    vars()['class'] = serializers.CharField()