Tutorial: Executar código no Depurador no Visual Studio

Este artigo apresenta a Etapa 4 da série de tutoriais Trabalhar com Python no Visual Studio.

O Visual Studio fornece recursos para gerenciar projetos, uma experiência de edição avançada, a Janela Interativa e a depuração completa para código Python. Na Etapa 4 desta série de tutoriais, você usa o Depurador para executar o código passo a passo, incluindo cada iteração de um loop. No Depurador, você pode pausar o programa sempre que determinadas condições forem verdadeiras. A qualquer momento em que o programa for pausado, você poderá examinar todo o estado do programa e alterar o valor das variáveis. Essas ações são essenciais para rastrear bugs do programa e também fornecem auxílios úteis para seguir o fluxo exato do programa.

Na Etapa 4 do tutorial, você aprenderá a:

Pré-requisitos

• Um projeto de aplicativo do Python que tem um arquivo Python (.py) com o código criado na Etapa 2: gravar e executar o código Python e Etapa 3: usar a janela interativa REPL deste tutorial.

Preparar o arquivo Python

Para se preparar para o exercício de depuração, siga estas etapas para atualizar o arquivo de projeto do Python para incluir um código mais robusto:

1. Abra o arquivo de projeto do Python (.py) no editor.

2. Substitua o código no arquivo pelo código a seguir. Esta versão do código expande a função make_dot_string para que você possa examinar suas etapas discretas no depurador. Ele move o loop for para uma função main e executa-o explicitamente chamando a função main:

   from math import cos, radians
   
   # Create a string with spaces proportional to a cosine of x in degrees
   def make_dot_string(x):
       rad = radians(x)                             # cos works with radians
       numspaces = int(20 * cos(rad) + 20)          # Scale to 0-40 spaces
       st = ' ' * numspaces + 'o'                   # Place 'o' after the spaces
       return st
   
   def main():
       for i in range(0, 1800, 12):
           s = make_dot_string(i)
           print(s)
   
   main()
   

Iniciar a depuração

Agora você está pronto para começar a verificar o código Python atualizado no Depurador.

1. Confirme se o código funciona corretamente selecionando Depurar>Iniciar depuração na barra de ferramentas ou use o atalho de teclado F5. Esses comandos executam o código no Depurador.

   O do depurador de não detecta nenhum problema, portanto, o programa é executado com êxito. Uma janela de saída será aberta e você verá algumas iterações do padrão de onda cosseno. Selecione qualquer chave para fechar a janela de saída.

   Dica

   Para fechar a janela de saída automaticamente quando o programa for concluído, selecione Ferramentas>Opções, expanda a guia Python>Depuração e desmarque a opção Aguardar a entrada quando o processo sair normalmente.

2. Defina um ponto de interrupção na instrução de loop for usando um dos seguintes métodos:

   • Selecione na margem esquerda da linha de código.
   • Clique com o botão direito do mouse na linha de código e selecione Ponto de Interrupção>Inserir Ponto de Interrupção.
   • Coloque o cursor de inserção na linha do código e selecione Depurar>Alternar Ponto de Interrupção (ou use o atalho de teclado F9).

   Os pontos de interrupção interrompem a execução do código em um ponto marcado para que você possa inspecionar o estado do programa. Um ponto vermelho é exibido em cada linha que tem um ponto de interrupção definido.

   

3. Inicie o Depurador novamente (F5). O código em execução do programa é interrompido na linha com o ponto de interrupção definido. Agora você pode inspecionar a pilha de chamadas e examinar variáveis para esse estado do código do programa em execução.

   O Visual Studio fornece várias maneiras de observar o código do programa e os dados de execução, incluindo as seguintes janelas:

   • A Pilha de chamadas mostra o histórico de chamadas de função e método pelo código do programa.
   • As variáveis definidas que estão no escopo são exibidas na janela Autos.
   • A exibição Locais mostra todas as variáveis que o Visual Studio encontra no escopo atual (incluindo funções), mesmo antes de serem definidas no código.

   Para ver a lista completa de janelas e ações disponíveis, selecione Depurar>Windows.

   Você pode abrir as janelas do Depurador para exibir o estado do programa quando um ponto de interrupção é atingido:

   

Usar ações do Depurador

Quando o Visual Studio interrompe a execução de código em um ponto de interrupção, há vários comandos que você pode usar para avançar pelo seu código ou executar blocos de código antes de parar novamente. Os comandos estão disponíveis em alguns locais no Visual Studio, incluindo a barra de ferramentas Depurador, o menu Depurar, o menu de contexto do editor de código ao clicar com o botão direito do mouse e por meio de atalhos de teclado.

A barra de ferramentas Depurador na parte superior da janela do Visual Studio fornece acesso rápido aos comandos de depuração mais comuns:

A tabela a seguir resume esses comandos conforme eles aparecem da esquerda para a direita na barra de ferramentas:

Siga estas etapas para trabalhar com as ações do Depurador no seu código Python:

1. Avance sobre a instrução de loop for usando a ação Passo a Passo.

   O Passo a Passo faz com que o Depurador execute a linha de código atual, inclusive qualquer função chamada, e pause imediatamente novamente. Depois do passo a passo, observe que a variável i agora está definida nas janelas Locais e Autos.

2. Passo a Passo na próxima linha de código, que chama a função make_dot_string.

   Nesse caso, o Passo a Passo faz com que o Depurador execute a função de make_dot_string completa e pause após o retorno da função. O Depurador não para dentro da função, a menos que exista um ponto de interrupção separado lá.

3. Continue depurando o código passo a passo mais algumas vezes e observe como os valores na janela Locais ou Autos se alteram.

4. Na janela Locais ou Autos, clique duas vezes na coluna Valor para que uma variável edite o valor. Neste exemplo, altere o valor da variável s para 'Hello, Python Application'. Certifique-se de colocar o valor entre aspas simples. Selecione Inserir ou qualquer área fora do valor para aplicar suas alterações.

   

5. Continue o passo a passo do código usando Intervir até a chamada para a função make_dot_string.

   Para uma função, Intervir faz com que o Depurador chame a função e também entre no código da função. Quando o processo de depuração está dentro de uma função, você pode examinar suas variáveis locais e percorrer seu código especificamente. Neste exemplo, a ação Passo para passa para a função make_dot_string.

6. Continue o passo a passo com Intervir até o retorno da função make_dot_string.

   Quando você chegar ao final do código da função make_dot_string, a próxima etapa retornará o *Depurador para o loop for com o novo valor de retorno na variável s.

   À medida que você volta à instrução print, observe que a ação Intervir na instrução print não entra nessa função. Esse comportamento ocorre porque a função print não é escrita em Python. É um código nativo dentro do runtime do Python.

7. Continue usando Intervir até entrar novamente na função make_dot_string e, em seguida, use Sair e observe que o Depurador retornará ao loop for.

   Com Sair, o Depurador executa o restante da função e, em seguida, pausa automaticamente no código chamador. Essa ação é útil depois que você percorre alguma parte de uma função extensa e deseja encerrar sua observação da função. Sair passa pelo código restante ou até atingir um ponto de interrupção explícito definido no código de chamada.

8. Continue executando o programa até que o próximo ponto de interrupção seja atingido usando Continuar (F5). Como você tem um ponto de interrupção definido no loop for, você quebra na próxima iteração.

   Você pode confirmar que o programa está sendo executado ao observar o valor em constante mudança da variável s na janela Locais.

Usar condições de ponto de interrupção

Percorrer centenas de iterações de um loop pode ser entediante, portanto, o Visual Studio permite adicionar uma condição a um ponto de interrupção. Quando você define uma condição de ponto de interrupção, o Depurador pausa o programa no ponto de interrupção somente quando a condição é atendida.

As etapas a seguir mostram como definir uma condição de ponto de interrupção na instrução de loop for para que o Depurador pausa somente quando o valor da variável i exceder 1600:

1. Para definir a condição do ponto de interrupção, clique com o botão direito do mouse no ponto de interrupção vermelho e selecione Condições ou use o atalho de teclado Alt+F9>C.

2. Na caixa de diálogo pop-up Configurações do Ponto de Interrupção, defina as seguintes configurações para criar a Condição:

   1. Defina o tipo de condição como expressão condicional.

   2. Defina a avaliação da condição como É verdadeira.

   3. Insira i > 1600 como o valor da condição.

   4. Selecione Fechar.

   

3. Selecione F5 para continuar a depuração e a execução do programa. Observe que o programa executa muitas iterações antes de atingir o ponto de interrupção condicional.

   Você pode confirmar se o Depurador pausa corretamente a execução do programa ao atingir o ponto de interrupção condicional. Quando a condição é atendida, a janela Locals mostra o valor da variável i como 1608.

4. Para executar o programa até a conclusão, você pode desabilitar o ponto de interrupção e continuar a execução do programa.

   1. Passe o mouse sobre o ponto vermelho e selecione Desabilitarou clique com o botão direito do mouse no ponto vermelho e selecione Desabilitar o ponto de interrupção.

   2. Selecione Continuar (ou pressione F5) para executar o programa.

   Quando o programa terminar, o Visual Studio interromperá a sessão de depuração e retornará ao modo de edição.

   Você também pode excluir um ponto de interrupção. Selecione o ponto vermelho ou clique com o botão direito do mouse no ponto e selecione Excluir ponto de interrupção. Essa ação também exclui quaisquer condições definidas.

Próxima etapa