Déboguer le code à l’aide de Databricks Connect pour l’extension Databricks pour Visual Studio Code

Cet article décrit comment utiliser l’intégration Databricks Connect dans l’extension Databricks pour Visual Studio Code afin d’exécuter et de déboguer des fichiers Python (.py) individuels. Consultez Présentation de l’extension Databricks pour Visual Studio Code.

L’intégration de Databricks Connect vous permet également d’exécuter et de déboguer des cellules de notebook. Consultez Exécuter et déboguer des cellules de notebook avec Databricks Connect en utilisant l’extension Databricks pour Visual Studio Code.

Spécifications

Avant de pouvoir utiliser Databricks Connect à partir de l’extension Databricks pour Visual Studio Code, vous devez d’abord répondre aux exigences de Databricks Connect. Ces exigences incluent des éléments tels qu’un espace de travail compatible avec Unity Catlog, les exigences de calcul et les exigences de version pour votre installation locale de Python.

Activer un environnement virtuel Python

Activer un environnement virtuel Python pour votre projet Python. Les environnements virtuels Python vous aident à vous assurer que votre projet utilise des versions compatibles des packages Python et Python (dans ce cas, le package Databricks Connect).

Dans le volet Configuration :

1. Cliquez sur l’élément Activer l’environnement virtuel rouge sous Environnement Python.
2. Dans la palette de commandes, sélectionnez Venv ou Conda.
3. Sélectionnez les dépendances que vous souhaitez installer, le cas échéant.

Installer Databricks Connect

Dans la vue Configuration sous Environnement Python :

1. Cliquez sur le bouton de lecture rouge d’installation rouge Installer databricks-connect.
2. Attacher un cluster.
   • Si la section Cluster n’est pas déjà configurée dans l’extension, le message suivant s’affiche : « Veuillez joindre un cluster pour utiliser Databricks Connect. » Cliquez sur Attacher un cluster et sélectionnez un cluster qui répond aux exigences de Databricks Connect.
   • Si la section Cluster est configurée mais que le cluster n’est pas compatible avec Databricks Connect, cliquez sur le bouton rouge Databricks Connect désactivé , cliquez sur Attacher un cluster, puis sélectionnez un cluster compatible.
3. Si le package Databricks Connect (et ses dépendances) n’est pas encore installé, le message suivant s’affiche : « Pour le débogage interactif et l’autocomplétion, vous avez besoin de Databricks Connect. Voulez-vous l’installer dans l’environnement <environment-name>. » Cliquez sur Installer.
4. Dans la barre d’état de Visual Studio Code, si le bouton rouge Databricks Connect désactivé s’affiche, cliquez dessus et suivez les instructions à l’écran pour l’activer.
5. Une fois que le bouton Databricks Connect activé s’affiche, vous êtes maintenant prêt à utiliser Databricks Connect.

Remarque

Si vous utilisez Poetry, vous pouvez synchroniser vos fichiers pyproject.toml et poetry.lock avec le package Databricks Connect installé (et ses dépendances) en exécutant la commande suivante. Veillez à remplacer 13.3.2 par la version du package Databricks Connect qui correspond à celle installée par l’extension Databricks pour Visual Studio Code pour votre projet.

poetry add databricks-connect==13.3.2

Exécuter ou déboguer votre code Python

Après avoir activé Databricks Connect, exécutez ou déboguez votre fichier Python (.py) :

1. Dans votre projet, ouvrez le fichier Python que vous souhaitez exécuter ou déboguer.

2. Définissez les points d’arrêt de débogage dans le fichier Python.

3. Cliquez sur l’icône Exécuter sur Databricks en regard de la liste des onglets de l’éditeur, puis cliquez sur Databricks Connect : déboguer le fichier actif.

   

   La sortie apparaît dans le volet Console de débogage.

   Vous pouvez également cliquer avec le bouton droit sur le fichier .py, puis cliquer sur Exécuter sur Databricks>Databricks Connect : déboguer le fichier actif.