Thread by @rochacbruno

Como depurar programas #Python 🐍 através da linha de comando. 🐛 #debugging #debug

#DicaDePythonCodeShow

🧵

A maneira mais fácil de interagir com um script Python é usando o argumento `-i` (interactive) no python ou no ipython.

$ ipython -i script.py

O script é executado e então o terminal interativo abre permitindo a inspeção do estado das variáveis.

Para uma depuração mais estruturada o melhor é o pdb que é o debugger built-in do Python docs.python.org/3/library/pdb.…

Executar e parar na linha 5
$ python -m pdb -c "until 5" script.py

O script é executado e então ao chegar na linha 5 o interpretador pausa.

Também é possível entrar no debugger sempre que ocorrer um erro.

$ python -m pdb -c continue script.py

Em qualquer Exception ao invés de "estourar" o erro, o debugger é acionado.

Para adicionar um breakpoint no seu código basta usar:

`__import__("pdb").set_trace()`

Outra opção a partir do Python 3.7 é usar a keyword `breakpoint()` que por padrão acionará o `pdb.set_trace`

O pdb é legal mas falta cor e facilidades, para isso existe o pdbr (pdb + rich)

Instalação e configuração:

$ pip install pdbr
$ export PYTHONBREAKPOINT=pdbr.set_trace

basta colocar `breakpoint()` na linha que deseja debugar.

O pdbr tem facilidades como colorização, histórico, comandos adicionais como `v` (exibir variaveis) e `vl` (exibir variaveis locais) e tudo isso formatado, colorido e com os helpers do ipython.

Ele também permite debugar projetos mais complexos, como aplicações Django.

Se prefere um debugger mais visual porém sem sair do terminal temos o pudb.

$ pip install pudb
$ export PYTHONBREAKPOINT=pudb.set_trace

ou

$ python -m pudb script.py

O legal é que dá para colocar breakpoints interativamente e tem um shell integrado.

Caso o programa que você quer debugar está localizado remotamente ou dentro de um container #docker é possível debugar via TCP com o sdb.

Remoto
$ pip install sdb
$ export PYTHONBREAKPOINT=sdb.set_trace

Local:
$ pip install sdb
$ sdb-listen

O sdb tem também uma feature bacana que permite o uso de SIGTRAP para iniciar o debugger, sendo assim quando temos aquele processo que fica travado e não sabemos o que tá acontecendo, podemos usar `kill -5 <pid>` para iniciar o debugger remotamente sem parar o processo.

github.com/ryanpetrello/s…

Para debugar remotamente ainda temos o web-pdb

$ pip install web-pdb

que funciona igual, mas para acessar o debugger vc aponta seu browser para uma porta especifica.

Todas essas ferramentas seguem o padrão `pdb` e portanto é possível customizar usando um arquivo chamado `~/.pdbrc` e o legal é que podemos criar aliases para comandos repetitivos.

gist.github.com/rochacbruno/f5…

Essa dica aprendi com o Adrian que trabalha comigo.

Para quem prefere uma experiência GUI ainda tem o WinPDB (eu pessoalmente não gosto) mas ele segue o mesmo padrão de todos.

$ pip install winpdb-reborn
$ winpdb script.py

ainda neste tema de debugging ainda tem mais coisas interessantes como rewind, situações onde não se pode colocar um breakpoint, post morten, debugger em filas, debugger em código async.

Para isso aqui não ficar enorme eu abordo essas questões depois.

Este conteúdo aqui eu tava guardando para preparar um vídeo no Youtube.com/CodeShowBR mas como estou sem condições/tempo de gravar resolvi colocar aqui mesmo. (se inscreve lá para dar uma força)

Sobre publicar essas dicas compiladas em 🧵 do twitter o que acham?

E mais uma questão, se eu compilar dicas aqui na próxima semana o que prefere?

Valeu! e manda mais dicas de debugging :) #python

E aproveita para deixar aquele RT no primeiro tweet desse fio :) valeu!