property属性

1. 什么是property属性

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

# ############### 定义 ############### class Foo: def func(self): pass # 定义property属性  @property def prop(self): pass # ############### 调用 ############### foo_obj = Foo() foo_obj.func() # 调用实例方法 foo_obj.prop # 调用property属性 

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

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

  方法：foo_obj.func()
    property属性：foo_obj.prop

2. 简单的实例

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

• 根据用户请求的当前页和总数据条数计算出 m 和 n

• 根据m 和 n 去数据库中请求数据

# ############### 定义 ############### class Pager: def __init__(self, current_page): # 用户当前请求的页码（第一页、第二页...） self.current_page = current_page # 每页默认显示10条数据 self.per_items = 10  @property def start(self): val = (self.current_page - 1) * self.per_items return val  @property def end(self): val = self.current_page * self.per_items return val # ############### 调用 ############### p = Pager(1) p.start # 就是起始值，即：m p.end # 就是结束值，即：n 

从上述可见

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

3. property属性的有两种方式

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

3.1 装饰器方式

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

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

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

# ############### 定义 ############### class Goods:  @property def price(self): return "laowang" # ############### 调用 ############### obj = Goods() result = obj.price # 自动执行 @property 修饰的 price 方法，并获取方法的返回值 print(result) 

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

#coding=utf-8 # ############### 定义 ############### class Goods: """python3中默认继承object类 以python二、3执行此程序的结果不一样，由于只有在python3中才有@xxx.setter @xxx.deleter """  @property def price(self): print('@property')  @price.setter def price(self, value): print('@price.setter')  @price.deleter def price(self): print('@price.deleter') # ############### 调用 ############### obj = Goods() obj.price # 自动执行 @property 修饰的 price 方法，并获取方法的返回值 obj.price = 123 # 自动执行 @price.setter 修饰的 price 方法，并将 123 赋值给方法的参数 del obj.price # 自动执行 @price.deleter 修饰的 price 方法 

注意

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

因为新式类中具备三种访问方式，咱们能够根据它们几个属性的访问特色，分别将三个方法定义为对同一个属性：获取、修改、删除

class Goods(object): def __init__(self): # 原价 self.original_price = 100 # 折扣 self.discount = 0.8  @property def price(self): # 实际价格 = 原价 * 折扣 new_price = self.original_price * self.discount return new_price  @price.setter def price(self, value): self.original_price = value  @price.deleter def price(self): del self.original_price obj = Goods() obj.price # 获取商品价格 obj.price = 200 # 修改商品原价 del obj.price # 删除商品原价 

3.2 类属性方式，建立值为property对象的类属性

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

class Foo: def get_bar(self): return 'laowang' BAR = property(get_bar) obj = Foo() reuslt = obj.BAR # 自动调用get_bar方法，并获取方法的返回值 print(reuslt) 

property方法中有个四个参数

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

#coding=utf-8 class Foo(object): def get_bar(self): print("getter...") return 'laowang' def set_bar(self, value): """必须两个参数""" print("setter...") return 'set value' + value def del_bar(self): print("deleter...") return 'laowang' BAR = property(get_bar, set_bar, del_bar, "description...") obj = Foo() obj.BAR # 自动调用第一个参数中定义的方法：get_bar obj.BAR = "alex" # 自动调用第二个参数中定义的方法：set_bar方法，并将“alex”看成参数传入 desc = Foo.BAR.__doc__ # 自动获取第四个参数中设置的值：description... print(desc) del obj.BAR # 自动调用第三个参数中定义的方法：del_bar方法 

因为类属性方式建立property属性具备3种访问方式，咱们能够根据它们几个属性的访问特色，分别将三个方法定义为对同一个属性：获取、修改、删除

class Goods(object): def __init__(self): # 原价 self.original_price = 100 # 折扣 self.discount = 0.8 def get_price(self): # 实际价格 = 原价 * 折扣 new_price = self.original_price * self.discount return new_price def set_price(self, value): self.original_price = value def del_price(self): del self.original_price PRICE = property(get_price, set_price, del_price, '价格属性描述...') obj = Goods() obj.PRICE # 获取商品价格 obj.PRICE = 200 # 修改商品原价 del obj.PRICE # 删除商品原价 

4. Django框架中应用了property属性（了解）

WEB框架 Django 的视图中 request.POST 就是使用的类属性的方式建立的属性

class WSGIRequest(http.HttpRequest): def __init__(self, environ): script_name = get_script_name(environ) path_info = get_path_info(environ) if not path_info: # Sometimes PATH_INFO exists, but is empty (e.g. accessing # the SCRIPT_NAME URL without a trailing slash). We really need to # operate as if they'd requested '/'. Not amazingly nice to force # the path like this, but should be harmless. path_info = '/' self.environ = environ self.path_info = path_info self.path = '%s/%s' % (script_name.rstrip('/'), path_info.lstrip('/')) self.META = environ self.META['PATH_INFO'] = path_info self.META['SCRIPT_NAME'] = script_name self.method = environ['REQUEST_METHOD'].upper() _, content_params = cgi.parse_header(environ.get('CONTENT_TYPE', '')) if 'charset' in content_params: try: codecs.lookup(content_params['charset']) except LookupError: pass else: self.encoding = content_params['charset'] self._post_parse_error = False try: content_length = int(environ.get('CONTENT_LENGTH')) except (ValueError, TypeError): content_length = 0 self._stream = LimitedStream(self.environ['wsgi.input'], content_length) self._read_started = False self.resolver_match = None def _get_scheme(self): return self.environ.get('wsgi.url_scheme') def _get_request(self): warnings.warn('`request.REQUEST` is deprecated, use `request.GET` or ' '`request.POST` instead.', RemovedInDjango19Warning, 2) if not hasattr(self, '_request'): self._request = datastructures.MergeDict(self.POST, self.GET) return self._request  @cached_property def GET(self): # The WSGI spec says 'QUERY_STRING' may be absent. raw_query_string = get_bytes_from_wsgi(self.environ, 'QUERY_STRING', '') return http.QueryDict(raw_query_string, encoding=self._encoding) # ############### 看这里看这里 ############### def _get_post(self): if not hasattr(self, '_post'): self._load_post_and_files() return self._post # ############### 看这里看这里 ############### def _set_post(self, post): self._post = post  @cached_property def COOKIES(self): raw_cookie = get_str_from_wsgi(self.environ, 'HTTP_COOKIE', '') return http.parse_cookie(raw_cookie) def _get_files(self): if not hasattr(self, '_files'): self._load_post_and_files() return self._files # ############### 看这里看这里 ############### POST = property(_get_post, _set_post) FILES = property(_get_files) REQUEST = property(_get_request) 

综上所述:

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