Pythonでコンソールアプリケーションを作るときのテンプレート
Python の実行環境、開発環境をチームメンバー間で揃える。(非 Docker) Mac のグローバルで Python のバージョンを切り替えずに実行できる。 VSCode でデバッグ実行できる。 前提条件 macOS 使いたい Python のバージョンが Mac にインストールされている。(dmg、Homebrew) ※この記事で使う pipenv は pyenv と一緒に使うことができるようだが未検証。 VSCode に拡張機能 Python(ms-python.python)がインストールされている。 使うツール pip Python パッケージのインストールなどを行うユーティリティで、Python 3.4 以降には、標準で付属している。 pipenv 手動でパッケージのインストールおよびアンインストールを行うのと同じように Pipfile に対してパッケージの追加および削除を行うのに加え、自動でプロジェクト用の仮想環境を作成し管理する。また Pipenv は、いかなるときも重要な Pipfile.lock を生成し、これを利用しビルドが常に同じ結果になるようにする。 環境構築 pipenv をインストールする。 1 $ brew install pipenv Python のソースコードを格納するディレクトリを作る。 1 2 mkdir myproject cd myproject ソースコードのディレクトリに仮想環境を作るために環境変数を設定する。 1 export PIPENV_VENV_IN_PROJECT=1 Python のバージョンを指定して pipenv で初期化する。 このコマンドで作成される.venvディレクトリはバージョン管理に含めない。(チームメンバーがpipenv syncすれば作成されるため) 1 pipenv --python 3.8 Python のバージョンを 3.X.Y のようにパッチバージョンまで指定する場合は Pipfile を書き換える必要がある。 # Pipfile [requires] python_version = "3.8.3" Pipfile.lock を作成する 1 pipenv install ここまでの動作確認 1 2 3 4 5 # 作成した仮想環境のshellに切り替える pipenv shell # Pythonのバージョンを確認する python --version VSCode が pipenv で作った仮想環境を Python 拡張機能とデバッグ実行で使うために.vscode/settings.jsonを作る。※バージョン管理に含めてチームで共有する。 1 2 3 4 # .vscode/settings.json { "python.pythonPath": ".venv/bin/python" } エントリーポイントになるmain.pyを作成する。(ファイル名は任意) 1 2 msg = "Hello World!" print(msg) VSCode でデバッグ実行したときに実行されるファイルを定義するために.vscode/launch.jsonを作る。※バージョン管理に含めてチームで共有する。 1 2 3 4 5 6 7 8 9 10 11 12 13 //.vscode/launch.json { "version": "0.2.0", "configurations": [ { "name": "Python: main.py", "type": "python", "request": "launch", "program": "${workspaceFolder}/main.py", "console": "internalConsole" } ] } チームメンバーが上記のソースコードを取得した後に行うこと Pipfile.lockで指定されたバージョンのパッケージをインストールするためにinstallではなくsyncを使う。 1 pipenv sync --dev GitHub リポジトリ 今回作成したテンプレートのリポジトリ 参考 Python debug configurations in Visual Studio Code Pipenv: 人間のための Python 開発ワークフロー