Debugování
Při vývoji software se často dostaneme do situace, kdy si chceme projít kód krok za krokem a zjistit například to, jaké jsou aktuální hodnoty proměnných, jestli se správně vyhodnocují podmínky atd. Tomuto procesu se česky říká ladění, často se ale setkáte s anglickým výrazem debugging. Obvykle ho provádíme ve chvíli, kdy se program nechová podle očekávání, tedy jsme narazili na chybu (bug).
Možná jste byly zvyklé si na různá místa v programu
pomocí funkce print vypisovat aktuální stav programu.
Zjistíte, že u většího projektu je tento přístup většinou
nedostatečný a že si chcete program projít krok za krokem.
Abychom mohli debugovat, potřebujeme k tomu nástroj zvaný debugger. VSCode spolu s rozšířením pro Python ho má zabudovaný. Ve zbytku této lekce si ukážeme, jak ho používat.
Ovládání debuggeru
Do debuggeru se přepneme kliknutím na tlačítko s přeškrtnutým broukem, které vidíte na obrázku níže.
Zajímají nás především:
- tlačítko pro spuštění debugování (zelený trojúhelník)
- panel s výpisem aktuálních hodnot proměnných - Variables
- panel pro ovládání debuggeru
Panel pro ovládání debuggeru se zobrazí až po spuštění debuggeru. Po spuštění je možné debugger restartovat (spustit od začátku) kliknutím na zelenou šipku ve tvaru kruhu nebo ho zastavit kliknutím na červený čtvereček.
Program se chová stejně, jako by debugger nebyl zaplý.
Např., pokud se podmínka vyhodnotí jako False, tak do jejího těla debugger nevstoupí.
Stejně tak debugger bude procházet cyklem tolikrát, jako za normálního
běhu programu.
Breakpoint
Klíčovou roli při debugování hraje zarážka - angl. breakpoint. Když debuger narazí na zarážku, tak zastaví vykonávání programu a předá kontrolu uživateli. Ten poté může zjistit hodnoty proměnných, pokračovat na další krok nebo třeba vejít do funkce, která se na řádku volá. Breakpoint umístíme kliknutím vlevo od řádku, kde chceme, aby se debugger zastavil:
Pokud klikneme na tlačítko Continue (modrý trojúhelník nebo F5), tak bude debugger pokračovat až do dalšího breakpointu, případně na konec programu.
Step over, into, out
Často budeme chtít pokračovat na další řádek kódu. Docílíme toho pomocí klávesy F10, případně kliknutím na Step over.
Pokud bychom chtěli vstoupit do funkce, která je volaná na aktualním řádku, tak toho docílíme pomocí F11 - Step into.
Pro vystoupení z aktuální funkce se používá Shift + F11. Program pokračuje až do chvíle, než se vrátí do funkce, která volala funkci, ze které jsme chtěli vystoupit.
Debug testů
Často zjistíme, že nám neprocházejí testy. Může se jednat o chybu v testu, nebo o chybu v programu. Ideální je si test prodebugovat, a to například tak, že dáme breakpoint na začátek testu a pak se kombinací Step over / into / out dostaneme na problémové místo programu. Budeme sledovat, jak se vyhodnocují jednotlivé podmínky, jaké argumenty se předávají do funkcí atd. Často se nám tímto způsobem podaří chybu najít.
Pokud máme správně nastavený VSCode, tak by se nad testovacími funkcemi měly objevit možnosti Run Test a Debug Test (jako na obrázku níže).
Jestli ve svém editoru tyto možnosti nemáš, tak zkus:
- zkontrolovat, že máš nastavený interpreter
- v levém dolním rohu VSCode by jsi kromě verze Pythonu
měla vidět jméno virtuálního prostředí (např. Python 3.6 (venv))
- pokud jméno virtuálního prostředí nevidíš, tak stiskni Ctrl + Shift + P, vyber Select Python Interpreter a zvol své virtuální prostředí (pravděpodobně venv)
- v levém dolním rohu VSCode by jsi kromě verze Pythonu
měla vidět jméno virtuálního prostředí (např. Python 3.6 (venv))
- Stisknout Ctrl + Shift + P a vybrat Discover Unit Tests
Po kliknutí na Debug test se spustí debugger.
Debug console
Po spuštění debugeru je možné používat debugovací konzoli. Najdete ji ve spodním panelu v záložce vedle integrovaného terminálu.
Představ si, že jsi spustila Python z příkazové řádky a poté zadala stejný kód, kterým debugger prošel, než se dostal na breakpoint. V tu chvíli tedy máte k dispozici všechny inicializované globální proměnné, můžete volat funkce nebo pracovat s proměnným úplně stejně, jak jsme to dělali v lekcích na začátku kurzu.
Pokud například víte, že na dalším řádku vzniká IndexError, ale nevíte proč,
tak můžete zjistit, na jaký index se přistupuje, jaké hodnoty jsou v
seznamu nebo slovníku obsažené a co by se stalo, kdybyste použily jiný index.
Do debug konzole se také vypisují printy, pokud je v programu používáte.
Jen pozor - pokud upravíte hodnoty proměnných, tak se změny promítnout do zbytku programu, takže je někdy nutné debugger restartovat.
{
"data": {
"sessionMaterial": {
"id": "session-material:2019/brno-jaro-2019-ut:tests:4",
"title": "Debugování",
"html": "\n \n \n\n <h1>Debugování</h1>\n<p>Při vývoji software se často dostaneme do situace,\nkdy si chceme projít kód krok za krokem a zjistit\nnapříklad to, jaké jsou aktuální hodnoty proměnných,\njestli se správně vyhodnocují podmínky atd.\nTomuto procesu se česky říká <em>ladění</em>, často se ale\nsetkáte s anglickým výrazem <em>debugging</em>. Obvykle\nho provádíme ve chvíli, kdy se program nechová\npodle očekávání, tedy jsme narazili na chybu (bug).</p>\n<p>Možná jste byly zvyklé si na různá místa v programu\npomocí funkce <code>print</code> vypisovat aktuální stav programu.\nZjistíte, že u většího projektu je tento přístup většinou\nnedostatečný a že si chcete program projít krok za krokem.</p>\n<p>Abychom mohli debugovat, potřebujeme k tomu nástroj zvaný\n<em>debugger</em>. VSCode spolu s <a href=\"https://marketplace.visualstudio.com/items?itemName=ms-python.python\">rozšířením pro Python</a> ho má zabudovaný.\nVe zbytku této lekce si ukážeme, jak ho používat.</p>\n<h2>Ovládání debuggeru</h2>\n<p>Do debuggeru se přepneme kliknutím na tlačítko s přeškrtnutým broukem,\nkteré vidíte na obrázku níže.</p>\n<p><span class=\"figure\"><a href=\"/2019/brno-jaro-2019-ut/beginners/debug/static/debug.png\"><img src=\"/2019/brno-jaro-2019-ut/beginners/debug/static/debug.png\" alt=\"(Menu debuggeru)\"></a></span></p>\n<p>Zajímají nás především:</p>\n<ul>\n<li>tlačítko pro spuštění debugování (zelený trojúhelník)</li>\n<li>panel s výpisem aktuálních hodnot proměnných - <em>Variables</em></li>\n<li>panel pro ovládání debuggeru</li>\n</ul>\n<p><strong>Panel pro ovládání debuggeru</strong> se zobrazí až po spuštění debuggeru.\nPo spuštění je možné debugger restartovat (spustit od začátku)\nkliknutím na zelenou šipku ve tvaru kruhu\nnebo ho zastavit kliknutím na červený čtvereček.</p>\n<p>Program se chová stejně, jako by debugger nebyl zaplý.\nNapř., pokud se podmínka vyhodnotí jako <code>False</code>, tak do jejího těla debugger nevstoupí.\nStejně tak debugger bude procházet cyklem tolikrát, jako za normálního\nběhu programu.</p>\n<h3>Breakpoint</h3>\n<p>Klíčovou roli při debugování hraje zarážka - angl. <em>breakpoint</em>.\nKdyž debuger narazí na zarážku, tak zastaví vykonávání programu\na předá kontrolu uživateli. Ten poté může zjistit hodnoty proměnných,\npokračovat na další krok nebo třeba vejít do funkce, která se na řádku volá.\nBreakpoint umístíme kliknutím vlevo od řádku, kde chceme, aby se debugger zastavil:</p>\n<p><span class=\"figure\"><a href=\"/2019/brno-jaro-2019-ut/beginners/debug/static/breakpoint.png\"><img src=\"/2019/brno-jaro-2019-ut/beginners/debug/static/breakpoint.png\" alt=\"(Umístění breakpointu)\"></a></span></p>\n<p>Pokud klikneme na tlačítko <em>Continue</em> (modrý trojúhelník nebo <kbd>F5</kbd>),\ntak bude debugger pokračovat až do dalšího breakpointu,\npřípadně na konec programu.</p>\n<h3>Step over, into, out</h3>\n<p>Často budeme chtít pokračovat na další řádek kódu. Docílíme toho pomocí\nklávesy <kbd>F10</kbd>, případně kliknutím na <em>Step over</em>.</p>\n<p>Pokud bychom chtěli vstoupit do funkce, která je volaná na aktualním řádku,\ntak toho docílíme pomocí <kbd>F11</kbd> - <em>Step into</em>.</p>\n<p>Pro vystoupení z aktuální funkce se používá\n<kbd>Shift</kbd> + <kbd>F11</kbd>.\nProgram pokračuje až do chvíle, než se vrátí do funkce, která volala\nfunkci, ze které jsme chtěli vystoupit.</p>\n<h2>Debug testů</h2>\n<p>Často zjistíme, že nám neprocházejí testy.\nMůže se jednat o chybu v testu, nebo o chybu v programu.\nIdeální je si test prodebugovat, a to například tak,\nže dáme breakpoint na začátek testu a pak se kombinací\n<em>Step over / into / out</em> dostaneme na problémové místo programu.\nBudeme sledovat, jak se vyhodnocují jednotlivé podmínky,\njaké argumenty se předávají do funkcí atd.\nČasto se nám tímto způsobem podaří chybu najít.</p>\n<p>Pokud máme správně nastavený VSCode, tak by se nad testovacími\nfunkcemi měly objevit možnosti <em>Run Test</em> a <em>Debug Test</em>\n(jako na obrázku níže).</p>\n<p><span class=\"figure\"><a href=\"/2019/brno-jaro-2019-ut/beginners/debug/static/test_debug.png\"><img src=\"/2019/brno-jaro-2019-ut/beginners/debug/static/test_debug.png\" alt=\"(Debug testu)\"></a></span></p>\n<p>Jestli ve svém editoru tyto možnosti nemáš, tak zkus:</p>\n<ul>\n<li>zkontrolovat, že máš nastavený interpreter<ul>\n<li>v levém dolním rohu VSCode by jsi kromě verze Pythonu\nměla vidět jméno virtuálního prostředí (např. Python 3.6 (venv))<ul>\n<li>pokud jméno virtuálního prostředí nevidíš, tak stiskni\n<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>,\nvyber <em>Select Python Interpreter</em> a zvol své virtuální prostředí\n(pravděpodobně <em>venv</em>)</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>Stisknout <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> a vybrat <em>Discover Unit Tests</em></li>\n</ul>\n<p>Po kliknutí na <em>Debug test</em> se spustí debugger.</p>\n<h2>Debug console</h2>\n<p>Po spuštění debugeru je možné používat debugovací konzoli.\nNajdete ji ve spodním panelu v záložce vedle integrovaného terminálu.</p>\n<p><span class=\"figure\"><a href=\"/2019/brno-jaro-2019-ut/beginners/debug/static/debug_console.png\"><img src=\"/2019/brno-jaro-2019-ut/beginners/debug/static/debug_console.png\" alt=\"(Debug konzole)\"></a></span></p>\n<p>Představ si, že jsi spustila Python z příkazové řádky\na poté zadala stejný kód, kterým debugger prošel, než se dostal na breakpoint.\nV tu chvíli tedy máte k dispozici všechny inicializované globální proměnné,\nmůžete volat funkce nebo pracovat s proměnným úplně stejně,\njak jsme to dělali v lekcích na začátku kurzu.</p>\n<p>Pokud například víte, že na dalším řádku vzniká <code>IndexError</code>, ale nevíte proč,\ntak můžete zjistit, na jaký index se přistupuje, jaké hodnoty jsou v\nseznamu nebo slovníku obsažené a co by se stalo, kdybyste použily jiný index.</p>\n<p>Do debug konzole se také vypisují <code>printy</code>, pokud je v programu používáte.</p>\n<p>Jen pozor - pokud upravíte hodnoty proměnných,\ntak se změny promítnout do zbytku programu, takže je někdy nutné\ndebugger restartovat.</p>\n\n\n "
}
}
}