Python×VSCodeでライブラリの中身までデバッグする方法

はじめに

VSCodeでPythonをデバッグする際に、 ライブラリの中身 までデバッグする方法についてです。

ライブラリの中身をデバッグしたい時ってありますよね。

私はこれまであまりPythonを使ったことがなかったのですが、最近は業務で利用する機会が増えました。

そして先日、ライブラリの中身をデバッグしたい状況になりました。

(デフォルトだとできないことに少し驚きましたが、)基本的には@timtoronto634さんの記事を参考させていただくことで、実現することができました。

ただ、少し躓いた部分があったので、より詳しいポイントを記載した記事を作成しました。

流れ

おおまかに以下の流れです。

1. デバッグの構成ファイルである「launch.json」を作成
2. 「launch.json」を編集
3. 「launch.json」を利用する形で実行

詳細

【STEP1】デバッグの構成ファイルである「launch.json」を作成

1. 「実行とデバッグ」の「launch.jsonファイルを作成します」をクリックします
   

2. 1つ目の「Python Debugger」を選択します
   

3. 1つ目の「Python ファイル」を選択します
   

4. launch.jsonが作成されました
   

ちなみに公式としてはこちらに記載されているようです。
https://code.visualstudio.com/docs/python/debugging#_initialize-configurations

【STEP2】「launch.json」を編集

@timtoronto634さんの記事のとおりですので、ここでは割愛します。
(configurationに「"justMyCode":false」を追加します)

【STEP3】「launch.json」を利用する形で実行

1. (デバッグ実行の方法はいくつかあるかと思いますが、)右上のアイコンより、一番下の「Pythonデバッガー：launch.jsonを利用したデバッグ」を選択して実行します
   

2. 一番上を選択します(これで起動します)
   

3. ブレイクポイントでステップインすると、
   

4. 無事にライブラリの中身に進むことができました
   

ちなみに、下から2つ目(「Pythonデバッガー：Pythonファイルのデバッグ」)を選択した場合には、ブレイクポイントには止まりますが、ステップインを押してもライブラリの中身に進むことができません。
(私はこれにはまりました)

さいごに

振り返れば、冷静に考えたらわかる内容だったかなと思う面はあります。

ただ、私のようにVSCodeとPythonに不慣れで、急いでいるときはなかなか気づかないこともあるのではないかと思いまして、そのような方のお役に立てば幸いです。