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

Cet article explique 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. Pour plus d’informations sur l’extension, consultez l’ extension Databricks pour Visual Studio Code.

L'intégration de Databricks Connect vous permet également d'exécuter et de déboguer les cellules de Notebook. Consultez Exécuter et déboguer les cellules de Notebook avec Databricks Connect à l'aide de l'extension Databricks pour Visual Studio Code.

Exigences

Avant de pouvoir utiliser Databricks Connect à partir de l'extension Databricks pour Visual Studio Code, vous devez d'abord satisfaire aux exigences de Databricks Connect. Ces exigences incluent des éléments tels qu'un Workspace avec Unity Catalog activé, des exigences de compute et des exigences de version pour votre installation locale de Python.

Activer un environnement virtuel Python

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

Dans le volet Configuration :

1. Cliquez sur l'élément rouge Activer l'environnement virtuel 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 Install databricks-connect .

2. Associer un cluster.

   • Si la section **Cluster** n'est pas déjà configurée dans l'extension, le message suivant apparaît : « Veuillez associer un cluster pour utiliser Databricks Connect. » Cliquez sur Associer le 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 le cluster** et sélectionnez un cluster compatible.

3. Si le package Databricks Connect (et ses dépendances) n'est pas déjà installé, le message suivant apparaît : « Pour le debugging interactif et la saisie semi-automatique, 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é** apparaît, cliquez dessus et suivez les instructions à l'écran pour l'activer.

5. Après l'apparition du bouton Databricks Connect activé , 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. Assurez-vous de remplacer 16.4.1 par la version du package Databricks Connect qui correspond à celle qui a été installée par l'extension Databricks pour Visual Studio Code pour votre projet.

Bash

poetry add databricks-connect==16.4.1

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 des points d'arrêt de debugging dans le fichier Python.

3. Cliquez sur l'icône **Exécuter sur Databricks** à côté de la liste des tabs d'éditeur, puis cliquez sur **Déboguer le fichier actuel avec Databricks Connect**.

   

   Le résultat apparaît dans le volet Debug Console .

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