🐈

VS code上でdocker環境をつなげてみた

2022/11/03に公開

目的:VScode上で予め用意されたdocker環境でデバッグを行えるようにする

※基本的には参考記事①に従うとリモートデバッグ可能となるため、主に詰まった箇所を補足いたします。

実行環境
M-1 Mac
VScode

実行手順

任意のディレクトリ(ここではvscode-python)に「.devcontainer」ディレクトリを作成する。
次に作成した.devcontainer配下にdevcontainer.jsonを作成する。これによりDockerFileを参照しイメージコンテナが作られる。
参考記事①より

devcontainer.json
{
	"name": "Python Sample",
	// Dockerfileでイメージ・コンテナを作成
	"dockerFile": "Dockerfile",
	// リモート先のVS Codeにインストールする拡張機能
	"extensions": [
		"ms-python.python"
	],
}

次に参照されるDockerFileの中身を以下のように記述する。
ここではpython3.9-busterイメージを用いてpython3.9を使用する。

DockerFile
FROM python:3.9-buster

ここからはVScode上で操作を行います。

VScode上の左下に上図のような緑色のマークがあるので、押下する。

次に「Open Folder in container」をクリックし、はじめに作成したvscode-pythonを選択してください。
これを行うことでコンテナがビルドされます。

最後にtest.pyを次のように記述し実行できるか確認します。

test.py
print("Hello World")


「実行」の「デバックの開始」を押下すると、ターミナルに「Hello World」と表示されます。

コンテナ起動時にインストールするモジュールを設定したり、
使用するコンテナイメージを変更しrebuildする方法などは記事①を参考にしてください!

参考記事:

【VS Code】Dockerコンテナの環境でリモート開発【Win/Mac】
https://chigusa-web.com/blog/vs-codeでdockerのpython環境でリモート開発/

Discussion