Atelier 03

[AminaM2]

Étapes de réalisation de l'atelier 03

[AminaM2]

À présent, nous aimerions pouvoir voir, ajouter, modifier et supprimer des polls à partir de l’application web en tant qu’usagers ordinaires. N’oublions pas que seuls les administrateurs peuvent accéder à l’interface utilisateur admin de Django et que le shell n’est pas convivial.

Pour cela, commençons par créer le formulaire qui permettra de créer une nouvelle instance de Poll:

1. Créez un fichier forms.py à la racine de votre app polls. Django nous fournit une classe ModelForm qui permet de créer un formulaire à partir d’un modèle. C’est ce que nous allons faire.
2. Tout d’abord, la classe Meta nous permet de dire à Django quel modèle il doit utiliser pour créer ce formulaire.
3. Puis, il faut spécifier les champs (fields) que nous désirons voir apparaître dans notre formulaire. Si la réponse est tous, on rentre la chaîne ‘_all_’. Dans le cas de Poll, on va exclure le field poller, car ce sera le créateur du poll qui sera le poller par défaut. À savoir qu'il est possible de spécifier un label pour le field et d'ajouter des précisions sur les widgets que l'on veut voir s'afficher (ex: le nombre de rangées et de colonnes de notre textarea)

Maintenant que nos formulaires sont faits, on peut créer nos vues. Il existe 2 types de vues dans Django:

• Les function based views
• Les class based views

Au final, toute vue est une fonction qui prend en paramètres une requête HTTP et retourne une réponse HTTP. Pour cette démo, j’ai choisi de vous montrer uniquement les class based views. L’inconvénient avec les function based views, c’est qu’il faut souvent répéter les mêmes bouts de code alors que les class based views regroupent ces portions de code dans des classes génériques. Les class based views ne remplacent pas les function based views et ne sont pas la solution optimale dans le cas de besoins complexes, mais dans le cas d’un simple CRUD, elles sont l’idéal (exemple de function based view dans l’app accounts) car elles permettent de structurer vos vues et de réutiliser du code en exploitant l’héritage et les « mixins ». Il vous suffit de surcharger ses attributs (comme template_name) ou ses méthodes (comme get_context_data).

La première classe servira à afficher une liste de nos objets polls et héritera donc de la classe générique ListView. Pour cette classe, le seul attribut que l’on aura besoin de définir sera model. Je surchargerai également la variable template_name, mais cela est optionnel (par défaut, le nom du template sera _list.html). Supposons par contre que nous ne voulions pas afficher tous les polls qui se trouvent dans la base de données, mais seulement ceux qui sont actifs. Dans ce cas-là, il nous faudra redéfinir la variable queryset et filtrer les résultats pour n’obtenir que les polls actifs.

À présent, la seule chose qu’il nous manque pour que notre page soit visible par les utilisateurs:

