Python命名元组：让你的数据结构更具可读性与可维护性！

发表于 2024-10-07 21:04:09 更新于 2024-11-18 23:00:57 分类于 Python

什么是 `namedtuple`

在 Python 中，namedtuple 是一个工厂函数，用于创建类似于普通元组的对象，但它还可以通过名字来访问字段。namedtuple 存在于 Python 标准库的 collections 模块中，它提供了轻量级的数据结构，结合了字典和元组的优点。

通常，元组通过索引访问元素，例如 tuple[0]、tuple[1] 等，而 namedtuple 则让你可以通过字段名直接访问元素，使代码更加易读。例如，使用 namedtuple 后，你可以像访问对象属性一样，直接使用 tuple.fieldname 访问元素。

为什么要使用 `namedtuple`

namedtuple 的主要优势是它提供了简洁的数据结构，适合用于那些字段固定、且不需要太多可变操作的数据模型。它既具备了元组的简单性与高效性，又拥有字典或对象的可读性和字段命名。

内存效率：相比于 dict 或自定义 class，namedtuple 使用的内存要少得多。
可读性：相比于普通的元组，namedtuple 通过字段名访问数据，增加了代码的可读性，减少了因索引出错的风险。
不可变性：像普通元组一样，namedtuple 的实例是不可变的，意味着一旦创建，就不能修改它的字段值，这有助于创建安全的、不可变的数据结构。

如何使用 `namedtuple`

基本用法

我们可以通过 collections.namedtuple() 函数创建一个 namedtuple 类型。以下是一个基本的例子：

from collections import namedtuple

# 创建一个 namedtuple 类型 'Person'
Person = namedtuple('Person', ['name', 'age', 'city'])

# 实例化 namedtuple
person = Person(name='Alice', age=30, city='New York')

# 通过名字访问字段
print(person.name)  # 输出: Alice
print(person.age)   # 输出: 30
print(person.city)  # 输出: New York

# 通过索引访问字段
print(person[0])    # 输出: Alice

在这个例子中，我们定义了一个名为 Person 的 namedtuple，它有 name、age 和 city 三个字段。然后，我们通过字段名或索引来访问这些字段的值。

字段默认值

在使用 namedtuple 时，我们可以给字段提供默认值。可以通过继承 namedtuple 并扩展其功能实现这一点：

from collections import namedtuple

# 创建一个 namedtuple 类型并设置默认值
Person = namedtuple('Person', ['name', 'age', 'city'])
Person.__new__.__defaults__ = ('Unknown', 0, 'Unknown')

person = Person(name='Alice')
print(person)  # 输出: Person(name='Alice', age=0, city='Unknown')

在这个例子中，我们为 age 和 city 设置了默认值，因此在实例化 Person 时，如果没有为这些字段提供值，它们会自动使用默认值。

`_replace()` 方法

namedtuple 是不可变的，但如果想在保留原有结构的基础上修改某些字段，可以使用 namedtuple 的 _replace() 方法，该方法会创建一个新的对象：

1 2	person = person._replace(age=35) print(person) # 输出: Person(name='Alice', age=35, city='New York')

这样，原来的 person 实例不会被修改，而是返回了一个带有新 age 值的副本。

转换为字典

有时可能需要将 namedtuple 转换为字典，namedtuple 提供了一个 _asdict() 方法，可以将其转换为 OrderedDict：

1 2	person_dict = person._asdict() print(person_dict) # 输出: OrderedDict([('name', 'Alice'), ('age', 35), ('city', 'New York')])

解包 `namedtuple`

namedtuple 支持像普通元组那样的解包操作：

1 2	name, age, city = person print(name, age, city) # 输出: Alice 35 New York

可用字段检查

我们可以通过 ._fields 属性检查一个 namedtuple 的字段：

1	print(Person._fields) # 输出: ('name', 'age', 'city')

类型提示支持

在 Python 3.6 及之后，namedtuple 也支持类型提示，这对使用静态类型检查工具（如 mypy）非常有帮助：

from typing import NamedTuple

class Person(NamedTuple):
    name: str
    age: int
    city: str

这种方式结合了 namedtuple 的简洁性和类型提示的好处，可以帮助你在编写大型应用时保持代码的类型安全。

namedtuple 的原理

namedtuple 的底层其实是生成了一个普通的类，只不过它通过元编程的方式动态生成，并且在生成的类中重载了一些方法，以实现通过字段名访问值的功能。

元组特性：namedtuple 本质上继承了元组的所有特性，因此它是不可变的，并且具备元组的序列化特性（如支持索引和迭代）。
类特性：namedtuple 创建的对象同时具备类的行为，字段名相当于类的属性，使得可以通过 . 语法访问字段。

这个机制通过 __new__ 方法实现，namedtuple 生成的类在初始化时调用 __new__ 来分配内存并初始化元组的值，而非通过 __init__。

这里重写了很多内部方法，后面会用到。

这里内部方法被当做参数传给了 type 类，最终的类是通过 type 动态的生成类，并且继承于 tuple。

namedtuple 的用途

namedtuple 的应用场景非常广泛，尤其适合存储结构化但不可变的数据。常见的使用场景包括：

返回多值结果：当一个函数需要返回多个值时，namedtuple 比普通元组更加清晰直观。
简化数据模型：对于一些简单的数据模型，不需要复杂的类定义时，namedtuple 是一种轻量级的选择。
日志和数据收集：namedtuple 可以方便地用于收集数据和记录日志时的结构化数据存储。

例子：坐标点处理

Point = namedtuple('Point', ['x', 'y'])

def distance(p1, p2):
    return ((p2.x - p1.x)**2 + (p2.y - p1.y)**2) ** 0.5

p1 = Point(0, 0)
p2 = Point(3, 4)

print(distance(p1, p2))  # 输出: 5.0

在这个例子中，Point 作为二维坐标点数据结构，不仅简洁而且提高了代码可读性。

例子：作为函数返回值

Result = namedtuple('Result', ['success', 'data'])

def fetch_data():
    # 模拟获取数据
    return Result(success=True, data={'name': 'Alice', 'age': 30})

result = fetch_data()
if result.success:
    print(result.data)

在函数中使用 namedtuple 作为返回值，可以清晰地表达返回的数据内容。

总结

namedtuple 是 Python 中非常实用且高效的数据结构，它结合了元组的轻量和类的可读性。使用 namedtuple 可以让你的代码更加简洁、清晰，并且能在一些场景下提供内存优化和提高性能。

适当使用 namedtuple 可以减少自定义类的冗余，同时保持代码的可读性，尤其在不需要频繁修改数据的场景下，namedtuple 是非常好的选择。

本文章首发于个人博客 LLLibra146’s blog
本文作者：LLLibra146
更多文章请关注：
版权声明：本博客所有文章除特别声明外，均采用 © BY-NC-ND 许可协议。非商用转载请注明出处！严禁商业转载！
本文链接：
https://blog.d77.xyz/archives/5e237e06.html

什么是 namedtuple

为什么要使用 namedtuple

如何使用 namedtuple