Spécifications

Alice et Bob travaillent ensemble

Bob a besoin des fonctions créées par Alice pour écrire son propre programme.

1. Bob n'a pas sous les yeux le script du module d'Alice. Pour savoir quelles sont les fonctions créées par Alice, sans ouvrir son fichier,comment va procéder Bob ?

Compléter ci-dessous

###(Dés-)Active le code après la ligne # Tests (insensible à la casse)
(Ctrl+I)
Entrer ou sortir du mode "deux colonnes"
(Shift+Esc ; Ctrl pour inverser les colonnes)
Entrer ou sortir du mode "plein écran"
(Esc)
Tronquer ou non le feedback dans les terminaux (sortie standard & stacktrace / relancer le code pour appliquer)
Si activé, le texte copié dans le terminal est joint sur une seule ligne avant d'être copié dans le presse-papier

Solution

En console :

🐍 Console Python
>>> dir(module_alice)

2. Ecrire ci-dessous le code qui permet de connaître le rôle des fonctions écrites par Alice.

###(Dés-)Active le code après la ligne # Tests (insensible à la casse)
(Ctrl+I)
Entrer ou sortir du mode "deux colonnes"
(Shift+Esc ; Ctrl pour inverser les colonnes)
Entrer ou sortir du mode "plein écran"
(Esc)
Tronquer ou non le feedback dans les terminaux (sortie standard & stacktrace / relancer le code pour appliquer)
Si activé, le texte copié dans le terminal est joint sur une seule ligne avant d'être copié dans le presse-papier

Astuce

Regardez bien comment a été réalisé l'importation du module d'Alice.

Solution

En console :

🐍 Console Python
>>> help(module_alice.fonction_1)

puis

🐍 Console Python
>>> help(module_alice.fonction_2)
Bilan de l'exercice

1. Quelle est la syntaxe, et à quoi sert la spécification d'une fonction ?

Solution
  • La spécification s'écrit au début de la fonction entre """ et """
  • On parle aussi souvent de "docstring"
  • Elle sert à préciser les paramètres, ce que renvoie la fonction, et son rôle.

2. Quelle est la syntaxe, et à quoi sert la fonction help ?

Solution

help(ma_fonction) renvoie la docstring de la fonction ma_fonction

Si la fonction fait partie d'un module mon_module.py importé avec import mon_module, il faut écrire : help(mon_module.ma_fonction)