Python製做和使用egg

常常接觸Python的同窗可能會注意到，當須要安裝第三方python包時，可能會用到easy_install命令。easy_install是由PEAK(Python Enterprise Application Kit)開發的setuptools包裏帶的一個命令，它用來安裝egg包。egg包是目前最流行的python應用打包部署方式。如何製做和安裝egg包？下面我就簡單的分析了一下。

1.1   安裝setuptools

首先要安裝setuptools工具。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命令來安裝其餘的egg包了。

1.2   製做本身的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 = "amoblin@ossxp.com",

        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目錄下找包，而不是原來默認的工程根目錄。

1.3   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文件夾便可。