Écriture de votre premier correctif pour Django

Introduction

Intéressé à redonner un peu de votre temps à la communauté ? Vous avez peut-être trouvé un bogue dans Django et vous souhaiteriez le corriger, ou alors vous aimeriez ajouter une petite fonctionnalité dans Django.

La meilleure manière de réaliser ces objectifs est de contribuer à Django lui-même. Si cela peut paraître une tâche effrayante au premier abord, ce n’est finalement pas si difficile que cela. Nous allons vous accompagner tout au long de ce processus afin que vous puissiez apprendre avec un exemple.

À qui est destiné ce tutoriel ?

Voir aussi

Si vous cherchez une référence sur la façon de soumettre des correctifs, consultez la documentation Soumission de correctifs.

Pour ce tutoriel, il s’agit d’avoir au moins une compréhension générale de la manière dont Django fonctionne. Cela implique que vous devez être à l’aise en parcourant les tutoriaux existants sur l”écriture de votre première application Django. De plus, vous devriez bien connaître Python lui-même. Si ce n’est pas le cas, Dive Into Python est un livre en ligne fantastique (et gratuit) pour les programmeurs Python débutants.

Ceux d’entre vous qui ne sont pas familiers avec les systèmes de gestion de versions et avec Trac trouveront dans ce tutoriel et ses liens les bonnes informations pour bien démarrer. Toutefois, il serait souhaitable d’en apprendre un peu plus sur ces différents outils si vous pensez contribuer régulièrement à Django.

Mais pour la plus grande partie, ce tutoriel vise à expliquer le plus possible de choses pour qu’il puisse convenir au plus grand nombre.

Où obtenir de l’aide :

Si vous avez des problèmes en suivant ce tutoriel, vous pouvez écrire (en anglais) à django-developers ou utiliser le canal IRC #django-dev sur irc.freenode.net (ou #django-fr en français) pour discuter avec d’autres utilisateurs Django qui pourront peut-être vous aider.

Quels sont les contenus de ce tutoriel ?

Nous allons vous guider dans votre première contribution d’un correctif pour Django. À la fin de ce tutoriel, vous aurez acquis une compréhension basique à la fois des outils et des processus nécessaires. Plus particulièrement, nous aborderons les thèmes suivants :

  • installation de Git,
  • Téléchargement d’une copie de la version de développement de Django.
  • le lancement de la suite de tests de Django,
  • l’écriture d’un test pour votre correctif,
  • l’écriture du code du correctif,
  • le test de votre correctif,
  • la soumission d’une requête de contribution,
  • les sources d’informations supplémentaires.

Une fois le tutoriel terminé, vous pouvez consulter le reste de la documentation de Django sur la façon de contribuer. Elle contient de nombreuses informations utiles et constitue une lecture indispensable pour tout contributeur en herbe à Django. Si vous avez des questions, vous y trouverez probablement les réponses.

Python 3 indispensable !

La version actuelle de Django ne prend plus en charge Python 2.7. Obtenez Python 3 depuis la page des téléchargements de Python ou par l’intermédiaire du gestionnaire des paquets de votre système.

Pour les utilisateurs Windows

Lors de l’installation de Python sur Windows, prenez soin de cocher l’option « Ajouter python.exe au chemin PATH » afin qu’il soit accessible en tout temps dans la ligne de commande.

Code de conduite

En tant que contributeur, vous pouvez nous aider à maintenir la communauté Django ouverte et accueillante. Lisez et respectez notre Code de conduite.

Installation de Git

Pour ce tutoriel, Git doit être installé afin de pouvoir télécharger la version actuelle de développement de Django et pour générer les fichiers correctifs contenant vos modifications.

Pour savoir si Git est installé, saisissez git sur une ligne de commande. Si vous obtenez un message vous indiquant que la commande n’a pas pu être trouvée, c’est que vous devez l’installer, voir la page de téléchargement de Git.

