在setup.py中使用Unicode元數據的正確方法是什麼？

Question

我在寫一個setup.py使用setuptools的Python包，並希望包括在LONG_DESCRIPTION領域的非ASCII字符：

#!/usr/bin/env python 
from setuptools import setup 
setup(... 
     long_description=u"...", # in real code this value is read from a text file 
     ...) 

不幸的是，經過一個Unicode對象設置（）或者突破的以下兩個命令與UnicodeEncodeError

 
python setup.py --long-description | rst2html 
python setup.py upload 

如果我使用原始UTF-8字符串爲LONG_DESCRIPTION字段，那麼下面的命令中斷以UnicodeDecodeError：

 
python setup.py register 

我通常通過運行'python setup.py sdist register upload'來發布軟件，這意味着查看sys.argv並傳遞正確對象類型的醜陋黑客正確無誤。

在我放棄了，並實施不同的醜陋的黑客到底：

class UltraMagicString(object): 
    # Catch-22: 
    # - if I return Unicode, python setup.py --long-description as well 
    # as python setup.py upload fail with a UnicodeEncodeError 
    # - if I return UTF-8 string, python setup.py sdist register 
    # fails with an UnicodeDecodeError 

    def __init__(self, value): 
     self.value = value 

    def __str__(self): 
     return self.value 

    def __unicode__(self): 
     return self.value.decode('UTF-8') 

    def __add__(self, other): 
     return UltraMagicString(self.value + str(other)) 

    def split(self, *args, **kw): 
     return self.value.split(*args, **kw) 

... 

setup(... 
     long_description=UltraMagicString("..."), 
     ...) 

是不是有更好的辦法？

Answer 1

這顯然是一個distutils的錯誤已被固定在Python 2.6：http://mail.python.org/pipermail/distutils-sig/2009-September/013275.html

塔裏克建議修補post_to_server。該補丁應該預處理 「data」參數中的所有值，並將它們轉換爲unicode，然後調用原始方法。請參閱http://mail.python.org/pipermail/distutils-sig/2009-September/013277.html

Answer 2

#!/usr/bin/env python 
# -*- coding: utf-8 -*- 

from setuptools import setup 
setup(name="fudz", 
     description="fudzily", 
     version="0.1", 
     long_description=u"bläh bläh".encode("UTF-8"), # in real code this value is read from a text file 
     py_modules=["fudz"], 
     author="David Fraser", 
     author_email="davidf@sjsoft.com", 
     url="http://en.wikipedia.org/wiki/Fudz", 
    ) 

我正在與上述代碼測試 - 存在從--long-說明中，僅對從rst2html沒有錯誤;上傳似乎工作正常（雖然我實際取消上傳）並註冊要求我輸入我沒有的用戶名。但是評論中的回溯很有幫助 - 這是register命令中導致問題的自動轉換爲unicode。

請參閱the illusive setdefaultencoding以獲取更多信息 - 基本上你希望Python中的默認編碼能夠將編碼後的字符串轉換回unicode，但設置它很困難。在這種情況下，我認爲這是值得的：

import sys 
reload(sys).setdefaultencoding("UTF-8") 

甚至是正確的，你可以從locale得到它 - 有一個在/usr/lib/python2.6/site.py註釋掉的代碼，你可以找到，做這一點，但我會離開這個討論目前。

Answer 3

您需要將您的unicode長的描述u"bläh bläh bläh"更改爲正常的字符串"bläh bläh bläh"並添加編碼頭作爲文件的第二行：

#!/usr/bin/env python 
# encoding: utf-8 
... 
... 

顯然，你需要使用UTF-8的文件編碼也是如此。