快捷導(dǎo)航

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

更新時(shí)間：2015年04月28日 09:40:09 作者：廖雪峰

這篇文章主要介紹了介紹Python的@property裝飾器的用法,是Python學(xué)習(xí)進(jìn)階中的重要知識(shí),代碼基于Python2.x版本,需要的朋友可以參考下

在綁定屬性時(shí)，如果我們直接把屬性暴露出去，雖然寫起來(lái)很簡(jiǎn)單，但是，沒辦法檢查參數(shù)，導(dǎo)致可以把成績(jī)隨便改：

s = Student()
s.score = 9999

這顯然不合邏輯。為了限制score的范圍，可以通過一個(gè)set_score()方法來(lái)設(shè)置成績(jī)，再通過一個(gè)get_score()來(lái)獲取成績(jī)，這樣，在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)在，對(duì)任意的Student實(shí)例進(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ù)雜，沒有直接用屬性這么直接簡(jiǎn)單。

有沒有既能檢查參數(shù)，又可以用類似屬性這樣簡(jiǎn)單的方式來(lái)訪問類的變量呢？對(duì)于追求完美的Python程序員來(lái)說(shuō)，這是必須要做到的！

還記得裝飾器（decorator）可以給函數(shù)動(dòng)態(tài)加上功能嗎？對(duì)于類的方法，裝飾器一樣起作用。Python內(nèi)置的@property裝飾器就是負(fù)責(zé)把一個(gè)方法變成屬性調(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的實(shí)現(xiàn)比較復(fù)雜，我們先考察如何使用。把一個(gè)getter方法變成屬性，只需要加上@property就可以了，此時(shí)，@property本身又創(chuàng)建了另一個(gè)裝飾器@score.setter，負(fù)責(zé)把一個(gè)setter方法變成屬性賦值，于是，我們就擁有一個(gè)可控的屬性操作：

>>> s = Student()
>>> s.score = 60 # OK，實(shí)際轉(zhuǎn)化為s.set_score(60)
>>> s.score # OK，實(shí)際轉(zhuǎn)化為s.get_score()
60
>>> s.score = 9999
Traceback (most recent call last):
 ...
ValueError: score must between 0 ~ 100!

注意到這個(gè)神奇的@property，我們?cè)趯?duì)實(shí)例屬性操作的時(shí)候，就知道該屬性很可能不是直接暴露的，而是通過getter和setter方法來(lái)實(shí)現(xiàn)的。

還可以定義只讀屬性，只定義getter方法，不定義setter方法就是一個(gè)只讀屬性：

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就是一個(gè)只讀屬性，因?yàn)閍ge可以根據(jù)birth和當(dāng)前時(shí)間計(jì)算出來(lái)。
小結(jié)

@property廣泛應(yīng)用在類的定義中，可以讓調(diào)用者寫出簡(jiǎn)短的代碼，同時(shí)保證對(duì)參數(shù)進(jìn)行必要的檢查，這樣，程序運(yùn)行時(shí)就減少了出錯(cuò)的可能性。

您可能感興趣的文章: