我们都知道,标准的元组 tuple
是使用数字索引来访问其中的成员的,但是在使用时要记住要哪一个数字索引对应哪一个成员值是有点困难的,往往会引发错误,特别是在元组包含了较多的成员时。
这个时候,我们的主角要登场了:namedtuple
,它会为每个成员分配一个索引的同时,再分配一个名称,使用起来就像一个「类」。
namedtuple 主要用来产生可以使用名称来访问元素的数据对象,通常用来增强代码的可读性。
namedtuple 继承自 tuple,但是它有更多更酷的特性,正所谓「青出于蓝」。namedtuple 创建一个和 tuple 类似的对象,而且对象拥有可以访问的属性。这对象更像带有数据属性的类,不过数据属性是只读的。
定义和使用
namedtuple 创建时会需要使用构造函数 namedtuple(),参数是创建类的名称,以及包含元素名称的字符串。
>>> from collections import namedtuple
>>> Person = namedtuple('Person','name age gender')
>>> type(Person)
>>> hoxis = Person('hoxis',18,'male')
>>> print(hoxis)
Person(name='hoxis', age=18, gender='male')
>>> hoxis.name
'hoxis'
>>> hoxis[0]
'hoxis'
从上面例子可以看出,我们可以通过 .
来访问成员(obj.attr
),同时也可以使用数字索引访问。同时,还内置了 repr()
函数。
注意事项
和元组一样,namedtuple 也是不可变的,不能直接改变其成员:
# hoxis 只能是 18 岁,变不了
>>> hoxis.age
18
>>> hoxis.age = 28
Traceback (most recent call last):
File "", line 1, in
AttributeError: can't set attribute
若非要改变,可以使用 _replace()
方法,但是这时其实是生成了一个新的 namedtuple,原来的还是没有改变,不信你看:
# hoxis 还是 18 岁
>>> hoxis_2 = hoxis._replace(age=28)
>>> hoxis
Person(name='hoxis', age=18, gender='male')
>>> hoxis_2
Person(name='hoxis', age=28, gender='male')
其实这里和其他不可变对象类似,若要改变只会返回一个新的数据给你,原来的还是原来的,your daye still your daye。
还有一点,不能使用 Python 自带关键字作为成员名称,如 class
,这时会抛出 ValueError
异常:
>>> Person = namedtuple('Person','name age gender class')
Traceback (most recent call last):
File "", line 1, in
File "/usr/lib/python3.5/collections/__init__.py", line 403, in namedtuple
'keyword: %r' % name)
ValueError: Type names and field names cannot be a keyword: 'class'
成员名称也不能重复:
>>> Person = namedtuple('Person','name age gender age')
Traceback (most recent call last):
File "", line 1, in
File "/usr/lib/python3.5/collections/__init__.py", line 410, in namedtuple
raise ValueError('Encountered duplicate field name: %r' % name)
ValueError: Encountered duplicate field name: 'age'
若非要死皮赖脸说,我就要用 class
,那你需要设置 rename=True
属性:
>>> Person = namedtuple('Person','name age gender class', rename=True)
>>> hoxis = Person('hoxis',18,'male','三年二班')
>>> hoxis
Person(name='hoxis', age=18, gender='male', _3='三年二班')
其实成员名称被重命名了,class 你还是没用上,死皮赖脸也没用。。。
扩展
有没有发现,namedtuple 和 dict 有点像?
其实 namedtuple 有一个内置的方法 ._asdict()
,可以生成一个 dict:
>>> hoxis = Person('hoxis',18,'male')
>>> hoxis_dict = hoxis._asdict()
>>> hoxis_dict
OrderedDict([('name', 'hoxis'), ('age', 18), ('gender', 'male')])
>>> hoxis_dict['age']
18
>>> hoxis_dict['age'] = 28
>>> hoxis_dict
OrderedDict([('name', 'hoxis'), ('age', 28), ('gender', 'male')])
转换成 dict 后,属性就可以改变了。
当然,dict 也可以转换为 namedtuple,其实是用 dict 生成一个 namedtuple:
>>> hoxis = Person(**hoxis_dict)
>>> hoxis
Person(name='hoxis', age=28, gender='male')
总结
相比 tuple 和 dictionary,namedtuple 略微有点综合体的意味:直观、使用方便,你不必使用整数索引来访问一个命名元组,这让你的代码更易于维护。
而且,namedtuple 的每个实例没有对象字典,所以它们很轻量,并不需要更多的内存,这使得它们比字典更快。
建议大家在合适的时候尝试使用 namedtuple,你会回来点赞的~
如果觉得有用,欢迎关注我的微信,一起学习,共同进步,不定期推出赠书活动~