"pdb" — Python デバッガ
***********************

**ソースコード:** Lib/pdb.py

======================================================================

モジュール "pdb" は Python プログラム用の対話型ソースコードデバッガを
定義します。 (条件付き)ブレークポイントの設定やソース行レベルでのシン
グルステップ実行、スタックフレームのインスペクション、ソースコードリス
ティングおよびあらゆるスタックフレームのコンテキストにおける任意の
Python コードの評価をサポートしています。事後解析デバッギングもサポー
トし、プログラムの制御下で呼び出すことができます。

The debugger is extensible — it is actually defined as the class
"Pdb". This is currently undocumented but easily understood by reading
the source.  The extension interface uses the modules "bdb" and "cmd".

デバッガのプロンプトは "(Pdb)" です。デバッガに制御された状態でプログ
ラムを実行するための典型的な使い方は以下のようになります:

   >>> import pdb
   >>> import mymodule
   >>> pdb.run('mymodule.test()')
   > <string>(0)?()
   (Pdb) continue
   > <string>(1)?()
   (Pdb) continue
   NameError: 'spam'
   > <string>(1)?()
   (Pdb)

他のスクリプトをデバッグするために、 "pdb.py" をスクリプトとして呼び出
すこともできます。例えば:

   python -m pdb myscript.py

When invoked as a script, pdb will automatically enter post-mortem
debugging if the program being debugged exits abnormally. After post-
mortem debugging (or after normal exit of the program), pdb will
restart the program. Automatic restarting preserves pdb’s state (such
as breakpoints) and in most cases is more useful than quitting the
debugger upon program’s exit.

バージョン 2.4 で追加: Restarting post-mortem behavior added.

実行するプログラムをデバッガで分析する典型的な使い方は:

   import pdb; pdb.set_trace()

at the location you want to break into the debugger.  You can then
step through the code following this statement, and continue running
without the debugger using the "c" command.

クラッシュしたプログラムを調べるための典型的な使い方は以下のようになり
ます:

   >>> import pdb
   >>> import mymodule
   >>> mymodule.test()
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "./mymodule.py", line 4, in test
       test2()
     File "./mymodule.py", line 3, in test2
       print spam
   NameError: spam
   >>> pdb.pm()
   > ./mymodule.py(3)test2()
   -> print spam
   (Pdb)

このモジュールは以下の関数を定義しています。それぞれが少しづつ違った方
法でデバッガに入ります:

pdb.run(statement[, globals[, locals]])

   Execute the *statement* (given as a string) under debugger control.
   The debugger prompt appears before any code is executed; you can
   set breakpoints and type "continue", or you can step through the
   statement using "step" or "next" (all these commands are explained
   below).  The optional *globals* and *locals* arguments specify the
   environment in which the code is executed; by default the
   dictionary of the module "__main__" is used.  (See the explanation
   of the "exec" statement or the "eval()" built-in function.)

pdb.runeval(expression[, globals[, locals]])

   Evaluate the *expression* (given as a string) under debugger
   control.  When "runeval()" returns, it returns the value of the
   expression.  Otherwise this function is similar to "run()".

pdb.runcall(function[, argument, ...])

   *function* (関数またはメソッドオブジェクト、文字列ではありません)
   を与えられた引数とともに呼び出します。 "runcall()" から復帰するとき
   、関数呼び出しが返したものはなんでも返します。関数に入るとすぐにデ
   バッガプロンプトが現れます。

pdb.set_trace()

   スタックフレームを呼び出したところでデバッガに入ります。たとえコー
   ドが別の方法でデバッグされている最中でなくても (例えば、アサーショ
   ンが失敗するとき)、これはプログラムの所定の場所でブレークポイントを
   ハードコードするために役に立ちます。

pdb.post_mortem([traceback])

   与えられた *traceback* オブジェクトの事後解析デバッギングに入ります
   。もし *traceback* が与えられなければ、その時点で取り扱っている例外
   のうちのひとつを使います。 (デフォルト動作をさせるには、例外を取り
   扱っている最中である必要があります。)

pdb.pm()

   "sys.last_traceback" のトレースバックの事後解析デバッギングに入りま
   す。

"run*" 関数と "set_trace()" は、 "Pdb" クラスをインスタンス化して同名
のメソッドを実行することのエイリアス関数です。それ以上の機能を利用した
い場合は、インスタンス化を自分で行わなければなりません:

class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None)

   "Pdb" はデバッガクラスです。

   *completekey*, *stdin*, *stdout* 引数は、基底にある "cmd.Cmd" クラ
   スに渡されます。そちらの解説を参照してください。

   *skip* 引数が指定された場合、 glob スタイルのモジュール名パターンの
   iterable (イテレート可能オブジェクト) でなければなりません。デバッ
   ガはこのパターンのどれかにマッチするモジュールに属するフレームには
   ステップインしません。 [1]

   *skip* を使ってトレースする呼び出しの例:

      import pdb; pdb.Pdb(skip=['django.*']).set_trace()

   バージョン 2.7 で追加: *skip* 引数が追加されました。

   run(statement[, globals[, locals]])
   runeval(expression[, globals[, locals]])
   runcall(function[, argument, ...])
   set_trace()

      前述のこれら関数のドキュメントを参照してください。


