Python设置,安装一个模块作为另一个模块的子模块?

时间:2013-04-15 16:58:31

标签: python setuptools distutils

我想创建一个安装到另一个python包的子模块中作为扩展名的包。

基本上原始模块设置如下:

origmodule/
    __init__.py
    stuff.py
    ext/
        __init__.py
        # This module is empty

然后将我的扩展模块安装到空的origmodule.ext模块中。阅读distutils的说明并不清楚这是否可行或支持。最终目标是,我的扩展模块一旦安装就会像这样导入:

import origmodule.ext.my_extension

1 个答案:

答案 0 :(得分:5)

你无法使用setuptools,在另一个软件包中安装不支持

相反,您想要使用entry points。您的origmodule应该查找注册为特定密钥的入口点的任何内容,并且您的extension模块应该为该密钥注册自己。

您的扩展程序会注册一个扩展点:

entry_points={
    'some.opaque.string.unique.to.origmodule':
        ['my_extension = my.extension.package:some.entry.point', ]
}

您的origmodule可以通过询问pkg_resources

来发现
import pkg_resources

for entrypoint in pkg_resources.iter_entry_points(group='some.opaque.string.unique.to.origmodule'):
    extension = entrypoint.load()

Babel project为例。 Babel可以从文件中提取可翻译的文本;它知道如何为Python源代码执行此操作,但它也支持可以从其他格式中提取此类文本的扩展。

这种提取方法可以注册为扩展点。 Babel在 Writing Extraction Methods部分对此进行了记录。提取文本时的消息提取代码loads those entry points

GROUP_NAME = 'babel.extractors'

# ...

for entry_point in working_set.iter_entry_points(GROUP_NAME,
                                                 method):
    func = entry_point.load(require=True)
    break

Mako templating language提供了这样一个插件;它registers the entry point,指向actual implementation

[babel.extractors]
mako = mako.ext.babelplugin:extract
def extract(fileobj, keywords, comment_tags, options):
    # ...