Question

我有一个插件式模块包。它看起来像这样：

/Plugins 
/Plugins/__init__.py
/Plugins/Plugin1.py
/Plugins/Plugin2.py 
etc...

每个.py文件都包含一个派生自PluginBaseClass的类。所以我需要列出Plugins包中的每个模块，然后搜索任何实现PluginBaseClass的类。理想情况下，我希望能够做到这样的事情：

for klass in iter_plugins(project.Plugins):
    action = klass()
    action.run()

我已经看到了其他一些答案，但我的情况有所不同。我有一个实际导入到基础包（即：import project.Plugins），我需要在发现模块后找到这些类。

Answer 1

您可以（也可能应该）在__all__中定义__init__.py作为您的包中子模块的列表;这样你就可以支持那些from Plugins import *人。如果您已经这样做了，可以使用

迭代模块

import Plugins
import sys
modules = { }
for module in Plugins.__all__:
    __import__( module )
    modules[ module ] = sys.modules[ module ]
    # iterate over dir( module ) as above

此处发布的另一个答案失败的原因是__import__导入最低级别的模块，但返回顶级模块（请参阅docs）。我不知道为什么。

Answer 2

编辑：这是一个经过修改的解决方案。我意识到我在测试前一个错误时犯了一个错误，但它并没有按照你期望的方式运行。所以这是一个更完整的解决方案：

import os
from imp import find_module
from types import ModuleType, ClassType

def iter_plugins(package):
    """Receives package (as a string) and, for all of its contained modules,
    generates all classes that are subclasses of PluginBaseClass."""

    # Despite the function name, "find_module" will find the package
    # (the "filename" part of the return value will be None, in this case)
    filename, path, description = find_module(package)

    # dir(some_package) will not list the modules within the package,
    # so we explicitly look for files. If you need to recursively descend
    # a directory tree, you can adapt this to use os.walk instead of os.listdir
    modules =  sorted(set(i.partition('.')[0]
                          for i in os.listdir(path)
                          if i.endswith(('.py', '.pyc', '.pyo'))
                          and not i.startswith('__init__.py')))
    pkg = __import__(package, fromlist=modules)
    for m in modules:
        module = getattr(pkg, m)
        if type(module) == ModuleType:  
            for c in dir(module):
                klass = getattr(module, c)
                if (type(klass) == ClassType and
                    klass is not PluginBaseClass and
                    issubclass(klass, PluginBaseClass)):
                    yield klass

我之前的解决方案是：

您可以尝试以下方式：

from types import ModuleType
import Plugins

classes = []
for item in dir(Plugins):
    module = getattr(Plugins, item)
    # Get all (and only) modules in Plugins
    if type(module) == ModuleType:
        for c in dir(module):
            klass = getattr(module, c)
            if isinstance(klass, PluginBaseClass):
                classes.append(klass)

实际上，如果你想要一些模块化，那就更好了：

from types import ModuleType

def iter_plugins(package):
    # This assumes "package" is a package name.
    # If it's the package itself, you can remove this __import__
    pkg = __import__(package)
    for item in dir(pkg):
        module = getattr(pkg, item)
        if type(module) == ModuleType:  
            for c in dir(module):
                klass = getattr(module, c)
                if issubclass(klass, PluginBaseClass):
                    yield klass

Answer 3

扫描模块不是一个好主意。如果您需要课程注册表，则应查看metaclasses或使用zope.interface等现有解决方案。通过元类的简单解决方案可能看起来像这样：

from functools import reduce
class DerivationRegistry(type):
    def __init__(cls,name,bases,cls_dict):
        type.__init__(cls,name,bases,cls_dict)
        cls._subclasses = set()
        for base in bases:
            if isinstance(base,DerivationRegistry):
                base._subclasses.add(cls)

    def getSubclasses(cls):
        return reduce( set.union,
                       ( succ.getSubclasses() for succ  in cls._subclasses if isinstance(succ,DerivationRegistry)),
                       cls._subclasses)

class Base(object):
    __metaclass__ = DerivationRegistry

class Cls1(object):
    pass

class Cls2(Base):
    pass

class Cls3(Cls2,Cls1):
    pass

class Cls4(Cls3):
    pass

print(Base.getSubclasses())

Answer 4

如果你不知道提前Plugins会发生什么，你可以在包的目录中获得一个python文件列表，然后像这样导入它们：

# compute a list of modules in the Plugins package

import os
import Plugins
plugin_modules = [f[:-3] for f in os.listdir(os.path.dirname(Plugins.__file__)) 
                  if f.endswith('.py') and f != '__init__.py']

对不起，对于一个比较新的python的人来说，这种理解可能会让人满口。这是一个更详细的版本（可能更容易理解）：

plugin_modules = []

package_path = Plugins.__file__
file_list = os.listdir(os.path.dirname(package_path))
for file_name in file_list:
    if file_name.endswith('.py') and file_name != '__init__.py':
        plugin_modules.append(file_name)

然后您可以使用__import__获取模块：

# get the first one
plugin = __import__('Plugins.' + plugin_modules[0])

如何在python中发现特定包中的类？

4 个答案: