Django. avancé. Pour des applications web puissantes en Python. Yohann Gabory. Préface de Nicolas Ferrari Avec la contribution de Thomas Petillon

Transcription

1 Django avancé Pour des applications web puissantes en Python Yohann Gabory Préface de Nicolas Ferrari Avec la contribution de Thomas Petillon Groupe Eyrolles, 2013, ISBN :

2 Table des matières Avant-propos... 1 Pourquoi ce livre? À qui s adresse le livre? Comment ce livre est-il organisé? Remerciements CHAPITRE 1 Bien démarrer avec Django : installation et initialisation d un projet... 5 Installer un bon environnement de travail Choisir entre éditeur de texte et EDI Installer Python Installation sous Linux Installation sous Mac OS X Installation sous Windows Installer pip et virtualenv Installation sous Linux Installation sous Mac OS X Installation sous Windows Installer un gestionnaire de versions Les différents systèmes de gestion de versions Installer un gestionnaire de versions : le choix Mercurial Installer et tester Django Initialiser un projet Un projet, des applications Les commandes d initialisation d un projet Création d un projet : startproject Serveur web de développement : runserver Conclusion

3 VIII Django avancé CHAPITRE 2 Créer sa première application : un tracker De la méthode et un framework adaptable Le développement par itérations Un framework transparent et adaptable De l utilité d un tracker Organisation du travail Gestion du temps Gestion des jalons Historique Tracker et gestionnaire de versions : les outils d une méthode «agile» Initialisation du projet Mise en place Création d une application : startapp Vue d ensemble du projet Paramétrer les variables d environnement (settings) Mode de développement (DEBUG) Configuration de la base de données Internationalisation Applications installées par défaut Initialisation de la base de données : syncdb Projet versus application Configuration des applications installées Les URL Une première vue L objet request L objet HttpResponse Créer une application dynamique Le modèle de l objet ticket La classe Task La commande python manage.py shell Première itération : l interface d administration Ajouter l application aux settings Ajouter l application aux URL Un premier test Ajouter le modèle Task à l administration Une interface CRUD Un premier aperçu Comment sont créées les URL de l administration? Les formulaires de l administration Modifier l interface d administration

4 Table des matières IX La fonction unicode Aller plus loin dans la configuration de l administration Afficher les due-dates sur l interface d administration Changer la couleur des champs due_date et schedule_date Première conclusion Seconde itération : les bases de l interface client L application databrowse (contribs...) Une première vue : liste Introduction aux querysets Présenter l information : les templates Les fichiers templates Un raccourci : render_to_response Troisième itération : l interface utilisateur, aspects avancés Mise en place des URL Utiliser le dictionnaire GET Les fichiers statiques staticfiles STATIC_URL et render_to_response Une petite astuce Conclusion CHAPITRE 3 Des bases à la production : créer un agenda partagé Fonctionnalités de l application Un environnement complet Activer l environnement virtuel Installer les paquets de base Créer un fichier requirements.txt Configuration du projet Plus d efficacité avec south et local_settings de settings.py Organisation du projet Conception des modèles La relation many-to-many L option through Création des tables Première migration avec south Test des modèles et TDD Les tests dans les docstrings Conclusion

5 X Django avancé CHAPITRE 4 Gestion de l authentification Authentifier un utilisateur sur le site Ajouter les URL login et logout Créer le template login Personnaliser le contenu Une page pour chaque utilisateur Une introduction aux vues génériques : TemplateView Afficher les informations de l utilisateur connecté Autoriser ou interdire certaines parties du site Découplage de l application Instancier un formulaire Valider les données du formulaire Enregistrer les données du formulaire La fonction create_account finalisée Les tests unitaires de l authentification La classe Client Test des URL Les tests des formulaires Les tests d échec Derniers ajustements Modifier les URL Modifier les templates Conclusion CHAPITRE 5 Création d un événement Les ModelForm Création du formulaire Présenter l objet Evenement à l utilisateur Ajouter des participants Améliorations et finitions Les contraintes L attribut unique pour la contrainte d unicité L attribut unique_together Rendre intelligent le formulaire Présélectionner l événement Supprimer les choix inutiles Supprimer un participant N afficher que les champs utiles

6 Table des matières XI L interface CRUD Lister tous les événements Supprimer un événement Modifier un événement Conclusion Les URL : #agenda/personal_calendar/urls.py Les vues : #agenda/personal_calendar/views.py Les formulaires Les modèles (sans les docstrings) :#agenda/models.py Le template liste.html Le template create.html Le template details.html CHAPITRE 6 Les templates pour l affichage Fonctionnement général : découplage et souplesse pour l intégration avec CSS/JavaScript Organisation des templates Le fichier base.html La directive extends La directive include Les styles CSS et les images Servir les fichiers statiques durant le développement Inclure un framework CSS dans Django Intégrer du JavaScript Calendrier JavaScript Pliage et dépliage Les requêtes Ajax Conclusion CHAPITRE 7 Les vues génériques pour les fonctions d agenda Les vues génériques depuis Django Les bases des vues génériques Afficher une collection d événements La pagination La pagination dans les vues Un peu de nettoyage Afficher les détails d un événement : DetailView Conclusion

7 XII Django avancé CHAPITRE 8 Une revue de l application : factorisation du code Utiliser les vues génériques dans l ensemble de votre application La vue Evenement_Detail Factorisation du formulaire Des URL DRY Créer, modifier, supprimer des événements La vue CreateView : création d un nouvel événement La vue UpdateView : mettre à jour un événement La vue DeleteView : supprimer un événement Conclusion CHAPITRE 9 Les notions de partage Le besoin : gérer sa propre liste d utilisateurs connectés Spécification des modèles Définition des modèles Les requêtes courantes Gestion des invitations Ajouter le champ à la création d un nouvel utilisateur Le modèle Invitation Le formulaire d invitation Envoi des s avec Django Créer le contact dans le carnet d adresses de l utilisateur Rediriger vers la fiche contact et non l invitation Revue de code Les vues Le formulaire d ajout d un cercle Le formulaire de modification d un contact Relier les applications Calendrier et Agenda Présenter les utilisateurs du carnet d adresses Ajouter l utilisateur créateur de l événement à la liste des participants La gestion des statuts Empêcher la suppression de l hôte L envoi d un à l ajout d un participant Laisser l utilisateur indiquer son statut Conclusion

8 Table des matières XIII CHAPITRE 10 Django et les bases de données Tour d horizon des bases de données relationnelles MySQL : SGBD historique PostgreSQL : robustesse SQLite : légèreté Comment choisir sa base de données? Tour d horizon des bases de données NoSQL L ORM de Django : couche d abstraction entre la BDD et les objets Principe de fonctionnement Une vision objet Les principaux avantages : manipuler les objets de la BDD en Python Les inconvénients : comment les contourner Anatomie d une queryset Méfiez-vous des templates Les différents types de champs Les champs CharField Les champs IntegerField Les champs TextField Les options remarquables Options relatives aux formulaires Options relatives à la base de données Créez vos propres types de champs Les relations Les relations one-to-one Cas d utilisation Implémentation Queryset sur une relation one-to-one Les foreign keys (clés étrangères) Implémentation Queryset sur une relation foreign key Les relations many-to-many Implémentation Queryset sur une relation many-to-many related_name Manipulation des relations many-to-many Les héritages de tables Héritage abstract Les classes abstraites et les applications réutilisables Multitable

9 XIV Django avancé Proxy Les méthodes des modèles Quelques remarques : gérer les appels à la base de données Les meta Les échanges avec la base de données L ordre des résultats Les contraintes d unicité Les permissions Les méthodes prédéfinies Les querysets Description d une queryset Les relations dans les querysets Le coût des querysets Les managers Le fonctionnement des managers Faire ses propres managers Ajouter de nouvelles méthodes Modifier le fonctionnement du manager Un exemple complet pour comprendre l intérêt des managers L objet Q : encapsuler des paramètres pour exécuter des requêtes Description de l objet Q Quand faut-il utiliser l objet Q? Conclusion CHAPITRE 11 Le traitement de l information : les vues Tour d horizon des vues Le workflow standard L objet request La méthode Les en-têtes Les informations fournies par Django dans la requête L objet response Les codes HTTP fournis par Django Les autres codes HTTP La compilation du template Le principe de base de la compilation d un template render_to_response L objet RequestContext render Les context processors

