Build extensible application with egg

在 python 社区中 egg 已经是一种广为人知的格式了。众所周知对于 python 来说 egg 是一种用来生小蛇的东西，小蛇自然就是 python 软件包了(纯属瞎扯 ;-)。

简单地说，egg 之于 python 正如 jar 之于 java。是一种软件包打包的格式——要注意的是这个格式并非文件格式，实际上 egg 可以使用多种文件格式，当然最常用的还是 zip ——这里的格式主要是指组织其中包含的文件的格式。

只是把软件包打包成 zip 格式的话，那就不足为奇了。egg 显然不光是用来干这个的，egg 最重要的作用是给软件包增加元数据！而元数据具体包含些什么内容和它的格式几乎没有什么强制的定义，这给基于 egg 的应用提供了大量发挥的空间。

比如做PyPi软件包注册查找的机制、处理软件包之间的依赖关系等等，比如 setuptools 就是定义了一些元数据的格式，然后软件包的开发者只需按照这种格式把相关信息写进 setup.py ，setuptools 读取到这些信息后就可以帮你干这些事情了。

除此以外，我觉的 egg 最有意思的应用莫过于做为插件系统了。相信把 egg 做为插件系统来用的几个框架大家应该都了解，像 turbogears 的模版插件系统，paste 的可扩展的项目模版，还有 trac 的插件系统等。

一个插件系统莫过于这么几个步骤：框架首先定义一个/些插件的接口；第三方插件替你实现这个/些接口；插件注册；框架发现并使用插件。而 setuptools 和 egg 便可以帮你完成后面两个最麻烦的步骤：注册和发现。

先来看个效果，以下代码能帮你找到你安装过的所有 paste 项目模版(下面用到的 pkg_resources 模块安装 setuptools 后就有)：

In [3]: import pkg_resources

In [4]: pts = list( pkg_resources.iter_entry_points('paste.paster_create_templat
e') )

In [5]: pts
Out[5]:
[EntryPoint.parse('pylons_minimal = pylons.util:MinimalPylonsTemplate'),
EntryPoint.parse('pylons = pylons.util:PylonsTemplate'),
EntryPoint.parse('myghty_modulecomponents = myghty.paste.templates:MCTemplate')
,
EntryPoint.parse('myghty_simple = myghty.paste.templates:SimpleTemplate'),
EntryPoint.parse('myghty_routes = myghty.paste.templates:RoutesTemplate'),
EntryPoint.parse('basic_package = paste.script.templates:BasicPackage'),
EntryPoint.parse('paste_deploy = paste.deploy.paster_templates:PasteDeploy'),
EntryPoint.parse('toscawidgets = toscawidgets.util:ToscaWidgetsTemplate')]

In [6]: pts[0].name
Out[6]: 'pylons_minimal'

In [7]: pts[0].module_name
Out[7]: 'pylons.util'

In [8]: pts[0].attrs
Out[8]: ('MinimalPylonsTemplate',)

In [9]: pts[0].load()
Out[9]: <class 'pylons.util.MinimalPylonsTemplate'>

可以看到最后一步我们就在运行时加载了那个实现了 paste 所定义接口的类。

注册的过程就更简单了，setup.py install 一装就 ok 了。

这个过程中使用到的元数据叫做 entry_points ，entry_points 的格式很简单，其实就是 ini 的格式，一个 group 对应多个 name，

[group_name]
...
...

pkg_resource 中将 name 的格式定义为：

name = some.module:some.attr [extra1,extra2]

而 group_name 则由框架定义，其实就是对应一个接口，插件只需要将自己实现了这个接口的类列在下面，然后 setup.py install 一装，就 ok 了。

现在 setuptools 和 egg 已经帮你干完了这些麻烦事，你还需要做的事情就只剩下：设计你的系统，定义你的插件接口。