Si vous ne connaissez pas bien Git, vous pouvez toujours obtenir des informations sur les commandes (une fois installé) en tapant git help sur une ligne de commande.

Téléchargement d’une copie de la version de développement de Django

La première étape pour contribuer à Django est d’obtenir une copie de son code source. Commencez par créer un fork de Django sur GitHub. Puis, à partir de la ligne de commande, utilisez la commande cd pour vous placer dans le répertoire où vous souhaitez mettre votre copie locale de Django.

Téléchargez le dépôt du code source de Django en utilisant la commande suivante :

$ git clone git@github.com:YourGitHubName/django.git
...\> git clone git@github.com:YourGitHubName/django.git

Connexion à faible bande passante ?

Vous pouvez ajouter l’option --depth 1 à git clone pour éviter le téléchargement de l’historique complet de Django, ce qui réduit le transfert de données de ~250 Mo à ~70 Mo.

Maintenant que vous disposez d’une copie locale de Django, vous pouvez l’installer comme tout autre paquet à l’aide de pip. La façon la plus simple de le faire est d’utiliser un environnement virtuel, qui est une fonctionnalité de Python permettant d’isoler dans une répertoire dédié les paquets installés pour chacun de vos projets afin qu’ils n’interfèrent pas entre eux.

Il est conseillé de conserver tous les environnements virtuels au même endroit, par exemple dans .virtualenvs/ dans votre dossier personnel.

Créez un nouvel environnement virtuel en exécutant :

$ python3 -m venv ~/.virtualenvs/djangodev
...\> py -m venv %HOMEPATH%\.virtualenvs\djangodev

Le chemin correspond à l’endroit où le nouvel environnement sera enregistré sur votre ordinateur.

La dernière étape de configuration de l’environnement virtuel est de l’activer :

$ source ~/.virtualenvs/djangodev/bin/activate

Si la commande source n’est pas disponible, vous pouvez essayer d’utiliser un point à la place :

$ . ~/.virtualenvs/djangodev/bin/activate

Pour les utilisateurs Windows

Pour activer votre environnement virtuel sur Windows, lancez :

...\> %HOMEPATH%\.virtualenvs\djangodev\Scripts\activate.bat

Vous devez activer l’environnement virtuel chaque fois que vous ouvrez une nouvelle fenêtre de terminal. virtualenvwrapper est un outil utile pour rendre cette opération plus directe.

The name of the currently activated virtual environment is displayed on the command line to help you keep track of which one you are using. Anything you install through pip while this name is displayed will be installed in that virtual environment, isolated from other environments and system-wide packages.

Go ahead and install the previously cloned copy of Django:

$ pip install -e /path/to/your/local/clone/django/
...\> pip install -e \path\to\your\local\clone\django\

La version installée de Django correspond maintenant à votre copie locale. Vous constaterez immédiatement les effets de toute modification, ce qui est très utile lorsqu’on se met à écrire des correctifs.

Lancement de la suite de test de Django pour la première fois

En contribuant à Django, il est très important que vos modifications de code n’introduisent pas de bogues dans d’autres parties de Django. Une des façons de contrôler que Django fonctionne toujours après vos modifications est de lancer la suite de tests de Django. Si tous les tests passent, il est raisonnable de penser que vos modifications fonctionnent et n’ont pas cassé d’autres parties de Django. Si vous n’avez encore jamais lancé la suite de tests de Django, il est recommandé de le faire une fois au préalable pour vous familiariser avec le résultat obtenu.

Avant de lancer la suite de tests, installez ses dépendances en vous plaçant dans le répertoire tests/ de Django et en exécutant :

$ pip install -r requirements/py3.txt
...\> pip install -r requirements\py3.txt

Si vous rencontrez une erreur durant l’installation, il est possible qu’une dépendance pour un ou plusieurs paquets Python manque sur votre système. Consultez la documentation du paquet problématique ou recherchez sur le Web avec le message d’erreur obtenu.

