Vous avez déjà utilisé les paramètres color et linewidth de plot. Les prochains exemples introduiront d’autres fonctions et paramètres. Vous n’avez pas à mémoriser tous leurs noms et leur ordre : PyneIDE affiche leur aide à côté du code.

Ce chapitre utilise le fichier first_chart.py déjà créé. Vous n’avez pas à exécuter le programme.

Survoler le nom de la fonction

  1. Ouvrez first_chart.py depuis le groupe Scripts de la vue Pyne.
  2. Repérez l’appel plot(close, "Close", ...) dans main().
  3. Placez le pointeur sur le nom plot au début de la ligne et laissez-le un instant.

L’aide qui apparaît présente la liste des paramètres et la description de la fonction. Si le contenu est long, placez le pointeur dans l’aide pour la faire défiler. Vous pouvez la fermer avec Esc.

L’aide de PyneIDE est ouverte au-dessus de l’appel à plot de first_chart.py ; la liste des paramètres indique une valeur par défaut de 1 pour linewidth.
L’aide affichée au survol de plot indique aussi le type et la valeur par défaut des paramètres.

Lire la liste des paramètres

L’aide peut présenter plus de paramètres que ceux utilisés dans l’exemple. Il suffit de chercher ceux dont vous avez besoin.

Pour plot, par exemple :

  • series est la valeur à tracer. Dans notre programme, close occupe cette place.
  • title est le nom du tracé. Le deuxième argument, "Close", le définit.
  • linewidth est l’épaisseur de la ligne. Le = 1 dans la liste indique sa valeur par défaut ; notre linewidth=2 la remplace.

Un paramètre est le nom d’une donnée ou d’un réglage attendu par une fonction. Un argument est la valeur que vous lui transmettez lors de l’appel. linewidth est donc un paramètre, et le 2 transmis dans linewidth=2 est un argument.

Un type indiqué à côté d’un nom renseigne sur la valeur attendue. int, par exemple, désigne un entier. Vous retrouverez ces annotations de type dans les prochains chapitres ; vous n’avez pas à en apprendre toute la liste maintenant.

L’aide est rédigée en anglais ; le livre explique aussi en français les paramètres utilisés dans les exemples. Pour une nouvelle fonction, parcourez d’abord sa description, puis cherchez le réglage que vous souhaitez modifier.

Autre possibilité : accéder à la définition

Pour voir où la fonction est écrite, maintenez Command sur macOS ou Ctrl sous Windows ou Linux, puis cliquez sur plot. L’éditeur ouvre la définition correspondante. Vous pouvez aussi faire un clic droit sur le nom et choisir Go to Definition.

Dans le fichier ouvert, la description et le fonctionnement de la fonction se trouvent sous def plot(...). Il s’agit du code de la bibliothèque installée : pour l’exercice, lisez-le sans le modifier. Cliquez sur l’onglet first_chart.py pour revenir à votre programme.

PyneIDE a ouvert la ligne def plot du fichier de bibliothèque plot.py ; la description des paramètres apparaît dessous.
L’accès à la définition ouvre le code de plot dans la bibliothèque. Votre programme reste dans un autre onglet.

Vous n’avez pas besoin de connaître les mécanismes internes de la bibliothèque pour réaliser les exemples du livre. Cet accès vous sera utile si vous souhaitez ensuite étudier une fonction plus en détail.

À vous de jouer

Ouvrez l’aide de plot et recherchez linewidth. Quelle est sa valeur par défaut ? Regardez ensuite votre appel : utilise-t-il la même valeur ?

Solution de l’exercice

La valeur par défaut est 1. Dans first_chart.py, linewidth=2 règle l’épaisseur de ligne sur 2. Si vous retirez cet argument, la fonction utilise la valeur par défaut, 1.