答疑·限时优惠

如果,你想让我看见你的疑问并且百分之百的回答。可以加入我的知识星球。
AI悦创·进化岛
AI悦创·进化岛

你好,我是悦创。

在我啃代理池的时候呢,遇到了这个 @property 的装饰器,但我确认对她没有任何感觉,为此呢就不得不再去找资料啃这些知识点了,接下来我把我的个人心得传授给你。

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

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 = Student()
student.set_score(10)
print(student.get_score())

# 现在的代码可以如此修改分数
student.score = 100
print(student.get_score())

# 我们直接访问属性值可以直接没有范围限制的修改
student.score = 10000000
print(student.get_score())

运行结果如下:

10
100
10000000

这显然不合逻辑。为了限制 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!') # raise 自己 DIY 异常
        self._score = value

还是上面的操作代码:

# 常规操作
student = Student()
student.set_score(10)
print(student.get_score())

# 现在的代码就无法进行对属性值的修改
student.score = 100
print(student.get_score())

# 现在的代码就无法进行对属性值的修改
student.score = 10000000
print(student.get_score())

运行结果:

10
10
10

这样就只能通过 set_score() 函数进行设置,并且我的 set_score() 函数限制了 self._score 值的大小。

所以当我们添加或者修改 self._score 的值时,满足范围的则不会报错,不满足范围的则会报错且这个报错是我们自定义的。

代码示例如下:

# 常规操作(其实就像被强制你要通过函数操作)
student = Student()
student.set_score(10)
print(student.get_score())

# 输出:
10

# 常规操作(其实就像被强制你要通过函数操作)
student = Student()
student.set_score(1000)
print(student.get_score())

# 输出:
Traceback (most recent call last):
  File "C:/Code/pycharm_daima/test.py", line 14, in <module>
    student.set_score(1000)
  File "C:/Code/pycharm_daima/test.py", line 9, in set_score
    raise ValueError('score must between 0 ~ 100!') # raise 自己 DIY 异常
ValueError: score must between 0 ~ 100!

看到这里很成功也很常规,这也是很多公众号就写到这或者根本不会这么详细,而你们也觉得懂了,这就问题很粗了。有个问题来了,不管你们有没有想到其他公众号故意避开问题来写(或者是没意识到)还是其他,我要把它提出了,我们把它的操作方法变成下面的代码又可以成功操作了:

student = Student()
student.set_score(10)
student._score = 100
print(student.get_score())

# 输出
100

这里要注意观察我们在 score 前面加上了 _ 也就是这个: student._score 成功修改值也赋值,你把 student.set_score(10) 去掉也还是可以正常赋值的。对于这个问题,我已经写在我的博客上面了,这里就不做赘述了 1

现在,对任意的 Student 实例进行操作,就不能随心所欲地设置 score 了:

但是,上面的调用方法又略显复杂,没有直接用属性这么直接简单。

有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?对于追求完美的 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广泛应用在类的定义中,可以让调用者写出简短的代码,同时保证对参数进行必要的检查,这样,程序运行时就减少了出错的可能性。


  1. https://www.aiyc.top/archives/550.html ↩︎
AI悦创·创造不同!
AI悦创 » Python 中的 @property

Leave a Reply