Nous sommes maintenant prêts à lancer la suite de tests. Si vous utilisez GNU/Linux, macOS ou une autre version de Unix, lancez :

$ ./runtests.py
...\> runtests.py 

Maintenant prenez place et détendez-vous. La suite complète de tests Django contient des milliers de tests, ce qui prend plusieurs minutes au moins à s’exécuter, en fonction de la rapidité de votre ordinateur.

Pendant que la suite de tests de Django s’exécute, vous voyez un flux de caractères représentant le statut de chaque test exécuté. E indique qu’une erreur est survenue durant le test et F indique qu’une assertion de test a échoué. Les deux sont considérés comme des échecs. Quant à eux, x et s indiquent respectivement des échecs attendus et des tests omis volontairement. Chaque point signifie qu’un test a réussi.

Les tests omis volontairement sont typiquement dus à des bibliothèques externes manquantes et nécessaires pour exécuter ces tests ; voir Running all the tests pour une liste de dépendances. Prenez soin d’installer toute dépendance de test qui est liée aux modifications que vous appliquez (nous n’en utiliserons pas pour ce tutoriel). Certains tests sont spécifiques à un moteur de base de données particulier et seront sautés lors des tests avec les autres moteurs. SQLite est le moteur de base de données des réglages par défaut. Pour lancer les tests avec un moteur différent, consultez Utilisation d’un autre module de réglages settings.

Lorsque les tests sont terminés, vous devez voir apparaître un message vous informant si la suite de tests a réussi ou échoué. Comme vous n’avez encore pas modifié de code Django, toute la suite de tests devrait passer. Si vous obtenez des échecs ou des erreurs, vérifiez que vous avez bien suivi toutes les précédentes étapes. Consultez Lancement des tests unitaires pour plus d’informations.

Il faut savoir que la version master (la plus actuelle) de Django n’est pas toujours stable. Lorsque vous développez sur cette version, vous pouvez vérifier les compilations d’intégration continue de Django pour savoir si les échecs que vous obtenez sont spécifiques à votre environnement ou s’ils sont aussi présents dans les compilations officielles de Django. Si vous cliquez sur une compilation particulière, vous voyez la « matrice de configurations » qui indique les échecs précisément par version de Python et par moteur de base de données.

Note

Pour ce tutoriel et le ticket sur lequel nous travaillons, il est suffisant de tester avec SQLite. Cependant, il est possible (et parfois nécessaire) de lancer les tests en utilisant une base de données différente.

Travail sur une fonctionnalité

Pour ce tutoriel, nous allons travailler sur un ticket factice comme cas d’étude. Voici les détails imaginaires :

Ticket #99999 – Permettre de faire des toasts

Django devrait fournir une fonction django.shortcuts.make_toast() qui renvoie 'toast'.

Nous allons maintenant implémenter cette fonctionnalité et les tests qui l’accompagnent.

Création d’une branche pour le correctif

Avant toute modification, créez une nouvelle branche pour le ticket :

$ git checkout -b ticket_99999
...\> git checkout -b ticket_99999

Vous êtes libre de choisir le nom de la branche, « ticket_99999 » est un exemple. Toutes les modifications appliquées dans cette branche seront spécifiques au ticket et ne toucheront pas la copie principale du code que nous avons clonée précédemment.

Écriture de quelques tests pour le ticket

Dans la majorité des cas, un correctif doit contenir des tests pour être accepté dans Django. Pour les correctifs de correction de bogue, cela implique la rédaction d’une test de régression pour s’assurer que le bogue ne soit plus réintroduit plus tard dans Django. Un test de régression doit être écrit de façon à échouer tant que le bogue est présent et à réussir lorsque le bogue a été corrigé. En ce qui concerne les correctifs contenant de nouvelles fonctionnalités, vous devrez inclure des tests qui assurent que les nouvelles fonctionnalités fonctionnent correctement. Ces tests devraient aussi échouer avant que la fonctionnalité ne soit développée, et réussir après qu’elle a été implémentée.

