Python 3 - Lernen und professionell anwenden

325

11.4

Programmierstil: Verwendung und Dokumentation von Modulen

Abb. 11.2: Verzeichnis mit der Quelltextdatei (Python File) des Moduls geld

und einem Verzeichnis

__pycache__ für kompilierte Module

11.4 Programmierstil: Verwendung und Dokumentation

von Modulen

Speichern Sie Klassen in Modulen ab. Die Verwendung von Modulen hat folgende Vorteile:

쐽 Ein komplexes Programm wird auf mehrere Dateien verteilt. Es entstehen kleine über-

schaubare Einheiten, die individuell getestet werden können.

쐽 Eine Klasse, die in einem Modul definiert ist, kann von unterschiedlichen Skripten ver-

wendet werden.

쐽 Python-Skripte, die Module verwenden, können vom Interpreter schneller geladen wer-

den, weil (nach dem ersten Start) die Module bereits in kompilierter Form vorliegen.

Das Modul beginnt mit einem Dokumentationsstring (langer String mit dreifachen Anfüh-

rungszeichen) folgenden Aufbaus:

쐽 Die erste Zeile enthält eine Kurzbeschreibung des Aufgabenfeldes des Moduls

쐽 Es folgt eine Leerzeile.

쐽 Die enthaltenen Klassen werden aufgelistet und kurz erläutert.

Beispiel:

""" Klassen zur Modellierung von Geld

Geld -- modelliert Geld-Objekte mit Betrag und Währung

Konto -- modelliert Bankkonten

"""