VSCodeで手軽にpythonを勉強したい人のための環境構築（for Mac） #Python

はじめに

「さぁ、Pythonの勉強をしよう」
と、思い立って環境を作るところから始めようと調べ始めると、
「Homebrewが…」「Pathを確認して…」「デフォルトのバージョンが…」などと
初心者の心を折ろうとする分岐がいくつも存在すると感じるのは私だけでしょうか？

色々やり方はあるかと思いますが、
私はシンプルにDockerとVisual Studio Code(以下、VSCode)の拡張機能を使って環境を作るのが
面倒なく楽なのではないかと感じましたので、それを記録として残しておきます。

もっとオススメがあるよ、という方はコメントいただければ幸いです。

インストール

それぞれ公式サイトよりダウンロード、インストールします。

Docker Desktop

Visual Studio Code

Dockerは仮想マシンを作ることが出来るサービスです。
こちらは初めて使用する際はアカウントを作る必要があります。

VSCodeのインストールはこちらの記事がとてもわかり易いです。
MacOSでVisual Studio Codeをインストールする手順

VSCodeに拡張機能を入れる

VSCodeを開く。
拡張機能からRemote - Containersをインストールする。

ディレクトリとファイルを準備する

新しくフォルダを作成する
.devcontainerという名前のフォルダを作る
その中にdevcontainer.jsonというファイルを作る
1.のフォルダにはDockerfileとdocker-compose.yamlという2つのファイルを作成する

各種設定ファイルを書く

1. Dockerfile

pythonのバージョンを3.9に指定しています。
VSCode内でソースコードを自動整形するためのautopep8と、
コード解析ツールのpylintも一緒に入れておきます。

Dockerfile

FROM python:3.9
USER root

RUN apt-get update && apt-get -y install locales git wget unzip vim && \
    localedef -f UTF-8 -i ja_JP ja_JP.UTF-8
ENV LANG ja_JP.UTF-8
ENV LANGUAGE ja_JP:ja
ENV LC_ALL ja_JP.UTF-8
ENV TZ JST-9
ENV TERM xterm

ARG DEBIAN_FRONTEND=noninteractive

RUN pip install -U pip && \
    pip install -U autopep8 && \
    pip install -U pylint

VOLUME /root/

2. docker-compose.yaml

後でVSCodeがこのファイルを見てbuildとup -dをしてくれます。

docker-compose.yaml

version: "3.8"
services: 
  python3.9:
    build: 
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/root/
    working_dir: /root/
    tty: true

3. devcontainer.json

このファイルが無くても上記で出来る環境を使用できますが、
VSCodeから簡単に環境の中に入るにはこのファイルが必要です。

（※このファイルは.devcontainerフォルダの中に置いて下さい）
（Finderから隠しファイル表示を切り替えるにはcommand + shift + .(ピリオド)で可能）

devcontainer.json

{
    "name": "Python3.9",

    "dockerComposeFile": [
        "../docker-compose.yml"
    ],

    "service": "python3.9",

    "workspaceFolder": "/root/",

    "settings": { 
        "terminal.integrated.shell.linux": null
    },

    "extensions": [
        "ms-ceintl.vscode-language-pack-ja",
        "ms-python.python",
        "oderwat.indent-rainbow",
        "almenon.arepl"
    ]
}

extensionsには、以下の内容の拡張機能を自動でインストールするようにしています。
* VSCodeを日本語化する「Japanese Language Pack」

* Pythonのための「Python」

* インデントを見やすくする「indent-rainbow」

* リアルタイムでデバッグしてくれる「AREPL for python」