Programátorská práce nespočívá jen v tom, program napsat. Důležité je si i ověřit, že opravdu funguje, a případně ho pak opravit. Ověřování, že program funguje, se říká testování (angl. testing).
Zatím jsi asi svoje programy testoval/a tak, že jsi je zkusil/a spustit, něco zadal/a a podíval/a se, jestli jsou výsledky v pořádku. U větších programů, které budou mít více a více možností, ale bude těžší a těžší takhle zkontrolovat, jestli všechny ty možnosti fungují, jak mají.
Proto si programátoři často nezkouší programy „ručně“. Píšou jiné programy, které jejich výtvory testují za ně.
Automatické testy jsou funkce, které zkontrolují, že program funguje správně. Spuštěním testů můžeš kdykoli ověřit, že kód funguje. Když v otestovaném kódu v budoucnu uděláš nějakou změnu, testy ověří, že jsi nerozbil/a nic, co dříve fungovalo.
Zatím jsme v kurzu pracovali/y s tím, co se instaluje
se samotným Pythonem – s moduly jako math a turtle.
Kromě takových modulů ale existuje ale velká spousta
dalších knihoven, které nejsou přímo v Pythonu, ale dají se doinstalovat
a používat.
Na testy je v samotném Pythonu zabudovaná knihovna unittest.
Ta je ale celkem složitá na použití, proto ji my používat nebudeme.
Nainstalujeme si knihovnu pytest, která se používá
mnohem jednodušeji a je velice populární.
Knihovny se instalují do aktivního virtuálního prostředí.
Jak se dělá a spouští virtuální prostředí
ses naučil/a při instalaci Pythonu,
ale teprve teď to začíná být opravdu důležité.
Ujisti se, že máš virtuální prostředí aktivované – na začátku příkazové řádky
máš (venv).
Potom zadej následující příkaz.
(Je to příkaz příkazové řádky, podobně jako
cd nebo mkdir; nezadávej ho do Pythonu.)
Opisuj opatrně!
Příkaz níže instaluje software z internetu.
Nahrát takovou knihovnu na internet může kdokoli – hodný nebo zlý,
chytrý nebo hloupý.
Za knihovnu pytest autoři tohoto kurzu ručí.
Jiné knihovny ale můžou dělat neplechu nebo být dokonce „zavirované“;
už při instalaci můžou něco pokazit.
Dej si proto pozor a ve jménu pytest neudělej překlep!
Nainstaluješ-li přesto omylem něco cos nechtěl/a, dej co nejdřív vědět zkušenějšímu programátorovi, aby zkontroloval jaký to mohlo mít efekt.
(venv)$ python -m pip install pytest
Co ten příkaz znamená?
python -m pip zavolá Python s tím, že má pustit modul
pip. Tento modul umí instalovat nebo
odinstalovávat knihovny.
(Jestli si pamatuješ vytváření virtuálního prostředí, použil/a jsi tam
příkaz python -m venv – modul venv umí vytvářet virtuální prostředí.)
No a slova install pytest říkají Pipu, že má nainstalovat pytest.
Nápověda k použití Pipu se dá vypsat pomocí příkazu
python -m pip --help.
Pro Windows
Jsi-li na Windows, od této lekce začne být důležité
spouštět pythonní programy pomocí python program.py, ne jen
program.py.
Ačkoli se v těchto materiálech všude používá python na začátku, zatím
mohlo všechno fungovat i bez toho.
Program se ale bez příkazu python může spustit v jiném Pythonu,
než v tom z virtuálního prostředí – a tam pytest nebude k dispozici.
Nejdříve si testování ukážeme na jednoduchém příkladu.
Tady je funkce secti, která umí sečíst
dvě čísla, a další funkce, která testuje, jestli se
secti pro určité hodnoty
chová správně.
Kód si opiš do souboru test_secteni.py,
v novém prázdném adresáři.
Pro pytest je (ve výchozím nastavení)
důležité, aby jména jak souborů s testy, tak
samotných testovacích funkcí, začínala na
test_.
def secti(a, b):
"""Vrátí součet dvou čísel"""
return a + b
def test_secti():
"""Otestuje funkci secti"""
assert secti(1, 2) == 3
Co se v té testovací funkci děje?
Příkaz assert vyhodnotí výraz za ním a pokud výsledek není pravdivý,
vyvolá výjimku, která způsobí, že test selže.
Můžeš si představit, že assert a == b dělá následující:
if not (a == b):
raise AssertionError('Test selhal!')
Zatím assert nepoužívej jinde než v testovacích funkcích.
V „normálním” kódu se assert může chovat trochu jinak než výše,
ale do toho teď nebudeme zabředávat.
Testy se spouští zadáním příkazu
python -m pytest -v následovaným názvem souboru s testy.
Tedy v překladu: Pythone, pusť
modul pytest,
v „ukecaném” režimu (angl. verbose) a se zadaným souborem.
$ python -m pytest -v test_secteni.py
============================= test session starts ==============================
platform linux -- Python 3.7.1, pytest-3.6.4, py-1.5.4, pluggy-0.6.0 -- venv/bin/python
cachedir: .pytest_cache
rootdir: naucse, inifile:
collecting ... collected 1 item
test_secteni.py::test_secti PASSED [100%]
=========================== 1 passed in 0.00 seconds ===========================
Tento příkaz projde zadaný soubor, zavolá v něm všechny funkce,
jejichž jméno začíná na test_, a ověří, že nevyvolají žádnou
výjimku – typicky výjimku z příkazu assert.
Pokud výjimka nastane, dá to pytest velice červeně
najevo a přidá několik informací, které můžou
usnadnit nalezení a opravu chyby.
Argument s názvem souboru můžeš vynechat: python -m pytest -v.
V takovém případě pytest projde aktuální adresář a spustí testy
ze všech souborů, jejichž jméno začíná na test_. Místo souboru
lze též uvést adresář: pytest vyhledá testy v něm.
Zkus si změnit funkci secti (nebo její test) a podívat se,
jak to vypadá když test „neprojde“.
Testy se většinou nepíšou přímo ke kódu, ale do souboru vedle. Je to tak přehlednější a taky to pak zjednodušuje distribuci – předání kódu někomu, kdo ho chce jen spustit a testy nepotřebuje.
Rozděl soubor s testem sečítání: funkci secti přesuň do modulu secteni.py,
a v test_secteni.py nech jenom test.
Do test_secteni.py pak na začátek přidej from secteni import secti,
aby byla funkce testu k dispozici.
Test by měl opět projít.