環境
- macOS Monterey 12.6
- Windows 11
- Python 3.10.5
- VSCode
Poetryとは
Poetryは、仮想環境の生成・Pythonのパッケージ管理が可能なツールです。また、pipenvより処理が早いです。
導入手順
基本的には、公式Docに従って進めれば OKです。
インストーラーをダウンロード
pipでインストールすることも可能ですが、非推奨なので今回はcurlでインストーラをダウンロードして、実行します
Linux, macOS, Windows (WSL)
curl -sSL https://install.python-poetry.org | python3 -Windows (Powershell)
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -※get-poetry.pyやinstall-poetry.pyなどを使用している技術記事が多いですが、これらは旧インストーラーのため、エラーになるので注意ください
Poetryをインストールする
インストーラーを実行すると、OSごとに以下のディレクトリにPoetryがインストールされます。
※インストーラをcurlでダウンロードする際にPOETRY_HOMEでパスを指定することで変更は可能です
- MacOS
~/Library/Application Support/pypoetry
- Linux/Unix
~/.local/share/pypoetry
- Windows
%APPDATA%\pypoetry
Poetryのパスを通す
export PATH=$HOME/your pypoetry path:$PATHパスが通っているか以下で確認して完了。
poetry --version基本的な使い方
プロジェクト初期化
完全に新規でプロジェクトを作成する
poetry new project_nameすでにプロジェクトが存在する場合はこちら
poetry init対話式で色々と聞かれるので、全て選択していく。
プロジェクト直下に、pyproject.tomlとpoetry.lockが生成される
環境の再現
lockファイルから環境を再現
poetry.lockがあるディレクトリで下記のコマンドを実行する。実行するとlockファイルからライブラリがインストールされるとともに、仮想環境が作成される
poetry install --no-root仮想環境の作成場所を変更する
デフォルトだと仮想環境は~/Library/Caches/pypoetry/virtualenvs/ に作られるため、管理がしずらい。プロジェクト直下に作成するには、
poetryの設定一覧を表示
poetry config --listデフォルトだと、virtualenvs.in-projectという設定値がnullないしfalseになっているので、これをtrueにしてからインストールコマンドを実行すると、プロジェクト直下に.venv等名称でディレクトリが生成される
poetry config virtualenvs.in-project true
poetry install --no-rootなお、上記を行う前に仮想環境をすでに作ってしまっていた場合、先に削除しておく必要がある
仮想環境の一覧を表示して、removeコマンドで対象の仮想環境を削除する
poetry env list
poetry env remove poetry-xx-pyライブラリの追加
poetry add library_name
poetry add mypy-D // dev-dependenciesの場合ライブラリのアップデート
poetry updateライブラリの削除
poetry remove pandaslockファイルの生成
poetry lockPython学習におすすめの書籍
