你也許經常會聽到“描述符”這個概念,但是由於大多數的程式設計師很少會使用到他,所以可能你並不太清楚了解它的原理,python視頻教學專欄將詳細介紹
推薦(免費):python影片教學
但是如果你想自己的事業來說更上一層的話,對於python的使用更加熟練的話,我認為你還是應該對描述符
的這個概念有一個清晰的了解,這對於你以後的發展有著巨大的幫助,也有利於你將來更深層的python設計的理解。
儘管在開發的過程中,我們沒有直接的使用過描述符,但是它在底層的運用卻是十分頻繁的存在。例如下面的這些:
function
、bound method
、unbound method
、
staticmethod 、
classmethod
這些是不是都很熟悉? 什麼是描述符?
在我們了解什麼是描述符前,我們可以先找一個例子來看class A: x = 10print(A.x) # 10
A中定義一個
類別屬性x,然後得到它的值。
除了這個直接定義類別屬性的方法外,我們還可以這樣去定義一個類別屬性:
class Ten: def __get__(self, obj, objtype=None): return 10class A: x = Ten() # 属性换成了一个类print(A.x) # 10
x不是一個具體的值了,而是一個類別
Ten,透過這個
Ten定義了一個
__get__方法,傳回具體的值。
我們可以把一個類別的屬性,託管給一個類,而這樣的屬性就是一個描述符簡而言之,
描述子是一個
綁定行為屬性
回想,我們在開發時,一般情況下,會叫
行為什麼?
行為即一個方法。
描述子理解為:
物件的屬性並非一個具體的值,而是交給了一個方法去定義。
class Age: def __get__(self, obj, objtype=None): if obj.name == 'zhangsan': return 20 elif obj.name == 'lisi': return 25 else: return ValueError("unknow")class Person: age = Age() def __init__(self, name): self.name = name p1 = Person('zhangsan')print(p1.age) # 20p2 = Person('lisi')print(p2.age) # 25p3 = Person('wangwu')print(p3.age) # unknow
age 類別屬性被另一個類別託管了,在這個類別的
__get__# 中,它會根據
Person 類別的屬性
name,決定
age 是什麼值。
描述子協定
了解了描述子的定義,現在我們把重點放到託管屬性的類別上。 其實,一個類別屬性想要託管給一個類,這個類別內部實作的方法不能是隨便定義的,它必須遵守「描述子協定」,也就是要實作以下幾個方法:
其中一個,那麼這個類別屬性就可以稱為描述符。
另外,描述子又可以分成「資料描述子」與「非資料描述子」:,叫做非數據描述子
之外,還定義了
__set__ 或
__delete__,叫做資料描述子
__get__ 和
__set__ 方法的描述子範例:
# coding: utf8class Age: def __init__(self, value=20): self.value = value def __get__(self, obj, type=None): print('call __get__: obj: %s type: %s' % (obj, type)) return self.value def __set__(self, obj, value): if value <= 0: raise ValueError("age must be greater than 0") print('call __set__: obj: %s value: %s' % (obj, value)) self.value = valueclass Person: age = Age() def __init__(self, name): self.name = name p1 = Person('zhangsan')print(p1.age)# call __get__: obj: <__main__.Person object at 0x1055509e8> type: <class '__main__.Person'># 20print(Person.age)# call __get__: obj: None type: <class '__main__.Person'># 20p1.age = 25# call __set__: obj: <__main__.Person object at 0x1055509e8> value: 25print(p1.age)# call __get__: obj: <__main__.Person object at 0x1055509e8> type: <class '__main__.Person'># 25p1.age = -1# ValueError: age must be greater than 0
age 是一個描述符,它的值取決於
Age 類別。
age 屬性時,呼叫了
Age 的
__get__ 和
__set__ 方法:
p1.age
时,__get__
被调用,参数 obj
是 Person
实例,type
是 type(Person)
Person.age
时,__get__
被调用,参数 obj
是 None
,type
是 type(Person)
p1.age = 25
时,__set__
被调用,参数 obj
是 Person
实例,value
是25p1.age = -1
时,__set__
没有通过校验,抛出 ValueError
其中,调用 __set__
传入的参数,我们比较容易理解,但是对于 __get__
方法,通过类或实例调用,传入的参数是不同的,这是为什么?
这就需要我们了解一下描述符的工作原理。
描述符的工作原理
要解释描述符的工作原理,首先我们需要先从属性的访问说起。
在开发时,不知道你有没有想过这样一个问题:通常我们写这样的代码 a.b
,其背后到底发生了什么?
这里的 a
和 b
可能存在以下情况:
a
可能是一个类,也可能是一个实例,我们这里统称为对象b
可能是一个属性,也可能是一个方法,方法其实也可以看做是类的属性其实,无论是以上哪种情况,在 Python 中,都有一个统一的调用逻辑:
__getattribute__
尝试获得结果__getattr__
用代码表示就是下面这样:
def getattr_hook(obj, name): try: return obj.__getattribute__(name) except AttributeError: if not hasattr(type(obj), '__getattr__'): raise return type(obj).__getattr__(obj, name)
我们这里需要重点关注一下 __getattribute__
,因为它是所有属性查找的入口,它内部实现的属性查找顺序是这样的:
__get__
__dict__
中查找__dict__
中查找不到,再看它是否是一个非数据描述符__get__
AttributeError
异常写成代码就是下面这样:
# 获取一个对象的属性 def __getattribute__(obj, name): null = object() # 对象的类型 也就是实例的类 objtype = type(obj) # 从这个类中获取指定属性 cls_var = getattr(objtype, name, null) # 如果这个类实现了描述符协议 descr_get = getattr(type(cls_var), '__get__', null) if descr_get is not null: if (hasattr(type(cls_var), '__set__') or hasattr(type(cls_var), '__delete__')): # 优先从数据描述符中获取属性 return descr_get(cls_var, obj, objtype) # 从实例中获取属性 if hasattr(obj, '__dict__') and name in vars(obj): return vars(obj)[name] # 从非数据描述符获取属性 if descr_get is not null: return descr_get(cls_var, obj, objtype) # 从类中获取属性 if cls_var is not null: return cls_var # 抛出 AttributeError 会触发调用 __getattr__ raise AttributeError(name)
如果不好理解,你最好写一个程序测试一下,观察各种情况下的属性的查找顺序。
到这里我们可以看到,在一个对象中查找一个属性,都是先从 __getattribute__
开始的。
在 __getattribute__
中,它会检查这个类属性是否是一个描述符,如果是一个描述符,那么就会调用它的 __get__
方法。但具体的调用细节和传入的参数是下面这样的:
a
是一个实例,调用细节为:type(a).__dict__['b'].__get__(a, type(a))复制代码
a
是一个类,调用细节为:a.__dict__['b'].__get__(None, a)复制代码
所以我们就能看到上面例子输出的结果。
数据描述符和非数据描述符
了解了描述符的工作原理,我们继续来看数据描述符和非数据描述符的区别。
从定义上来看,它们的区别是:
__get___
,叫做非数据描述符__get__
之外,还定义了 __set__
或 __delete__
,叫做数据描述符此外,我们从上面描述符调用的顺序可以看到,在对象中查找属性时,数据描述符要优先于非数据描述符调用。
在之前的例子中,我们定义了 __get__
和 __set__
,所以那些类属性都是数据描述符。
我们再来看一个非数据描述符的例子:
class A: def __init__(self): self.foo = 'abc' def foo(self): return 'xyz'print(A().foo) # 输出什么? 复制代码
这段代码,我们定义了一个相同名字的属性和方法 foo
,如果现在执行 A().foo
,你觉得会输出什么结果?
答案是 abc
。
为什么打印的是实例属性 foo
的值,而不是方法 foo
呢?
这就和非数据描述符有关系了。
我们执行 dir(A.foo)
,观察结果:
print(dir(A.foo))# [... '__get__', '__getattribute__', ...]复制代码
看到了吗?A
的 foo
方法其实实现了 __get__
,我们在上面的分析已经得知:只定义 __get__
方法的对象,它其实是一个非数据描述符,也就是说,我们在类中定义的方法,其实本身就是一个非数据描述符。
所以,在一个类中,如果存在相同名字的属性和方法,按照上面所讲的 __getattribute__
中查找属性的顺序,这个属性就会优先从实例中获取,如果实例中不存在,才会从非数据描述符中获取,所以在这里优先查找的是实例属性 foo
的值。
到这里我们可以总结一下关于描述符的相关知识点:
__getattribute__
是查找一个属性(方法)的入口__getattribute__
定义了一个属性(方法)的查找顺序:数据描述符、实例属性、非数据描述符、类属性__getattribute__
方法,会阻止描述符的调用__get__
描述符的使用场景
了解了描述符的工作原理,那描述符一般用在哪些业务场景中呢?
在这里我用描述符实现了一个属性校验器,你可以参考这个例子,在类似的场景中去使用它。
首先我们定义一个校验基类 Validator
,在 __set__
方法中先调用 validate
方法校验属性是否符合要求,然后再对属性进行赋值。
class Validator: def __init__(self): self.data = {} def __get__(self, obj, objtype=None): return self.data[obj] def __set__(self, obj, value): # 校验通过后再赋值 self.validate(value) self.data[obj] = value def validate(self, value): pass 复制代码
接下来,我们定义两个校验类,继承 Validator
,然后实现自己的校验逻辑。
class Number(Validator): def __init__(self, minvalue=None, maxvalue=None): super(Number, self).__init__() self.minvalue = minvalue self.maxvalue = maxvalue def validate(self, value): if not isinstance(value, (int, float)): raise TypeError(f'Expected {value!r} to be an int or float') if self.minvalue is not None and value < self.minvalue: raise ValueError( f'Expected {value!r} to be at least {self.minvalue!r}' ) if self.maxvalue is not None and value > self.maxvalue: raise ValueError( f'Expected {value!r} to be no more than {self.maxvalue!r}' )class String(Validator): def __init__(self, minsize=None, maxsize=None): super(String, self).__init__() self.minsize = minsize self.maxsize = maxsize def validate(self, value): if not isinstance(value, str): raise TypeError(f'Expected {value!r} to be an str') if self.minsize is not None and len(value) < self.minsize: raise ValueError( f'Expected {value!r} to be no smaller than {self.minsize!r}' ) if self.maxsize is not None and len(value) > self.maxsize: raise ValueError( f'Expected {value!r} to be no bigger than {self.maxsize!r}' )复制代码
最后,我们使用这个校验类:
class Person: # 定义属性的校验规则 内部用描述符实现 name = String(minsize=3, maxsize=10) age = Number(minvalue=1, maxvalue=120) def __init__(self, name, age): self.name = name self.age = age # 属性符合规则 p1 = Person('zhangsan', 20)print(p1.name, p1.age)# 属性不符合规则 p2 = person('a', 20)# ValueError: Expected 'a' to be no smaller than 3p3 = Person('zhangsan', -1)# ValueError: Expected -1 to be at least 1复制代码
现在,当我们对 Person
实例进行初始化时,就可以校验这些属性是否符合预定义的规则了。
function与method
我们再来看一下,在开发时经常看到的 function
、unbound method
、bound method
它们之间到底有什么区别?
来看下面这段代码:
class A: def foo(self): return 'xyz'print(A.__dict__['foo']) # <function foo at 0x10a790d70>print(A.foo) # <unbound method A.foo>print(A().foo) # <bound method A.foo of <__main__.A object at 0x10a793050>>复制代码
从结果我们可以看出它们的区别:
function
准确来说就是一个函数,并且它实现了 __get__
方法,因此每一个 function
都是一个非数据描述符,而在类中会把 function
放到 __dict__
中存储function
被实例调用时,它是一个 bound method
function
被类调用时, 它是一个 unbound method
function
是一个非数据描述符,我们之前已经讲到了。
而 bound method
和 unbound method
的区别就在于调用方的类型是什么,如果是一个实例,那么这个 function
就是一个 bound method
,否则它是一个 unbound method
。
property/staticmethod/classmethod
我们再来看 property
、staticmethod
、classmethod
。
这些装饰器的实现,默认是 C 来实现的。
其实,我们也可以直接利用 Python 描述符的特性来实现这些装饰器,
property
的 Python 版实现:
class property: def __init__(self, fget=None, fset=None, fdel=None, doc=None): self.fget = fget self.fset = fset self.fdel = fdel self.__doc__ = doc def __get__(self, obj, objtype=None): if obj is None: return self.fget if self.fget is None: raise AttributeError(), "unreadable attribute" return self.fget(obj) def __set__(self, obj, value): if self.fset is None: raise AttributeError, "can't set attribute" return self.fset(obj, value) def __delete__(self, obj): if self.fdel is None: raise AttributeError, "can't delete attribute" return self.fdel(obj) def getter(self, fget): return type(self)(fget, self.fset, self.fdel, self.__doc__) def setter(self, fset): return type(self)(self.fget, fset, self.fdel, self.__doc__) def deleter(self, fdel): return type(self)(self.fget, self.fset, fdel, self.__doc__)复制代码
staticmethod
的 Python 版实现:
class staticmethod: def __init__(self, func): self.func = func def __get__(self, obj, objtype=None): return self.func 复制代码
classmethod
的 Python 版实现:
class classmethod: def __init__(self, func): self.func = func def __get__(self, obj, klass=None): if klass is None: klass = type(obj) def newfunc(*args): return self.func(klass, *args) return newfunc 复制代码
除此之外,你还可以实现其他功能强大的装饰器。
由此可见,通过描述符我们可以实现强大而灵活的属性管理功能,对于一些要求属性控制比较复杂的场景,我们可以选择用描述符来实现。
总结
这篇文章我们主要讲了 Python 描述符的工作原理。
首先,我们从一个简单的例子了解到,一个类属性是可以托管给另外一个类的,这个类如果实现了描述符协议方法,那么这个类属性就是一个描述符。此外,描述符又可以分为数据描述符和非数据描述符。
之后我们又分析了获取一个属性的过程,一切的入口都在 __getattribute__
中,这个方法定义了寻找属性的顺序,其中实例属性优先于数据描述符调用,数据描述符要优先于非数据描述符调用。
另外我們又了解到,方法其實就是一個非資料描述符,如果我們在類別中定義了相同名字的實例屬性和方法,按照__getattribute__
中的屬性查找順序,實例屬性優先訪問。
最後我們分析了function
和method
的區別,以及使用Python 描述子也可以實作property
、staticmethod
、classmethod
裝飾器。
Python 描述子提供了強大的屬性存取控制功能,我們可以在需要對屬性進行複雜控制的場景中去使用它。
本作品採用《CC 協議》,轉載必須註明作者與本文連結
以上是介紹python描述子的意義的詳細內容。更多資訊請關注PHP中文網其他相關文章!