Python具名元组的使用方法

collections.namedtuple用于构造带字段名的元组。对应类型为typing.NamedTuple（可用作超类）。

具名元组

namedtuple对象的定义：

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

• typename：元组名称

• field_names：是字段序列（如，[‘x’, ‘y’]）；

• rename：为true时，字段名无效时（如，重名或使用关键字）会被自动替换为位置名（如，_1）；

• defaults：字段的默认值，若为iterable对象，则依次对应field_names中字段的缺省值；

from collections import namedtuple

Color = namedtuple("Color", "r g b alpha")

def convert_to_color(desc: str, alpha: float = 0.0):
    if desc == "green":
        return Color(r=50, g=205, b=50, alpha=alpha)
    elif desc == "blue":
        return Color(r=50, g=0, b=255, alpha=alpha)
    else:
        return Color(r=50, g=0, b=0, alpha=alpha)

从可迭代对象（Iterable）构造具名元组：

c = Color._make([10, 20, 30, 0.1])
nc = Color._make((10, 20, 30, 0.1))

print("r:", c.r)

元组操作

具名元组修改：不能直接修改里面的值，可通过_replace构造一个新的：

c = {"r": 50, "g": 205, "b": 50, "alpha": 0.5}
nc = c._replace(r=100)

把字典转换为具名元组：

c = {"r": 50, "g": 205, "b": 50, "alpha": 0.5}
nc = Color(**c)

具名元组转换为字典（通过_asdict方法）：

c = Color(r=50, g=0, b=0, alpha=0.5)
d = c._asdict()

具名元组转换为元组：

c = Color(r=50, g=0, b=0, alpha=0.5)
t = tuple(c)

属性

• 属性_fields包含所有字段的元组：如('r', 'g', 'b', 'alpha')；

• 属性__annotations__包含字段与对应类型的字典：如{'r': , 'g': , 'b': , 'alpha': }；

• 属性_field_defaults保证有初始值的字段与初始值的字典：如{'alpha': 0.0}；

排序

具名元组排序：通过operator库中的attrgetter可指定排序字段：

from operator import attrgetter

colors = [
    Color(r=50, g=205, b=50, alpha=0.1),
    Color(r=50, g=205, b=50, alpha=0.5),
    Color(r=50, g=0, b=0, alpha=0.3)
]
out = sorted(colors, key=attrgetter("alpha"))
print(out)

与字典比较

字典dict是一种非常通用的数据结构，很容易被滥用，同时相对namedtuple，有以下问题：

• 字典是不可散列，因此无法将其存储在set或其他字典中；

• 字典是可变的，可以根据需要添加任意数量的新键；

与dict类似，在namedtuple中可以将值分配给单个变量并根据需要使用。但：

namedtuple是不可变的，不会意外添加新的值（键）；

数据类

数据类详情可参见《数据类(dataclass)简介》。

dataclass修饰

python3.7中引入了数据类（Data Class），可看做是“具有默认值的可变namedtuple”：

• 可方便地添加doc；

• 可定义可选字段；

from dataclasses import dataclass

# frozen设为true后，字段内容将不允许修改（与namedtuple完全类似）
# 否则可修改字段；并可任意添加字段（如，c.n=1）；
@dataclass(frozen=True)
class DColor:
    """A regular class that represents a color."""
    r: float
    g: float
    b: float
    alpha: float = 0.0

# c = DColor(r=10, g=20, b=30)
c = DColor(10, 20, 30)

继承NamedTuple

通过继承NamedTuple也可方便定义（同时可定义字段的初始值，有初始值的字段必须在无初始字段后面）：

from typing import NamedTuple

class NColor(NamedTuple):
    """A namedtuple that represents a color."""
    r: float
    g: float
    b: float
    alpha: float = 0.0

nc = NColor(100, 110, 120)