python格式化输出 xz_Python——详解__str__, __repr__和__format__
今天是Python專題的第10篇文章，我們來聊聊Python當中的類。
打印實例
我們先從類和對象當中最簡單的打印輸出開始講起，打印一個實例是一個非常不起眼的應用，但是在實際的編程當中卻非常重要。原因也很簡單，因為我們debug的時候往往會想看下某個類當中的內容是不是符合我們的預期。但是我們直接print輸出的話，只會得到一個地址。
我們來看一個例子：
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
if?__name__?==?"__main__":
p?=?point(3,?4)
print(p)
在這段代碼當中我們定義了一個簡單的類，它當中有x和y兩個元素，但是如果我們直接運行的話，屏幕上會輸出這樣一個結果：
這個是解釋器在執行的時候這個實例的一些相關信息，但是對于我們來說幾乎沒有參考意義，我們想要的是這個實例當中具體的值，而不是一個內存當中的地址。
想要實現這個功能，我們有很多方法，下面我們一一來看。
__str__方法
__str__方法大家應該都不陌生，它類似于Java當中的toString方法，可以根據我們的需要返回實例轉化成字符串之后的結果。
比如，我們可以在類當中重載這個方法，就可以根據我們的需要輸出結果了：
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
def?__str__(self):
return?'x:?%s,?y:?%s'?%?(self.x,?self.y)
當我們運行它，得到的結果會是：
x:?3,?y:?4
__str__和__init__, __len__很多函數一樣是Python中的特殊函數，在我們創建類的時候，系統會我們隱式創造許多這樣的特殊函數。我們可以根據需要重載其中的一部分完成我們想要的功能。比如如果我們寫的是一棵二叉樹的類，我們還可以在__str__函數當中進行遞歸遍歷所有的節點，打印出完整的樹來。
__repr__方法
你也許可能也聽說過__repr__函數，它也可以實現根據我們的需要自定義輸出的功能。比如我們把上面的代碼改下函數名，也可以得到一樣的結果。
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
def?__repr__(self):
return?'x:?%s,?y:?%s'?%?(self.x,?self.y)
我們運行它，同樣會得到：
x:?3,?y:?4
這是為什么呢，難道__repr__和__str__是一樣的嗎？如果是一樣的，Python的設計者干嘛要保留兩個完全相同的函數呢，為什么不去掉其中一個呢？
在分析原因之前，我們先來做一個實驗，如果我們兩個函數都重載，那么當我們輸出的時候，程序執行的是哪一個呢？為了做好區分，我們把repr當中的輸出的格式稍微修改一下。
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
def?__str__(self):
return?'x:?%s,?y:?%s'?%?(self.x,?self.y)
def?__repr__(self):
return?''?%?(self.x,?self.y)
我們運行之后，會發現輸出的結果還是：
x:?3,?y:?4
先別著急下結論，我們再把這段代碼拷貝到jupyter notebook當中，我們這次不通過打印輸出，而通過jupyter自帶的交互框輸出交互結果，我們再來看下：
奇怪，怎么結果就變成了__repr__的結果了呢？
[斯坦福大學2014機器學習教程筆記]第六章-分類回歸
其實這正是反應了兩者的區別，如果簡單理解，這兩個函數都是將一個實例轉成字符串。但是不同的是，兩者的使用場景不同，其中__str__更加側重展示。所以當我們print輸出給用戶或者使用str函數進行類型轉化的時候，Python都會默認優先調用__str__函數。而__repr__更側重于這個實例的報告，除了實例當中的內容之外，我們往往還會附上它的類相關的信息，因為這些內容是給開發者看的。所以當我們在交互式窗口輸出的時候，它會優先調用__repr__。
理論上來說，對于一個合格的__repr__函數要能夠做到:
eval(repr(obj))?==?obj
也就是說我們通過__repr__輸出的內容執行之后可以再還原得到這個實例本身，當然在一些場景下這個非常難以實現，所以我們退而求其次，保證__repr__當中輸出類和對象足夠多的信息，方便開發者調試和使用即可。
另外多說一句，repr是report的縮寫，所以它有一個報告的意思在里面，而str就只是轉化成字符串而已。這兩者還是有一定區別的。
format
Python當中最常用的輸出函數除了上面兩個之外，還有一個就是format。
比較簡單的用法就是通過{}代表變量，然后按照順序依次輸入：
除此之外，我們還可以進一步寫明花括號里的變量名稱，進一步增加可讀性：
format的功能遠不止如此，它還支持許多參數，類似于C語言當中的printf，可以通過不同的參數做到各種各樣的輸出。比如控制小數點后面保留的位數，或者是轉化成百分數、科學記數法、左右對齊等功能。這里不一一列舉了，大家用到的時候再查詢即可。
我們當然可以使用format重新__repr__和__str__當中的邏輯，但這并不能體現它的強大。因為在Python當中，也為類提供了__format__這個特殊函數，通過重寫__format__和使用format，我們可以做到更牛的功能。
format聯合__format__
我們可以在類當中重載__format__函數，這樣我們就可以在外部直接通過format函數來調用對象，輸出我們想要的結果。
我們來看代碼：
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
def?__str__(self):
return?'x:?%s,?y:?%s'?%?(self.x,?self.y)
def?__format__(self,?code):
return?'x:?{x},?y:?{y}'.format(x?=?self.x,?y?=?self.y)
我們把剛才的__repr__改成了__format__，但是需要注意一個細節，我們多加了一個參數code，這是由于format當中支持通過參數來對處理邏輯進行配置的功能，所以我們必須要在接口處多加一個參數。加好了以后，我們就可以直接調用format(p)了。
到這里還沒有結束，在有些場景當中，對于同一個對象我們可能有多種輸出的格式。比如點，在有些場景下我們可能希望輸出(x, y)，有時候我們又希望輸出x: 3, y: 4，可能還有些場景當中，我們希望輸出。
我們針對這么多場景，如果各自實現不同的接口會非常麻煩。這個時候利用__format__當中的這個參數，就可以大大簡化這個過程，我們來看代碼：
formats?=?{
'normal':?'x:?{p.x},?y:?{p.y}',
'point'?:?'({p.x},?{p.y})',
'prot':?''
}
class?point:
def?__init__(self,?x,?y):
self.x?=?x
self.y?=?y
def?__str__(self):
return?'x:?%s,?y:?%s'?%?(self.x,?self.y)
def?__format__(self,?code):
return?formats[code].format(p=self)
我們在調用的時候就可以通過參數來控制我們究竟使用哪一種格式來格式化對象了：
也就是說通過重載__format__方法，我們把原本固定的格式化的邏輯做成了可配置的。這樣大大增加了我們使用過程當中的靈活性，這種靈活性在一些問題場景當中可以大大簡化和簡潔我們的代碼。對于Python這門語言來說，我個人感覺實現功能只是其中很小的一個部分，把代碼寫得簡潔美觀，才是其中的大頭。這也是為什么很多人都說Python易學難精的原因。
今天的文章就是這些，如果覺得有所收獲，請順手點個關注或者轉發吧，你們的舉手之勞對我來說很重要。
總結
以上是生活随笔為你收集整理的python格式化输出 xz_Python——详解__str__, __repr__和__format__的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 每天学习一点点（2010年二月）
- 下一篇： python怎么设置界面的背景音乐_Py