Poetry - es ist ein Python-Paketverwaltungstool, mit dem Sie Abhängigkeiten in Ihrem Projekt erstellen, installieren und verwalten können. Es bietet eine einfache und intuitive Möglichkeit, Ihrem Projekt Module hinzuzufügen.
Um ein Modul mit poetry zu Ihrem Projekt hinzuzufügen, müssen Sie zuerst die Eingabeaufforderung öffnen und zum Stammordner Ihres Projekts navigieren. Führen Sie dann den folgenden Befehl aus:
poetry add Modulname
Hier modulname - dies ist der Name des Moduls, das Sie hinzufügen möchten. Poetry wird das Modul und seine Abhängigkeiten selbst installieren, falls vorhanden.
Alternativ können Sie eine bestimmte Version des Moduls angeben, indem Sie sie nach dem Modulnamen hinzufügen:
poetry add Modulname@Version
Auf diese Weise können Sie ein Modul einer bestimmten Version hinzufügen oder sogar einen Bereich von Modulversionen angeben.
Nachdem der Befehl ausgeführt wurde, installiert poetry das angegebene Modul und seine Abhängigkeiten und fügt es automatisch zur pyproject-Datei hinzu.toml, das Informationen zu Ihrem Projekt und seinen Abhängigkeiten enthält.
Installieren von Poetry
Um Poetry zu installieren, müssen Sie Python Version 3.7+ und pip installiert haben. Nachdem Sie den Befehl im Terminal geschrieben haben, ist Poetry einsatzbereit.
Sie können die folgenden Befehle an der Eingabeaufforderung ausführen:
$ curl -sSL https://install.python-poetry.org | python -
$ python -m pip install --upgrade pip $ pip install poetry
Nachdem Poetry erfolgreich installiert wurde, können Sie die Version von Poetry mit dem Befehl überprüfen:
Wenn Sie Probleme mit der Installation haben, finden Sie weitere Informationen in der offiziellen Poetry-Dokumentation.
Jetzt, da Poetry installiert ist, können Sie damit beginnen, die Abhängigkeiten Ihres Python-Projekts zu verwalten.
Erstellen eines Projekts
Um ein Modul über Poetry hinzuzufügen, müssen Sie ein neues Projekt erstellen. Der Prozess zum Erstellen eines Projekts umfasst mehrere Schritte:
- Öffnen Sie ein Terminal oder eine Eingabeaufforderung und navigieren Sie zu dem Ordner, in dem Sie das Projekt erstellen möchten.
- Geben Sie den folgenden Befehl ein, um ein neues Projekt zu erstellen:
| poetry new Projekt |
Geben Sie anstelle von "Projekt" einen Namen für Ihr Projekt ein. Poetry erstellt einen neuen Ordner mit dem angegebenen Namen und initialisiert darin ein neues Projekt.
Nachdem Sie das Projekt erstellt haben, können Sie mit dem Befehl cd zum Projektordner navigieren :
Jetzt können Sie Ihrem Projekt die erforderlichen Module hinzufügen, indem Sie den Befehl poetry add verwenden. Führen Sie beispielsweise den folgenden Befehl aus, um das Requests-Modul hinzuzufügen:
| poetry add requests |
Nachdem Sie diesen Befehl ausgeführt haben, lädt Poetry das Requests-Modul in Ihr Projekt herunter und installiert es.
Jetzt können Sie mit der Entwicklung Ihres Projekts beginnen, indem Sie die hinzugefügten Module verwenden.
Hinzufügen von Abhängigkeiten
Um dem Projekt über Poetry Abhängigkeiten hinzuzufügen, müssen Sie die pyproject-Datei öffnen.toml im Stammordner Ihres Projekts. In dieser Datei finden Sie einen Abschnitt [tool.poetry.dependencies] , die die für Ihr Projekt erforderlichen Abhängigkeiten auflistet.
Um eine neue Abhängigkeit hinzuzufügen, müssen Sie sie einfach zur Abhängigkeitsliste hinzufügen. Die Syntax lautet: Abhängigkeitsname = "Version" . Zum Beispiel:
[tool.poetry.dependencies]python = "^3.8"requests = "^2.24"
Hier haben wir zwei Abhängigkeiten hinzugefügt: Python und requests . Der Wert "^3.8" bedeutet, dass wir eine beliebige Version von Python ab 3.8 verwenden möchten, und "^2.24" bedeutet, dass wir eine beliebige Version der Requests-Bibliothek ab 2.24 verwenden möchten.
Nachdem Sie eine neue Abhängigkeit hinzugefügt haben, führen Sie den Befehl poetry install aus, damit Poetry alle Abhängigkeiten Ihres Projekts installiert.
Jetzt können Sie die hinzugefügten Abhängigkeiten in Ihrem Projekt verwenden und haben die Gewissheit, dass sie automatisch installiert werden, wenn Sie Ihr Projekt auf einem anderen System installieren.
Modul importieren
Sie müssen es in Python importieren, um ein Modul verwenden zu können. Dazu wird das Schlüsselwort import verwendet. Gehen Sie folgendermaßen vor, um ein Modul über Poetry hinzuzufügen:
| Schritt | Das Team | Die Beschreibung |
|---|---|---|
| 1 | poetry init | Initialisieren Sie das Projekt und erstellen Sie eine pyproject-Datei.toml |
| 2 | poetry add module-name | Fügt der pyproject-Datei ein Modul mit dem angegebenen Namen hinzu.toml |
| 3 | from module-name import function-name | Importieren einer Funktion aus einem Modul |
Nachdem Sie diese Schritte ausgeführt haben, können Sie die Funktion aus dem hinzugefügten Modul in Ihrem Code verwenden. Es wird empfohlen, die virtuelle Umgebung für das Projekt zu verwenden, wenn Sie mit poetry arbeiten.
Hinzufügen eines Moduls zu einem Projekt
Um ein Modul mithilfe von Poetry zu einem Projekt hinzuzufügen, führen Sie die folgenden Schritte aus:
- Öffnen Sie eine Eingabeaufforderung oder ein Terminal und navigieren Sie zu Ihrem Projektverzeichnis.
- Geben Sie den folgenden Befehl ein: poetry add [name des Moduls] . Hier [name des Moduls] - dies ist der Name des Moduls, das Sie hinzufügen möchten.
Poetry fügt das Modul dann automatisch zur pyproject-Datei hinzu.toml und lädt es mit dem pip-Paketmanager herunter. Ihr Projekt ist bereit, dieses Modul zu verwenden.
Wenn Sie das Modul auch der Abhängigkeitsliste für Poetry hinzufügen möchten, führen Sie den folgenden Befehl aus: poetry add [name des Moduls] .
Nachdem Sie diese Schritte ausgeführt haben, können Sie das hinzugefügte Modul in Ihrem Projekt verwenden.
Modul aktualisieren
Wenn Sie ein installiertes Modul aktualisieren möchten, können Sie den Befehl verwenden poetry update. Dieser Befehl prüft, ob neue Versionen der Module in der angegebenen Datei vorhanden sind pyproject.toml und wird sie auf die neueste Version aktualisieren.
Wenn Sie nur ein bestimmtes Modul aktualisieren möchten, können Sie den Befehl verwenden poetry update . Zum Beispiel der Befehl poetry update requests aktualisiert nur das requests-Modul auf die neueste Version.
Wenn Sie ein Modul aktualisieren, kann es zu Situationen kommen, in denen eine neue Version eines Moduls eine andere Version eines anderen Moduls erfordert. In diesem Fall versucht poetry, die erforderliche Version eines anderen Moduls zu installieren oder bietet Optionen zur Lösung des Abhängigkeitskonflikts an.
Nachdem das Modul erfolgreich aktualisiert wurde, erstellt oder aktualisiert poetry die Datei poetry.lock mit aktuellen Versionen aller installierten Module und ihrer Abhängigkeiten.
Entfernen eines Moduls
Um ein Modul aus dem Projekt zu entfernen, können Sie den Befehl poetry remove verwenden. Mit diesem Befehl können Sie ein installiertes Modul entfernen und seine Abhängigkeiten entfernen, wenn sie von anderen Projektmodulen nicht mehr verwendet werden.
Führen Sie den folgenden Befehl an einer Eingabeaufforderung aus, um ein Modul zu entfernen:
Wenn Sie beispielsweise das Modul "requests" aus Ihrem Projekt entfernen möchten, führen Sie den Befehl aus:
| poetry remove requests |
Nach dem Ausführen des Befehls werden das Modul und seine Abhängigkeiten aus Ihrem Projekt entfernt. Stellen Sie sicher, dass Sie das Modul wirklich löschen möchten, da dieser Vorgang nicht rückgängig gemacht werden kann.
Die Verwendung des Befehls poetry remove ist eine zuverlässige Möglichkeit, ein Modul zu entfernen und die Sauberkeit und Ordnung in Ihrem Projekt aufrechtzuerhalten.
Überprüfen der Funktion des Moduls
Nachdem Sie ein Modul über poetry hinzugefügt haben, müssen Sie überprüfen, ob es in Ihrem Projekt funktioniert. Dazu können Sie die folgenden Schritte ausführen:
1. Modul importieren:
2. Aufrufen von Modulfunktionen:
Sie können die in Ihrem Modul definierten Funktionen aufrufen und ihre Funktionsfähigkeit überprüfen.
3. Überprüfen der Rückgabewerte:
Wenn die Modulfunktionen Werte zurückgeben müssen, stellen Sie sicher, dass die zurückgegebenen Ergebnisse korrekt sind.
result = module_name.function_name(argument1, argument2, . ) print(result)
4. Behandeln möglicher Ausnahmen:
Wenn Ihr Modul Ausnahmen behandelt, stellen Sie sicher, dass sie korrekt ausgelöst werden und die entsprechenden Fehlermeldungen zurückgegeben werden.
5. Testen des Moduls:
Sie können automatisierte Tests schreiben, um die Funktion des Moduls zu überprüfen und sicherzustellen, dass alle Funktionen wie erwartet funktionieren.
Verwenden Sie Frameworks zum Testen wie pytest oder unittest, um Tests für Ihr Modul zu erstellen und auszuführen.
6. Modul-Dokumentation:
Es ist auch wichtig zu überprüfen, ob das Modul über die erforderliche Dokumentation verfügt. Dokumentieren Sie die Funktionen und Klassen Ihres Moduls, damit es für andere Entwickler einfacher ist, seine Funktionalität zu verstehen und zu verwenden.
Wenn Sie das Modul überprüfen, können Sie sicherstellen, dass alle Funktionen ordnungsgemäß funktionieren, und mögliche Fehler warnen, bevor Sie den Code an die Produktion senden oder veröffentlichen.