Как правильно использовать метаданные Unicode в setup.py?

я писал setup.py для пакета Python с использованием setuptools и хотел включить символ не ASCII в поле long_description:

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

к сожалению, передача объекта unicode в setup () нарушает любую из следующих двух команд с помощью UnicodeEncodeError

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

если я использую необработанную строку UTF-8 для поля long_description, то следующая команда разрывается с UnicodeDecodeError:

python setup.py register

Я обычно выпускаю программное обеспечение от running '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("..."),
      ...)

разве нет лучшего способа?

3 ответов


Это, по-видимому, ошибка distutils, которая была исправлена в python 2.6:http://mail.python.org/pipermail/distutils-sig/2009-September/013275.html

Tarek предлагает исправить post_to_server. Патч должен предварительно обработать все значения в аргумент "data" и превратите их в unicode, а затем вызовите исходный метод. См.http://mail.python.org/pipermail/distutils-sig/2009-September/013277.html


#!/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-description, только из rst2html; загрузка, кажется, работает нормально (хотя я отменяю фактическую загрузку), и регистрация запрашивает мое имя пользователя, которого у меня нет. Но трассировка в вашем комментарии полезна - Это автоматическое преобразование в unicode на register команда, которая вызывает проблему.

посмотреть призрачный setdefaultencoding подробнее об этом - в основном вы хотите кодировка по умолчанию в Python, чтобы иметь возможность конвертировать закодированную строку обратно в unicode, но это сложно настроить. В этом случае я думаю, что это стоит усилий:

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

или даже, чтобы быть правильным, Вы можете сделать его из locale - там код прокомментирован в /usr/lib/python2.6/site.py что вы можете найти, что это, но я оставлю это обсуждение.


вам нужно изменить длинное описание unicode u"bläh bläh bläh" к нормальной строке "bläh bläh bläh" и добавьте заголовок кодировки в качестве второй строки вашего файла:

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

очевидно, что вам также нужно сохранить файл с кодировкой UTF-8.