デバッガコマンド
****************

The debugger recognizes the following commands.  Most commands can be
abbreviated to one or two letters; e.g. "h(elp)" means that either "h"
or "help" can be used to enter the help command (but not "he" or
"hel", nor "H" or "Help" or "HELP").  Arguments to commands must be
separated by whitespace (spaces or tabs).  Optional arguments are
enclosed in square brackets ("[]") in the command syntax; the square
brackets must not be typed. Alternatives in the command syntax are
separated by a vertical bar ("|").

Entering a blank line repeats the last command entered.  Exception: if
the last command was a "list" command, the next 11 lines are listed.

デバッガが認識しないコマンドは Python 文とみなして、デバッグしているプ
ログラムのコンテキストおいて実行されます。先頭にに感嘆符 ("!") を付け
ることで Python 文であると明示することもできます。これはデバッグ中のプ
ログラムを調査する強力な方法です。変数を変更したり関数を呼び出したりす
ることも可能です。このような文で例外が発生した場合には例外名が出力され
ますが、デバッガの状態は変化しません。

Multiple commands may be entered on a single line, separated by ";;".
(A single ";" is not used as it is the separator for multiple commands
in a line that is passed to the Python parser.) No intelligence is
applied to separating the commands; the input is split at the first
";;" pair, even if it is in the middle of a quoted string.

The debugger supports aliases.  Aliases can have parameters which
allows one a certain level of adaptability to the context under
examination.

If a file ".pdbrc"  exists in the user’s home directory or in the
current directory, it is read in and executed as if it had been typed
at the debugger prompt. This is particularly useful for aliases.  If
both files exist, the one in the home directory is read first and
aliases defined there can be overridden by the local file.

h(elp) [*command*]
   Without argument, print the list of available commands.  With a
   *command* as argument, print help about that command.  "help pdb"
   displays the full documentation file; if the environment variable
   "PAGER" is defined, the file is piped through that command instead.
   Since the *command* argument must be an identifier, "help exec"
   must be entered to get help on the "!" command.

w(here)
   スタックの底にある最も新しいフレームと一緒にスタックトレースをプリ
   ントします。矢印はカレントフレームを指し、それがほとんどのコマンド
   のコンテキストを決定します。

d(own)
   Move the current frame one level down in the stack trace (to a
   newer frame).

u(p)
   Move the current frame one level up in the stack trace (to an older
   frame).

b(reak) [[*filename*:]*lineno* | *function*[, *condition*]]
   With a *lineno* argument, set a break there in the current file.
   With a *function* argument, set a break at the first executable
   statement within that function. The line number may be prefixed
   with a filename and a colon, to specify a breakpoint in another
   file (probably one that hasn’t been loaded yet). The file is
   searched on "sys.path". Note that each breakpoint is assigned a
   number to which all the other breakpoint commands refer.

   第二引数を指定する場合、その値は式で、その評価値が真でなければブレ
   ークポイントは有効になりません。

   引数なしの場合は、それぞれのブレークポイントに対して、そのブレーク
   ポイントに行き当たった回数、現在の通過カウント ( ignore count ) と
   、もしあれば関連条件を含めてすべてのブレークポイントをリストします
   。

tbreak [[*filename*:]*lineno* | *function*[, *condition*]]
   Temporary breakpoint, which is removed automatically when it is
   first hit.  The arguments are the same as break.

cl(ear) [*filename:lineno* | *bpnumber* [*bpnumber …*]]
   *filename:lineno* 引数を与えると、その行にある全てのブレークポイン
   トを解除します。スペースで区切られたブレークポイントナンバーのリス
   トを与えると、それらのブレークポイントを解除します。引数なしの場合
   は、すべてのブレークポイントを解除します ( が、はじめに確認します )
   。

disable [*bpnumber* [*bpnumber …*]]
   Disables the breakpoints given as a space separated list of
   breakpoint numbers. Disabling a breakpoint means it cannot cause
   the program to stop execution, but unlike clearing a breakpoint, it
   remains in the list of breakpoints and can be (re-)enabled.

enable [*bpnumber* [*bpnumber …*]]
   Enables the breakpoints specified.

ignore *bpnumber* [*count*]
   Sets the ignore count for the given breakpoint number.  If count is
   omitted, the ignore count is set to 0.  A breakpoint becomes active
   when the ignore count is zero.  When non-zero, the count is
   decremented each time the breakpoint is reached and the breakpoint
   is not disabled and any associated condition evaluates to true.

condition *bpnumber* [*condition*]
   Condition is an expression which must evaluate to true before the
   breakpoint is honored.  If condition is absent, any existing
   condition is removed; i.e., the breakpoint is made unconditional.

