Module

Module werden in Python verwendet, um größere Projekte zu organisieren. Die Python-Standardbibliothek ist in Module aufgeteilt, um sie überschaubarer zu machen. Ihr müsst euren eigenen Code zwar nicht in Modulen organisieren, aber wenn ihr umfangreichere Programme schreibt, oder Code, den ihr wiederverwenden möchten, solltet ihr dies tun.

Was ist ein Modul?

Ein Modul ist eine Datei, die Code enthält. Sie definiert eine Gruppe von Python-Funktionen oder anderen Objekten, und der Name des Moduls wird vom Namen der Datei abgeleitet. Module enthalten meist Python-Quellcode, können aber auch kompilierte C- oder C++-Objektdateien sein. Kompilierte Module und Python-Source-Module werden auf die gleiche Weise verwendet.

Module fassen nicht nur verwandte Python-Objekte zusammen, sondern helfen auch, Namenskonflikte zu vermeiden. Do könnt ihr für euer Programm ein Modul namens mymodule schreiben, das eine Funktion namens my_func definiert. Im selben Programm möchtet ihr vielleicht auch ein anderes Modul namens othermodule verwenden, das ebenfalls eine Funktion namens my_func definiert, aber etwas anderes tut als eure my_func-Funktion. Ohne Module wäre es unmöglich, zwei verschiedene Funktionen mit demelben Namen zu verwenden. Mit Modulen könnt ihr in eurem Hauptprogramm auf die Funktionen mymodule.my_func und othermodule.my_func verweisen. Die Verwendung der Modulnamen sorgt dafür, dass die beiden my_func-Funktionen nicht verwechselt werden, da Python sog. Namespaces verwendet. Ein Namespace ist im Wesentlichen ein Wörterbuch mit Bezeichnungen für die dort zur Verfügung stehenden Funktionen, Klassen, Module usw..

Module werden auch verwendet, um Python selbst überschaubarer zu machen. Die meisten Standardfunktionen von Python sind nicht in den Kern der Sprache integriert, sondern werden über spezielle Module bereitgestellt, die ihr bei Bedarf laden könnt.

Erstellen von Modulen

Vermutlich der beste Weg, um etwas über Module zu lernen, ist das Erstellen eines eigenen Moduls. Hierzu erstellen wir eine Textdatei mit dem Namen wc.py, und geben in diese Textdatei den unten stehenden Python-Code ein. Wenn ihr IDLE verwendet, wählt File ‣ New Window und beginnt mit der Eingabe.

Es ist einfach, eigene Module zu erstellen, die auf die gleiche Weise importiert und verwendet werden können wie die in Python eingebauten Bibliotheksmodule. Das folgende Beispiel ist ein einfaches Modul mit einer Funktion, die zur Eingabe eines Dateinamens auffordert und die Anzahl der in dieser Datei vorkommenden Wörter ermittelt.

 1"""wc module. Contains function: words_occur()"""
 2def words_occur():
 3    """words_occur() - count the occurrences of words in a file."""
 4    # Prompt user for the name of the file to use.
 5    file_name = input("Enter the name of the file: ")
 6    # Open the file, read it and store its words in a list.
 7    f = open(file_name, 'r')
 8    word_list = f.read().split()
 9    f.close()
10    # Count the number of occurrences of each word in the file.
11    occurs_dict = {}
12    for word in word_list:
13        # increment the occurrences count for this word
14        occurs_dict[word] = occurs_dict.get(word, 0) + 1
15    # Print out the results.
16    print(f"File {file_name} has {len(word_list)} words, "\
17          f"{len(occurs_dict)} are unique:")
18    print(occurs_dict)
19if __name__ == '__main__':
20    words_occur()
Zeilen 1 und 3

Docstrings sind Standardmethoden zur Dokumentation von Modulen, Funktionen, Methoden und Klassen.

Zeile 8

read gibt eine Zeichenkette zurück, die alle Zeichen in einer Datei enthält, und split gibt eine Liste der Wörter einer Zeichenkette zurück, die anhand von Leerzeichen aufgespalten wurde.

Zeile 16

Ihr könnt einen \ verwenden, um eine lange Anweisung über mehrere Zeilen zu verteilen.

Zeilen 19 bis 20

Mit dieser if-Anweisung könnt ihr das Programm auf zweierlei Arten nutzen:

  • zum Importieren in der Python-Shell oder einem anderen Python-Skript ist __name__ der Dateiname:

    >>> import wc
    >>> wc.words_occur()
    Enter the name of the file: README.rst
    File README.rst has 332 words (191 are unique)
    {'Schnelleinstieg': 1, ...}
    

    Alternativ könnt ihr auch words_occur direkt importieren:

    >>> from wc import words_occur
    >>> words_occur()
    Enter the name of the file: README.rst
    File README.rst has 332 words (191 are unique)
    {'Schnelleinstieg': 1, ...}
    

    Ihr könnt den interaktiven Modus der Python-Shell oder von IDLE verwenden, um ein Modul während der Erstellung inkrementell zu testen. Wenn ihr jedoch euer Modul auf der Festplatte ändert, wird es durch die erneute Eingabe des Import-Befehls nicht erneut geladen. Zu diesem Zweck müsst ihr die Funktion reload aus dem importlib-Modul verwenden:

    >>> import wc, importlib
    >>> importlib.reload(wc)
    <module 'wc' from '/home/veit/.local/lib/python3.8/site-packages/wc.py'>
    
  • als Skript wird es mit dem Namen __main__ ausgeführt und die Funktion words_occur() aufgerufen:

    $ python3 wc.py
    Enter the name of the file: README.rst
    File README.rst has 332 words (191 are unique)
    {'Schnelleinstieg': 1, ...}
    

