如何正確地實現兩者__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')