Python 自动注册子类

问题描述

假如有个基类Base,现在想在Base中记录所有继承了Base的基类
实现的效果是这样的：

    class Foo1(Base):
        pass

    class Foo(object):
        pass

    class Foo2(Base):
        pass

    class Sun(Base):
        pass

    for item in Base:
        print(item)

    print(Foo in list(Base))
    print(Foo2 in list(Base))
    print(list(Base))

输出结果：

Foo1
Foo2
Sun
False
True
[Foo1, Foo2, Sun]

Key Points

• python 中类的本质也是对象
• 创建类也类似一个对象的创建过程
• 元类控制类的创建
• 指定Base的元类， Base的所有子类在创建时都会进入元类中的_new_方法，在此方法中进行记录

Codes

# 使用 python 元类解决这个问题
class BaseMetaClass(type):
    record_cls = []

    def __iter__(self):
        for item in BaseMetaClass.record_cls:
            yield item

    # 控制类的打印名称
    def __repr__(cls):
        return cls.__name__

    def __new__(cls, name, bases, attrs):
        new_cls = type.__new__(cls, name, bases, attrs)
        if name != 'Base':
            BaseMetaClass.record_cls.append(new_cls)
        return new_cls


class Base(object, metaclass=BaseMetaClass):
    def __init__(self):
        pass

    def __iter__(self):
        yield BaseMetaClass

深入探究

过程分析

• 指定Base的关键字metaclass时，就指定了所有的Base类在创建时，都需要通过metaclass 中的__new__ 方法进行创建。__new__() 方法中指定的四个参数的含义分别是：1. cls 当前准备创建的类， 2.name 当前创建的类的名字。3. bases类继承的父类集合 4. 类方法集合
• type.__new__(cls, name, base, attrs) 返回的是什么的是什么类型的？是BaseMetaClass类型的，编写了下面这样的测试代码：

class BaseMetaClass(type):
    record_names = []

    def __iter__(self):
        for item in BaseMetaClass.record_names:
            yield item

    # 控制类的打印名称
    def __repr__(cls):
        return cls.__name__

    def __new__(cls, name, bases, attrs):
        new_cls = type.__new__(cls, name, bases, attrs)
        print("type of {} is {} name is {}".format(name, type(new_cls), new_cls.__name__))
        if name != 'Base':
            BaseMetaClass.record_names.append(new_cls)
        return new_cls

print 的结果是:

type of Base is  name is Base
type of Foo1 is  name is Foo1
type of Foo2 is  name is Foo2
type of Sun is  name is Sun

总结这段代码的意义： Base, Foo1, Foo2, Sun虽然是我们定义的类，但是他们都是BaseMetaClass这个类的对象。它们的类型由name进行区分

• 由于Base是继承自BaseMetaClass, Base和其任意子类在定义时都会在BaseMetaClass的__new__()中创建类的对象
• 我们在BaseMetaClass 的__new__()中记录，就知道了Base究竟有哪些子类。