⛳

PoetryでPythonのライブラリ依存管理を導入する

に公開
Docker
docker-compose
poetry
venv
tech

Poetry とは

Python の依存管理 / プロジェクト管理ツールで、

  1. 依存関係を保った上でライブラリのインストール・アンインストール
  2. 仮想環境の分離
  3. パッケージ化・公開

までを統一的に扱えるように設計されている。

以下、各項目の詳細を記載する。

  1. 依存管理

Poetry は、従来のpipの機能を包含しつつ、依存解決や**ロック（lock ファイル化）**といった仕組みを提供し、ライブラリ間のバージョン依存性の整合性を保つことを目指している。

  • 依存管理とは、プロジェクトが使うライブラリやそのバージョン、およびそれらの依存関係（そのライブラリがさらに依存しているものも含む）を管理すること

  • Poetry は、以下の流れを自動でサポートする:

    1. 宣言（pyproject.toml に使いたいパッケージを記述）
    2. 解決（どのバージョンを使うかを決定）
    3. ロック（poetry.lock に具体的なバージョンを固定）

  • pip はライブラリをインストール・アンインストールできるが、依存ライブラリのバージョン整合性を十分に意識した操作は基本的に自動化していない。

  1. 仮想環境分離
  • Poetry は、プロジェクトごとの仮想環境を自動生成・使用する機能を持っている（ただし、設定により無効化も可能 ← Docker 上での使用時は無効化が原則）
  • プロジェクト内に .venv ディレクトリを作るよう設定することも可能: poetry config virtualenvs.in-project true
  • ただし注意：Poetry 自体は仮想環境ツールそのものではなく、既存の仮想環境や環境隔離の枠組みを管理・活用するツール
  1. プロジェクト管理・公開機能

Poetry では、poetry.lock を使うことで、requirements.txt に現れない間接依存なども含めた全体の依存構成を固定できる。
それにより、別の環境（別の PC、CI、本番サーバなど）でも “まったく同じ依存構成” を再現しやすくなる。

  • poetry build：ソース配布（sdist）や wheel 形式にビルド
  • poetry publish：ビルド済のパッケージを PyPI などに公開

補足 Poetry における依存管理の仕組み

  • 依存関係があるライブラリについて、Poetry はロックファイル（poetry.lock）で利用する具体的なバージョンを固定する
  • poetry show --tree コマンドで依存関係ツリーを可視化でき、どのパッケージがどのパッケージに依存しているかを確認できる。これにより、競合がありそうな箇所を見つけやすくなっている
  • ただし、依存解決プロセスは複雑で、依存関係が多いプロジェクトでは時間がかかることがある（特に依存のバージョン制約がゆるい場合）

前提

  • Windows PC を使う
  • WSL2 を使っており、Ubuntu 等の Linux 環境上で作業
  • Docker Engine は WSL 内または Linux 側にインストール済み
  • FastAPI で API サーバを構築したい
  • Poetry（Python のモダンな依存管理／パッケージ管理ツール）を使用する

大まかな流れ

コンテナ化を見据えて、Docker + poetry にする
（コンテナ化を見据えなければ、WSL 上の pyenv + poetry で環境構築をすることもある）

  1. （初回のみ）WSL 上に Poetry をインストールする
  2. プロジェクトディレクトリ構成を作成
  3. pyproject.tomlを作成 / Poetry 初期化
  4. Dockerfile、docker-compose.ymlを書く
  5. FastAPI アプリ本体 (app/main.pyなど) を書く
  6. Docker イメージをビルド
  7. コンテナを起動
  8. FastAPI にアクセス、開発・停止など

0. （初回のみ）WSL 上に Poetry をインストールする

curl -sSL https://install.python-poetry.org | python3 -

  • curlは Web からデータを取得するコマンド

  • https://install.python-poetry.orgは Poetry の公式インストールスクリプト。このスクリプト（Python で書かれている）を Python で実行することで、Poetry がインストールされる

  • オプションの意味:

    オプション 意味
    -s silent（進捗バーなどを非表示にする）
    -S error が起きたときだけエラーを表示する（-sと併用して静かに失敗を見せる）
    -L リダイレクトをたどる（URL が転送されても OK にする）

  • 出力例:

    Installing Poetry (2.2.1): Done

Poetry (2.2.1) is installed now. Great!

To get started you need Poetry's bin directory (/home/sakih/.local/bin) in your `PATH`
environment variable.

Add `export PATH="/home/sakih/.local/bin:$PATH"` to your shell configuration file.

Alternatively, you can call Poetry explicitly with `/home/sakih/.local/bin/poetry`.

You can test that everything is set up by executing:

`poetry --version`

  • 出力例を読むとわかるように、poetryコマンドが使えるように PATH を通す

    export PATH="$HOME/.local/bin:$PATH"
