如何获取 Python 中当前模块内所有类的列表？

问题描述：

我见过很多人从模块中提取所有类的例子，通常是这样的：

# foo.py
class Foo:
    pass

# test.py
import inspect
import foo

for name, obj in inspect.getmembers(foo):
    if inspect.isclass(obj):
        print obj

惊人的。

但我不知道如何从当前模块中获取所有类。

# foo.py
import inspect

class Foo:
    pass

def print_classes():
    for name, obj in inspect.getmembers(???): # what do I do here?
        if inspect.isclass(obj):
            print obj

# test.py
import foo

foo.print_classes()

这可能是很明显的问题，但我找不到任何东西。有人能帮我吗？

解决方案 1：

尝试一下：

import sys
current_module = sys.modules[__name__]

在您的上下文中：

import sys, inspect
def print_classes():
    for name, obj in inspect.getmembers(sys.modules[__name__]):
        if inspect.isclass(obj):
            print(obj)

甚至更好：

clsmembers = inspect.getmembers(sys.modules[__name__], inspect.isclass)

因为inspect.getmembers()采用谓词。

解决方案 2：

我不知道是否有“正确”的方法来做到这一点，但您的代码片段是正确的：只需添加import foo到 foo.py，执行inspect.getmembers(foo)，它就可以正常工作。

解决方案 3：

那么

g = globals().copy()
for name, obj in g.iteritems():

？

解决方案 4：

我能够从dir内置加号中获得我需要的一切getattr。

# Works on pretty much everything, but be mindful that 
# you get lists of strings back

print dir(myproject)
print dir(myproject.mymodule)
print dir(myproject.mymodule.myfile)
print dir(myproject.mymodule.myfile.myclass)

# But, the string names can be resolved with getattr, (as seen below)

不过，它看起来确实像一个毛球：

def list_supported_platforms():
    """
        List supported platforms (to match sys.platform)

        @Retirms:
            list str: platform names
    """
    return list(itertools.chain(
        *list(
            # Get the class's constant
            getattr(
                # Get the module's first class, which we wrote
                getattr(
                    # Get the module
                    getattr(platforms, item),
                    dir(
                        getattr(platforms, item)
                    )[0]
                ),
                'SYS_PLATFORMS'
            )
            # For each include in platforms/__init__.py 
            for item in dir(platforms)
            # Ignore magic, ourselves (index.py) and a base class.
            if not item.startswith('__') and item not in ['index', 'base']
        )
    ))

解决方案 5：

import pyclbr
print(pyclbr.readmodule(__name__).keys())

请注意，stdlib 的 Python 类浏览器模块使用静态源分析，因此它仅适用于由真实文件支持的模块.py。

解决方案 6：

如果您想要拥有属于当前模块的所有类，您可以使用这个：

import sys, inspect
def print_classes():
    is_class_member = lambda member: inspect.isclass(member) and member.__module__ == __name__
    clsmembers = inspect.getmembers(sys.modules[__name__], is_class_member)

如果您使用Nadia的答案并且在模块上导入其他类，那么这些类也将被导入。

这就是为什么member.__module__ == __name__要将 添加到 上使用的谓词中is_class_member。此语句检查该类是否确实属于该模块。

谓词是一个函数（可调用），它返回一个布尔值。

解决方案 7：

这是我用来获取当前模块中已定义的所有类（即未导入的类）的行。根据 PEP-8，它有点长，但您可以根据需要进行更改。

import sys
import inspect

classes = [name for name, obj in inspect.getmembers(sys.modules[__name__], inspect.isclass) 
          if obj.__module__ is __name__]

这将为您提供类名列表。如果您想要类对象本身，只需保留 obj 即可。

classes = [obj for name, obj in inspect.getmembers(sys.modules[__name__], inspect.isclass)
          if obj.__module__ is __name__]

根据我的经验，这更有用。

解决方案 8：

另一个适用于 Python 2 和 3 的解决方案：

#foo.py
import sys

class Foo(object):
    pass

def print_classes():
    current_module = sys.modules[__name__]
    for key in dir(current_module):
        if isinstance( getattr(current_module, key), type ):
            print(key)

# test.py
import foo
foo.print_classes()

解决方案 9：

我认为你可以做这样的事情。

class custom(object):
    __custom__ = True
class Alpha(custom):
    something = 3
def GetClasses():
    return [x for x in globals() if hasattr(globals()[str(x)], '__custom__')]
print(GetClasses())`

如果你需要自己的课程

解决方案 10：

我经常发现自己在编写命令行实用程序时，第一个参数用于引用许多不同类中的一个。例如./something.py feature command —-arguments，其中Feature是一个类，command是该类的一个方法。这里有一个基类，可以很容易地实现这一点。

假设此基类与其所有子类一起位于目录中。然后您可以调用ArgBaseClass(foo = bar).load_subclasses()它将返回一个字典。例如，如果目录如下所示：

• arg_base_class.py

• 特征.py

假设feature.py实现了class Feature(ArgBaseClass)，则上述的调用load_subclasses将返回{ 'feature' : <Feature object> }。相同的kwargs（foo = bar）将被传递到Feature类中。

#!/usr/bin/env python3
import os, pkgutil, importlib, inspect

class ArgBaseClass():
    # Assign all keyword arguments as properties on self, and keep the kwargs for later.
    def __init__(self, **kwargs):
        self._kwargs = kwargs
        for (k, v) in kwargs.items():
            setattr(self, k, v)
        ms = inspect.getmembers(self, predicate=inspect.ismethod)
        self.methods = dict([(n, m) for (n, m) in ms if not n.startswith('_')])

    # Add the names of the methods to a parser object.
    def _parse_arguments(self, parser):
        parser.add_argument('method', choices=list(self.methods))
        return parser

    # Instantiate one of each of the subclasses of this class.
    def load_subclasses(self):
        module_dir = os.path.dirname(__file__)
        module_name = os.path.basename(os.path.normpath(module_dir))
        parent_class = self.__class__
        modules = {}
        # Load all the modules it the package:
        for (module_loader, name, ispkg) in pkgutil.iter_modules([module_dir]):
            modules[name] = importlib.import_module('.' + name, module_name)

        # Instantiate one of each class, passing the keyword arguments.
        ret = {}
        for cls in parent_class.__subclasses__():
            path = cls.__module__.split('.')
            ret[path[-1]] = cls(**self._kwargs)
        return ret

解决方案 11：

import Foo 
dir(Foo)

import collections
dir(collections)

解决方案 12：

以下内容可以放在文件顶部：

def get_classes():
    import inspect, sys
    return dict(inspect.getmembers(
        sys.modules[__name__],
        lambda member: inspect.isclass(member) and member.__module__ == __name__
    ))

请注意，这可以放在模块的顶部，因为我们已将逻辑包装在函数定义中。如果您希望字典作为顶级对象存在，则需要将定义放在文件底部以确保包含所有类。

解决方案 13：

转到 Python 解释器。输入help ('module_name')，然后按 Enter。例如help('os')。在这里，我粘贴了以下输出的一部分：

class statvfs_result(__builtin__.object)
     |  statvfs_result: Result from statvfs or fstatvfs.
     |
     |  This object may be accessed either as a tuple of
     |    (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),
     |  or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.
     |
     |  See os.statvfs for more information.
     |
     |  Methods defined here:
     |
     |  __add__(...)
     |      x.__add__(y) <==> x+y
     |
     |  __contains__(...)
     |      x.__contains__(y) <==> y in x