使用 rpclib 編寫 Python Web Service 時,若方法文檔字符串包含中文且未聲明為 Unicode,會導致 WSDL 生成失敗,拋出 ValueError: All strings must be XML compatible: Unicode or ASCII, no NULL bytes or control characters。本文記錄排查過程與根因修復。
@srpc(RequestModel, _returns=Unicode)
def shenzhen(request):
"""根據傳入的 token、車牌號及車駕號,以及驗證碼 查詢該車輛的違章記錄"""
logging.info(request)
query = ShenZhenQuery(request)
return query.query_car_records()
訪問 ?wsdl 返回 502,日志報上述錯誤。刪除文檔字符串或改為純 ASCII 即正常。
rpclib 會將方法的 __doc__ 字符串作為 <wsdl:documentation> 內容嵌入生成的 WSDL XML。u"" 前綴的字符串是 str(字節串),若源文件編碼為 UTF-8,其中文內容實際是 UTF-8 字節序列,非純 ASCII,導致 XML 生成器拋錯。u"" 前綴(Python 2 必須)@srpc(RequestModel, _returns=Unicode)
def shenzhen(request):
u"""根據傳入的 token、車牌號及車駕號,以及驗證碼 查詢該車輛的違章記錄"""
...
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
@srpc(RequestModel, _returns=Unicode)
def shenzhen(request):
"""中文文檔現在自動是 unicode"""
...
<wsdl:documentation>
根據傳入的token、車牌號及車駕號,以及驗證碼 查詢該車輛的違章記錄
</wsdl:documentation>
rpclib 已停止維護,官方推薦遷移至 Spyne。Spyne 原生支持 Python 3、更完善的類型系統、更好的 WSDL/Schema 生成。若項目允許,盡早遷移可避免此類編碼陷阱。
# -*- coding: utf-8 -*-。from __future__ import unicode_literals 習慣,或全面遷移 Python 3。一個 u"" 拯救一個下午的調試,Unicode 處理的核心就是:「內部統一用 Unicode,邊界處編解碼」。