Une bonne manière de faire cela est d’écrire d’abord les nouveaux tests, avant de toucher au code. Ce style de développement est appelé développement piloté par les tests et peut être appliqué aussi bien à des projets complets qu’à des correctifs individuels. Après avoir écrit les tests, vous les lancez pour être sûr qu’ils échouent effectivement (puisque vous n’avez pas encore corrigé l’erreur ou ajouté la fonctionnalité). Si vos nouveaux tests n’échouent pas, vous devez les corriger jusqu’à ce qu’ils échouent. Après tout, un test de régression qui passe que le bogue soit présent ou non n’est pas très utile pour éviter que ce bogue ne réapparaisse à l’avenir.

Entrons maintenant dans le vif du sujet.

Écriture d’un test pour le ticket #99999

Afin de résoudre ce ticket, nous allons ajouter une fonction make_toast() au module django de premier niveau. Pour commencer, nous écrirons un test qui essaie d’utiliser cette fonction et qui vérifie que son résultat est correct.

Placez-vous dans le dossier tests/shortcuts/ et créez un nouveau fichier test_make_toast.py. Ajoutez le code suivant

from django.shortcuts import make_toast
from django.test import SimpleTestCase


class MakeToastTests(SimpleTestCase):
    def test_make_toast(self):
        self.assertEqual(make_toast(), 'toast')

Ce test vérifie que la fonction make_toast() renvoie 'toast'.

Mais cette histoire de tests semble plutôt compliquée…

Si vous n’avez jamais eu affaire à des tests précédemment, ils peuvent paraître un peu difficiles à écrire au premier abord. Heureusement, les tests sont un sujet très important en programmation, il existe donc beaucoup d’informations à leur sujet :

  • Une première approche conseillée dans l’écriture de tests pour Django est de parcourir la documentation Writing and running tests.
  • Dive Into Python (un livre en ligne gratuit pour les développeurs débutants en Python) contient une très bonne section sur l”introduction aux tests unitaires.
  • Après ces lectures, si vous désirez un peu plus de matière à digérer, vous pouvez toujours parcourir la documentation Python de unittest.

Lancement des nouveaux tests

Comme nous n’avons encore effectué aucune modification à django.shortcuts, notre test est censé échouer. Lançons tous les tests dans le dossier shortcuts pour être certain que c’est vraiment ce qui va se passer. Placez-vous dans le répertoire tests/ de Django et lancez :

$ ./runtests.py shortcuts
...\> runtests.py shortcuts

Si les tests se sont déroulés correctement, vous devriez voir un échec correspondant à la méthode de test que nous avons ajoutée, avec cette erreur

ImportError: cannot import name 'make_toast' from 'django.shortcuts'

Si tous les tests ont réussi, vous devriez alors vérifier que vous avez bien ajouté les nouveaux tests ci-dessus dans le bon répertoire et le bon nom de fichier.

Écriture du code pour le ticket

Ensuite, nous allons ajouter la fonction make_toast().

Passez dans le dossier django/ et ouvrez le fichier shortcuts.py. Au bas du fichier, ajoutez la fonction

def make_toast():
    return 'toast'

Nous devons maintenant être sûrs que le test précédemment écrit réussit, afin de vérifier que le code que nous venons d’ajouter fonctionne correctement. Placez-vous une nouvelle fois dans le répertoire tests/ de Django et lancez :

$ ./runtests.py shortcuts
...\> runtests.py shortcuts

Tous les tests devraient réussir. Si ce n’est pas le cas, assurez-vous d’avoir ajouté la bonne fonction dans le bon fichier.

Lancement de la suite de tests de Django pour la seconde fois

Après avoir vérifié que votre correctif et les tests fonctionnent correctement, il est recommandé de relancer toute la suite de tests de Django, simplement pour contrôler que vos modifications n’ont pas introduit des bogues dans d’autres parties de Django. Même si quand la suite de tests passe entièrement, ce n’est toujours pas une garantie que votre code ne contient pas d’erreurs, cela aide tout de même à révéler de nombreux bogues et régressions qui pourraient être passés inaperçus.

