L'obtention de la docstring à partir d'une fonction

J'ai la fonction suivante:

def my_func():
    """My docstring is both funny and informative"""
    pass

Comment puis-je accéder à la docstring?

  • Notez que l'exécution de Python avec -OO bandes docstrings. Si vous avez l'intention de distribuer votre code pour les autres, gardez à l'esprit qu'ils peuvent exécuter de cette façon. Il fera de ces gens vraiment vraiment malheureux si votre code s'appuie sur les docstrings, mais ne l'attrape pas le cas où ils n'existent pas.
InformationsquelleAutor Teifion | 2009-04-03
  1. 225

    De manière interactive, vous pouvez l'afficher avec

    help(my_func)

    Ou de code, vous pouvez le récupérer avec

    my_func.__doc__
    • BTW: Cette technique fonctionne avec les fonctions internes ainsi que des modules et des classes (aide test() avec des objets trop - peut également travailler). Cela rend votre python shell interactif d'aide coquille!
    • Sur le ipython invite, vous pouvez faire my_func?? et elle montrerait la docstring ainsi.
    • de l'aide(func) donne une version lisible de sortie tandis que la touche func.__doc__ donne un inline sortie. Merci pour la réponse.
    InformationsquelleAutor unwind
  2. 74

    Vous pouvez également utiliser inspecter.getdoc. Il nettoie la __doc__ en normalisant les tabulations en espaces et à gauche en transférant la doc corps à éliminer les espaces communs.

    InformationsquelleAutor Andrew Dalke
  3. 7

    Sur ipython ou jupyter ordinateur portable, vous pouvez utiliser tous ces moyens, mais je vais avec 

    my_func?

    ou

    ?my_func

    rapide résumé des deux signature de la méthode et de la docstring.

    - Je éviter d'utiliser 

    my_func??

    (comme indiqué par @rohan) pour docstring et de les utiliser uniquement pour vérifier le code source

    InformationsquelleAutor Sameer Sinha