pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
<li><ahref="#_gestion_des_utilisateurs">23.1. Gestion des utilisateurs</a></li>
<li><ahref="#_gestion_des_listes">23.2. Gestion des listes</a></li>
<li><ahref="#_gestion_des_souhaits">23.3. Gestion des souhaits</a></li>
<li><ahref="#_gestion_des_réalisations_de_souhaits">23.4. Gestion des réalisations de souhaits</a></li>
<li><ahref="#_gestion_des_personnes_réalisants_les_souhaits_et_qui_ne_sont_pas_connues">23.5. Gestion des personnes réalisants les souhaits et qui ne sont pas connues</a></li>
<p>On ne va pas se mentir: il existe enormément de tutoriaux très bien réalisés sur "Comment réaliser une application Django" et autres "Déployer votre code en 2 minutes". On se disait juste que ces tutoriaux restaient relativement haut-niveau et se limitaient à un contexte donné.</p>
</div>
<divclass="paragraph">
<p>L’idée du texte ci-dessous est de jeter les bases d’un bon développement, en survolant l’ensemble des outils permettant de suivre des lignes directrices reconnues, de maintenir une bonne qualité de code au travers des différentes étapes (du développement au déploiement) et de s’assurer du maintient correct de la base de code, en permettant à n’importe qui de reprendre le développement.</p>
</div>
<divclass="paragraph">
<p>Ces idées ne s’appliquent pas uniquement à Django et à son cadre de travail, ni même au langage Python. Juste que ces deux bidules sont de bons candidats et que le cadre de travail est bien défini et suffisamment flexible.</p>
</div>
<divclass="paragraph">
<p>Django se présente comme un `Framework Web pour perfectionnistes ayant des deadlines <<ahref="https://www.djangoproject.com/>`_"class="bare">https://www.djangoproject.com/>`_</a>.</p>
</div>
<divclass="paragraph">
<p>Django suit quelques principes <<ahref="https://docs.djangoproject.com/en/dev/misc/design-philosophies/>"class="bare">https://docs.djangoproject.com/en/dev/misc/design-philosophies/></a>:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Faible couplage et forte cohésion, pour que chaque composant ait son indépendance.</p>
</li>
<li>
<p>Moins de code, plus de fonctionnalités.</p>
</li>
<li>
<p>`Don’t repeat yourself <<ahref="https://fr.wikipedia.org/wiki/Sec>`_"class="bare">https://fr.wikipedia.org/wiki/Sec>`_</a>: ne pas se répéter!</p>
</li>
<li>
<p>Rapidité du développement (après une courbe d’apprentissage relativement ardue, malgré tout)</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Mis côté à côté, l’application de ces principes permet une meilleure stabilité du projet. Dans la suite de ce chapitre, on verra comment configurer l’environnement, comment installer Django de manière isolée et comment démarrer un nouveau projet. On verra comment gérer correctement les dépendances, les versions et comment applique un score sur note code.</p>
</div>
<divclass="paragraph">
<p>Finalement, on verra aussique la configuration proposée par défaut par le framework n’est pas idéale pour la majorité des cas.</p>
</div>
<divclass="paragraph">
<p>Pour cela, on présentera différents outils (mypy, flake8, black, …​), la rédaction de tests unitaires et d’intégration pour limiter les régressions, les règles de nomenclature et de contrôle du contenu, ainsi que les bonnes étapes à suivre pour arriver à un déploiement rapide et fonctionnel avec peu d’efforts.</p>
</div>
<divclass="paragraph">
<p>Et tout ça à un seul et même endroit. Oui. :-)</p>
</div>
<divclass="paragraph">
<p>Bonne lecture.</p>
</div>
</div>
</div>
<h1id="_environnement_de_travail"class="sect0">Environnement de travail</h1>
<divclass="openblock partintro">
<divclass="content">
<divclass="paragraph">
<p>Avant de démarrer le développement, il est nécessaire de passer un peu de temps sur la configuration de l’environnement.</p>
</div>
<divclass="paragraph">
<p>Les morceaux de code seront développés pour Python3.4+ et Django 1.8+. Ils nécessiteront peut-être quelques adaptations pour fonctionner sur une version antérieure.</p>
</div>
<divclass="paragraph">
<p><strong>Remarque</strong> : les commandes qui seront exécutés dans ce livre le seront depuis un shell sous GNU/Linux. Certaines devront donc être adaptées si vous êtes dans un autre environnemnet.</p>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_méthodologie_de_travail">1. Méthodologie de travail</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>Pour la méthode de travail et de développement, on va se baser sur les <ahref="https://12factor.net/fr/">The Twelve-factor App</a> - ou plus simplement les <strong>12 facteurs</strong>.</p>
</div>
<divclass="paragraph">
<p>L’idée derrière cette méthode consiste à pousser les concepts suivants (repris grossièrement de la <ahref="https://12factor.net/fr/">page d’introduction</a> :</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Faciliter la mise en place de phases d’automatisation; plus simplement, faciliter les mises à jour applicatives, simplifier la gestion de l’hôte, diminuer la divergence entre les différents environnements d’exécution et offrir la possibilité d’intégrer le projet dans un processus d’<ahref="https://en.wikipedia.org/wiki/Continuous_integration">intégration continue</a>/<ahref="https://en.wikipedia.org/wiki/Continuous_deployment">déploiement continu</a></p>
</li>
<li>
<p>Faciliter la mise à pied de nouveaux développeurs ou de personnes souhaitant rejoindre le projet.</p>
</li>
<li>
<p>Faciliter</p>
</li>
<li>
<p>Augmenter l’agilité générale du projet, en permettant une meilleure évolutivité architecturale et une meilleure mise à l’échelle - <em>Vous avez 5000 utilisateurs en plus? Ajoutez un serveur et on n’en parle plus ;-)</em>.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>En pratique, les idées planquées derrière les quelques phrases ci-dessus permettront de monter facilement un nouvel environnement - qu’il soit sur la machine du petit nouveau ou sur un serveur Azure, Heroku, Digital Ocean ou votre nouveau Raspberry Pi Zéro caché à la cave.</p>
</div>
<divclass="paragraph">
<p>Pour reprendre de manière très brute les différentes idées derrière cette méthode, on a:</p>
</div>
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
pensez à retravailler la partie ci-dessous; la version anglophone semble plus compréhensible…​ :-/
</td>
</tr>
</table>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Une base de code suivie avec un système de contrôle de version, plusieurs déploiements</p>
</li>
<li>
<p>Déclarez explicitement et isolez les dépendances</p>
</li>
<li>
<p>Stockez la configuration dans l’environnement</p>
</li>
<li>
<p>Traitez les services externes comme des ressources attachées</p>
</li>
<li>
<p>Séparez strictement les étapes d’assemblage et d’exécution</p>
</li>
<li>
<p>Exécutez l’application comme un ou plusieurs processus sans état</p>
</li>
<li>
<p>Exportez les services via des associations de ports</p>
</li>
<li>
<p>Grossissez à l’aide du modèle de processus</p>
</li>
<li>
<p>Maximisez la robustesse avec des démarrages rapides et des arrêts gracieux</p>
</li>
<li>
<p>Gardez le développement, la validation et la production aussi proches que possible</p>
</li>
<li>
<p>Traitez les logs comme des flux d’évènements</p>
</li>
<li>
<p>Lancez les processus d’administration et de maintenance comme des one-off-processes</p>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Chaque déploiement démarre à partir d’une base de code unique. Il n’y pas de dépôt "Prod", "Staging" ou "Dev". Il n’y en a qu’un et un seul.</p></td>
</tr>
<tr>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Déclaration explicite et isolation des dépendances</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Afin de ne pas perturber les dépendances systèmes, chaque application doit disposer d’un environnement sain par défaut.</p></td>
</tr>
<tr>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Configuration dans l’environnement</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Toute clé de configuration (nom du serveur de base de données, adresse d’un service Web externe, clé d’API pour l’interrogation d’une ressource, …​) sera définie directement au niveau de l’hôte - à aucun moment, on ne doit trouver un mot de passe en clair dans le dépôt source ou une valeur susceptible d’évoluer, écrite en dur dans le code.</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Chaque ressource doit pouvoir être interchangeable avec une autre, sans modification du code source. La solution consiste à passer toutes ces informations (nom du serveur et type de base de données, clé d’authentification, …​) directement via des variables d’environnement.</p></td>
</tr>
<tr>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Bien séparer les étapes de construction des étapes de mise à disposition</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">Capistrano, Gitea, un serveur d’artefacts, …​</p></td>
<tdclass="tableblock halign-left valign-top"><pclass="tableblock">L’idée est de pouvoir récupérer une version spécifique du code, sans que celle-ci ne puisse avoir été modifiée. Git permet bien de gérer des versions (au travers des tags), mais ces éléments peuvent sans doute être modifiés directement au travers de l’historique.</p></td>
<p>On va commencer avec la partie la moins funky, mais la plus utile, dans la vie d’un développeur: la gestion et l’isolation des dépendances.</p>
</div>
<divclass="paragraph">
<p>Il est tout à fait possible de s’en passer complètement dans le cadre de "petits" projets ou d’applications déployées sur des machines dédiées, et de fonctionner à grand renforts de "sudo" et d’installation globale des dépendances. Cette pratique est cependant fortement déconseillée pour plusieurs raisons:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Pour la reproductibilité d’un environnement spécifique. Cela évite notamment les réponses type "Ca juste marche chez moi", puisqu’on a la possibilité de construire un environnement sain et appliquer des dépendances identiques, quelle que soit la machine hôte.</p>
</li>
<li>
<p>Il est tout à fait envisagable que deux applications soient déployées sur un même hôte, et nécessitent chacune deux versions différentes d’une même dépendance.</p>
</li>
</ol>
</div>
<divclass="quoteblock">
<blockquote>
<divclass="paragraph">
<p>But it works on my machine! Then, we’ll ship your machine.</p>
</div>
</blockquote>
<divclass="attribution">
— A famous meme<br>
<cite>And this is how Docker was born.</cite>
</div>
</div>
<divclass="paragraph">
<p>Nous allons utiliser le module <code>venv</code> afin de créer un `environnement virtuel <<ahref="http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_"class="bare">http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/>`_</a> pour python.</p>
</div>
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
auparavant, on utilisait <code>virtualenvwrapper</code>. mais cela fait plusieurs années que je ne l’utilise plus. On l’intègre quand même ?
</td>
</tr>
</table>
</div>
<divclass="sect2">
<h3id="_création_de_lenvironnement_virtuel">2.1. Création de l’environnement virtuel</h3>
<divclass="paragraph">
<p>Commencons par créer un environnement virtuel, afin d’y stocker les dépendances. Lancez <code>python3 -m venv gwift-env</code>.</p>
<p>Le <strong>shell</strong> signale que nous sommes bien dans l’environnement <code>gwift-env</code> en l’affichant avant le <code>$</code>. Par la suite, nous considérerons que l’environnement virtuel est toujours activé, même si <code>gwift-env</code> n’est pas présent devant chaque <code>$</code>.</p>
</div>
<divclass="paragraph">
<p>A présent, tous les binaires de cet environnement prendront le pas sur les binaires du système. De la même manière, une variable <code>PATH</code> propre est définie et utilisée, afin que les librairies Python y soient stockées. C’est donc dans cet environnement virtuel que nous retrouverons le code source de Django, ainsi que des librairies externes pour Python une fois que nous les aurons installées.</p>
</div>
<divclass="paragraph">
<p>Pour désactiver l’environnement virtuel, il suffira d’utiliser la commande <code>deactivate</code></p>
</div>
</div>
<divclass="sect2">
<h3id="_installation_de_django_et_création_du_répertoire_de_travail">2.2. Installation de Django et création du répertoire de travail</h3>
<divclass="paragraph">
<p>Comme l’environnement est activé, on peut à présent y installer Django. La librairie restera indépendante du reste du système, et ne polluera pas les autres projets.</p>
<p>Les commandes de création d’un nouveau site sont à présent disponibles, la principale étant <code>django-admin startproject</code>. Par la suite, nous utiliserons <code>manage.py</code>, qui constitue un <strong>wrapper</strong> autour de <code>django-admin</code>.</p>
</div>
<divclass="paragraph">
<p>Pour démarrer notre projet, nous lançons donc <code>django-admin startproject gwift</code>.</p>
<p>C’est sans ce répertoire que vont vivre tous les fichiers liés au projet. Le but est de faire en sorte que toutes les opérations (maintenance, déploiement, écriture, tests, …​) puissent se faire à partir d’un seul point d’entrée. Tant qu’on y est, nous pouvons rajouter les répertoires utiles à la gestion de notre projet, à savoir la documentation, les dépendances et le README:</p>
<p><code>settings.py</code> contient tous les paramètres globaux à notre projet.</p>
</li>
<li>
<p><code>urls.py</code> contient les variables de routes, les adresses utilisées et les fonctions vers lesquelles elles pointent.</p>
</li>
<li>
<p><code>manage.py</code>, pour toutes les commandes de gestion.</p>
</li>
<li>
<p><code>wsgi.py</code> contient la définition de l’interface `WSGI <<ahref="https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface>`_"class="bare">https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface>`_</a>, qui permettra à votre serveur Web (Nginx, Apache, …​) de faire un pont vers votre projet.</p>
</li>
</ul>
</div>
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
déplacer la configuration dans un répertoire <code>config</code> à part.
</td>
</tr>
</table>
</div>
</div>
<divclass="sect2">
<h3id="_gestion_des_dépendances">2.3. Gestion des dépendances</h3>
<divclass="paragraph">
<p>Comme nous venons d’ajouter une dépendance à notre projet, nous allons créer un fichier reprenant tous les dépendances de notre projet. Celles-ci sont normalement placées dans un fichier <code>requirements.txt</code>. Dans un premier temps, ce fichier peut être placé directement à la racine du projet, mais on préférera rapidement le déplacer dans un sous-répertoire spécifique (<code>requirements</code>), afin de grouper les dépendances en fonction de leur utilité:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p><code>base.txt</code></p>
</li>
<li>
<p><code>dev.txt</code></p>
</li>
<li>
<p><code>staging.txt</code></p>
</li>
<li>
<p><code>production.txt</code></p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Au début de chaque fichier, il suffira d’ajouter la ligne <code>-r base.txt</code>, puis de lancer l’installation grâce à un <code>pip install -r <nom du fichier></code>. De cette manière, il est tout à fait acceptable de n’installer <code>flake8</code> et <code>django-debug-toolbar</code> qu’en développement par exemple. Dans l’immédiat, ajoutez simplement <code>django</code> dans le fichier <code>requirements/base.txt</code>.</p>
<p>Par la suite, il vous faudra <strong>absolument</strong> spécifier les versions à utiliser: les librairies que vous utilisez comme dépendances évoluent, de la même manière que vos projets. Des fonctions sont cassées, certaines signatures sont modifiées, des comportements sont altérés, etc. Si vous voulez être sûr et certain que le code que vous avez écrit continue à fonctionner, spécifiez la version de chaque librairie de dépendances. Avec les mécanismes d’intégration continue et de tests unitaires, on verra plus loin comment se prémunir d’un changement inattendu.</p>
</div>
</div>
<divclass="sect2">
<h3id="_structure_finale_de_lenvironnement">2.4. Structure finale de l’environnement</h3>
<divclass="paragraph">
<p>Nous avons donc la strucutre finale pour notre environnement de travail:</p>
<p>Comme on l’a vu ci-dessus, <code>django-admin</code> permet de créer un nouveau projet. On fait ici une distinction entre un <strong>projet</strong> et une <strong>application</strong>:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p><strong>Projet</strong>: ensemble des applications, paramètres, pages HTML, middlwares, dépendances, etc., qui font que votre code fait ce qu’il est sensé faire.</p>
</li>
<li>
<p><strong>Application</strong>: <strong>contexte</strong> éventuellement indépendant, permettant d’effectuer une partie isolée de ce que l’on veut faire.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Pour <code>gwift</code>, on va notamment avoir une application pour la gestion des listes de souhaits et des éléments, une deuxième application pour la gestion des utilisateurs, voire une troisième application qui gérera les partages entre utilisateurs et listes.</p>
</div>
<divclass="paragraph">
<p>On voit bien ici le principe de <strong>contexte</strong>: l’application viendra avec son modèle, ses tests, ses vues et son paramétrage. Elle pourra éventuellement être réutilisée dans un autre projet. C’est en ça que consistent les `paquets Django <<ahref="https://www.djangopackages.com/>`_"class="bare">https://www.djangopackages.com/>`_</a> déjà disponibles: ce sont simplement de petites applications empaquetées pour être réutilisées (eg. `Django-Rest-Framework <<ahref="https://github.com/tomchristie/django-rest-framework>`"class="bare">https://github.com/tomchristie/django-rest-framework>`</a><em>, `Django-Debug-Toolbar <<ahref="https://github.com/django-debug-toolbar/django-debug-toolbar>`"class="bare">https://github.com/django-debug-toolbar/django-debug-toolbar>`</a></em>, …​).</p>
</div>
<divclass="sect2">
<h3id="_gestion">3.1. Gestion</h3>
<divclass="paragraph">
<p>Comme expliqué un peu plus haut, le fichier <code>manage.py</code> est un <strong>wrapper</strong> sur les commandes <code>django-admin</code>. A partir de maintenant, nous n’utiliserons plus que celui-là pour tout ce qui touchera à la gestion de notre projet:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p><code>manage.py check</code> pour vérifier (en surface…​) que votre projet ne rencontre aucune erreur</p>
</li>
<li>
<p><code>manage.py runserver</code> pour lancer un serveur de développement</p>
</li>
<li>
<p><code>manage.py test</code> pour découvrir les tests unitaires disponibles et les lancer.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>La liste complète peut être affichée avec <code>manage.py help</code>. Vous remarquerez que ces commandes sont groupées selon différentes catégories:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p><strong>auth</strong>: création d’un nouveau super-utilisateur, changer le mot de passe pour un utilisateur existant.</p>
</li>
<li>
<p><strong>django</strong>: vérifier la <strong>compliance</strong> du projet, lancer un <strong>shell</strong>, <strong>dumper</strong> les données de la base, effectuer une migration du schéma, …​</p>
</li>
<li>
<p><strong>sessions</strong>: suppressions des sessions en cours</p>
</li>
<li>
<p><strong>staticfiles</strong>: gestion des fichiers statiques et lancement du serveur de développement.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Nous verrons plus tard comment ajouter de nouvelles commandes.</p>
<p>Maintenant que l’on a vu à quoi servait <code>manage.py</code>, on peut créer notre nouvelle application grâce à la commande <code>manage.py startapp <label></code>.</p>
</div>
<divclass="paragraph">
<p>Cette application servira à structurer les listes de souhaits, les éléments qui les composent et les parties que chaque utilisateur pourra offrir. Essayez de trouver un nom éloquent, court et qui résume bien ce que fait l’application. Pour nous, ce sera donc <code>wish</code>. C’est parti pour <code>manage.py startapp wish</code>!</p>
<p>En résumé, chaque fichier a la fonction suivante:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p><code>admin.py</code> servira à structurer l’administration de notre application. Chaque information peut en effet être administrée facilement au travers d’une interface générée à la volée par le framework. On y reviendra par la suite.</p>
</li>
<li>
<p><code><em>init</em>.py</code> pour que notre répertoire <code>wish</code> soit converti en package Python.</p>
</li>
<li>
<p><code>migrations/</code>, dossier dans lequel seront stockées toutes les différentes migrations de notre application.</p>
</li>
<li>
<p><code>models.py</code> pour représenter et structurer nos données.</p>
</li>
<li>
<p><code>tests.py</code> pour les tests unitaires.</p>
<p>Plein de trucs à compléter ici ;-) Est-ce qu’on passe par pytest ou par le framework intégré ? Quels sont les avantages de l’un % à l’autre ?
* <code>views.py</code> pour définir ce que nous pouvons faire avec nos données.</p>
</div>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_construire_des_applications_maintenables">4. Construire des applications maintenables</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>Pour cette section, je me base d’un résumé de l’ebook <strong>Building Maintenable Software</strong> disponible chez `O’Reilly <<ahref="http://shop.oreilly.com/product/0636920049555.do`_"class="bare">http://shop.oreilly.com/product/0636920049555.do`_</a> qui vaut clairement le détour pour poser les bases d’un projet.</p>
</div>
<divclass="paragraph">
<p>Ce livre répartit un ensemble de conseils parmi quatre niveaux de composants:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Les méthodes et fonctions</p>
</li>
<li>
<p>Les classes</p>
</li>
<li>
<p>Les composants</p>
</li>
<li>
<p>Et de manière plus générale.</p>
</li>
</ul>
</div>
<divclass="sect2">
<h3id="_au_niveau_des_méthodes_et_fonctions">4.1. Au niveau des méthodes et fonctions</h3>
<divclass="ulist">
<ul>
<li>
<p>Gardez vos méthodes/fonctions courtes. Pas plus de 15 lignes, en comptant les commentaires. Des exceptions sont possibles, mais dans une certaine mesure uniquement (pas plus de 6.9% de plus de 60 lignes; pas plus de 22.3% de plus de 30 lignes, au plus 43.7% de plus de 15 lignes et au moins 56.3% en dessous de 15 lignes). Oui, c’est dur à tenir, mais faisable.</p>
</li>
<li>
<p>Conserver une complexité de McCabe en dessous de 5, c’est-à-dire avec quatre branches au maximum. A nouveau, si on a une méthode avec une complexité cyclomatique de 15, la séparer en 3 fonctions avec une complexité de 5 conservera globalement le nombre 15, mais rendra le code de chacune de ces méthodes plus lisible, plus maintenable.</p>
</li>
<li>
<p>N’écrivez votre code qu’une seule fois: évitez les duplications, copie, etc., c’est juste mal: imaginez qu’un bug soit découvert dans une fonction; il devra alors être corrigé dans toutes les fonctions qui auront été copiées/collées. C’est aussi une forme de régression.</p>
</li>
<li>
<p>Conservez de petites interfaces. Quatre paramètres, pas plus. Au besoin, refactorisez certains paramètres dans une classe, plus facile à tester.</p>
</li>
</ul>
</div>
</div>
<divclass="sect2">
<h3id="_au_niveau_des_classes">4.2. Au niveau des classes</h3>
<divclass="ulist">
<ul>
<li>
<p>Privilégiez un couplage faible entre vos classes. Ceci n’est pas toujours possible, mais dans la mesure du possible, éclatez vos classes en fonction de leur domaine de compétences. L’implémentation du service <code>UserNotificationsService</code> ne doit pas forcément se trouver embarqué dans une classe <code>UserService</code>. De même, pensez à passer par une interface (commune à plusieurs classes), afin d’ajouter une couche d’abstraction. La classe appellante n’aura alors que les méthodes offertes par l’interface comme points d’entrée.</p>
</li>
</ul>
</div>
</div>
<divclass="sect2">
<h3id="_au_niveau_des_composants">4.3. Au niveau des composants</h3>
<divclass="ulist">
<ul>
<li>
<p>Tout comme pour les classes, il faut conserver un couplage faible au niveau des composants également. Une manière d’arriver à ce résultat est de conserver un nombre de points d’entrée restreint, et d’éviter qu’on ne puisse contacter trop facilement des couches séparées de l’architecture. Pour une architecture n-tiers par exemple, la couche d’abstraction à la base de données ne peut être connue que des services; sans cela, au bout de quelques semaines, n’importe quelle couche de présentation risque de contacter directement la base de données, "juste parce qu’elle en a la possibilité". Vous pourrez également passer par des interfaces, afin de réduire le nombre de points d’entrée connus par un composant externe (qui ne connaîtra par exemple que <code>IFileTransfer</code> avec ses méthodes <code>put</code> et <code>get</code>, et non pas les détails d’implémentation complet d’une classe <code>FtpFileTransfer</code> ou <code>SshFileTransfer</code>).</p>
</li>
<li>
<p>Conserver un bon balancement au niveau des composants: évitez qu’un composant <strong>A</strong> ne soit un énorme mastodonte, alors que le composant juste à côté n’est capable que d’une action. De cette manière, les nouvelles fonctionnalités seront mieux réparties parmi les différents systèmes, et les responsabilités plus faciles à gérer. Un conseil est d’avoir un nombre de composants compris entre 6 et 12 (idéalement, 12), et que ces composants soit approximativement de même taille.</p>
</li>
</ul>
</div>
</div>
<divclass="sect2">
<h3id="_de_manière_plus_générale">4.4. De manière plus générale</h3>
<divclass="ulist">
<ul>
<li>
<p>Conserver une densité de code faible: il n’est évidemment pas possible d’implémenter n’importe quelle nouvelle fonctionnalité en moins de 20 lignes de code; l’idée ici est que la réécriture du projet ne prenne pas plus de 20 hommes/mois. Pour cela, il faut (activement) passer du temps à réduire la taille du code existant: soit en faisant du refactoring (intensif?), soit en utilisant des librairies existantes, soit en explosant un système existant en plusieurs sous-systèmes communiquant entre eux. Mais surtout en évitant de copier/coller bêtement du code existant.</p>
</li>
<li>
<p>Automatiser les tests, ajouter un environnement d’intégration continue dès le début du projet et vérifier par des outils les points ci-dessus.</p>
</li>
</ul>
</div>
</div>
<divclass="sect2">
<h3id="_en_pratique">4.5. En pratique</h3>
<divclass="paragraph">
<p>Par rapport aux points repris ci-dessus, l’environnement Python et le framework Django proposent un ensemble d’outils intégrés qui permettent de répondre à chaque point. Avant d’aller plus loin, donc, un petit point sur les conventions, les tests (unitaires, orientés comportement, basés sur la documentation, …​), la gestion de version du code et sur la documentation. Plus que dans tout langage compilé, ceux-ci sont pratiquement obligatoires. Vous pourrez les voir comme une perte de temps dans un premier temps, mais nous vous promettons qu’ils vous en feront gagner par la suite.</p>
<p>Le langage Python fonctionne avec un système d’améliorations basées sur des propositions: les PEP, ou “Python Enhancement Proposal”.</p>
</div>
<divclass="paragraph">
<p>Celle qui va nous intéresser pour cette section est la <ahref="https://www.python.org/dev/peps/pep-0008/">PEP 8 — Style Guide for Python Code</a>. Elle spécifie comment du code Python doit être organisé ou formaté, quelles sont les conventions pour l’indentation, le nommage des variables et des classes, … En bref, elle décrit comment écrire du code proprement pour que d’autres développeurs puissent le reprendre facilement, ou simplement que votre base de code ne dérive lentement vers un seuil de non-maintenabilité.</p>
</div>
<divclass="sect2">
<h3id="_pep8">5.1. PEP8</h3>
<divclass="paragraph">
<p>Le langage Python fonctionne avec un système d’améliorations basées sur des propositions: les PEP, ou "<strong>Python Enhancement Proposal</strong>". Chacune d’entre elles doit être approuvée par le `Benevolent Dictator For Life <<ahref="http://fr.wikipedia.org/wiki/Benevolent_Dictator_for_Life>`_"class="bare">http://fr.wikipedia.org/wiki/Benevolent_Dictator_for_Life>`_</a>.</p>
</div>
<divclass="paragraph">
<p>La PEP qui nous intéresse plus particulièrement pour la suite est la `PEP-8 <<ahref="https://www.python.org/dev/peps/pep-0008/>`_"class="bare">https://www.python.org/dev/peps/pep-0008/>`_</a>, ou "Style Guide for Python Code". Elle spécifie des conventions d’organisation et de formatage de code Python, quelles sont les conventions pour l’indentation, le nommage des variables et des classes, etc. En bref, elle décrit comment écrire du code proprement pour que d’autres développeurs puissent le reprendre facilement, ou simplement que votre base de code ne dérive lentement vers un seuil de non-maintenabilité.</p>
</div>
<divclass="paragraph">
<p>Sur cette base, un outil existe et listera l’ensemble des conventions qui ne sont pas correctement suivies dans votre projet: pep8. Pour l’installer, passez par pip. Lancez ensuite la commande pep8 suivie du chemin à analyser (<code>.</code>, le nom d’un répertoire, le nom d’un fichier <code>.py</code>, …​). Si vous souhaitez uniquement avoir le nombre d’erreur de chaque type, saisissez les options <code>--statistics -qq</code>.</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre>$ pep8 . --statistics -qq</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>7 E101 indentation contains mixed spaces and tabs
6 E122 continuation line missing indentation or outdented
8 E127 continuation line over-indented for visual indent
23 E128 continuation line under-indented for visual indent
3 E131 continuation line unaligned for hanging indent
12 E201 whitespace after '{'
13 E202 whitespace before '}'
86 E203 whitespace before ':'</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Si vous ne voulez pas être dérangé sur votre manière de coder, et que vous voulez juste avoir un retour sur une analyse de votre code, essayez <code>pyflakes</code>: il analysera vos sources à la recherche de sources d’erreurs possibles (imports inutilisés, méthodes inconnues, etc.).</p>
</div>
<divclass="paragraph">
<p>Finalement, la solution qui couvre ces deux domaines existe et s’intitule `flake8 <<ahref="https://github.com/PyCQA/flake8>`_"class="bare">https://github.com/PyCQA/flake8>`_</a>. Sur base la même interface que <code>pep8</code>, vous aurez en plus tous les avantages liés à <code>pyflakes</code> concernant votre code source.</p>
</div>
<divclass="sect3">
<h4id="_pep257">5.1.1. PEP257</h4>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>todo:: à remplir avec <code>pydocstyle</code>.</p>
</li>
</ol>
</div>
</div>
<divclass="sect3">
<h4id="_tests">5.1.2. Tests</h4>
<divclass="paragraph">
<p>Comme tout bon <strong>framework</strong> qui se respecte, Django embarque tout un environnement facilitant le lancement de tests; chaque application est créée par défaut avec un fichier <strong>tests.py</strong>, qui inclut la classe <code>TestCase</code> depuis le package <code>django.test</code>:</p>
<p>Idéalement, chaque fonction ou méthode doit être testée afin de bien en valider le fonctionnement, indépendamment du reste des composants. Cela permet d’isoler chaque bloc de manière unitaire, et permet de ne pas rencontrer de régression lors de l’ajout d’une nouvelle fonctionnalité ou de la modification d’une existante. Il existe plusieurs types de tests (intégration, comportement, …​); on ne parlera ici que des tests unitaires.</p>
</div>
<divclass="paragraph">
<p>Avoir des tests, c’est bien. S’assurer que tout est testé, c’est mieux. C’est là qu’il est utile d’avoir le pourcentage de code couvert par les différents tests, pour savoir ce qui peut être amélioré.</p>
</div>
</div>
<divclass="sect3">
<h4id="_couverture_de_code">5.1.3. Couverture de code</h4>
<divclass="paragraph">
<p>La couverture de code est une analyse qui donne un pourcentage lié à la quantité de code couvert par les tests. Attention qu’il ne s’agit pas de vérifier que le code est <strong>bien</strong> testé, mais juste de vérifier <strong>quelle partie</strong> du code est testée. En Python, il existe le paquet `coverage <<ahref="https://pypi.python.org/pypi/coverage/>`_"class="bare">https://pypi.python.org/pypi/coverage/>`_</a>, qui se charge d’évaluer le pourcentage de code couvert par les tests. Ajoutez-le dans le fichier <code>requirements/base.txt</code>, et lancez une couverture de code grâce à la commande <code>coverage</code>. La configuration peut se faire dans un fichier <code>.coveragerc</code> que vous placerez à la racine de votre projet, et qui sera lu lors de l’exécution.</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre># requirements/base.text
[...]
coverage
django_coverage_plugin</pre>
</div>
</div>
</li>
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre># .coveragerc to control coverage.py
[run]
branch = True
omit = ../*migrations*
plugins =
django_coverage_plugin</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>[report]
ignore_errors = True</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>[html]
directory = coverage_html_report</pre>
</div>
</div>
</li>
<li>
<p>todo:: le bloc ci-dessous est à revoir pour isoler la configuration.</p>
</li>
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre>$ coverage run --source "." manage.py test
$ coverage report</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>Name Stmts Miss Cover
---------------------------------------------
gwift\gwift\__init__.py 0 0 100%
gwift\gwift\settings.py 17 0 100%
gwift\gwift\urls.py 5 5 0%
gwift\gwift\wsgi.py 4 4 0%
gwift\manage.py 6 0 100%
gwift\wish\__init__.py 0 0 100%
gwift\wish\admin.py 1 0 100%
gwift\wish\models.py 49 16 67%
gwift\wish\tests.py 1 1 0%
gwift\wish\views.py 6 6 0%
---------------------------------------------
TOTAL 89 32 64%</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>$ coverage html</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Ceci vous affichera non seulement la couverture de code estimée, et générera également vos fichiers sources avec les branches non couvertes. Pour gagner un peu de temps, n’hésitez pas à créer un fichier <code>Makefile</code> que vous placerez à la racine du projet. L’exemple ci-dessous permettra, grâce à la commande <code>make coverage</code>, d’arriver au même résultat que ci-dessus:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre># Makefile for gwift
#</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre># User-friendly check for coverage
ifeq ($(shell which coverage >/dev/null 2>&1; echo $$?), 1)
$(error The 'coverage' command was not found. Make sure you have coverage installed)
endif</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>.PHONY: help coverage</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>help:
@echo " coverage to run coverage check of the source files."</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>coverage:
coverage run --source='.' manage.py test; coverage report; coverage html;
@echo "Testing of coverage in the sources finished."</pre>
</div>
</div>
</li>
</ol>
</div>
</div>
<divclass="sect3">
<h4id="_complexité_de_mccabe">5.1.4. Complexité de McCabe</h4>
<divclass="paragraph">
<p>La `complexité cyclomatique <<ahref="https://fr.wikipedia.org/wiki/Nombre_cyclomatique>`_"class="bare">https://fr.wikipedia.org/wiki/Nombre_cyclomatique>`_</a> (ou complexité de McCabe) peut s’apparenter à mesure de difficulté de compréhension du code, en fonction du nombre d’embranchements trouvés dans une même section. Quand le cycle d’exécution du code rencontre une condition, il peut soit rentrer dedans, soit passer directement à la suite. Par exemple:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: python</p>
<divclass="literalblock">
<divclass="content">
<pre>if True == True:
pass # never happens</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre># continue ...</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>La condition existe, mais on ne passera jamais dedans. A l’inverse, le code suivant aura une complexité pourrie à cause du nombre de conditions imbriquées:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: python</p>
<divclass="literalblock">
<divclass="content">
<pre>def compare(a, b, c, d, e):
if a == b:
if b == c:
if c == d:
if d == e:
print('Yeah!')
return 1</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Potentiellement, les tests unitaires qui seront nécessaires à couvrir tous les cas de figure seront au nombre de quatre: le cas par défaut (a est différent de b, rien ne se passe), puis les autres cas, jusqu’à arriver à l’impression à l’écran et à la valeur de retour. La complexité cyclomatique d’un bloc est évaluée sur base du nombre d’embranchements possibles; par défaut, sa valeur est de 1. Si on rencontre une condition, elle passera à 2, etc.</p>
</div>
<divclass="paragraph">
<p>Pour l’exemple ci-dessous, on va en fait devoir vérifier au moins chacun des cas pour s’assurer que la couverture est complète. On devrait donc trouver:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Un test pour entrer (ou non) dans la condition <code>a == b</code></p>
</li>
<li>
<p>Un test pour entrer (ou non) dans la condition <code>b == c</code></p>
</li>
<li>
<p>Un test pour entrer (ou non) dans la condition <code>c == d</code></p>
</li>
<li>
<p>Un test pour entrer (ou non) dans la condition <code>d == e</code></p>
</li>
<li>
<p>Et s’assurer que n’importe quel autre cas retournera la valeur <code>None</code>.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>On a donc bien besoin de minimum cinq tests pour couvrir l’entièreté des cas présentés.</p>
</div>
<divclass="paragraph">
<p>Le nombre de tests unitaires nécessaires à la couverture d’un bloc est au minimum égal à la complexité cyclomatique de ce bloc. Une possibilité pour améliorer la maintenance du code est de faire baisser ce nombre, et de le conserver sous un certain seuil. Certains recommandent de le garder sous une complexité de 10; d’autres de 5.</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>note::</p>
<divclass="literalblock">
<divclass="content">
<pre>Evidemment, si on refactorise un bloc pour en extraire une méthode, cela n'améliorera pas sa complexité cyclomatique globale</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>A nouveau, un greffon pour <code>flake8</code> existe et donnera une estimation de la complexité de McCabe pour les fonctions trop complexes. Installez-le avec <code>pip install mccabe</code>, et activez-le avec le paramètre <code>--max-complexity</code>. Toute fonction dans la complexité est supérieure à cette valeur sera considérée comme trop complexe.</p>
</div>
</div>
<divclass="sect3">
<h4id="_documentation">5.1.5. Documentation</h4>
<divclass="paragraph">
<p>Il existe plusieurs manières de générer la documentation d’un projet. Les plus connues sont `Sphinx <<ahref="http://sphinx-doc.org/>`_"class="bare">http://sphinx-doc.org/>`_</a> et `MkDocs <<ahref="http://www.mkdocs.org/>`"class="bare">http://www.mkdocs.org/>`</a><em>. Le premier a l’avantage d’être plus reconnu dans la communauté Python que l’autre, de pouvoir <strong>parser</strong> le code pour en extraire la documentation et de pouvoir lancer des `tests orientés documentation <<ahref="https://duckduckgo.com/?q=documentation+driven+development&t=ffsb>`"class="bare">https://duckduckgo.com/?q=documentation+driven+development&t=ffsb>`</a></em>. A contrario, votre syntaxe devra respecter `ReStructuredText <<ahref="https://en.wikipedia.org/wiki/ReStructuredText>`_"class="bare">https://en.wikipedia.org/wiki/ReStructuredText>`_</a>. Le second a l’avantage d’avoir une syntaxe plus simple à apprendre et à comprendre, mais est plus limité dans son résultat.</p>
</div>
<divclass="paragraph">
<p>Dans l’immédiat, nous nous contenterons d’avoir des modules documentés (quelle que soit la méthode Sphinx/MkDocs/…​). Dans la continuié de <code>Flake8</code>, il existe un greffon qui vérifie la présence de commentaires au niveau des méthodes et modules développés.</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>note::</p>
<divclass="literalblock">
<divclass="content">
<pre>voir si il ne faudrait pas mieux passer par pydocstyle.</pre>
</div>
</div>
</li>
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre>$ pip install flake8_docstrings</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Lancez ensuite <code>flake8</code> avec la commande <code>flake8 . --exclude="migrations"</code>. Sur notre projet (presque) vide, le résultat sera le suivant:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: shell</p>
<divclass="literalblock">
<divclass="content">
<pre>$ flake8 . --exclude="migrations"
.\src\manage.py:1:1: D100 Missing docstring in public module
.\src\gwift\__init__.py:1:1: D100 Missing docstring in public module
.\src\gwift\urls.py:1:1: D400 First line should end with a period (not 'n')
.\src\wish\__init__.py:1:1: D100 Missing docstring in public module
.\src\wish\admin.py:1:1: D100 Missing docstring in public module
.\src\wish\admin.py:1:1: F401 'admin' imported but unused
.\src\wish\models.py:1:1: D100 Missing docstring in public module
.\src\wish\models.py:1:1: F401 'models' imported but unused
.\src\wish\tests.py:1:1: D100 Missing docstring in public module
.\src\wish\tests.py:1:1: F401 'TestCase' imported but unused
.\src\wish\views.py:1:1: D100 Missing docstring in public module
.\src\wish\views.py:1:1: F401 'render' imported but unused</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Bref, on le voit: nous n’avons que très peu de modules, et aucun d’eux n’est commenté.</p>
</div>
<divclass="paragraph">
<p>En plus de cette méthode, Django permet également de rendre la documentation accessible depuis son interface d’administration.</p>
<p>Un outil existe et listera l’ensemble des conventions qui ne sont pas correctement suivies dans votre projet: pep8. Pour l’installer, passez par pip. Lancez ensuite la commande pep8 suivie du chemin à analyser (., le nom d’un répertoire, le nom d’un fichier .py, …​).</p>
</div>
<divclass="paragraph">
<p>Si vous ne voulez pas être dérangé sur votre manière de coder, et que vous voulez juste avoir un retour sur une analyse de votre code, essayez pyflakes: il analaysera vos sources à la recherche d’erreurs (imports inutilsés, méthodes inconnues, etc.).</p>
</div>
<divclass="paragraph">
<p>Et finalement, si vous voulez grouper les deux, il existe flake8. Sur base la même interface que pep8, vous aurez en plus des avertissements concernant le code source.</p>
test.py:18:1: W391 blank line at end of file</code></pre>
</div>
</div>
<divclass="paragraph">
<p>On trouve des erreurs:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>de <strong>conventions</strong>: le nombre de lignes qui séparent deux fonctions, le nombre d’espace après un opérateur, une ligne vide à la fin du fichier, …​ Ces <em>erreurs</em> n’en sont pas vraiment, elles indiquent juste de potentiels problèmes de communication si le code devait être lu ou compris par une autre personne.</p>
</li>
<li>
<p>de <strong>définition</strong>: une variable assignée mais pas utilisée ou une lexème non trouvé. Cette dernière information indique clairement un bug potentiel.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>L’étape d’après consiste à invoquer pylint. Lui, il est directement moins conciliant:</p>
<p>En gros, j’ai programmé comme une grosse bouse anémique (et oui, le score d’évaluation du code permet bien d’aller en négatif). En vrac, on trouve des problèmes liés:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>au nommage (C0103) et à la mise en forme (C0305, C0326, W0105)</p>
</li>
<li>
<p>à des variables non définies (E0602)</p>
</li>
<li>
<p>de la documentation manquante (C0114, C0116)</p>
</li>
<li>
<p>de la redéfinition de variables (W0621).</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Pour reprendre la <ahref="http://pylint.pycqa.org/en/latest/user_guide/message-control.html">documentation</a>, chaque code possède sa signification (ouf!):</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>C convention related checks</p>
</li>
<li>
<p>R refactoring related checks</p>
</li>
<li>
<p>W various warnings</p>
</li>
<li>
<p>E errors, for probable bugs in the code</p>
</li>
<li>
<p>F fatal, if an error occurred which prevented pylint from doing further* processing.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>PyLint est la version <strong>++</strong>, pour ceux qui veulent un code propre et sans bavure.</p>
</div>
</div>
<divclass="sect2">
<h3id="_black">5.3. Black</h3>
</div>
<divclass="sect2">
<h3id="_pytest">5.4. pytest</h3>
</div>
<divclass="sect2">
<h3id="_mypy">5.5. mypy</h3>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_git">6. Git</h2>
<divclass="sectionbody">
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
insérer ici une description de Gitflow + quelques exemples types création, ajout, suppression, historique, branches, …​ et quelques schémas qui-vont-bien.
</td>
</tr>
</table>
</div>
<divclass="paragraph">
<p>Il existe plusiseurs outils permettant de gérer les versions du code, dont les plus connus sont `git <<ahref="https://git-scm.com/>`_"class="bare">https://git-scm.com/>`_</a> et `mercurial <<ahref="https://www.mercurial-scm.org/>`_"class="bare">https://www.mercurial-scm.org/>`_</a>.</p>
</div>
<divclass="paragraph">
<p>Dans notre cas, nous utilisons git et hebergons le code et le livre directement sur le gitlab de `framasoft <<ahref="https://git.framasoft.org/>`_"class="bare">https://git.framasoft.org/>`_</a></p>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_graphviz">7. graphviz</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>En utilisant django_extensions (! bien suivre les étapes d’installation !).</p>
<p>C’est ici que le projet <ahref="http://cookiecutter.readthedocs.io/en/latest/readme.html">CookieCutter</a> va être intéressant: les X premières étapes peuvent être <strong>bypassées</strong> par une simple commande.</p>
<p>On va déjà parler de déploiement. Le serveur que django met à notre disposition est prévu uniquement pour le développement: inutile de passer par du code Python pour charger des fichiers statiques (feuilles de style, fichiers JavaScript, images, …​). De même, la base de donnée doit supporter plus qu’un seul utilisateur: SQLite fonctionne très bien dès lors qu’on se limite à un seul utilisateur…​ Sur une application Web, il est plus que probable que vous rencontriez rapidement des erreurs de base de données verrouillée pour écriture par un autre processus. Il est donc plus que bénéfique de passer sur quelque chose de plus solide.</p>
</div>
<divclass="paragraph">
<p>Si vous avez suivi les étapes jusqu’ici, vous devriez à peine disposer d’un espace de travail proprement configuré, d’un modèle relativement basique et d’une configuration avec une base de données simpliste. En bref, vous avez quelque chose qui fonctionne, mais qui ressemble de très loin à ce que vous souhaitez au final.</p>
<p>Il y a une raison très simple à aborder le déploiement dès maintenant: à trop attendre et à peaufiner son développement en local, on en oublie que sa finalité sera de se retrouver exposé sur un serveur. On risque d’avoir oublié une partie des désidérata, d’avoir zappé une fonctionnalité essentielle ou simplement de passer énormément de temps à adapter les sources pour qu’elles fonctionnent sur un environnement en particulier.</p>
</div>
<divclass="paragraph">
<p>Aborder le déploiement maintenant permet également de rédiger dès le début les procédures d’installation, de mise à jour et de sauvegardes. Déploier une nouvelle version sera aussi simple que de récupérer la dernière archive depuis le dépôt, la placer dans le bon répertoire, appliquer des actions spécifiques (et souvent identiques entre deux versions), puis redémarrer les services adéquats.</p>
</div>
<divclass="paragraph">
<p>Dans cette partie, on abordera les points suivants:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>La définition de l’infrastructure nécessaire à notre application</p>
</li>
<li>
<p>La configuration de l’hôte, qui hébergera l’application: dans une machine physique, virtuelle ou dans un container. On abordera aussi rapidement les déploiements via Ansible, Chef, Puppet ou Salt.</p>
</li>
<li>
<p>Les différentes méthodes de supervision de l’application: comment analyser les fichiers de logs et comment intercepter correctement une erreur si elle se présente et comment remonter l’information.</p>
</li>
<li>
<p>Une partie sur la sécurité et la sécurisation de l’hôte.</p>
<p>Comme on l’a vu dans la première partie, Django est un framework complet, intégrant tous les mécanismes nécessaires à la bonne évolution d’une application. On peut ainsi commencer petit, et suivre l’évolution des besoins en fonction de la charge estimée ou ressentie, ajouter un mécanisme de mise en cache, des logiciels de suivi, …​</p>
<p>Aussi : Docker, Heroku, Digital Ocean, Scaleway, OVH, …​ Bref, sur Debian et CentOS pour avoir un panel assez large. On oublie Windows.</p>
<p>On l’a déjà vu, Django se base sur un pattern type ActiveRecords pour l’ORM.</p>
</div>
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
à vérifier ;-)
</td>
</tr>
</table>
</div>
<divclass="paragraph">
<p>et supporte les principaux moteurs de bases de données connus: MariaDB (en natif depuis Django 3.0), PostgreSQL au travers de psycopg2 (en natif aussi), Microsoft SQLServer grâce aux drivers […​à compléter] ou Oracle via <ahref="https://oracle.github.io/python-cx_Oracle/">cx_Oracle</a>.</p>
</div>
<divclass="admonitionblock warning">
<table>
<tr>
<tdclass="icon">
<divclass="title">Warning</div>
</td>
<tdclass="content">
Chaque pilote doit être utilisé précautionneusement ! Chaque version de Django n’est pas toujours compatible avec chacune des versions des pilotes, et chaque moteur de base de données nécessite parfois une version spécifique du pilote. De fait, vous serez parfois bloqué sur une version de Django, simplement parce que votre serveur de base de données se trouvera dans une version spécifique (eg. Django 2.3 à cause d’un Oracle 12.1).
</td>
</tr>
</table>
</div>
<divclass="paragraph">
<p>Ci-dessous, quelques procédures d’installation pour mettre un serveur à disposition. Les deux plus simples seront MariaDB et PostgreSQL, qu’on couvrira ci-dessous. Oracle et Microsoft SQLServer se trouveront en annexes.</p>
</div>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_postgresql">11. PostgreSQL</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>On commence par installer PostgreSQL.</p>
</div>
<divclass="paragraph">
<p>Par exemple, dans le cas de debian, on exécute la commande suivante:</p>
Dans ce chapitre, on va parler de plusieurs concepts utiles au développement rapide d’une application. On parlera de modélisation, de migrations, d’administration auto-générée.
<p>On va aborder la modélisation des objets en elle-même, qui s’apparente à la conception de la base de données.</p>
</div>
<divclass="paragraph">
<p>Django utilise un modèle <ahref="https://fr.wikipedia.org/wiki/Mapping_objet-relationnel">ORM</a> - c’est-à-dire que chaque objet peut s’apparenter à une table SQL, mais en ajoutant une couche propre au paradigme orienté objet. Il sera ainsi possible de définir facilement des notions d’héritage (tout en restant dans une forme d’héritage simple), la possibilité d’utiliser des propriétés spécifiques, des classes intermédiaires, …​</p>
</div>
<divclass="paragraph">
<p>L’avantage de tout ceci est que tout reste au niveau du code. Si l’on revient sur la méthodologie des douze facteurs, ce point concerne principalement la minimisation de la divergence entre les environnements d’exécution. Déployer une nouvelle instance de l’application pourra être réalisé directement à partir d’une seule et même commande, dans la mesure où <strong>tout est embarqué au niveau du code</strong>.</p>
<p>Ou comment valider proprement des données entrantes.</p>
</div>
<divclass="admonitionblock note">
<table>
<tr>
<tdclass="icon">
<divclass="title">Note</div>
</td>
<tdclass="content">
intégrer le dessin XKCD avec Little Bobby Table sur l’assainissement des données en entrée :-p
</td>
</tr>
</table>
</div>
<divclass="paragraph">
<p>Quand on parle de <code>forms</code>, on ne parle pas uniquement de formulaires Web. On pourrait considérer qu’il s’agit de leur objectif principal, mais on peut également voir un peu plus loin: on peut en fait voir les <code>forms</code> comme le point d’entrée pour chaque donnée arrivant dans notre application: il s’agit en quelque sorte d’un ensemble de règles complémentaires à celles déjà présentes au niveau du modèle.</p>
</div>
<divclass="paragraph">
<p>L’exemple le plus simple est un fichier <code>.csv</code>: la lecture de ce fichier pourrait se faire de manière très simple, en récupérant les valeurs de chaque colonne et en l’introduisant dans une instance du modèle.</p>
</div>
<divclass="paragraph">
<p>Mauvaise idée.</p>
</div>
<divclass="paragraph">
<p>Les données fournies par un utilisateur <strong>doivent</strong><strong>toujours</strong> être validées avant introduction dans la base de données. Notre base de données étant accessible ici par l’ORM, la solution consiste à introduire une couche supplémentaire de validation.</p>
</div>
<divclass="paragraph">
<p>Le flux à suivre est le suivant:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Création d’une instance grâce à un dictionnaire</p>
</li>
<li>
<p>Validation des données et des informations reçues</p>
</li>
<li>
<p>Traitement, si la validation a réussi.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Ils jouent également plusieurs rôles:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Validation des données, en plus de celles déjà définies au niveau du modèle</p>
</li>
<li>
<p>Contrôle sur le rendu à appliquer aux champs</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Ils agissent come une glue entre l’utilisateur et la modélisation de vos structures de données.</p>
<p>Un <strong>form</strong> peut dépendre d’une autre classe Django. Pour cela, il suffit de fixer l’attribut <code>model</code> au niveau de la <code>class Meta</code> dans la définition.</p>
<p>De cette manière, notre form dépendra automatiquement des champs déjà déclarés dans la classe <code>Wishlist</code>. Cela suit le principe de <code>DRY <don’t repeat yourself>`_, et évite qu’une modification ne pourrisse le code: en testant les deux champs présent dans l’attribut `fields</code>, nous pourrons nous assurer de faire évoluer le formulaire en fonction du modèle sur lequel il se base.</p>
<p>Le formulaire permet également de contrôler le rendu qui sera appliqué lors de la génération de la page. Si les champs dépendent du modèle sur lequel se base le formulaire, ces widgets doivent être initialisés dans l’attribut <code>Meta</code>. Sinon, ils peuvent l’être directement au niveau du champ.</p>
<p>Comme on l’a vu à l’instant, les forms, en Django, c’est le bien. Cela permet de valider des données reçues en entrée et d’afficher (très) facilement des formulaires à compléter par l’utilisateur.</p>
</div>
<divclass="paragraph">
<p>Par contre, c’est lourd. Dès qu’on souhaite peaufiner un peu l’affichage, contrôler parfaitement ce que l’utilisateur doit remplir, modifier les types de contrôleurs, les placer au pixel près, …​ Tout ça demande énormément de temps. Et c’est là qu’intervient `Django-Crispy-Forms <<ahref="http://django-crispy-forms.readthedocs.io/en/latest/>`_"class="bare">http://django-crispy-forms.readthedocs.io/en/latest/>`_</a>. Cette librairie intègre plusieurs frameworks CSS (Bootstrap, Foundation et uni-form) et permet de contrôler entièrement le <strong>layout</strong> et la présentation.</p>
</div>
<divclass="paragraph">
<p>(c/c depuis le lien ci-dessous)</p>
</div>
<divclass="paragraph">
<p>Pour chaque champ, crispy-forms va :</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>utiliser le <code>verbose_name</code> comme label.</p>
</li>
<li>
<p>vérifier les paramètres <code>blank</code> et <code>null</code> pour savoir si le champ est obligatoire.</p>
</li>
<li>
<p>utiliser le type de champ pour définir le type de la balise <code><input></code>.</p>
</li>
<li>
<p>récupérer les valeurs du paramètre <code>choices</code> (si présent) pour la balise <code><select></code>.</p>
<p>Les migrations (comprendre les "migrations du schéma de base de données") sont intimement liées à la représentation d’un contexte fonctionnel. L’ajout d’une nouvelle information, d’un nouveau champ ou d’une nouvelle fonction peut s’accompagner de tables de données à mettre à jour ou de champs à étendre.</p>
</div>
<divclass="paragraph">
<p>Toujours dans une optique de centralisation, les migrations sont directement embarquées au niveau du code. Le développeur s’occupe de créer les migrations en fonction des actions à entreprendre; ces migrations peuvent être retravaillées, <em>squashées</em>, …​ et feront partie intégrante du processus de mise à jour de l’application.</p>
<p>Dans un <strong>pattern</strong> MVC classique, la traduction immédiate du <strong>contrôleur</strong> est une <strong>vue</strong>. Et comme on le verra par la suite, la <strong>vue</strong> est en fait le <strong>template</strong>.
Les vues agrègent donc les informations à partir d’un des composants et les font transiter vers un autre. En d’autres mots, la vue sert de pont entre les données gérées par la base et l’interface utilisateur.</p>
</div>
<divclass="sect2">
<h3id="_vues">19.1. Vues</h3>
<divclass="paragraph">
<p>Une vue correspond à un contrôleur dans le pattern MVC. Tout ce que vous pourrez définir au niveau du fichier <code>views.py</code> fera le lien entre le modèle stocké dans la base de données et ce avec quoi l’utilisateur pourra réellement interagir (le <code>template</code>).</p>
</div>
<divclass="paragraph">
<p>Chaque vue peut etre représentée de deux manières: soit par des fonctions, soit par des classes. Le comportement leur est propre, mais le résultat reste identique. Le lien entre l’URL à laquelle l’utilisateur accède et son exécution est faite au travers du fichier <code>gwift/urls.py</code>, comme on le verra par la suite.</p>
</div>
<divclass="sect3">
<h4id="_function_based_views">19.1.1. Function Based Views</h4>
<divclass="paragraph">
<p>Les fonctions (ou <code>FBV</code> pour <strong>Function Based Views</strong>) permettent une implémentation classique des contrôleurs. Au fur et à mesure de votre implémentation, on se rendra compte qu’il y a beaucoup de répétitions dans ce type d’implémentation: elles ne sont pas obsolètes, mais dans certains cas, il sera préférable de passer par les classes.</p>
<p>Pour définir la liste des <code>WishLists</code> actuellement disponibles, on précédera de la manière suivante:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Définition d’une fonction qui va récupérer les objets de type <code>WishList</code> dans notre base de données. La valeur de retour sera la construction d’un dictionnaire (le <strong>contexte</strong>) qui sera passé à un template HTML. On démandera à ce template d’effectuer le rendu au travers de la fonction <code>render</code>, qui est importée par défaut dans le fichier <code>views.py</code>.</p>
</li>
<li>
<p>Construction d’une URL qui permettra de lier l’adresse à l’exécution de la fonction.</p>
</li>
<li>
<p>Définition du squelette.</p>
</li>
</ol>
</div>
<divclass="sect4">
<h5id="_définition_de_la_fonction">Définition de la fonction</h5>
<p>A ce stade, vérifiez que la variable <code>TEMPLATES</code> est correctement initialisée dans le fichier <code>gwift/settings.py</code> et que le fichier <code>templates/wish/list.html</code> ressemble à ceci:</p>
<p>Lancez le serveur grâce à la commande <code>python manage.py runserver</code>, ouvrez un navigateur quelconque et rendez-vous à l’adresse `http://localhost:8000 <<ahref="http://localhost:8000>`_"class="bare">http://localhost:8000>`_</a>. Vous devriez obtenir le résultat suivant:</p>
<p>Rien de très sexy, aucune interaction avec l’utilisateur, très peu d’utilisation des variables contextuelles, mais c’est un bon début! =)</p>
<p>Les classes, de leur côté, implémente le <strong>pattern</strong> objet et permettent d’arriver facilement à un résultat en très peu de temps, parfois même en définissant simplement quelques attributs, et rien d’autre. Pour l’exemple, on va définir deux classes qui donnent exactement le même résultat que la fonction <code>wishlists</code> ci-dessus. Une première fois en utilisant une classe générique vierge, et ensuite en utilisant une classe de type <code>ListView</code>.</p>
<p>Les classes génériques implémentent un aspect bien particulier de la représentation d’un modèle, en utilisant très peu d’attributs. Les principales classes génériques sont de type <code>ListView</code>, […​]. L’implémentation consiste, exactement comme pour les fonctions, à:</p>
<p>C’est tout. Lancez le serveur, le résultat sera identique. Par inférence, Django construit beaucoup d’informations: si on n’avait pas spécifié les variables <code>context_object_name</code> et <code>template_name</code>, celles-ci auraient pris les valeurs suivantes:</p>
<p>Avant de commencer à interagir avec nos données au travers de listes, formulaires et IHM sophistiquées, quelques mots sur les templates: il s’agit en fait de <strong>squelettes</strong> de présentation, recevant en entrée un dictionnaire contenant des clés-valeurs et ayant pour but de les afficher dans le format que vous définirez. En intégrant un ensemble de <strong>tags</strong>, cela vous permettra de greffer les données reçues en entrée dans un patron prédéfini.</p>
<p>Notre première vue permettra de récupérer la liste des objets de type <code>Wishlist</code> que nous avons définis dans le fichier <code>wish/models.py</code>. Supposez que cette liste soit accessible <strong>via</strong> la clé <code>wishlists</code> d’un dictionnaire passé au template. Elle devient dès lors accessible grâce aux tags <code>{% for wishlist in wishlists %}</code>. A chaque tour de boucle, on pourra directement accéder à la variable <code>{{ wishlist }}</code>. De même, il sera possible d’accéder aux propriétés de cette objet de la même manière: <code>{{ wishlist.id }}</code>, <code>{{ wishlist.description }}</code>, …​ et d’ainsi respecter la mise en page que nous souhaitons.</p>
<p>Il est conseillé que les templates respectent la structure de vos différentes applications, mais dans un répertoire à part. Par convention, nous les placerons dans un répertoire <code>templates</code>. La hiérarchie des fichiers devient alors celle-ci:</p>
<p>Par défaut, Django cherchera les templates dans les répertoirer d’installation. Vous devrez vous éditer le fichier <code>gwift/settings.py</code> et ajouter, dans la variable <code>TEMPLATES</code>, la clé <code>DIRS</code> de la manière suivante:</p>
<p>Django vient avec un ensemble de <strong>tags</strong>. On a vu la boucle <code>for</code> ci-dessus, mais il existe <ahref="https://docs.djangoproject.com/fr/1.9/ref/templates/builtins/">beaucoup d’autres tags nativement présents</a>. Les principaux sont par exemple:</p>
<p><code>{% if …​ %} …​ {% elif …​ %} …​ {% else %} …​ {% endif %}</code>: permet de vérifier une condition et de n’afficher le contenu du bloc que si la condition est vérifiée.</p>
<p>En plus des quelques tags survolés ci-dessus, il est également possible de construire ses propres tags. La structure est un peu bizarre, car elle consiste à ajouter un paquet dans une de vos applications, à y définir un nouveau module et à y définir un ensemble de fonctions. Chacune de ces fonctions correspondra à un tag appelable depuis vos templates.</p>
<p>Les filtres - on peut les appeler grâce au <strong>pipe</strong><code>|</code> directement après une valeur dans le template.</p>
</li>
<li>
<p>Les tags simples - ils peuvent prendre une valeur ou plusieurs en paramètre et retourne une nouvelle valeur. Pour les appeler, c’est <strong>via</strong> les tags <code>{% nom_de_la_fonction param1 param2 …​ %}</code>.</p>
</li>
<li>
<p>Les tags d’inclusion: ils retournent un contexte (ie. un dictionnaire), qui est ensuite passé à un nouveau template.</p>
<p>On prend l’application <code>wish</code> et on y ajoute un répertoire <code>templatetags</code>, ainsi qu’un fichier <code><em>init</em>.py</code>.</p>
</li>
<li>
<p>Dans ce nouveau paquet, on ajoute un nouveau module que l’on va appeler <code>tools.py</code></p>
</li>
<li>
<p>Dans ce module, pour avoir un aperçu des possibilités, on va définir trois fonctions (une pour chaque type de tags possible).</p>
<p>Pour plus d’informations, la <ahref="https://docs.djangoproject.com/en/stable/howto/custom-template-tags/#writing-custom-template-tags">documentation officielle est un bon début</a>.
<p>Pour que nos pages soient un peu plus <strong>eye-candy</strong> que ce qu’on a présenté ci-dessus, nous allons modifié notre squelette pour qu’il se base sur <code>Bootstrap <<ahref="http://getbootstrap.com/>`_"class="bare">http://getbootstrap.com/>`_</a>. Nous placerons une barre de navigation principale, la possibilité de se connecter pour l’utilisateur et définirons quelques emplacements à utiliser par la suite. Reprenez votre fichier `base.html</code> et modifiez le comme ceci:</p>
<p>La première ligne du fichier inclut le <strong>tag</strong><code>{% load staticfiles %}</code>. On y reviendra par la suite, mais en gros, cela permet de faciliter la gestion des fichiers statiques, notamment en les appelent grâce à la commande <code>{% static 'img/header.png' %}</code> ou <code>{% static 'css/app_style.css' %}</code>.</p>
<p>Les balises <code>{% block content %} {% endblock %}</code> permettent de faire hériter du contenu depuis une autre page. On l’utilise notamment dans notre page <code>templates/wish/list.html</code>.</p>
<p>Pour l’entête et le bas de page, on fait appel aux balises <code>{% include 'nom_du_fichier.html' %}</code>: ces fichiers sont des fichiers physiques, placés sur le filesystem, juste à côté du fichier <code>base.html</code>. De façon bête et méchante, cela inclut juste du contenu HTML. Le contenu des fichiers <code>_menu_items.html</code> et <code>_footer.html</code> est copié ci-dessous.</p>
<p>En fonction de vos affinités, vous pourriez également passer par `PluCSS <<ahref="http://plucss.pluxml.org/>`"class="bare">http://plucss.pluxml.org/>`</a><em>, `Pure <<ahref="http://purecss.io/>`"class="bare">http://purecss.io/>`</a></em>, `Knacss <<ahref="http://knacss.com/>`"class="bare">http://knacss.com/>`</a><em>, `Cascade <<ahref="http://www.cascade-framework.com/>`"class="bare">http://www.cascade-framework.com/>`</a></em>, `Semantic <<ahref="http://semantic-ui.com/>`_"class="bare">http://semantic-ui.com/>`_</a> ou `Skeleton <<ahref="http://getskeleton.com/>`_"class="bare">http://getskeleton.com/>`_</a>. Pour notre plus grand bonheur, les frameworks de ce type pullulent. Reste à choisir le bon.</p>
</div>
<divclass="paragraph">
<p><strong>A priori</strong>, si vous relancez le serveur de développement maintenant, vous devriez déjà voir les modifications…​ Mais pas les images, ni tout autre fichier statique.</p>
<p>Si vous ouvrez la page et que vous lancez la console de développement (F12, sur la majorité des navigateurs), vous vous rendrez compte que certains fichiers ne sont pas disponibles. Il s’agit des fichiers suivants:</p>
<p><code>django.contrib.staticfiles.finders.FileSystemFinder</code> et . <code>django.contrib.staticfiles.finders.AppDirectoriesFinder</code>.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>En fait, Django va considérer un répertoire <code>static</code> à l’intérieur de chaque application. Si deux fichiers portent le même nom, le premier trouvé sera pris. Par facilité, et pour notre développement, nous placerons les fichiers statiques dans le répertoire <code>gwift/static</code>. On y trouve donc:</p>
</div>
<divclass="listingblock">
<divclass="content">
<preclass="highlight"><codeclass="language-bash"data-lang="bash">[inclure un tree du répertoire gwift/static]</code></pre>
</div>
</div>
<divclass="paragraph">
<p>Pour indiquer à Django que vous souhaitez aller y chercher vos fichiers, il faut initialiser la <code>variable <<ahref="https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-STATICFILES_DIRS>`_"class="bare">https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-STATICFILES_DIRS>`_</a> `STATICFILES_DIRS</code> dans le fichier <code>settings/base.py</code>. Vérifiez également que la variable <code>STATIC_URL</code> est correctement définie.</p>
<p>En production par contre, nous ferons en sorte que le contenu statique soit pris en charge par le front-end Web (Nginx), raison pour laquelle cette variable n’est initialisée que dans le fichier des paramètres liés au développement.</p>
</div>
<divclass="paragraph">
<p>Au final, cela ressemble à ceci:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>image:: mvc/my-first-wishlists.png
:align: center
=== URLs</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>La gestion des URLs permet <strong>grosso modo</strong> d’assigner une adresse paramétrée ou non à une fonction Python. La manière simple consiste à modifier le fichier <code>gwift/settings.py</code> pour y ajouter nos correspondances. Par défaut, le fichier ressemble à ceci:</p>
<p>Le champ <code>urlpatterns</code> associe un ensemble d’adresses à des fonctions. Dans le fichier <strong>nu</strong>, seul le <strong>pattern</strong><code>admin`_ est défini, et inclut toutes les adresses qui sont définies dans le fichier `admin.site.urls</code>. Reportez-vous à l’installation de l’environnement: ce fichier contient les informations suivantes:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>_`admin`: Rappelez-vous de vos expressions régulières: <code>^</code> indique le début de la chaîne.</p>
</li>
<li>
<p>code-block:: python</p>
<divclass="literalblock">
<divclass="content">
<pre># admin.site.urls.py</pre>
</div>
</div>
</li>
</ol>
</div>
</div>
<divclass="sect3">
<h4id="_reverse">19.1.7. Reverse</h4>
<divclass="paragraph">
<p>En associant un nom ou un libellé à chaque URL, il est possible de récupérer sa <strong>traduction</strong>. Cela implique par contre de ne plus toucher à ce libellé par la suite…​</p>
</div>
<divclass="paragraph">
<p>Dans le fichier <code>urls.py</code>, on associe le libellé <code>wishlists</code> à l’URL <code>r'^$</code> (c’est-à-dire la racine du site):</p>
Ne pas oublier de parler des sessions. Mais je ne sais pas si c’est le bon endroit.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_logging">20. Logging</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>Si on veut propager les logs entre applications, il faut bien spécifier l’attribut <code>propagate</code>, sans quoi on s’arrêtera au module sans prendre en considération les sous-modules.</p>
<p>Le log sera écrit dans la console <strong>ET</strong> dans le fichier.</p>
</div>
<divclass="paragraph">
<p>Par contre, si on retire l’attribut <code>propagate: True</code> (ou qu’on le change en <code>propagate: False</code>), le même code ci-dessus n’écrit que dans la console. Simplement parce que le log associé à un package considère par défaut ses enfants, alors que le log associé à un module pas. [Par exemple](<ahref="https://docs.djangoproject.com/en/2.1/topics/logging/#examples"class="bare">https://docs.djangoproject.com/en/2.1/topics/logging/#examples</a>).</p>
</div>
</div>
</div>
<divclass="sect1">
<h2id="_administration">21. Administration</h2>
<divclass="sectionbody">
<divclass="paragraph">
<p>Woké. On va commencer par la <strong>partie à ne <em>surtout</em> (<em>surtout</em> !!) pas faire en premier dans un projet Django</strong>. Mais on va la faire quand même. La raison principale est que cette partie est tellement puissante et performante, qu’elle pourrait laisser penser qu’il est possible de réaliser une application complète rien qu’en configurant l’administration.</p>
</div>
<divclass="paragraph">
<p>C’est faux.</p>
</div>
<divclass="paragraph">
<p>L’administration est une sorte de tour de contrôle évoluée; elle se base sur le modèle de données programmé et construit dynamiquement les formulaires qui lui est associé. Elle joue avec les clés primaires, étrangères, les champs et types de champs par <ahref="https://fr.wikipedia.org/wiki/Introspection">introspection</a>.</p>
</div>
<divclass="paragraph">
<p>Son problème est qu’elle présente une courbe d’apprentissage asymptotique. Il est <strong>très</strong> facile d’arriver rapidement à un bon résultat, au travers d’un périmètre de configuration relativement restreint. Mais quoi que vous fassiez, il y a un moment où la courbe de paramétrage sera tellement ardue que vous aurez plus facile à développer ce que vous souhaitez ajouter en utilisant les autres concepts de Django.</p>
</div>
<divclass="paragraph">
<p>Elle doit rester dans les mains d’administrateurs ou de gestionnaires, et dans leurs mains à eux uniquement: il n’est pas question de donner des droits aux utilisateurs finaux (même si c’est extrêment tentant durant les premiers tours de roues). Indépendamment de la manière dont vous allez l’utiliser et la configurer, vous finirez par devoir développer une "vraie" application, destinée aux utilisateurs classiques, et répondant à leurs besoins uniquement.</p>
</div>
<divclass="paragraph">
<p>Une bonne idée consiste à développer l’administration dans un premier temps, en <strong>gardant en tête qu’il sera nécessaire de développer des concepts spécifiques</strong>. Dans cet objectif, l’administration est un outil exceptionel, qui permet de valider un modèle, de créer des objets rapidement et de valider les liens qui existent entre eux. C’est un excellent outil de prototypage et de preuve de concept.</p>
</div>
<divclass="sect2">
<h3id="_quelques_conseils">21.1. Quelques conseils</h3>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Surchargez la méthode <code><em>str</em>(self)</code> pour chaque classe que vous aurez définie dans le modèle. Cela permettra de construire une représentation textuelle qui représentera l’instance de votre classe. Cette information sera utilisée un peu partout dans le code, et donnera une meilleure idée de ce que l’on manipule. En plus, cette méthode est également appelée lorsque l’administration historisera une action (et comme cette étape sera inaltérable, autant qu’elle soit fixée dans le début).</p>
</li>
<li>
<p>La méthode <code>get_absolute_url(self)</code> retourne l’URL à laquelle on peut accéder pour obtenir les détails d’une instance. Par exemple:</p>
verbose_name_plural = 'my class when is in a list!'</code></pre>
</div>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Le titre:</p>
<divclass="ulist">
<ul>
<li>
<p>Soit en modifiant le template de l’administration</p>
</li>
<li>
<p>Soit en ajoutant l’assignation suivante dans le fichier <code>urls.py</code>: <code>admin.site.site_header = "SuperBook Secret Area</code>.</p>
<p>En gros, le problème de l’admin est que si on fait des requêtes imbriquées, on va flinguer l’application et le chargement de la page.
La solution consiste à utiliser la propriété <code>list_select_related</code> de la classe d’Admin, afin d’appliquer une jointure par défaut et
et gagner en performances.</p>
</div>
</div>
</div>
</div>
<h1id="_go_live"class="sect0">Go Live !</h1>
<divclass="openblock partintro">
<divclass="content">
<divclass="paragraph">
<p>Pour commencer, nous allons nous concentrer sur la création d’un site ne contenant qu’une seule application, même si en pratique le site contiendra déjà plusieurs applications fournies pas django, comme nous le verrons plus loin.</p>
</div>
<divclass="paragraph">
<p>Pour prendre un exemple concret, nous allons créer un site permettant de gérer des listes de souhaits, que nous appellerons <code>gwift</code> (pour <code>GiFTs and WIshlisTs</code> :)).</p>
</div>
<divclass="paragraph">
<p>La première chose à faire est de définir nos besoins du point de vue de l’utilisateur, c’est-à-dire ce que nous souhaitons qu’un utilisateur puisse faire avec l’application.</p>
</div>
<divclass="paragraph">
<p>Ensuite, nous pourrons traduire ces besoins en fonctionnalités et finalement effectuer le développement</p>
<p>Nous souhaitons développer un site où un utilisateur donné peut créer une liste contenant des souhaits et où d’autres utilisateurs, authentifiés ou non, peuvent choisir les souhaits à la réalisation desquels ils souhaitent participer.</p>
</div>
<divclass="paragraph">
<p>Il sera nécessaire de s’authentifier pour :</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Créer une liste associée à l’utilisateur en cours</p>
</li>
<li>
<p>Ajouter un nouvel élément à une liste</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Il ne sera pas nécessaire de s’authentifier pour :</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Faire une promesse d’offre pour un élément appartenant à une liste, associée à un utilisateur.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>L’utilisateur ayant créé une liste pourra envoyer un email directement depuis le site aux personnes avec qui il souhaite partager sa liste, cet email contenant un lien permettant d’accéder à cette liste.</p>
</div>
<divclass="paragraph">
<p>A chaque souhait, on pourrait de manière facultative ajouter un prix. Dans ce cas, le souhait pourrait aussi être subdivisé en plusieurs parties, de manière à ce que plusieurs personnes puissent participer à sa réalisation.</p>
</div>
<divclass="paragraph">
<p>Un souhait pourrait aussi être réalisé plusieurs fois. Ceci revient à dupliquer le souhait en question.</p>
<h3id="_gestion_des_utilisateurs">23.1. Gestion des utilisateurs</h3>
<divclass="paragraph">
<p>Pour gérer les utilisateurs, nous allons faire en sorte de surcharger ce que Django propose: par défaut, on a une la possibilité de gérer des utilisateurs (identifiés par une adresse email, un nom, un prénom, …​) mais sans plus.</p>
</div>
<divclass="paragraph">
<p>Ce qu’on peut souhaiter, c’est que l’utilisateur puisse s’authentifier grâce à une plateforme connue (Facebook, Twitter, Google, etc.), et qu’il puisse un minimum gérer son profil.</p>
</div>
</div>
<divclass="sect2">
<h3id="_gestion_des_listes">23.2. Gestion des listes</h3>
<divclass="sect3">
<h4id="_modèlisation">23.2.1. Modèlisation</h4>
<divclass="paragraph">
<p>Les données suivantes doivent être associées à une liste:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>un identifiant</p>
</li>
<li>
<p>un identifiant externe (un GUID, par exemple)</p>
</li>
<li>
<p>un nom</p>
</li>
<li>
<p>une description</p>
</li>
<li>
<p>le propriétaire, associé à l’utilisateur qui l’aura créée</p>
<p>L’utilisateur doit pouvoir voir si un souhait est réalisé, en partie ou non. Il doit également avoir un pourcentage de complétion sur la possibilité de réalisation de son souhait, entre 0% et 100%.</p>
</li>
<li>
<p>L’utilisateur doit pouvoir voir la ou les personnes ayant réalisé un souhait.</p>
</li>
<li>
<p>Il y a autant de réalisation que de parts de souhait réalisées ou de nombre de fois que le souhait est réalisé.</p>
<h3id="_gestion_des_personnes_réalisants_les_souhaits_et_qui_ne_sont_pas_connues">23.5. Gestion des personnes réalisants les souhaits et qui ne sont pas connues</h3>
<p>L’ORM de Django permet de travailler uniquement avec une définition de classes, et de faire en sorte que le lien avec la base de données soit géré uniquement de manière indirecte, par Django lui-même. On peut schématiser ce comportement par une classe = une table.</p>
</div>
<divclass="paragraph">
<p>Comme on l’a vu dans la description des fonctionnalités, on va <strong>grosso modo</strong> avoir besoin des éléments suivants:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Des listes de souhaits</p>
</li>
<li>
<p>Des éléments qui composent ces listes</p>
</li>
<li>
<p>Des parts pouvant composer chacun de ces éléments</p>
</li>
<li>
<p>Des utilisateurs pour gérer tout ceci.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Nous proposons dans un premier temps d’éluder la gestion des utilisateurs, et de simplement se concentrer sur les fonctionnalités principales.
Cela nous donne ceci:</p>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>code-block:: python</p>
<divclass="literalblock">
<divclass="content">
<pre># wish/models.py</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>from django.db import models</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>class Wishlist(models.Model):
pass</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>class Item(models.Model):
pass</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>class Part(models.Model):
pass</pre>
</div>
</div>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Les classes sont créées, mais vides. Entrons dans les détails.</p>
</div>
<divclass="sidebarblock">
<divclass="content">
<divclass="paragraph">
<p>Listes de souhaits</p>
</div>
</div>
</div>
<divclass="paragraph">
<p>Comme déjà décrit précédemment, les listes de souhaits peuvent s’apparenter simplement à un objet ayant un nom et une description. Pour rappel, voici ce qui avait été défini dans les spécifications:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>un identifiant</p>
</li>
<li>
<p>un identifiant externe</p>
</li>
<li>
<p>un nom</p>
</li>
<li>
<p>une description</p>
</li>
<li>
<p>une date de création</p>
</li>
<li>
<p>une date de modification</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Notre classe <code>Wishlist</code> peut être définie de la manière suivante:</p>
<p>Que s’il n’est pas spécifié, un identifiant <code>id</code> sera automatiquement généré et accessible dans le modèle. Si vous souhaitez malgré tout spécifier que ce soit un champ en particulier qui devienne la clé primaire, il suffit de l’indiquer grâce à l’attribut <code>primary_key=True</code>.</p>
</li>
<li>
<p>Que chaque type de champs (<code>DateTimeField</code>, <code>CharField</code>, <code>UUIDField</code>, etc.) a ses propres paramètres d’initialisation. Il est intéressant de les apprendre ou de se référer à la documentation en cas de doute.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Au niveau de notre modélisation:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>La propriété <code>created_at</code> est gérée automatiquement par Django grâce à l’attribut <code>auto_now_add</code>: de cette manière, lors d’un <strong>ajout</strong>, une valeur par défaut ("<strong>maintenant</strong>") sera attribuée à cette propriété.</p>
</li>
<li>
<p>La propriété <code>updated_at</code> est également gérée automatique, cette fois grâce à l’attribut <code>auto_now</code> initialisé à <code>True</code>: lors d’une <strong>mise à jour</strong>, la propriété se verra automatiquement assigner la valeur du moment présent. Cela ne permet évidemment pas de gérer un historique complet et ne nous dira pas <strong>quels champs</strong> ont été modifiés, mais cela nous conviendra dans un premier temps.</p>
</li>
<li>
<p>La propriété <code>external_id</code> est de type <code>UUIDField</code>. Lorsqu’une nouvelle instance sera instanciée, cette propriété prendra la valeur générée par la fonction <code>uuid.uuid4()</code>. <strong>A priori</strong>, chacun des types de champs possède une propriété <code>default</code>, qui permet d’initialiser une valeur sur une nouvelle instance.</p>
</li>
</ul>
</div>
<divclass="sidebarblock">
<divclass="content">
<divclass="paragraph">
<p>Souhaits</p>
</div>
</div>
</div>
<divclass="paragraph">
<p>Nos souhaits ont besoin des propriétés suivantes:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>un identifiant</p>
</li>
<li>
<p>l’identifiant de la liste auquel le souhait est lié</p>
</li>
<li>
<p>un nom</p>
</li>
<li>
<p>une description</p>
</li>
<li>
<p>le propriétaire</p>
</li>
<li>
<p>une date de création</p>
</li>
<li>
<p>une date de modification</p>
</li>
<li>
<p>une image permettant de le représenter.</p>
</li>
<li>
<p>un nombre (1 par défaut)</p>
</li>
<li>
<p>un prix facultatif</p>
</li>
<li>
<p>un nombre de part facultatif, si un prix est fourni.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Après implémentation, cela ressemble à ceci:</p>
<p>Les clés étrangères sont gérées directement dans la déclaration du modèle. Un champ de type `ForeignKey <<ahref="https://docs.djangoproject.com/en/1.8/ref/models/fields/#django.db.models.ForeignKey>`_"class="bare">https://docs.djangoproject.com/en/1.8/ref/models/fields/#django.db.models.ForeignKey>`_</a> permet de déclarer une relation 1-N entre deux classes. Dans la même veine, une relation 1-1 sera représentée par un champ de type `OneToOneField <<ahref="https://docs.djangoproject.com/en/1.8/topics/db/examples/one_to_one/>`"class="bare">https://docs.djangoproject.com/en/1.8/topics/db/examples/one_to_one/>`</a><em>, alors qu’une relation N-N utilisera un `ManyToManyField <<ahref="https://docs.djangoproject.com/en/1.8/topics/db/examples/many_to_many/>`"class="bare">https://docs.djangoproject.com/en/1.8/topics/db/examples/many_to_many/>`</a></em>.</p>
</li>
<li>
<p>L’attribut <code>default</code> permet de spécifier une valeur initiale, utilisée lors de la construction de l’instance. Cet attribut peut également être une fonction.</p>
</li>
<li>
<p>Pour rendre un champ optionnel, il suffit de lui ajouter l’attribut <code>null=True</code>.</p>
</li>
<li>
<p>Comme cité ci-dessus, chaque champ possède des attributs spécifiques. Le champ <code>DecimalField</code> possède par exemple les attributs <code>max_digits</code> et <code>decimal_places</code>, qui nous permettra de représenter une valeur comprise entre 0 et plus d’un milliard (avec deux chiffres décimaux).</p>
</li>
<li>
<p>L’ajout d’un champ de type <code>ImageField</code> nécessite l’installation de <code>pillow</code> pour la gestion des images. Nous l’ajoutons donc à nos pré-requis, dans le fichier <code>requirements/base.txt</code>.</p>
</li>
</ul>
</div>
<divclass="sidebarblock">
<divclass="content">
<divclass="paragraph">
<p>Parts</p>
</div>
</div>
</div>
<divclass="paragraph">
<p>Les parts ont besoins des propriétés suivantes:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>un identifiant</p>
</li>
<li>
<p>identifiant du souhait</p>
</li>
<li>
<p>identifiant de l’utilisateur si connu</p>
</li>
<li>
<p>identifiant de la personne si utilisateur non connu</p>
</li>
<li>
<p>un commentaire</p>
</li>
<li>
<p>une date de réalisation</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>Elles constituent la dernière étape de notre modélisation et représente la réalisation d’un souhait. Il y aura autant de part d’un souhait que le nombre de souhait à réaliser fois le nombre de part.</p>
</div>
<divclass="paragraph">
<p>Elles permettent à un utilisateur de participer au souhait émis par un autre utilisateur. Pour les modéliser, une part est liée d’un côté à un souhait, et d’autre part à un utilisateur. Cela nous donne ceci:</p>
<p>La classe <code>User</code> référencée au début du snippet correspond à l’utilisateur qui sera connecté. Ceci est géré par Django. Lorsqu’une requête est effectuée et est transmise au serveur, cette information sera disponible grâce à l’objet <code>request.user</code>, transmis à chaque fonction ou <strong>Class-based-view</strong>. C’est un des avantages d’un framework tout intégré: il vient <strong>batteries-included</strong> et beaucoup de détails ne doivent pas être pris en compte. Pour le moment, nous nous limiterons à ceci. Par la suite, nous verrons comment améliorer la gestion des profils utilisateurs, comment y ajouter des informations et comment gérer les cas particuliers.</p>
</div>
<divclass="paragraph">
<p>La classe <code>UnknownUser</code> permet de représenter un utilisateur non enregistré sur le site et est définie au point suivant.</p>
</div>
<divclass="sidebarblock">
<divclass="content">
<divclass="paragraph">
<p>Utilisateurs inconnus</p>
</div>
</div>
</div>
<divclass="olist loweralpha">
<olclass="loweralpha"type="a">
<li>
<p>todo:: je supprimerais pour que tous les utilisateurs soient gérés au même endroit.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Pour chaque réalisation d’un souhait par quelqu’un, il est nécessaire de sauver les données suivantes, même si l’utilisateur n’est pas enregistré sur le site:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>un identifiant</p>
</li>
<li>
<p>un nom</p>
</li>
<li>
<p>une adresse email. Cette adresse email sera unique dans notre base de données, pour ne pas créer une nouvelle occurence si un même utilisateur participe à la réalisation de plusieurs souhaits.</p>
<p>Traduit grossièrement depuis un article sur `https://medium.com <<ahref="https://medium.com/javascript-scene/what-every-unit-test-needs-f6cd34d9836d#.kfyvxyb21>`_"class="bare">https://medium.com/javascript-scene/what-every-unit-test-needs-f6cd34d9836d#.kfyvxyb21>`_</a>:</p>
</div>
<divclass="literalblock">
<divclass="content">
<pre>Vos tests sont la première et la meilleure ligne de défense contre les défauts de programmation. Ils sont</pre>
</div>
</div>
<divclass="literalblock">
<divclass="content">
<pre>Les tests unitaires combinent de nombreuses fonctionnalités, qui en fait une arme secrète au service d'un développement réussi:</pre>
</div>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Aide au design: écrire des tests avant d’écrire le code vous donnera une meilleure perspective sur le design à appliquer aux API.</p>
</li>
<li>
<p>Documentation (pour les développeurs): chaque description d’un test</p>
</li>
<li>
<p>Tester votre compréhension en tant que développeur:</p>
<p>Your tests are your first and best line of defense against software defects. Your tests are more important than linting & static analysis (which can only find a subclass of errors, not problems with your actual program logic). Tests are as important as the implementation itself (all that matters is that the code meets the requirement—how it’s implemented doesn’t matter at all unless it’s implemented poorly).</p>
</div>
<divclass="paragraph">
<p>Unit tests combine many features that make them your secret weapon to application success:</p>
</div>
<divclass="olist arabic">
<olclass="arabic">
<li>
<p>Design aid: Writing tests first gives you a clearer perspective on the ideal API design.</p>
</li>
<li>
<p>Feature documentation (for developers): Test descriptions enshrine in code every implemented feature requirement.</p>
</li>
<li>
<p>Test your developer understanding: Does the developer understand the problem enough to articulate in code all critical component requirements?</p>
</li>
<li>
<p>Quality Assurance: Manual QA is error prone. In my experience, it’s impossible for a developer to remember all features that need testing after making a change to refactor, add new features, or remove features.</p>
</li>
<li>
<p>Continuous Delivery Aid: Automated QA affords the opportunity to automatically prevent broken builds from being deployed to production.</p>
</li>
</ol>
</div>
<divclass="paragraph">
<p>Unit tests don’t need to be twisted or manipulated to serve all of those broad-ranging goals. Rather, it is in the essential nature of a unit test to satisfy all of those needs. These benefits are all side-effects of a well-written test suite with good coverage.</p>
<p>Il y a deux manières d’écrire les tests: soit avant, soit après l’implémentation. Oui, idéalement, les tests doivent être écrits à l’avance. Entre nous, on ne va pas râler si vous faites l’inverse, l’important étant que vous le fassiez. Une bonne métrique pour vérifier l’avancement des tests est la couverture de code.</p>
</div>
<divclass="paragraph">
<p>Pour l’exemple, nous allons écrire la fonction <code>percentage_of_completion</code> sur la classe <code>Wish</code>, et nous allons spécifier les résultats attendus avant même d’implémenter son contenu. Prenons le cas où nous écrivons la méthode avant son test:</p>
<p>Si vous générez le rapport HTML avec la commande <code>coverage html</code> et que vous ouvrez le fichier <code>coverage_html_report/src_wish_models_py.html</code>, vous verrez que les méthodes en rouge ne sont pas testées.
<strong>A contrario</strong>, la couverture de code atteignait <strong>98%</strong> avant l’ajout de cette nouvelle méthode.</p>
</div>
<divclass="paragraph">
<p>Pour cela, on va utiliser un fichier <code>tests.py</code> dans notre application <code>wish</code>. <strong>A priori</strong>, ce fichier est créé automatiquement lorsque vous initialisez une nouvelle application.</p>
<p>L’attribut <code>@property</code> sur la méthode <code>percentage_of_completion()</code> va nous permettre d’appeler directement la méthode <code>percentage_of_completion()</code> comme s’il s’agissait d’une propriété de la classe, au même titre que les champs <code>number_of_parts</code> ou <code>numbers_available</code>. Attention que ce type de méthode contactera la base de données à chaque fois qu’elle sera appelée. Il convient de ne pas surcharger ces méthodes de connexions à la base: sur de petites applications, ce type de comportement a très peu d’impacts, mais ce n’est plus le cas sur de grosses applications ou sur des méthodes fréquemment appelées. Il convient alors de passer par un mécanisme de <strong>cache</strong>, que nous aborderons plus loin.</p>
</div>
<divclass="paragraph">
<p>En relançant la couverture de code, on voit à présent que nous arrivons à 99%:</p>
<p>En continuant de cette manière (ie. Ecriture du code et des tests, vérification de la couverture de code), on se fixe un objectif idéal dès le début du projet. En prenant un développement en cours de route, fixez-vous comme objectif de ne jamais faire baisser la couverture de code.</p>
<p>`Django factory boy <<ahref="https://github.com/rbarrois/django-factory_boy/tree/v1.0.0>`_"class="bare">https://github.com/rbarrois/django-factory_boy/tree/v1.0.0>`_</a></p>
<p>Si vous décidez de définir un constructeur sur votre modèle, ne surchargez pas la méthode <code><em>init</em></code>: créez plutôt une méthode static de type <code>create()</code>, en y associant les paramètres obligatoires ou souhaités:</p>
<p>Mieux encore: on pourrait passer par un <code>ModelManager</code> pour limiter le couplage; l''accès à une information stockée en base de données ne se ferait dès lors qu’au travers de cette instance et pas directement au travers du modèle. De cette manière, on limite le couplage des classes et on centralise l’accès.</p>
<p>Dans les examples ci-dessus, nous avons vu les relations multiples (1-N), représentées par des <strong>ForeignKey</strong> d’une classe A vers une classe B. Il existe également les champs de type <strong>ManyToManyField</strong>, afin de représenter une relation N-N. Les champs de type <strong>OneToOneField</strong>, pour représenter une relation 1-1.
Dans notre modèle ci-dessus, nous n’avons jusqu’à présent eu besoin que des relations 1-N: la première entre les listes de souhaits et les souhaits; la seconde entre les souhaits et les parts.</p>
<p>Depuis le code, à partir de l’instance de la classe <code>Item</code>, on peut donc accéder à la liste en appelant la propriété <code>wishlist</code> de notre instance. <strong>A contrario</strong>, depuis une instance de type <code>Wishlist</code>, on peut accéder à tous les éléments liés grâce à <code><nom de la propriété>_set</code>; ici <code>item_set</code>.</p>
<p>Lorsque vous déclarez une relation 1-1, 1-N ou N-N entre deux classes, vous pouvez ajouter l’attribut <code>related_name</code> afin de nommer la relation inverse.</p>
<p>Remarque: si, dans une classe A, plusieurs relations sont liées à une classe B, Django ne saura pas à quoi correspondra la relation inverse. Pour palier à ce problème et pour gagner en cohérence, on fixe alors une valeur à l’attribut <code>related_name</code>.</p>
<p>On constate que plusieurs classes possèdent les mêmes propriétés <code>created_at</code> et <code>updated_at</code>, initialisées aux mêmes valeurs. Pour gagner en cohérence, nous allons créer une classe dans laquelle nous définirons ces deux champs, et nous ferons en sorte que les classes <code>Wishlist</code>, <code>Item</code> et <code>Part</code> en héritent. Django gère trois sortes d’héritage:</p>
<h3id="_classe_abstraite">26.1. Classe abstraite</h3>
<divclass="paragraph">
<p>L’héritage par classe abstraite consiste à déterminer une classe mère qui ne sera jamais instanciée. C’est utile pour définir des champs qui se répèteront dans plusieurs autres classes et surtout pour respecter le principe de DRY. Comme la classe mère ne sera jamais instanciée, ces champs seront en fait dupliqués physiquement, et traduits en SQL, dans chacune des classes filles.</p>
<p>En traduisant ceci en SQL, on aura en fait trois tables, chacune reprenant les champs <code>created_at</code> et <code>updated_at</code>, ainsi que son propre identifiant:</p>
<p>L’héritage classique est généralement déconseillé, car il peut introduire très rapidement un problème de performances: en reprenant l’exemple introduit avec l’héritage par classe abstraite, et en omettant l’attribut <code>abstract = True</code>, on se retrouvera en fait avec quatre tables SQL:</p>
</div>
<divclass="ulist">
<ul>
<li>
<p>Une table <code>AbstractModel</code>, qui reprend les deux champs <code>created_at</code> et <code>updated_at</code></p>
</li>
<li>
<p>Une table <code>Wishlist</code></p>
</li>
<li>
<p>Une table <code>Item</code></p>
</li>
<li>
<p>Une table <code>Part</code>.</p>
</li>
</ul>
</div>
<divclass="paragraph">
<p>A nouveau, en analysant la sortie SQL de cette modélisation, on obtient ceci:</p>
<p>Le problème est que les identifiants seront définis et incrémentés au niveau de la table mère. Pour obtenir les informations héritées, nous seront obligés de faire une jointure. En gros, impossible d’obtenir les données complètes pour l’une des classes de notre travail de base sans effectuer un <strong>join</strong> sur la classe mère.</p>
</div>
<divclass="paragraph">
<p>Dans ce sens, cela va encore…​ Mais imaginez que vous définissiez une classe <code>Wishlist</code>, de laquelle héritent les classes <code>ChristmasWishlist</code> et <code>EasterWishlist</code>: pour obtenir la liste complètes des listes de souhaits, il vous faudra faire une jointure <strong>externe</strong> sur chacune des tables possibles, avant même d’avoir commencé à remplir vos données. Il est parfois nécessaire de passer par cette modélisation, mais en étant conscient des risques inhérents.</p>
<p>Lorsqu’on définit une classe de type <strong>proxy</strong>, on fait en sorte que cette nouvelle classe ne définisse aucun nouveau champ sur la classe mère. Cela ne change dès lors rien à la traduction du modèle de données en SQL, puisque la classe mère sera traduite par une table, et la classe fille ira récupérer les mêmes informations dans la même table: elle ne fera qu’ajouter ou modifier un comportement dynamiquement, sans ajouter d’emplacements de stockage supplémentaires.</p>
</div>
<divclass="paragraph">
<p>Nous pourrions ainsi définir les classes suivantes:</p>
<p>Dans les spécifications, nous souhaitions pouvoir associer un utilisateur à une liste (<strong>le propriétaire</strong>) et un utilisateur à une part (<strong>le donateur</strong>). Par défaut, Django offre une gestion simplifiée des utilisateurs (pas de connexion LDAP, pas de double authentification, …​): juste un utilisateur et un mot de passe. Pour y accéder, un paramètre par défaut est défini dans votre fichier de settings: <code>AUTH_USER_MODEL</code>.</p>
<p>Sous ce titre franchement pompeux, on va un peu parler de la modélisation du modèle. Quand on prend une classe (par exemple, <code>Wishlist</code> que l’on a défini ci-dessus), on voit qu’elle hérite par défaut de <code>models.Model</code>. On peut regarder les propriétés définies dans cette classe en analysant le fichier <code>lib\site-packages\django\models\base.py</code>. On y voit notamment que <code>models.Model</code> hérite de <code>ModelBase</code> au travers de `six <<ahref="https://pypi.python.org/pypi/six>`_"class="bare">https://pypi.python.org/pypi/six>`_</a> pour la rétrocompatibilité vers Python 2.7.</p>
</div>
<divclass="paragraph">
<p>Cet héritage apporte notamment les fonctions <code>save()</code>, <code>clean()</code>, <code>delete()</code>, …​ Bref, toutes les méthodes qui font qu’une instance est sait <strong>comment</strong> interagir avec la base de données. La base d’un `ORM <<ahref="https://en.wikipedia.org/wiki/Object-relational_mapping>`_"class="bare">https://en.wikipedia.org/wiki/Object-relational_mapping>`_</a>, en fait.</p>
</div>
<divclass="paragraph">
<p>D’autre part, chaque classe héritant de <code>models.Model</code> possède une propriété <code>objects</code>. Comme on l’a vu dans la section <strong>Jouons un peu avec la console</strong>, cette propriété permet d’accéder aux objects persistants dans la base de données.</p>
<p>L’idée ici est simplement de pouvoir afficher le numéro de version ou le hash d’exécution du code, sans avoir à se connecter au dépôt. Cela apporte une certaine transparence, <strong>sous réserve que le code soit géré par Git</strong>. Si vous suivez scrupuleusement les 12 facteurs, la version de l’application déployée n’est plus sensée conserver un lien avec votre dépôt d’origine…​ Si vous déployez votre code en utilisant un <code>git fetch</code> puis un <code>git checkout <tag_name></code>, le morceau de code ci-dessous pourra vous intéresser :-)</p>