¿El mejor tipo de salida y prácticas de codificación para las funciones __repr __()?

Question

Últimamente, he tenido muchos problemas con __repr__(), format() y codificaciones. ¿Debería codificarse la salida de __repr__() o ser una cadena unicode? ¿Hay una mejor codificación para el resultado de __repr__() en Python? Lo que quiero mostrar tiene caracteres que no sean ASCII.

utilizo Python 2.x, y quiero escribir código que puede ser fácilmente adaptado a Python 3. El programa utiliza tanto

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

Éstos son algunos problemas adicionales que me han estado molestando, y yo' m buscando una solución que les resuelve:

1. impresión a un terminal de UTF-8 debería funcionar (no tengo sys.stdout.encoding conjunto de UTF-8, pero sería mejor si otros casos trabajaron también).
2. La conexión de la salida a un archivo (codificada en UTF-8) debería funcionar (en este caso, sys.stdout.encoding es None).
3. Mi código para muchas funciones __repr__() actualmente tiene muchos return ….encode('utf-8'), y eso es pesado. ¿Hay algo robusto y ligero?
4. En algunos casos, incluso tengo bestias feas como return ('<{}>'.format(repr(x).decode('utf-8'))).encode('utf-8'), es decir, la representación de objetos se decodifica, se pone en una cadena de formato y luego se vuelve a codificar. Me gustaría evitar tales transformaciones enrevesadas.

¿Qué recomendarías hacer para escribir funciones simples __repr__() que se comporten bien con respecto a estas preguntas de codificación?

Answer 1

En Python2, __repr__ (y __str__) debe devolver un objeto de cadena, no un objeto unicode . En python3, la situación se invierte, y __repr____str__ debe devolver los objetos Unicode, no bytes (cadena de soltera) objetos:

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) 

en python2, usted realmente no tiene una opción. Debe elegir una codificación para el valor de retorno de __repr__.

Por cierto, ¿has leído el PrintFails wiki? Es posible que no responda directamente al sus otras preguntas, pero lo encontré útil para esclarecer por qué ocurren ciertos errores .

---

Al utilizar from __future__ import unicode_literals,

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

puede ser más simplemente escribir como

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

asumiendo str codifica a utf-8 en su sistema.

Sin from __future__ import unicode_literals, la expresión se puede escribir como:

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

Answer 2

utilizo una función como la siguiente:

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

Entonces mis __repr__ funciones se ven así:

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

Answer 3

Creo que un decorador puede administrar __repr__ incomp atitudes de una manera sensata. Esto es lo que yo uso:

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}'