Speichert diesen Code zunächst in einem der Verzeichnisse des Modulsuchpfads, die in der Liste von sys.path zu finden ist. Als Dateinamensendung empfiehlt sich .py, da hierdurch die Datei als Python-Quellcode ausgewiesen wird.

Bemerkung

Die Liste von Verzeichnissen, die mit sys.path angezeigt wird, hängt von eurer Systemkonfiguration ab. Diese Liste von Verzeichnissen wird von Python in der Reihenfolge durchsucht, wenn eine Import-Anweisung ausgeführt wird. Das erste gefundene Modul, das die Importanforderung erfüllt, wird verwendet. Wenn es kein zutreffendes Modul in diesem Suchpfad gibt, wird ein ImportError ausgelöst.

Wenn ihr IDLE verwendet, könnt ihr euch den Suchpfad und die darin enthaltenen Module grafisch ansehen, indem ihr das Fenster File ‣ Path Browser verwendet.

Die Variable sys.path wird mit dem Wert der Umgebungsvariablen PYTHONPATH initialisiert, falls diese existiert. Wenn ihr ein Python-Skript ausführt, wird in die sys.path-Variable für dieses Skript das Verzeichnis, in dem sich das Skript befindet, als erstes Element eingefügt, so dass ihr auf bequeme Weise feststellen könnt, wo sich das ausführende Python-Programm befindet.

Befehlszeilenargumente

Wollt ihr in unserem Beispiel den Dateinamen als Befehlszeilenargument übergeben, also mit

$ python3 wc.py README.rst

so könnt ihr dies einfach mit folgender Änderung unseres Scripts:

--- /home/docs/checkouts/readthedocs.org/user_builds/python-basics-tutorial-de/checkouts/latest/docs/modules/wc.py
+++ /home/docs/checkouts/readthedocs.org/user_builds/python-basics-tutorial-de/checkouts/latest/docs/modules/wcargv.py
@@ -1,8 +1,9 @@
 """wc module. Contains function: words_occur()"""
+import sys
 def words_occur():
     """words_occur() - count the occurrences of words in a file."""
     # Prompt user for the name of the file to use.
-    file_name = input("Enter the name of the file: ")
+    file_name = sys.argv.pop()
     # Open the file, read it and store its words in a list.
     f = open(file_name, 'r')
     word_list = f.read().split()
@@ -13,8 +14,8 @@
         # increment the occurrences count for this word
         occurs_dict[word] = occurs_dict.get(word, 0) + 1
     # Print out the results.
-    print(f"File {file_name} has {len(word_list)} words, "\
-          f"{len(occurs_dict)} are unique:")
+    print("File %s has %d words (%d are unique)" \
+      % (file_name, len(word_list), len(occurs_dict)))
     print(occurs_dict)
 if __name__ == '__main__':
     words_occur()
sys.argv

gibt eine Liste der Befehlszeilenargumente zurück, die an ein Python-Skript übergeben wurden. argv[0] ist der Skriptname.

.pop

entfernt das Element an der angegebenen Position in der Liste und gibt es zurück. Wenn kein Index angegeben wird, entfernt .pop() das letzte Element in der Liste und gibt es zurück.

Das argparse-Modul

Ihr könnt ein Skript so konfigurieren, dass es sowohl Kommandozeilenoptionen als auch Argumente akzeptiert. Das argparse-Modul unterstützt beim Parsen verschiedener Argumenttypen und kann sogar Nachrichten erzeugen. Um das argparse-Modul zu verwenden, erstellt eine Instanz von ArgumentParser, füllt sie mit Argumenten und lest dann sowohl die optionalen als auch die Positionsargumente. Das folgende Beispiel veranschaulicht die Verwendung des Moduls:

--- /home/docs/checkouts/readthedocs.org/user_builds/python-basics-tutorial-de/checkouts/latest/docs/modules/wc.py
+++ /home/docs/checkouts/readthedocs.org/user_builds/python-basics-tutorial-de/checkouts/latest/docs/modules/wcargparse.py
@@ -1,8 +1,12 @@
 """wc module. Contains function: words_occur()"""
+from argparse import ArgumentParser
 def words_occur():
     """words_occur() - count the occurrences of words in a file."""
+    parser = ArgumentParser()
     # Prompt user for the name of the file to use.
-    file_name = input("Enter the name of the file: ")
+    parser.add_argument("-f", "--file", dest="filename", help="read data from the file")
+    args = parser.parse_args()
+    file_name = args.filename
     # Open the file, read it and store its words in a list.
     f = open(file_name, 'r')
     word_list = f.read().split()
@@ -13,8 +17,8 @@
         # increment the occurrences count for this word
         occurs_dict[word] = occurs_dict.get(word, 0) + 1
     # Print out the results.
-    print(f"File {file_name} has {len(word_list)} words, "\
-          f"{len(occurs_dict)} are unique:")
+    print("File %s has %d words (%d are unique)" \
+      % (file_name, len(word_list), len(occurs_dict)))
     print(occurs_dict)
 if __name__ == '__main__':
     words_occur()

Dieser Code erzeugt eine Instanz von ArgumentParser und fügt dann das Argument filename hinzu. Das argparse-Modul gibt ein Namespace-Objekt zurück, das die Argumente als Attribute enthält. Ihr könnt die Werte der Argumente mit der Punktnotation abrufen, in unserem Fall mit args.filename.

Ihr könnt das Skript nun aufrufen mit:

$ python3 wcargparse.py -f index.rst

Zudem wird automatisch eine Hilfeoption -h oder --help erzeugt:

$ python3 wcargparse.py -h
usage: wcargparse.py [-h] [-f FILENAME]

optional arguments:
  -h, --help            show this help message and exit
  -f FILENAME, --file FILENAME
                        read data from the file