VSCodeのDevcontainerでpython環境構築

VSCodeのDevcontainerアップデートで記載方法が変わっていたので備忘録として、簡単な環境構築をまとめてみました。

環境

・Visual Studio Code
・Docker Desktop

VSCodeの拡張機能として以下をインストール
・Dev Containers

サンプル構成

sample/
  ┣ .devcontainer
  ┃   ┗ devcontainer.json
  ┃
  ┗ sample.py

devcontainer.json

{
    // 接続するコンテナの名前
    "name": "Python 3.11 Dev",

    // 利用するコンテナイメージ
    "image": "python:3.11-slim",

    // コンテナ起動時のホストとの疎通ポート
    "forwardPorts": [
        5000
    ],

    // コンテナビルド時に実行したいコマンド
    "postCreateCommand": "apt-get update && pip3 install requests",

    // 利用したいVSCodeの拡張機能
    "customizations": {
        "vscode": {
            "extensions": [
                "ms-python.python",
                "ms-python.vscode-pylance"
            ]
        }
    }
}

sample.py

def main():
    print('Hello, World!')

if __name__ == '__main__':
    main()

コンテナ起動

VSCodeのコマンドパレットにて以下コマンドを実行
Rebuild and Reopen in Container

ビルド前は開いているフォルダが表示される

ビルド後は接続しているコンテナが表示される

動作検証

sample.pyを実行するとコンテナ環境内でPythonコードが実行される

root@931306:/workspaces/sample# /usr/local/bin/python /workspaces/sample/sample.py
Hello, World!
root@931306:/workspaces/sample# 

公式ドキュメント

PythonのDevcontainerテンプレート

参考