本站文章除注明轉(zhuǎn)載外盟劫,均為本站原創(chuàng)或者翻譯饰迹。
本站文章歡迎各種形式的轉(zhuǎn)載序调,但請18歲以上的轉(zhuǎn)載者注明文章出處躬窜,尊重我的勞動,也尊重你的智商炕置;
本站部分原創(chuàng)和翻譯文章提供markdown格式源碼荣挨,歡迎使用文章源碼進行轉(zhuǎn)載;
本博客采用WPCMD維護朴摊;
本文標(biāo)題:Python 包管理工具解惑
本文鏈接:http://zengrong.net/post/2169.htm
一默垄、困惑
作為一個 Python 初學(xué)者,我在包管理上感到相當(dāng)疑惑(嗯甚纲,是困惑)口锭。主要表現(xiàn)在下面幾個方面:
這幾個包管理工具有什么不同?
distutils
setuptools
distribute
disutils2
distlib
pip
什么時候該用pip介杆,什么時候該用setup.py鹃操,它們有關(guān)系么?
easy_install春哨、ez_setup.py荆隘、setup.py、setup.cfg分別都是干啥的赴背?
wheel 和 pip 的關(guān)系椰拒?
Egg 和 whl 的關(guān)系?
如何發(fā)布自己的模塊(發(fā)布到PyPI)凰荚?
如何進行模塊的私有發(fā)布(不發(fā)布到PyPI)燃观?
為了弄清這些問題,我找了許多資料便瑟。最后發(fā)現(xiàn)最好的資料還是 python 的官方文檔缆毁。
下面是閱讀了所有我找到的資料后的一個總結(jié),希望能幫到幾個月后又把這些全部忘光的那個自己到涂。
二脊框、python 包管理工具大亂斗
我用時間順序來描述亂斗過程。
1. distutils
distutils是 python 標(biāo)準(zhǔn)庫的一部分养盗,2000年發(fā)布缚陷。使用它能夠進行 python 模塊的安裝和發(fā)布。
setup.py 就是利用distutils的功能寫成往核,我們可以看一個簡單的setup.py的例子箫爷。
在這里可以看到關(guān)于 setupt.py 格式的所有詳細(xì)描述:Writing the Setup Script。
要安裝一個模塊到當(dāng)前的 python 環(huán)境中聂儒,可以使用這個模塊提供的 setup.py 文件:
pythonsetup.pyinstall
下面的代碼會發(fā)布一個 python 模塊虎锚,將其打包成 tar.gz 或者 zip 壓縮包:
pythonsetup.pysdist
甚至能打包成 rpm 或者 exe 安裝包:
pythonsetup.pybdist_rpmpythonsetup.pybdist_wininst
2. setuptools 和 distribute
setuptools是一個為了增強 distutils 而開發(fā)的集合,2004年發(fā)布衩婚。它包含了easy_install這個工具窜护。
ez_setup.py是 setuptools 的安裝工具。ez就是easy的縮寫非春。
簡單的說柱徙,setuptools 是一個項目的名稱缓屠,是基礎(chǔ)組件。而easy_install是這個項目中提供的工具护侮,它依賴基礎(chǔ)組件工作敌完。
為了方便描述,下面文章中提到的 setuptools 被認(rèn)為與easy_install同義羊初。
使用 setuptools 可以自動下載滨溉、構(gòu)建、安裝和管理python 模塊长赞。
例如晦攒,從 PyPI 上安裝一個包:
easy_installSQLObject
下載一個包文件,然后安裝它:
easy_installhttp://example.com/path/to/MyPackage-1.2.3.tgz
從一個 .egg 格式安裝:
easy_install/my_downloads/OtherPackage-3.2.1-py2.3.egg
distribute是 setuptools 的一個分支版本得哆。分支的原因可能是有一部分開發(fā)者認(rèn)為 setuptools 開發(fā)太慢了脯颜。但現(xiàn)在,distribute 又合并回了 setuptools 中柳恐。因此伐脖,我們可以認(rèn)為它們是同一個東西。事實上乐设,如果你查看一下easy_install的版本讼庇,會發(fā)現(xiàn)它本質(zhì)上就是 distribute 。
# easy_install --versiondistribute0.6.28
3. Eggs
Eggs格式是 setuptools 引入的一種文件格式近尚,它使用 .egg 擴展名蠕啄,用于 Python 模塊的安裝。
setuptools 可以識別這種格式戈锻。并解析它歼跟,安裝它。
想要詳細(xì)了解格遭,可以看看這篇:The Quick Guide to Python Eggs哈街。
Eggs are to Pythons as Jars are to Java..
4. pip
注意,從此處開始拒迅,easy_install和setuptools不再同義骚秦。
pip是目前 python 包管理的事實標(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 來實現(xiàn)在依賴的安裝屹电。在setup.py中阶剑,也存在一個install_requires表來指定依賴的安裝跃巡。它們的區(qū)別在哪里?可以看這篇文章:setup.py vs requirements.txt(中文版)个扰。
pip 支持git/svn/hg 等流行的 VCS 系統(tǒng)瓷炮,可以直接從 gz 或者 zip 壓縮包安裝,支持搜索包递宅,以及指定服務(wù)器安裝等等功能。
pip vs easy_install詳細(xì)介紹了兩者的不同苍狰。它們可以說是各占勝場办龄,但 pip 明顯優(yōu)勢更大。
5. wheel
wheel本質(zhì)上是一個 zip 包格式淋昭,它使用 .whl 擴展名俐填,用于 python 模塊的安裝,它的出現(xiàn)是為了替代 Eggs翔忽。
wheel 還提供了一個bdist_wheel作為 setuptools 的擴展命令英融,這個命令可以用來生成 wheel 包。
pip 提供了一個 wheel 子命令來安裝 wheel 包歇式。當(dāng)然驶悟,需要先安裝 wheel 模塊。
setup.cfg可以用來定義 wheel 打包時候的相關(guān)信息材失。
Wheel vs Egg詳細(xì)介紹了 wheel 和 Eggs 格式的區(qū)別痕鳍,很顯然,wheel 優(yōu)勢明顯龙巨。
Python Wheels網(wǎng)站展示了使用 Wheels 發(fā)行的 python 模塊在 PyPI 上的占有率笼呆。
pypip.in也支持 wheel。
6. distutils2 和 distlib
distutils2被設(shè)計為distutils的替代品旨别。從2009年開發(fā)到2012年诗赌。它包含更多的功能,并希望以packaging作為名稱進入 python 3.3 成為標(biāo)準(zhǔn)庫的一部分秸弛。但這個計劃后來停滯了铭若。
distlib是distutils2的部分,它為distutils2/packaging提供的低級功能增加高級 API胆屿,使其便于使用奥喻。
這里介紹了 distlib 沒有進入 python 3.3 標(biāo)準(zhǔn)庫的一些原因。
因此非迹,可以暫時不必了解這兩個工具环鲤,靜觀其變即可。
三憎兽、工具選擇
如果仔細(xì)看過上面的亂斗內(nèi)容冷离,我相信你已經(jīng)清楚當(dāng)前應(yīng)該如何選擇了吵冒。
對于我這樣剛剛開始的新手來說,自然是使用 pip 而不使用easy_install了西剥。
如果發(fā)布模塊痹栖,當(dāng)然是使用 wheel 格式。
四瞭空、發(fā)布自己的模塊
對于 python3 程序員來說揪阿,當(dāng)然應(yīng)該先看這一篇:Distributing Python Modules。
另外咆畏,Tutorial on Packaging and Distributing Projects也足夠詳細(xì)和官方南捂。
而 Python2 程序員則應(yīng)該看這篇Distributing Python Modules。
當(dāng)然旧找,setuptools 的官方文檔也是不錯的教程:Building and Distributing Packages with Setuptools溺健。
這篇教程可以用來入門:Sharing Your Labor of Love: PyPI Quick and Dirty
至于如何發(fā)布自己的模塊到 PyPI 或者搭建自己的私有包管理服務(wù)器,上面的文章已經(jīng)講得非常清楚了钮蛛。
五鞭缭、引用
上面提到的大部分資料,都是在這里找到魏颓,或者是提到:Python Packaging User Guide岭辣。