http://www.chicoree.fr/w/Premiers_pas_avec_Pyramidhttp://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Le_projetLe projet qui me sert de support ici est un embryon de système de gestion de stock. Outre l'écran de connexion (login), l'application comporte deux pages: une page permet de saisir un code EAN13 (au clavier ou à l'aide d'une douchette émulant un clavier) ainsi qu'une description associée. Une autre page permet de visualiser la liste des entrées saisies.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Installer_les_outilsIl est recommandé d'utiliser Pyramid au travers d'un environnement Python virtuel. L'argument principal en faveur de ce choix est que, pendant le cycle de développement, vous allez être amené à installer différents modules avec easy_install (y compris notre application). Par conséquent vous devrez avoir les permissions en écriture sur les dossiers correspondants:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#PyramidIl est recommandé d'utiliser Pyramid au travers d'un environnement Python virtuel. L'argument principal en faveur de ce choix est que, pendant le cycle de développement, vous allez être amené à installer différents modules avec easy_install (y compris notre application). Par conséquent vous devrez avoir les permissions en écriture sur les dossiers correspondants:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#MariaDBJe suppose ici que MariaDB (ou MySQL) est déjà installé sur la machine qui servira de serveur de bases de données. Je ne m'étend pas sur le processus car il est la plupart du temps trivial — et sous Debian se limite le plus souvent à installer le paquet correspondant.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Cycle_de_d.C3.A9veloppement_avec_PyramidLe manuel d'introduction de Pyramid explique très clairement comment il est possible de créer une première application "à la main". Mais dans la pratique, il est nettement plus productif de partir d'un squelette de projet généré par Pyramid (scaffold). Ici, comme j'ai l'intention d'utiliser SQLAlchemy comme couche d'abstraction pour l'accès à la base de données, je vais utiliser le modèle correspondant:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Cr.C3.A9er_le_projetLe manuel d'introduction de Pyramid explique très clairement comment il est possible de créer une première application "à la main". Mais dans la pratique, il est nettement plus productif de partir d'un squelette de projet généré par Pyramid (scaffold). Ici, comme j'ai l'intention d'utiliser SQLAlchemy comme couche d'abstraction pour l'accès à la base de données, je vais utiliser le modèle correspondant:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Lancer_les_tests_unitairesLe script setup.py à la racine du projet permet de lancer le jeu de tests unitaires de l'application:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Lancer_l.27applicationPour lancer l'application Pyramid, il faut d'abord l'installer. Comme pour les tests, cela se fait à l'aide du script setup.py. Ensuite, il faut lancer le serveur WSGI qui permettra de répondre aux requêtes http. Pour cela Pyramid fournit l'utilitaire pserve:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Modifier_la_configuration_du_projetPour la version de développement, la configuration du projet se trouve dans le fichier development.ini. Ici, je vais faire deux changements:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Changer_la_configuration_du_serveur_WSGIDans le fichier development.ini il faut trouver la section [server:main] qui se charge de la configuration du réseau. Dans sa version par défaut, cette section contient les options suivantes:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Changer_la_configuration_d.27acc.C3.A8s_.C3.A0_la_base_de_donn.C3.A9esPour modifier les paramètres de connection à la base de données, il faut altérer l'option sqlalchery.url de la section [app:main]. Par défaut, les applications utilisant SQLAlchemy sont adossées à une base SQLLite:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Ajouter_des_d.C3.A9pendancesJe l'ai dit dans la section précédente, je vais utiliser PyMySQL comme pilote pour accéder à la base MariaDB. C'est à dire que pour fonctionner, mon application va nécessiter ce module supplémentaire. À la fois en version de développement mais aussi en production. Il est donc inimaginable de simplement installer "à la main" le module nécessaire localement. Il est vital d'automatiser ce processus. Tout cela pour dire que nous allons ajouter cette nouvelle dépendance au script setup.py situé à la racine du projet:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Initialiser_la_base_de_donn.C3.A9esÀ ce stade, nous avons rassemblé toutes les briques nécessaires à notre application. La toute dernière étape avant de pouvoir (enfin) tester l'application par défaut va être d'initialiser la base de données.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Cr.C3.A9er_les_mod.C3.A8les...Tout d'abord, nous allons créer la table des utilisateurs qui nous servira pour authentifier les accès à l'application. Ici, je vais créer et peupler manuellement la table dans MariaDB. Ce n'est pas nécessairement la manière recommandée de procéder, mais c'est un scénario très plausible: on pourrait facilement imaginer qu'il s'agit d'une table déjà existante gérée par une application tierce. Même si notre application n'est qu'un jouet développé pour le besoin de ce tutoriel, je vais quand même stocker les mots de passe sous forme de hash pour ne pas encourager les mauvaises pratiques.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#..._.C3.A0_la_mainTout d'abord, nous allons créer la table des utilisateurs qui nous servira pour authentifier les accès à l'application. Ici, je vais créer et peupler manuellement la table dans MariaDB. Ce n'est pas nécessairement la manière recommandée de procéder, mais c'est un scénario très plausible: on pourrait facilement imaginer qu'il s'agit d'une table déjà existante gérée par une application tierce. Même si notre application n'est qu'un jouet développé pour le besoin de ce tutoriel, je vais quand même stocker les mots de passe sous forme de hash pour ne pas encourager les mauvaises pratiques.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#..._.C3.A0_partir_de_PythonNotre application Pyramid va utiliser l'ORM (Object-relational mapping) SQLAlchemy. Concrètement, cela veut dire que l'on peut définir le modèle de données objet à partir du langage de programmation (éventuellement en utilisant l'héritage ou la composition) et que le framework va prendre en charge automagiquement la conversion depuis (ou vers) le modèle relationnel de la base de données. Bref, vous écrivez du Python, pas du SQL.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Je_veux_voir_quelque-chose_...Un concept simple mais important dans le framework Pyramid est celui de route. Une route permet l'association entre une URL et une vue (une "page"). Chaque route possède un nom. Notre application contient trois pages. Qui vont ici correspondre à trois routes. Cependant, pour éviter les répétitions, Pyramid nous permet de créer des routes dynamiques à partir de motifs. Ici, je vais donc ajouter les routes suivantes au fichier PyramidDemo/pyramiddemo/__init__.py:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#..._mais_j.27ai_perdu_ma_routeUn concept simple mais important dans le framework Pyramid est celui de route. Une route permet l'association entre une URL et une vue (une "page"). Chaque route possède un nom. Notre application contient trois pages. Qui vont ici correspondre à trois routes. Cependant, pour éviter les répétitions, Pyramid nous permet de créer des routes dynamiques à partir de motifs. Ici, je vais donc ajouter les routes suivantes au fichier PyramidDemo/pyramiddemo/__init__.py:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#La_vue_de_connexion_.28login.29Enfin, nous allons pouvoir créer nos pages. Pyramid offre pour cela en standard plusieurs alternatives. Dont les moteurs de template Mako et Chameleon. Ce dernier est le moteur de template par défaut et c'est lui que je vais utiliser. Je vous livre directement le code de pyramiddemo/templates/login.pt:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Authentification_et_autorisationCe sont deux concepts liés, mais clairement séparés dans Pyramid afin d'offrir un maximum de souplesse dans leur mise en œuvre:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Connecter_tout_ensemblePresque. Nous y sommes presque. L'infrastructure de "sécurité" est en place. Le modèle pour la page web de connexion est écrit. La route pour accéder à la page est définie. Reste seulement à ajouter les quelques lignes de logique applicative en Python pour générer la vue et répondre à la saisie du formulaire. Cela se fait dans le fichier PyramidDemo/pyramiddemo/views.py. Ici, je vous donne l'intégralité du fichier car nous avons une fonction à ajouter mais aussi pas mal de ménage à faire pour supprimer la page principale par défaut générée lors de la création du projet. Rassurez-vous l'ensemble du code imports compris prend moins de 40 lignes:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Ajouter_d.27autres_vuesAprès la longue section consacrée à la page de connexion, la création de la vue qui permet de visualiser les données de la table ITEMS va vous sembler assez reposante. Tout d'abord, jetons un œil au modèle Chameleon associé PyramidDemo/pyramiddemo/templates/item_view.pt:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#La_vue_.2Fitem.2FviewAprès la longue section consacrée à la page de connexion, la création de la vue qui permet de visualiser les données de la table ITEMS va vous sembler assez reposante. Tout d'abord, jetons un œil au modèle Chameleon associé PyramidDemo/pyramiddemo/templates/item_view.pt:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#La_vue_.2Fitem.2FaddCelle-ci est vraiment simple. Il suffit de créer le modèle Chameleon, puis de rajouter le code Python pour gérer cette vue et répondre au formulaire. Voici tout d'abord le contenu intégral de PyramidDemo/pyramiddemo/templates/item_add.pt. Vous le verrez, il n'y a rien de nouveau dans ce code par rapport à nos exemples précédents:

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#TesterLe framework Pyramid supporte à la fois les tests unitaires, les tests d'intégration et les tests fonctionnels à l'aide de fonction qui viennent compléter le module Python standard unittest.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#ConclusionOuf! Même si l'application est relativement simple, son développement nous a quand même demandé un peu de travail. Surtout parce que j'ai pris le temps d'introduire de nombreux concepts clés en route. Par contre, une fois les premières pages réalisées, vous constaterez que l'on peut ensuite ajouter assez rapidement de nouvelles fonctionnalités à l'application sans beaucoup de difficultés. L'outil se révèle souple et est bâti sur des technologies éprouvées et interchangeables (SQLAlchemy, Chameleon, Mako...) C'est à la fois son point fort, puisque Pyramid ne vous impose finalement pas grand chose. Mais c'est peut-être aussi un écueil dans les premiers temps, puisqu'il faut souvent jongler avec les documentations de différents logiciels pour résoudre un problème.

]]>http://www.chicoree.fr/w/Premiers_pas_avec_Pyramid#Ressources