Poetryを使ってPythonのパッケージを管理する方法を現役エンジニアが解説【初心者向け】

初心者向けにPoetryを使ってPythonのパッケージを管理する方法について現役エンジニアが解説しています。Poetryとはパッケージ管理ツールとは、コンピュータで複数のパッケージを管理するためのツール(ソフトウェア)です。Poetryをインストールしてパッケージを管理してみましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Poetryを使ってPythonのパッケージを管理する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Poetryを使ってPythonのパッケージを管理する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

パッケージ管理ツールとは

パッケージ管理ツールとは、コンピュータで複数のパッケージを管理するためのツール(ソフトウェア)です。

インターネットからパッケージをダウンロードしてきてインストールしたり、不要になったパッケージを削除したりするのに用います。単にインストール、アンインストールを支援するだけでなく、パッケージ配布元でバージョンアップがあったか確認したり、依存する他のパッケージも同時にインストールしたりします。

RedHat系OSではyum、Debian系OSではaptというパッケージ管理ツールが広く使われています。

プログラミング言語にもそれぞれツールがあり、Pythonではこの記事で紹介するPoetry、Rubyではgem、Node.jsではnpmといったものがあります。

Poetryとは

PoetryはPython用のパッケージ管理ツールです。

パッケージ管理に必要なコマンド一式を備えている(単体で完結する)ことや、パッケージのビルドや公開を簡単に行える、といった特徴をうたっています。

[PR] Pythonで挫折しない学習方法を動画で公開中

PoetryとPipenvの比較

Poetryは、PEP 518で提案された、pyproject.tomlファイルを採用しています。

パッケージの依存関係だけでなく、ビルド環境一式を設定ファイルとして記述できることが強みです。

Poetryの基本的な使い方

前提条件

  • Python3.7.3を使用しました
  • venvを適用した隔離環境で作業しました
  • Windows環境での実行結果ですが、LinuxやMacでも同様です

インストール

以下コマンドでpoetryをインストールしました。

$ pip install poetry
インストールが成功したか確認するため、バージョンを表示しました。

$ poetry -V
Poetry version 1.0.3

 

プロジェクトの作成

以下コマンドで新規プロジェクトsampleを作成します。

$ poetry new sample
sampleディレクトリ内の、pyproject.tomlがプロジェクトの設定ファイルです。

パッケージのインストール
sampleディレクトリに移動し、以下コマンドを実行します。

$ poetry add requests
Using version ^2.22.0 for requests

Updating dependencies
Resolving dependencies...

Writing lock file

Package operations: 8 installs, 1 update, 0 removals

  - Updating importlib-metadata (1.1.3 -> 1.5.0)
  - Installing atomicwrites (1.3.0)
  - Installing colorama (0.4.3)
  - Installing more-itertools (8.2.0)
  - Installing packaging (20.1)
  - Installing pluggy (0.13.1)
  - Installing py (1.8.1)
  - Installing wcwidth (0.1.8)
  - Installing pytest (5.3.5)

上記の通り、requestsパッケージがインストールされました。
また、pyproject.tomlが自動的に更新されました。

(一部抜粋)

[tool.poetry.dependencies]
python = "^3.7"
requests = "^2.22.0"

 

パッケージのアンインストール

requestパッケージをアンインストールすると、不要になったパッケージも同時にアンインストールされました。

$ poetry remove requests
Updating dependencies
Resolving dependencies...

Writing lock file


Package operations: 0 installs, 0 updates, 5 removals

  - Removing certifi (2019.11.28)
  - Removing chardet (3.0.4)
  - Removing idna (2.8)
  - Removing requests (2.22.0)
  - Removing urllib3 (1.25.8)

 

まとめ

この記事ではPythonのパッケージ管理ツールである、Poetryを紹介しました。

パッケージ管理ツールを用いることで、依存するパッケージのバージョン管理が容易になります。依存パッケージをバージョンアップしたら、ソフトウェアの挙動が変わってしまった、といった意図せぬトラブルも予防できます。

監修してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。