我們先從類和對(duì)象當(dāng)中最簡(jiǎn)單的打印輸出開始講起，打印一個(gè)實(shí)例是一個(gè)非常不起眼的應(yīng)用，但是在實(shí)際的編程當(dāng)中卻非常重要。原因也很簡(jiǎn)單，因?yàn)槲覀僤ebug的時(shí)候往往會(huì)想看下某個(gè)類當(dāng)中的內(nèi)容是不是符合我們的預(yù)期。但是我們直接print輸出的話，只會(huì)得到一個(gè)地址。

我們來看一個(gè)例子：

classpoint:

def__init__(self,x,y):

self.x=x

self.y=y

if__name__=="__main__":

p=point(3,4)

print(p)

在這段代碼當(dāng)中我們定義了一個(gè)簡(jiǎn)單的類，它當(dāng)中有x和y兩個(gè)元素，但是如果我們直接運(yùn)行的話，屏幕上會(huì)輸出這樣一個(gè)結(jié)果：

<__main__.pointobjectat0x10a18c210>

這個(gè)是解釋器在執(zhí)行的時(shí)候這個(gè)實(shí)例的一些相關(guān)信息，但是對(duì)于我們來說幾乎沒有參考意義，我們想要的是這個(gè)實(shí)例當(dāng)中具體的值，而不是一個(gè)內(nèi)存當(dāng)中的地址。

想要實(shí)現(xiàn)這個(gè)功能，我們有很多方法，下面我們一一來看。

__str__方法__str__方法大家應(yīng)該都不陌生，它類似于Java當(dāng)中的toString方法，可以根據(jù)我們的需要返回實(shí)例轉(zhuǎn)化成字符串之后的結(jié)果。

比如，我們可以在類當(dāng)中重載這個(gè)方法，就可以根據(jù)我們的需要輸出結(jié)果了：

classpoint:

def__init__(self,x,y):

self.x=x

self.y=y

def__str__(self):

return'x:%s,y:%s'%(self.x,self.y)

當(dāng)我們運(yùn)行它，得到的結(jié)果會(huì)是：

x:3,y:4

__str__和__init__,__len__很多函數(shù)一樣是Python中的特殊函數(shù)，在我們創(chuàng)建類的時(shí)候，系統(tǒng)會(huì)我們隱式創(chuàng)造許多這樣的特殊函數(shù)。我們可以根據(jù)需要重載其中的一部分完成我們想要的功能。比如如果我們寫的是一棵二叉樹的類，我們還可以在__str__函數(shù)當(dāng)中進(jìn)行遞歸遍歷所有的節(jié)點(diǎn)，打印出完整的樹來。

__repr__方法你也許可能也聽說過__repr__函數(shù)，它也可以實(shí)現(xiàn)根據(jù)我們的需要自定義輸出的功能。比如我們把上面的代碼改下函數(shù)名，也可以得到一樣的結(jié)果。

classpoint:

def__init__(self,x,y):

self.x=x

self.y=y

def__repr__(self):

return'x:%s,y:%s'%(self.x,self.y)

我們運(yùn)行它，同樣會(huì)得到：

x:3,y:4

這是為什么呢，難道__repr__和__str__是一樣的嗎?如果是一樣的，Python的設(shè)計(jì)者干嘛要保留兩個(gè)完全相同的函數(shù)呢，為什么不去掉其中一個(gè)呢?

在分析原因之前，我們先來做一個(gè)實(shí)驗(yàn)，如果我們兩個(gè)函數(shù)都重載，那么當(dāng)我們輸出的時(shí)候，程序執(zhí)行的是哪一個(gè)呢?為了做好區(qū)分，我們把repr當(dāng)中的輸出的格式稍微修改一下。

classpoint:

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)

我們運(yùn)行之后，會(huì)發(fā)現(xiàn)輸出的結(jié)果還是：

x:3,y:4

先別著急下結(jié)論，我們?cè)侔堰@段代碼拷貝到j(luò)upyternotebook當(dāng)中，我們這次不通過打印輸出，而通過jupyter自帶的交互框輸出交互結(jié)果，我們?cè)賮砜聪拢?/p>

奇怪，怎么結(jié)果就變成了__repr__的結(jié)果了呢?

其實(shí)這正是反應(yīng)了兩者的區(qū)別，如果簡(jiǎn)單理解，這兩個(gè)函數(shù)都是將一個(gè)實(shí)例轉(zhuǎn)成字符串。但是不同的是，兩者的使用場(chǎng)景不同，其中__str__更加側(cè)重展示。所以當(dāng)我們print輸出給用戶或者使用str函數(shù)進(jìn)行類型轉(zhuǎn)化的時(shí)候，Python都會(huì)默認(rèn)優(yōu)先調(diào)用__str__函數(shù)。而__repr__更側(cè)重于這個(gè)實(shí)例的報(bào)告，除了實(shí)例當(dāng)中的內(nèi)容之外，我們往往還會(huì)附上它的類相關(guān)的信息，因?yàn)檫@些內(nèi)容是給開發(fā)者看的。所以當(dāng)我們?cè)诮换ナ酱翱谳敵龅臅r(shí)候，它會(huì)優(yōu)先調(diào)用__repr__。

