pdb の使い方 -- コマンド編

ここでは、pdb コマンドの一覧とそのリファレンスを示します。

alias [name [command [parameter...]]]

'name' という名前で 'command' の別名をつくる。コマンドやパラメータはクオートで括ってはならない。置換可能パラメータは %1, %2 のように表し、%* は残りのパラメータ全てを表す。command が与えられなければ、name の現在の別名を表示する。name が与えられなければ、全ての alias を一覧表示する。

alias は入れ子になっていても、どんな正規に pdb プロンプトに書ける文を含んでいても良い。pdb の内部コマンドを alias で上書きすることが出来るので注意。その場合内部コマンドは alias が消去されるまで隠される。

便利な alias (とりわけ .pdbrc ファイルに置かれる) は、

#インスタンス変数を表示 ("pi インスタンス" と使う)
alias pi for k in %1.__dict__.keys(): print "%1.",k,"=",%1.__dict__[k]

#自身のインスタンス変数を表示
alias ps pi self

a(args)

現在の関数の引数を表示する。

b(reak) [[file:]lineno | function[, condition]]

引数なしだと、全てのブレークポイントを一覧表示する。行数だと、現在のファイルのその行にブレークポイントを設定する。関数名だと、その関数の最初の実行行にブレークポイントを設定する。二番目の引数は、ブレークポイントが認識される前に真と評価されなければならない式の文字列だ。

行数の前には、他のファイルにブレークポイントを設定するために、(恐らくまだロードされたことのない) ファイル名とコロンを付けることが出来る。ファイルは sys.path から探される。拡張子 .py は省いてもよい。

cl(ear) [filename:lineno | [bpnumber...]]

引数なしだと、全てのブレークポイントを削除する (確認される)。空白区切りのブレークポイント番号リストだと、それらのブレークポイントを消去する。ファイル名:行番号 だと、そのファイルのその行の全てのブレークポイントが消去される。

condition bpnumber [str_condition]

str_condition は、ブレークポイントが認識される前に真と評価されなければならない式の文字列だ。str_condition が欠落していると、現存の条件は削除される。つまり、そのブレークポイントは無条件になる。

c(ont(inue))

実行を再開する。ブレークポイントに出会うまで停止しない。

disable bpnumber [bpnumber...]

空白区切りのブレークポイント番号リストで与えられるブレークポイントを削除する。

d(own)

スタックトレースを現状から一段階下がる (古いフレームへ)。

enable bpnumber [bpnumber...]

空白区切りのブレークポイント番号リストで与えられるブレークポイントを有効化する。

(!) statement

現在のスタックフレームで (一行の) 文を実行する。最初の単語がデバッガコマンドでない場合、「 ! 」は省略できる。グローバル変数を指定する場合、常に 'global' を付けなければならない。例えば、
(Pdb) global list_options; list_options = ['-l']
(Pdb)

h(elp) [command]

引数なしだと、利用できるコマンドのリストを表示する。コマンド名だと、そのコマンドについての説明を、$PAGER を使って表示する。"help exec" は、! コマンドについての説明を表示する。

ignore bpnumber [count]

ブレークポイント番号で与えられるブレークポイントを count 回だけ無効化する。count が 0 になるとブレークポイントはアクティブになる。0 以外なら、count は、ブレークポイントに到達して、ブレークポイントが無効化されていなくて、条件が真であるたびに減少する。

l(ist) [first[, last]]

現在のファイルのソースコードのリストを表示する。引数なしだと、現在行の周りの 11 行を表示するか、前回の表示を繰り返す。引数がひとつだと、その行の周りの 11 行を表示する。引数がふたつだと、その間を表示する。二番目の数が一番目より小さいなら、カウントとして扱われる。

n(ext)

関数が次行に到達するかリターンするまで、実行を続ける。

p expression

式の値を表示する。

q(uit)

デバッガを終了する。実行しているプログラムは中止される。

r(eturn)

関数がリターンするまで、実行を続ける。

s(tep)

現在行を実行し、呼ばれた関数か、現在の関数のどちらかで停止する。

tbreak [[file:]lineno | function[, condition]]

引数は break と同じだが、ブレークポイントは最初にヒットした時点で削除される。

unalias name

設定された alias を削除する。

u(p)

スタックトレースを現状から一段階上がる (新しいフレームへ)。

whatis arg

引数の型を表示する。

w(here)

最新のフレームの底から、スタックトレースを表示する。矢印は現在位置を指している。