python元编程之使用动态属性实现定制类--特殊方法__setattr__，__getattribute__篇

Posted 2021-01-23 ZWARD

问题：实现一个类，要求行为如同namedtuple:只存在给定名称的属性，不允许动态添加实例属性。

主要知识点在于: __setattr__,__getattr__,getattribute__,__delattr__特殊方法的实现使用。

代码如下：

 1 """
 2 运行环境
 3 python 3.7+
 4 """
 5 from collections OrderedDict, namedtuple
 6 #以下为要包装的对象：1个命名元组，用于存储计数，并对外传递信息
 7 Counter = namedtuple("Counter", "total put OK failed recorded keys count",
 8                      defaults=(0, 0, 0, 0, 0, 0, 0))
 9 class CounterClass:
10         """
11         内部计数的自定义类,
12         维护一个namedtuple[Counter]
13         """
14 
15         def __init__(self):
16             # _dict用于实际保存并计数
17             self._dict = OrderedDict(Counter._fields_defaults)
18 
19         def __setattr__(self, name, value):
20             """所有的赋值操作都会调用"""
21             #阻止对_dict的直接赋值
22             if (name == ‘_dict‘ and hasattr(self,‘_dict‘) and isinstance(getattr(self, ‘_dict‘), OrderedDict)):
23                 raise ValueError(f‘ Forbidden to modify attribute:[{name}]‘)
24             if name==‘_dict‘:  # 本实现将阻止除了更新计数之外的其它设值及增加属性,模拟了namedtuple抛出异常
25                 super().__setattr__(name,value)
26             elif name in self._dict:
27                 self._dict[name] = value
28             else:
29                 raise ValueError(f‘ Got unexpected field names:[{name}]‘)
30 
31         def __getattribute__(self, name):
32             """
33             __getattribute__在任何属性查找操作中都会调用(包含特殊属性),所以注意以下要super调用
34             否则会陷入无限递归调用.
35             __getattr__方法则是在本身及其类上查找不到才会调用
36             """
37             # 本实现未考虑特殊属性.实际应用时应注意
38             if name in super().__getattribute__(‘_dict‘):
39                 return super().__getattribute__(‘_dict‘)[name]
40             else:
41                 return super().__getattribute__(name)
42 
43         def __delattr__(self, name):
44             """拦截了所有删除操作"""
45             raise ValueError(f‘ Forbidden to delete attribute:[{name}]‘)
46 
47         def update(self, n: Counter = None, **kargs):
48             """
49             使用数值累加计数器
50             当Counter与键参数同时提供时，键值为准
51             """

补充说明，以上部分逻辑并未完整考虑和优化，只是对特殊方法的实现和利用做演示。如果只是模仿命名数组，最简单的就是从命名数组继承即可。

但是根据业务需求，可能需要实现自己的定制类，以上的特殊方法使用就是python元编程中实现动态属性的重要基础。

下一篇将演示用描述符、__slots__、及__new__实现同样功能的类。