【MacOS】PythonをインストールしてVSCodeの実行環境をつくる【Python】

pyenvとは？

「pyenv」は、Pythonのバージョンを簡単に切り替えることができるツールです。

準備

①MacにVScodeをインストールします。

→MacOSでVisual Studio Codeをインストール

pyenvをインストール

①ターミナルを起動します。

②ホームディレクトリに移動します。

cd ~/

③pyenvをホームディレクトリの 「.pyenv」にcloneします。

git clone https://github.com/pyenv/pyenv.git ~/.pyenv

Cloning into '/Users/iwasakiyuta/.pyenv'...
remote: Enumerating objects: 19, done.
remote: Counting objects: 100% (19/19), done.
remote: Compressing objects: 100% (16/16), done.
remote: Total 18370 (delta 3), reused 10 (delta 2), pack-reused 18351
Receiving objects: 100% (18370/18370), 3.70 MiB | 535.00 KiB/s, done.
Resolving deltas: 100% (12507/12507), done.

④viコマンドで「.zshrc」を編集します。

vi ~/.zshrc

以下の記述をします。記述したら「:wq」コマンドで保存しましょう。

export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"

シェルを再起動します。

source ~/.zshrc

再起動後、pyenv コマンドが使用可能になります。

インストール可能なPython の一覧表示しインストール

①インストール可能なPythonを表示します。

pyenv install --list

②バージョンを指定してPython をインストールします。(今回は3.7.9をインストールする)

pyenv install 3.7.9

以下のように使うPythonを指定します。(ローカルで指定したいのであれば「pyenv local」を使います。)

pyenv global 3.7.9

③バージョンが、3.7.9が反映されていることを確認します。

python --version

python 3.7.9

venvで仮想環境を設備

Pythonごとに独立したプロジェクトを作成し、他のプロジェクトに影響されないようにします。

①「py_project_1」ディレクトリを作成します。

mkdir py_project_1 && cd $_

②venvという名前でプロジェクトディレクトリ直下に作成します。

python3 -m venv venv

※プロジェクトディレクトリ名は、「venv」でなくても大丈夫です。わかりやすくするために、venvがお勧めです。

仮想環境を起動する

①sourceを実行し、仮想環境を起動します。

source venv/bin/activate

以下のコマンドで仮想環境から離脱します。

deactivate

プロジェクトごとに依存関係を管理とvscodeの設定

各python環境プロジェクトによって、仮想環境を作ります。依存関係のバージョンなどを分け他のプロジェクトに影響しない環境を作ります。

(例

• Aプロジェクトでインストールしたライブラリは、Bプロジェクトでは使用できない。
• Aプロジェクトでインストールしたライブラリは、Bプロジェクトで「pip list」しても表示されない。
• AプロジェクトとBプロジェクトで同じライブラリを使用しても、バージョンが違う場合そのバージョンが有効になる。

①プロジェクトディレクトリに移動します。

cd py_project_1

②vscodeを起動します。vscode 「メニュー」→「ファイル」→「フォルダー」→「ワークスペースに追加…」を指定します。

以下のように「py_project_1」を選択して「追加」をクリックします。

③ターミナルの操作にもどります。以下のように仮想環境に入ります。

source venv/bin/activate

④vscodeフォルダを作成し、settings.jsonを作成します。

mkdir vscode && cd $_
touch settings.json

⑤仮想環境のpythonのパスを確認します。

which python

settings.jsonに以下を記載します。python.pythonPathにwhich pythonで確認したパスを記載して下さい。

settings.json
{
    "python.pythonPath": "which pythonで確認したパスを記載",
    "python.venvFolders": [
        "venv"
    ]
}

仮想環境だけで使うパッケージをインストール

①仮想環境だけで使うパッケージをインストールします。「py_project_1」ディレクトリに移動し、仮想環境に入ります。

cd py_project_1
source venv/bin/activate

②以下のコマンドを実行します。「pytest」をインストールします。

pip install pytest

pytestをインストールしたらインストールできたことを確認します。

pip list
 
Package            Version
------------------ -------
attrs              20.2.0
importlib-metadata 2.0.0
iniconfig          1.1.1
packaging          20.4
pip                20.2.4
pluggy             0.13.1
py                 1.9.0
pyparsing          2.4.7
pytest             6.1.2
setuptools         47.1.0
six                1.15.0
toml               0.10.2
zipp               3.4.0

③仮想環境を離脱します。

deactivate

pipインストール状況を確認します。(pip listでOK)。

pip list

Package            Version
------------------ -------
pip                20.2.4
setuptools         47.1.0

※pytestが反映されていなければ、他のプロジェクトに影響しない環境が作れていることが確認できます。

次回

VSCODEからPythonを実行します。また、アノテーションをしてくれるPylanceも一緒にインストールします。

→【Mac】VSCODEでPythonの実行までの流れとPylance【VSCODE】