Suche python docs offline?

In python kann ich einige rudimentäre Dokumentation für jedes Objekt mit help(<object>). Doch um fähig zu sein Suche in der Dokumentation, die ich habe, um online zu gehen. Das ist nicht wirklich hilfreich, wenn ich irgendwo, wo das internet nicht zugänglich ist.

In R, gibt es eine praktische Doppel-Fragezeichen-Funktion ( ??<topic> ), die mir erlaubt, durchsuchen Sie die Dokumentation aller installierten Bibliotheken für eine beliebige Funktion beinhaltet <topic> im Namen oder der Dokumentation für string. Gibt es etwas ähnliches für python? Vielleicht sogar nur für geladene Objekte?

Welche Plattform/Betriebssystem?
Ich bin auf linux, aber ein cross-Plattform-Antwort wäre vorzuziehen, wenn möglich.
Beachten Sie, dass stackoverflow.com/questions/723017 auf docs.python.org/3/download.html das ist sicherlich hilfreich, aber enthält nur die core python docs. Ich bin interessiert an der Suche die Dokumentation für python-core und alle Module installiert (oder nur die importierte).
Wäre wirklich interessant, den Grund für die downvotes hier. Wenn ein solches feature ist in anderen Sprachen verfügbar (wie R), dann ist es irgendwie nicht für python? Unpythonic? Gegen den Zen?
Auf viele Module, können Sie gehen Sie durch die Dateien und es herausfinden, durch das Lesen der Kommentare oder code.
Ich konnte ziehen Sie auch ein Auto auseinander, um herauszufinden, wie es funktioniert, aber wenn ich will, um etwas zu beheben, würde ich lieber einen anständigen service-Handbuch mit einem guten index.
Ja, es ist nicht der beste Weg. Jedoch, alles, was Sie tun müssen, ist Blick auf die Datei und Lesen Sie die Kommentare am Anfang jeder Funktion oder Klasse. Dann wieder, können Sie dies nur tun, wenn Sie das Modul ist nur eine Datei. In der Regel, wenn es mehr als eins, wird es eine readme-Datei mit einer Beschreibung. Im Grunde sind Sie nur auf der Suche auf den Etiketten von jeder größeren Teil des Autos. Offen ist aber auch nicht schlimm, wenn sonst nichts funktioniert.

InformationsquelleAutor naught101 | 2013-10-18

offline python

26

Blick in den python-Ordner in den Ordner: Doc. Dieser Ordner hat den gesamten heruntergeladenen Dokumentation der python-docs aus python.org. Ich weiß, das ist eine SEHR späte Antwort, aber bringt es eine einfache Lösung.
- Die Frage ist, über suchen die docs. Was ist Ihr Vorschlag? Ich denke, grep funktionieren könnte, je nach format..
- Gut, es gibt die Möglichkeit, die Suche im Fenster "Dokumentation" angezeigt. Es ist, wie meine Antwort sagt, die gleiche Dokumentation wie auf der Website.
- Du hast Recht, ich verpasst, dass zu der Zeit. Allerdings ist es nicht enthalten Dritter Bibliotheken, wie numpy. Haben Sie getrennte docs verfügbar, aber man kann nicht suchen, die über das gesamte ökosystem auf einmal...
- Ich glaube tatsächlich, das ist die beste Antwort, die jetzt die HTML-Version des python-docs sind Recht gut, und die Suche funktioniert Recht gut. Es scheint jedoch, dass, wenn es keine python-[Modul]-doc Paket in der Paket-manager (z.B. für weniger beliebte Pakete), dann gibt es keine einfache Möglichkeit zum installieren von Paketen' docs und verwenden Sie es auf diese Weise.
- Noch ich Stimme mit dem ersten Kommentar. Diese Antwort ist unvollständig - mehr ein Hinweis in die richtige Richtung. In meinem Fall, zum Beispiel, ich bin mir auch nicht sicher, wo die Doc-Ordner ist, oder wie Sie es finden. Auch, welcher Befehl zu verwenden, um Sie zu durchsuchen? Ich konnte herausfinden, etwas über grep, nehme ich an. Ich denke, es könnten davon profitieren ein Beispiel-code-snippet.
InformationsquelleAutor AHuman
16

pydoc kommt mit python und kann nicht sucht, sondern nur in der Zusammenschau Linien der zur Verfügung stehenden Module. Zitieren pydoc --help:
```
pydoc -k 
Suchen nach einem Schlüsselwort in der synopsis Linien aller verfügbaren Module. 
```
Beachten Sie, dass in pydoc Sie können Suchvorgänge mit "/".
- Das klingt ziemlich genau das, was ich Suche, außer, dass es nicht schlecht wenn ich es benutze: AttributeError: 'NoneType' object has no attribute 'load_module'. Ich denke, vielleicht habe ich ein Modul irgendwo mit Problemen, aber ich kann es nicht finden, und vermutlich auch so ein tool sollte die Behandlung dieser Art von problem. Auch, wie es aussieht lädt er alle Module zu jeder Zeit, das dauert eine Weile: Es wäre fantastisch, wenn es cached die Ergebnisse (vielleicht passt es und ich bin einfach nicht sehen, denn es ist fehlerhaft).
- In der Tat pydoc Werke durch den Import der Module. Wenn Sie in Ihrem python-Pfad, der nicht importiert werden kann, wird es scheitern.
- Sie können auch suchen in einem browser mit pydoc3 -b die Start an HTTP server on an arbitrary unused port and open a Web browser to interactively browse documentation.
InformationsquelleAutor Nicolas Barbey
5

Nur um eine weitere option für den offline-Zugriff von python docs (hauptsächlich core):

