使用 Databricks Connect 為 Visual Studio Code 的 Databricks 擴充功能除錯程式碼

本文說明如何在 Databricks 擴充套件中使用 Databricks Connect 整合,讓 Visual Studio Code 執行並除錯個別的 Python(.py)檔案。 關於該擴充功能的資訊,請參閱 Visual Studio Code 的 Databricks 擴充功能。

Databricks Connect 整合也可讓您執行和偵錯筆記本單元格。 請參考 使用 Databricks Connect 以執行並除錯筆記本儲存格,對於 Visual Studio Code 使用 Databricks 擴充功能

需求

你必須先符合 Databricks Connect 的要求,才能在 Visual Studio Code 的 Databricks 擴充功能中使用 Databricks Connect。 這些需求包括支援 Unity 目錄的工作區、計算需求,以及本地安裝 Python 的版本要求。

啟用 Python 虛擬環境

為您的Python專案啟用Python 虛擬環境。 Python 虛擬環境有助於確保你的專案使用相容的 Python 和 Python 套件版本(此處指 Databricks Connect 套件)。

在 [ 組態 ] 窗格中:

  1. 點擊啟動虛擬環境紅色的項目,位於Python環境下。
  2. 在 [ 命令選擇區] 中,選取 [Venv] 或 [Conda]。
  3. 選取您想要安裝的相依性,如果有的話。

安裝 Databricks Connect

ConfigurationPython Environment 視圖中:

  1. 按一下紅色安裝 databricks-connect播放按鈕。
  2. 連接叢集。
    • 如果延伸模組中尚未設定 [ 叢集 ] 區段,則會出現下列訊息:「請附加叢集以使用 Databricks Connect」。 按兩下 [ 連結叢集 ],然後選取符合 Databricks Connect 需求的叢集。
    • 如果已設定 叢集 區段,但叢集與 Databricks Connect 不相容,請單擊紅色的已停用 Databricks Connect 按鈕,再單擊 附加叢集,然後選取相容的叢集。
  3. 如果尚未安裝 Databricks Connect 套件(及其相依性),則會出現下列訊息:「針對互動式偵錯和自動完成,您需要 Databricks Connect。 您是否想要將它安裝在環境 <environment-name> 中? 按一下 [安裝]
  4. 在 Visual Studio Code 狀態列中,如果出現紅色的Databricks Connect已禁用按鈕,請點擊它,並按照螢幕上的指示完成啟用流程。
  5. 啟用 Databricks Connect 按鈕之後,您現在已準備好使用 Databricks Connect。

注意

如果您使用Poetry,您可以執行下列命令,將您的pyproject.tomlpoetry.lock檔案與已安裝的Databricks Connect套件及其相依套件同步處理。 請確保將 16.4.1 替換成與由 Visual Studio Code 的 Databricks 擴充套件安裝的版本相符的 Databricks Connect 套件,以適用於您的專案。

poetry add databricks-connect==16.4.1

執行或除錯你的Python程式碼

啟用 Databricks Connect 後,執行或除錯你的 Python 檔案(.py):

  1. 在你的專案中,打開你想執行或除錯的 Python 檔案。

  2. 在 Python 檔案中設定任何除錯斷點。

  3. 按一下編輯器索引標籤清單旁的 [Databricks 上執行] 圖示,然後按一下 [使用 Databricks Connect 偵錯目前檔案]。

    從圖示偵錯目前的檔案

    輸出會出現在 [ 偵錯控制台] 窗格中。

    您也可以右鍵點擊 .py 檔案,然後按下 [在 Databricks 上執行]>[使用 Databricks Connect 偵錯目前檔案]

    從操作功能表偵錯目前的檔案