Poetryに関するTips

Poetryの使い方を簡単にまとめました。後半では自分がつまづいた箇所の解決法を紹介しています。

基本コマンド

$ poetry new <project-name>

新たにプロジェクトを作成します。

$ poetry install 

仮想環境を立ち上げます。

$ poetry shell

仮想環境を有効にします。

$ poetry add <package-name>

仮想環境にパッケージを追加します。

以下では知っておくと役に立つかもしれない情報を紹介します。

仮想環境の配置場所について

仮想環境はプロジェクトディレクトリで

$ poetry env info

を打つことで確認でき下のような結果が得られると思います。（公式サイトの出力例）

Virtual environment
Python:         3.7.1
Implementation: CPython
Path:           /path/to/poetry/cache/virtualenvs/test-O3eWbxRl-py3.7
Valid:          True

System
Platform: darwin
OS:       posix
Python:   /path/to/main/python

デフォルトの設定だと仮想環境はプロジェクト配下ではなく、別の場所に配置されます。 仮想環境の配置場所をプロジェクト配下にしたければ

$ poetry config virtualenvs.in-project true

とします。 またvirtualenvs.in-projectがfalseの場合は

$ poetry config virtualenvs.path

によって確認できるパスに収められるようです。

仮想環境のpythonのバージョンについて

仮想環境で使用されるpythonのバージョンは上で説明したpoetry env infoの出力から確認できます。 私の環境ではpyenvでインストールしたpythonを有効にしているにも関わらず、デフォルトではシステムに元々備わっているpythonが使われるようでした。 これは

$ poetry config virtualenvs.prefer-active-python true

によってpoetryがshellで有効になっているpythonを見つけてくれるようです。