MicroPython中requests库修改headers参数的Bug分析与修复

问题背景

在MicroPython v1.24.1版本中，用户报告了一个关于requests库的有趣问题。当使用requests.request()方法发送HTTP请求时，传入的headers参数会被意外修改，添加了额外的头部字段。这个行为与标准Python的requests库行为不一致，也不同于MicroPython早期版本(v1.23.0)的行为。

问题复现

通过以下代码可以复现该问题：

import network
import requests
import time

def do_connect():
    sta_if = network.WLAN(network.STA_IF)
    if not sta_if.isconnected():
        sta_if.active(True)
        sta_if.connect("SSID", "PSK")
        while not sta_if.isconnected():
            pass

do_connect()

HEADERS = {"X-Api-Key": "foobar"}
print(HEADERS)  # 初始headers
requests.request(method="GET", url="https://postman-echo.com/get", headers=HEADERS, timeout=2)
print(HEADERS)  # 请求后的headers

在v1.24.1版本中，输出结果会显示headers被添加了"Host"和"Connection"字段：

{'X-Api-Key': 'foobar'}
{'Host': 'postman-echo.com', 'X-Api-Key': 'foobar', 'Connection': 'close'}

问题分析

这个问题的根源在于MicroPython的requests库实现中，对headers参数的处理方式存在问题。在发送HTTP请求时，库内部需要添加一些必要的HTTP头部字段（如Host和Connection），但实现上直接修改了传入的字典对象，而不是创建一个新的字典副本。

这种行为会带来几个问题：

1. 违反最小意外原则：大多数开发者不会预期函数调用会修改传入的参数
2. 潜在的多线程问题：如果headers字典被多个线程共享，这种修改可能导致竞态条件
3. 与标准库行为不一致：标准Python的requests库会保持传入的headers不变

解决方案

MicroPython开发团队在v1.25.0版本中修复了这个问题。修复方案的核心是：

1. 在修改headers前，先创建传入headers的副本
2. 所有内部添加的头部字段都在这个副本上进行操作
3. 保持原始headers字典不被修改

这个修复确保了函数的纯函数特性，即相同的输入总是产生相同的输出，且不会产生副作用（修改输入参数）。

最佳实践

为了避免类似问题，开发者可以采取以下措施：

1. 使用不可变对象：如果不需要修改传入的参数，可以考虑使用不可变对象
2. 文档说明：如果API确实需要修改参数，应该在文档中明确说明
3. 防御性拷贝：在函数内部对可变参数进行拷贝，避免修改原始对象
4. 版本检查：对于关键功能，可以检查MicroPython版本以确保预期行为

结论

这个bug的修复体现了MicroPython社区对API一致性和开发者体验的重视。虽然这是一个看似小的问题，但它可能在实际项目中导致难以调试的bug。MicroPython团队快速响应并修复了这个问题，展示了开源社区的高效协作。

对于开发者来说，保持MicroPython版本更新是避免类似问题的好方法。同时，了解这类问题的模式也有助于编写更健壮的代码，特别是在资源受限的嵌入式环境中。