Python Cookbook-6.18 用__init__参数自动初始化实例变量
任务
想避免编写和维护一种烦人的几乎什么也不做的__init__方法,这种方法中含有一大堆形如 self.something = something 的赋值语句。
解决方案
可以把那些属性赋值任务抽取出来置入一个辅助函数中:
def attributesFromDict(d):self = d.pop('self')for n,y in d.iteritems():setattr(self,n,v)
而__init__方法里的那种千篇一律的赋值语句大概是这个样子的:
def __init__(self,foo,bar,baz,boom=1,bang=2):self.foo = fooself.bar = barself.baz = bazself.boom = boomself.bang = bang
现在可以被缩减为清晰的一行:
def __init__(self,foo,bar,baz,boom=1,bang=2):attributesFromDict(locals())
讨论
如果__init__的主体中没有其他的逻辑,调用内建函数locals 返回的 dict 只包含了被传递给__init__的参数(包括那些并未被传递但却有默认值的参数)。首先函数attributesFromDict 获取对象,假定这个对象是一个名字为“self”的参数,然后将其他的所有元素作为它的属性名进行设置。一个相似但更简单的技术是,不使用辅助函数而是像下面这样:
def __init__(self,foo,bar,baz,boom=1,bang=2):self.__dict__.update(locals())del self.self
不过,后来给出的这种技术同解决方案给出的方法相比,有一个重大的缺陷:它直接设置 self.__dict__中的属性(通过update方法),对于一些特性(property)和高级描述符(descriptor),它无法正常地工作。而解决方案给出的方法使用了内建的 setattr,在这方面表现得很完美。
attributesFromDict 并不适用于使用了更多代码尤其是使用了本地变量的__init__ 方法因为对于传递给它的唯一的字典参数,attributesFromDict无法区分字典里的传递给__init__的参数以及__init__内部的局部变量。如果你在辅助函数中加入一点内省的能力,这个限制就可以被打破:
def attributesFromArguments(d):self = d.pop('self')codeObject = self.__init__.im_func.func_codeargumentNames = codeObject.co_varnames[1:codeObject.co_argcount]for n in arqumentNames:setattr(self,n,d[n])
通过获取__init__方法的代码对象,attributesFromArguments 函数能够只处理传递给__init__ 的参数名。因此你的__init__方法应当调用 attributesFromArguments(locals( )),而不是 attributesFromDict(locals()),在这个调用之后如果还有需要,可以继续加入更多代码并定义其他局部变量。
attributesFromArguments 最关键的限制是它不支持__init__ 的某种特殊参数,即kw。我们可以通过引入更多的内省来获得处理kw的能力,但那就要求使用更多的黑魔法和引入更多的复杂性,比起获得的这点功能似乎有些不值得。如果你确实想在这方面做些探索,为了实现内省,应当使用标准库的inspect模块,而不是在attributesFromArguments函数中自己实现这个功能。通过使用 inspect.getargspec(self.init),你能够同时知道参数名以及 self.__init__是否接受**kw 形式的参数。关于 insepectgetargspec 的更多信息请参看6.19 节。最后,请记住 Python 编程中的一个至理名言:“尽最用标准库搞定一切!”