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 Catalog 対応ワークスペース、コンピューティング要件、Python のローカル インストールのバージョン要件などが含まれます。
Python 仮想環境をアクティブ化する
お使いの Python プロジェクト用の Python 仮想環境をアクティブ化します。 Python 仮想環境では、プロジェクトで互換性のあるバージョンの Python と Python パッケージ (この場合は Databricks Connect パッケージ) が使用されているかどうかを確認できます。
[構成] ウィンドウで、次の操作を実行します。
- [Python 環境] の下にある赤い [仮想環境のアクティブ化] 項目をクリックします。
- [コマンド パレット] で、Venv または Conda を選択します。
- インストールする依存関係を選択します (存在する場合)。
Databricks Connect をインストールする
[構成] ビューの [Python 環境] で、次の操作を実行します。
- 赤い [databricks-connect のインストール] 再生ボタンをクリックします。
- クラスターを接続します。
- 拡張機能で [クラスター] セクションがまだ構成されていない場合は、次のメッセージが表示されます: [Please attach a cluster to use Databricks Connect] (Databricks Connect を使用するクラスターをアタッチしてください)。 [Attach Cluster] (クラスターのアタッチ) をクリックし、Databricks Connect の要件を満たしているクラスターを選びます。
- [クラスター]セクションは構成されているが、クラスターが Databricks Connect に適合していない場合は、赤い [Databricks Connect disabled] (Databricks Connect は無効) ボタンをクリックし、[Attach Cluster] (クラスターのアタッチ) をクリックして、適合するクラスターを選びます。
- 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>
にインストールしますか)。 [インストール] をクリックします。 - Visual Studio Code のステータス バーで、赤い [Databricks Connect は無効] ボタンが表示されたら、それをクリックして、オンスクリーン インストラクションに従って有効にします。
- [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
) を実行またはデバッグします。
プロジェクトで、実行またはデバッグする Python ファイルを開きます。
Python ファイル内にデバッグ ブレークポイントを設定します。
エディター タブの一覧の横にある [Databricks で実行] アイコンをクリックし、[Databricks Connect: 現在のファイルをデバッグ] をクリックします。
出力は [デバッグ コンソール] ペインに表示されます。
.py
ファイルを右クリックし、[Databricks で実行]>[Databricks Connect: 現在のファイルをデバッグ] をクリックすることもできます。