Pour lancer la suite complète de tests de Django, placez-vous dans le répertoire tests/ de Django et lancez :

$ ./runtests.py
...\> runtests.py 

Écriture de la documentation

Ceci est une nouvelle fonctionnalité, elle doit donc être documentée. Ouvrez le fichier docs/topics/http/shortcuts.txt et ajoutez le contenu ci-après à la fin du fichier

``make_toast()``
================

.. versionadded:: 2.2

Returns ``'toast'``.

Comme cette nouvelle fonctionnalité sera présente dans une version à venir, nous la mentionnons aussi dans les notes de publication de la prochaine version de Django. Ouvrez les notes de publication de la version la plus récente dans docs/releases/ (2.2.txt au moment de cette rédaction). Ajoutez une note sous le chapitre « Minor Features »:

:mod:`django.shortcuts`
~~~~~~~~~~~~~~~~~~~~~~~

* The new :func:`django.shortcuts.make_toast` function returns ``'toast'``.

Pour plus d’informations sur l’écriture de documentation, y compris une explication sur la signification de versionadded, consultez Écrire la documentation. Cette page contient aussi une explication sur la manière de produire une copie locale de la documentation afin de pouvoir prévisualiser le code HTML qui sera généré.

Aperçu des changements

Il est temps maintenant de passer en revue toutes les modifications effectuées dans notre correctif. Pour approuver toutes les modifications prêtes pour le commit, exécutez :

$ git add --all
...\> git add --all

Puis affichez les différences entre votre copie actuelle de Django (incluant vos modifications) et la révision que vous avez initialement extraite précédemment dans ce tutoriel avec :

$ git diff --cached
...\> git diff --cached

Utilisez les touches fléchées pour avancer ou reculer.

diff --git a/django/shortcuts.py b/django/shortcuts.py
index 7ab1df0e9d..8dde9e28d9 100644
--- a/django/shortcuts.py
+++ b/django/shortcuts.py
@@ -156,3 +156,7 @@ def resolve_url(to, *args, **kwargs):

     # Finally, fall back and assume it's a URL
     return to
+
+
+def make_toast():
+    return 'toast'
diff --git a/docs/releases/2.2.txt b/docs/releases/2.2.txt
index 7d85d30c4a..81518187b3 100644
--- a/docs/releases/2.2.txt
+++ b/docs/releases/2.2.txt
@@ -40,6 +40,11 @@ database constraints. Constraints are added to models using the
 Minor features
 --------------

+:mod:`django.shortcuts`
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* The new :func:`django.shortcuts.make_toast` function returns ``'toast'``.
+
 :mod:`django.contrib.admin`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/topics/http/shortcuts.txt b/docs/topics/http/shortcuts.txt
index 7b3a3a2c00..711bf6bb6d 100644
--- a/docs/topics/http/shortcuts.txt
+++ b/docs/topics/http/shortcuts.txt
@@ -271,3 +271,12 @@ This example is equivalent to::
         my_objects = list(MyModel.objects.filter(published=True))
         if not my_objects:
             raise Http404("No MyModel matches the given query.")
+
+``make_toast()``
+================
+
+.. function:: make_toast()
+
+.. versionadded:: 2.2
+
+Returns ``'toast'``.
diff --git a/tests/shortcuts/test_make_toast.py b/tests/shortcuts/test_make_toast.py
new file mode 100644
index 0000000000..6f4c627b6e
--- /dev/null
+++ b/tests/shortcuts/test_make_toast.py
@@ -0,0 +1,7 @@
+from django.shortcuts import make_toast
+from django.test import SimpleTestCase
+
+
+class MakeToastTests(SimpleTestCase):
+    def test_make_toast(self):
+        self.assertEqual(make_toast(), 'toast')

