Practical Python项目解析：深入理解Python迭代协议

Practical Python项目解析：深入理解Python迭代协议

practical-python Practical Python Programming (course by @dabeaz) 项目地址: https://gitcode.com/gh_mirrors/pr/practical-python

什么是迭代协议

Python中的迭代协议（Iteration Protocol）是Python语言中一个基础但强大的特性，它定义了对象如何被迭代。简单来说，任何实现了迭代协议的对象都可以在for循环中使用。

迭代协议由两个核心方法组成：

1. __iter__() - 返回一个迭代器对象
2. __next__() - 返回容器中的下一个项目

迭代协议的工作原理

当你使用for循环遍历一个对象时，Python内部实际上执行了以下操作：

_iter = obj.__iter__()  # 获取迭代器对象
while True:
    try:
        x = _iter.__next__()  # 获取下一个元素
        # 执行循环体代码
    except StopIteration:  # 没有更多元素时
        break

Python中常见的可迭代对象

Python中许多内置类型都天然支持迭代：

# 字符串迭代
for char in "hello":
    print(char)

# 字典迭代键
for key in {"name": "Dave", "password": "foo"}:
    print(key)

# 列表迭代
for num in [1, 2, 3, 4]:
    print(num)

# 文件迭代行
with open('data.txt') as f:
    for line in f:
        print(line)

手动实现迭代

理解迭代协议的最好方式就是手动操作一个迭代器：

nums = [1, 9, 4, 25, 16]
it = nums.__iter__()  # 获取迭代器
print(it.__next__())  # 输出: 1
print(it.__next__())  # 输出: 9
print(it.__next__())  # 输出: 4
# 直到抛出StopIteration异常

Python还提供了内置函数next()作为__next__()的快捷方式：

f = open('data.txt')
print(next(f))  # 读取第一行
print(next(f))  # 读取第二行

自定义可迭代类

让我们通过Practical Python项目中的一个例子来学习如何使自定义类支持迭代。假设我们有一个Portfolio类：

class Portfolio:
    def __init__(self, holdings):
        self._holdings = holdings  # 持有股票列表
    
    def __iter__(self):
        return self._holdings.__iter__()  # 委托给列表的迭代器
    
    @property
    def total_cost(self):
        return sum(s.shares * s.price for s in self._holdings)

这样修改后，Portfolio实例就可以在for循环中使用了：

portfolio = Portfolio(stock_list)
for stock in portfolio:
    print(stock.name, stock.shares)

完善容器类功能

为了使Portfolio更像一个完整的容器类，我们可以实现更多特殊方法：

class Portfolio:
    # ... 其他方法 ...
    
    def __len__(self):
        return len(self._holdings)  # 支持len()函数
    
    def __getitem__(self, index):
        return self._holdings[index]  # 支持索引访问
    
    def __contains__(self, name):
        return any(s.name == name for s in self._holdings)  # 支持in操作符

现在Portfolio实例支持更多Python容器操作：

print(len(portfolio))  # 获取持有的股票数量
print(portfolio[0])  # 获取第一支股票
print('IBM' in portfolio)  # 检查是否持有IBM

为什么迭代协议重要

理解迭代协议有以下几个好处：

1. 可以创建自定义的可迭代对象
2. 深入理解Python内部工作机制
3. 编写更符合Python风格的代码
4. 能够处理大型数据集（通过生成器实现惰性求值）

实际应用建议

1. 当包装一个现有序列时，通常只需将__iter__()委托给内部序列
2. 对于自定义容器，考虑实现完整的容器协议（__len__, __getitem__, __contains__等）
3. 记住迭代是一次性的，迭代器耗尽后需要重新获取
4. 对于大型数据集，考虑使用生成器实现惰性迭代

通过掌握迭代协议，你可以创建更灵活、更Pythonic的代码，并深入理解Python的核心机制。

practical-python Practical Python Programming (course by @dabeaz) 项目地址: https://gitcode.com/gh_mirrors/pr/practical-python