一、困惑
作為一個(gè) Python 初學(xué)者,我在包管理上感到相當(dāng)疑惑(嗯,是困惑)。主要表現(xiàn)在下面幾個(gè)方面:
這幾個(gè)包管理工具有什么不同?
distutils
setuptools
distribute
disutils2
distlib
pip
什么時(shí)候該用pip,什么時(shí)候該用 setup.py ,它們有關(guān)系么?
easy_install、ez_setup.py、setup.py、setup.cfg 分別都是干啥的?
wheel 和 pip 的關(guān)系?
Egg 和 whl 的關(guān)系?
如何發(fā)布自己的模塊(發(fā)布到PyPI)?
如何進(jìn)行模塊的私有發(fā)布(不發(fā)布到PyPI)?
為了弄清這些問題,我找了許多資料。最后發(fā)現(xiàn)最好的資料還是 python 的官方文檔。
下面是閱讀了所有我找到的資料后的一個(gè)總結(jié),希望能幫到幾個(gè)月后又把這些全部忘光的那個(gè)自己。
二、python 包管理工具大亂斗
我用時(shí)間順序來描述亂斗過程。
1. distutils
distutils 是 python 標(biāo)準(zhǔn)庫(kù)的一部分,2000年發(fā)布。使用它能夠進(jìn)行 python 模塊的 安裝 和 發(fā)布。
setup.py 就是利用 distutils 的功能寫成,我們可以看一個(gè)簡(jiǎn)單的 setup.py 的例子。
在這里可以看到關(guān)于 setupt.py 格式的所有詳細(xì)描述:Writing the Setup Script。
要安裝一個(gè)模塊到當(dāng)前的 python 環(huán)境中,可以使用這個(gè)模塊提供的 setup.py 文件:
python setup.py install
下面的代碼會(huì)發(fā)布一個(gè) python 模塊,將其打包成 tar.gz 或者 zip 壓縮包:
python setup.py sdist
甚至能打包成 rpm 或者 exe 安裝包:
python setup.py bdist_rpm
python setup.py bdist_wininst
2. setuptools 和 distribute
setuptools 是一個(gè)為了增強(qiáng) distutils 而開發(fā)的集合,2004年發(fā)布。它包含了 easy_install 這個(gè)工具。
ez_setup.py 是 setuptools 的安裝工具。ez 就是 easy 的縮寫。
簡(jiǎn)單的說,setuptools 是一個(gè)項(xiàng)目的名稱,是基礎(chǔ)組件。而 easy_install 是這個(gè)項(xiàng)目中提供的工具,它依賴基礎(chǔ)組件工作。
為了方便描述,下面文章中提到的 setuptools 被認(rèn)為與 easy_install 同義。
使用 setuptools 可以自動(dòng) 下載、構(gòu)建、安裝和管理 python 模塊。
例如,從 PyPI 上安裝一個(gè)包:
easy_install SQLObject
下載一個(gè)包文件,然后安裝它:
easy_install http://example.com/path/to/MyPackage-1.2.3.tgz
從一個(gè) .egg 格式安裝:
easy_install /my_downloads/OtherPackage-3.2.1-py2.3.egg
distribute 是 setuptools 的一個(gè)分支版本。分支的原因可能是有一部分開發(fā)者認(rèn)為 setuptools 開發(fā)太慢了。但現(xiàn)在,distribute 又合并回了 setuptools 中。因此,我們可以認(rèn)為它們是同一個(gè)東西。事實(shí)上,如果你查看一下 easy_install 的版本,會(huì)發(fā)現(xiàn)它本質(zhì)上就是 distribute 。
# easy_install --version
distribute 0.6.28
3. Eggs
Eggs 格式是 setuptools 引入的一種文件格式,它使用 .egg 擴(kuò)展名,用于 Python 模塊的安裝。
setuptools 可以識(shí)別這種格式。并解析它,安裝它。
想要詳細(xì)了解,可以看看這篇:The Quick Guide to Python Eggs。
Eggs are to Pythons as Jars are to Java..
4. pip
注意,從此處開始,easy_install 和 setuptools 不再同義。
pip 是目前 python 包管理的事實(shí)標(biāo)準(zhǔn),2008年發(fā)布。它被用作 easy_install 的替代品,但是它仍有大量的功能建立在 setuptools 組件之上。
pip 希望不再使用 Eggs 格式(雖然它支持 Eggs),而更希望采用“源碼發(fā)行版”(使用 python setup.py sdist 創(chuàng)建)。這可以充分利用 Requirements File Format 提供的方便功能。
pip 可以利用 requirments.txt 來實(shí)現(xiàn)在依賴的安裝。在 setup.py 中,也存在一個(gè) install_requires 表來指定依賴的安裝。它們的區(qū)別在哪里?可以看這篇文章:setup.py vs requirements.txt (中文版)。
pip 支持 git/svn/hg 等流行的 VCS 系統(tǒng),可以直接從 gz 或者 zip 壓縮包安裝,支持搜索包,以及指定服務(wù)器安裝等等功能。
pip vs easy_install 詳細(xì)介紹了兩者的不同。它們可以說是各占勝場(chǎng),但 pip 明顯優(yōu)勢(shì)更大。
5. wheel
wheel 本質(zhì)上是一個(gè) zip 包格式,它使用 .whl 擴(kuò)展名,用于 python 模塊的安裝,它的出現(xiàn)是為了替代 Eggs。
wheel 還提供了一個(gè) bdist_wheel 作為 setuptools 的擴(kuò)展命令,這個(gè)命令可以用來生成 wheel 包。
pip 提供了一個(gè) wheel 子命令來安裝 wheel 包。當(dāng)然,需要先安裝 wheel 模塊。
setup.cfg 可以用來定義 wheel 打包時(shí)候的相關(guān)信息。
Wheel vs Egg 詳細(xì)介紹了 wheel 和 Eggs 格式的區(qū)別,很顯然,wheel 優(yōu)勢(shì)明顯。
Python Wheels 網(wǎng)站展示了使用 Wheels 發(fā)行的 python 模塊在 PyPI 上的占有率。
pypip.in 也支持 wheel。
6. distutils2 和 distlib
distutils2 被設(shè)計(jì)為 distutils 的替代品。從2009年開發(fā)到2012年。它包含更多的功能,并希望以 packaging 作為名稱進(jìn)入 python 3.3 成為標(biāo)準(zhǔn)庫(kù)的一部分。但這個(gè)計(jì)劃 后來停滯了 。
distlib 是 distutils2 的部分,它為 distutils2/packaging 提供的低級(jí)功能增加高級(jí) API,使其便于使用。
這里 介紹了 distlib 沒有進(jìn)入 python 3.3 標(biāo)準(zhǔn)庫(kù)的一些原因。
因此,可以暫時(shí)不必了解這兩個(gè)工具,靜觀其變即可。
三、工具選擇
如果仔細(xì)看過上面的亂斗內(nèi)容,我相信你已經(jīng)清楚當(dāng)前應(yīng)該如何選擇了。
對(duì)于我這樣剛剛開始的新手來說,自然是使用 pip 而不使用 easy_install 了。
如果發(fā)布模塊,當(dāng)然是使用 wheel 格式。
四、發(fā)布自己的模塊
對(duì)于 python3 程序員來說,當(dāng)然應(yīng)該先看這一篇:Distributing Python Modules。
另外,Tutorial on Packaging and Distributing Projects 也足夠詳細(xì)和官方。
而 Python2 程序員則應(yīng)該看這篇 Distributing Python Modules 。
當(dāng)然,setuptools 的官方文檔也是不錯(cuò)的教程:Building and Distributing Packages with Setuptools。
這篇教程可以用來入門:Sharing Your Labor of Love: PyPI Quick and Dirty
至于如何發(fā)布自己的模塊到 PyPI 或者搭建自己的私有包管理服務(wù)器,上面的文章已經(jīng)講得非常清楚了。
五、引用
上面提到的大部分資料,都是在這里找到,或者是提到:Python Packaging User Guide。
感謝這篇文章,讓我不再糾結(jié),然后又下決心寫了本文繼續(xù)糾結(jié):Differences between distribute, distutils, setuptools and distutils2? 。
這篇文章也比較碎:關(guān)于python中的setup.py,而且比本文范例更多。
關(guān)聯(lián)文章
Python 虛擬環(huán)境
不重新編譯,讓官方網(wǎng)站下載的Vim支持Python
Cygwin的包管理器:apt-cyg
今年第六屆大會(huì)PyConChina2016,由PyChina.org發(fā)起,CPyUG/TopGeek 等社區(qū)協(xié)辦,將在2016年9月10日(上海)9月25日(深圳)10月15日(北京、杭州)地舉辦的針對(duì)Python開發(fā)者所舉辦的最盛大和權(quán)威的Python相關(guān)技術(shù)會(huì)議,由PyChina社區(qū)主辦,致力于推動(dòng)各類Python相關(guān)的技術(shù)在互聯(lián)網(wǎng)、企業(yè)應(yīng)用等領(lǐng)域的研發(fā)和應(yīng)用。
您可以點(diǎn)擊此處
了解更多詳情,或者掃描下圖二維碼:
