我需要一种工作方法来获取从Python基类继承的所有类。


当前回答

新风格的类(即从object继承的子类,这是Python 3中的默认值)有__subclasses__方法,该方法返回子类:

class Foo(object): pass
class Bar(Foo): pass
class Baz(Foo): pass
class Bing(Bar): pass

下面是子类的名称:

print([cls.__name__ for cls in Foo.__subclasses__()])
# ['Bar', 'Baz']

下面是子类本身:

print(Foo.__subclasses__())
# [<class '__main__.Bar'>, <class '__main__.Baz'>]

确认子类确实将Foo列为基类:

for cls in Foo.__subclasses__():
    print(cls.__base__)
# <class '__main__.Foo'>
# <class '__main__.Foo'>

注意,如果你想要子类,你必须递归:

def all_subclasses(cls):
    return set(cls.__subclasses__()).union(
        [s for c in cls.__subclasses__() for s in all_subclasses(c)])

print(all_subclasses(Foo))
# {<class '__main__.Bar'>, <class '__main__.Baz'>, <class '__main__.Bing'>}

注意,如果一个子类的类定义还没有被执行——例如,如果子类的模块还没有被导入——那么这个子类还不存在,__subclasses__将找不到它。


你提到了“以其名字命名”。由于Python类是一级对象,所以不需要使用带有类名的字符串来代替类或类似的东西。您可以直接使用该类,而且您可能应该这样做。

如果你确实有一个表示类名的字符串,并且你想要找到该类的子类,那么有两个步骤:找到给定其名称的类,然后像上面那样找到带有__subclasses__的子类。

如何从名称中找到类取决于您希望在哪里找到它。如果您希望在与试图定位类的代码相同的模块中找到它,那么

cls = globals()[name]

会起作用,或者在不太可能的情况下,你期望在当地人身上找到它,

cls = locals()[name]

如果这个类可以在任何模块中,那么你的名称字符串应该包含完全限定的名称——比如'pkg.module '。Foo'而不是Foo'。使用importlib加载类的模块,然后检索相应的属性:

import importlib
modname, _, clsname = name.rpartition('.')
mod = importlib.import_module(modname)
cls = getattr(mod, clsname)

无论你如何找到这个类,cls.__subclasses__()将返回它的子类列表。

其他回答

如果你只想要直接的子类,那么.__subclasses__()就可以了。如果你想要所有的子类,子类的子类等等,你需要一个函数来为你做这些。

下面是一个简单易读的函数,它可以递归地找到给定类的所有子类:

def get_all_subclasses(cls):
    all_subclasses = []

    for subclass in cls.__subclasses__():
        all_subclasses.append(subclass)
        all_subclasses.extend(get_all_subclasses(subclass))

    return all_subclasses

Python 3.6 - __init_subclass__

正如其他回答提到的,你可以检查__subclasses__属性来获得子类列表,因为python 3.6你可以通过重写__init_subclass__方法来修改这个属性的创建。

class PluginBase:
    subclasses = []

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.subclasses.append(cls)

class Plugin1(PluginBase):
    pass

class Plugin2(PluginBase):
    pass

这样,如果你知道你在做什么,你可以重写__subclasses__的行为,并从这个列表中省略/添加子类。

下面是一个简单但有效的代码版本:

def get_all_subclasses(cls):
    subclass_list = []

    def recurse(klass):
        for subclass in klass.__subclasses__():
            subclass_list.append(subclass)
            recurse(subclass)

    recurse(cls)

    return set(subclass_list)

它的时间复杂度是O(n)如果没有多重继承,n是所有子类的数目。 它比递归地创建列表或使用生成器生成类的函数更有效,后者的复杂度可能是(1)O(nlogn)当类层次结构是平衡树时,或(2)O(n²)当类层次结构是有偏树时。

新风格的类(即从object继承的子类,这是Python 3中的默认值)有__subclasses__方法,该方法返回子类:

class Foo(object): pass
class Bar(Foo): pass
class Baz(Foo): pass
class Bing(Bar): pass

下面是子类的名称:

print([cls.__name__ for cls in Foo.__subclasses__()])
# ['Bar', 'Baz']

下面是子类本身:

print(Foo.__subclasses__())
# [<class '__main__.Bar'>, <class '__main__.Baz'>]

确认子类确实将Foo列为基类:

for cls in Foo.__subclasses__():
    print(cls.__base__)
# <class '__main__.Foo'>
# <class '__main__.Foo'>

注意,如果你想要子类,你必须递归:

def all_subclasses(cls):
    return set(cls.__subclasses__()).union(
        [s for c in cls.__subclasses__() for s in all_subclasses(c)])

print(all_subclasses(Foo))
# {<class '__main__.Bar'>, <class '__main__.Baz'>, <class '__main__.Bing'>}

注意,如果一个子类的类定义还没有被执行——例如,如果子类的模块还没有被导入——那么这个子类还不存在,__subclasses__将找不到它。


你提到了“以其名字命名”。由于Python类是一级对象,所以不需要使用带有类名的字符串来代替类或类似的东西。您可以直接使用该类,而且您可能应该这样做。

如果你确实有一个表示类名的字符串,并且你想要找到该类的子类,那么有两个步骤:找到给定其名称的类,然后像上面那样找到带有__subclasses__的子类。

如何从名称中找到类取决于您希望在哪里找到它。如果您希望在与试图定位类的代码相同的模块中找到它,那么

cls = globals()[name]

会起作用,或者在不太可能的情况下,你期望在当地人身上找到它,

cls = locals()[name]

如果这个类可以在任何模块中,那么你的名称字符串应该包含完全限定的名称——比如'pkg.module '。Foo'而不是Foo'。使用importlib加载类的模块,然后检索相应的属性:

import importlib
modname, _, clsname = name.rpartition('.')
mod = importlib.import_module(modname)
cls = getattr(mod, clsname)

无论你如何找到这个类,cls.__subclasses__()将返回它的子类列表。

一般形式的最简单解:

def get_subclasses(cls):
    for subclass in cls.__subclasses__():
        yield from get_subclasses(subclass)
        yield subclass

和类方法,如果你有一个单一的类,你继承:

@classmethod
def get_subclasses(cls):
    for subclass in cls.__subclasses__():
        yield from subclass.get_subclasses()
        yield subclass