總是安裝別人的egg包,是不是也想制作自己的egg包呢?好,接下來我們就自己制作一個(gè)簡單的egg包。
首先建立工程目錄egg-demo,初始化一個(gè)setup.py文件:
$ mkdir egg-demo
$ cd egg-demo
$ touch setup.py
$ ls
setup.py
下面主要就是填充setup.py。setup.py其實(shí)是python工具包distutils的配置文件,setuptools就是基于distutils來做的。 在setup.py中通過setup函數(shù)來配置打包信息。首先要引入setuptools的函數(shù)setup。setuptools的setup其實(shí)就是distutils的setup函數(shù),填寫setup.py為以下內(nèi)容:
$ cat setup.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-
from setuptools import setup
setup()
寫到這里,一個(gè)空的egg配置文件就寫好了。我們可以使用下面命令生成egg包:
$ python setup.py bdist_egg
下面看看究竟生成了什么:
$ ls -F
build/ dist/ setup.py UNKNOWN.egg-info/
可以看到多了三個(gè)文件夾。而在dist文件夾下,有一個(gè)egg文件:UNKNOWN-0.0.0-py2.6.egg。
產(chǎn)蛋成功!先看看這個(gè)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
噢,原來就是一個(gè)zip壓縮包呀!好,再來看看內(nèi)部構(gòu)造:
$ 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
只有一個(gè)EGG-INFO文件夾,內(nèi)含五個(gè)egg信息文件,沒了。
這個(gè)egg名稱未知,版本0.0.0。這是因?yàn)槲覀冊趕etup里什么也沒有設(shè)置。
顯然,這個(gè)egg什么也不能做。
下面給它加點(diǎn)料。
在setup.py中,setup函數(shù)接收一系列屬性作為配置參數(shù)。
- name name是egg包的名稱,也是尋找要打包的文件夾的名稱,默認(rèn)是UNKNOWN。
- version 版本號(hào),默認(rèn)0.0.0
- packages 這里要用到setuptools的另一個(gè)函數(shù)find_packages,顧名思義,find_packages用來將指定目錄下的文件打包。
- zip_safe 默認(rèn)是False,這樣在每次生成egg包時(shí)都會(huì)檢查項(xiàng)目文件的內(nèi)容,確保無誤。
還有一些描述性的屬性,如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
可以看到,多了一個(gè)文件夾demo,里面有我們寫的__init__.py。
奉行敏捷原則,先安裝了體驗(yàn)一下再說:
$ 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.
成功輸出!這說明安裝正確。我們的一個(gè)egg包誕生了。
一般情況下,我們的源程序都放在src目錄下,所以接下來將demo文件夾移動(dòng)到src里。但這樣也要修改setup.py文件,修改find_packages函數(shù)中參數(shù)為'src',同時(shí)增加package_dir參數(shù):
packages=find_packages('src'),
package_dir = {'':'src'}
這樣告訴setuptools在src目錄下找包,而不是原來默認(rèn)的工程根目錄。
|