插件问题回答第5题

问题原贴： http://cloverprince.iteye.com/admin/blogs/481307

[quote]5. 现有一个主程序用Python语言写成。现在要允许第三方开发人员编写扩展的类，约定第三方开发的类必须包含一个继承自某个已知类（如class FooPlugin）的子类，名称不限。如果要求第三方的类必须与主程序的py脚本或pyc字节码分开发布，把py或pyc丢在某个文件夹内即可被动态装载使用，应如何实现？
[/quote]

回答：

Python的imp模块提供了加载模块的方法。一旦加载了模块，其中的函数、类，就可以直接用成员运算符“.”访问。

适用范围：

Python2.x


实现：

Python是动态语言，定义接口不是必须的，只要你知道如何“对待”这些对象即可。

插件设计如下
一个插件：

def hello():
    print "Hello world!"

class Hello():
    def set_name(self,name):
        self.name=name
    def greet(self):
        print "Hello, %s" % (self.name,)

plugin_class = Hello

最后一行，plugin_class是为了让不同的插件有相同的“接口”（程序员想象中的接口即可，即：知道这个类叫plugin_class这个名字）。

另一个插件

def hello():
    print "Goodbye world!"

class Goodbye():
    def set_name(self,name):
        self.name=name
    def greet(self):
        print "Goodbye, %s" % (self.name,)

plugin_class = Goodbye

主程序只要装载它们。

import imp
import os

PLUGINS_PATH = "plugins"
SUFFIXES = [tup[0] for tup in imp.get_suffixes()]

def split_suffix(name):
    for suffix in SUFFIXES:
        if name.endswith(suffix):
            return (name[:-len(suffix)],suffix)
    return None

module_names = set(split_pair[0]
                   for split_pair
                   in map(split_suffix,os.listdir(PLUGIN_PATH))
                   if split_pair is not None)

plugin_modules = []

for module_name in module_names:
    rv = imp.find_module(module_name,[PLUGINS_PATH])
    if rv is not None:
        mod = imp.load_module(module_name,*rv)
        plugin_modules.append(mod)

for mod in plugin_modules:
    mod.hello()
    obj = mod.plugin_class()
    obj.set_name("cloverprince")
    obj.greet()

运行：

目录结构如下：
[quote].
│ main.py
│
└─plugins
goodbye.py
hello.py
[/quote]

执行结果：
[quote]Hello world!
Hello, cloverprince
Goodbye world!
Goodbye, cloverprince[/quote]


总结：

1. 主程序并不了解plugins目录中有多少插件。在运行时列举目录。
2. 主程序对每个plugins文件（比如叫hello.py）的了解只有：
- 这个模块中有一个叫做hello()的函数
- 这个模块中有一个类，名字虽然不知道，但是可以用plugin_class()这样的调用来获得实例（plugin_class不一定是类，也可以是工厂函数，Python运行时的语法都是plugin_class()）
- 这个类的实例有set_name()和greet()两个方法。