Vous avez peut-être entendu dire que les fonctions avec yield sont appelées générateurs en Python. Qu'est-ce qu'un générateur ?
Laissons de côté les générateurs pour l'instant et utilisons un problème de programmation courant pour démontrer le concept de yield.
Comment générer la suite de Fibonacci
La suite de Fibonacci est une suite récursive très simple. À l'exception des premier et deuxième nombres, tout nombre peut être obtenu en additionnant les deux nombres précédents. Utiliser un programme informatique pour afficher les N premiers nombres de la suite de Fibonacci est un problème très simple, et de nombreux débutants peuvent facilement écrire la fonction suivante :
Listing 1. Afficher simplement les N premiers nombres de la suite de Fibonacci
Exemple
En exécutant le code ci-dessus, on obtient la sortie suivante :
1 1 2 3 5
Le résultat est correct, mais les développeurs expérimentés feront remarquer que l'utilisation directe de print dans la fonction fab pour afficher des nombres rend la fonction peu réutilisable, car la fonction fab renvoie None, et les autres fonctions ne peuvent pas obtenir la séquence générée par cette fonction.
Pour améliorer la réutilisabilité de la fonction fab, il est préférable de ne pas afficher directement la séquence, mais de renvoyer une liste. Voici la deuxième version de la fonction fab réécrite :
Listing 2. Deuxième version de l'affichage des N premiers nombres de la suite de Fibonacci
Exemple
Vous pouvez afficher la liste renvoyée par la fonction fab de la manière suivante :
1 1 2 3 5
La fonction fab réécrite répond à l'exigence de réutilisabilité en renvoyant une liste, mais des développeurs plus expérimentés feront remarquer que la mémoire occupée par cette fonction pendant l'exécution augmente à mesure que le paramètre max augmente. Pour contrôler l'utilisation de la mémoire, il est préférable de ne pas utiliser une liste
pour stocker des résultats intermédiaires, mais plutôt de parcourir un objet itérable. Par exemple, dans Python 2.x, le code :
Listing 3. Parcours d'un objet itérable
for i in range(1000): pass
générera une liste de 1000 éléments, tandis que le code :
for i in xrange(1000): pass
ne générera pas une liste de 1000 éléments, mais renvoie à la place la valeur suivante à chaque itération, occupant très peu d'espace mémoire. Cela s'explique par le fait que xrange ne renvoie pas une liste, mais un objet itérable.
En utilisant itérable, nous pouvons réécrire la fonction fab sous la forme d'une classe qui prend en charge itérable. Voici la troisième version de Fab :
Listing 4. Troisième version
Exemple
La classe Fab retourne continuellement le nombre suivant de la séquence via next(), et l’utilisation de la mémoire reste constante :
1 1 2 3 5
Cependant, cette version réécrite à l’aide d’une classe est bien moins concise que la première version de la fonction fab. Si nous voulons conserver la concision de la première version de la fonction fab tout en obtenant l’effet itérable, yield entre en jeu :
Liste 5. Quatrième version utilisant yield
Exemple
Comparée à la première version, la quatrième version de fab remplace simplement print b par yield b, ce qui permet d’obtenir l’effet itérable tout en conservant la concision.
L’appel de la quatrième version de fab est exactement identique à l’appel de la deuxième version de fab :
1 1 2 3 5
En termes simples, le rôle de yield est de transformer une fonction en générateur. Une fonction comportant yield n’est plus une fonction ordinaire. L’interpréteur Python la traitera comme un générateur. L’appel de fab(5) n’exécutera pas la fonction fab, mais retournera un objet itérable ! Lorsque la boucle for s’exécute, chaque itération exécute le code à l’intérieur de la fonction fab. Lorsqu’elle atteint yield b, la fonction fab retourne une valeur d’itération. À l’itération suivante, le code continue à s’exécuter à partir de l’instruction située après yield b, et les variables locales de la fonction apparaissent exactement comme avant la dernière interruption. La fonction poursuit ensuite son exécution jusqu’à ce qu’elle rencontre à nouveau yield.
Vous pouvez également appeler manuellement la méthode next() de fab(5) (car fab(5) est un objet générateur qui possède une méthode next()), ce qui nous permet de voir plus clairement le flux d’exécution de fab :
Listing 6. Flux d'exécution
Lorsque la fonction termine son exécution, le générateur lève automatiquement une exception StopIteration, indiquant que l'itération est terminée. Dans une boucle for, il n'est pas nécessaire de gérer l'exception StopIteration ; la boucle se termine normalement.
Nous pouvons tirer les conclusions suivantes :
Une fonction contenant yield est un générateur. Contrairement aux fonctions ordinaires, la création d'un générateur ressemble à un appel de fonction, mais elle n'exécute aucun code de la fonction tant que next() n'est pas appelé sur lui (dans une boucle for, next() est appelé automatiquement). Bien que le flux d'exécution suive toujours le flux de la fonction, il est interrompu chaque fois qu'il atteint une instruction yield et renvoie une valeur d'itération. La prochaine fois que l'exécution reprend, elle continue à partir de l'instruction qui suit yield. On dirait qu'une fonction a été interrompue par yield plusieurs fois pendant son exécution normale, et chaque interruption renvoie la valeur d'itération courante via yield.
Les avantages de yield sont évidents. Réécrire une fonction sous forme de générateur lui confère une capacité d'itération. Par rapport à l'utilisation d'une instance de classe pour sauvegarder l'état et calculer la valeur suivante pour next(), c'est non seulement concis en code, mais aussi exceptionnellement clair dans le flux d'exécution.
Comment déterminer si une fonction est une fonction génératrice spéciale ? Nous pouvons utiliser isgeneratorfunction pour le déterminer :
Listing 7. Utilisation de isgeneratorfunction pour déterminer
Nous devons faire attention à distinguer entre fab et fab(5). fab est une fonction génératrice, tandis que fab(5) est un générateur renvoyé par l'appel à fab, tout comme la différence entre une définition de classe et une instance de classe :
Listing 8. Définition de classe et instance de classe
Chaque appel à la fonction fab génère une nouvelle instance de générateur, et les instances ne s'affectent pas mutuellement :
Le rôle de return
Dans une fonction génératrice, s'il n'y a pas de return, elle s'exécute par défaut jusqu'à ce que la fonction se termine. Si return est rencontré pendant l'exécution, il déclenche directement StopIteration pour terminer l'itération.
Un autre exemple
Un autre exemple de yield vient de la lecture de fichiers. Si vous appelez directement la méthode read() sur un objet fichier, cela peut entraîner une utilisation imprévisible de la mémoire. Une bonne approche consiste à utiliser un tampon de longueur fixe pour lire en continu le contenu du fichier. Grâce à yield, nous n'avons plus besoin d'écrire une classe d'itération pour la lecture de fichiers, et pouvons facilement implémenter la lecture de fichiers :
Listing 9. Un autre exemple de yield
Exemple
Ce qui précède ne fait qu'introduire brièvement les concepts de base et l'utilisation de yield. yield a des utilisations plus puissantes dans Python 3, que nous aborderons dans les articles suivants.
Remarque : Tout le code de cet article a été testé et validé sous Python 2.7.
URL d'origine : https://www.ibm.com/developerworks/cn/opensource/os-cn-python-yield/