Comment patcher un seul champ à l'aide de Django Repos Cadre?

J'ai un modèle "Monmodèle' avec de nombreux champs et je voudrais mettre à jour un champ "statut" à l'aide de PATCH méthode. Je suis l'aide de la classe des vues basées sur les. Est-il possible de mettre en œuvre PATCH?

  • vous pouvez simplement vérifier request.method == 'PATCH' dans votre afficher le code et ensuite faire ce que vous voulez.
  • Je voudrais savoir comment gérer cela dans sérialiseur de classe.
  • Sérialiseur de classe n'est pas le lieu qui doit savoir quelque chose au sujet de la méthode de requête. Donc, je vous recommande de vérifier les classes d'affichage (comme APIView ), pas sérialiseurs
InformationsquelleAutor pnhegde | 2015-01-16
  1. 40

    Sérialiseurs permettre des mises à jour partielles en spécifiant partielle=True lors de l'initialisation de la serialzer. C'est de cette façon PATCH de traitement des demandes de par défaut dans le générique de vues.

    serializer = CommentSerializer(comment, data=request.data, partial=True)

    Cela vous permettra de mettre à jour les champs individuels dans un sérialiseur, ou tous les champs si vous le voulez, sans aucune des restrictions de la norme PUT demande.

    • Exactement où cela ne va?
    • Bonne question @ScottSmith. Il semble que la documentation et d'autres sources citent ce one-liner comme la solution pour faire des mises à jour partielles. Mais il est pas bon si il ne sait pas où mettre cette ligne de code.
    • "où est-ce aller?" dépend de la façon dont votre point de vue par écrit. Cette réponse est en supposant que vous n'êtes pas à l'utilisation de générique point de vue, mais plutôt à rouler votre propre.
    • Yep, vous avez besoin de remplacer def update(self, request, *args, **kwargs) ou def partial_update(self, request, *args, **kwargs) à l'intérieur de votre point de vue comme Kevin mentionné. La raison que le patch ne fonctionne pas hors de la boîte comme prévu, lorsque vous utilisez ModelSerializer ou Sérialiseur, c'est parce que à l'intérieur de BaseSerializer constructeur, il y a: self.partial = kwargs.pop('partial', False) ce qui signifie que même si vous écrasez !!partial_update!! vous avez encore besoin de passer partial=True lors de la création du sérialiseur. Ainsi, le comportement par défaut du générique de points de vue ci-dessus est mis au rebut.
    • Vous avez pu voir les génériques, voir ma réponse
    • Donc, je suis à l'aide d'un ModelSerializer et RetrieveUpdateDestroyAPIView. Je suis confus sur où spécifier ce partial=True!

    InformationsquelleAutor Kevin Brown
  2. 14

    Comme Kevin Brown a déclaré vous pouvez utiliser le partial=True, qui chefarov précisé joliment.

    Je voudrais juste corriger et dire que vous pourriez utiliser des génériques librement, en fonction de la méthode HTTP utilisée:

    • Si vous utilisez le PATCH méthode HTTP, comme demandé, vous sortir de la boîte. Vous pouvez voir UpdateModelMixin code pour partial_update:

      def partial_update(self, request, *args, **kwargs):
    kwargs['partial'] = True
    return self.update(request, *args, **kwargs)

    • Pour toute méthode HTTP différente de PATCH, ce qui peut être accompli simplement en remplaçant la get_serializer méthode comme suit:

      def get_serializer(self, *args, **kwargs):
    kwargs['partial'] = True
    return super(YOUR_CLASS, self).get_serializer(*args, **kwargs)

    Cela va créer le sérialiseur que partielle, et le reste des médicaments génériques, fonctionne comme un charme sans aucune intervention manuelle dans la mise à jour/partial_update mécanisme.

    Sous le capot

    J'ai utilisé le générique: generics.UpdateAPIView qui utilise le UpdateModelMixin qui a ce code:

    def update(self, request, *args, **kwargs):
    partial = kwargs.pop('partial', False)
    instance = self.get_object()
    serializer = self.get_serializer(instance, data=request.data, partial=partial)
    …

    Donc, si vous remplacez la get_serializer fonction, vous pouvez effectivement remplacer la partielle de l'argumentation et de la force pour être vrai.

    Veuillez noter que si vous voulez seulement partielle pour certaines des méthodes HTTP, ce qui rend cette approche plus difficile.

    Je suis en utilisant djangorestframework==3.5.3

    InformationsquelleAutor Uri Shalit
  3. 5

    Il ne semble pas être pris en charge hors de la boîte. Sur votre navigateur API, accédez à un modèle de page de détail, au fond à côté de la HTML Form onglet, cliquez sur Raw data, supprimer tout le contenu de la chaîne JSON, sauf le champ ID et le champ que vous voulez modifier, puis cliquez sur PATCH. Partielle PATCH mise à jour est effectuée.

    Je suis en utilisant djangorestframework==3.2.4, et n'ont pas eu à faire quelque chose pour mon ViewSets et Sérialiseurs pour permettre cela.

    Dans ce exampe nous mettons à jour l'bool status_field champ du modèle, et je suis en utilisant jquery 2.2.1. Ajouter le texte suivant à la <head>:

    <script src="{% static 'my_app/jquery.min.js' %}"></script>
