23.2.9.2 Example オブジェクト

23.2.9.2 Example オブジェクト

クラス Example( source, want[, exc_msg][, lineno][, indent][, options]): ひとつの Python 文と、それに対する予想出力からなる、単一の対話的モードの例題です。コンストラクタの引数は Example インスタンス中の同名のメンバ変数の初期化に使われます。バージョン 2.4 で新たに追加された仕様です。

Example では、以下のメンバ変数を定義しています。これらの変数はコンストラクタで初期化されます。直接変更してはなりません。

source: 例題のソースコードが入った文字列です。ソースコードは単一の Python で、末尾は常に改行です。コンストラクタは必要に応じて改行を追加します。

want: 例題のソースコードを実行した際の予想出力 (標準出力と、例外が生じた場合にはトレースバック) です。want の末尾は、予想出力が全くない場合を除いて常に改行になります。予想出力がない場合には空文字列になります。コンストラクタは必要に応じて改行を追加します。

exc_msg: 例題が例外を生成すると予想される場合の例外メッセージです。例外を送出しない場合には None です。この例外メッセージは、traceback.format_exception_only() の戻り値と比較されます。値が None でない限り、exc_msg は改行で終わっていなければなりません; コンストラクタは必要に応じて改行を追加します。

lineno: この例題の入っている文字列中における、例題の実行文のある行のの行番号です。行番号は文字列の先頭をゼロとして数えます。

indent: 例題の入っている文字列のインデント、すなわち例題の最初のプロンプトより前にある空白文字の数です。

options: オプションフラグを True または False に対応付けている辞書です。例題に対するデフォルトオプションを上書きするために用いられます。この辞書に入っていないオプションフラグはデフォルトの状態 (DocTestrunner の optionflags の内容) のままになります。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。