VSCodeでPythonのデバッグを行う方法

VSCodeは、Pythonを含む多くのプログラミング言語でデバッグを行うことができます。デバッグの設定は、.vscode/launch.jsonという設定ファイルで統一的に記述できます。

デバッグの流れ

VSCodeでデバッグを行う際の基本的な流れは以下の通りです。

1. サイドバーの「デバッグと実行」から.vscode/launch.jsonを作成します。
2. ソースコードにブレークポイントを設定します。ソースコード内でF9キーを押すか、ソースコードの左側をクリックで設定可能です。
3. デバッグを開始します。F5キーを押すか、デバッグビューの開始ボタンをクリックして開始できます。
4. ブレークポイントでプログラムが停止し、デバッグビューで変数の値が確認できます。F10 (ステップイン)やF11 (ステップオーバー)を使ってプログラムを一行ずつ実行していきます。

launch.jsonの設定

デバッグの設定は、.vscode/launch.jsonファイルに記載できます。このファイルは、サイドバーの「デバッグと実行」から自動的に作成されます。

以下はlaunch.jsonの一例です。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Main File",
            "type": "python",
            "request": "launch",
            "program": "main.py",
            "args": ["arg1", "arg2"], // コマンドライン引数を指定
            "console": "integratedTerminal"
        },
        {
            "name": "Python: FastAPI",
            "type": "python",
            "request": "launch",
            "module": "uvicorn",
            "args": ["api.server:app", "--host", "0.0.0.0", "--reload"], // apiディレクトリ直下のserver.pyを実行
            "cwd": "${workspaceFolder}",
            "jinja": true
        }
    ]
}

この設定ファイルを用いて、VSCodeでPythonのデバッグを行うことができます。具体的なデバッグの手順や設定方法については、参考リンクをご覧ください。