python之Collections模块的namedtuple函数
Python中的元组(tuple)是大家非常熟悉的类型,它可以存储一个Python对象序列,不过元组与列表有所不同,元组中的元素值是不能被更改的。
由于元组不像字典那样可以为内部的元素命名,在访问元组的时候也只能通过索引访问其中的元素。Python标准模块collections提供了namedtuple函数,它可以创建一个和元组类似但更为强大的类型——具名元组(namedtuple),也就是构造一个带字段名的元组。具名元组增加了数据的可读性和操作上的方便性。
【collections这个模块实现了特定目标的容器,以提供Python标准内建容器 dict , list , set , 和 tuple 的替代选择。其中的namedtuple()是创建命名元组字段的工厂函数(Factory Function for Tuples with Named Fields)
https://docs.python.org/zh-cn/3.9/library/collections.html#collections.namedtuple 】
namedtuple 函数的语法如下所示:
collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)
说明:
★typename 创建的namedtuple返回的对象类型
★field_names 创建的namedtuple每个元素对应的name,不然为啥叫namedtuple呢。这个参数传递的可以是一个列表,一个用空格或者","间隔开的字符串。
★rename 如果为True,则对field_names中的关键字和重复的键(官方文档原文为invalid fieldnames,暂时没想到其他可能无效的键)进行重命名,命名方式为对应参数的位置前加一个占位符"_"
★defaults 只能是None或者一个iterable(可迭代对象,python中具有__item__或__getitem__方法的对象都可称之为iterable),并且该可迭代对象的元素个数不能超过field_names传递的参数个数,不然会报错;这个参数的作用是在创建namedtuple时,传递的参数数量小于field_names参数数量时,用iterable中的元素来填充不足,补足的方式为从可迭代对象的最右端开始逐一填充到field_names的末端。
★moudle 当其值为None的时候,调用.__module__时返回的是__main__
创建一个具名元组,至少需要指明两个参数,一个是类名,另一个是类的各个字段名。后者可以是有多个字符串组成的可迭代对象,或者是有空格分隔开的字段名组成的字符串。具名元组可以通过字段名或者位置来获取一个字段的信息。
使用collections.namedtuple的简单的例子,代码如下:
import collections
PointA = collections.namedtuple('Point', ['x', 'y'])
p = PointA(10, y=20) # 可以使用关键字参数和位置参数初始化namedtuple
p[0] + p[1] # 可以使用索引去获取namedtuple里面的元素,输出:30
x, y = p # 可以将namedtuple拆包
print(x, y) # 输出:10, 20
print(p.x + p.y) # 使用对应的字段名字也可以获取namedtuple里面的元素,输出:30
print(p) # 使用类似name=value的样式增加了数据的可读性,输出:Point(x=10, y=20)
运行之,参见下图:
可见具名元组比普通元组具有更好的可读性,可以使代码更易于维护。同时与字典相比,又更加的轻量和高效。
又如:
from collections import namedtuple
tupleA = namedtuple('User', ['name', 'age', 'id'])
tuple_a = tupleA('Tom', '28', '464643123')
tuple_a # 输出:User(name='Tom', age='28', id='464643123')
参见下图:
具名元组是元组的子类,所以仍适用正常的元组操作,但它更友好,因为创建的具名元组实例,可以按字典方式来访问,如
print(tuple_a[0]) #输出:Tom
print(tuple_a.name)#输出:Tom
参见下图:
有一点需要注意,就是具名元组中的属性都是不可变的。任何尝试改变其属性值的操作都是非法的。如:
报错提示:'User' object does not support item assignment('User'对象不支持项赋值)
使用 ** 运算符将字典转化为namedtuple的例子:
from collections import namedtuple
ss = namedtuple('t', 'a b c')
d0 = {'x':1, 'y':2, 'z':3}
d1 = {'a':1, 'b':2, 'c':3}
#print(ss(**d0)) #报错,原因是键名和field_names不匹配,故注释掉
print(ss(**d1))#正常输出t(a=1, b=2, c=3)
输出:
t(a=1, b=2, c=3)
具名元组除了继承元组的一些方法和特性之外,具名元组还具有以下这些特有的属性和方法。
★类属性_fields:包含这个类所有字段名的元组,如
print(tuple_a._fields) # ('name', 'age', 'id')
参见下图:
★类方法_make(iterable):接受一个可迭代对象来产生这个类的实例,如:
tuple_a_l = tupleA._make(['Lucy', '12', 464464314])
print(tuple_a_l) #输出:User(name='Lucy', age='12', id=464464314)
参见下图:
★方法_asdict():把具名元组以collections.OrdereDict的形式返回,可以利用它来把元组里的信息友好的展示出来,如:
print(tuple_a._asdict()) #输出:{'name': 'Tom', 'age': '28', 'id': '464643123'}
参见下图:
★方法._replace ():修改对象属性,如
tuple_a = tuple_a._replace(age=22)
print(tuple_a) #输出:User(name='Tom', age=22, id='464643123')
参见下图:
附
collections.namedtuple 用法详解完整版https://blog.csdn.net/m0_37586991/article/details/103713691
Python collections中的 namedtuple(命名元组)用法 https://blog.csdn.net/weixin_43064185/article/details/93402831