介绍Python的@property装饰器的用法

更新时间：2015年04月28日 09:40:09 作者：廖雪峰

这篇文章主要介绍了介绍Python的@property装饰器的用法,是Python学习进阶中的重要知识,代码基于Python2.x版本,需要的朋友可以参考下

在绑定属性时，如果我们直接把属性暴露出去，虽然写起来很简单，但是，没办法检查参数，导致可以把成绩随便改：

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 2014 - self._birth

上面的birth是可读写属性，而age就是一个只读属性，因为age可以根据birth和当前时间计算出来。
小结

@property广泛应用在类的定义中，可以让调用者写出简短的代码，同时保证对参数进行必要的检查，这样，程序运行时就减少了出错的可能性。

您可能感兴趣的文章:

Python

编写Python脚本批量下载DesktopNexus壁纸的教程
这篇文章主要介绍了编写Python脚本批量下载DesktopNexus壁纸的教程,相较于普通的爬虫抓取,本文的下载壁纸教程还包括了设置所要下载的分辨率等功能的实现,需要的朋友可以参考下
2015-05-05
人生苦短我用python python如何快速入门?
这篇文章主要教大家如何快速入门python，一个简短而全面的入门教程带你走入Python的大门，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-03-03
通过python3实现投票功能代码实例
这篇文章主要介绍了通过python3实现投票功能代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09
python调用DLL与EXE文件截屏对比分析
这篇文章主要为大家介绍了python调用DLL与EXE文件截屏对比分析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2021-10-10
一文深入学习Python中的os.listdir函数
这篇文章主要给大家介绍了关于Python中os.listdir函数的相关资料,os.listdir是 Python中的一个函数,它的意思是返回指定目录下的文件和文件夹的名称的列表,需要的朋友可以参考下
2023-10-10
Python数据拟合实现最小二乘法示例解析
这篇文章主要为大家介绍了Python数据拟合实现最小二乘法的示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步
2021-10-10
python通过cython加密代码
这篇文章主要介绍了python通过cython实现加密的示例代码，帮助大家加密自己的python代码，提高安全性，感兴趣的朋友可以参考下
2020-12-12
Python3爬虫关于识别检验滑动验证码的实例
在本篇内容里小编给大家分享了关于Python3爬虫关于识别检验滑动验证码的实例内容，需要的朋友们可以学习下。
2020-07-07
python实现俄罗斯方块小游戏
这篇文章主要为大家详细介绍了python实现俄罗斯方块小游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-04-04
Python3实现将文件树中所有文件和子目录归档到tar压缩文件的方法
这篇文章主要介绍了Python3实现将文件树中所有文件和子目录归档到tar压缩文件的方法,涉及Python3使用tarfile模块实现tar压缩文件的技巧,需要的朋友可以参考下
2015-05-05