将Python应用程序捆绑为一个文件以支持附加组件或扩展名？

Question

有几个公用事业 - 所有实用程序都有不同的程序，限制和目标操作系统 - 用于获取Python软件包及其所有依赖项，并将它们变成一个易于运送给客户的单个二进制程序：

• http://wiki.python.org/moin/freeze
• http://www.pyinstaller.org/
• http://www.py2exe.org/
• http://svn.pythonmac.org/py2app/py2app/trunk/doc/index.html

我的情况更进一步：第三方开发人员将想要为我的应用程序编写插件，扩展程序或附加组件。当然，这是一个令人生畏的问题，例如Windows等平台上的用户如何最容易安装插件或插件，以使我的应用程序可以轻松地发现已安装它们。但是，除了这个基本问题之外，还有另一个：如何将其扩展名与扩展程序本身所需的任何库（可能是二进制模块，例如LXML）捆绑，以使插件的依赖关系可用于相同的导入，插件可用的时间。

如何处理？我的应用程序是否需要在磁盘及其自己的插件注册表上进行自己的插件区域才能使此处理？还是我可以避免写作的一般机制，这将允许一个作为单个可执行文件分发的应用程序可以环顾四周并找到也安装为单个文件的插件？

Answer 1

您应该能够拥有一个插件目录，该插件目录在运行时（或更高版本）扫描以导入有关代码。这是一个示例，该示例应适用于常规的.py或.pyc代码，甚至可以与存储在zip文件中的插件一起使用（因此用户可以在“插件”目录中删除SomePlugin.zip并使其神奇地工作）：

import re, os, sys
class Plugin(object):
    """
    The base class from which all plugins are derived.  It is used by the
    plugin loading functions to find all the installed plugins.
    """
    def __init__(self, foo):
        self.foo = foo
    # Any useful base plugin methods would go in here.

def get_plugins(plugin_dir):
    """Adds plugins to sys.path and returns them as a list"""

    registered_plugins = []

    #check to see if a plugins directory exists and add any found plugins
    # (even if they're zipped)
    if os.path.exists(plugin_dir):
        plugins = os.listdir(plugin_dir)
        pattern = ".py$"
        for plugin in plugins:
            plugin_path = os.path.join(plugin_dir, plugin)
            if os.path.splitext(plugin)[1] == ".zip":
                sys.path.append(plugin_path)
                (plugin, ext) = os.path.splitext(plugin) # Get rid of the .zip extension
                registered_plugins.append(plugin)
            elif plugin != "__init__.py":
                if re.search(pattern, plugin):
                    (shortname, ext) = os.path.splitext(plugin)
                    registered_plugins.append(shortname)
            if os.path.isdir(plugin_path):
                plugins = os.listdir(plugin_path)
                for plugin in plugins:
                    if plugin != "__init__.py":
                        if re.search(pattern, plugin):
                            (shortname, ext) = os.path.splitext(plugin)
                            sys.path.append(plugin_path)
                            registered_plugins.append(shortname)
    return registered_plugins

def init_plugin_system(cfg):
    """
    Initializes the plugin system by appending all plugins into sys.path and
    then using load_plugins() to import them.

        cfg - A dictionary with two keys:
        plugin_path - path to the plugin directory (e.g. 'plugins')
        plugins - List of plugin names to import (e.g. ['foo', 'bar'])
    """
    if not cfg['plugin_path'] in sys.path:
        sys.path.insert(0, cfg['plugin_path'])
    load_plugins(cfg['plugins'])

def load_plugins(plugins):
    """
    Imports all plugins given a list.
    Note:  Assumes they're all in sys.path.
    """
    for plugin in plugins:
        __import__(plugin, None, None, [''])
        if plugin not in Plugin.__subclasses__():
            # This takes care of importing zipped plugins:
            __import__(plugin, None, None, [plugin])

因此，可以说我在一个名为'插件'的目录中有一个名为“ foo.py”的插件（在我的应用程序的基础dir中），该插件将为我的应用程序添加一个新功能。内容可能看起来像这样：

from plugin_stuff import Plugin

class Foo(Plugin):
    """An example plugin."""
    self.menu_entry = {'Tools': {'Foo': self.bar}}
    def bar(self):
        return "foo plugin!"

当我这样启动应用程序时，我可以初始化插件：

plugin_dir = "%s/plugins" % os.getcwd()
plugin_list = get_plugins(plugin_dir)
init_plugin_system({'plugin_path': plugin_dir, 'plugins': plugin_list})
plugins = find_plugins()
plugin_menu_entries = []
for plugin in plugins:
    print "Enabling plugin: %s" % plugin.__name__
    plugin_menu_entries.append(plugin.menu_entry))
add_menu_entries(plugin_menu_entries) # This is an imaginary function

只要插件是.py或.pyc文件（假设该插件是针对该平台的字节编译）。它可以是独立文件，也可以是目录内部的 在里面.py 或者 在具有相同规则的ZIP文件的内部。

我怎么知道这有效？这就是我在 pyci. 。 PYCI是一个Web应用程序，但没有理由为什么这种方法不适合常规的OL'GUI。在上面的示例中，我选择使用虚构的add_menu_entries（）函数与插件对象变量结合使用，该插件可用于将插件的方法添加到GUI的菜单中。

希望此答案将帮助您构建自己的插件系统。如果您想精确地查看如何实现它，建议您下载pyci源代码，并在plugins_enabled目录中查看plugin_utils.py和示例插件。

Answer 2

这是使用插件的Python应用程序的另一个示例： OpenStv. 。在这里，插件只能是Python模块。