Zusammenfassung

Diese PEP beschreibt eine kommandozeilengesteuerte Online-Hilfefunktion für Python. Die Funktion sollte auf bestehenden Dokumentationsfunktionen wie der Python-Dokumentation und Docstrings aufbauen können. Sie sollte auch für neue Typen und Module erweiterbar sein.

Interaktive Nutzung

Das einfache Eingeben von help beschreibt die Hilfefunktion (durch Überladen von repr()).

help kann auch als Funktion verwendet werden.

Die Funktion akzeptiert folgende Eingabeformen

• help( "string" ) – Eingebautes Thema oder globales Objekt
• help( <ob> ) – Docstring von Objekt oder Typ
• help( "doc:filename" ) – Dateiname aus der Python-Dokumentation

Wenn Sie nach einem globalen Objekt fragen, kann dies ein vollständig qualifizierter Name sein, wie z. B.:

help("xml.dom")

Sie können die Funktion auch von der Kommandozeile aus verwenden

python --help if

In beiden Fällen gibt die Ausgabe eine Paginierung aus, ähnlich dem Befehl more.

Implementierung

Die Hilfefunktion ist in einem onlinehelp-Modul implementiert, das bei Bedarf geladen wird.

Es sollten Optionen zum Abrufen von Hilfeinformationen aus anderen Umgebungen als der Kommandozeile über das onlinehelp-Modul vorhanden sein.

onlinehelp.gethelp(object_or_string) -> string

Es sollte auch möglich sein, die Hilfefunktion zu überschreiben, indem onlinehelp.displayhelp(object_or_string) zugewiesen wird.

Das Modul sollte in der Lage sein, Modulinformationen sowohl aus der HTML- als auch aus der LaTeX-Version der Python-Dokumentation zu extrahieren. Links sollten in einer "lynx-ähnlichen" Weise gehandhabt werden.

Im Laufe der Zeit sollte es auch erkennen können, wann Docstrings in "speziellen" Syntaxen wie strukturiertem Text, HTML und LaTeX vorliegen, und sie entsprechend dekodieren.

Eine Prototyp-Implementierung ist mit der Python-Quellcode-Distribution als nondist/sandbox/doctools/onlinehelp.py verfügbar.

Eingebaute Themen

• help( "intro" ) – Was ist Python? Lesen Sie dies zuerst!
• help( "keywords" ) – Was sind die Schlüsselwörter?
• help( "syntax" ) – Wie ist die allgemeine Syntax?
• help( "operators" ) – Welche Operatoren sind verfügbar?
• help( "builtins" ) – Welche Funktionen, Typen usw. sind eingebaut?
• help( "modules" ) – Welche Module sind in der Standardbibliothek enthalten?
• help( "copyright" ) – Wem gehört Python?
• help( "moreinfo" ) – Wo gibt es weitere Informationen?
• help( "changes" ) – Was hat sich in Python 2.0 geändert?
• help( "extensions" ) – Welche Erweiterungen sind installiert?
• help( "faq" ) – Welche Fragen werden häufig gestellt?
• help( "ack" ) – Wer hat in letzter Zeit an Python gearbeitet?

Sicherheitsaspekte

Dieses Modul wird versuchen, Module mit den gleichen Namen wie die angeforderten Themen zu importieren. Verwenden Sie die Module nicht, wenn Sie nicht sicher sind, dass alles in Ihrem PYTHONPATH aus einer vertrauenswürdigen Quelle stammt.