关于Python 中的 property 语法浅谈

水深无声 2024-03-23 22:12 64阅读 0赞

本文主要介绍了一文详述 Python 中的 property 语法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

property() 函数的作用是在新式类中返回属性值。

Python中有一个property的语法，它类似于C\#的get set语法，其功能有以下两点：

*  将类方法设置为只读属性；
 *  实现属性的getter和setter方法；

下面开始本文的重点介绍，Python 中的 property 语法介绍，具体内容如下所示：

在大多数语言的程序中，一个类，每有一个属性，就会对应 setter 和 getter，基本都是标配。

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>class</code> <code>Money(</code><code>object</code><code>):</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.__money </code><code>=</code> <code>0</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>getMoney(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>self</code><code>.__money</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>setMoney(</code><code>self</code><code>, value):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>isinstance</code><code>(value, </code><code>int</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.__money </code><code>=</code> <code>value</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>else</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>"error:不是整型数字"</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

设置私有属性的目的就是不想让数据被误取出来，增加一个方法去获取私有属性或者设置私有属性，那么就保证将来想获取属性的时候就获取，想设置的时候还可以进行过滤。

其他语言基本都是这么做的，但是 Python 不推荐。 Python 有 property。

**一、什么是property属性**

一种用起来像是使用的实例属性一样的特殊属性，可以对应于某个方法。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>class</code> <code>Foo:</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>func(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>pass</code> <code>&nbsp;&nbsp;</code><code># 定义property属性</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>prop(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>pass</code> <code>foo_obj </code><code>=</code> <code>Foo()</code> <code>foo_obj.func() </code><code># 调用实例方法</code> <code>foo_obj.prop </code><code># 调用property属性</code> </td> 
 </tr> 
 </tbody> 
</table>

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>class</code> <code>Goods:</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>size(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>100</code> <code>obj </code><code>=</code> <code>Goods()</code> <code>ret </code><code>=</code> <code>obj.size </code><code># 调用属性</code> <code>print</code><code>(ret) </code><code># 100</code> </td> 
 </tr> 
 </tbody> 
</table>

obj.size 会自动地去调用 size 方法，返回 size 方法的返回值。

property属性的定义和调用要注意以下几点：

*  定义时，在实例方法的基础上添加 @property 装饰器；
 *  仅有一个self参数；
 *  调用时，无需括号。

那 property 属性到底是用来干什么的？下面看一个实例。

对于京东商城中显示电脑主机的列表页面，每次请求不可能把数据库中的所有内容都显示到页面上，而是通过分页的功能局部显示，所以在向数据库中请求数据时就要显示的指定获取从第m条到第n条的所有数据，这个分页的功能包括：

*  根据用户请求的当前页和总数据条数计算出 m 和 n。
 *  根据m 和 n 去数据库中请求数据。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 </td> 
 <td> <code>class</code> <code>Pager:</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>, current_page):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 用户当前请求的页码（第一页、第二页...）</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.current_page </code><code>=</code> <code>current_page</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 每页默认显示10条数据</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.per_items </code><code>=</code> <code>10</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>start(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>val </code><code>=</code> <code>(</code><code>self</code><code>.current_page </code><code>-</code> <code>1</code><code>) </code><code>*</code> <code>self</code><code>.per_items</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>val</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>end(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>val </code><code>=</code> <code>self</code><code>.current_page </code><code>*</code> <code>self</code><code>.per_items</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>val</code> <code>p </code><code>=</code> <code>Pager(</code><code>1</code><code>)</code> <code>p.start </code><code># 就是起始值，即：m</code> <code>p.end </code><code># 就是结束值，即：n</code> </td> 
 </tr> 
 </tbody> 
</table>

从上述可见，Python 的 property 属性的功能是：property属性内部进行一系列的逻辑计算，最终将计算结果返回。

**二、property属性的有两种方式**

*  装饰器 即：在方法上应用装饰器。
 *  类属性 即：在类中定义值为 property 对象的类属性。

**1、装饰器方式**

在类的实例方法上应用 @property 装饰器。

Python中的类有经典类和新式类，新式类的属性比经典类的属性丰富。（ 如果类继object，那么该类是新式类 ）

经典类，具有一种 @property 装饰器。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>class</code> <code>Goods:</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>"laowang"</code> <code>obj </code><code>=</code> <code>Goods()</code> <code># 自动执行 @property 修饰的 price 方法，并获取方法的返回值</code> <code>result </code><code>=</code> <code>obj.price </code> <code>print</code><code>(result) </code><code># laowang</code> </td> 
 </tr> 
 </tbody> 
</table>

新式类，具有三种@property装饰器。

python3 中默认继承object类，只有在 python3 中才有@xxx.setter @xxx.deleter。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 </td> 
 <td> <code>class</code> <code>Goods:</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>'@property'</code><code>)</code> <code>&nbsp;&nbsp;</code><code>@price</code><code>.setter</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>, value):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>'@price.setter'</code><code>)</code> <code>&nbsp;&nbsp;</code><code>@price</code><code>.deleter</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>'@price.deleter'</code><code>)</code> <code>obj </code><code>=</code> <code>Goods()</code> <code># 自动执行 @property 修饰的 price 方法，并获取方法的返回值</code> <code>obj.price </code><code># @property</code> <code># 自动执行 @price.setter 修饰的 price 方法，并将 123 赋值给方法的参数</code> <code>obj.price </code><code>=</code> <code>123</code> <code># @price.setter</code> <code># 自动执行 @price.deleter 修饰的 price 方法</code> <code>del</code> <code>obj.price </code><code># @price.deleter</code> </td> 
 </tr> 
 </tbody> 
</table>

注意：

*  经典类中的属性只有一种访问方式，其对应被 @property 修饰的方法。
 *  新式类中的属性有三种访问方式，并分别对应了三个被@property、@方法名.setter、@方法名.deleter修饰的方法。

由于新式类中具有三种访问方式，我们可以根据它们几个属性的访问特点，分别将三个方法定义为对同一个属性：获取、修改、删除。

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 </td> 
 <td> <code>class</code> <code>Goods(</code><code>object</code><code>):</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 原价</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.original_price </code><code>=</code> <code>100</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 折扣</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.discount </code><code>=</code> <code>0.8</code> <code>&nbsp;&nbsp;</code><code>@property</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 实际价格 = 原价 * 折扣</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>new_price </code><code>=</code> <code>self</code><code>.original_price </code><code>*</code> <code>self</code><code>.discount</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new_price</code> <code>&nbsp;&nbsp;</code><code>@price</code><code>.setter</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>, value):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.original_price </code><code>=</code> <code>value</code> <code>&nbsp;&nbsp;</code><code>@price</code><code>.deleter</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>del</code> <code>self</code><code>.original_price</code> <code>obj </code><code>=</code> <code>Goods()</code> <code>obj.price&nbsp;&nbsp;&nbsp;&nbsp; </code><code># 获取商品价格</code> <code>obj.price </code><code>=</code> <code>200</code>&nbsp; <code># 修改商品原价</code> <code>del</code> <code>obj.price&nbsp;&nbsp; </code><code># 删除商品原价</code> </td> 
 </tr> 
 </tbody> 
