はじめに

pdbとは？

• 標準ライブラリ：追加のインストールが不要で、Python環境に最初から含まれています。
• 対話型操作：コマンドラインからインタラクティブにコマンドを入力し、デバッグ操作が可能です。
• 柔軟な制御：ステップ実行、次の行へ進む、関数の中に入る、実行の再開など、細かい制御ができます。

pdbの基本的な使い方

python -m pdb your_script.py

import pdb

def add(a, b):
    pdb.set_trace()  # ここで実行が停止する
    return a + b

result = add(2, 3)
print("Result:", result)

pdbの主なコマンド

• l (list) 現在の実行位置付近のソースコードを表示します。(Pdb) l
• n (next) 現在の行の実行を完了し、次の行に移動します。関数の中に入らず、現在の関数内の次の行を実行します。(Pdb) n
• s (step) 現在の行を実行し、もし関数呼び出しがあればその関数の中に入って実行を続けます。関数内部の動作を詳細に追いたいときに使用します。(Pdb) s
• c (continue) 次のブレークポイントまで、またはプログラム終了まで実行を継続します。(Pdb) c
• b (break) ブレークポイントを設定します。行番号や関数名を指定できます。 行番号で設定する場合： (Pdb) b 15 関数名で設定する場合： (Pdb) b my_function
• 行番号で設定する場合： (Pdb) b 15
• 関数名で設定する場合： (Pdb) b my_function
• p (print) 指定した変数や式の値を表示します。(Pdb) p variable_name
• q (quit) デバッグを終了し、プログラムの実行を中断します。(Pdb) q

pdbでのステップ実行とブレークポイント設定の実践例

例題：数値の加算処理のデバッグ

# sample.py
import pdb

def add(a, b):
    # デバッグのためにブレークポイントを設定
    pdb.set_trace()
    # バグ：引数aを2倍にしてしまっている
    return (a * 2) + b

def main():
    x = 5
    y = 3
    result = add(x, y)
    print("Result:", result)

if __name__ == '__main__':
    main()

デバッグの手順

• ブレークポイントの設定 上記コードでは、pdb.set_trace() を使って add 関数内にブレークポイントを設定しています。プログラム実行時、add 関数に入ると自動的に実行が停止します。
• プログラムの実行 ターミナルから以下のコマンドで実行します。python sample.py すると、pdbのプロンプト (Pdb) が表示され、デバッグモードに入ります。
• 変数の確認 ブレークポイントで停止した状態で、変数の値を確認してみます。(Pdb) p a 5 (Pdb) p b 3 ここで、aが正しく5であること、bが3であることを確認します。
• ステップ実行 n コマンドを使って次の行に進みます。(Pdb) n この時点で、計算式 (a * 2) + b が実行されるため、計算結果がどのようになっているか確認するために、p コマンドで式を評価してみてもよいでしょう。
• 実行の再開 c コマンドでプログラムの実行を再開します。ブレークポイントがない場合は、プログラムが最後まで実行され、結果が表示されます。(Pdb) c 実行結果として「Result: 13」が表示されますが、本来期待すべきは「Result: 8」だったとすると、どこかにバグがあることが分かります。
• 原因の特定 この例では、aを2倍してしまっているために誤った結果になっていることが判明します。実際のコード修正では、単に return a + b とするのが正しいでしょう。

pdbを活用した効果的なデバッグのコツ

• ブレークポイントを戦略的に配置する 問題が発生している箇所や、疑わしい関数の先頭にpdb.set_trace()を配置することで、必要なタイミングで実行を停止させ、状況を詳しく確認できます。
• 変数の状態を頻繁に確認する p コマンドを使って、重要な変数の値を随時確認することで、予期せぬ値の変化や不整合を早期に発見できます。
• ステップ実行と関数の内部確認を使い分ける n コマンドで大まかな流れを追いつつ、s コマンドを用いて関数の内部に入るなど、状況に応じた実行制御を行いましょう。
• コードのリスト表示で文脈を把握する l コマンドで周辺コードを表示し、現在の実行位置や処理内容を把握することで、デバッグ時の混乱を防げます。
• 終了する際はqコマンドで安全に抜ける デバッグを中断してプログラムを終了したい場合は、q コマンドを使用して安全にデバッガを終了しましょう。

おわりに

• Pythonデバッグの基本として、pdbの使い方をマスターしましょう。
• ステップ実行とブレークポイント設定を戦略的に活用することで、複雑なバグも解決しやすくなります。
• この記事で紹介したpdbの主なコマンドを実際に試し、デバッグ作業に慣れていくことが、より良いプログラム作成につながります。

参考資料

• Python公式ドキュメント – pdb
• Real Python – Python Debugging With pdb
• Effective Debugging Techniques in Python