Mis a jour le 2025-04-14, 12:10

Aide sous python

help, avec python en interactif donne de l'aide :
  • help(sorted) ou help(numpy.mean) : aide sur une fonction
  • s = set({3, 4}); help(s) : donne de l'aide sur le type ou la classe à laquelle l'objet appartient
  • help(argparse) : donne l'aide sur le module
  • on peut aussi depuis le shell faire pydoc argparse pour avoir l'aide sur un module.
pydoc
  • soit on fournit le nom d'un module : pydoc myModule
  • soit on fournit le nom d'un fichier, mais il doit y avoir '/' dans le path : pydoc ./myModule.py (pydoc myModule.py ne marche pas)
  • attention, si on fournit un fichier, pydoc doit l'exécuter, donc mettre le code directement exécutable (ici, la fonction main()) sous la forme :
    if __name__ == '__main__':
        main()
        
fonctions disponibles pour une variable ou un objet donné :
  • faire dir(myVar) pour avoir les fonctions, méthodes ou champs disponibles pour la variables myVar.
Package inspect :
  • inspect.getmembers(myObj) : renvoie tous les membres de l'objet sous forme de list de paires (nom, valeur).
  • inspect.getmro(type(myObj)) : renvoie la liste des classes qui sont examinées dans l'ordre
  • inspect.getfullargspec(myFunc) : renvoie un tuple (en fait, un objet ArgSpec dérivant d'un tuple) qui a notamment les champs :
    • args : la liste des noms des arguments.
    • defaults : la liste des valeurs par défaut.

Copyright python-simple.com
programmer en python, tutoriel python, graphes en python, Aymeric Duclert