类扩展功能的方法

你有很多有用的方法，想使用它们来扩展其他类的功能。但是这些类并没有任何继承的关系。 因此你不能简单的将这些方法放入一个基类，然后被其他类继承。

假设你想扩展映射对象，给它们添加日志、唯一性设置、类型检查等等功能。下面是一些混入类：

 

from collections import defaultdict


class Log:
    __slots__ = ()

    def __getitem__(self, key):
        print("get" + str(key))
        return super().__getitem__(key)

    def __setitem__(self, key, value):
        print("set" + str(key))
        return super().__setitem__(key, value)

    def __delitem__(self, key):
        print("del" + str(key))
        return super().__delitem__(key)


class SetOnceMappingMixin:
    '''
    Only allow a key to be set once.
    '''
    __slots__ = ()

    def __setitem__(self, key, value):
        if key in self:
            raise KeyError(str(key) + ' already set')
        return super().__setitem__(key, value)


class StringKeysMappingMixin:
    '''
    Restrict keys to strings only
    '''
    __slots__ = ()

    def __setitem__(self, key, value):
        if not isinstance(key, str):
            raise TypeError('keys must be strings')
        return super().__setitem__(key, value)


class LoggedDict(Log, dict):
    pass


class SetOnceDefaultDict(SetOnceMappingMixin, defaultdict):
    pass


d = LoggedDict()
d['x'] = 23
print(d['x'])

d = SetOnceDefaultDict(list)
d['x'].append(2)

d['x'].append(3)
print(d['x'])
d['x']=23#KeyError: 'x already set'

这个例子中，可以看到混入类跟其他已存在的类(比如dict、defaultdict和OrderedDict)结合起来使用，一个接一个。 结合后就能发挥正常功效了。

 

对于混入类，有几点需要记住。首先是，混入类不能直接被实例化使用。 其次，混入类没有自己的状态信息，也就是说它们并没有定义 __init__() 方法，并且没有实例属性。 这也是为什么我们在上面明确定义了 __slots__ = () 。

还有一种实现混入类的方式就是使用类装饰器，如下所示：

from collections import defaultdict


def Log(cls):
    cls_getitem = cls.__getitem__
    cls_setitem = cls.__setitem__
    cls_delitem = cls.__delitem__

    def __getitem__(self, key):
        print("get" + str(key))
        return cls_getitem(self,key)

    def __setitem__(self, key, value):
        print("set" + str(key))
        return cls_setitem(self,key, value)

    def __delitem__(self, key):
        print("del" + str(key))
        return cls_delitem(self,key)

    cls.__getitem__ = __getitem__
    cls.__setitem__ = __setitem__
    cls.__delitem__ = __delitem__
    return  cls

@Log
class LoggedDict(dict):
    pass


d = LoggedDict()
d['x'] = 23
print(d['x'])

这个效果跟之前的是一样的，而且不再需要使用多继承了。参考9.12小节获取更多类装饰器的信息