Depurar código usando Databricks Connect para a extensão do IDE Databricks

Este artigo descreve como usar a integração Databricks Connect na extensão do IDE Databricks para executar e depurar arquivos Python (.py) individuais. Para informações sobre a extensão, veja extensão do IDE Databricks.

A integração do Databricks Connect também permite executar e depurar as células do notebook. Veja : Executar e depurar células de notebooks com Databricks. Conecte usando a extensão do IDE Databricks.

Requisitos

Antes de poder usar o Databricks Connect dentro da extensão do IDE do Databricks, você deve primeiro atender aos requisitos do Databricks Connect. Esses requisitos incluem itens como um workspace habilitado para o Catálogo do Unity, requisitos de computação e requisitos de versão para sua instalação local de Python.

Ativar um ambiente virtual Python

Ative um ambiente Python virtual para seu projeto de Python. Ambientes virtuais Python ajudam a garantir que seu projeto esteja usando versões compatíveis do Python e de pacotes do Python (nesse caso, o pacote Databricks Connect).

No painel Configuração:

  1. Clique no item Ativar Ambiente Virtual em Ambiente Python.
  2. Na Paleta de comandos, selecione Venv ou Conda.
  3. Selecione as dependências que você deseja instalar, caso haja alguma.

Instalar o Databricks Connect

Na visualização Configuration em Python Environment:

  1. Clique no botão vermelho Instalar databricks-connect para executar.
  2. Anexar um cluster.
    • Se a seção Cluster ainda não estiver configurada na extensão, a seguinte mensagem será exibida: "Anexe um cluster para usar o Databricks Connect." Clique em Anexar Cluster e selecione um cluster que atenda aos requisitos do Databricks Connect.
    • Se a seção Cluster estiver configurada, mas o cluster não for compatível com o Databricks Connect, clique no botão vermelho Databricks Connect desabilitado, clique em Anexar Cluster e selecione um cluster compatível.
  3. Se o pacote do Databricks Connect (e suas dependências) não estiver instalado, a seguinte mensagem será exibida: "Para depuração interativa e preenchimento automático, você precisa do Databricks Connect. Você gostaria de instalá-lo no ambiente <environment-name>?" Clique em Instalar.
  4. Na barra de status Visual Studio Code, se o botão vermelho Databricks Connect desabilitado aparecer, clique nele e conclua as instruções na tela para habilitá-lo.
  5. Depois que o botão Databricks Connect habilitado for exibido, você estará pronto para usar o Databricks Connect.

Observação

Se você usar o Poetry, poderá sincronizar seus arquivos pyproject.toml e poetry.lock com o pacote do Databricks Connect instalado (e suas dependências) executando o comando a seguir. Certifique-se de substituir 16.4.1 pela versão do pacote Databricks Connect que corresponde à instalada pela extensão IDE do Databricks para o seu projeto.

poetry add databricks-connect==16.4.1

Execute ou depure seu código Python

Depois de habilitar o Databricks Connect, execute ou depure seu arquivo Python (.py):

  1. Em seu projeto, abra o arquivo Python que você deseja executar ou depurar.

  2. Defina os pontos de interrupção de depuração no arquivo Python.

  3. Clique no ícone Executar no Databricks ao lado da lista de guias do editor e clique em Depurar arquivo atual com o Databricks Connect.

    Depurar o arquivo atual pelo ícone

    A saída aparece no painel Console de Depuração.

    Você também pode clicar com o botão direito do mouse no arquivo .py e clicar em Executar no Databricks>Depurar o arquivo atual com o Databricks Connect.

    Depurar o arquivo atual no menu de contexto