1. Créer un gabarit ou template (par défaut Django va chercher ce gabarit dans : templates//_list.html). On va mettre ce gabarit dans l’app polls étant donné qu’il permet d’afficher la liste des polls. Mais vous pourriez tout aussi bien le mettre à la racine de n’importe quelle app, il s’agit simplement de respecter le path que Django s’attend à rencontrer. Si vous voulez spécifier un nouveau path, il suffit d’overrider la variable template_name, ce que nous allons faire.
2. Puis, il faut mapper la vue que l’on veut créer avec un pattern d’url. Allons donc dans le fichier urls.py à la racine de l’app portant le nom du projet. Il s’agit du fichier de configuration que Django va consulter en premier. Ce que nous voulons, c’est rediriger toutes les requêtes pour lesquelles l’url commence par polls vers notre app polls. Il suffit ensuite de spécifier include(`polls.urls`) qui est le fichier que nous allons créer à l’instant pour contenir les urls qui se rapportent aux polls. Donc, on retourne à la racine de notre app polls et on créer un fichier urls.py. J’importe la vue que je viens de créer et la fonction path fournie par Django pour router les URL vers les vues appropriées.

   Les paramètres à spécifier sont :

   • Le paramètre route doit être une chaîne contenant un motif d’URL.
   • Le paramètre view est une fonction de vue ou le résultat de as_view() pour les vues fondées sur des classes (permet de retourner la classe sous forme de fonction) . Cela peut aussi être une inclusion django.urls.include().
   • Le paramètre kwargs permet de transmettre des paramètres supplémentaires à la fonction ou méthode de vue.
   • Le paramètre name est utile pour nommer l’url et y faire référence plus tard dans les views et les templates. Les liens hardcodés peuvent présenter un sérieux problème de maintenance à mesure qu'un projet se développe, car ils conduisent à des liens difficiles à détecter et à réparer.

   Tout est prêt maintenant! Si l’on rentre l’url localhost:8000/polls, on sera redirigé vers une page blanche, étant donné que l’on n’a rien affiché dans notre template. Si on retourne dans le template en question, on va pouvoir commencer à découvrir quelques-uns des template tags que Django propose pour l’affichage des résultats.

   Template tags

   1. Le premier dont je veux vous parler est le template tag extends. Il est utilisé pour l’héritage de templates en Django (templates && variables). Dans mon cas je veux que mon template poll_list.html extends base.html, qui est un fichier contenu dans l’app pages et qui continent le head et le body de mes pages html. Si l’on se rend dans ce template, on va pouvoir voir le deuxième tag que nous allons utiliser dans cette démo.
   2. Le second tag dont je veux vous parler et qui se trouve dans le fichier base.html se nomme include. Le tag include tag permet de loader un template et de l’afficher dans le contexte courant, donc d’inclure un template dans un autre. Dans mon cas, j’ai choisi d’inclure le template navbar dans le template base.html pour qu’il s’affiches sur chacune des pages de l’application.
   3. Le troisième tag est le tag block qui définit un bloc pouvant être surchargé par les gabarits enfants. Le bloc que j’ai créé se nomme content, donc si je retourne dans le fichier poll_list.html, je peux surcharger le bloc content et insérer le code html que je désire afficher.
   4. À présent, j’aimerais pouvoir afficher la liste d’objets que ma vue m’aura retourné. Bien que nous ne puissions pas le voir, la ListView effectue un traitement en arrière-plan et récupère tous les polls, puis les retourne à mon template dans une variable context. La variable context est en fait un dictionnaire(map en java) avec des noms de variables comme keys et leurs valeurs comme values. Par défaut, le nom de la variable contenant le queryset de polls est object_list. Je peux donc à l’aide de mon troisième tag, le for in, looper à travers tous les résultats et les afficher. Disons que je veux afficher tous les attributs de mon poll, contenu la variable object, je ferais simplement object.nomdelattribut et pour afficher le contenu de cette variable ou de n’importe quelle autre variable, il faut utiliser les double accolades, qui font partie du Django Template Language. . Étant donné que je n’ai aucun poll dans ma base de données, rien ne s’affichera. Cependant, Django fournit une clause empty que l’on peut utiliser pour afficher un résultat différent dans le cas où ma liste serait vide. Cette clause doit s’insérer avant la fin de ma boucle for. La for loop définit un certain nombre de variables que l’on peut utiliser à l’intérieur de la boucle et qui peuvent être très utiles comme :
      • forloop.counter : position dans la boucle (en partant d’un index 1)
      • forloop.counter0 : position dans la boucle (en partant d’un index 0)
      • forloop.revcounter : le nombre d’itérations restantes avant d’atteindre la fin de la boucle (en partant d’un index 1)
      • forloop.revcounter0 : le nombre d’itérations restantes avant d’atteindre la fin de la boucle (en partant d’un index 1)
      • forloop.first : Retourne True si il s’agit de la première iteration dans la boucle
      • forloop.last : Retourne True si il s’agit de la dernière iteration dans la boucle
      • forloop.parentloop: Pour les boucles imbriquées, il s’agit de la boucle parent
   5. L’introduction à la clause empty me permet de vous introduire le prochain tag que nous connaissons tous, le if. Je vais utiliser le tag comment pour commenter ce que nous venons de faire et je vais réaliser la même chose, cette fois en utilisant le tag if. Le fait de simplement écrire if suivi du nom de la variable object_list permet de vérifier que la variable existe, qu’elle n’est pas vide et que l’expression qu’elle contient n’est pas égale à False. (if – elif – else)
   6. The first argument is a URL pattern name. It can be a quoted literal or any other context variable. Additional arguments are optional and should be space-separated values that will be used as arguments in the URL.
   7. Il existe quelques autres tags utiles tel que now qui permet d’afficher la date d’aujourd’hui et de la formatter, mais le templating language de Django est assez minimal et cela pour une raison simple: il a été conçu pour présenter l’information et non pour contenir la logique du programme.

   Après cette petite parenthèse sur les templates, revenons à notre fichier views.py pour ajouter une vue de détail qui affichera l’information spécifique à un poll.

   DetailView

   Créons donc une class based view qui hérite de DetailView (après l’avoir importée bien sûr). Comme pour la vue précédente, je vais redéfinir la variable template_name et je vais tout de suite aller créer mon template que j’appellerais poll_detail.html sous tempaltes/polls, comme le template précédent. Il va lui aussi étendre de base.html et redéfinir le bloc content, qui ne contiendra rien pour le moment.

   Puis, retournons dans le fichier urls.py de l’app. Ajoutons un nouveau pattern. Ce qui va différer par rapport à l’url précédente, c’est le premier paramètre. En effet, à présent, nous devons passer dans l’url l’id de l’objet (car nous désirons afficher les détails d’un objet en particulier), donc nous allons ajouter entre les guillemets des chevrons. À l’intérieur des chevrons, nous allons spécifier le type du paramètre (int dans notre cas), suivi de :, puis du nom du paramètre (pk est le nom que Django à recevoir du côté de la vue, il est possible de le changer, mais cela impliquera l’ajout de quelques lignes de code. Nous allons donc garder pk)

   Il est aussi possible de passer une slug à la place d’un id. Un slug est une courte étiquette pour quelque chose, contenant uniquement des lettres, des chiffres, des traits de soulignement ou des tirets. Il suffit d’ajouter un field slug de type models.SlugField(), puis de définir dans le fichier urls, au lieu d’un int, un slug et au lieu de pk, slug. (plus significatif qu’un id et cache l’id)

   À présent, dans notre template, on peut afficher les informations de l’objet passé en contexte. Le nom de cette variable sera object. Affichons donc tous les attributs de cette variable.

   **À noter que si c’est le titre du livre qui s’affiche lorsque l’on imprime l’attribut book, c’est parce que dans la classe modèle Book, nous avons redéfini la fonction __str__

   À présent, nous voudrions faire le lien entre la page qui permet d’afficher tous les polls et la page de détail d’un poll. Pour cela, nous allons retourner dans le template poll_list.html. Nous allons ajouter un lien (balise html ) qui va nous rediriger vers la page de détail. L’attribut href pointera sur object.get_absolute_url, qui est une méthode que nous devons redéfinir dans la classe modèle. C’est également l’occasion d’introduire le tag url qui permet de rediriger l’utilisateur vers l’url spécifiée en paramètres. C’est donc pour éviter de hardcoder des urls que l’on créera la méthode get_absolute_url. Aussi, il est intéressant de noter qu’à plusieurs endroits, Django va chercher une méthode appelée get_absolute_url dans votre modèle. C’est le cas entre autres lorsque vous utilisez une CreateView sans spécifier de sucess_url. Par défaut, Django vous redirigera vers l’objet nouvellement créé en utilisant la méthode get_absolute_url. La méthode get_absolute_url se sert de la méthode reverse () pour référencer cette URL en utilisant le nom de l’url, spécifié dans le fichier urls.py.

   CreateView

   Créons maintenant une vue pour créer de nouveaux polls. Comme pour les deux vues précédentes, on va hériter de la vue générique appropriée, CreateView dans notre cas. On va redéfinir template_name et form_class, une variable pour laquelle on doit spécifier le formulaire à utiliser.

   Puis, dans le dossier templates, sous polls, on va créer un fichier poll_create.html. Ce template va recevoir dans le contexte une variable form qui contiendra tous les champs du formulaire.

   1. Extends base.html et block content comme pour les autres templates
   2. Nous devons toutefois ajouter une balise html form qui contiendra ces champs et qui définira une méthode d’envoi, POST dans notre cas.
   3. Nous devons également ajouter un input de type submit pour envoyer le formulaire
   4. Nous devons également ajouter le tag csrf_token dans le formulaire. Ce jeton est utilisé pour vérifier que l'utilisateur authentifié est bien celui qui fait les demandes à l'application. Chaque fois que vous définissez un formulaire HTML dans votre application, vous devez inclure un tag csrf_token dans le formulaire afin que le middleware de protection CSRF (que vous pouvez voir dans les settings) puisse valider la demande.
   5. Puis, nous pouvons simplement afficher notre variable form (accolades double) et c’est à ce moment que l’app django-crispy-forms entre en jeu (nous l’avons ajouté dans les installed apps dans le fichier settings). Elle permet d’obtenir un rendu de formulaires Django élégant très facilement à l’aide d’un simple tag et d’un filtre. Pour pouvoir l’utiliser, il faut utiliser le tag load qui charge un lot de balises de gabarit personnalisées (prend autant de paramètres que nécessaire) et charger le tag crispy_form_tags. Puis, vous ajoutez un pipe après votre formulaire et vous ajoutez crispy.

   Et voilà, vous avez un formulaire présentable en quelques minutes seulement!

   Il existe aussi une DeleteView et une UpdateView que nous ne passerons pas en revue, mais vous pouvez regarder le fichier views.py d’une autre app si la syntaxe vous intéresse.