Documentation Python
Utiliser la documentation officielle de Python
La documentation officielle de Python est l’outil de référence pour tous les développeurs, du débutant à l’ingénieur confirmé. Savoir s’en servir fait partie des compétences professionnelles de base : au lieu de mémoriser tout le langage, on apprend à retrouver l’information fiable, à jour, au bon endroit.
1. Où trouver la documentation officielle ?
Le site officiel est :
👉 https://docs.python.org/3/contents.html
Pour accéder directement à la version française :
- ouvre la page ci-dessus ;
- dans le menu “Language” en haut à gauche, choisis Français ;
- l’URL devient souvent
https://docs.python.org/fr/3/....
Si la traduction française n’est pas à jour, il est utile de comparer avec la version anglaise pour vérifier les détails les plus récents.
2. Les grandes parties de la documentation
La documentation Python est organisée en plusieurs sections. Les plus utiles au quotidien sont :
- Tutoriel — une introduction progressive au langage (variables, conditions, boucles, fonctions, modules, etc.) ;
- Référence du langage — très précise, formelle, plutôt utilisée pour vérifier le comportement exact d’une fonctionnalité ;
-
Bibliothèque standard — décrit tous les modules fournis avec Python
(
math,random,datetime,pathlib, etc.) ; - HowTo / Guides pratiques — des articles thématiques (“Comment gérer les fichiers”, “Comment faire du logging”, etc.) ;
- Glossaire — un dictionnaire des termes importants (itérateur, générateur, compréhensions, etc.).
Un développeur professionnel sait dans quelle section chercher en fonction de sa question.
3. Chercher efficacement une information
Exemples de questions typiques et où chercher :
-
« Comment arrondir un nombre ? »
→ cherche “round” dans la documentation (barre de recherche en haut à droite) ou dans la page “Built-in Functions”. -
« Comment générer un nombre aléatoire ? »
→ va dans le modulerandomde la bibliothèque standard, puis regarde les fonctionsrandint,random, etc. -
« Comment travailler avec la date et l’heure ? »
→ consulte le moduledatetime(sectionsdate,time,datetime,timedelta).
Astuce “pro” : en plus de la barre de recherche du site, tu peux utiliser Ctrl + F dans ton navigateur pour chercher un mot sur la page actuelle.
4. Lien entre le code Python et la documentation
Python fournit aussi des outils intégrés pour t’aider à retrouver la documentation depuis le code :
-
La fonction
help()dans l’interpréteur :
>>> help(len)
>>> help(str.split)
Affiche un résumé de ce que fait la fonction, souvent directement dérivé de la documentation officielle. -
Les docstrings (chaînes de documentation) des fonctions et classes :
print(len.__doc__)
montrent le texte explicatif associé à l’objet.
Bon réflexe professionnel : quand tu utilises une fonction pour la première fois, jette un coup d’œil à sa documentation pour comprendre tous ses paramètres et ses comportements particuliers.
5. Mini-exercices pratiques
Essaie de faire ces petites recherches dans la documentation (sans passer par Google) :
-
Trouve la documentation de la fonction
len(). Quel est son rôle exact ? Quels types d’objets peut-elle mesurer ? -
Dans le module
math, trouve la fonction qui permet de calculer la racine carrée. Quel est son nom ? Quel est son type d’argument ? -
Dans le module
random, trouve une fonction qui renvoie un entier aléatoire entre 1 et 6 (comme un dé). Comment s’écrit l’appel ?
Tu peux noter tes réponses dans ton cahier ou dans un fichier texte, puis vérifier directement dans la documentation si tu as vu toutes les options.
6. QCM interactif : maîtriser la documentation Python
Coche une réponse par question puis clique sur « Vérifier mes réponses ».