9    Informationsquellen zu Python 

Mit diesem Buch verfolgen wir das Ziel, Ihnen einen umfassenden Einstieg in die Programmierung mit Python zu ermöglichen. Leider ist der Umfang dieses Buchs begrenzt, sodass wir an einigen Stellen auf Details verzichten und Sie stattdessen auf weiterführende Dokumentation verweisen müssen. Im Programmieralltag sind es manchmal gerade diese Details, die den Unterschied machen.

In diesem Kapitel zeigen wir Ihnen verschiedene Informationsquellen zu Python, die Sie nutzen können. Diese Informationsquellen sind ausnahmslos in englischer Sprache verfügbar.

 

9.1    Die Built-in Function help 

Sie können die eingebaute Funktion help aufrufen, um die interaktive Hilfefunktion des Python-Interpreters zu starten. Mit help() wird ein Einleitungstext ausgegeben, gefolgt von einem Eingabeprompt. In dieser interaktiven Hilfe können Sie Begriffe nachschlagen.

Mögliche Begriffe sind Schlüsselworte (z. B. »for«), Symbole (z. B. »+«), Module (z. B. »pprint«) oder Themen (z. B. »DEBUGGING«). Eine Liste der möglichen Suchbegriffe in den jeweiligen Kategorien lässt sich über die Befehle keywords, symbols, modules und topics anzeigen.

Wenn zu einem eingegebenen Begriff eine Hilfeseite gefunden wurde, wird diese in einem Lesemodus angezeigt. Längere Texte können gescrollt werden. Das funktioniert unter Linux mit den (ì)- und (ë)-Tasten und unter Windows über die Leertaste-Taste. Über die Taste (Q) gelangen Sie vom Lesemodus zurück in die interaktive Hilfe. Die interaktive Hilfe können Sie über den Befehl quit oder über die Tastenkombination (Strg) + (D) beenden.

Pythons interaktive Hilfe eignet sich besonders, um schnell Antworten auf Fragen zu Schnittstellen zu finden, beispielsweise »Welche Funktionen waren noch mal im Modul copy enthalten?« oder »Welchen Standardwert hatte noch mal der Parameter indent der Funktion pprint.pprint?«.

Anstatt die interaktive Shell der Hilfefunktion zu starten, kann der Funktion help auch eine Instanz, beispielsweise ein Modul oder eine Funktion, übergeben werden. Dann wird die zugehörige Hilfeseite im Lesemodus angezeigt:

>>> import pprint
>>> help(pprint.pprint)
Help on function pprint in module pprint:

pprint(object, stream=None, indent=1, width=80, depth=None, *, compact=False)
    Pretty-print a Python object to a stream [default is sys.stdout].

Alternativ kann ein String übergeben werden, der den Suchbegriff enthält:

>>> import copy
>>> help("copy.copy")
Help on function copy in copy:

copy.copy = copy(x)
    Shallow copy operation on arbitrary Python objects.
    
    See the module's __doc__ string for more info.