L'introspection

00:00:00 :On va commencer avec la fonction help qui permet d'obtenir de l'aide sur des modules qu'on utilise et qui est très pratique pour éviter des fois d'avoir à aller fouiller sur Google sur des documentations qui ne sont peut-être pas à jour ou qui sont incomplètes ou des fois fausses même. Help ça va aller
00:00:16 :chercher directement la documentation qui est à l'intérieur des modules qu'on utilise donc vous pouvez être sûr que c'est une documentation officielle et vous allez pouvoir la récupérer sans avoir besoin d'ouvrir un navigateur internet ou autre. On va déjà ouvrir une invite de commande donc je vais taper
00:00:30 :cmd sur Windows pour ouvrir une invite de commande, sur Mac ou Linux ce serait un terminal et je vais taper python pour rentrer dans un shell python et je vais vous montrer donc comment on peut utiliser help de plusieurs façons. Donc
00:00:42 :la première façon de faire c'est tout simplement de taper help, il vous dit ici d'ailleurs vous voyez type help copyright credits or license for more information donc on peut taper directement help ici et on peut avoir de l'aide interactive donc là vous voyez il nous dit que si on veut de l'aide
00:00:58 :interactive il faut taper avec les parenthèses sinon on peut directement entrer un objet sur lequel on va avoir de l'aide. Donc moi je vais rentrer pour
00:01:05 :l'instant dans l'aide interactive donc j'appuie sur entrer et là vous voyez donc il nous dit qu'on est rentré dans l'aide de python donc là vous voyez que c'est préfixé par help et on peut commencer à taper par exemple des mots clés pour obtenir de l'aide à propos de ces mots clés. Donc là par exemple il
00:01:23 :vous dit en fait tout si vous lisez vous avez toutes les informations qui sont disponibles donc par exemple on peut taper modules et modules ce que ça va faire c'est que ça va nous retourner toute la liste des modules qui sont disponibles qu'on peut utiliser donc là vous voyez qu'il y en a quand même
00:01:34 :beaucoup ça lui prend un petit peu de temps à aller tous les chercher et donc vous voyez si jamais vous n'êtes pas sûr de quels modules sont disponibles et bien vous pouvez directement dans help taper modules et ça vous retourne une liste de tous les modules pas seulement des modules de base vous voyez que là
00:01:47 :j'ai des modules que j'avais créé moi pour mes projets personnels donc THB project manager tout ça donc ça c'est des modules à moi et il me les affiche aussi directement là dedans donc c'est vraiment très pratique pour avoir une liste de tous les modules disponibles sur votre ordinateur. Vous pouvez même
00:02:00 :aller plus loin et par exemple taper le nom d'un module directement donc je vais taper module timeit et là vous allez voir qu'il va chercher dans tous les modules s'il y a un module qui contient le mot timeit donc là il y en a un qui va sortir puisque il y a un module dans la liste des modules qui s'appelle timeit
00:02:15 :donc là vous voyez que il me sort le nom du module et ce qu'il fait donc là il y en a juste un puisque j'y suis allé assez précis mais je pourrais tout simplement rentrer module time et là ça me sortirait donc tous les modules qui contiennent le mot time donc là on voit qu'on a date time, on a time, on va avoir
00:02:30 :timer aussi donc tout plein de modules ici qui contiennent le mot time que ce soit dans le nom du module ou dans l'indication là vous voyez qu'on a des modules by installer par exemple qui ne contiennent pas le mot time dans le nom du module mais dans la description donc là c'est pas time au sens où on l'entend
00:02:46 :c'est run time donc c'est un peu différent mais vous voyez ça permet rapidement de voilà de faire des recherches de voir quels modules sont disponibles qu'est ce qu'on peut utiliser etc et il y a plein de trucs comme ça qu'on peut faire donc par exemple si on veut voir une liste des
00:02:59 :mots clés qui sont réservés par python on peut taper keywords et là ça va nous sortir vous voyez toute la liste des mots qui sont réservés donc ça c'est des mots qu'on peut pas utiliser par exemple pour des variables donc si vous utilisez une variable que vous appelez print et bien vous allez écraser en fait
00:03:12 :la fonction print qui existe de base et donc ça va vous retourner des erreurs donc tout ça c'est les mots clés qui sont réservés donc si jamais vous vous en souvenez plus là aussi c'est très pratique d'aller directement dans l'aide de python pour chercher cette information. Moi je m'en sers aussi beaucoup
00:03:26 :directement sur un module donc on peut par exemple ici importer un module comme le module random et indiquer entre parenthèses le module qu'on veut inspecter donc là je vais commenter cette ligne ici et je vais tout simplement exécuter le script on n'a pas besoin de faire un print juste le fait
00:03:42 :de taper help et de mettre entre parenthèses le nom du module ça va nous retourner l'information à propos de ce module donc je vais réduire un petit peu la taille ici pour qu'on voit quelque chose donc là vous voyez que ça me retourne vraiment l'aide du module au complet donc c'est assez assez long il
00:03:56 :y a vraiment beaucoup beaucoup d'informations donc là vous voyez qu'il nous fait un résumé de l'aide donc sur le module random donc ça nous dit qu'est ce que ça permet de faire ça nous dit où est ce qu'il est sur le disque ça va nous donner toutes les toutes les donc les classes les fonctions les méthodes
00:04:09 :qui sont disponibles et donc là vous voyez que on peut par exemple aller fouiller là dedans voir qu'est ce qui pourrait être intéressant donc là par exemple la fonction randint donc qui permet de retourner un integer dans un range donc entre a et b qui inclut les donc le début et la fin donc c'est à
00:04:26 :dire que si on fait un range entre 0 et 10 ça va nous retourner un nombre qui va être compris entre 0 et 10 0 et 10 inclus donc maintenant qu'on sait directement le nom de la fonction on peut même faire un help directement sur cette fonction donc là random.randint et ce que ça va faire ce help ici ça
00:04:42 :va nous retourner directement la phrase qu'on voit ici donc si vous savez directement la fonction que vous voulez inspecter donc là par exemple la fonction randint vous pouvez directement le mettre ça va faire moins de texte et vous aurez directement l'aide qui sera reliée à cette méthode précise et non
00:04:57 :pas à tout le module puisque le module ça peut être assez grand donc là c'est à vous de voir ce que vous voulez est-ce que vous voulez voir toutes les méthodes qui sont contenues dans le module que vous voulez utiliser ou est-ce que vous voulez voir l'aide d'une fonction en particulier donc vous voyez c'est
00:05:08 :vraiment très pratique la fonction help que vous sachiez la fonction que vous voulez utiliser comme par exemple la fonction randint ou que vous vouliez chercher quelles fonctions sont disponibles à l'intérieur d'un module et bien sans quitter vous voyez votre script python vous pouvez directement faire de l'introspection pour aller chercher directement la documentation
00:05:25 :donc ça c'est en fait les docstring donc les docstring qui sont contenus à l'intérieur de ces méthodes qui nous sont retournés automatiquement par python qu'on peut donc lire et utiliser ensuite donc là par exemple je peux utiliser cette fonction randint pour me générer un nombre aléatoire entre 1 et 10
00:05:41 :donc même si vous connaissez pas tout vous voyez donc là voilà ça me retourne 1 par exemple donc même si vous connaissez pas toutes les fonctions qui sont disponibles la fonction help est votre ami dans ce cas ci pour pouvoir explorer qu'est ce qui est disponible les modules que vous avez qui sont

La fonction help

Toutes les questions

Farid

Exporter le résultat de help dans un fichier

Rechercher sur le site

La fonction help

Inscris-toi

Toutes les questions

Farid

Exporter le résultat de help dans un fichier

Rechercher sur le site