使用@property · Python 3零起點教程

在綁定屬性時，如果我們直接把屬性暴露出去，雖然寫起來很簡單，但是，沒辦法檢查參數，導致可以把成績隨便改： ~~~ s = Student() s.score = 9999 ~~~ 這顯然不合邏輯。為了限制score的范圍，可以通過一個`set_score()`方法來設置成績，再通過一個`get_score()`來獲取成績，這樣，在`set_score()`方法里，就可以檢查參數： ~~~ class Student(object): def get_score(self): return self._score def set_score(self, value): if not isinstance(value, int): raise ValueError('score must be an integer!') if value < 0 or value > 100: raise ValueError('score must between 0 ~ 100!') self._score = value ~~~ 現在，對任意的Student實例進行操作，就不能隨心所欲地設置score了： ~~~ >>> s = Student() >>> s.set_score(60) # ok! >>> s.get_score() 60 >>> s.set_score(9999) Traceback (most recent call last): ... ValueError: score must between 0 ~ 100! ~~~ 但是，上面的調用方法又略顯復雜，沒有直接用屬性這么直接簡單。有沒有既能檢查參數，又可以用類似屬性這樣簡單的方式來訪問類的變量呢？對于追求完美的Python程序員來說，這是必須要做到的！還記得裝飾器（decorator）可以給函數動態加上功能嗎？對于類的方法，裝飾器一樣起作用。Python內置的`@property`裝飾器就是負責把一個方法變成屬性調用的： ~~~ class Student(object): @property def score(self): return self._score @score.setter def score(self, value): if not isinstance(value, int): raise ValueError('score must be an integer!') if value < 0 or value > 100: raise ValueError('score must between 0 ~ 100!') self._score = value ~~~ `@property`的實現比較復雜，我們先考察如何使用。把一個getter方法變成屬性，只需要加上`@property`就可以了，此時，`@property`本身又創建了另一個裝飾器`@score.setter`，負責把一個setter方法變成屬性賦值，于是，我們就擁有一個可控的屬性操作： ~~~ >>> s = Student() >>> s.score = 60 # OK，實際轉化為s.set_score(60) >>> s.score # OK，實際轉化為s.get_score() 60 >>> s.score = 9999 Traceback (most recent call last): ... ValueError: score must between 0 ~ 100! ~~~ 注意到這個神奇的`@property`，我們在對實例屬性操作的時候，就知道該屬性很可能不是直接暴露的，而是通過getter和setter方法來實現的。還可以定義只讀屬性，只定義getter方法，不定義setter方法就是一個只讀屬性： ~~~ class Student(object): @property def birth(self): return self._birth @birth.setter def birth(self, value): self._birth = value @property def age(self): return 2015 - self._birth ~~~ 上面的`birth`是可讀寫屬性，而`age`就是一個**只讀**屬性，因為`age`可以根據`birth`和當前時間計算出來。 ### 小結 `@property`廣泛應用在類的定義中，可以讓調用者寫出簡短的代碼，同時保證對參數進行必要的檢查，這樣，程序運行時就減少了出錯的可能性。 ### 練習請利用`@property`給一個`Screen`對象加上`width`和`height`屬性，以及一個只讀屬性`resolution`： ~~~ # -*- coding: utf-8 -*- class Screen(object): # test: s = Screen() s.width = 1024 s.height = 768 print(s.resolution) assert s.resolution == 786432, '1024 * 768 = %d ?' % s.resolution ~~~ ?Run ### 參考源碼 [use_property.py](https://github.com/michaelliao/learn-python3/blob/master/samples/oop_advance/use_property.py)