Poetry - je to nástroj pro správu Python balíčků, který vám pomůže vytvářet, instalovat a spravovat závislosti ve vašem projektu. Poskytuje jednoduchý a intuitivní způsob, jak přidat moduly do vašeho projektu.
Chcete-li přidat modul do svého projektu pomocí poetry, musíte nejprve otevřít příkazový řádek a přejít do kořenové složky vašeho projektu. Poté spusťte následující příkaz:
poetry add název_modula
Zde název_modul - to je název modulu, který chcete přidat. Poetry si modul a jeho závislosti nainstaluje sám, pokud existují.
Případně můžete zadat konkrétní verzi modulu přidáním za název modulu:
poetry add název @ verze
Tímto způsobem můžete přidat modul konkrétní verze nebo dokonce určit rozsah verzí modulu.
Po spuštění příkazu poetry nainstaluje zadaný modul a jeho závislosti a automaticky jej přidá do souboru pyproject.toml, který obsahuje informace o vašem projektu a jeho závislostech.
Instalace Poetry
K instalaci Poetry budete muset mít nainstalovaný Python verze 3.7+ a pip. Po napsání příkazu v terminálu bude Poetry připraven k použití.
Následující příkazy lze provést na příkazovém řádku:
$ curl -sSL https://install.python-poetry.org | python -
$ python -m pip install --upgrade pip $ pip install poetry
Po úspěšné instalaci Poetry, můžete zkontrolovat jeho verzi pomocí příkazu:
Pokud máte problémy s instalací, další podrobnosti najdete v oficiální dokumentaci Poetry.
Nyní, když je Poetry nainstalován, jste připraveni jej začít používat ke správě závislostí vašeho projektu Python.
Vytvoření projektu
Chcete-li přidat modul přes Poetry, musíte vytvořit nový projekt. Proces vytváření projektu zahrnuje několik kroků:
- Otevřete terminál nebo příkazový řádek a přejděte do složky, kde chcete vytvořit projekt.
- Zadejte následující příkaz k vytvoření nového projektu:
| poetry nový projekt |
Místo" projekt " zadejte název svého projektu. Poetry vytvoří novou složku se zadaným názvem a inicializuje v ní nový projekt.
Po vytvoření projektu můžete přejít do složky projektu pomocí příkazu cd :
Nyní můžete do svého projektu přidat potřebné moduly pomocí příkazu poetry add . Chcete-li například přidat modul požadavky, spusťte následující příkaz:
| poetry add requests |
Po spuštění tohoto příkazu Poetry stáhne a nainstaluje modul Requests do vašeho projektu.
Nyní můžete začít navrhovat svůj projekt pomocí přidaných modulů.
Přidání závislostí
Chcete-li přidat závislosti do projektu prostřednictvím Poetry, budete muset otevřít soubor pyproject.toml v kořenové složce vašeho projektu. V tomto souboru najdete sekci [tool.poetry.dependencies] , která uvádí závislosti potřebné pro váš projekt.
Chcete-li přidat novou závislost, stačí ji přidat do seznamu závislostí. Syntaxe je: název_závislosti = "verze". Například:
[tool.poetry.dependencies]python = "^3.8"requests = "^2.24"Zde jsme přidali dvě závislosti: python a requests . Hodnota " ^3.8 "znamená, že chceme použít jakoukoli verzi Pythonu od 3.8 a výše a" ^2.24 " znamená, že chceme použít jakoukoli verzi knihovny Requests od 2.24 a výše.
Jakmile přidáte novou závislost , spusťte příkaz poetry install, aby Poetry nastavil všechny závislosti vašeho projektu.
Nyní můžete ve svém projektu použít přidané závislosti a mít jistotu, že budou automaticky nainstalovány při instalaci vašeho projektu na jiný systém.
Import modulu
V Pythonu je pro použití modulu nutné jej importovat. K tomu se používá klíčové slovo import . Chcete-li přidat modul přes poetry, musíte provést následující kroky:
| Krok | Tým | Popis |
|---|---|---|
| 1 | poetry init | Inicializace projektu a vytvoření souboru pyproject.toml |
| 2 | poetry add module-name | Přidání modulu se zadaným názvem do souboru pyproject.toml |
| 3 | from module-name import function-name | Import funkce z modulu |
Po provedení uvedených kroků lze použít funkci z přidaného modulu ve svém kódu. Při práci s poetry se doporučuje používat virtuální prostředí pro projekt .
Přidání modulu do projektu
Chcete-li přidat modul do projektu pomocí Poetry, musíte postupovat podle následujících kroků:
- Otevřete příkazový řádek nebo terminál a přejděte do adresáře projektu.
- Zadejte následující příkaz: poetry add [název modulu] . Zde [název modulu] - toto je název modulu, který chcete přidat.
Poetry pak modul automaticky přidá do souboru pyproject.toml a Stahuje jej pomocí správce balíčků Pip. Váš projekt bude připraven k použití tohoto modulu.
Pokud chcete také přidat modul do seznamu závislostí pro Poetry, spusťte následující příkaz: poetry add [název modulu] .
Po dokončení těchto kroků budete moci ve svém projektu použít přidaný modul.
Aktualizace modulu
Pokud potřebujete aktualizovat nainstalovaný modul, můžete použít příkaz poetry update. Tento příkaz zkontroluje nové verze modulů v zadaném souboru pyproject.toml a aktualizuje je na nejnovější verzi.
Pokud chcete aktualizovat pouze jeden konkrétní modul, můžete použít příkaz poetry update . Například Tým poetry update requests aktualizuje pouze modul requests na nejnovější verzi.
Při aktualizaci modulu může nastat situace, kdy nová verze modulu vyžaduje jinou verzi nějakého jiného modulu. V takovém případě se poetry pokusí nainstalovat potřebnou verzi jiného modulu nebo nabídne možnosti řešení konfliktu závislostí.
Po úspěšné aktualizaci modulu poetry vytvoří nebo aktualizuje soubor poetry.lock s aktuálními verzemi všech nainstalovaných modulů a jejich závislostí.
Odstranění modulu
Chcete-li odebrat modul z projektu, můžete použít příkaz poetry remove . Tento příkaz vám umožňuje odstranit nainstalovaný modul a také odstranit jeho závislosti, pokud je již jiné moduly projektu nepoužívají.
Chcete-li modul odstranit, spusťte na příkazovém řádku následující příkaz:
Pokud například chcete z projektu odstranit modul "requests", spusťte příkaz:
| poetry remove requests |
Po provedení příkazu bude modul a jeho závislosti odstraněny z vašeho projektu. Ujistěte se, že chcete modul skutečně odstranit, protože tuto operaci nelze vrátit zpět.
Použití příkazu poetry remove je spolehlivý způsob, jak odstranit modul a udržet váš projekt čistý a v pořádku.
Kontrola provozu modulu
Po přidání modulu přes poetry je nutné zkontrolovat jeho fungování ve vašem projektu. Chcete-li to provést, můžete postupovat podle následujících kroků:
1. Import modulu:
2. Volání funkcí modulu:
Můžete vyvolat funkce definované ve vašem modulu a zkontrolovat jejich funkčnost.
3. Kontrola vrácených hodnot:
Pokud by funkce modulu měly vrátit hodnoty, ujistěte se, že jsou výsledky vráceny správně.
result = module_name.function_name(argument1, argument2, . ) print(result)
4. Zpracování možných výjimek:
Pokud má váš modul zpracování výjimek, ujistěte se, že fungují správně a vracejí se příslušné chybové zprávy.
5. Testování modulu:
Můžete napsat automatizované testy, abyste zkontrolovali provoz modulu a ujistili se, že všechny funkce fungují podle očekávání.
K testování použijte rámce, jako jsou pytest nebo unittest vytvořit a spustit testy pro váš modul.
6. Dokumentace modulu:
Důležité je také ověřit, že modul má potřebnou dokumentaci. Dokumentujte funkce a třídy vašeho modulu, aby bylo pro ostatní vývojáře snazší porozumět jeho funkcím a používat je.
Kontrola provozu modulu vám pomůže zajistit, aby všechny funkce fungovaly správně, a upozornit na možné chyby před odesláním kódu do produkce nebo jeho zveřejněním.