理論上來說，對(duì)于一個(gè)合格的__repr__函數(shù)要能夠做到:

eval(repr(obj))==obj

也就是說我們通過__repr__輸出的內(nèi)容執(zhí)行之后可以再還原得到這個(gè)實(shí)例本身，當(dāng)然在一些場(chǎng)景下這個(gè)非常難以實(shí)現(xiàn)，所以我們退而求其次，保證__repr__當(dāng)中輸出類和對(duì)象足夠多的信息，方便開發(fā)者調(diào)試和使用即可。

另外多說一句，repr是report的縮寫，所以它有一個(gè)報(bào)告的意思在里面，而str就只是轉(zhuǎn)化成字符串而已。這兩者還是有一定區(qū)別的。

formatPython當(dāng)中最常用的輸出函數(shù)除了上面兩個(gè)之外，還有一個(gè)就是format。

比較簡(jiǎn)單的用法就是通過{}代表變量，然后按照順序依次輸入：

除此之外，我們還可以進(jìn)一步寫明花括號(hào)里的變量名稱，進(jìn)一步增加可讀性：

format的功能遠(yuǎn)不止如此，它還支持許多參數(shù)，類似于C語言當(dāng)中的printf，可以通過不同的參數(shù)做到各種各樣的輸出。比如控制小數(shù)點(diǎn)后面保留的位數(shù)，或者是轉(zhuǎn)化成百分?jǐn)?shù)、科學(xué)記數(shù)法、左右對(duì)齊等功能。這里不一一列舉了，大家用到的時(shí)候再查詢即可。

我們當(dāng)然可以使用format重新__repr__和__str__當(dāng)中的邏輯，但這并不能體現(xiàn)它的強(qiáng)大。因?yàn)樵赑ython當(dāng)中，也為類提供了__format__這個(gè)特殊函數(shù)，通過重寫__format__和使用format，我們可以做到更牛的功能。

format聯(lián)合__format__我們可以在類當(dāng)中重載__format__函數(shù)，這樣我們就可以在外部直接通過format函數(shù)來調(diào)用對(duì)象，輸出我們想要的結(jié)果。

我們來看代碼：

classpoint:

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__，但是需要注意一個(gè)細(xì)節(jié)，我們多加了一個(gè)參數(shù)code，這是由于format當(dāng)中支持通過參數(shù)來對(duì)處理邏輯進(jìn)行配置的功能，所以我們必須要在接口處多加一個(gè)參數(shù)。加好了以后，我們就可以直接調(diào)用format(p)了。

到這里還沒有結(jié)束，在有些場(chǎng)景當(dāng)中，對(duì)于同一個(gè)對(duì)象我們可能有多種輸出的格式。比如點(diǎn)，在有些場(chǎng)景下我們可能希望輸出(x,y)，有時(shí)候我們又希望輸出x:3,y:4，可能還有些場(chǎng)景當(dāng)中，我們希望輸出。

我們針對(duì)這么多場(chǎng)景，如果各自實(shí)現(xiàn)不同的接口會(huì)非常麻煩。這個(gè)時(shí)候利用__format__當(dāng)中的這個(gè)參數(shù)，就可以大大簡(jiǎn)化這個(gè)過程，我們來看代碼：

formats={

'normal':'x:{p.x},y:{p.y}',

'point':'({p.x},{p.y})',

'prot':'<{p.x},{p.y}>'

}

classpoint:

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):

returnformats[code].format(p=self)

我們?cè)谡{(diào)用的時(shí)候就可以通過參數(shù)來控制我們究竟使用哪一種格式來格式化對(duì)象了：

也就是說通過重載__format__方法，我們把原本固定的格式化的邏輯做成了可配置的。這樣大大增加了我們使用過程當(dāng)中的靈活性，這種靈活性在一些問題場(chǎng)景當(dāng)中可以大大簡(jiǎn)化和簡(jiǎn)潔我們的代碼。對(duì)于Python這門語言來說，我個(gè)人感覺實(shí)現(xiàn)功能只是其中很小的一個(gè)部分，把代碼寫得簡(jiǎn)潔美觀，才是其中的大頭。這也是為什么很多人都說Python易學(xué)難精的原因。

以上內(nèi)容為大家介紹了Python之詳解__str__,__repr__和__format__，希望對(duì)大家有所幫助，如果想要了解更多Python相關(guān)知識(shí)，請(qǐng)關(guān)注IT培訓(xùn)機(jī)構(gòu):千鋒教育。

上一篇

Python變量的類型(弱類型語言)

下一篇

Python之迭代器的幾個(gè)高級(jí)用法