Python進階文法_property屬性講解與應用

文章目錄

- property屬性講解與應用
- - property屬性
  - property屬性的有兩種方式
  - - 裝飾器方式
    - 類屬性方式：建立值為 property 對象的類屬性
  - Django架構中應用了property屬性（目前僅作了解）
  - property屬性-應用
  - - 私有屬性添加getter和setter方法
    - 使用property更新getter和setter方法
    - 使用property取代getter和setter方法

property屬性講解與應用

property屬性

什麼是property屬性？

一種用起來像是使用的執行個體屬性一樣的特殊屬性，可以對應于某個方法

# ############### 定義 ###############
class Foo:
    def func(self):
        pass

    # 定義property屬性
    @property
    def prop(self):
        pass

# ############### 調用 ###############
foo_obj = Foo()
foo_obj.func()  # 調用執行個體方法
foo_obj.prop  # 調用property屬性

Python進階文法_property屬性講解與應用

property屬性的定義和調用要注意一下幾點：

定義時，在執行個體方法的基礎上添加 @property 裝飾器；并且僅有一個self參數
調用時，無需括号

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

簡單的執行個體

以某網絡商城為例，對于商城中顯示商品的清單頁面，每次請求不可能把資料庫中的所有内容都顯示到頁面上，而是通過分頁的功能局部顯示，是以在向資料庫中請求資料時就要顯示的指定擷取從第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屬性内部進行一系列的邏輯計算，最終将計算結果傳回。

property屬性的有兩種方式

裝飾器即：在方法上應用裝飾器
類屬性即：在類中定義值為property對象的類屬性

裝飾器方式

在類的執行個體方法上應用@property裝飾器

Python中的類有經典類和新式類，新式類的屬性比經典類的屬性豐富。

這裡簡單的介紹一下什麼是

經典類

，什麼是

新式類

，以及二者之間的差別。

在Python2.x中，預設都是經典類，隻有顯式繼承了object才是新式類，即：

class Person(object):
	pass  # 新式類寫法


class Person():
	pass  # 經典類寫法


class Person:
	pass  # 經典類寫法

但是在Python 3.x中取消了經典類，預設都是新式類，并且不必顯式的繼承object，也就是說

class Person(object):
	pass


class Person():
	pass


class Person:
	pass

這三種寫法并無差別，但是推薦第一種。

他們最明顯的差別在于繼承搜尋的順序發生了改變，即

經典類

多繼承

搜尋順序(深度優先):

先深入繼承樹左側查找，然後再傳回，開始查找右側。

新式類

多繼承

搜尋順序(廣度優先):

先在水準方向查找，然後再向上查找。

具體詳細内容可以參考之前的 Python基礎：面向對象三大特性内的關于繼承-深度優先與廣度優先的講解。

經典類，具有一種@property裝飾器

# ############### 定義 ###############    
class Goods:
    @property
    def price(self):
        return "laowang"
# ############### 調用 ###############
obj = Goods()
result = obj.price  # 自動執行 @property 修飾的 price 方法，并擷取方法的傳回值
print(result)

新式類，具有三種@property裝飾器

# ############### 定義 ###############
class Goods:
    """python3中預設繼承object類
        以python2、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修飾的方法

由于新式類中具有三種通路方式，我們可以根據它們幾個屬性的通路特點，分别将三個方法定義為對同一個屬性：擷取、修改、删除.

比如以擷取商品折扣價格為例子，參考下方示例Demo

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     # 删除商品原價

類屬性方式：建立值為 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 ，此參數是該屬性的描述資訊

代碼示例：

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種通路方式，我們可以根據它們幾個屬性的通路特點，分别将三個方法定義為對同一個屬性：擷取、修改、删除

同樣以擷取商品折扣價格為例子，參考下方示例Demo

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     # 删除商品原價

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屬性，能夠簡化調用者在擷取資料的流程.

property屬性-應用

私有屬性添加getter和setter方法

代碼示例：

class Money(object):
    def __init__(self):
        self.__money = 0

    def getMoney(self):
        return self.__money

    def setMoney(self, value):
        if isinstance(value, int):
            self.__money = value
        else:
            print("error:不是整型數字")

使用property更新getter和setter方法

代碼示例：

class Money(object):
    def __init__(self):
        self.__money = 0

    def getMoney(self):
        return self.__money

    def setMoney(self, value):
        if isinstance(value, int):
            self.__money = value
        else:
            print("error:不是整型數字")

    # 定義一個屬性，當對這個money設定值時調用setMoney,當擷取值時調用getMoney
    money = property(getMoney, setMoney)  

a = Money()
a.money = 100  # 調用setMoney方法
print(a.money)  # 調用getMoney方法

使用property取代getter和setter方法

重新實作一個屬性的設定和讀取方法,可做邊界判定

class Money(object):
    def __init__(self):
        self.__money = 0

    # 使用裝飾器對money進行裝飾，那麼會自動添加一個叫money的屬性，當調用擷取money的值時，調用裝飾的方法
    @property
    def money(self):
        return self.__money

    # 使用裝飾器對money進行裝飾，當對money設定值時，調用裝飾的方法
    @money.setter
    def money(self, value):
        if isinstance(value, int):
            self.__money = value
        else:
            print("error:不是整型數字")

a = Money()
a.money = 100
print(a.money)

Python進階文法_property屬性講解與應用

文章目錄

property屬性講解與應用

property屬性

property屬性的有兩種方式

裝飾器方式

類屬性方式：建立值為 property 對象的類屬性

Django架構中應用了property屬性（目前僅作了解）

property屬性-應用

私有屬性添加getter和setter方法

使用property更新getter和setter方法

使用property取代getter和setter方法

繼續閱讀

Python學習之路（3）——python的資料類型（2）——清單清單

Python學習（第二站：第一個Python程式）

python2.7入門---字典（Dictionary）

Day02 - 語言元素

Python基礎入門第六課--字元串 1.前言 2.單引号字元串和轉義引号 3.字元串方法 4.input和raw_input的關系

Python入門基礎第十課--字典 1.前言 2.字典的建立和使用 3.字典方法

清單生成式一、清單生成式介紹二、易錯點

Day08 - 面向對象程式設計基礎

python2.7入門---元組

Python學習（第一站：Python簡史）Python的誕生：Python的發展：Python的意義：應用領域優缺點：

Python為什麼受歡迎Python為什麼受歡迎

python的logging日志子產品

【python學習筆記】Python函數式程式設計

Python基礎：函數傳回值 & return

Python基礎：元組&集合&字典

【資料挖掘】一、統計分析計算一、下載下傳一份用來分析的資料集二、Python中的pandas子產品簡介（資料分析）三、撰寫代碼