En Python, que fait pydoc?
Nouveauté en programmation et en python. Dans mon livre, l'auteur m'a suggéré de découvrir le but de Pydoc.
J'ai fait une recherche sur Google et trouvé une correspondance (à partir de Gnome Terminal), mais cela n'avait pas beaucoup de sens pour moi. Quelqu'un veut-il simplifier un peu? Merci.
Pydoc est un module d’aide/documentation pour Python.
Utilisez ceci sur votre terminal Windows pour comprendre ce qu’une fonction en python fait:
python -m pydoc <function>
par exemple.
python -m pydoc raw_input
Si la documentation d'une fonction particulière est très longue, utilisez 'q' pour en sortir.
par exemple. en cas de
python -m pydoc Tkinter
C'est un outil pour générer une documentation de style python voir http://docs.python.org/2/library/pydoc.html
Vous voudrez peut-être aussi jeter un coup d'œil au Sphinx.
Pydoc est le système de génération de documentation pour Python. Supposons que vous puissiez documenter vos fonctions en utilisant le standard Pydoc, qui pourra ensuite être utilisé pour générer de la documentation dans votre code.
Le module Pydoc en Python peut être utilisé pour générer de la documentation sous la forme de pages HTML ou même sur la console.
python -m pydoc
Cette commande donne des options comme afficher le pydoc pour un fichier, -k rechercher différentes bibliothèques, -p permet d'ouvrir une page dans un navigateur Web pour afficher les paquetages python, -g fournit une interface graphique pour la recherche de documentation, -w écrit une sortie HTML . Vous trouverez ci-dessous des exemples de commandes que vous pouvez activer pour les tests.
python -m pydoc yourpythonfile
python -m pydoc -k ftplib
python -m pydoc -p 314
python -m pydoc -w file
J'ai créé deux exemples de fichiers dans un répertoire file1.py et file2.py contenant un code simple avec une seule ligne de commentaire.
def f2m(ft):
""" Return the number of meters eq to feet """
return 0.30 * ft
Une façon de voir le commentaire des fichiers est simplement d'écrire ci-dessous dans le même fichier et de lancer python fichier.py pour afficher les commentaires.
help(f2m)
Une autre façon de voir cela est d'écrire la commande
python -m pydoc file1
Une autre façon de voir les commentaires dans une page html en tapant cette commande et en l'exportant au format html
python -m pydoc -w <dir>
Si vous avez plusieurs fichiers python et si vous voulez générer du HTML dans un dossier séparé, de simples commandes Shell peuvent faire l'affaire. Le code ci-dessous génère un dossier 'htmldocs', puis génère du HTML et les déplace dans ce nouveau dossier. Si vous ouvrez une fenêtre dans le coin supérieur droit, vous pouvez voir l’option d’index qui vous permet de naviguer entre les autres pages.
mkdir -p htmldocs
pydoc -w `find . -name '*.py'`
mv *.html htmldocs
Le module pydoc génère automatiquement la documentation à partir de modules Python. La documentation peut être présentée sous forme de pages de texte sur la console, servie dans un navigateur Web ou enregistrée dans des fichiers HTML.
Pour les modules, les classes, les fonctions et les méthodes, la documentation affichée est dérivée de la docstring (c.-à-d. L'attribut doc de l'objet) et de manière récursive de ses membres documentables. S'il n'y a pas de docstring, pydoc tente d'obtenir une description à partir du bloc de lignes de commentaire situé juste au-dessus de la définition de la classe, de la fonction ou de la méthode dans le fichier source ou en haut du module.
Pour plus d'informations sur les versions respectives de Python - Python 2.7 - Python 3.5 - - Python 3.6
Description concise fournie par Wikipedia: "Pydoc permet aux programmeurs Python d’accéder aux fichiers d’aide à la documentation de Python, de générer du texte et des pages HTML avec des informations spécifiques sur la documentation et de trouver le module approprié pour un travail particulier."