source ~/.bashrc # 再起動せずに環境変数の変更を反映

  • poetryコマンドが使えることを確認

    poetry --version

1. ディレクトリ構成

  • poetry.lockは、poetry addコマンドを実行した際に自動生成するファイルなので作成しないでおくこと（空ファイルを作成しておくとエラーになった The lock file does not have a metadata entry.）
backend-study_postgresql-test-with-poetry/
├── app/ # FastAPIのアプリコードはここに集約する
│   └── main.py
├── pyproject.toml
├── poetry.lock
├── Dockerfile
└── docker-compose.yml

2. Poetry プロジェクトの初期化・依存追加

プロジェクトディレクトリに移動して Poetry プロジェクトを初期化する

cd backend-study_postgresql-test-with-poetry
poetry init

依存管理したいライブラリ名を追加する。追加の仕方は 3 通りある。今回は「2.requirements.txtに記載されたライブラリをそのままcatコマンドで読み込み、追加する」のやり方を選択

  1. 1 つずつコマンドをたたいて追加していく
poetry add fastapi@0.111.0
poetry add uvicorn[standard]@0.30.1
...

まとめて追加もできる

poetry add fastapi@0.111.0 uvicorn[standard]@0.30.1 pydantic@2.6.4 \
  SQLAlchemy@2.0.35 psycopg[binary]@3.2.1 python-dotenv@1.0.1
  1. requirements.txtに記載されたライブラリをそのままcatコマンドで読み込み、追加する
poetry add $(cat requirements.txt)

requirements.txtにコメント行や空行が入っていてもうまく処理できるようにするには、sedコマンドやgrep -vコマンドを使用する

poetry add $(sed 's/#.*$//' requirements.txt | grep -v '^\s*$' | grep -v '^\s*#')
  • sed 's/#.*$//' requirements.txt：行中の#以降を削除（コメントを除去）
  • grep -v '^\s*$'：空行を除外
  • grep -v '^\s*#'：行頭が#の完全コメント行を除外
  • 残った部分をpoetry addに渡す

※ 上記コマンド（poetry add）をいきなり実行するとエラーになることがある。その際はpyproject.tomlに以下を追加して上書き保存してから実行する

[tool.poetry]
name = "backend-study_postgresql-test-with-poetry"     # 任意のプロジェクト名
version = "0.1.0"              # 初期バージョンなど
authors = ["ご自身の名前 <your_email_address@gmail.com>"]

[tool.poetry.dependencies]
python = "3.12.11"

※ 上記 toml ファイルに記載する Python のバージョンは、現在ホスト PC で設定されているものを記載する。もしある特定のバージョンにしたい場合は、WSL にインストール済みの pyenv を使って特定のバージョンがホスト PC で実行されるように設定する。

  1. pyproject.tomlの[tool.poetry.dependencies]セクションに以下の内容を直接編集して追記、あとでpoetry install（またはpoetry lock）を実行する
[tool.poetry.dependencies]
python = "^3.x"
fastapi = "0.111.0"
uvicorn = { version = "0.30.1", extras = ["standard"] }
pydantic = "2.6.4"
SQLAlchemy = "2.0.35"
psycopg = { version = "3.2.1", extras = ["binary"] }
python-dotenv = "1.0.1"

poetry lock
poetry install

依存管理したいライブラリが追加されることで、pyproject.tomlとpoetry.lockができ、依存関係が管理されるようになる

pyproject.tomlの例:

[tool.poetry]
name = "backend-study_postgresql-test-with-poetry"     # 任意のプロジェクト名
version = "0.1.0"              # 初期バージョンなど
authors = ["ご自身の名前 <your_email_address@gmail.com>"]

[tool.poetry.dependencies]
python = "3.12.11"
fastapi = "0.111.0"
uvicorn = {version = "0.30.1", extras = ["standard"]}
pydantic = "2.6.4"
sqlalchemy = "2.0.35"
psycopg = {version = "3.2.1", extras = ["binary"]}
python-dotenv = "1.0.1"

補足 .toml ファイルとは

  • Tom’s Obvious, Minimal Languageの略
  • 設定ファイル（コンフィグファイル）を表すための形式
  • 実体はテキストファイル
  • JSON や YAML に似た役割を持つ
  • # でコメントアウトを記載できる

