如何正确地实现两者__str__和__repr__

Question

在我的几个类的，我要同时实现__str__和__repr__，通常落得这样的代码：

class MyClass(object): 
    def __init__(self, a): 
     self.a = a 

    def __str__(self): 
     return 'MyClass({})'.format(self.a) 

    def __repr__(self): 
     return 'MyClass({!r})'.format(self.a) 

这不会是我所期望的：

>>> myobject = MyClass(np.array([1, 2])) 
>>> str(myobject) 
'MyClass([1 2])' 
>>> repr(myobject) 
'MyClass(array([1, 2]))' 

然而代码违反DRY和参数的数量开始增长保持这个变得麻烦和我经常发现，无论是中__str__或__repr__来了“不同步”与其他。

有没有更好的方式同时实现__str__和__repr__没有重复？

Answer 1

不需要重复，只是不执行__str__。

这样，对象的行为将类似于__str__ = __repr__。

我想你还应该读this answer。

Answer 2

对于实现__str__和__repr__没有规则也没有明确的指导原则 - 至少没有任何地方一贯遵循（即使在stdlib中也没有）。所以没有办法自动获得“标准行为”，只是因为没有标准行为。这取决于你，所以如果你为自己制定指导方针，也许你也可以想出一个实用程序，让你更容易跟随它们。

在你的情况，例如，您可以创建一个基类，它提供了__str__和__repr__实现：

class AutoStRepr(object): 
    _args = [] 
    def __repr__(self): 
     return '{}({})'.format(type(self).__name__, 
      ', '.join(repr(getattr(self, a)) for a in self._args)) 
    def __str__(self): 
     return '{}({})'.format(type(self).__name__, 
      ', '.join(str(getattr(self, a)) for a in self._args)) 

然后，您可以使用在许多不同的类型：

class MyClass(AutoStRepr): 
    _args = ['a'] 
    def __init__(self, a): 
     self.a = a 

class MyOtherClass(AutoStRepr): 
    _args = ['a', 'bc'] 
    def __init__(self, a, b, c): 
     self.a = a 
     self.bc = b * c 

>>> MyClass('foo') 
MyClass('foo') 
>>> MyOtherClass('foo', 2, 5) 
MyOtherClass('foo', 10) 

Answer 3

由于您的__str__和__repr__遵循相同的模式，您可以编写一个函数为你创建对象的字符串表示。这将需要一个对象，属性列表和str或repr作为参数：

def stringify(obj, attrs, strfunc): 
    values = [] 
    # get each attribute's value and convert it to a string 
    for attr in attrs: 
     value = getattr(obj, attr) 
     values.append(strfunc(value)) 

    # get the class name 
    clsname = type(obj).__name__ 

    # put everything together 
    args = ', '.join(values) 
    return '{}({})'.format(clsname, args) 

print(stringify(MyClass('foo'), ['a'], repr)) 
# output: MyClass('foo') 

---

我建议把这个函数的一类，你再继承：

class Printable: 
    def __str__(self): 
     return self.__stringify(str) 

    def __repr__(self): 
     return self.__stringify(repr) 

    def __stringify(self, strfunc): 
     values = [] 
     for attr in self._attributes: 
      value = getattr(self, attr) 
      values.append(strfunc(value)) 

     clsname = type(self).__name__ 
     args = ', '.join(values) 
     return '{}({})'.format(clsname, args) 

class MyClass(Printable): 
    _attributes = ['a'] 

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

而且您甚至可以通过直接从__init__函数的签名中获取属性完全自动完成：

import inspect 

class AutoPrintable: 
    def __str__(self): 
     return self.__stringify(str) 

    def __repr__(self): 
     return self.__stringify(repr) 

    def __stringify(self, strfunc): 
     sig= inspect.signature(self.__init__) 
     values= [] 
     for attr in sig.parameters: 
      value= getattr(self, attr) 
      values.append(strfunc(value)) 

     clsname= type(self).__name__ 
     args= ', '.join(values) 
     return '{}({})'.format(clsname, args) 

class MyClass(AutoPrintable): 
    def __init__(self, a, b): 
     self.a = a 
     self.b = b 

print(str(MyClass('foo', 'bar'))) # output: MyClass(foo, bar) 
print(repr(MyClass('foo', 'bar'))) # output: MyClass('foo', 'bar')