Jak vytvářet balíčky Python [2023]

Obsah

Podle průzkumu Stackoverflow z roku 2023 se Python řadí na třetí příčku v popularitě programovacích jazyků. Jeho všestrannost umožňuje uplatnění v datové vědě, webovém vývoji, strojovém učení, softwarovém inženýrství i vědeckých výpočtech.

Během studia a práce s Pythonem se setkáte s termínem „balíček“. Co přesně balíčky v Pythonu znamenají a jak je lze vytvářet?

Tento článek se zaměří na následující témata:

Definice balíčků v Pythonu.
Objasnění významu balíčků v programování s Pythonem.
Praktický návod k vytváření vlastních balíčků.
Ukázka, jak balíčky používat a testovat.
Postup pro nahrávání balíčků online.

Co jsou to Python balíčky?

Balíčky představují klíčový prvek v programování Pythonu. Bez nich by vývojáři museli psát veškerý kód od začátku, což by proces programování značně zkomplikovalo a prodloužilo. Balíčky jsou v podstatě sady modulů, tedy kolekce kódu určeného k opakovanému použití.

Modul v Pythonu je soubor obsahující kód napsaný v Pythonu, který lze importovat do jiných programů. K vytvoření balíčku musíte uložit kód do adresáře, který obsahuje soubor s názvem `__init__.py`.

Balíčky v Pythonu mohou obsahovat další (vnořené) balíčky. Existují tisíce balíčků, které jsou dostupné online, některé oficiální, jiné ne. Většinu balíčků pro Python najdete na adrese https://pypi.org/.

Příkladem balíčku, který lze použít pro tvorbu webových aplikací, je Django, webový framework pro Python. V oblasti strojového učení se často využívají balíčky jako Scikit-learn, PyTorch nebo TensorFlow.

Význam Python balíčků

Proč by programátoři neměli vytvářet veškerý kód od nuly? Proč jsou balíčky důležité? Zde je několik důvodů:

Úspora času: Balíčky poskytují přístup k již napsanému kódu, který řeší běžné problémy. Místo abyste při každém psaní skriptu Python znovu vymýšleli kolo, můžete použít existující balíčky.
Snadná distribuce kódu: Spolupráce je v programování běžná. Můžete vytvořit balíček, který členové týmu mohou jednoduše importovat při společné práci na projektu.
Opakované využití kódu: Pokud se ve vašich programech opakuje určitý blok kódu, můžete jej zabalit a importovat do různých aplikací.
Organizace kódu: Balíčky umožňují organizovat kód do logických modulů, což zlepšuje čitelnost a usnadňuje údržbu.

Jak vytvořit svůj první Python balíček

Jak již bylo zmíněno, Python je univerzální jazyk, a jako programátor můžete vytvářet různé typy balíčků.

Můžete například vytvořit balíček, který automatizuje určité úlohy, pomáhá se správou rozpočtu nebo dokonce usnadňuje učení nového jazyka. Než se však pustíte do vytváření svého prvního balíčku, ujistěte se, že máte následující:

Předpoklady:

Python je nainstalován na vašem počítači. Pokud používáte Linux, Python je obvykle předinstalovaný. Verzi Pythonu můžete ověřit příkazem `python –version` nebo `python3 –version`. Pokud je Python nainstalován, zobrazí se v terminálu verze:

Pokud Python nemáte, stáhněte si jej z https://www.python.org/downloads/.

Znalost jazyka Python. Musíte ovládat psaní tříd, modulů a funkcí.
Správce balíčků. Pro demonstraci použijeme `pip`. Instalaci pip můžete zkontrolovat příkazem:

pip --version

Pokud je pip nainstalovaný, zobrazí se v terminálu podobný výstup.

Požadavky se mohou lišit v závislosti na typu balíčku, který chcete vytvořit.

Pro ukázku vytvořím jednoduchý balíček, který zkontroluje, zda je číslo prvočíslo. Postupujte následovně:

Krok 1: Vytvořte složku projektu. Já ji pojmenuji `Primechecker`.
Krok 2: Vytvořte v této složce další složku a pojmenujte ji `prime`.
Krok 3: Vytvořte uvnitř složky `prime` soubor `prime.py`. Všechny tři kroky můžete provést jedním příkazem:

 mkdir primechecker && cd primechecker && mkdir prime && cd prime && touch prime.py

Krok 4: Otevřete projekt v editoru kódu. Do souboru `prime.py` přidejte tento kód, který kontroluje, zda je číslo prvočíslo:

def is_prime(number):
    if number < 2:
        return False
    for i in range(2, int(number ** 0.5) + 1):
        if number % i == 0:
            return False
    return True

Krok 5: Vytvořte v adresáři `prime` nový soubor a pojmenujte jej `__init__.py`. Tento soubor dává Pythonu najevo, že se jedná o balíček.

Můžete použít tento příkaz:

touch prime/__init__.py

Krok 6: Otestujte kód. Vytvoříme skript `test.py` v kořenové složce, který otestuje, zda je zadané číslo prvočíslo. Vraťte se do hlavní složky a použijte tento příkaz:

touch test.py

Do tohoto souboru přidejte následující kód:

from prime.prime import is_prime

number = int(input("Zadejte číslo: "))

