Лучший тип вывода и методы кодирования для функций __repr __ ()? - PullRequest
Новая
       3

Лучший тип вывода и методы кодирования для функций __repr __ ()?

65 голосов
/ 02 сентября 2010

В последнее время у меня было много проблем с __repr__(), format() и кодировками. Должен ли вывод __repr__() быть закодирован или быть строкой Unicode? Существует ли наилучшая кодировка для результата __repr__() в Python?То, что я хочу вывести, имеет символы не ASCII.

Я использую Python 2.x и хочу написать код, который можно легко адаптировать к Python 3. Таким образом, программа использует 

# -*- coding: utf-8 -*-
from __future__ import unicode_literals, print_function  # The 'Hello' literal represents a Unicode object

Вот некоторые дополнительные проблемы, которые беспокоили меня, и я ищу решение, которое решает их:

  1. Должна работать печать на терминал UTF-8 (у меня установлен sys.stdout.encodingв UTF-8, но было бы лучше, если бы работали и другие случаи).
  2. Должна работать передача данных в файл (кодированный в UTF-8) (в этом случае sys.stdout.encoding равно None).
  3. Мой код для многих __repr__() функций в настоящее время имеет много return ….encode('utf-8'), и это тяжело.Есть ли что-нибудь более крепкое и более легкое?
  4. В некоторых случаях у меня даже есть уродливые звери, такие как return ('<{}>'.format(repr(x).decode('utf-8'))).encode('utf-8'), т.е. представление объектов декодируется, помещается в строку форматирования, а затем перекодируется.Я хотел бы избежать таких запутанных преобразований.

Что бы вы порекомендовали сделать, чтобы написать простые __repr__() функции, которые хорошо себя ведут по отношению к этим вопросам кодирования?

Ответы [ 3 ]

41 голосов
/ 02 сентября 2010

В Python2 __repr__ (и __str__) должны возвращать строковый объект, а не Unicode объект. В Python3 ситуация обратная: __repr__ и __str__ должен возвращать объекты в кодировке Unicode, а не объекты в байтах (строки): 

class Foo(object):
    def __repr__(self):
        return u'\N{WHITE SMILING FACE}' 

class Bar(object):
    def __repr__(self):
        return u'\N{WHITE SMILING FACE}'.encode('utf8')

repr(Bar())
# ☺
repr(Foo())
# UnicodeEncodeError: 'ascii' codec can't encode character u'\u263a' in position 0: ordinal not in range(128)

В Python2 у вас нет выбора. Вы должны выбрать кодировку для возвращаемое значение __repr__.

Кстати, вы читали PrintFails wiki ? Это может не отвечать напрямую ваши другие вопросы, но я нашел, что это полезно для освещения, почему некоторые происходят ошибки.

При использовании from __future__ import unicode_literals, 

'<{}>'.format(repr(x).decode('utf-8'))).encode('utf-8')

проще записать как 

str('<{}>').format(repr(x))

при условии, что str кодируется в utf-8 в вашей системе.

Без from __future__ import unicode_literals выражение можно записать в виде: 

'<{}>'.format(repr(x))
6 голосов
/ 13 декабря 2012

Я думаю, что декоратор может справиться с __repr__ несовместимостью в здравом смысле. Вот что я использую: 

from __future__ import unicode_literals, print_function
import sys

def force_encoded_string_output(func):

    if sys.version_info.major < 3:

        def _func(*args, **kwargs):
            return func(*args, **kwargs).encode(sys.stdout.encoding or 'utf-8')

        return _func

    else:
        return func


class MyDummyClass(object):

    @force_encoded_string_output
    def __repr__(self):
        return 'My Dummy Class! \N{WHITE SMILING FACE}'
1 голос
/ 17 мая 2012

Я использую функцию, подобную следующей: 

def stdout_encode(u, default='UTF8'):
    if sys.stdout.encoding:
        return u.encode(sys.stdout.encoding)
    return u.encode(default)

Тогда мои __repr__ функции выглядят так: 

def __repr__(self):
    return stdout_encode(u'<MyClass {0} {1}>'.format(self.abcd, self.efgh))
...