Documentation Python

デバッガの使用 (pdbモジュール)について

デバッグは、ソフトウェア開発において不可欠な作業です。Pythonでは、標準ライブラリとしてpdbモジュールが提供されており、このモジュールを使用することで、プログラムの動作を詳しく確認しながら、効率的にバグを特定して修正することができます。 この記事では、Pythonのpdbモジュールを使って、プログラムの実行をステップごとに追跡し、問題箇所を見つけ出す方法について解説します

pdbモジュールとは？

pdbは、Pythonのデバッガ（debugger）で、プログラムを一行ずつ実行し、変数の値を確認したり、ブレークポイントを設定して特定の箇所でプログラムを一時停止させることができます。 デバッグの主な目的は、プログラムの中で何が起きているのかを理解することです。これにより、バグの原因を特定し、修正することが可能になります

pdbを使ったデバッグの基本

デバッガの起動方法

pdbモジュールを使ってデバッグを始めるには、次のようにPythonスクリプトを実行します。

python -m pdb myscript.py

これにより、スクリプトがデバッガモードで実行され、プログラムが開始された時点でpdbが有効になります。

プログラム内でデバッガを起動

もう1つの方法として、コード内にpdb.set_trace()を挿入することで、デバッグしたい箇所でプログラムを停止させることができます。

import pdb
def divide(a, b):
    pdb.set_trace()  # ここでデバッガが起動
    return a / b
divide(10, 0)

このようにコードにデバッガを埋め込むことで、特定の箇所でプログラムを停止させ、そこでの状態を確認できます

pdbの基本コマンド

pdbには、プログラムの進行を操作するためのさまざまなコマンドが用意されています。以下に、代表的なコマンドを紹介します。

break (ブレークポイントの設定)

breakコマンドを使うと、指定した行でプログラムを一時停止させるブレークポイントを設定できます。これにより、問題のある箇所に到達したときに、プログラムを停止させてその状態を確認できます。

break myscript.py:10

上記のコマンドは、myscript.pyの10行目にブレークポイントを設定します。

list (コードの表示)

listコマンドは、現在の位置から前後のコードを表示します。これにより、デバッグ中にどの部分のコードが実行されているかを確認できます。

list

next (次の行に進む)

next（省略形n）は、現在の行の処理を行い、次の行に進むコマンドです。関数呼び出しを中に入らずに実行できます。

next

step (ステップ実行)

step（省略形s）は、現在の行をステップ実行し、もしその行が関数呼び出しであれば、その関数の中に入って処理を追跡します。

step

continue (プログラムの再開)

continue（省略形c）は、プログラムを次のブレークポイント、または終了まで再開するコマンドです。

continue

6. print (変数の表示)

print（省略形p）コマンドを使うと、特定の変数の値を表示できます。デバッグ中に、変数の状態を確認するのに非常に便利です。

p my_variable

7. where (現在の実行位置を確認)

where（省略形w）コマンドは、現在実行している箇所のスタックトレース（実行中の関数のリスト）を表示します。複数の関数が呼び出されている場合、実行位置を把握するのに役立ちます。

where

8. quit (デバッガの終了)

デバッグセッションを終了するには、quitコマンド（省略形q）を使用します。これでデバッガから抜け、プログラムの実行も停止します。

quit

pdbを使ったデバッグの例

ここでは、簡単なプログラムをデバッグする例を見てみましょう。次のコードには、ゼロ除算エラーが発生するバグがあります。

def divide(a, b):
    return a / b
result = divide(10, 0)
print(f"Result: {result}")

実行すると、ZeroDivisionErrorが発生します。このバグを特定するために、pdbを使ってデバッグしてみましょう。

デバッグの手順

  1. コードにpdb.set_trace()を挿入して、デバッガを起動します。

    import pdb
def divide(a, b):
    pdb.set_trace()  # ここでデバッグ開始
    return a / b
result = divide(10, 0)
print(f"Result: {result}")

  2. プログラムを実行すると、pdbが起動してインタラクティブなデバッグセッションに入ります。

    > myscript.py(4)divide()
-> return a / b

  3. pコマンドを使って、変数aとbの値を確認します。

    p a
# -> 10
p b
# -> 0

    この時点で、bが0であることがわかるため、ゼロ除算エラーが発生する原因を特定できます。

  4. stepやnextを使って、ステップ実行しながらプログラムの動作を確認したり、変数の状態を調べることで、問題箇所を修正できます

デバッグの効率を上げるためのヒント

ブレークポイントを賢く使う

デバッグ対象のコード全体を一行ずつステップ実行するのではなく、ブレークポイントを適切に設定することで、特定の重要な箇所に直接移動して問題を追跡することができます。

コードを理解しながら実行

デバッガは、コードを一行一行確認しながらプログラムがどう動作しているかを理解するのに役立ちます。デバッグ中に発生したエラーや期待通りに動作しない部分をじっくり観察しながら、実行の流れを把握しましょう。

pdb.set_trace()を使って特定の箇所で停止

特定の箇所でプログラムを停止させたいときは、pdb.set_trace()を挿入することで、実行の流れを止め、手動で変数や動作を確認することができます。

continueで効率よくデバッグ

1つのブレークポイントを設置した後は、毎回一行ずつステップ実行するのではなく、continueを使って次のブレークポイントまで一気に進めることで、効率的にデバッグが可能です

まとめ

pdbは、Pythonの標準デバッガとして、非常にシンプルかつ強力なツールです。ブレークポイントの設定やステップ実行、変数の表示といった基本的な操作を駆使することで、バグを効率よく特定し、問題を迅速に修正することができます。 pdbの使い方に慣れれば、プログラムの挙動を深く理解し、開発効率を大幅に向上させることができるでしょう。次回のデバッグ作業では、pdbを活用してみてください。

参照:

pdb — The `Python` Debugger
円