插件架构-插件管理器与从插件导入检查*

Question

我当前正在编写一个应用程序，允许用户通过“插件”类型的体系结构对其进行扩展。他们可以基于我提供的BaseClass对象编写其他python类，并针对各种应用程序信号加载这些类。在启动应用程序之前，作为插件加载的类的确切数目和名称是未知的，但在启动时仅加载一次。

在研究解决此问题的最佳方法的过程中，我提出了两种常见的解决方案。

选项1-使用imp，pkgutil等自行滚动。
例如，参见此答案或此答案。

选项2-使用插件管理器库
随机选择一对

• 直接插件
• ya
• 这种方法

我的问题是-在其前提是应用程序必须以加载新的插件重新启动-
是有过一些上述方法从灵感任何好处此SO答案和这一个，如：

import inspect
import sys
import my_plugins

def predicate(c):
    # filter to classes
    return inspect.isclass(c)

def load_plugins():
    for name, obj in inspect.getmembers(sys.modules['my_plugins'], predicate):
        obj.register_signals()

与上述方法相比，该方法是否有任何缺点？（除了所有的插件必须在同一个文件中）谢谢！

编辑
注释需要更多信息…我唯一想添加的就是插件使用眨眼程序库提供它们所订阅的信号。每个插件可以订阅不同类型的不同信号，因此必须具有自己的特定“注册”方法。

Answer 1

在Python <3.6中，元类方法对于此问题很有用（请参阅@quasoft对于Python
3.6+的回答）。它非常简单，并且可以自动对任何导入的模块起作用。另外，可以很轻松地将复杂的逻辑应用于插件注册。这个需要：

在元类方法的工作原理如下所示：

1）定义了一个自定义PluginMount元类，其中维护了所有插件的列表

2）Plugin定义一个将PluginMount其设置为元类的类

3）例如，当导入一个源自Plugin-的对象时MyPlugin，它将触发__init__该元类上的方法。这将注册插件并执行任何特定于应用程序的逻辑和事件订阅。

或者，如果您将PluginMount.__init__逻辑放入其中，则在创建派生类PluginMount.__new__的新实例时将调用该逻辑Plugin。

class PluginMount(type):
    """
    A plugin mount point derived from:
        http://martyalchin.com/2008/jan/10/simple-plugin-framework/
    Acts as a metaclass which creates anything inheriting from Plugin
    """

    def __init__(cls, name, bases, attrs):
        """Called when a Plugin derived class is imported"""

        if not hasattr(cls, 'plugins'):
            # Called when the metaclass is first instantiated
            cls.plugins = []
        else:
            # Called when a plugin class is imported
            cls.register_plugin(cls)

    def register_plugin(cls, plugin):
        """Add the plugin to the plugin list and perform any registration logic"""

        # create a plugin instance and store it
        # optionally you could just store the plugin class and lazily instantiate
        instance = plugin()

        # save the plugin reference
        cls.plugins.append(instance)

        # apply plugin logic - in this case connect the plugin to blinker signals
        # this must be defined in the derived class
        instance.register_signals()

然后是一个基本的插件类，如下所示：

class Plugin(object):
    """A plugin which must provide a register_signals() method"""
    __metaclass__ = PluginMount

最后，一个实际的插件类如下所示：

class MyPlugin(Plugin):
    def register_signals(self):
        print "Class created and registering signals"

    def other_plugin_stuff(self):
        print "I can do other plugin stuff"

可以从已导入的任何python模块访问插件Plugin：

for plugin in Plugin.plugins:
    plugin.other_plugin_stuff()

查看完整的工作示例