Configurar um IDE para usar o Snowpark Checkpoints¶
O Snowflake Extension for Visual Studio Code oferece suporte à biblioteca Snowpark Checkpoints para aprimorar a experiência de uso do framework. Ele oferece controle refinado sobre as instruções collect
e validate
inseridas no seu código, bem como analisa o status das afirmações de equivalência comportamental do seu código convertido.
Como habilitar Snowpark Checkpoints¶
Para habilitar Snowpark Checkpoints, acesse as configurações de extensão do Snowflake e marque Snowpark Checkpoints: Enabled.

Exibição¶
A definição da propriedade Snowpark Checkpoints como Enabled, conforme explicado anteriormente, abrirá uma nova guia na extensão chamada SNOWPARK CHECKPOINTS. Ele exibe todos os pontos de verificação no espaço de trabalho e permite a execução de várias ações, como ativar/desativar todos ou individualmente, limpar todos os arquivos e, ao clicar duas vezes em cada ponto de navegação, navega até o arquivo e a linha de código em que ele está definido.
Alternar todos os pontos de verificação¶
Localizada no canto superior direito da guia Snowpark Checkpoints, essa opção alterna a propriedade ativada em todos os pontos de verificação.

Pontos de verificação ativados:

A desativação de um ponto de verificação faz com que ele seja ignorado no tempo de execução.

Limpeza de todos os pontos de verificação¶
Localizado no canto superior direito da guia Snowpark Checkpoints. Isso remove os pontos de verificação de todos os arquivos Python, incluindo Jupyter notebooks, em seu espaço de trabalho, mas não os exclui do contrato e do painel. Isso significa que eles podem ser restaurados usando o comando Snowflake: Restore All Checkpoints
.

Inserção de pontos de verificação em um arquivo¶
Ao clicar com o botão direito do mouse em um arquivo, será exibido um menu de contexto que contém a opção Snowpark Checkpoints, que permite adicionar pontos de verificação Collection e Validation.
Opção de pontos de verificação do Snowpark no menu de contexto:

Coletor/Validador adicionado:

Execução de um único ponto de verificação¶
Um único ponto de verificação pode ser executado clicando na opção de lente de código mostrada acima de cada ponto de verificação. A execução abrirá um console de saída mostrando o progresso e, quando terminar, abrirá a exibição de resultados. Mesmo que o ponto de verificação esteja desativado no arquivo de contrato, ele será ativado apenas para sua execução.

Se um ponto de entrada não for declarado no arquivo de contrato, será exibida a mensagem de erro: Ponto de entrada não encontrado para o ponto de verificação.

Execução de todos os pontos de verificação do Snowpark ativados em um arquivo¶
No canto superior direito de cada arquivo, o botão Run all checkpoints from the current file estará presente.

Ao clicar nele, será exibido um canal de saída que mostra o progresso da execução.

Visualização da linha do tempo¶
Exibe uma linha do tempo dos resultados da execução dos pontos de verificação.

Comandos¶
Os seguintes comandos estão disponíveis para Snowpark Checkpoints. Para usá-los, digite Snowflake: [command name]
na paleta de comandos.
Comando |
Descrição |
---|---|
Snowflake: alternar pontos de verificação |
Alterna a propriedade habilitada de todos os pontos de verificação. |
Snowflake: inicialização do projeto Snowpark Checkpoints |
Aciona a inicialização do projeto, criando um arquivo de contrato se ele não existir. Caso ele exista, será exibida uma janela pop-up perguntando se você deseja carregar o ponto de verificação no arquivo de contrato. |
Snowflake: limpar todos os pontos de verificação |
Exclui todos os pontos de verificação de todos os arquivos no espaço de trabalho. |
Snowflake: restaurar todos os pontos de verificação |
Restaurar pontos de verificação excluídos anteriormente dos arquivos que ainda estão presentes no arquivo de contrato. |
Snowflake: adicionar ponto de verificação de validação/coleta |
Adiciona um validador ou coletor com seus parâmetros obrigatórios na posição do cursor. |
Snowflake: foco na visão do Snowpark Checkpoints |
Muda o foco para o painel SNOWPARK CHECKPOINTS. |
Snowflake: abrir linha do tempo de pontos de verificação |
Exibe uma linha do tempo das execuções dos pontos de verificação. |
Snowflake: executar todos os pontos de verificação do arquivo atual |
Executa todos os pontos de verificação habilitados no arquivo atual. |
Snowflake: executar todos os pontos de verificação no espaço de trabalho |
Executa todos os pontos de verificação habilitados do espaço de trabalho. |
Snowflake: mostrar o resultado de Snowpark Checkpoints |
Exibe uma guia com todos os resultados dos pontos de verificação. |
Avisos¶
Duplicado: em um projeto de coleção, se dois pontos de verificação forem atribuídos com o mesmo nome, um aviso: «Outro ponto de verificação com um nome idêntico foi detectado e será substituído.» Os projetos de validação podem ter vários pontos de verificação com o mesmo nome, e nenhum aviso será exibido.
Tipo errado: ao adicionar um ponto de verificação com um tipo diferente do tipo de projeto, você o sublinhará com a seguinte mensagem de erro: «Certifique-se de que você está usando a instrução correta do Snowpark-Checkpoints. Essa instrução de ponto de verificação específica é diferente das outras usadas neste projeto; as instruções que não corresponderem ao tipo de projeto serão ignoradas quando executadas.»
Nome do ponto de controle inválido: há maneiras inválidas de adicionar um parâmetro de nome de ponto de verificação. Se isso acontecer, será exibida uma mensagem de aviso: «Nome do ponto de verificação inválido. Os nomes dos pontos de verificação devem começar com uma letra e só podem conter letras, números, hífens e sublinhados».