こんにちは！日々のPythonでのデバッグ作業、お疲れ様です。
突然ですが、皆さんはコードが意図通りに動かないとき、どのようにバグを追跡していますか？
「あちこちに `print()` を仕込んでは実行し、終わったら消す」という泥臭い方法をやっていないでしょうか。あるいは、標準の `pdb` を起動したはいいものの、今自分がどのファイルにいて、どんな変数の状態だったかを忘れてしまい、毎回 `l` (list) コマンドや `p` (print) コマンドを叩いていませんか？
実は、デバッグ中の「今どこにいるんだっけ？」という脳のコンテキストスイッチ（文脈の切り替え）こそが、開発者の集中力を削ぎ、疲労を蓄積させる最大の原因です。
今回は、Python標準のデバッガである `pdb`（およびその高機能版 `IPdb`）のプロンプトを魔改造し、「現在地（ファイル名・行数）」や「特定の変数の状態」をプロンプト（入力待ちの行）に常時インジケーターとして表示させる裏技をご紹介します。
これをマスターすれば、`pdb` が単なる「止めるツール」から「全知全能のコックピット」へと生まれ変わり、毎日のコーディングが劇的に楽になりますよ。さあ、一緒にその扉を開けてみましょう！
—
1. なぜ `pdb` のプロンプトをカスタマイズするのか？
まず、私たちが普段目にする標準の `pdb` のプロンプトを思い出してください。
(Pdb)
あまりにもそっけない、ただの文字列ですね。この中で止まったとき、私たちは次のような思考プロセスをたどります。
1. 「お、止まったな。ここどこだっけ？」 -> `l` を打つ。
2. 「あぁ、このループの中か。カウンタ `i` の値はいくつだ？」 -> `p i` を打つ。
3. 「じゃあ次のステップに進もう」 -> `n` を打つ。
これ、小さなストレスの積み重ねだと思いませんか？
もし、プロンプト自体が次のように変化してくれたらどうでしょう？
[app.py:42 | i=5, status=RUNNING] (Pdb)
わざわざコマンドを打たなくても、目線を動かすだけで「現在地」と「監視したい変数」が飛び込んでくる。このわずかな認知負荷の軽減が、複雑なバグを追うときの脳のメモリを解放し、問題解決のスピードを何倍にも引き上げてくれるのです。
—
2. ツールのご紹介と基本セットアップ
今回は、標準の `pdb` だけでなく、シンタックスハイライトやタブ補完が効いて圧倒的に使いやすい `ipdb` をベースに解説を進めます（裏側で標準の `pdb` の仕組みを拡張しているため、考え方は全く同じです）。
インストール
まずは、必要なパッケージをサクッとインストールしましょう。ターミナルを開いて以下のコマンドを実行してください。
高機能なIPythonベースのデバッガと、カラー表示のためのパッケージをインストール
pip install ipdb
これだけで、コード内の好きな場所で `import ipdb; ipdb.set_trace()` と書くだけで、リッチなデバッグ環境が手に入ります。
—
3. 魔法の鍵：`PYTHONSTARTUP` による起動時フック
「でも、デバッガが起動するたびにそんな面倒な設定を書くのは嫌だな…」と思いましたか？ご安心ください。Pythonには、対話モードやデバッガが立ち上がるときに自動実行される初期化ファイルを指定する仕組みがあります。それが環境変数 `PYTHONSTARTUP` です。
これを利用して、`ipdb`（および `pdb`）が起動した瞬間に、プロンプトの見た目をプログラムで書き換えてしまいましょう。
ホームディレクトリに設定ファイルを作成する
お使いのPCのホームディレクトリ（Windowsなら `C:\Users\<ユーザー名>`、Mac/Linuxなら `/home/<ユーザー名>` または `~`）に、`.pdbrc.py` というファイルを作成します。
このファイルは、`pdb` が起動する瞬間にPythonスクリプトとして読み込まれます。ここに、プロンプトをカスタマイズするロジックを記述します。
以下のコードを `~/.pdbrc.py` として保存してください。
~/.pdbrc.py
pdb / ipdb が起動したときに自動読み込みされる設定スクリプト
import sys
import os
pdbのクラスを拡張するためのモジュールをインポート
try:
from pdb import DefaultConfig
except ImportError:
# 標準pdb環境へのフォールバック（簡易設定）
class DefaultConfig:
prompt = ‘(Pdb) ‘
class MyPdbConfig(DefaultConfig):
“””
pdbの動作や見た目をカスタマイズするための設定クラス
“””
# デバッガのプロンプトを動的に書き換えるプロパティ
@property
def prompt(self):
“””
このメソッドはプロンプトが表示されるたびに評価されます。
ここで現在のフレーム情報を取得し、プロンプト文字列を動的に組み立てます。
“””
try:
# 現在実行が停止しているフレーム（スタックフレーム）を取得
frame = sys._getframe().f_back
# 実行中のファイル名（パスからファイル名だけを抽出）と行番号を取得
filename = os.path.basename(frame.f_code.co_filename)
lineno = frame.f_lineno
# — 【裏技】特定の変数をインジケーターとしてリアルタイムに覗き見する —
# 例として、ローカル変数に ‘user_id’ や ‘status’ があればそれを抽出し、なければ ‘N/A’ にする
local_vars = frame.f_locals
user_id = local_vars.get(‘user_id’, ‘N/A’)
status = local_vars.get(‘status’, ‘N/A’)
# 開発者が一目で状況を把握できるカスタムプロンプトを構築
# 例: [main.py:15 | user_id=1042, status=active] (Pdb)
custom_prompt = f”[{filename}:{lineno} | uid={user_id}, st={status}] (Pdb) ”
return custom_prompt
except Exception:
# 万が一フレーム情報が取れなかった場合の安全なフォールバック
return “(Pdb) ”
設定をpdbに適用する（IPdbがこの設定クラスを読み取ります）
c = MyPdbConfig()
—
4. 精度高い HelloWorld 的な動作確認
理屈はここまでにして、実際にこのカスタムプロンプトがどのように動くのか、簡単なサンプルコードを作って体験してみましょう。
適当なディレクトリに `test_debug.py` というファイルを作成し、以下のコードを記述してください。
test_debug.py
import ipdb
def process_user_data(user_id: int, status: str):
“””
ユーザーデータを処理するダミー関数
“””
# わざとここで処理を一時停止させ、インジケーターの動作を確認する
# この時、ローカル変数である user_id と status がプロンプトに反映されるはずです
ipdb.set_trace()
# 処理のシミュレーション
result = f”User {user_id} is currently {status}.”
return result
if __name__ == “__main__”:
# テスト用の変数を定義して関数を呼び出す
target_user_id = 9999
current_status = “PENDING”
print(“デバッグセッションを開始します…”)
process_user_data(user_id=target_user_id, status=current_status)
実行と検証
ターミナルからこのスクリプトを実行してみましょう。
python test_debug.py
実行すると、コード内の `ipdb.set_trace()` で処理が一時停止し、次のようなリッチなプロンプトがあなたを迎え入れてくれるはずです！
デバッグセッションを開始します…
> /path/to/test_debug.py(11)process_user_data()
-> ipdb.set_trace()
↓↓↓ ここに注目！コードを変更しなくても、現在地と変数の値がプロンプトに直結している！ ↓↓↓
[test_debug.py:11 | uid=9999, st=PENDING] (Pdb)
どうですか？ `l` コマンドを打つ必要も、`p user_id` を打つ必要もありません。プロンプトを見るだけで、「今 `test_debug.py` の11行目にいて、`user_id` は `9999`、`status` は `PENDING` の状態で止まっている」という事実が脳にダイレクトに飛び込んできます。
あとは、ここで普通に `n`（次の行へ）を進めたり、変数の値を書き換えたりしてデバッグを進めるだけです。
—
5. 現場のプロとして知っておくべきアーキテクチャの裏側
なぜ、この設定ファイル（`~/.pdbrc.py`）だけでこのような魔法が実現できるのでしょうか？
背後にある仕組みを少しだけ技術的な視点で解説しておきます。
1. `sys._getframe()` の魔力:
Pythonの標準ライブラリ `sys` に備わる `_getframe()` は、現在実行中のCPythonのコールスタックフレームへの参照を直接取得する低レベルなAPIです。これを利用することで、デバッガ内部から「自分がどこから呼ばれたか」「そのスコープにはどんな変数があるか」を自由自在に覗き見ることができます。
2. 動的な評価（Evaluation on Demand）:
`prompt` を通常の文字列ではなく、`@property` を使ったメソッド（あるいはゲッター）にすることで、プロンプトが描画される「その瞬間」に関数が実行されます。これにより、ステップ実行（`n` や `s`）で行や変数の値が変わるたびに、プロンプトのインジケーターもリアルタイムに更新されるという極めて高い利便性が生まれます。
—
まとめ
今回は、`PYTHONSTARTUP` と `ipdb` を駆使して、現在地や変数を常時表示するカスタムプロンプトの自作方法をご紹介しました。
たったこれだけの工夫ですが、デバッグ中の「あれ、今の変数なんだっけ？」というプチストレスが消え去るだけで、コードの構造を直感的に捉える能力（メンタルモデルの構築速度）が跳ね上がります。
「たかがプロンプト、されどプロンプト」。開発環境の細部にまでこだわり、自分の手足のようにカスタマイズしていくことこそが、一流のエンジニアへの確実な第一歩です。
これをマスターすれば、毎日のコーディングが劇的に楽になりますよ。ぜひ、あなたの開発環境にも取り入れてみてくださいね！