VSCodeを使ったPythonのリモートデバッグ

VSCodeとPythonのリモートデバッグ

VSCodeは、リモートマシン上で動作するPythonプログラムのデバッグを可能にします。以下に、その手順を説明します。

1. 必要なツールのインストール

まず、VSCodeとOpenSSHをローカルマシンにインストールします。次に、VSCodeのExtensionボタンから、Japanese Language PackとPythonのExtensionをインストールします。

2. リモートマシンのPython環境の設定

リモートマシン（ここではCentOS7を例に）にPython3がインストールされていなければ、インストールします。そして、リモートマシン上でPythonスクリプトを実行するためのディレクトリを作成します。

3. デバッグセッションの開始

Pythonプログラムを実行する前に、debugpyを起動してリモートデバッグセッションを開始する必要があります。これには、以下のコードをPythonスクリプトの先頭に追加します。

import debugpy
debugpy.listen(('0.0.0.0', 5678))
print("Waiting for debugger attach")
debugpy.wait_for_client()

4. SSHトンネリングの設定

ローカルマシンからリモートマシン上のdebugpyに接続するために、SSHトンネリングを使用します。これには、以下のコマンドを使用します。

ssh -i ~/.ssh/<pem-key> -L 5678:localhost:5678 ubuntu@<public-ip>

5. VSCodeでのデバッグセッションの開始

最後に、VSCodeでデバッグセッションを開始します。これには、VSCodeのlaunch.jsonファイルに以下の設定を追加します。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Remote Attach",
            "type": "python",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}",
                    "remoteRoot": "<current directory>"
                }
            ]
        }
    ]
}

以上が、VSCodeを使ったPythonのリモートデバッグの基本的な手順です。これにより、ローカルマシンからリモートマシン上のPythonプログラムをデバッグすることが可能になります。