Fonctions et effets de bord
Ce cours traite du problème numéro un du projet : des fonctions qui modifient plein de variables sans qu'on le voie.
Le problème
Voici Unit.move, simplifiée :
Python
Le nom dit « déplacer une unité ». Les quatre premières lignes le font. Les deux dernières changent la sélection du joueur et ouvrent ou ferment des panneaux à l'écran. Rien dans le nom ni dans les paramètres ne l'annonce.
La notion : l'effet de bord
Une fonction peut faire deux choses :
- renvoyer une valeur ;
- modifier quelque chose à l'extérieur d'elle : c'est un effet de bord.
Une fonction pure ne dépend que de ses paramètres et ne modifie rien. Appelée deux fois avec les mêmes valeurs, elle rend le même résultat.
Python
Les effets de bord ne sont pas interdits. Un jeu doit modifier son état et dessiner à l'écran. Le but est de les rendre peu nombreux et prévisibles.
Pourquoi les fonctions pures sont précieuses
| Qualité | Fonction pure | Fonction avec effets de bord |
|---|---|---|
| Comprendre | On lit la fonction, c'est tout | Il faut connaître tout ce qu'elle touche |
| Tester | Une ligne : entrée, résultat attendu | Il faut préparer un jeu complet |
| Réutiliser | Partout | Seulement dans le même contexte |
| Déboguer | Le bug est dedans | Le bug peut venir de n'importe quel état extérieur |
L'état global, même déguisé
Python a le mot-clé global. Le projet ne l'utilise pas. Mais chaque classe garde self.game, qui donne accès à tout :
Python
Du point de vue de celui qui lit, le résultat est le même qu'une variable globale : n'importe quelle fonction peut modifier n'importe quelle donnée. Pour savoir qui change selected_, il faut chercher dans tout le projet. La réponse : six fonctions, dans deux fichiers, dont aucun n'est celui de la carte.
Quatre techniques pour s'en sortir
1. Séparer le calcul de l'action
Une fonction qui calcule, une fonction qui applique.
Python
La seconde version sert au joueur, au bot et aux tests. Elle ne dessine rien.
2. Passer ce dont on a besoin en paramètre
Au lieu d'aller chercher dans self.game, on reçoit.
Python
La signature devient honnête : elle dit de quoi la fonction a besoin. Et le bot peut l'appeler avec son unité.
3. Renvoyer un résultat plutôt que modifier en cachette
Python
L'interface peut alors afficher un message au joueur.
4. Un seul propriétaire par donnée
Chaque donnée appartient à un objet, et lui seul la modifie. Les autres passent par ses méthodes.
Python
Commande et requête
Une règle simple à garder en tête : une fonction répond à une question ou change quelque chose, pas les deux.
| Type | Renvoie | Modifie | Exemple |
|---|---|---|---|
| Requête | Une valeur | Rien | get_ |
| Commande | Un compte rendu | L'état | finish_ |
look_ fait les deux : selon le cas elle sélectionne une case, ouvre un panneau, ou construit un bâtiment. D'où la difficulté à la nommer.
Dans le jeu : avant, après
À retenir
- Un effet de bord, c'est tout ce qu'une fonction modifie en dehors d'elle.
self.gamepartout revient à une variable globale.- Séparer calculer et appliquer.
- Les paramètres disent de quoi la fonction a besoin, la valeur de retour dit ce qui s'est passé.
- Une donnée, un propriétaire.
Exercices
- Dans
units.py, lister tout ce que modifieSettler.. Combien d'objets différents ?special_ action - Écrire la fonction pure
allowed_ci-dessus à partir debuild_ coos Map., et l'utiliser dans cette dernière.draw_ build_ tiles - Chercher
selected_dans tout le projet. Qui devrait être le seul à la modifier ?tile = - Faire renvoyer
TrueouFalseàUnit.moveselon que le déplacement a eu lieu. Où ce résultat serait-il utile ?