VSCodeでPythonライブラリのデバッグ方法

VSCodeでPythonのライブラリをデバッグする方法について解説します。この記事はPythonを使ったプログラミング全般に応用できる内容になっています。

ライブラリのデバッグ設定

VSCodeでは、Pythonプラグイン（拡張機能）を導入することで簡単にステップ実行等のデバッグを行うことができます。ただし、初期状態では、ステップ実行等が行えるのは内部モジュール（自身で作成しているPythonスクリプト）のみです。

一方、importを行って使用している外部モジュールや外部ライブラリについてはステップ実行等のデバッグが行えません。しかし、justMyCode設定をfalseにすることで、これらの外部モジュール・外部ライブラリも含めてVSCodeでデバッグを行うことが可能になります。

設定方法

この設定はlaunch.jsonで行います。launch.jsonに下記のようにjustMyCode設定の追記を行います。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": false
        }
    ]
}

これだけで外部モジュールに対してステップイン実行等のデバッグが行えるようになります。

注意点

ただし、justMyCodeでデバッグできる外部ライブラリは.pyファイルの部分のみです。Python以外で作成された.soファイル等で提供されているライブラリに関しては別の方法を利用する必要があります。

以上がVSCodeでPythonのライブラリをデバッグする方法になります。この設定を行うことで、外部モジュールでエラーが発生した原因が解明できるだけでなく、外部モジュールの作りが理解できるなど、デバッグの幅が広がります。.