列出目录中的类 (Python)

Question

我正在开发一个 Python 2.6 包，在其中我想获取某个目录（包内）中所有类的列表，以便对类对象执行内省。

具体来说，如果包含当前正在执行的模块的目录有一个名为“foobar”的子目录，并且“foobar”包含指定 class Foo(MyBase)、class Bar(MyBase)< 的 .py 文件/code> 和 class Bar2，我想获取继承自 MyBase 的类对象的引用列表，即 Foo 和 < code>Bar，但不是 Bar2。

我不确定这个任务是否真的需要涉及文件系统的任何处理，或者子目录中的模块是否自动加载并且只需要通过某种方式内省列出。请问这里有什么想法吗？非常感谢示例代码，因为我对 Python 还很陌生，尤其是内省。

Answer 1

模块永远不会自动加载，但应该很容易迭代目录中的模块并使用 __import__ 内置函数加载它们：

import os
from glob import glob
for file in glob(os.path.join(os.path.dirname(os.path.abspath(__file__))), "*.py"):
    name = os.path.splitext(os.path.basename(file))[0]
    # add package prefix to name, if required
    module = __import__(name)
    for member in dir(module):
        # do something with the member named ``member``

Answer 2

我想做同样的事情，这就是我最终的结果：

import glob
import importlib
import inspect
import os

current_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)))
current_module_name = os.path.splitext(os.path.basename(current_dir))[0]
for file in glob.glob(current_dir + "/*.py"):
     name = os.path.splitext(os.path.basename(file))[0]

     # Ignore __ files
     if name.startswith("__"):
         continue
     module = importlib.import_module("." + name,package=current_module_name)

     for member in dir(module):
         handler_class = getattr(module, member)

         if handler_class and inspect.isclass(handler_class):
             print member

希望它有帮助..

Answer 3

选项 1：使用 -r 参数 grep for "^class (\a\w+)\(Myclass" 正则表达式。

选项 2：将目录作为包（创建一个空的 __init__.py 文件），导入它并递归地迭代其成员：

import mymodule
def itermodule(mod):
    for member in dir(mymod):
        ...

itermodule(mymodule)

Answer 4

我自己处理过，这是我的版本（分叉@krakover片段）：

• 迭代目录并导入放置在那里的每个脚本
  • 过滤掉抽象类
  • 过滤掉不继承基类的类
  • 每个迭代类的新实例（如果您发现它没有用，请更改它）

---

import importlib
import inspect
import os
import glob


def import_plugins(plugins_package_directory_path, base_class=None, create_instance=True, filter_abstract=True):

    plugins_package_name = os.path.basename(plugins_package_directory_path)

    # -----------------------------
    # Iterate all python files within that directory
    plugin_file_paths = glob.glob(os.path.join(plugins_package_directory_path, "*.py"))
    for plugin_file_path in plugin_file_paths:
        plugin_file_name = os.path.basename(plugin_file_path)

        module_name = os.path.splitext(plugin_file_name)[0]

        if module_name.startswith("__"):
            continue

        # -----------------------------
        # Import python file

        module = importlib.import_module("." + module_name, package=plugins_package_name)

        # -----------------------------
        # Iterate items inside imported python file

        for item in dir(module):
            value = getattr(module, item)
            if not value:
                continue

            if not inspect.isclass(value):
                continue

            if filter_abstract and inspect.isabstract(value):
                continue

            if base_class is not None:
                if type(value) != type(base_class):
                    continue

            # -----------------------------
            # Instantiate / return type (depends on create_instance)

            yield value() if create_instance else value

用法：

SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
plugins_directory_path = os.path.join(SCRIPT_DIR, 'plugins')
plugins = import_plugins(plugins_directory_path, base_class=BasePlugin)

for plugin in plugins:
    plugin.foo()

• 假设有一个名为 plugins 包含 BasePlugin 类的实现

Answer 5

在具有egrep的平台上：

from subprocess import Popen, PIPE
from re import search

def get_classes(directory):
    job = Popen(['egrep', '-ir', '--include=*.py', 'class ', str(directory), ], stdout=PIPE)
    fileout, fileerr = job.communicate()
    if fileerr:
        raise Exception(fileerr)
    while directory[-1] == '/':
        directory = directory[:-1]
    found = []
    for line in fileout.split('\n'):
        match = search('^([^:]+).py:\s*class\s*(\S+)\s*\((\S+)\):', line)
        if match:
            pypath = match.group(1).replace(directory, '').replace('/', '.')[1:]
            cls = match.group(2)
            parents = filter(lambda x: x.strip, match.group(3).split())
            found.append((pypath, cls, parents, ))
    return found

对于get_classes('.')，egrep返回类似以下内容：

./helpers/action.py:class Action(object):
./helpers/get_classes.py:    job = Popen(['egrep', '-ir', '--include=*.py', 'class ', str(directory), ], stdout=PIPE) # this is the get_classes script; not a valid result
./helpers/options.py:class Option(object):

它被转换为路径、类名和直接祖先的元组：

[('helpers.action', 'Action', ['object']), ('helpers.options', 'Option', ['object'])]

如果您只想要路径，那就是< code>[item[0] for get_classes('.')]。