萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

rpclib 生成 WSDL 時中文文檔字符串導致 Unicode 編碼錯誤的解決

使用 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 即正常。

根因分析

  1. rpclib 會將方法的 __doc__ 字符串作為 <wsdl:documentation> 內容嵌入生成的 WSDL XML。
  2. XML 要求內容為合法 Unicode 或 ASCII。Python 2 中無 u"" 前綴的字符串是 str(字節串),若源文件編碼為 UTF-8,其中文內容實際是 UTF-8 字節序列,非純 ASCII,導致 XML 生成器拋錯。
  3. Python 3 默認字符串即 Unicode,無此問題。

修復方案

方案 1:文檔字符串加 u"" 前綴(Python 2 必須)

@srpc(RequestModel, _returns=Unicode)
def shenzhen(request):
    u"""根據傳入的 token、車牌號及車駕號,以及驗證碼 查詢該車輛的違章記錄"""
    ...

方案 2:文件頂部聲明編碼 + 統一使用 Unicode 字面量

# -*- coding: utf-8 -*-
from __future__ import unicode_literals

@srpc(RequestModel, _returns=Unicode)
def shenzhen(request):
    """中文文檔現在自動是 unicode"""
    ...

驗證生成的 WSDL 片段

<wsdl:documentation>
根據傳入的token、車牌號及車駕號,以及驗證碼 查詢該車輛的違章記錄
</wsdl:documentation>

遷移建議

rpclib 已停止維護,官方推薦遷移至 Spyne。Spyne 原生支持 Python 3、更完善的類型系統、更好的 WSDL/Schema 生成。若項目允許,盡早遷移可避免此類編碼陷阱。

通用經驗

  • Python 2 代碼中所有面向外部輸出的字符串(日志、文檔、網絡、文件)必須是 Unicode。
  • 源文件必須聲明 # -*- coding: utf-8 -*-。
  • 養成 from __future__ import unicode_literals 習慣,或全面遷移 Python 3。

一個 u"" 拯救一個下午的調試,Unicode 處理的核心就是:「內部統一用 Unicode,邊界處編解碼」。

copyright © 萬盛學電腦網 all rights reserved