最初に
pythonのpipとVSCode環境の構築方法に関してまとめた。
なお、conda環境とpip環境は共存しないため、anacondaなどをインストールしている場合は、アンインストールが必要となる。
https://qiita.com/flcn-x/items/cca3c94758037da61ac5
| 環境 | 詳細 |
|---|---|
| OS | Windows11 |
1. Python環境の構築
Pythonの環境をインストールする。
1.1. インストーラのダウンロード
Pythonは下記公式HPから任意の環境のものをインストールする。
が、バージョンやカスタマイズが複数あるのでわかりにくい。
https://www.python.org/
Windowsであれば以下のサイトが分かりやすかったので、利用をおススメする。
https://pythonlinks.python.jp/ja/index.html
1.2. インストーラの実行
ダウンロードしたインストーラを実行してpythonをインストールする。
- インストーラーを実行
- インストール情報：PATHの追加のチェックボックスにチェックを入れ、「Install Now」をクリック
- インストール完了後：「Close」をクリック
1.3. 動作確認
コマンドプロンプトを起動する。
windowsであれば「windowsボタン+R」で検索窓を出し、「cmd」と打ち込んで開く。
※pythonのインストール完了後に開く必要がある。
コマンドプロンプトで以下のコマンドを実行する。
python
成功していれば以下のような表示が出て、pythonが起動する。
Python 3.x.x (tags yyy) [zzz] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>
上記が確認できれば、以下のコマンドでpython抜け、閉じる。
>>> exit()
2. VSCodeの環境構築
Pythonの実行環境としてVSCodeが有名である。
今回はVSCode環境を構築する。
2.1. インストーラのダウンロード
VSCodeを以下の公式サイトからダウンロードする。
https://code.visualstudio.com/download
WindowsではUser Installerが推奨らしい。
2.2 インストーラの実行
- インストーラーを実行
- ライセンス条項：同意する(A)を選択し、「次へ(N)>」をクリック
- インストール先の指定：「次へ(N)>」をクリック
- スタートメニューフォルダの指定：「次へ(N)>」をクリック
- 追加タスクの選択：「次へ(N)>」をクリック (PATHへの追加が選択されていることを確認する)
- インストールの実行：「インストール(I)」をクリック
- インストール完了後：「完了(F)」をクリック
2.3 環境の設定
公式のpythonのチュートリアルは以下がある。
https://code.visualstudio.com/docs/python/python-tutorial
VSCodeのpython関連機能や日本語設定はVSCode左にある「拡張機能」から自分でインストールする。
python関連機能は、「python」や「jupyter」を検索し、インストールする。
日本語は、「Japanese Language Pack」を検索し、インストールする。
もしくは、VSCode起動時やファイル選択時に右下に提案表示される。
その表示内容を読み、提案された拡張機能を入れるか選択する。
3. 実行環境の構築
Pythonのベース環境は触らない。
pipを使用した仮想環境で実行する。
3.1. 仮想環境の作成
VSCodeの「ターミナル」→「新しいターミナル」からpowershellを起動する。
仮想環境を作成したいディレクトリに移動する。
※Cドライブ//ユーザディレクトリ直下付近を推奨する。
コマンドから、[環境名]の仮想環境(ディレクトリ)を作成する。
※環境名は「.venv」を推奨する。
※環境名部分は絶対パスもしくは相対パス、ディレクトリ名でも可能。
python -m venv [環境名 or パス]
これにより、pipおよびsetuptoolsが含まれる環境が構築される。
3.2. 仮想環境の有効化
仮想環境の有効化には、下記のコマンドを用いる。
※下記コマンドはカレントディレクトリが仮想環境のディレクトリ直上にある場合。
./[環境名]/Scripts/activate
実行の状態は、左端に環境名が表記されれば成功している。
([環境名]) C:\Users\...>
3.3. packageのインストール
以下のコマンドで必要なpackageをインストールする。
pip install [package名]
インストールの際に、最初はpipのアップデートが必要であるとのエラーが出る場合がある。
WARNING: You are using pip version x.x.x; however, version y.y.y is available.
You should consider upgrading via the ' << path >> \.venv\Scripts\python.exe -m pip install --upgrade pip' command.
その場合は、メッセージに従ってpipのアップデートを行う。
python.exe -m pip install --upgrade pip
4. Jupyternotebookでの実行テスト
まず、拡張機能で「Jupyter」をインストールする。
次に、VSCodeで.ipynbファイルを作成し、動作テストを行う。
適当にtest.ipynbファイルを作成し、importテストを行う。
問題なく実行できれば完了となる。
import os
インタープリタパスの設定について
Jupyternotebook右上にpythonの実行環境を指定する表示がある。
[環境名]が表示されていない場合は、クリックして、検索窓から仮想環境を選択する。
Jupyternotebookの実行エラー
Jupyterの実行に必要なライブラリがインストールされていない場合、VSCodeからエラー表示が出る。
インストールの許可を選択すれば必要なライブラリがインストールされる。
環境の有効化について
仮想環境の実行にはPowerShellの実行が必要となるが、その前にポリシーの変更が必要となる。
以下の手順で設定すればVSCodeの実行時のみ許可される。
- 設定を開く
歯車マークをクリックする。 - Setting.json ファイルを開く
検索バーに「json」を入力し、「ユーザ」→「機能」→「デバッグ」の部分を選択する。
「setting.jsonで編集」をクリックする。 - 設定を記述
setting.jsonファイルに以下を追記する。
"terminal.integrated.env.windows": {
"PSExecutionPolicyPreference": "RemoteSigned"
}
5. 最後に
今回も複数のやり方、複数のエラーがあり、一部に時間がかかった。
参考にしたサイト、引用させて頂いたサイト様に感謝。