2022年 11月 9日

python egg_python egg 简介

$ 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目录下找包,而不是原来默认的工程根目录。