Python 使用@property對屬性進行數據規(guī)范性校驗的實現

更新時間：2021年10月20日 10:23:18 作者：a772304419

本文主要介紹了Python 使用@property對屬性進行數據規(guī)范性校驗的實現，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

在綁定屬性時，如果我們直接把屬性暴露出去，雖然寫起來很簡單，但是，沒辦法檢查參數，導致可以把成績隨便改：

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）可以給函數動態(tài)加上功能嗎？對于類的方法，裝飾器一樣起作用。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本身又創(chuàng)建了另一個裝飾器@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時，首先轉換為方法調用，在執(zhí)行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

到此這篇關于Python 使用@property對屬性進行數據規(guī)范性校驗的實現的文章就介紹到這了,更多相關Python @property 屬性校驗內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: