Python中的property属性

Python中有个很赞的概念,叫做property,它使得面向对象的编程更加简单。在详细解释和深入了解Python中的property之前,让我们首先建立这样一个直觉:为什么我们需要用到property? 从一个

Python中有个很赞的概念,叫做property,它使得面向对象的编程更加简单。在详细解释和深入了解Python中的property之前,让我们首先建立这样一个直觉:为什么我们需要用到property?

从一个实例开始

假设有天你决定创建一个类,用来存储摄氏温度。当然这个类也需要实现一个将摄氏温度转换为华氏温度的方法。一种实现的方式如下:

Python

class Celsius :

def __init__ ( self , temperature = 0 ) :

self . temperature = temperature

def to_fahrenheit ( self ) :

return ( self . temperature * 1.8 ) + 32

我们可以用这个类产生一个对象,然后按照我们期望的方式改变该对象的温度属性:

Python

>>> # create new object

>>> man = Celsius ( )

>>> # set temperature

>>> man . temperature = 37

>>> # get temperature

>>> man . temperature

37

>>> # get degrees Fahrenheit

>>> man . to_fahrenheit ( )

98.60000000000001

这里额外的小数部分是转换成华氏温度时由于浮点运算误差造成的(你可以在Python解释器中试试1.1 + 2.2)。每当我们赋值或获取任何对象的属性时,例如上面展示的温度,Python都会从对象的 __dict__ 字典中搜索它。

Python

>>> man . __dict_ _

{ 'temperature' : 37 }

因此,man.temperature在其内部就变成了 man.__dict__['temperature']

现在,让我们进一步假设我们的类在客户中很受欢迎,他们开始在其程序中使用这个类。他们对该类生成的对象做了各种操作。有一天,一个受信任的客户来找我们,建议温度不能低于-273摄氏度(热力学的同学可能会提出异议,它实际上是-273.15),也被称为绝对零。客户进一步要求我们实现这个值约束。作为一个以争取客户满意度为己任的公司,我们很高兴地听从了建议,发布了1.01版本,升级了我们现有的类。

使用Getters和Setters

对于上边的约束,一个很容易想到的解决方案是隐藏其温度属性(使其私有化),并且定义新的用于操作温度属性的getter和setter接口。可以这么实现:

Python

class Celsius :

def __init__ ( self , temperature = 0 ) :

self . set_temperature ( temperature )

def to_fahrenheit ( self ) :

return ( self . get_temperature ( ) * 1.8 ) + 32

# new update

def get_temperature ( self ) :

return self . _temperature

def set_temperature ( self , value ) :

if value < - 273 :

raise ValueError ( "Temperature below -273 is not possible" )

self . _temperature = value

从上边可以看出,我们定义了两个新方法 get_temperature() 和set_temperature() ,此外属性temperature也被替换为了 _temperature 。最前边的下划线(_)用于指示Python中的私有变量。

Python

>>> c = Celsius ( - 277 )

Traceback ( most recent call last ) :

. . .

ValueError : Temperature below - 273 is not possible

>>> c = Celsius ( 37 )

>>> c . get_temperature ( )

37

>>> c . set_temperature ( 10 )

>>> c . set_temperature ( - 300 )

Traceback ( most recent call last ) :

. . .

ValueError : Temperature below - 273 is not possible

这个更新成功地实现了新约束,我们不再允许设置温度低于-273度。

请注意,Python中实际上是没有私有变量的。有一些简单的被遵循的规范。Python本身不会应用任何限制。

Python

>>> c . _temperature = - 300

>>> c . get_temperature ( )

- 300

但这样并不会让人很放心。上述更新的最大问题是,所有在他们的程序中使用了我们先前类的客户都必须更改他们的代码:obj.temperature改为obj.get_temperature(),所有的赋值语句也必须更改,比如obj.temperature = val改为obj.set_temperature(val)。这样的重构会给那些拥有成千上万行代码的客户带来很大的麻烦。

总而言之,我们的更新是不向后兼容地。这就是需要property闪亮登场的地方。

