web-dev-qa-db-ja.com

DRF 3のModelSerializerにモデル以外のフィールドを追加します

DRF 3のModelSerializerにモデル以外のフィールドを追加するにはどうすればよいですか？つまり、実際のモデルに存在しないフィールドを追加しますか？

class TestSerializer(serializers.ModelSerializer):
    url = serializers.HyperlinkedIdentityField(view_name='vote_detail')
    non_field = serializers.CharField()  # no corresponding model property.


    class Meta:
        model = vote_model
        fields = ("url", "non_field")

    def create(self, validated_data):
      print(direction=validated_data['non_field'])

しかし、DRF 3は私にエラーを与えます：

Got AttributeError when attempting to get a value for field `non_field` on serializer `TestSerializer`.
The serializer field might be named incorrectly and not match any attribute or key on the `Test` instance.
Original exception text was: 'Test' object has no attribute 'non_field'.

スタックを検索しました DRF-非モデルのwrite_onlyフィールドを持つModelSerializer といくつかの解決策を見つけましたが、これらはDRF 3を使用しているDRF 2を指します。このバージョンでこれに対する解決策はありますか？

pythondjangodjango-rest-framework
25
Prometheus
class TestSerializer(serializers.ModelSerializer):
    url = serializers.HyperlinkedIdentityField(view_name='vote_detail')
    non_field = serializers.SerializerMethodField()  # no corresponding model property.

    class Meta:
        model = vote_model
        fields = ("url", "non_field")

    def create(self, validated_data):
        print(direction=validated_data['non_field'])

http://www.Django-rest-framework.org/api-guide/fields/#serializermethodfield

またはこれを実行します link

4
chandu
_class MySerializer(serializers.ModelSerializer):
    write_only_char_field = serializer.CharField(write_only=True)
    write_only_list_char_field = serializer.ListField(child=serializers.CharField(max_length=100, default=''), write_only=True)
    empty_method_field = serializers.SerializerMethodField()
    read_only_custom_model_field = serializers.CharField(source='custom_property', read_only=True)

    def create(self, validated_data):
        validated_data.pop('write_only_char_field', None)
        validated_data.pop('write_only_list_char_field', None)
        return super().create(validated_data)
_

serializers.CharField(write_only=True)およびserializers.ListField(...)は、_.create_および_.update_メソッドに追加のデータを単一の文字列または文字列のリスト（ ListFieldを他のシリアライザーフィールドタイプと混在させることができます）。このメソッドを使用すると、_def validate_write_only_char_field_を定義して、すばやく簡単な検証を実装することもできます。

serializers.SerializerMethodField()を使用すると、シリアライザで定義されたメソッドからのシリアライザ出力にカスタムの読み取り専用フィールドを追加できます。

_read_only_custom_model_field_は、モデルのメソッドを使用して、厳密にはモデルフィールドではなく、カスタムメソッドのデータを読み取ります。つまり.

_class MyModel(models.Model):
    my_field = models.CharField(max_length=100)

    @property
    def custom_property(self):
        return "Perform calculations, combine with related models, etc. etc."
_
47
A. J. Parr

ほんの一例が役立ちます。

  class ExtensibleModelSerializerOptions(serializers.SerializerOptions):
    """
    Meta class options for ModelSerializer
    """
    def __init__(self, meta):
        super(ExtensibleModelSerializerOptions, self).__init__(meta)
        self.model = getattr(meta, 'model', None)
        self.read_only_fields = getattr(meta, 'read_only_fields', ())
        self.non_native_fields = getattr(meta, 'non_native_fields', ())


class ExtensibleModelSerializer(serializers.ModelSerializer):

    _options_class = ExtensibleModelSerializerOptions

    def restore_object(self, attrs, instance=None):
        """
        Deserialize a dictionary of attributes into an object instance.
        You should override this method to control how deserialized objects
        are instantiated.
        """
        for field in self.opts.non_native_fields:
            attrs.pop(field)

        return super(ExtensibleModelSerializer, self).restore_object(attrs, instance)

ソース： https://github.com/tomchristie/Django-rest-framework/issues/951

2
chandu
class Foo(models.Model):
    . . .
    @property
    def my_field(self):
        return stuff
    . . .

ソース：

Django REST Framework：ModelSerializerにフィールドを追加する

1
chandu

前述のように、2つの方法があります。 （1）モデルプロパティの追加。 （2）モデルフィールドの追加。 @postertyをモデルに追加することは、この投稿で十分に説明されていると思います。モデルを「無駄のない平均」に保ちたい場合は、[メソッド]フィールドを使用します。チャンドスの答えは、いくつかの重要な点を省略していますが、

_class DeliveryItemSerializer(serializers.ModelSerializer):

    product_name = serializers.SerializerMethodField(read_only=True)

    def get_product_name(self, obj):
        return obj.product.name

    class Meta:
        model = DeliveryItem
        fields = (
            (...your field names),
            'product_name',)
_
  1. 読み取り専用に設定
  2. フィールドと対応するメソッドの名前は同じではありません。メソッド名のデフォルトは_get__ field_nameです。別の名前を使用する場合は、SerializerMethodField()で_method_name=method_ name引数を使用します
0
Xen_mar