10 Table des matières XV Les vues et les objets de modèles Les vues avancées Organiser les vues d un projet Cas particulier : Ajax Reconnaître une requête Ajax Le contexte JSON serializer Les relations et JSON Aller plus loin dans la sérialisation Cas particulier CSV : format d échange de données tabulaires Renvoyer du CSV avec le moteur de templates Django Cas particulier PDF Un exemple simple Avant et après la vue : les middlewares Les vues génériques Un exemple simple : TemplateView ListView et DetailView ListView et queryset Les décorateurs et les vues génériques Les mixins MultipleObjectMixin CreateView et DeleteView CreateView Le template CreateView Les paramètres optionnels de CreateView Les autres vues génériques Les vues génériques basées sur les dates Les vues génériques de dates de Django Les vues-classes Vues-classes vs vues-fonctions Les verbes REST et les vues-classes Les héritages de vues Du bon usage des vues-classes Utiliser les capacités d agrégation de Django CHAPITRE 12 L affichage de l information : les templates Le langage de templates Le template et le contexte Afficher une variable Afficher une série de variables

11 XVI Django avancé Branchements logiques Les filtres Revue de code L organisation des templates Un dossier template pour le projet Un dossier template par application Les dossiers includes Créer des template tags et des filtres Les filtres : modifier une variable Structure de fichier Écriture d un premier filtre Les filtres avec argument Les tags : agir au niveau du contexte Les décorateurs Ajouter des arguments aux tags Conclusion CHAPITRE 13 Dialogue avec l utilisateur : les formulaires L objet Form Un premier exemple : formulaire d enregistrement à une newsletter Traitement du formulaire Affichage du formulaire Les champs de formulaire Les options remarquables d un champ de formulaire L option required La validation des champs de formulaire Les options d affichage Les widgets Modifier l affichage HTML d un formulaire Conclusion CHAPITRE 14 Django et le protocole web Les verbes du Web GET et POST Les verbes REST Un exemple concret : mise en place d une API complète Installation de Mezzanine Description de OAuth Création de l authentification OAuth

12 Table des matières XVII Création de l API Sécuriser l API Authentification Limiter l accès aux ressources Créer un client slumber un client d API REST En bref Une API REST en détail Retrouver une ressource unique Créer une nouvelle ressource Modifier une ressource Supprimer une ressource Filtrer les ressources Conclusion CHAPITRE 15 Les contribs Django Le module auth : authentification des utilisateurs Installation Choix du backend RemoteUserBackend L objet User Création d utilisateur Activer un utilisateur Connecter un utilisateur Déconnecter un utilisateur Vérifier qu un utilisateur est connecté La gestion des utilisateurs connectés dans les templates Les permissions Les permissions d un utilisateur Les groupes Créer ses propres permissions En bref Le module admin : gérer l interface d administration de Django Cas d utilisation du module admin Le prototypage L interface d administration à usage de maintenance L interface d administration pour les usagers L interface d administration par l exemple Présenter une liste des objets Rechercher dans la liste d objets

13 XVIII Django avancé Les formulaires dans l interface d administration Aller plus loin avec l interface d administration Les méthodes spéciales des ModelAdmin En bref Les autres modules contribs Les commentaires Activer les commentaires pour votre projet Utilisation des commentaires dans les templates Prendre le contrôle des commentaires Django En bref Les content-types Une application de tag utilisant les content-types En bref L application flatpages : gérer les parties statiques de votre site Installation Fonctionnement Le framework de message Installation Utilisation L application sitemaps : produire une carte de votre site Installation La classe Sitemap Les raccourcis pour la création de sitemaps En bref Le framework de site : gérer plusieurs sites à la fois Installation Utilisation Le framework de syndication : créer un flux RSS Installation Utilisation Aller plus loin avec les flux RSS En bref Conclusion CHAPITRE 16 Django avancé Percer les secrets de l interface d administration Les templates de l administration Révision des règles de surclassement de templates Une application thème Surclassement des templates d administration

14 Table des matières XIX Surclasser change_list_result En faire plus avec les vues : générer modèles et URL à la volée Une application de prototypage Les URL Les vues Les modèles Les templates Aller plus loin avec les templates Utiliser Django en dehors de Django : déjouer l anicroche Index