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


301

我见过很多人从一个模块中提取所有类的示例,通常是这样的:

# 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()

这可能确实很明显,但是我什么也找不到。谁能帮我吗?


2
此类功能有一个PEP,但被拒绝了。
加里·范德·梅尔维

阅读源代码有"class"什么问题?为什么不行?
S.Lott

66
我猜这个问题是关于要自动化某些任务的,所以以编程方式完成它很重要。大概是发问者认为,通过用眼睛阅读源代码进行手动操作可能是重复的,容易出错的或耗时的。
乔纳森·哈特利

Answers:


386

尝试这个:

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()带谓语。


9
如果我在模块级别(即from optparse import OptionParser)在此模块中导入类,则这些模块将包含在打印列表中。我如何避免这种情况?
克里斯(Chris

5
@phasetwenty,而不是inspect.isclass,您可以使用类似以下内容的方法:inspect.getmembers(sys.modules[__name__], lambda member: member.__module__ == __name__ and isnpect.isclass)
Nadia Alramli 2010年

1
但是dict(inspect.getmembers(sys.modules[__name__])) == globals()总是True如此,那为什么要进口呢?
kojiro 2012年

16
纳迪亚的答案几乎是正确的。更好: inspect.getmembers(sys.modules[__name__], lambda member: inspect.isclass(member) and member.__module__ == __name__
William Budington

1
@JohnM。因为纳迪亚忘记打电话isclass
亚历克斯·霍尔

20

关于什么

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


这就是我通常要做的。其他答案似乎更“干净”,但他们不知道。
Mizipzor

1
对我来说似乎很干净,尤其是如果您过滤isinstance(obj, types.ClassType)
kojiro 2012年

4
我更喜欢这个答案,因为即使没有将当前模块放入sys.modules中,它也可以工作,例如,来自docs.python.org/2/library/functions.html#execfile
Chris Smith,

@ChrisSmith特别是,我今天发现一些调试器(例如以pudb这种方式运行程序)导致代码sys.modules在调试时随机中断。globals()似乎有点丑陋,但似乎更可靠。
索伦·比约恩斯塔德

15

我不知道是否有“适当的”方法来执行此操作,但是您的代码片段import foo处在正确的轨道上:只需将其添加到foo.py中,do inspect.getmembers(foo),它就可以正常工作。


哇,我原本以为这会产生循环依赖或类似的东西,但是行得通!
mcccclean

您没有循环依赖项或导入循环的原因是,一旦导入模块,便会将其添加到全局名称空间中。当导入的模块被执行并进入'import foo'时,它将跳过导入,因为该模块已经在全局变量中可用。如果您将foo作为main(作为脚本)执行,则该模块实际上会运行两次,因为当您导入'import foo'时,main将在全局名称空间中,但不在foo中。在'import foo'之后,' main '和'foo'都将在globals命名空间中。
galinden

10

我能够从dir内置plus中获得所需的一切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']
        )
    ))

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

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


4

如果要拥有属于当前模块的所有类,则可以使用以下方法:

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。该语句检查该类是否确实属于该模块。

谓词是一个函数(可调用),它返回布尔值。


3

另一个可在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()

在3.6.8中不起作用。我没有模块错误。
Aviral Srivastava

3

这是我用来获取当前模块中已定义(即未导入)的所有类的行。根据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__]

根据我的经验,这是更有用的。



0

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

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())`

如果您需要自己的课程


0

我经常发现自己在编写命令行实用程序,其中第一个参数旨在引用许多不同类中的一个。例如./something.py feature command —-arguments,where Feature是一个类,并且command是该类上的一个方法。这是一个使这变得容易的基类。

假设该基类与所有子类都位于一个目录中。然后ArgBaseClass(foo = bar).load_subclasses(),您可以拨打电话,这将返回字典。例如,如果目录如下所示:

  • arg_base_class.py
  • feature.py

假设feature.py工具class Feature(ArgBaseClass),则上述调用load_subclasses将返回{ 'feature' : <Feature object> }。相同的kwargsfoo = 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
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.