Python 自動デバッグ

概要

デバッガーを実行してください。実行する予定だけでなく。

このスキルは debug_session.py を使用して非対話型の pdb セッションを実行します。コマンドを事前に指定し、実行して、出力を分析し、反復します。macOS/Linux のみで動作します。

使用時期

• テストが 2 回以上失敗している、修正にもかかわらず
• コードは正しく見えるが、動作が異なる
• コードを読むのではなく、ランタイム状態を確認する必要がある
• print 文では問題が明らかにならない

サイクル

digraph debug_cycle {
    rankdir=LR;
    "Form Hypothesis" -> "Write pdb commands";
    "Write pdb commands" -> "RUN debug_session.py";
    "RUN debug_session.py" -> "Analyze output";
    "Analyze output" -> "Hypothesis confirmed?" [style=invis];
    "Hypothesis confirmed?" [shape=diamond];
    "Hypothesis confirmed?" -> "Fix bug" [label="yes"];
    "Hypothesis confirmed?" -> "Form Hypothesis" [label="no - new hypothesis"];
}

ツールを実際に実行する必要があります。 実行予定をたてるのはデバッグではありません。

ツール使用方法

場所: このスキルのディレクトリにある debug_session.py

# 基本的な使用方法
python debug_session.py <script.py> "cmd1" "cmd2" ... "q"

# モジュールをデバッグ
python debug_session.py -m <module> "cmd1" "cmd2" "q"

# 出力を保存
python debug_session.py <script.py> "cmd1" "cmd2" "q" --output debug.log

常に q で終了 してください。ハングを避けるためにクリーンに終了します。

セッション例

キャッシングバグを調査:

python debug_session.py test_file.py \
    "b process_item" \
    "c" \
    "p multiplier" \
    "p self.cache" \
    "c" \
    "p multiplier" \
    "p self.cache" \
    "q"

仮説: キャッシュが更新されていない。コマンドは 2 つの呼び出しにわたる状態を比較します。

予期しない None 戻り値をトレース:

python debug_session.py buggy.py \
    "b compute_result" \
    "c" \
    "a" \
    "n" \
    "n" \
    "p intermediate" \
    "p result" \
    "w" \
    "q"

仮説: 中間計算が失敗している。コマンドは関数をトレースします。

例外の発生元をデバッグ:

python debug_session.py crash.py \
    "c" \
    "w" \
    "pp locals()" \
    "l" \
    "q"

クラッシュさせてから、クラッシュポイントのスタックとローカル変数を検査します。

反復が予想されます

最初のデバッグ実行が完全な答えを与えることはめったにありません。一般的なパターン:

1. 実行 1: ブレークポイントを設定、明らかな変数を出力 → どの変数が間違っているか発見
2. 実行 2: その変数がどこで設定されるかをトレース → キャッシュされていることを発見
3. 実行 3: 複数の呼び出しにわたるキャッシュ動作を検査 → バグを発見

各実行は検索範囲を狭めます。同じデバッグセッションを繰り返さない - 各反復は新しい仮説をテストするか、前の実行で学んだことを調査すべきです。

よくある間違い

間違い	修正方法
コマンドを計画するが実行しない	debug_session.py をすぐに実行
同じデバッグセッションを繰り返す	各実行は異なる仮説をテストする
1 つの大規模なデバッグセッション	各セッションは 1 つの仮説をテストする複数の焦点を絞ったセッション
最後の q を忘れる	常に q で終了してハングを避ける
仮説なしでデバッグ	実行前に何を発見することを期待するか述べる

赤信号 - 実際にはデバッグしていない場合

• 「〜を実行するだろう」→ 今すぐ実行
• 「使用するコマンドは〜」→ 実行する
• 「コードを読むに基づいて〜」→ コード読みではなくランタイムデータが必要
• 異なる結果を期待して同じセッションを繰り返す → 新しい仮説が必要