Django Rest Framework - Як додати власне поле в ModelSerializer

Я створив ModelSerializerі хочу додати власне поле, яке не є частиною моєї моделі.

Я знайшов опис, щоб додати сюди додаткові поля, і спробував наступне:

customField = CharField(source='my_field')

Коли я додаю це поле і викликаю свою validate()функцію, це поле не є частиною attrдикту. 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

... для наочності, якщо у вас є метод моделі, визначений наступним чином:

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

Я шукав рішення для додавання спеціального поля для запису до серіалізатора моделі. Я знайшов цей, який не був висвітлений у відповідях на це питання.

Здається, вам дійсно потрібно написати власний простий серіалізатор.

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

Тепер ви можете використовувати цей серіалізатор для додавання користувацьких полів до 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але ви хочете ігнорувати її валідатори.

Прочитавши всі відповіді тут, мій висновок полягає в тому, що зробити це чисто неможливо. Вам потрібно грати брудно і робити щось хакешське, наприклад, створювати поле write_only, а потім перевизначити методи validateand 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