http://www.cnblogs.com/itech/archive/2011/02/13/1953268.html
python技巧26[python的egg包的安裝和製作]
一 setuptools 和easy_install
setuptools:setuptools 是一組由PEAK(Python Enterprise Application Kit)開發的 Python 的 distutils 工具的增強工具,可以讓程序員更方便的創建和發佈 Python的egg 包,特別是那些對其它包具有依賴性的狀況。 由 setuptools 創建和發佈的包看起來和基於 distutils 發佈的包沒什麼不同。最終用戶不需要事先安裝 setuptools 甚至根本不需要知道 setuptools 的存在,而程序員也不需要附上完整的 setuptools,只需要包含一個大小約 8K 的ez_setup.py腳本作爲啓動模塊,就可以在最終用戶沒有安裝適當版本的 setuptools 時讓這些包自動下載和安裝 setuptools。
easy_install: 常使用python的人員,當需要安裝第三方python包時,可能會用到easy_install命令。easy_install是由PEAK(Python Enterprise Application Kit)開發的setuptools包裏帶的一個命令,它用來自動地從http://pypi.python.org/simple/來安裝egg包,相當於perl中的cpan或PPM。
二 windows上安裝setuptool
方法1: exe安裝文件 從這裏下載:setuptools-0.6c11.win32-py2.6.exe 安裝文件
如果以前曾經安裝舊版的setuptools,則在安裝之前需要將系統中的site-packages目錄(以及任何其他sys.path目錄)下的所有setuptools*.egg和setuptools.pth文件刪除。
如果之前也是使用.exe安裝程序安裝的setuptools,則安裝前要在“添加/刪除程序”中卸載舊的版本。
安裝完畢後,在Python的Scripts子目錄下就會出現easy_install.exe程序。 確保將這個目錄(例如 C:\Python26\Scripts)加入 PATH 環境變量。
方法2: 手工安裝
卸載舊版的方法同 1 相同。
下載ez_setup.py腳本, http://peak.telecommunity.com/dist/ez_setup.py 然後在命令行運行: python ez_setup.py
三 Linux上的setuptool的安裝
Debian/Ubuntu下可以直接使用apt安裝::
$ sudo apt-get install python-setuptools
手工安裝的話,有兩種方式:
- 通過引導程序 ez_setup.py 來安裝。這個引導程序會聯網下載最新版本setuptools來安裝,同時也可以更新本地的setuptools。
$ wget http://peak.telecommunity.com/dist/ez_setup.py $ sudo python ez_setup.py
更新setuptools::
$ sudo python ez_setup.py -U setuptools
- 或者下載setuptools的egg包來安裝。可以在 這裏 查看最新版本下載。下載完畢以後通過sh安裝。
$ wget http://pypi.python.org/packages/2.6/s/setuptools/setuptools-0.6c11-py2.6.egg $ sudo sh setuptools-0.6c11-py2.6.egg
四 easy_install的使用
1) 使用easy_install來自動安裝egg包
比如說要安裝Python的MYSQL支持,可以執行如下命令,系統會自動在pypi網站列表裏查找相關軟件包:easy_install MySQL-python。
通過easy_install安裝軟件,相關安裝信息會保存到easy-install.pth文件裏,路徑類似如下形式:C:\Python25\Lib\site-packages\easy-install.pth。
如果想刪除通過easy_install安裝的軟件包,比如說:MySQL-python,可以執行命令:easy_install -m MySQL-python。
2)將egg安裝包下載到本地安裝
進入到安裝包的目錄,執行python setup.py install
3)如果easy_install安裝某模塊有錯的話,則可以自己到http://pypi.python.org/simple/python-ldap/下載,然後使用python setup.py install來安裝。
有的時候easy_install並不能夠很好地自動安裝,比如我安裝ldap:easy_install.exe python-ldap, easy_install應該到http://pypi.python.org/simple/python-ldap/下下載python-ldap-2.3.8.win32-py2.6.exe,但是easy_install卻找到了python-ldap
2.3.12,最總導致安裝有錯。(不知道是不是因爲pypi上沒有64bit的egg,我的系統是64bit的,但是我的python是32bit的啊)
五 egg的製作
egg包是目前最流行的python應用打包部署方式。如何製作和安裝egg包?下面我就簡單的分析了一下。
總是安裝別人的egg包,是不是也想製作自己的egg包呢?好,接下來我們就自己製作一個簡單的egg包。
首先建立工程目錄egg-demo,初始化一個setup.py文件:
$ mkdir egg-demo $ cd egg-demo $ touch setup.py $ ls setup.py
下面主要就是填充setup.py。setup.py其實是python工具包distutils的配置文件,setuptools就是基於distutils來做的。 在setup.py中通過setup函數來配置打包信息。首先要引入setuptools的函數setup。setuptools的setup其實就是distutils的setup函數,填寫setup.py爲以下內容:
$ cat setup.py #!/usr/bin/env python #-*- coding:utf-8 -*- from setuptools import setup setup()
寫到這裏,一個空的egg配置文件就寫好了。我們可以使用下面命令生成egg包:
$ python setup.py bdist_egg
下面看看究竟生成了什麼:
$ ls -F build/ dist/ setup.py UNKNOWN.egg-info/
可以看到多了三個文件夾。而在dist文件夾下,有一個egg文件:UNKNOWN-0.0.0-py2.6.egg。
產蛋成功!先看看這個egg文件是什麼格式的:
$ file dist/UNKNOWN-0.0.0-py2.6.egg dist/UNKNOWN-0.0.0-py2.6.egg: Zip archive data, at least v2.0 to extract
噢,原來就是一個zip壓縮包呀!好,再來看看內部構造:
$ unzip -l dist/UNKNOWN-0.0.0-py2.6.egg Archive: dist/KNOWN-0.0.0-py2.6.egg Length Date Time Name --------- ---------- ----- ---- 120 2010-12-06 17:04 EGG-INFO/SOURCES.txt 1 2010-12-06 17:04 EGG-INFO/top_level.txt 1 2010-12-06 17:04 EGG-INFO/zip-safe 1 2010-12-06 17:04 EGG-INFO/dependency_links.txt 227 2010-12-06 17:04 EGG-INFO/PKG-INFO --------- ------- 350 5 files
只有一個EGG-INFO文件夾,內含五個egg信息文件,沒了。
這個egg名稱未知,版本0.0.0。這是因爲我們在setup裏什麼也沒有設置。
顯然,這個egg什麼也不能做。
下面給它加點料。
在setup.py中,setup函數接收一系列屬性作爲配置參數。
- name name是egg包的名稱,也是尋找要打包的文件夾的名稱,默認是UNKNOWN。
- version 版本號,默認0.0.0
- packages 這裏要用到setuptools的另一個函數find_packages,顧名思義,find_packages用來將指定目錄下的文件打包。
- zip_safe 默認是False,這樣在每次生成egg包時都會檢查項目文件的內容,確保無誤。
還有一些描述性的屬性,如description,long_description,author,author_email,license,keywords,platform,url等。
填充setup.py文件如下::
$ cat setup.py #!/usr/bin/env python #-*- coding:utf-8 -*- from setuptools import setup, find_packages setup( name = "demo", version="0.1.0", packages = find_packages(), zip_safe = False, description = "egg test demo.", long_description = "egg test demo, haha.", author = "amoblin", author_email = "[email protected]", license = "GPL", keywords = ("test", "egg"), platforms = "Independant", url = "", )
在egg-demo目錄下建立和上述name名稱相同的目錄demo,demo目錄下寫__init__.py文件:
$ mkdir demo $ cat demo/__init__.py #!/usr/bin/env python #-*- coding:utf-8 -*- def test(): print "Hello, I'm amoblin." if __name__ == '__main__': test()
再次生成egg包以後查看egg包信息:
$ python setup.py bdist_egg $ unzip -l dist/demo-0.1.0-py2.6.egg Archive: dist/demo-0.1.0-py2.6.egg Length Date Time Name --------- ---------- ----- ---- 121 2010-12-06 17:30 demo/__init__.py 344 2010-12-06 17:46 demo/__init__.pyc 137 2010-12-06 17:46 EGG-INFO/SOURCES.txt 5 2010-12-06 17:46 EGG-INFO/top_level.txt 1 2010-12-06 17:46 EGG-INFO/zip-safe 1 2010-12-06 17:46 EGG-INFO/dependency_links.txt 227 2010-12-06 17:46 EGG-INFO/PKG-INFO --------- ------- 836 7 files
可以看到,多了一個文件夾demo,裏面有我們寫的__init__.py。
奉行敏捷原則,先安裝了體驗一下再說:
$ sudo python setup.py install running install install_dir /usr/local/lib/python2.6/dist-packages/ ... creating /usr/local/lib/python2.6/dist-packages/demo-0.1.0-py2.6.egg Extracting demo-0.1.0-py2.6.egg to /usr/local/lib/python2.6/dist-packages demo 0.1.0 is already the active version in easy-install.pth Installed /usr/local/lib/python2.6/dist-packages/demo-0.1.0-py2.6.egg Processing dependencies for demo==0.1.0 Finished processing dependencies for demo==0.1.0
OK!安裝完畢!接下來我們就可以直接通過import來使用啦!
$ python -c "from demo import test;test()" Hello, I'm amoblin.
成功輸出!這說明安裝正確。我們的一個egg包誕生了。
一般情況下,我們的源程序都放在src目錄下,所以接下來將demo文件夾移動到src裏。但這樣也要修改setup.py文件,修改find_packages函數中參數爲’src’,同時增加package_dir參數:
packages=find_packages('src'), package_dir = {'':'src'}
這樣告訴setuptools在src目錄下找包,而不是原來默認的工程根目錄。
最後我們來手動的卸載以下剛纔安裝的egg文件,以python2.6版本爲例,egg文件一般安裝在/usr/local/lib/python2.6/dist-packages/目錄下,該目錄下還有一個easy-install.pth文件,用於存放安裝的egg信息。:
$ cd /usr/local/lib/python2.6/dist-packages $ cat easy-install.pth|grep demo ./demo-0.1.0-py2.6.egg $ ls -F|grep demo demo-0.1.0-py2.6.egg/
卸載egg文件很簡單,首先將包含此egg的行從easy-install.pth中刪除,然後刪除egg文件夾即可。
參考: