Le traitement de formulaires utilise généralement trois parcours :
\nAffichage initial GET (vierge ou contenu pré-rempli)
Envoi POST avec données non valides (réaffiche normalement le formulaire avec indication des erreurs)
Envoi POST avec données valides (traitement des données normalement suivi par une redirection)
Lorsqu’on implémente soi-même ces étapes, il en résulte souvent beaucoup de code répétitif (voir Utilisation d’un formulaire dans une vue). Pour l’éviter, Django fournit un ensemble de vues génériques fondées sur les classes dédiées au traitement des vues.
\nÉtant donné un formulaire simple de contact :
\nforms.pyfrom django import forms\n\nclass ContactForm(forms.Form):\n name = forms.CharField()\n message = forms.CharField(widget=forms.Textarea)\n\n def send_email(self):\n # send email using the self.cleaned_data dictionary\n pass\nLa vue peut être construite en utilisant une classe FormView:
views.pyfrom myapp.forms import ContactForm\nfrom django.views.generic.edit import FormView\n\nclass ContactView(FormView):\n template_name = 'contact.html'\n form_class = ContactForm\n success_url = '/thanks/'\n\n def form_valid(self, form):\n # This method is called when valid form data has been POSTed.\n # It should return an HttpResponse.\n form.send_email()\n return super(ContactView, self).form_valid(form)\nNotes :
\nFormView hérite de TemplateResponseMixin, ce qui fait qu’on peut utiliser template_name à cet endroit.
L’implémentation par défaut de form_valid() redirige simplement vers success_url.
Les vues génériques brillent particulièrement lorsqu’elles interagissent avec des modèles. Ces vues génériques vont automatiquement créer un formulaire ModelForm, pour autant qu’elles puissent déterminer la classe de modèle à utiliser :
Si l’attribut model est présent, c’est cette classe de modèle qui sera utilisée.
Si get_object() renvoie un objet, c’est la classe de cet objet qui sera utilisée.
Si un attribut queryset est présent, c’est le modèle correspondant à ce jeu de requête qui sera utilisé.
Les vues de formulaire de modèle contiennent une implémentation de form_valid() qui enregistre automatiquement le modèle. Vous pouvez surcharger cela si vous avez des exigences particulières ; voir ci-dessous pour des exemples.
Vous n’avez même pas besoin d’indiquer un attribut success_url pour CreateView ou UpdateView, elles vont utiliser get_absolute_url() sur l’objet de modèle le cas échéant.
Si vous souhaitez utiliser un formulaire ModelForm personnalisé (par exemple pour ajouter de la validation en plus), il suffit de définir form_class dans la vue.
Nous devons d’abord ajouter une méthode get_absolute_url() à notre classe Author:
models.pyfrom django.urls import reverse\nfrom django.db import models\n\nclass Author(models.Model):\n name = models.CharField(max_length=200)\n\n def get_absolute_url(self):\n return reverse('author-detail', kwargs={'pk': self.pk})\nPuis nous pouvons utiliser CreateView et compagnie pour faire le travail. Remarquez que nous avons ici juste à configurer les vues génériques fondées sur les classes ; nous n’avons pas à écrire nous-même de logique de vue :
views.pyfrom django.views.generic.edit import CreateView, UpdateView, DeleteView\nfrom django.urls import reverse_lazy\nfrom myapp.models import Author\n\nclass AuthorCreate(CreateView):\n model = Author\n fields = ['name']\n\nclass AuthorUpdate(UpdateView):\n model = Author\n fields = ['name']\n\nclass AuthorDelete(DeleteView):\n model = Author\n success_url = reverse_lazy('author-list')\nL’attribut fields fonctionne de la même manière que l’attribut fields de la classe interne Meta de ModelForm. Sauf dans les cas où la classe de formulaire est définie d’une autre manière, cet attribut est obligatoire et la vue génère une exception ImproperlyConfigured s’il est absent.
Si vous définissez à la fois les attributs fields et form_class, une exception ImproperlyConfigured est générée.
Finalement, nous connectons ces nouvelles vues dans la configuration d’URL :
\nurls.pyfrom django.conf.urls import url\nfrom myapp.views import AuthorCreate, AuthorUpdate, AuthorDelete\n\nurlpatterns = [\n # ...\n url(r'author/add/$', AuthorCreate.as_view(), name='author-add'),\n url(r'author/(?P<pk>[0-9]+)/$', AuthorUpdate.as_view(), name='author-update'),\n url(r'author/(?P<pk>[0-9]+)/delete/$', AuthorDelete.as_view(), name='author-delete'),\n]\nrequest.userLien vers cette rubrique#Pour garder trace de l’utilisateur ayant créé un objet en utilisant CreateView, vous pouvez utiliser un formulaire ModelForm personnalisé. Premièrement, ajoutez la relation de clé étrangère dans le modèle :
models.pyfrom django.contrib.auth.models import User\nfrom django.db import models\n\nclass Author(models.Model):\n name = models.CharField(max_length=200)\n created_by = models.ForeignKey(User, on_delete=models.CASCADE)\n\n # ...\nDans la vue, prenez soin de ne pas inclure created_by dans la liste des champs modifiables et surchargez form_valid() afin d’ajouter l’utilisateur :
views.pyfrom django.views.generic.edit import CreateView\nfrom myapp.models import Author\n\nclass AuthorCreate(CreateView):\n model = Author\n fields = ['name']\n\n def form_valid(self, form):\n form.instance.created_by = self.request.user\n return super(AuthorCreate, self).form_valid(form)\nNotez que vous devrez décorer cette vue par login_required() ou trouver un autre moyen de gérer les accès d’utilisateurs non autorisés dans form_valid().
Voici un exemple simple montrant une possible implémentation d’un formulaire fonctionnant aussi bien pour des requêtes AJAX que pour des envois de formulaire POST « normaux » :
\nfrom django.http import JsonResponse\nfrom django.views.generic.edit import CreateView\nfrom myapp.models import Author\n\nclass AjaxableResponseMixin(object):\n """\n Mixin to add AJAX support to a form.\n Must be used with an object-based FormView (e.g. CreateView)\n """\n def form_invalid(self, form):\n response = super(AjaxableResponseMixin, self).form_invalid(form)\n if self.request.is_ajax():\n return JsonResponse(form.errors, status=400)\n else:\n return response\n\n def form_valid(self, form):\n # We make sure to call the parent's form_valid() method because\n # it might do some processing (in the case of CreateView, it will\n # call form.save() for example).\n response = super(AjaxableResponseMixin, self).form_valid(form)\n if self.request.is_ajax():\n data = {\n 'pk': self.object.pk,\n }\n return JsonResponse(data)\n else:\n return response\n\nclass AuthorCreate(AjaxableResponseMixin, CreateView):\n model = Author\n fields = ['name']\n