关于Python中property属性的用处

我会带着你远行 2024-03-30 11:38 68阅读 0赞

Python 动态属性的概念可能会被面试问到，在项目当中也非常实用，但是在一般的编程教程中不会提到，可以进修一下。

先看一个简单的例子。创建一个 Student 类，我希望通过实例来获取每个学生的一些情况，包括名字，成绩等。成绩只有等到考试结束以后才会有，所以实例化的时候不会给它赋值。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>class</code> <code>Student:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>, name):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.name </code><code>=</code> <code>name</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.score </code><code>=</code> <code>None</code> <code>mike </code><code>=</code> <code>Student(</code><code>'mike'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

考试完以后，准备给 mike 打分：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>mike.score </code><code>=</code> <code>999</code> </td> 
 </tr> 
 </tbody> 
</table>

在这里，老师一不小心多打了个 9 ，通常来说打分都是 100 分值，999 是一个非法数据，不应该赋值成功。学生一多，老师打分出现手误的情况肯定会越来越多，所以我们必须想办法修改程序，限制 score 的值必须在 0-100 分。

### 限制值 ###

我们定义一个方法，如果输入的不是 0-100 的整数，就让程序报错，数据合法，我们就把 score 属性修改成功。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>def</code> <code>set_score(</code><code>self</code><code>, new_score):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>not</code> <code>isinstance</code><code>(new_score, </code><code>int</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'score must be int'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>0</code> <code>&lt;</code><code>=</code> <code>new_score &lt;</code><code>=</code> <code>100</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.score </code><code>=</code> <code>new_score</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code><code>.score</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>else</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'score invalid'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

这样我们每次需要获取成绩的时候使用 self.score 获取，修改成绩的时候调用函数来修改：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>mike.set_score(</code><code>999</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

调用以后会报错，因为 999 是非法数据。注意，这个时候我使用 self.score 还是可以进行设置，而且不报错：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>self</code><code>.score </code><code>=</code> <code>999</code> </td> 
 </tr> 
 </tbody> 
</table>

这显然是不行的。所以我们要提供一种机制，把 score 变成私有属性，不能让外部访问。很遗憾，python 的私有属性是伪私有。通常我们把 `_` 开头的属性叫私有属性，但是这只是一种协议和规定，你看到下划线开头的属性，不要去访问了。你硬要访问，是可以的，python 并不会禁止。

### 使用 @property 的方式代替。 ###

上面的方法虽然实现了功能，但是改变了属性的使用方式。平常是这样使用的：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code># 获取属性</code> <code>a </code><code>=</code> <code>mike.score</code> <code># 设置属性</code> <code>mike.score </code><code>=</code> <code>99</code> <code>@property</code> <code>def</code> <code>score(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code><code>._score</code> <code>@score</code><code>.setter</code> <code>def</code> <code>score(</code><code>self</code><code>, new_score):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>not</code> <code>isinstance</code><code>(new_score, </code><code>int</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'score must be int'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>0</code> <code>&lt;</code><code>=</code> <code>new_score &lt;</code><code>=</code> <code>100</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>._score </code><code>=</code> <code>new_score</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code><code>._score</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>else</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code> <code>ValueError(</code><code>'score invalid'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

### 动态属性的好处 ###

*  统一了调用方式。self.score = 99 的方式，而不是函数调用的方式。
 *  `_score` 我们就不直接去使用了。你要用也可以，不建议。
 *  如果我们一个属性只可以读，把 setter 部分注释掉就可以了。

现在我们来完善这个类，添加 birth 属性和年龄属性：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>from</code> <code>datetime </code><code>import</code> <code>datetime</code> <code>class</code> <code>Student:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>, name, birth</code><code>=</code><code>1920</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.name </code><code>=</code> <code>name</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>._score </code><code>=</code> <code>None</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.birth </code><code>=</code> <code>birth</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.age </code><code>=</code> <code>datetime.now().year </code><code>-</code> <code>self</code><code>.birth</code> <code>mike </code><code>=</code> <code>Student(</code><code>'mike'</code><code>)</code> <code>print</code><code>(mike.birth)</code> <code>print</code><code>(mike.age)</code> </td> 
 </tr> 
 </tbody> 
</table>

* birth 和 age 这两个是可以根据一个求出另外一个的。存在数据冗余问题。
 * age 属性这样是有问题的。mike 初始化的时候，age 已经被求出来了，如果我在下一年再去访问 age 属性，那他就是个错误的值。可以通过把 age 设成现在的秒数来验证：
 
 <table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>self</code><code>.age </code><code>=</code> <code>datetime.now().second</code> <code>mike </code><code>=</code> <code>Student(</code><code>'mike'</code><code>)</code> <code>time.sleep(</code><code>5</code><code>)</code> <code>print</code><code>(mike.age)</code> <code>print</code><code>(datetime.now().second)</code> </td> 
 </tr> 
 </tbody> 
 </table>

### 动态显示 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>@property</code> <code>def</code> <code>age(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>datetime.now().year </code><code>-</code> <code>self</code><code>.birth</code> </td> 
 </tr> 
 </tbody> 
</table>

注意，这里不要去设置 @age.setter ，因为他是动态变化的，你修改了会造成数据不一致，它只能作为一个只读属性。

@property 作用和应用场景：

*  @property 优化了属性读取和设置的可读性
 *  需要限制属性的特征；
 *  只读属性。如果属性只可以读，不可以写，用起来很方便。
 *  这个属性根据一个变化的环境动态改变。

来源：[https://www.weidianyuedu.com][https_www.weidianyuedu.com]

[https_www.weidianyuedu.com]: https://www.weidianyuedu.com