サイトアイコン 【TechGrowUp】

Python開発入門30 Pythonプロジェクトの効率的な管理に役立つPoetryの使い方

Daichi Mizuno

はじめに

Pythonでプロジェクトを開発するとき、依存関係の管理やパッケージ化は面倒になりがちです。そこで登場するのが、Pythonの依存関係管理ツールPoetryです。Poetryを使用することで、依存関係の解決や仮想環境の構築が簡単にでき、開発がスムーズになります。

この記事では、Poetryのインストールから基本操作、便利な機能まで、わかりやすく解説します。

Poetryとは

Poetryの概要

Poetryは、Pythonプロジェクトの依存関係とパッケージ管理を効率化するツールです。
従来のrequirements.txtやsetup.pyに代わり、pyproject.tomlを使用して、依存関係やプロジェクトの設定を一元管理します。

Poetryの主な特徴

  1. 依存関係の簡単な管理
    必要なライブラリを簡単に追加・削除できます。
  2. 仮想環境の自動管理
    プロジェクトごとに仮想環境を自動で作成し、分離された環境で動作します。
  3. パッケージの公開機能
    作成したプロジェクトを簡単にPyPIに公開できます。
  4. 高速なインストール
    キャッシュ機能により、依存関係を高速にインストールできます。

Poetryのインストール

Poetryをインストールする

Poetryをインストールするには、以下のコマンドを実行します：

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

説明：
このコマンドは、Poetryのインストールスクリプトをダウンロードして実行します。

インストールを確認する

インストールが成功したか確認するには、以下のコマンドを実行します：

poetry --version

出力例：

Poetry version 1.5.0

シェル環境を設定する

Poetryを適切に動作させるために、インストールスクリプトが環境変数を設定します。ターミナルを再起動してからPoetryを利用しましょう。

Poetryの基本的な使い方

Poetryを使ったプロジェクトの管理方法を見ていきます。

新しいプロジェクトを作成する

以下のコマンドで新しいプロジェクトを作成します：

poetry new プロジェクト名
例：my_projectというプロジェクトを作成
poetry new my_project

説明：
このコマンドを実行すると、以下のようなディレクトリ構造が自動的に生成されます：

my_project/
├── pyproject.toml
├── my_project/
│   └── __init__.py
└── tests/
    └── __init__.py

既存のプロジェクトでPoetryを初期化する

既存のプロジェクトにPoetryを導入する場合は、以下を実行します：

poetry init

説明：
対話形式で依存関係やプロジェクト情報を入力すると、pyproject.tomlファイルが生成されます。

依存関係を追加する

新しいライブラリをインストールするには、以下のコマンドを使用します：

poetry add ライブラリ名
例：requestsライブラリを追加
poetry add requests

説明：
このコマンドは、requestsをインストールすると同時にpyproject.tomlに依存関係を記録します。

開発用依存関係を追加する

開発時にのみ必要なライブラリを追加する場合は、以下を使用します：

poetry add --dev ライブラリ名
例：pytestを追加
poetry add --dev pytest

説明：
--devオプションを指定すると、開発用の依存関係として記録されます。

依存関係をインストールする

プロジェクトに必要なすべての依存関係をインストールするには：

poetry install

仮想環境のアクティブ化

仮想環境を手動でアクティブ化するには、以下を実行します：

poetry shell

説明：
このコマンドでPoetryが管理する仮想環境に切り替わります。

Poetryの便利な機能

パッケージのリスト表示

現在のプロジェクトでインストール済みの依存関係を確認するには：

poetry show

パッケージのアップデート

依存関係を最新バージョンに更新するには：

poetry update

パッケージの削除

不要になったライブラリを削除するには：

poetry remove ライブラリ名

PyPIへの公開

作成したパッケージをPyPIに公開するには、以下を実行します：

poetry publish

説明：
事前にpyproject.tomlに必要な情報を記載しておく必要があります。

Poetryを使う際の注意点

  1. Pythonバージョンの指定
    pyproject.tomlでPythonのバージョンを指定することで、環境の互換性を保てます。
  2. 仮想環境の管理
    仮想環境のディレクトリを確認するには：
poetry env list
  1. Poetry自体のアップデート
    Poetryを最新バージョンに保つために、以下を実行します：
poetry self update

まとめ

Poetryは、Pythonプロジェクトの依存関係や仮想環境の管理をシンプルかつ効率的に行えるツールです。この記事で紹介した基本的な使い方や便利な機能を活用し、よりスムーズなPython開発を体験してください！

モバイルバージョンを終了