114
J'ai la fonction suivante:Obtenir le docstring d'une fonction
def my_func():
"""My docstring is both funny and informative"""
pass
Comment puis-je avoir accès à la docstring?
A
Répondre
157
interactivement, vous pouvez l'afficher avec
help(my_func)
Ou du code que vous pouvez récupérer avec
my_func.__doc__
+1
BTW: Cette technique fonctionne avec des fonctions intégrées ainsi que des modules et des classes (aide au test() avec des objets aussi - pourrait aussi fonctionner). Cela rend votre shell python un shell d'aide interactif! –
+2
Sur l'invite ipython, vous pouvez faire my_func ?? et il montrerait le docstring aussi bien. – ronak
+3
Python est tellement cool – ThorSummoner
56
Vous pouvez également utiliser inspect.getdoc. Il nettoie le __doc__ en normalisant les tabulations vers les espaces et en décalant vers la gauche le corps du document pour supprimer les espaces principaux communs.
+1
Maintenant c'est exactement ce que j'essayais de faire moi-même. Merci pour ça. – ereOn
1
Sur ipython ou ordinateur portable jupyter, vous pouvez utiliser tous les moyens mentionnés ci-dessus, mais j'aller avec
my_func?
ou
?my_func
pour un résumé rapide à la fois la signature de la méthode et docstring.
J'éviter d'utiliser
my_func??
(comme commenté par @rohan) pour docstring et l'utiliser uniquement pour vérifier le code source
Questions connexes
- 1. Python Get Docstring sans passer en mode interactif
- 2. show * only * docstring dans la documentation Sphinx
- 3. Existe-t-il un standard (comme phpdoc ou docstring de python) pour commenter le code C#?
- 4. Comment obtenir le dernier numéro de la fonction range()?
- 5. Python - Obtenir des arguments de fonction d'origine dans le décorateur
- 6. fonction pour obtenir le nom de n'importe quelle méthode?
- 7. Obtenir appel nom de la fonction de fonction appelée
- 8. dans flex, obtenir le nom de la fonction à partir de l'objet Fonction
- 9. Obtenir le nom de la fonction appelant dans une autre fonction en Python?
- 10. Obtenir le nom d'objet dans le objectScope
- 11. Tableau de pointeurs de fonction membre: Obtenir 0xcccccccc lorsque le contrôle a atteint pointeur vers une fonction membre
- 12. sur les fenêtres avec django-je obtenir un WindowsError (3, «Le système ne peut pas trouver le chemin spécifié)
- 13. Obtenir le visage d'un cube
- 14. comment obtenir l'objet JSON en fonction de sa valeur
- 15. Ne pas obtenir la fonction glob en PHP
- 16. Comment puis-je obtenir le numéro de version d'une fonction Eclipse personnalisée lors de l'exécution?
- 17. Quelle est la fonction utilisée dans Sql Server 2005 pour obtenir le datetime actuel dans utc?
- 18. fonction pour obtenir le descripteur de fichier terminal du processus en cours UNIX
- 19. Comment puis-je obtenir le plein dans SpiderMonkey backtrace (JSAPI) de ma fonction reportError?
- 20. Comment puis-je obtenir le nom d'une fonction d'appel dans un module dans Mathematica?
- 21. Fonction PHP pour obtenir élément de différence des deux tableaux
- 22. Comment obtenir la valeur de retour d'une fonction dans windbg?
- 23. obtenir l'heure actuelle en fonction du fuseau horaire dans javascript
- 24. Obtenir le contrôle en javascript
- 25. Comment obtenir le texte d'exception Python
- 26. Comment obtenir le client complet rect?
- 27. Obtenir le mime de fichiers texte
- 28. Obtenir le courrier d'un contact sur l'iPhone
- 29. Obtenir le nom du fichier en PHP
- 30. obtenir le texte html en exécutant url
Notez que l'exécution de Python avec -OO bandes sur docstrings. Si vous avez l'intention de distribuer votre code à d'autres, gardez à l'esprit qu'ils peuvent l'exécuter de cette façon. Cela rendra vraiment ces gens vraiment mécontents si votre code repose sur des docstrings, mais n'attrape pas le cas où ils n'existent pas. – DNS
Bravo pour ça, c'est une information plutôt utile. – Teifion
@DNS Merci, je me demandais pourquoi tous mes docstrings étaient None. – Timo