Rechercher des documents python hors ligne?
En python, je peux obtenir une documentation rudimentaire pour tout objet en utilisant help(<object>). Mais pour pouvoir rechercher la documentation, je dois aller en ligne. Ce n'est pas vraiment utile si je suis quelque part où Internet n'est pas accessible.
Dans R, il existe un double point d’interrogation très pratique (??<topic>) qui me permet de rechercher dans la documentation de toutes les bibliothèques installées toute fonction comportant <topic> dans son nom ou dans la chaîne de documentation. Y a-t-il quelque chose de similaire pour le python? Peut-être même juste pour les objets chargés?
Regardez dans le dossier python du dossier: Doc. Ce dossier contient toute la documentation téléchargée des documents Python de python.org . Je sais que cette réponse est TRÈS tardive, mais elle apporte une solution simple.
pydoc est livré avec python et peut effectuer des recherches mais uniquement dans les lignes de synopsis des modules disponibles. Citer pydoc --help:
pydoc -k Recherchez un mot clé dans les lignes de synopsis de tous les modules disponibles.
Notez que dans pydoc, vous pouvez effectuer des recherches en utilisant "/".
Juste pour ajouter une autre option pour l’accès hors ligne de la documentation Python (principalement de base):
Je n'ai pas accès à un ordinateur Linux pour le moment, mais sous Windows, vous pouvez accéder à your_python_dist_folder/doc pour trouver des fichiers d'aide. En particulier python275.chm par exemple.
S'il n'y a pas de dossier de documentation sur votre machine Linux, vous pouvez télécharger le fichier ici et google pour un visualiseur Linux chm:
https://www.google.com/search?q=linux+chm+viewer
::Remarque:
Certaines distributions incluent également des documents pour d’autres paquets, car cela vaut la peine d’être vérifié. Sinon, help(module) renvoie généralement de bonnes informations.
Modifier :
Vous pourriez obtenir quelque chose qui pourrait être un peu plus proche de ce que vous voulez en utilisant pydoc. Par exemple. vous cherchez quelque chose à propos de sin dans le module de maths:
import math
import pydoc
[i for i in dir(math) if 'sin' in pydoc.getdoc(getattr(math,i))]
Cela renverrait les méthodes dont la docstring inclut sin:
['acos', 'acosh', 'asin', 'asinh', 'cos', 'cosh', 'isinf', 'sin', 'sinh']
pour lequel vous pourriez alors exécuter la fonction help()
Cela a déjà été mentionné dans les commentaires: Zeal est similaire à Dash mais pour Windows/Linux. Il utilise les mêmes sources que Dash. Il a été construit avec Qt et est disponible dans les dépôts pour plusieurs distributions. Pour Ubuntu, il existe un PPA. Téléchargez-le ici .
Zeal est un navigateur de documentation API simple hors ligne inspiré de Dash (application OS X), disponible pour Linux et Windows.
- Recherchez rapidement dans la documentation à l'aide de la touche de raccourci Alt + Espace (ou personnalisée) pour afficher le zèle à partir de n'importe quel endroit de votre espace de travail.
- Rechercher dans plusieurs ensembles de documentation à la fois.
- Ne soyez pas dépendant de votre connexion internet.
- Intégrez Zeal à Emacs, Sublime Text ou Vim. Voir Utilisation »Modules d'éditeur pour plus de détails.
C'est open source (GPL), le développement a lieu sur GitHub . Zeal utilise les mêmes feuilles de style/HTML que les documents en ligne, donc tout devrait paraître familier.
Une alternative dans le navigateur est devdocs.io . Vous pouvez accéder au site Web même si vous êtes hors ligne, à condition que vous les ayez marqués pour un stockage local hors ligne. Vous devez activer les documents Python 2, puis les marquer pour le stockage hors connexion here . Cependant, en tant qu'utilisateur de longue date des documents en ligne Python, je trouve la feuille de style personnalisée que DevDocs utilise un peu gênante.
Bien qu'il existe certainement de meilleures documentations intégrées à votre ordinateur que help () comme Windows inactif, une autre option pour certains des sujets les plus courants serait simplement de sauvegarder une partie de la documentation en ligne sur votre ordinateur. Pour les modules que vous utilisez beaucoup et que vous souhaitez accéder hors ligne, vous pouvez simplement télécharger une version texte de la documentation officielle en ligne de Python, qui est le meilleur endroit pour obtenir de la documentation. (fichier> enregistrer la page sous> sélectionner le format de fichier .txt)
Windows inactif - La fenêtre F1 de Shell ou la fenêtre d’édition vous fournit un fichier d’aide de Windows contenant tous les documents. Je pense que c'est mieux que la version en ligne - il est plus facile de trouver des choses.
Cette information n'était peut-être pas disponible au moment où la question a été posée et répondue, mais python.org met désormais toute la documentation à disposition en ligne sous forme d'archive de fichiers HTML pouvant être parcourus et recherchés hors ligne: https: //docs.python. org/2/download.html
(Le lien mène à docs pour la dernière version de 2.x, mais vous pouvez choisir les versions 3.x et 2.x antérieures à partir de cette page)
Vous devriez essayer ipython .
nom_objet? affichera toutes sortes de détails sur n'importe quel objet, y compris les docstrings, les lignes de définition de fonction (pour les arguments d'appel) et les détails du constructeur pour les classes.
Les commandes magiques% pdoc,% pdef,% psource et% pfile afficheront respectivement la chaîne de documentation, la ligne de définition de fonction, le code source complet et le fichier complet de tout objet (lorsqu'ils peuvent être trouvés). Si automagic est activé (par défaut), vous n’avez pas besoin de taper explicitement le «%».