result = is_prime(number)

print(f"{number} je prvočíslo: {result}")

Pro spuštění testu použijte příkaz:

python3 test.py

Nyní můžete zadat číslo a ověřit, zda se jedná o prvočíslo.

Například jsem ověřil čísla 5 a 1 a dostal jsem následující výstup:

Jak nahrát balíček online

Váš vytvořený balíček můžete nahrát na PyPI (Python Package Index). Jedná se o centrální úložiště, kde jsou uloženy tisíce balíčků pro Python. Přejděte na https://pypi.org/ a vytvořte si účet, pokud jej ještě nemáte.

Pro nahrání balíčku postupujte podle těchto kroků:

Krok 1: Vytvořte nový soubor v kořenové složce (u mě `primechecker`) a pojmenujte jej `setup.py`.
Krok 2: Upravte obsah souboru `setup.py` tak, aby obsahoval informace o balíčku, který chcete nahrát.

Kód pro tento soubor by měl vypadat nějak takto:

from setuptools import setup, find_packages

setup(
    name="primechecker",
    version='1.0.0',
    author="Vaše Jméno",
    author_email="[email protected]",
    description='Balíček pro kontrolu prvočísel',
    packages=find_packages(),
)

Změňte název, autora, e-mail autora a popis tak, aby odpovídaly detailům vašeho balíčku.

Krok 3: Sestavte balíček. V kořenové složce spusťte tento příkaz:

python3 setup.py sdist bdist_wheel

Pokud zkontrolujete složku projektu, uvidíte v kořenové složce dvě nové složky (`build` a `dist`).

Krok 4: Nainstalujte `twine`. Jedná se o balíček potřebný pro nahrávání balíčků na PyPI.

Použijte tento příkaz:

pip install twine

Krok 5: Nahrajte balíček.

Použijte tento příkaz:

twine upload dist/*

Budete vyzváni k zadání uživatelského jména a hesla. Pokud název vašeho balíčku ještě není obsazen, bude balíček publikován online a v terminálu se zobrazí odkaz.

Balíček, který jste právě zveřejnili, bude k dispozici veřejnosti. Každý, kdo jej bude chtít použít, si ho může stáhnout pomocí pip.

Například balíček, který jsem zveřejnil, si můžete stáhnout pomocí příkazu:

pip install primechecker==1.0.0.

Nejlepší postupy pro vytváření Python balíčků

Dodržujte standardy balíčků Pythonu: I když máte volnost při rozhodování o typu balíčku, který vytvoříte, vždy mějte na paměti, že existují standardy, které byste měli dodržovat. Před začátkem programování si prohlédněte tyto standardy na https://packaging.python.org/.
Otestujte balíček před nasazením: V programování se chyby běžně vyskytují. Vytvořte skripty pro automatické testy, zejména při sestavování rozsáhlejších balíčků. Tím zajistíte, že nahráváte balíčky bez chyb.
Verzování: Správný balíček by měl dodržovat sémantické verzování. Balíček, který jsme vytvořili v ukázce, měl označení `1.0.0`. První číslice (1) je hlavní verze, druhá číslice (0) je vedlejší verze a poslední číslice je oprava (patch).
Uveďte všechny závislosti: V závislosti na potřebách může balíček vyžadovat další balíčky jako závislosti. Během nahrávání byste měli všechny závislosti uvést v popisu balíčku. Pro správu závislostí můžete použít nástroje jako `setuptools` nebo `poetry`.
Používejte systém správy verzí: Programování je neustálý proces. Balíček můžete neustále aktualizovat a vylepšovat, přidávat nové funkce a optimalizovat. Můžete také pozvat další vývojáře ke spolupráci. Kód balíčku můžete nahrát na platformy jako GitHub nebo GitLab, abyste jej zpřístupnili a umožnili spolupráci.
Dokumentujte kód: Balíček, který jsme vytvořili, sloužil pro demonstraci. Pokud však plánujete balíček sdílet s veřejností nebo členy týmu, je nutné vygenerovat dokumentaci pro uživatele. K tomu můžete použít nástroje jako Pydoc nebo Sphinx.

Kde jinde mohu nahrát Python balíčky?

I když je Python Package Index (PyPI) oficiálním úložištěm balíčků, nemusíte se omezovat pouze na něj. Při rozhodování o tom, kam balíček nahrát, je třeba zvážit velikost souborů, povahu balíčku, úroveň potřebné podpory a cílové publikum.

Zde jsou další platformy, kde můžete sdílet balíčky Python:

GitHub: GitHub je největší platforma pro hostování kódu. Můžete vytvořit repozitář a přidat balíček jako ZIP soubor pro distribuci.
Conda: Conda je správce balíčků, který se často využívá v datové vědě. Vytvořte si účet na Conda a začněte nahrávat své balíčky.
PyPI Mirrors: Existuje mnoho zrcadel platformy PyPI. Vyberte si zrcadlo, které nejlépe vyhovuje vašim požadavkům.

Závěr

Nyní znáte postup pro vytváření balíčků v Pythonu a jejich publikování online. Náš příklad byl jednoduchý, ale můžete experimentovat a vytvářet složitější balíčky. Při tvorbě balíčků dbejte na správnou strukturu složek.