Vscodeとdevcontainerで実現する簡単Python環境構築

サクッとPythonの実行環境を整えたい時、ありますよね。でも、ローカル環境をいじりたくないという気持ちも分かります。
「そんなときには、devcontainerを使ってみませんか？」
devcontainerは、環境の一貫性を保ちながら、チームメンバー間での開発環境の共有を容易にするツールです。
今回は、データ分析で頻繁に使用されるPandasライブラリを含むPythonの開発環境の構築方法をご紹介します。

開発環境

• WSL Ubuntu 22.04.3 LTS
• Visual Studio Code(Vscode)
• Docker Desktop

前提

Docker DesktopとVscodeが既にセットアップされていることが前提です。
まだの方は、公式サイトからダウンロードし、基本的な初期設定を行ってください。
また、VscodeでのRemote - Containers拡張機能のインストールが必要です。これにより、Vscodeから直接コンテナ内で作業を開始できます。

目標

Pandasライブラリを使用できるPythonの開発環境をDev Containersを通じて構築します。

手順

• Docker Desktopを起動する
• ローカルの任意のディレクトリに作業ディレクトリを作成する
• Vscodeのコマンドパレットからコンテナを作成する
• pandasのインポート

Docker Desktopを起動する

ローカルの任意のディレクトリに作業ディレクトリを作成する

今回はworkspace/以下に作業ディレクトリを作成していきます。

mkdir python-playground

次に作成した作業ディレクトリに移動します。

cd python-playground

移動したらVscodeを起動しましょう。

code .

Vscodeのコマンドパレットからコンテナを作成する

「Show and Run Commands」を選択します。

次に「Dev Containers: Open Folder in Container」を選択します。

現在のディレクトリが選択されていると思うので、そのまま「OK」を押します。

次に言語の選択をしていきます。
言語としてPython3を、バージョンは3.12を選択します。ここで、特に追加機能は指定せずに進みます。

バージョンは今回3.12を使用します。

今回は追加機能を特に指定せず、そのまま「OK」を押します。
少し時間がかかりますが、コンテナが作成されます。

Vscode左下の表示が「開発コンテナー」となっていることを確認します。
ターミナルを開き、Pythonのバージョンを確認してみましょう。

これでPythonの環境構築完了です！
簡単ですね。

Pandasのインポート

devcontainer.jsonに"postCreateCommand": "pip install pandas"を追加し、コンテナの再構築を行います。これで、Pandasがインストールされます。

devcontainer.json

...
"postCreateCommand": "pip install pandas"
...

構成ファイルを編集したので、右下のボタンを押して「Rebuild」します。

最後に、Pandasを使ってCSVファイルを読み込む簡単なスクリプトを作成し、動作確認を行います。
sample.csvファイルを準備し、以下のようなスクリプトで読み込みます。

ちゃんと実行できていますね。
実行したスクリプトは以下です

main.py

import pandas as pd

def read_and_print_csv(file_path):
    df = pd.read_csv(file_path)
    print(df)

if __name__ == "__main__":
    file_path = 'sample.csv'
    read_and_print_csv(file_path)

まとめ

devcontainerを使用することで、Vscodeで数回クリックするだけで、必要な実行環境を素早く簡単に構築できます。
この方法は、Pythonだけでなく、他の言語やフレームワークにも適用可能です。
いろいろ試してみたいですね！