Databricks 対話型デバッガーを使用する

[アーティクル]
04/25/2024

重要

この機能はパブリックプレビュー段階にあります。

このページでは、Databricks ノートブックの組み込みの対話型デバッガーを使用する方法について説明します。このデバッガーは Python でのみ使用できます。

この対話型デバッガーには、ブレークポイント、ステップバイステップ実行、変数検査などのツールが備わっており、ノートブック内のコードをより効率的に開発するのに役立ちます。

要件

ノートブックは、次の要件を満たすクラスターにアタッチする必要があります。

Databricks Runtime バージョン 13.3 LTS 以降。
アクセスモードは、単一ユーザー (割り当て済み) または分離なし共有である必要があります。

デバッガーを有効または無効にする

デバッガーを有効または無効にするには、次のようにします。

ワークスペースの右上にあるユーザー名をクリックし、ドロップダウンリストから [設定] を選択します。
[設定] サイドバーで、[Developer] を選択します。
[実験的な機能] セクションで、[Python ノートブック対話型デバッガー] をオンにします。

デバッガーを起動する

デバッガーを起動するには、次のステップに従います。

セルの余白をクリックし、1 つ以上のブレークポイントを追加します。ブレークポイントを削除するには、再度クリックします。
次のいずれかの操作を行います。
- [実行] > [セルのデバッグ] の順にクリックします。
- キーボードショートカット Ctrl + Shift + D を使用します。
- セルの実行メニューで、[セルのデバッグ] を選択します。

デバッグセッションは自動的に始まり、選択したセルを実行します。

セルでエラーがトリガーされた場合にもデバッガーを自動的に開始できます。セルの出力の下部で、をクリックします。

デバッグセッションがアクティブな場合、デバッグツールバー [デバッグ] ツールバーがセルの上部に表示されます。

デバッガーを使用する

注釈付きデバッガーツールバー

デバッグセッションで、次のことを実行できます。

ブレークポイントを設定または削除する。
ブレークポイントの変数の値を表示する。
コードをステップ実行する。
関数にステップインまたは関数からステップアウトする。

コードがブレークポイントに達すると、行が実行される前 (後ではなく) に停止します。

デバッガーツールバーのボタンを使用してコードをステップ実行します。コードをステップ実行すると、現在の行がセルで強調表示されます。変数値は、右サイドバーの変数エクスプローラーペインで確認できます。

関数をステップ実行すると、ローカル関数の変数が変数ペインに表示され、[local] とマークされます。

デバッガーセッションを終了する

デバッガーセッションを終了するには、セルの左上にあるデバッガーの停止ボタンをクリックするか、ノートブックの上部にあるをクリックします。

制限事項

デバッガーは Python でのみ機能します。 Scala や R には対応していません。
デバッガーは、共有アクセスモードのクラスターでは機能しません。
デバッガーは、外部のファイルやモジュールへのステップインには対応していません。
デバッグセッションがアクティブな場合、ノートブック内で他のコマンドを実行できません。