Lorsque la relecture du correctif est terminée, pressez sur la touche q pour revenir à la ligne de commande. Si le contenu du correctif est bon, il est temps de valider les modifications.

Validation (commit) des modifications du correctif

Pour valider les modifications :

$ git commit
...\> git commit

Un éditeur de texte apparaît pour rédiger le message de commit. Suivez les lignes directrices des messages de commit et écrivez un message comme :

Fixed #99999 -- Added a shortcut function to make toast.

Envoi du commit et création de la requête de contribution

Après avoir validé le correctif (commit), envoyez-le vers votre fork GitHub (remplacez « ticket_99999 » par le nom de votre branche) :

$ git push origin ticket_99999
...\> git push origin ticket_99999

Vous pouvez créer une requête de contribution en visitant la page GitHub de Django. Vous verrez votre branche sous « Your recently pushed branches ». Cliquez sur « Compare & pull request » à côté du message.

Ne le faites pas réellement pour ce tutoriel, mais sur la page suivante qui affiche l’aperçu du correctif, vous devriez cliquez sur « Create pull request ».

Étapes suivantes

Félicitations, vous avez appris comment effectuer une requête de contribution pour Django ! Des détails sur des techniques plus avancées sont disponibles dans Travailler avec Git et GitHub.

Vous pouvez mettre à profit maintenant ces compétences en aidant à améliorer la base de code de Django.

Plus d’informations pour les nouveaux contributeurs

Avant de vous impliquer plus intensément dans l’écriture de correctifs pour Django, il est souhaitable de parcourir un peu plus d’informations destinées aux contributeurs :

  • Il est important de lire la documentation de Django sur l”appropriation de tickets et la soumission de correctifs. Cela comprend les règles de comportement sur Trac, la façon de vous assigner un ticket, le style attendu du code des correctifs et encore bien d’autres détails importants.
  • Les contributeurs débutants devraient aussi lire la documentation de Django pour les contributeurs débutants. Elle contient de nombreux bons conseils pour ceux d’entre nous qui débutent dans la contribution à Django.
  • Après cela, si vous êtes toujours avide de plus d’informations sur la contribution, vous pouvez toujours parcourir le reste de la documentation de Django sur la contribution. Elle contient plein d’informations utiles et devrait constituer votre source principale de réponses aux questions que vous vous posez.

Recherche de votre premier vrai ticket

Après avoir consulté une partie de ces informations, vous êtes fin prêt pour partir à la recherche d’un ticket pour lequel vous allez écrire un correctif. Commencez en priorité par les tickets marqués comme « Easy pickings » (résolution facile). Ces tickets sont souvent plus simples par nature et sont une cible idéale pour les contributeurs débutants. Lorsque vous serez à l’aise avec la contribution à Django, vous pourrez alors passer à la rédaction de correctifs pour des tickets plus difficiles.

Si vous voulez commencer tout de suite (et personne ne vous le reprochera), jetez un coup d’œil à la liste des tickets simples qui ont besoin d’un correctif et des tickets simples qui ont des correctifs nécessitant une amélioration. Si vous êtes à l’aise dans l’écriture de tests, vous pouvez aussi examiner la liste des tickets simples qui ont besoin de tests. N’oubliez pas de suivre les instructions sur l’attribution de tickets qui étaient mentionnées dans le lien sur la documentation de Django sur l”appropriation de tickets et la soumission de correctifs.

Que se passe-t-il après la création d’une requête de contribution ?

Quand un ticket possède un correctif, il doit être relu par une deuxième paire d’yeux. Après la soumission d’une requête de contribution, mettez à jour les métadonnées du ticket en définissant les drapeaux du ticket « has patch », « doesn’t need tests », etc, pour que d’autres puissent les retrouver en vue d’une relecture. Contribuer ne signifie pas nécessairement écrire un correctif à partir de zéro. La relecture de correctifs existants est également une contribution très utile. Consultez Tri des tickets pour plus de détails.

Back to Top