Python 使用@property对属性进行数据规范性校验的实现

作者:a772304419 时间:2021-03-31 00:37:10 

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


s = Student()
s.score = 9999

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

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


>>> s = Student()
>>> s.set_score(60) # ok!
>>> s.get_score()
60
>>> s.set_score(9999)
Traceback (most recent call last):
 ...
ValueError: score must between 0 ~ 100!

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

有没有既能检查参数,又可以用类似属性这样简单的方式来访问类的变量呢?对于追求完美的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和当前时间计算出来。

要特别注意:属性的方法名不要和实例变量重名。例如,以下的代码是错误的:


class Student(object):

# 方法名称和实例变量均为birth:
   @property
   def birth(self):
       return self.birth

这是因为调用s.birth时,首先转换为方法调用,在执行return self.birth时,又视为访问self的属性,于是又转换为方法调用,造成无限递归,最终导致栈溢出报错RecursionError。

小结

@property广泛应用在类的定义中,可以让调用者写出简短的代码,同时保证对参数进行必要的检查,这样,程序运行时就减少了出错的可能性。

练习

请利用@property给一个Screen对象加上width和height属性,以及一个只读属性resolution:


# -*- coding: utf-8 -*-
# 测试:
s = Screen()
s.width = 1024
s.height = 768
print('resolution =', s.resolution)
if s.resolution == 786432:
print('测试通过!')
else:
print('测试失败!')

完整源码:


#!/usr/bin/env python3
# -*- coding: utf-8 -*-

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

s = Student()
s.score = 60
print('s.score =', s.score)
# ValueError: score must between 0 ~ 100!
s.score = 9999

来源:https://blog.51cto.com/zhangxueliang/4253913

标签:Python,@property,属性,校验
0
投稿

猜你喜欢

  • 关于Node.js中Buffer的一些你可能不知道的用法

    2024-05-09 09:05:33
  • Django框架中表单的用法

    2022-03-29 02:00:14
  • 如何取得服务器上的用户组列表?

    2010-01-18 20:54:00
  • Python加载文件内容的两种实现方式

    2023-09-01 03:17:14
  • php上传大文件设置方法

    2023-11-21 19:11:22
  • Vue组件封装之input输入框实战记录

    2024-05-29 22:25:24
  • Python拼接字符串的7种方法总结

    2022-10-28 08:38:00
  • 8大措施帮你构筑Access安全防线

    2010-03-11 14:38:00
  • 详解python字节码

    2021-12-16 16:56:29
  • Python之二维正态分布采样置信椭圆绘制

    2021-04-08 06:39:09
  • 使用python Telnet远程登录执行程序的方法

    2022-12-22 11:56:57
  • JavaScript的Number对象的toString()方法

    2024-04-18 10:08:55
  • Python实现对一个函数应用多个装饰器的方法示例

    2022-01-23 17:30:22
  • 利用Django-environ如何区分不同环境

    2022-01-10 10:52:24
  • sql server中批量插入与更新两种解决方案分享(存储过程)

    2012-05-22 18:29:59
  • Python使用tkinter实现小时钟效果

    2022-08-14 09:00:18
  • python virtualenv虚拟环境配置与使用教程详解

    2023-01-21 23:06:56
  • python多线程和多进程关系详解

    2023-03-08 22:21:54
  • ASP使用连接MYSQL数据库全攻略

    2007-09-23 09:06:00
  • Oracle DECODE函数语法使用介绍

    2023-07-17 12:44:22
  • asp之家 网络编程 m.aspxhome.com