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

プレビュー

この機能はパブリックプレビュー段階です。

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

対話型デバッガーは、ブレークポイント、ステップバイステップの実行、変数検査など、ノートブックでコードをより効率的に開発するのに役立つツールを提供します。

要件

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

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

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

デバッガを有効または無効にするには、次の操作を行います。

ワークスペースの右上にあるユーザー名をクリックし、ドロップダウンリストから[設定]を選択します。
[ 設定 ] サイドバーで [ 開発者] を選択します。
[実験的な機能]セクションで、 [Python ノートブックインタラクティブデバッガー]を切り替えます。

デバッガを起動する

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

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

デバッグセッションが自動的に開始され、選択したセルが実行されます。

また、セルがエラーをトリガーした場合にデバッガを起動することもできます。セル出力の下部で、をクリックします。

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

デバッガを使用する

デバッグセッションでは、次の操作を実行できます。

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

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

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

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

デバッグコンソールを使用する

デバッグセッションを開始すると、デバッグコンソールが下部のパネルに自動的に表示されます。このコンソールを使用すると、ブレークポイントで停止したときにPythonコードを実行して変数を検査または操作できます。メインノートブックで実行されるコードは、デバッグセッション中は実行されません。コンソールでコードを実行するには、 Enterキーを押します。複数行の式の場合は、 Shift + Enter キーを使用して新しい行に移動します。

注：

デバッグコンソールは、迅速な評価を行い、コードの実行が 15 秒を超えるとタイムアウトするように設計されています。
displayコマンドはデバッグコンソールではサポートされていません。 DataFrame からサンプルデータを表示するには、PySpark DataFrames の場合はdf.show() 、Pandas DataFrames の場合はdf.head()使用します。

変数エクスプローラーを使用する

右側の変数エクスプローラーパネルを使用して、変数の値を表示できます。 [Inspect] をクリックすると、デバッグコンソールでコードが自動的に実行され、変数の値が出力されます。

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

デバッグセッションを終了するには、デバッガの停止ボタンセルの左上にあるノートブックの上部にあります。ユーザーがデバッグツールバーまたはデバッグコンソールを使用しない場合、デバッグセッションは 30 分後に自動的に終了します。

制限事項

詳細については、 Databricks既知の制限事項」を参照してください。