Property的作用

对于上边的问题,Python式的解决方式是使用property。这里是我们已经实现了的一个版本:

Python

class Celsius :

def __init__ ( self , temperature = 0 ) :

self . temperature = temperature

def to_fahrenheit ( self ) :

return ( self . temperature * 1.8 ) + 32

def get_temperature ( self ) :

print ( "Getting value" )

return self . _temperature

def set_temperature ( self , value ) :

if value < - 273 :

raise ValueError ( "Temperature below -273 is not possible" )

print ( "Setting value" )

self . _temperature = value

temperature = property ( get_temperature , set_temperature )

我们在 get_temperature() 和 set_temperature() 的内部增加了一个print()函数,用来清楚地观察它们是否正在执行。代码的最后一行,创建了一个property对象temperature。简单地说,property将一些代码( get_temperature 和set_temperature )附加到成员属性(temperature)的访问入口。任何获取temperature值的代码都会自动调用 get_temperature() ,而不是去字典表(__dict__ )中进行查找。同样的,任何赋给temperature值的代码也会自动调用set_temperature() 。这是Python中一个很酷的功能。我们实际演示一下。

Python

>>> c = Celsius ( )

Setting value

从上边的代码中我们可以看到,即使当我们创建一个对象时,set_temperature() 也会被调用。你能猜到为什么吗?原因是,当一个对象被创建时, __init__() 方法被调用。该方法有一行代码self.temperature = temperature。这个任务会自动调用 set_temperature() 方法。

Python

>>> c . temperature

Getting value

0

同样的,对于属性的任何访问,例如c.temperature,也会自动调用get_temperature() 方法。这就是property所作的事情。这里有一些额外的实例。

Python

>>> c . temperature = 37

Setting value

>>> c . to_fahrenheit ( )

Getting value

98.60000000000001

我们可以看到,通过使用property,我们在不需要客户代码做任何修改的情况下,修改了我们的类,并实现了值约束。因此我们的实现是向后兼容的,这样的结果,大家都很高兴。

最后需要注意的是,实际温度值存储在私有变量 _temperature 中。属性temperature是一个property对象,是用来为这个私有变量提供接口的。

深入挖掘property

在Python中,property()是一个内置函数,用于创建和返回一个property对象。该函数的签名为:

Python

property ( fget = None , fset = None , fdel = None , doc = None )

这里,fget是一个获取属性值的函数,fset是一个设置属性值的函数,fdel是一个删除属性的函数,doc是一个字符串(类似于注释)。从函数实现上看,这些函数参数都是可选的。所以,可以按照如下的方式简单的创建一个property对象。

Python

>>> property ( )

< property object at 0x0000000003239B38 >

Property对象有三个方法,getter(), setter()和delete(),用来在对象创建后设置fget,fset和fdel。这就意味着,这行代码:temperature = property(get_temperature,set_temperature)可以被分解为:

Python

# make empty property

temperature = property ( )

# assign fget

temperature = temperature . getter ( get_temperature )

# assign fset

temperature = temperature . setter ( set_temperature )

它们之间是相互等价的。

熟悉Python中装饰器decorator的程序员能够认识到上述结构可以作为decorator实现。我们可以更进一步,不去定义名字get_temperature和set_temperature,因为他们不是必须的,并且污染类的命名空间。为此,我们在定义getter函数和setter函数时重用名字temperature。下边的代码展示如何实现它。

Python

class Celsius :

def __init__ ( self , temperature = 0 ) :

self . _temperature = temperature

def to_fahrenheit ( self ) :

return ( self . temperature * 1.8 ) + 32

@ property

def temperature ( self ) :

print ( "Getting value" )

return self . _temperature

@ temperature . setter

def temperature ( self , value ) :

if value < - 273 :

raise ValueError ( "Temperature below -273 is not possible" )

print ( "Setting value" )

self . _temperature = value

上边的两种生成property的实现方式,都很简单,推荐使用。在Python寻找property时,你很可能会遇到这种类似的代码结构。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容