Django contient un « distributeur de signaux » qui permet aux applications découplées de pouvoir plus facilement être averties quand des actions se produisent ailleurs dans un projet. En résumé, les signaux permettent à certains expéditeurs d’avertir un ensemble de destinataires qu’une action a eu lieu. Ils sont particulièrement utiles lorsque beaucoup de parties de code peuvent être intéressées aux mêmes événements.
\nPar exemple, une application tierce peut s’inscrire pour être avertie des modifications de réglages
\nfrom django.apps import AppConfig\nfrom django.core.signals import setting_changed\n\ndef my_callback(sender, **kwargs):\n print("Setting changed!")\n\nclass MyAppConfig(AppConfig):\n ...\n\n def ready(self):\n setting_changed.connect(my_callback)\nLes signaux propres à Django permettent à du code utilisateur d’être averti de certaines actions.
\nVous pouvez également définir et envoyer vos propres signaux personnalisés. Voir Définition et envoi de signaux ci-dessous.
\n\nPour recevoir un signal, inscrivez une fonction réceptrice en utilisant la méthode Signal.connect(). Cette fonction sera appelée au moment où le signal est envoyé. Toutes les fonctions réceptrices d’un signal sont appelées consécutivement dans l’ordre où elles ont été inscrites.
receiver – La fonction réceptrice qui sera connectée à ce signal. Voir Fonctions réceptrices pour plus d’informations.
sender – Indique un expéditeur particulier duquel recevoir les signaux. Voir Connexion aux signaux envoyés par des expéditeurs spécifiques pour plus d’informations.
weak – Django stocke les gestionnaires de signaux comme référence faible par défaut. Cela signifie que si le récepteur est une fonction locale, il peut être purgé de la mémoire. Pour empêcher cela, indiquez weak=False lors de l’appel à la méthode connect() du signal.
dispatch_uid – Un identifiant unique pour un récepteur de signal afin d’éviter que certains signaux puissent être envoyés à double. Voir Prévention des signaux dupliqués pour plus d’informations.
Voyons comment ça fonctionne en inscrivant un signal qui sera appelé à la fin de chaque requête HTTP. Nous allons nous connecter au signal request_finished.
Tout d’abord, nous devons définir une fonction réceptrice. Celle-ci peut être n’importe quelle fonction ou méthode Python :
\ndef my_callback(sender, **kwargs):\n print("Request finished!")\nRemarquez que la fonction accepte un paramètre sender, accompagné des paramètres nommés génériques (**kwargs) ; tous les gestionnaires de signal doivent accepter ces paramètres.
Nous aborderons le paramètre sender un peu plus loin, mais commençons par examiner le paramètre **kwargs. Tous les signaux envoient des paramètres nommés et peuvent changer ces paramètres nommés à tout instant. Dans le cas de request_finished, sa documentation indique qu’il n’envoie pas de paramètre, ce qui signifie que nous pourrions être tentés d’écrire notre fonction de signal comme my_callback(sender).
Ce serait une erreur. En fait, Django génère une exception dans ce cas, parce que l’on doit s’attendre à ce que de nouveaux paramètres soient ajoutés dans le temps et la fonction réceptrice doit être capable d’accepter ces nouveaux paramètres.
\nIl y a deux façons de connecter une fonction réceptrice à un signal. Vous pouvez choisir l’option de la connexion manuelle :
\nfrom django.core.signals import request_finished\n\nrequest_finished.connect(my_callback)\nL’autre possibilité est d’utiliser le décorateur receiver():
signal – Un signal ou une liste de signaux auxquels connecter la fonction.
kwargs – Autres paramètres nommés arbitraires à passer à la fonction.
Voici comment faire la connexion avec le décorateur :
\nfrom django.core.signals import request_finished\nfrom django.dispatch import receiver\n\n@receiver(request_finished)\ndef my_callback(sender, **kwargs):\n print("Request finished!")\nÀ partir de cet instant, la fonction my_callback sera appelée chaque fois qu’une requête se termine.
Certains signaux sont envoyés de nombreuses fois, mais vous n’êtes pas toujours intéressé à tous les recevoir. Par exemple, considérez le signal django.db.models.signals.pre_save envoyé avant chaque enregistrement de modèle. La plupart du temps, vous n’avez pas besoin de savoir quand chaque modèle est enregistré, mais seulement pour un modèle spécifique.
Dans ces situations, vous pouvez inscrire une fonction pour qu’elle ne reçoive les signaux que de certains expéditeurs. Dans le cas de django.db.models.signals.pre_save, l’expéditeur sera la classe du modèle en cours d’enregistrement, il est donc possible d’indiquer que vous ne voulez recevoir que les signaux envoyés par certains modèles :
from django.db.models.signals import pre_save\nfrom django.dispatch import receiver\nfrom myapp.models import MyModel\n\n\n@receiver(pre_save, sender=MyModel)\ndef my_handler(sender, **kwargs):\n ...\nLa fonction my_handler ne sera appelée que lors de l’enregistrement d’une instance de MyModel.
Différents signaux utilisent différents objets comme expéditeurs ; il s’agit de consulter la documentation des signaux intégrés pour plus de détails sur chaque signal.
\nDans certaines circonstances, le code faisant la connexion entre les récepteurs et les signaux peut être exécuté à plusieurs reprises. En conséquence, la fonction de réception peut être inscrite plus d’une fois et être ensuite appelée plusieurs fois pour un même événement de signal. Par exemple, la méthode ready() peut être exécutée plus d’une fois pendant l’exécution des tests. Plus généralement, ceci se produit à chaque fois que votre projet importe le module où les signaux sont définis, car l’enregistrement d’un signal se produit autant de fois qu’il est importé.
Si ce comportement est problématique (par exemple quand des signaux sont utilisés pour envoyer des courriels quand un modèle est enregistré), indiquez un identifiant unique dans le paramètre dispatch_uid pour identifier votre fonction réceptrice. Il s’agit généralement d’une chaîne de caractères, même si n’importe quel objet hachable peut faire l’affaire. En conséquence, la fonction réceptrice ne sera inscrite au signal qu’une seule fois par valeur unique de dispatch_uid:
from django.core.signals import request_finished\n\nrequest_finished.connect(my_callback, dispatch_uid="my_unique_identifier")\nLes applications peuvent profiter de l’infrastructure des signaux et fournir leurs propres signaux.
\n\nTous les signaux sont des instances de django.dispatch.Signal.
Par exemple :
\nimport django.dispatch\n\npizza_done = django.dispatch.Signal()\nCeci déclare un signal pizza_done.
Il y a deux façons d’envoyer des signaux dans Django.
\nPour envoyer un signal, appelez Signal.send() (tous les signaux intégrés l’utilisent) ou Signal.send_robust(). Vous devez indiquer le paramètre sender (qui est une classe la plupart du temps) et vous pouvez ajouter autant de paramètres nommés que vous le souhaitez.
Par exemple, voici comment envoyer notre signal pizza_done:
class PizzaStore:\n ...\n\n def send_pizza(self, toppings, size):\n pizza_done.send(sender=self.__class__, toppings=toppings, size=size)\n ...\nAussi bien send() que send_robust() renvoient uns liste de paires de tuples [(récepteur, réponse), ... ] correspondant à la liste des fonctions réceptrices appelées et la valeur de leur réponse.
send() diffère de send_robust() par la manière dont les exceptions générées par les fonctions réceptrices sont traitées. send() n’intercepte aucune exception générée par les récepteurs ; elle laisse simplement les erreurs se propager. Il est donc possible que certains récepteurs ne soient pas notifiés par le signal en cas d’erreur.
send_robust() intercepte toutes les erreurs héritant de la classe Exception de Python et s’assure que tous les récepteurs soient notifiés par le signal. Si une erreur survient, l’instance d’erreur est renvoyée dans le tuple correspondant au récepteur qui a généré l’erreur.
Les traces de débogage sont présentes dans l’attribut __traceback__ des erreurs renvoyées lors des appels à send_robust().
Pour déconnecter un récepteur d’un signal, appelez Signal.disconnect(). Les paramètres sont identiques à ceux décrits pour Signal.connect(). La méthode renvoie True si un récepteur a été déconnecté, sinon False. Lorsque sender est transmis comme référence différée à <app label>.<model>, cette méthode renvoie toujours None.
Le paramètre receiver indique le récepteur inscrit qu’il s’agit de déconnecter. Il peut valoir None si dispatch_uid est utilisé pour identifier le récepteur.