Django Repos Cadre - Comment ajouter un champ personnalisé dans ModelSerializer

J'ai créé un ModelSerializer et souhaitez ajouter un champ personnalisé qui ne fait pas partie de mon modèle.

J'ai trouvé une description pour ajouter des champs supplémentaires ici et j'ai essayé le suivant:

customField = CharField(source='my_field')

Quand j'ajoute ce domaine, et d'appeler mon validate() fonction de ce champ ne fait pas partie de la attr dict. attr contient tous les champs de modèle spécifié, sauf les champs supplémentaires. Je ne peux donc pas accéder à ce champ dans mon écrasé de validation, puis-je?

Quand j'ai ajouter ce champ dans la liste de champs comme ceci:

class Meta:
    model = Account
    fields = ('myfield1', 'myfield2', 'customField')

puis-je obtenir une erreur car customField ne fait pas partie de mon modèle - ce qui est correct parce que je veux ajouter juste pour cette sérialiseur.

Est-il possible d'ajouter un champ personnalisé?

InformationsquelleAutor Ron | 2013-01-29
  1. 55

    Vous êtes en train de faire la bonne chose, sauf que CharField (et les autres tapé champs) sont pour l'écriture des champs.

    Dans ce cas, vous voulez simplement un champ en lecture seule, donc au lieu simplement utiliser:

    customField = Field(source='get_absolute_url')
    • merci, mais je veux un domaine accessible en écriture. Je passe un certain utilisateur de jeton qui identifie mon utilisateur. mais dans mon modèle, j'ai de l'utilisateur et non le jeton. donc, je veux passer le jeton et "convertir" à un utilisateur de l'objet via une requête.
    • la prochaine chose est que la source doit cibler un attribut du modèle de droit? dans mon cas, je n'ai pas un attribut de point.
    • Je ne comprends pas l'utilisateur/jeton peu de commentaire. Mais si vous voulez inclure un champ dans le sérialiseur qui obtient supprimés avant de vous restaurer dans une instance du modèle, vous pouvez utiliser le .validate() méthode pour supprimer l'attribut. Voir: django-rest-framework.org/api-guide/serializers.html#validation Que feriez ce que vous avez besoin, même si je ne comprends pas vraiment le cas d'utilisation, ou pourquoi vous voulez un écriture champ qui est lié à un lecture seule propriété get_absolute_url?
    • oublier le get_absolute_url j'ai juste copier&coller avais de la documentation. Je veux juste normal de domaine accessible en écriture à laquelle je peux accéder à la validate(). J'ai juste deviné que j'avais besoin de la source attribut...
    • Cela fait plus de sens. 🙂 La valeur doit être passé à travers pour valider, donc j'aurais le double de vérifier la façon dont vous êtes l'instanciation de la sérialiseur, et si cette valeur est fournie.
    • merci! pourriez-vous fournir un petit exemple de code pour le cas que customField n'est pas dans le fields() tableau, mais est toujours accessible dans le validate() fonction?
    • Grande réponse, mais dans mon cas, j'avais besoin d'utiliser ReadOnlyField au lieu de Field

    InformationsquelleAutor Tom Christie
  2. 66

    En fait-il une solution sans toucher à tous les modèle. Vous pouvez utiliser SerializerMethodField qui vous permettent de brancher n'importe quelle méthode pour votre sérialiseur.

    class FooSerializer(ModelSerializer):
    foo = serializers.SerializerMethodField()

    def get_foo(self, obj):
        return "Foo id: %i" % obj.pk
    • C'est la meilleure réponse, l'api doivent pas se mêler avec les modèles
    • Comme OP mentionné dans ce commentaire, ils veulent un domaine accessible en écriture, ce qui SerializerMethodFields ne sont pas
    InformationsquelleAutor Idaho
  3. 14

    ...pour plus de clarté, si vous avez un Modèle de Méthode définie de la manière suivante:

    class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

    Vous pouvez ajouter le résultat de l'appel dit de la méthode de votre sérialiseur comme suit:

    class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

    p.s. Depuis le champ personnalisé n'est pas vraiment un domaine dans votre modèle, vous aurez habituellement à se rendre en lecture seule, comme suit:

    class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )
    • Que faire si je veux qu'il soit accessible en écriture?
    • Vous aurez juste besoin d'écrire personnalisé enregistrer et de suppression des crochets pour le contenu supplémentaire: Voir "Enregistrer et de suppression des crochets" sur les "Méthodes" (Ici) Vous aurez besoin d'écrire personnalisé perform_create(self, serializer), perform_update(self, serializer), perform_destroy(self, instance).
    InformationsquelleAutor Lindauson
  4. 13

    ici la réponse à votre question.
    vous devriez ajouter à votre Compte modèle:

    @property
def my_field(self):
    return None

    maintenant, vous pouvez utiliser:

    customField = CharField(source='my_field')

    source: https://stackoverflow.com/a/18396622/3220916

    • J'ai utilisé cette approche lorsque cela a du sens, mais ce n'est pas idéal pour ajouter du code supplémentaire de modèles pour des choses qui ne sont vraiment pour les appels d'API.
    • Vous pouvez écrire un proxy modèle pour l'
    InformationsquelleAutor va-dev
  5. 8

    Pour montrer self.author.full_name, j'ai eu une erreur avec Field. Il a travaillé avec ReadOnlyField:

    class CommentSerializer(serializers.HyperlinkedModelSerializer):
    author_name = ReadOnlyField(source="author.full_name")
    class Meta:
        model = Comment
        fields = ('url', 'content', 'author_name', 'author')
    InformationsquelleAutor François Constant
  6. 6

    Avec la dernière version de Django Rest Framework, vous devez créer une méthode dans votre modèle avec le nom du champ que vous souhaitez ajouter. 

    class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)
    InformationsquelleAutor Guillaume Vincent
  7. 1

    Je cherchais une solution pour l'ajout d'une écriture champ personnalisé à un modèle sérialiseur. J'ai trouvé celui-ci, qui n'a pas été abordés dans les réponses à cette question.

    Il semble que vous n'avez en effet besoin d'écrire votre propre simple Sérialiseur.

    class PassThroughSerializer(serializers.Serializer):
    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

    Maintenant, vous pouvez utiliser ce Processus pour ajouter des champs personnalisés à un 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

    Cela fonctionne aussi, si le Modèle MyModel a en fait une propriété appelée my_custom_field mais vous voulez ignorer ses validateurs.

    InformationsquelleAutor David Nathan