Python 包管理工具解惑

一、困惑

作為一個 Python 初學者，我在包管理上感到相當疑惑（嗯，是困惑）。主要表現在下面幾個方面：

1. 這幾個包管理工具有什麼不同？
2. distutils
3. setuptools
4. distribute
5. disutils2
6. distlib
7. pip
8. 什麼時候該用pip，什麼時候該用 setup.py ，它們有關係麼？
9. easy_install、ez_setup.py、setup.py、setup.cfg 分別都是幹啥的？
10. wheel 和 pip 的關係？
11. Egg 和 whl 的關係？
12. 如何釋出自己的模組（釋出到PyPI）？
13. 如何進行模組的私有釋出（不釋出到PyPI）？

為了弄清這些問題，我找了許多資料。最後發現最好的資料還是 python 的官方文件。

下面是閱讀了所有我找到的資料後的一個總結，希望能幫到幾個月後又把這些全部忘光的那個自己。

二、python 包管理工具大亂鬥

我用時間順序來描述亂鬥過程。

1. distutils

distutils 是 python 標準庫的一部分，2000年釋出。使用它能夠進行 python 模組的 安裝 和 釋出。

setup.py 就是利用 distutils 的功能寫成，我們可以看一個簡單的 setup.py 的例子。

在這裡可以看到關於 setupt.py 格式的所有詳細描述：Writing the Setup Script。

要安裝一個模組到當前的 python 環境中，可以使用這個模組提供的 setup.py 檔案：

下面的程式碼會釋出一個 python 模組，將其打包成 tar.gz 或者 zip 壓縮包：

甚至能打包成 rpm 或者 exe 安裝包：

2. setuptools 和 distribute

setuptools 是一個為了增強 distutils 而開發的集合，2004年釋出。它包含了 easy_install 這個工具。

ez_setup.py 是 setuptools 的安裝工具。ez 就是 easy 的縮寫。

簡單的說，setuptools 是一個專案的名稱，是基礎元件。而 easy_install 是這個專案中提供的工具，它依賴基礎元件工作。

為了方便描述，下面文章中提到的 setuptools 被認為與 easy_install 同義。

使用 setuptools 可以自動 下載、構建、安裝和管理 python 模組。

例如，從 PyPI 上安裝一個包：

下載一個包檔案，然後安裝它：

從一個 .egg 格式安裝：

distribute 是 setuptools 的一個分支版本。分支的原因可能是有一部分開發者認為 setuptools 開發太慢了。但現在，distribute 又合併回了 setuptools 中。因此，我們可以認為它們是同一個東西。事實上，如果你檢視一下 easy_install 的版本，會發現它本質上就是 distribute 。

3. Eggs

Eggs 格式是 setuptools 引入的一種檔案格式，它使用 .egg 副檔名，用於 Python 模組的安裝。

setuptools 可以識別這種格式。並解析它，安裝它。

想要詳細瞭解，可以看看這篇：The Quick Guide to Python Eggs。

Eggs are to Pythons as Jars are to Java..

4. pip

注意，從此處開始，easy_install 和 setuptools 不再同義。

pip 是目前 python 包管理的事實標準，2008年釋出。它被用作 easy_install 的替代品，但是它仍有大量的功能建立在 setuptools 元件之上。

pip 希望不再使用 Eggs 格式（雖然它支援 Eggs），而更希望採用“原始碼發行版”（使用 python setup.py sdist 建立）。這可以充分利用 Requirements File Format 提供的方便功能。

pip 可以利用 requirments.txt 來實現在依賴的安裝。在 setup.py 中，也存在一個 install_requires 表來指定依賴的安裝。它們的區別在哪裡？可以看這篇文章：setup.py vs requirements.txt （中文版）。

pip 支援 git/svn/hg 等流行的 VCS 系統，可以直接從 gz 或者 zip 壓縮包安裝，支援搜尋包，以及指定伺服器安裝等等功能。

pip vs easy_install 詳細介紹了兩者的不同。它們可以說是各佔勝場，但 pip 明顯優勢更大。

5. wheel

wheel 本質上是一個 zip 包格式，它使用 .whl 副檔名，用於 python 模組的安裝，它的出現是為了替代 Eggs。

wheel 還提供了一個 bdist_wheel 作為 setuptools 的擴充套件命令，這個命令可以用來生成 wheel 包。

pip 提供了一個 wheel 子命令來安裝 wheel 包。當然，需要先安裝 wheel 模組。

setup.cfg 可以用來定義 wheel 打包時候的相關資訊。

Wheel vs Egg 詳細介紹了 wheel 和 Eggs 格式的區別，很顯然，wheel 優勢明顯。

Python Wheels 網站展示了使用 Wheels 發行的 python 模組在 PyPI 上的佔有率。

pypip.in 也支援 wheel。

6. distutils2 和 distlib

distutils2 被設計為 distutils 的替代品。從2009年開發到2012年。它包含更多的功能，並希望以 packaging 作為名稱進入 python 3.3 成為標準庫的一部分。但這個計劃 後來停滯了 。

distlib 是 distutils2 的部分，它為 distutils2/packaging 提供的低階功能增加高階 API，使其便於使用。

這裡 介紹了 distlib 沒有進入 python 3.3 標準庫的一些原因。

因此，可以暫時不必瞭解這兩個工具，靜觀其變即可。

三、工具選擇

如果仔細看過上面的亂鬥內容，我相信你已經清楚當前應該如何選擇了。

對於我這樣剛剛開始的新手來說，自然是使用 pip 而不使用 easy_install 了。

如果釋出模組，當然是使用 wheel 格式。

四、釋出自己的模組

對於 python3 程式設計師來說，當然應該先看這一篇：Distributing Python Modules。

另外，Tutorial on Packaging and Distributing Projects 也足夠詳細和官方。

而 Python2 程式設計師則應該看這篇 Distributing Python Modules 。

當然，setuptools 的官方文件也是不錯的教程：Building and Distributing Packages with Setuptools 。

這篇教程可以用來入門：Sharing Your Labor of Love: PyPI Quick and Dirty

至於如何釋出自己的模組到 PyPI 或者搭建自己的私有包管理伺服器，上面的文章已經講得非常清楚了。

五、引用

上面提到的大部分資料，都是在這裡找到，或者是提到：Python Packaging User Guide。

感謝這篇文章，讓我不再糾結，然後又下決心寫了本文繼續糾結：Differences between distribute, distutils, setuptools and distutils2? 。

這篇文章也比較碎：關於python中的setup.py，而且比本文範例更多。