commands [*bpnumber*]
   Specify a list of commands for breakpoint number *bpnumber*.  The
   commands themselves appear on the following lines.  Type a line
   containing just 『end』 to terminate the commands. An example:

      (Pdb) commands 1
      (com) print some_variable
      (com) end
      (Pdb)

   To remove all commands from a breakpoint, type commands and follow
   it immediately with  end; that is, give no commands.

   *bpnumber* 引数が指定されない場合、最後にセットされたブレークポイン
   トを参照することになります。

   You can use breakpoint commands to start your program up again.
   Simply use the continue command, or step, or any other command that
   resumes execution.

   実行を再開するコマンド (現在のところ continue, step, next, return,
   jump, quit とそれらの省略形) によって、コマンドリストは終了するもの
   と見なされます (コマンドにすぐ end が続いているかのように)。という
   のも実行を再開すれば (それが単純な next や step であっても) 別のブ
   レークポイントに到達するかもしれないからです。そのブレークポイント
   にさらにコマンドリストがあれば、どちらのリストを実行すべきか状況が
   曖昧になります。

   コマンドリストの中で 『silent』 コマンドを使うと、ブレークポイント
   で停止したという通常のメッセージはプリントされません。この振る舞い
   は特定のメッセージを出して実行を続けるようなブレークポイントでは望
   ましいものでしょう。他のコマンドが何も画面出力をしなければ、そのブ
   レークポイントに到達したというサインを見ないことになります。

   バージョン 2.5 で追加.

s(tep)
   現在の行を実行し、最初に実行可能なものがあらわれたときに (呼び出さ
   れた関数の中か、現在の関数の次の行で) 停止します。

n(ext)
   Continue execution until the next line in the current function is
   reached or it returns.  (The difference between "next" and "step"
   is that "step" stops inside a called function, while "next"
   executes called functions at (nearly) full speed, only stopping at
   the next line in the current function.)

unt(il)
   Continue execution until the line with the line number greater than
   the current one is reached or when returning from current frame.

   バージョン 2.6 で追加.

r(eturn)
   現在の関数が返るまで実行を継続します。

c(ont(inue))
   ブレークポイントに出会うまで、実行を継続します。

j(ump) *lineno*
   次に実行する行を指定します。最も底のフレーム中でのみ実行可能です。
   前に戻って実行したり、不要な部分をスキップして先の処理を実行する場
   合に使用します。

   It should be noted that not all jumps are allowed — for instance it
   is not possible to jump into the middle of a "for" loop or out of a
   "finally" clause.

l(ist) [*first*[, *last*]]
   List source code for the current file.  Without arguments, list 11
   lines around the current line or continue the previous listing.
   With one argument, list 11 lines around at that line.  With two
   arguments, list the given range; if the second argument is less
   than the first, it is interpreted as a count.

a(rgs)
   現在の関数の引数リストをプリントします。

p *expression*
   現在のコンテキストにおいて *expression* を評価し、その値をプリント
   します。

   注釈: "print" can also be used, but is not a debugger command —
     this executes the Python "print" statement.

pp *expression*
   Like the "p" command, except the value of the expression is pretty-
   printed using the "pprint" module.

alias [*name* [command]]
   Creates an alias called *name* that executes *command*.  The
   command must *not* be enclosed in quotes.  Replaceable parameters
   can be indicated by "%1", "%2", and so on, while "%*" is replaced
   by all the parameters.  If no command is given, the current alias
   for *name* is shown. If no arguments are given, all aliases are
   listed.

   Aliases may be nested and can contain anything that can be legally
   typed at the pdb prompt.  Note that internal pdb commands *can* be
   overridden by aliases. Such a command is then hidden until the
   alias is removed.  Aliasing is recursively applied to the first
   word of the command line; all other words in the line are left
   alone.

   例として、二つの便利なエイリアスがあります (特に ".pdbrc" ファイル
   に置かれたときに):

      #Print instance variables (usage "pi classInst")
      alias pi for k in %1.__dict__.keys(): print "%1.",k,"=",%1.__dict__[k]
      #Print instance variables in self
      alias ps pi self

unalias *name*
   Deletes the specified alias.

[!]*statement*
   Execute the (one-line) *statement* in the context of the current
   stack frame. The exclamation point can be omitted unless the first
   word of the statement resembles a debugger command. To set a global
   variable, you can prefix the assignment command with a "global"
   command on the same line, e.g.:

      (Pdb) global list_options; list_options = ['-l']
      (Pdb)

run [*args* …]
   Restart the debugged Python program. If an argument is supplied, it
   is split with 「shlex」 and the result is used as the new sys.argv.
   History, breakpoints, actions and debugger options are preserved.
   「restart」 is an alias for 「run」.

   バージョン 2.6 で追加.

q(uit)
   Quit from the debugger. The program being executed is aborted.

-[ 脚注 ]-

[1] フレームが属するモジュールは、そのフレームのグローバルの
    "__name__" によって決定されます。