<script>
$(document).ready(function(){
    var chk_status_field = $('#status_field');
    chk_status_field.click(function(){
        $.ajax({url: "{% url 'model-detail' your_rendering_context.id %}",
            type: 'PATCH', timeout: 3000, data: { status_field: this.checked }
        })
        .fail(function(){
            alert('Error updating this model instance.');
            chk_status_field.prop('checked', !chk_status_field.prop('checked'));
        });
    });
});
</script>

    Puis dans un <form>:

    <input type="checkbox" id="status_field" {% if your_rendering_context.status_field %} 
    checked {% endif %} >

    J'ai choisi de permettre à la case à modifier, puis de revenir en cas d'échec. Mais vous pouvez le remplacer click avec mousedown pour mettre à jour uniquement la case de valeur une fois que l'appel AJAX a réussi. Je pense que cela va conduire à des personnes à plusieurs reprises en cliquant sur la case à cocher pour les connexions lentes si.

    • A travaillé à partir de la boîte! la transmission des données par le biais appel ajax dans un dictionnaire comme l'objet est la chose qui me manquait, merci!
    InformationsquelleAutor Chris
  4. 4

    Si quelqu'un est toujours l'intention de trouver une solution simple à l'aide de ModelSerializer sans changer beaucoup de vos points de vue, vous pouvez sous-classe de la ModelSerializer et d'avoir tous vos ModelSerializers héritent de cette.

    class PatchModelSerializer(serializers.ModelSerializer):
    def __init__(self, *args, **kwargs):
        kwargs['partial'] = True
        super(PatchModelSerializer, self).__init__(*args, **kwargs)

class ArticleSerializer(PatchModelSerializer):
    class Meta:
        model = Article
    • Merci. Cette méthode fonctionne
    InformationsquelleAutor firecast
  5. 0

    J'ai eu du mal avec celui-ci pendant un certain temps, mais il est très simple de mise en œuvre de l'utilisation de générique de vues ou une combinaison de vues génériques et mixin.

    Dans le cas de l'utilisation d'un générique de mettre à jour la vue (les génériques.UpdateAPIView), il suffit d'utiliser le code suivant, s'assurer que le type de demande est PATCH:

    class UpdateUser(generics.UpdateAPIView):

    queryset = User.objects.all()
    serializer_class = UserSerializer

    Il n'y a rien d'autre à lui!

    Si vous utilisez une mise à jour mixin (mixin.UpdateModelMixin) en combinaison avec une vue générique (génériques.GenericAPIView), utilisez le code suivant, s'assurer que le type de demande est PATCH:

    class ActivateUser(mixins.UpdateModelMixin, generics.GenericAPIView):

    serializer_class = UserSerializer
    model = User
    lookup_field = 'email'

    def get_queryset(self):
        queryset = self.model.objects.filter(active=False)
        return queryset

    def patch(self, request, *args, **kwargs):
        return self.partial_update(request, *args, **kwargs)

    Le deuxième exemple est plus complexe, pour vous montrer comment remplacer le queryset et champ de recherche, mais le code que vous devez prêter attention est le patch de la fonction.

    • C'est la seule réponse qui mentionne serializer_class, qui est la façon dont notre point de vue est mis en place. Je vois que dans votre top exemple, vous utilisez une classe appelée UpdateUser. Dites-vous que pour le patch, j'aurais besoin de créer une classe de vue juste pour le PATCH? Puis-je activer le PATCH dans la vue normale de la classe qui comprend la POSTE, etc? Voici comment mon point de vue est mis en place: la classe JobViewSet(viewsets.ModelViewSet): serializer_class = JobSerializer ...
    InformationsquelleAutor user2583728