Ich habe keinen Zugriff auf einen linux-Rechner im moment, aber auf windows, navigieren Sie zu your_python_dist_folder/doc zu finden, einige Hilfe-Dateien. Besonders python275.chm zum Beispiel.

Wenn es keine doc-Ordner auf Ihrem linux-Computer, können Sie die Datei herunterladen hier und google für eine linux-chm-viewer:

https://www.google.com/search?q=linux+chm+viewer

::Hinweis:

Manche Distributionen enthalten auch Dokumente für andere Pakete gibt... vielleicht lohnt sich ein check. Other than, die help(module) in der Regel gibt gute Informationen.

Bearbeiten:

Bekommen konnte, etwas, das vielleicht ein wenig näher an, was Sie wollen, indem Sie pydoc. E. g. Sie sind auf der Suche für etwas über sin im math-Modul:
```
import math
import pydoc
[i for i in dir(math) if 'sin' in pydoc.getdoc(getattr(math,i))]
```
Dieser zurückkehren würde, die Methoden, deren docstrings gehören sin:
```
['acos', 'acosh', 'asin', 'asinh', 'cos', 'cosh', 'isinf', 'sin', 'sinh']
```
für die Sie dann laufen konnte, die help() Funktion

InformationsquelleAutor pandita
5

Dieser wurde erwähnt in den Kommentaren schon: Eifer
ist ähnlich wie Dash, aber für Windows/Linux. Es nutzt die gleichen Quellen wie Dash. Es wurde mit Qt und ist in den repositories für die verschiedenen Distributionen, für Ubuntu gibt es ein PPA. Laden Sie es hier.
Eifer ist eine einfache offline-API-Dokumentation browser-inspiriert von Dash (OS-X-app), die es für Linux und Windows.
- Schnelle Suche und Dokumentationen über Alt+Leertaste (oder besonders angefertigt) - hotkey zum anzeigen Eifer von jedem Ort in Ihrem Arbeitsbereich.
- Suche in mehreren Dokumentationen auf einmal.
- Sei nicht abhängig von Ihrer internet-Verbindung.
- Integrieren Eifer, mit Emacs, Sublime Text oder Vim. Siehe Verwendung » Editor-plugins für details.
Es ist open-source (GPL), die Entwicklung geschieht auf GitHub. Eifer verwendet die gleichen stylesheets/HTML als online-docs, also alles sollte vertraut Aussehen.

Einen im-browser-alternative ist devdocs.io. Sie können auf die website zugreifen, selbst wenn Sie offline sind, vorausgesetzt, dass Sie markiert haben Sie für die lokalen offline-Speicher. Sie müssen aktivieren Sie die Python 2 docs, und markieren Sie Sie für die offline-Speicherung hier. Jedoch, als langjähriger Nutzer des online-Python-docs, ich find die custom-stylesheet, das DevDocs wird ein bisschen abgelenkt.

InformationsquelleAutor jmiserez
4

Fall, dass Ihre arbeiten in einem Mac gibt es Dash, die es erlaubt, Sie herunterzuladen, docsets und erkunden Sie dann/search offline. Trotz seiner Dokumentation Funktionalität, Dash ist auch ein Snippet-Manager.
- wissen Sie, ob es ein open-source-alternative zu Dash? Der Zustand von offline-Dokumentationen surfen ist miserabel und ich überlege mir, das schreiben Sie selber einen.
- Check-out Eifer - zealdocs.org
InformationsquelleAutor simme
2

Windows-Idle - F1-shell-Fenster ein oder Bearbeiten-Fenster bekommt man eine windows-Hilfe-Datei von allen docs. Ich denke, es ist besser als die online - version- es ist einfacher, Sie zu finden Zeug.

InformationsquelleAutor wwii
2

Obwohl es sicher bessere Dokumentationen gebaut in den computer als Hilfe (wie windows idle, ist eine weitere option für einige der häufigsten Themen würden nur zu sparen der online-Dokumentation zu Ihrem computer. Für die Module, die Sie verwenden eine Menge, und Sie möchten, um offline-Zugriff, könnten Sie laden Sie einfach eine text-Datei-version von der offiziellen online-python-Dokumentation, das ist der beste Ort, um Dokumentation. (Datei - > Seite speichern unter > wählen .txt-Datei-format)

InformationsquelleAutor trevorKirkby
2

Kann dies nicht verfügbar war zu der Zeit die Frage gestellt und beantwortet, aber python.org jetzt macht die gesamte Dokumentation als online-Archiv der HTML-Dateien navigiert und recherchiert offline: https://docs.python.org/2/download.html

(Der link leitet zur Dokumentation für die neueste version von 2.x, aber Sie können wählen, 3.x und älter 2.x-Versionen von dieser Seite)
- Ja, leider, es ist nur der Kern der Dokumentation, keine 3rd-party-Bibliotheken.
InformationsquelleAutor sabeer
0

Sollten Sie versuchen,ipython.

object_name? druckt alle möglichen details über jedes Objekt,
darunter docstrings -, Funktions-definition-Linien (für call-Argumente)
und der Konstruktor details für Klassen.

Des Magie-Kommandos %pdoc, %pdef, %psource und %pfile wird bzw. drucken Sie die docstring -, Funktions-definition-line, full-source-code und die komplette Datei für jedes Objekt (wenn Sie gefunden werden kann). Wenn automagic eingeschaltet ist (Standardeinstellung), müssen Sie nicht geben Sie '%' explizit.
- Sorry, aber das ist völlig irrelevant für die Frage. Ich weiß, wie ich Lesen Sie die Dokumentation eines Objekts, und ich verwende bereits ipython. Aber keine, die mir erlaubt, Suche die Dokumentation für alle verfügbaren Module oder alle geladenen Objekte.
InformationsquelleAutor Leonardo.Z

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.