python高级容器collections -- namedtuple

collections模块实现了特定目标的容器，以提供Python标准内建容器 dict , list , set , 和 tuple 的替代选择。

包含namedtuple、deque、ChainMap、Counter、OrderedDict、defaultdict等。

本章讲解namedtuple，基于python3.10。

简介

具名元组（namedtuple）赋予每个位置一个含义，提供可读性和自文档性。它们不仅具有普通元组的功能，并添加了通过名字获取值的能力。具名元组也是元组，是不可变容器。

collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)

返回一个新的元组子类，名为 参数typename 。这个新的子类用于创建类元组的对象，可以通过字段名来获取属性值，同样也可以通过索引和迭代获取值。

参数

• typename：该参数指定所创建的tuple子类的类名，相当于用户定义了一个新类；
• field_names：用于指定元组指定位置元素的名称。是一个像 [‘x’, ‘y’] 一样的字符串序列，也可以是一个纯字符串，用空白或逗号分隔开元素名，比如 ‘x y’ 或者 ‘x, y’ ；
  注意：任何有效的Python 标识符都可以作为字段名，除了下划线开头的那些。有效标识符由字母，数字，下划线组成，但首字母不能是数字或下划线，另外不能是关键词 keyword 比如 class, for, return, global, pass, 或 raise 。
• rename：如果 rename 为真， 无效字段名会自动转换成位置名。比如 [‘abc’, ‘def’, ‘ghi’, ‘abc’] 转换成 [‘abc’, ‘_1’, ‘ghi’, ‘_3’]；
• defaults：defaults 可以为 None 或者是一个默认值的 iterable 。如果一个默认值域必须跟其他没有默认值的域在一起出现，defaults 就应用到最右边的参数。比如如果域名 [‘x’, ‘y’, ‘z’] 和默认值 (1, 2) ，那么 x 就必须指定一个参数值 ，y 默认值 1 ， z 默认值 2 ；
• module：module 值有定义，命名元组的 __module__属性值就被设置。

示例

如下，建立一个类似点的具名元组

from collections import namedtuple


Point = namedtuple('Point', ['x', 'y'])
p = Point(11, y=22)
# 通过下标获取元素
print(p[0] + p[1])  # 33
# 拆包
x, y = p
print(x, y)  # 11 22
# 通过名字获取
print(p.x + p.y)  # 33
print(p)  # Point(x=11, y=22)

特有方法和属性

除了继承元组的方法，具名元组还支持三个额外的方法和两个属性。
方法：
_make：从存在的序列或迭代实例创建一个新实例；
_asdict()：将一个具名元组实例转为字典（3.8 版本之前返回的是OrderedDict）；
_replace：返回一个新的具名元组实例，并将指定域替换为新的值。

t = [11, 22]
p2 = Point._make(t)
print(p2)  # Point(x=11, y=22)
print(p2._asdict())  # OrderedDict([('x', 11), ('y', 22)])
p3 = p2._replace(x=33)
print(p3)  # Point(x=33, y=22)

属性：
_fields：返回字符串元组，列出了对象的字段名。可用于从现有元组创建一个新的具名元组类型；

from collections import namedtuple


Point = namedtuple('Point', ['x', 'y'])
p = Point(11, y=22)
print(p._fields)  # ('x', 'y')

Color = namedtuple('Color', 'red green blue')
Pixel = namedtuple('Pixel', Point._fields + Color._fields)
pi = Pixel(11, 22, 128, 255, 0)
print(pi)  # Pixel(x=11, y=22, red=128, green=255, blue=0)

_field_defaults：返回一个字典，列出具名元组具有默认值的字段。

Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
print(Account._field_defaults)  # {'balance': 0}
a = Account('premium')
b = Account(type='premium', balance=0)
print(a)  # Account(type='premium', balance=0)
print(b)  # Account(type='premium', balance=0)

其他方法

getattr()

from collections import namedtuple


Point = namedtuple('Point', ['x', 'y'])
p = Point(11, y=22)
print(getattr(p, 'x'))  # 11

转换一个字典到命名元组

d = {'x': 11, 'y': 22}
print(Point(**d))  # Point(x=11, y=22)

参考

官方文档：https://docs.python.org/zh-cn/3/library/collections.html#module-col