Python2中Pyramid启用unicode_literals后WebTest断言错误的解决方法

我之前在把Pyramid项目从Python2迁到Python3时，刚好碰到过一模一样的问题——加了from __future__ import unicode_literals后，WebTest直接炸出那个AssertionError。核心原因其实很明确：

在Python2里，unicode_literals会让所有字符串字面量默认变成unicode类型，但WebTest在Python2环境下对HTTP头名称的要求是必须是latin1编码的原生str（字节串），两者类型不匹配就触发了断言检查。

下面是几个实用的解决思路，按推荐程度排序：

1. 显式转换请求头的类型（最直接高效） #

在你用WebTest发起请求的代码里，把所有头名称手动转成Python2的str类型就行。比如：

# 原来报错的代码
response = app.get('/api/endpoint', headers={'X-Request-ID': '12345'})

# 修改后，强制转成str
headers = {str('X-Request-ID'): '12345'}
response = app.get('/api/endpoint', headers=headers)

如果要处理大量头，写个小工具函数批量转换更方便：

def normalize_headers(headers):
    if not isinstance(headers, dict):
        return headers
    # Python2下转成str，Python3下保持原样
    import sys
    if sys.version_info[0] == 2:
        return {str(k): v for k, v in headers.items()}
    return headers

# 调用方式
response = app.get('/api/endpoint', headers=normalize_headers({'X-Request-ID': '12345'}))

2. 局部禁用unicode_literals（适合测试文件场景） #

如果只是测试代码里出现这个问题，可以给测试文件单独处理：要么去掉测试文件顶部的from __future__ import unicode_literals，要么针对头名称用b前缀声明字节串（Python2里b'xxx'就是原生str）：

# Python2下直接用字节串当头名称
response = app.get('/api/endpoint', headers={b'X-Request-ID': '12345'})

要是想兼顾Python3兼容性，加个版本判断就行：

import sys
HEADER_KEY = str('X-Request-ID') if sys.version_info[0] == 2 else 'X-Request-ID'

response = app.get('/api/endpoint', headers={HEADER_KEY: '12345'})

3. 升级WebTest版本（看项目兼容性） #

老版本的WebTest对Python2/3的unicode兼容性处理得不够好，你可以试试升级到WebTest 2.x及以上版本，新版本已经修复了这类类型不兼容的问题：

pip install --upgrade webtest

不过升级前记得确认你的Pyramid版本和新WebTest兼容，别搞出新问题。

4. 自定义WebTest适配器（一劳永逸） #

如果不想每个请求都手动处理头，那就自定义一个TestApp子类，自动帮你转换头类型：

import sys
from webtest import TestApp

class UnicodeFriendlyTestApp(TestApp):
    def _make_request(self, *args, **kwargs):
        # 只在Python2下处理头转换
        if sys.version_info[0] == 2:
            headers = kwargs.get('headers')
            if headers:
                kwargs['headers'] = {str(k): v for k, v in headers.items()}
        return super(UnicodeFriendlyTestApp, self)._make_request(*args, **kwargs)

# 替换原来的TestApp初始化
app = UnicodeFriendlyTestApp(your_pyramid_wsgi_app)

这样所有请求都会自动处理头类型，不用再逐个改了。

个人最推荐第一种或第四种方法，既能保留unicode_literals的迁移兼容性，又能彻底解决WebTest的问题。如果只是测试代码，第二种方法也足够简单。

内容的提问来源于stack exchange，提问作者Sean Hammond