property的使用

本质上说,本文提到的 @property 和上一篇文章提到的 @classmethod、@staticmethod 都是装饰器,都是对函数定义进行补充使之具有特殊功能。

正文

一、

设想:当我定义了一个用户类:

class User(Model):
    ...
    password = db.Column(db.String(64))
    ...

在上例中,很明显,password 是可以显式调用的属性,这在网站设计中绝不可以出现,会造成用户数据泄露的极大风险。那么,要将其变为私有属性,需要修改如下:

class User(Model):
    ...
    __password = db.Column(db.String(64))

这样,当创建实例变量后,再访问此属性会抛出 AttributeError 异常:

AttributeError: 'User' object has no attribute '__password'

这是一种解决办法,可是,当我们需要获取或者修改这个属性的值时,该怎么办呢?

只能通过为类增加实例方法来实现,方法中还可以加入参数检查的功能:

class User(Model):
    
    def __init__(self, name, score):
        self.__name = name
        self.__score = score

    def get_score(self):
        return self.__score

    def set_score(self, score):
    if 0 <= score <= 100:
        self.__score = score
    else:
        rasie ValueError('bad score')

但上面的方法略显复杂,python 提供了 @property 装饰器,可以轻松实现上述功能。

二、

创建一个只读属性:

class User(object):
    ...
    @property
    def score():
        return __score
    ...

使用 @property 可以将一个方法变为属性,无 @property 时,需要 u.score();使用之后,直接调用 u.score即可。

对于网站设计来说,常采用的做法是:将密码设置为只写属性,存储时,只存储其与其他用户属性生成的散列值(如用户密码+用户邮箱):

class User:
    
    @property
    def password(self):
        raise AttributeError('Password is not accessable.')

    @password.setter
    def password(self, password):
        self.password_hash = generate_password_hash(password)

当我们设置密码时,就可以使用 u.password = 'xxxx' 了。

在这个过程中,@property 又产生了另一个装饰器 @password.setter 将 password 方法变成属性赋值。

在 Python 的官方文档中,除了 gettersetter 外,还有一个 deleter

class User:
    
    @property
    def score():
        return __score

    @score.deleter
    def score(self):
        del score

顾名思义,这个派生出来的装饰器可以用来删除用户属性。

三、

在官方文档中,@property 装饰器还被这样使用:

class C:
    def __init__(self):
        self._x = None

    def getx(self):
        return self._x

    def setx(self, value):
        self._x = value

    def delx(self):
        del self._x

    x = property(getx, setx, delx, "I'm the 'x' property.")

这样,u 是 C 的实例,当访问 u.x 时,将调用 u.getx() 方法。

u.x = value 将调用 u.setx(value) 方法。

del u.x 将调用 u.delx() 方法。

四、

@property 能将方法变成属性,又可在方法中加入参数检查的功能,这将它可普通属性区别开来,同时比定义额外的 get/set 方法清晰明了。将方法变成属性,这是 @property 的精髓。

参考链接


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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 上次我们说到了构造方法,书接上文,这次我们来详细了解一下OC中@property中的内容.本文也是我自己寻找了相关...
    哈利_阅读 905评论 0 1
  • 装饰器(decorator)可以给函数动态加上功能,对于类的方法,装饰器一样起作用。Python内置的@prope...
    SevenBy阅读 6,043评论 0 1
  • Property常用的属性 常用场景 属性中的修饰词 : assign ( ARC/MRC )1:assign用于...
    IOS开发攻城狮_Fyc阅读 214评论 0 0
  • 金庸武侠小说的魅力不容置疑,刀光剑影,侠骨柔情的江湖让人心潮澎湃。殊不知,不管正派反派,除了飞檐走壁、开山裂石的功...
    记忆大师app阅读 1,523评论 0 0