Visual Studio Code 用 Databricks 拡張機能の Databricks Connect を使用したコードのデバッグ

  • [アーティクル]

この記事では、Visual Studio Code 用 Databricks 拡張機能の Databricks Connect 統合を使って、個々の Python (.py) ファイルを実行してデバッグする方法について説明します。 「Visual Studio Code 用 Databricks 拡張機能について」を参照してください。

Databricks Connect 統合では、ノートブック セルを実行およびデバッグをすることもできます。 Visual Studio Code 用 Databricks 拡張機能を使用した Databricks Connect によるノートブックセルの実行とデバッグを参照してください。

要件

Visual Studio Code 用 Databricks 拡張機能内から Databricks Connect を使用するには、まず Databricks Connect の要件を満たす必要があります。 これらの要件には、Unity カタログ対応ワークスペース、コンピューティング要件、Python のローカル インストールのバージョン要件などがありまれます。

Python 仮想環境をアクティブ化する

お使いの Python コード プロジェクト用の Python 「仮想環境」 をアクティブにします。 Python 仮想環境は、プロジェクトで必ず適合したバージョンの Python および Python パッケージ (この場合は Databricks Connect パッケージ) が使用されるようにするのに役立ちます。

[構成] ウィンドウで、

  1. Python 環境の下の赤い Activate Virtual Environment 項目をクリックします。
  2. コマンド パレットで、Venv または Conda を選択します。
  3. 依存関係をインストールするパックがあれば選択します。

Databricks Connect をインストールする

Python 環境の構成 ビュー:

  1. 赤い databricks-connectのインストール 再生ボタンをクリックします。
  2. クラスターの接続
    • 拡張機能で [クラスター] セクションがまだ構成されていない場合は、次のメッセージが表示されます: [Please attach a cluster to use Databricks Connect] (Databricks Connect を使用するクラスターをアタッチしてください)。 [Attach Cluster] (クラスターのアタッチ) をクリックし、Databricks Connect の要件を満たしているクラスターを選びます。
    • [クラスター]セクションは構成されているが、クラスターが Databricks Connect に適合していない場合は、赤い [Databricks Connect disabled] (Databricks Connect は無効) ボタンをクリックし、[Attach Cluster] (クラスターのアタッチ) をクリックして、適合するクラスターを選びます。
  3. Databricks Connect パッケージ (およびその依存関係) がまだインストールされていない場合は、次のメッセージが表示されます: "For interactive debugging and autocompletion you need Databricks Connect. Would you like to install it in the environment <environment-name> (対話型デバッグとオートコンプリートには、Databricks Connect が必要です。これを環境 <environment-name> にインストールしますか)。 [インストール] をクリックします。
  4. Visual Studio Code のステータス バーで、赤い Databricks Connect が無効 ボタンが表示されたら、それをクリックして、画面の指示に従って有効にします。
  5. [Databricks Connect enabled] (Databricks Connect は有効) ボタンが表示されたら、Databricks Connect を使用する準備ができています。

Note

Poetry を使用すると、次のコマンドを実行して、pyproject.toml および poetry.lock ファイルをインストールされている Databricks Connect パッケージ (およびその依存関係) と同期することができます。 13.3.2 は、Visual Studio Code 用 Databricks 拡張機能によってプロジェクト用にインストールされたものと一致する Databricks Connect パッケージのバージョンに必ず置き換えてください。

poetry add databricks-connect==13.3.2

Python コードを実行またはデバッグする

Databricks Connect の有効後、Python ファイル (.py) を実行またはデバッグします。

  1. プロジェクトで、実行またはデバッグする Python ファイルを開きます。

  2. Python ファイル内にデバッグ ブレークポイントを設定します。

  3. エディター タブの一覧の横にある [Databricks で実行 ] アイコンをクリックして、[ Databricks Connect: Debug current file をクリックします。

    アイコンから現在のファイルをデバッグ

    出力は [デバッグ コンソール] ペインに表示されます。

    .py ファイルを右クリックし、[Run on Databricks>Databricks Connect: Debug current file のクリックもできます。

    コンテキスト メニューから現在のファイルをデバッグ