介紹Python的@property裝飾器的用法

字號:


    這篇文章主要介紹了介紹Python的@property裝飾器的用法,是Python學(xué)習(xí)進(jìn)階中的重要知識,代碼基于Python2.x版本,需要的朋友可以參考下
    在綁定屬性時,如果我們直接把屬性暴露出去,雖然寫起來很簡單,但是,沒辦法檢查參數(shù),導(dǎo)致可以把成績隨便改:
    s = Student()
    s.score = 9999
    這顯然不合邏輯。為了限制score的范圍,可以通過一個set_score()方法來設(shè)置成績,再通過一個get_score()來獲取成績,這樣,在set_score()方法里,就可以檢查參數(shù):
    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
    現(xiàn)在,對任意的Student實例進(jìn)行操作,就不能隨心所欲地設(shè)置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!
    但是,上面的調(diào)用方法又略顯復(fù)雜,沒有直接用屬性這么直接簡單。
    有沒有既能檢查參數(shù),又可以用類似屬性這樣簡單的方式來訪問類的變量呢?對于追求完美的Python程序員來說,這是必須要做到的!
    還記得裝飾器(decorator)可以給函數(shù)動態(tài)加上功能嗎?對于類的方法,裝飾器一樣起作用。Python內(nèi)置的@property裝飾器就是負(fù)責(zé)把一個方法變成屬性調(diào)用的:
    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的實現(xiàn)比較復(fù)雜,我們先考察如何使用。把一個getter方法變成屬性,只需要加上@property就可以了,此時,@property本身又創(chuàng)建了另一個裝飾器@score.setter,負(fù)責(zé)把一個setter方法變成屬性賦值,于是,我們就擁有一個可控的屬性操作:
    >>> s = Student()
    >>> s.score = 60 # OK,實際轉(zhuǎn)化為s.set_score(60)
    >>> s.score # OK,實際轉(zhuǎn)化為s.get_score()
    60
    >>> s.score = 9999
    Traceback (most recent call last):
    ...
    ValueError: score must between 0 ~ 100!
    注意到這個神奇的@property,我們在對實例屬性操作的時候,就知道該屬性很可能不是直接暴露的,而是通過getter和setter方法來實現(xiàn)的。
    還可以定義只讀屬性,只定義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 2014 - self._birth
    上面的birth是可讀寫屬性,而age就是一個只讀屬性,因為age可以根據(jù)birth和當(dāng)前時間計算出來。
    小結(jié)
    @property廣泛應(yīng)用在類的定義中,可以讓調(diào)用者寫出簡短的代碼,同時保證對參數(shù)進(jìn)行必要的檢查,這樣,程序運行時就減少了出錯的可能性。