3. Dockerfile を作成

  • ホスト PC（WSL）上で作ったpyproject.tomlとpoetry.lockをコンテナにコピーする（なぜ外で作って中にコピーをするのかは後述）
  • RUN poetry config virtualenvs.create false（Poetry が自動で仮想環境（.venv）を作るのをやめる意）で Dockerfile の中でも Poetry の挙動を制御して、仮想環境を作らずに依存をインストールする設定をしている（なぜ仮想環境を作らない設定にしているかは後述）
  • poetry install --no-root: このプロジェクト自体（＝ app/ 配下の自作モジュール）をインストールせず、依存パッケージだけをインストールするの意
  • --no-interaction: ユーザー入力（Yes/No など）を求めずに自動実行するの意（Docker ビルドは 非対話モード（人が入力できない）なので、このオプションを付けないと途中で止まることがある）
  • --no-ansi: ターミナルの色や装飾出力（ANSI カラー）をオフにするの意（ログを CI/CD や Docker のビルドログに出すときに、文字化けや色コードが混ざるのを防ぐための慣習的オプション）
FROM python:3.12-slim

# システム依存パッケージ（必要なら）
RUN apt-get update && apt-get install -y --no-install-recommends \
        build-essential \
    && rm -rf /var/lib/apt/lists/*

WORKDIR /app

# Poetry のインストール
# 公式推奨インストール方法に従う（例として以下）
RUN pip install --no-cache-dir poetry

# pyproject.toml と poetry.lock をコピー
COPY pyproject.toml poetry.lock* /app/

# 依存関係をインストール
RUN poetry config virtualenvs.create false \
    && poetry install --no-root --no-interaction --no-ansi

# アプリ本体をコピー
COPY app /app/app

# uvicorn で起動
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]
EXPOSE 8000

補足 なぜpyproject.tomlとpoetry.lockは外で作って中にコピーするのか

  1. 再現性（determinism）を担保
  • poetry.lockが依存の最終決定（確定版）
  • これをビルド時にコンテナへコピー → poetry install ＝ 毎回同じ依存が入る
  • コンテナ内で毎回poetry lock（解決）すると、日によって解決結果が変わる可能性があり、再現性が落ちる
  1. ビルドが速い（Docker レイヤキャッシュ）
  • COPY pyproject.toml poetry.lock /app/ → poetry installをソースコードコピーより前に置いておけば、依存が変わらない限りpoetry install層がキャッシュされる
  • コードだけ触って再ビルドしても依存インストールがスキップされ、爆速
  1. 責務の分離 & 非対話
  • **依存の解決（lock 作成）は開発フロー側（WSL/CI）**でやる
  • コンテナビルドは “ロックに従ってインストールするだけ”
  • Docker ビルドは非対話・再現可能にすべきで、コンテナ内で対話的に lock を生成するのはアンチパターン寄り
  1. セキュリティ＆監査
  • poetry.lock があると、入るバージョンが固定されるのでレビュー・検証しやすい
  • 事故って勝手にメジャーアップされる…を防ぎやすい

補足 なぜpoetry config virtualenvs.create falseにするのか

通常、Poetry はプロジェクトごとに仮想環境を作って依存をそこにインストールする
（たとえば ~/.cache/pypoetry/virtualenvs/... のような場所）

しかし Docker コンテナ内では、すでに環境が隔離されている（＝他のプロジェクトと混ざらない）ので、わざわざ仮想環境を作る必要は無い

そのためこの設定を入れて、「コンテナのグローバル Python 環境に直接インストールしてね」という挙動に変えている

4. docker-compose.ymlを作成

version: '3.8' # Docker Compose（YAML）の「ファイルバージョン」

services:
  api:
    build: .
    command: uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload # --reloadが入っていることで、ソース変更時にAPIサーバが自動リロードされる（Dockerfileにも同コマンドがあるが、compose.ymlの内容が優先される）
    volumes:
      - ./app:/app/app:rw # volumes でホスト側 app/ をコンテナ側にマウントし、コード変更を即時反映
      - ./pyproject.toml:/app/pyproject.toml:ro # pyproject.toml と poetry.lock もマウントしておくと、依存が変更されたときも対応しやすくなる
      - ./poetry.lock:/app/poetry.lock:ro
    ports:
      - '8000:8000'
    environment:
      - PYTHONUNBUFFERED=1

5. app/main.pyを作成

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello, Poetry + FastAPI!"}

6. Docker イメージのビルド

docker compose build

7. コンテナを起動

docker compose up

8. FastAPI サーバにアクセス

8. コンテナを停止

  • Ctrl + Cでdocker compose upを停止
  • 再度起動する場合は、同じディレクトリでdocker compose upを実行
  • 依存の追加・バージョン更新があれば、ホスト側でpoetry add実行 →poetry.lock更新 → 再度docker compose build

参考 URL

  1. requirements.txtからライブラリをまとめてpoetry addするコマンド（poetry add $(cat requirements.txt)）の出典: https://stackoverflow.com/questions/62764148/how-to-import-an-existing-requirements-txt-into-a-poetry-project?utm_source=chatgpt.com

Discussion