</table>

2、类属性方式

创建值为 property 对象的类属性。

当使用类属性的方式创建property属性时，经典类和新式类无区别。

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>class</code> <code>Foo:</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>get_bar(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>'laowang'</code> <code>&nbsp;&nbsp;</code><code>BAR </code><code>=</code> <code>property</code><code>(get_bar)</code> <code>obj </code><code>=</code> <code>Foo()</code> <code>reuslt </code><code>=</code> <code>obj.BAR </code><code># 自动调用get_bar方法，并获取方法的返回值</code> <code>print</code><code>(reuslt) </code><code># laowang</code> </td> 
 </tr> 
 </tbody> 
</table>

property方法中有个四个参数

*  第一个参数是方法名，调用 对象.属性 时自动触发执行方法。
 *  第二个参数是方法名，调用 对象.属性 ＝ XXX 时自动触发执行方法。
 *  第三个参数是方法名，调用 del 对象.属性 时自动触发执行方法。第四个参数是字符串，调用 对象.属性.\_\_doc\_\_ ，此参数是该属性的描述信息。

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 </td> 
 <td> <code>class</code> <code>Foo(</code><code>object</code><code>):</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>get_bar(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>"getter..."</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>'laowang'</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>set_bar(</code><code>self</code><code>, value):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>"""必须两个参数"""</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>"setter..."</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>'set value'</code> <code>+</code> <code>value</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>del_bar(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(</code><code>"deleter..."</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>'laowang'</code> <code>&nbsp;&nbsp;</code><code>BAR </code><code>=</code> <code>property</code><code>(get_bar, set_bar, del_bar, </code><code>"description..."</code><code>)</code> <code>obj </code><code>=</code> <code>Foo()</code> <code># 自动调用第一个参数中定义的方法：get_bar</code> <code>obj.BAR </code><code># getter...</code> <code># 自动调用第二个参数中定义的方法：set_bar方法，并将“alex”当作参数传入</code> <code>obj.BAR </code><code>=</code> <code>"alex"</code> <code># setter...</code> <code># 自动获取第四个参数中设置的值：description...</code> <code>desc </code><code>=</code> <code>Foo.BAR.__doc__</code> <code>print</code><code>(desc) </code><code># description...</code> <code># 自动调用第三个参数中定义的方法：del_bar方法</code> <code>del</code> <code>obj.BAR </code><code># deleter...</code> </td> 
 </tr> 
 </tbody> 
</table>

由于类属性方式创建 property 属性具有3种访问方式，我们可以根据它们几个属性的访问特点，分别将三个方法定义为对同一个属性：获取、修改、删除。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 </td> 
 <td> <code>class</code> <code>Goods(</code><code>object</code><code>):</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>__init__(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 原价</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.original_price </code><code>=</code> <code>100</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 折扣</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.discount </code><code>=</code> <code>0.8</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>get_price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 实际价格 = 原价 * 折扣</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>new_price </code><code>=</code> <code>self</code><code>.original_price </code><code>*</code> <code>self</code><code>.discount</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>new_price</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>set_price(</code><code>self</code><code>, value):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.original_price </code><code>=</code> <code>value</code> <code>&nbsp;&nbsp;</code><code>def</code> <code>del_price(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>del</code> <code>self</code><code>.original_price</code> <code>&nbsp;&nbsp;</code><code>PRICE </code><code>=</code> <code>property</code><code>(get_price, set_price, del_price, </code><code>'价格属性描述...'</code><code>)</code> <code>obj </code><code>=</code> <code>Goods()</code> <code>obj.PRICE&nbsp;&nbsp;&nbsp;&nbsp; </code><code># 获取商品价格</code> <code>obj.PRICE </code><code>=</code> <code>200</code>&nbsp; <code># 修改商品原价</code> <code>del</code> <code>obj.PRICE&nbsp;&nbsp; </code><code># 删除商品原价</code> </td> 
 </tr> 
 </tbody> 
</table>

综上所述:

*  定义property属性共有两种方式，分别是【装饰器】和【类属性】，而【装饰器】方式针对经典类和新式类又有所不同。
 *  通过使用property属性，能够简化调用者在获取数据的流程。

转自：[微点阅读][Link 1] [https://www.weidianyuedu.com][https_www.weidianyuedu.com]

[Link 1]: https://m.weidianyuedu.com/
[https_www.weidianyuedu.com]: https://www.weidianyuedu.com