引言Descriptors(描述符)是Python语言中一个深奥但很重要的一个黑魔法,它被广泛应用于Python语言的内核,熟练掌握描述符将会为Python程序员的工具箱添加一个额外的技巧。本文我将讲述描述符的定义以及一些常见的场景,并且在文末会补充一下 描述符的定义descr__get__(self, obj, objtype=None) --> value
descr.__set__(self, obj, value) --> None
descr.__delete__(self, obj) --> None
只要一个 描述符基础下面这个例子中我们创建了一个 class RevealAccess(object):
def __get__(self, obj, objtype):
print('self in RevealAccess: {}'.format(self))
print('self: {}\nobj: {}\nobjtype: {}'.format(self, obj, objtype))
class MyClass(object):
x = RevealAccess()
def test(self):
print('self in MyClass: {}'.format(self))
EX1实例属性 接下来我们来看一下 >>> m = MyClass()
>>> m.test()
self in MyClass: <__main__.MyClass object at 0x7f19d4e42160>
>>> m.x
self in RevealAccess: <__main__.RevealAccess object at 0x7f19d4e420f0>
self: <__main__.RevealAccess object at 0x7f19d4e420f0>
obj: <__main__.MyClass object at 0x7f19d4e42160>
objtype: <class '__main__.MyClass'>
EX2类属性 如果通过类直接访问属性 >>> MyClass.x
self in RevealAccess: <__main__.RevealAccess object at 0x7f53651070f0>
self: <__main__.RevealAccess object at 0x7f53651070f0>
obj: None
objtype: <class '__main__.MyClass'>
描述符的原理描述符触发上面这个例子中,我们分别从实例属性和类属性的角度列举了描述符的用法,下面我们来仔细分析一下内部的原理:
简单讲一下 描述符优先级首先,描述符分为两种:
我们对属性进行访问的时候存在下面四种情况:
它们的优先级大小是: data descriptor > instance dict > non-data descriptor > __getattr__()
这是什么意思呢?就是说如果实例对象obj中出现了同名的 Property每次使用描述符的时候都定义一个描述符类,这样看起来非常繁琐。Python提供了一种简洁的方式用来向属性添加数据描述符。 property(fget=None, fset=None, fdel=None, doc=None) -> property attribute
fget、fset和fdel分别是类的getter、setter和deleter方法。我们通过下面的一个示例来说明如何使用Property: class Account(object):
def __init__(self):
self._acct_num = None
def get_acct_num(self):
return self._acct_num
def set_acct_num(self, value):
self._acct_num = value
def del_acct_num(self):
del self._acct_num
acct_num = property(get_acct_num, set_acct_num, del_acct_num, '_acct_num property.')
如果acct是Account的一个实例,acct.acct_num将会调用getter,acct.acct_num = value将调用setter,del acct_num.acct_num将调用deleter。 >>> acct = Account()
>>> acct.acct_num = 1000
>>> acct.acct_num
1000
Python也提供了 class Account(object):
def __init__(self):
self._acct_num = None
@property
# the _acct_num property. the decorator creates a read-only property
def acct_num(self):
return self._acct_num
@acct_num.setter
# the _acct_num property setter makes the property writeable
def set_acct_num(self, value):
self._acct_num = value
@acct_num.deleter
def del_acct_num(self):
del self._acct_num
如果想让属性只读,只需要去掉setter方法。 在运行时创建描述符我们可以在运行时添加property属性: class Person(object):
def addProperty(self, attribute):
# create local setter and getter with a particular attribute name
getter = lambda self: self._getProperty(attribute)
setter = lambda self, value: self._setProperty(attribute, value)
# construct property attribute and add it to the class
setattr(self.__class__, attribute, property(fget=getter, fset=setter, doc='Auto-generated method'))
def _setProperty(self, attribute, value):
print('Setting: {} = {}'.format(attribute, value))
setattr(self, '_' attribute, value.title())
def _getProperty(self, attribute):
print('Getting: {}'.format(attribute))
return getattr(self, '_' attribute)
>>> user = Person()
>>> user.addProperty('name')
>>> user.addProperty('phone')
>>> user.name = 'john smith'
Setting: name = john smith
>>> user.phone = '12345'
Setting: phone = 12345
>>> user.name
Getting: name
'John Smith'
>>> user.__dict__
{'_phone': '12345', '_name': 'John Smith'}
静态方法和类方法我们可以使用描述符来模拟Python中的
静态方法对于静态方法 静态方法有什么用呢?假设有一个处理专门数据的容器类,它提供了一些方法来求平均数,中位数等统计数据方式,这些方法都是要依赖于相应的数据的。但是类中可能还有一些方法,并不依赖这些数据,这个时候我们可以将这些方法声明为静态方法,同时这也可以提高代码的可读性。 使用非数据描述符来模拟一下静态方法的实现: class StaticMethod(object):
def __init__(self, f):
self.f = f
def __get__(self, obj, objtype=None):
return self.f
我们来应用一下: class MyClass(object):
@StaticMethod
def get_x(x):
return x
print(MyClass.get_x(100)) # output: 100
类方法Python的 使用非数据描述符来模拟一下类方法的实现: class ClassMethod(object):
def __init__(self, f):
self.f = f
def __get__(self, obj, klass=None):
if klass is None:
klass = type(obj)
def newfunc(*args):
return self.f(klass, *args)
return newfunc
其他的魔术方法首次接触Python魔术方法的时候,我也被 __getattr__Python默认访问类/实例的某个属性都是通过 从下面的输出可以看出,当一个属性通过 In [1]: class Test(object):
...: def __getattribute__(self, item):
...: print('call __getattribute__')
...: return super(Test, self).__getattribute__(item)
...: def __getattr__(self, item):
...: return 'call __getattr__'
...:
In [2]: Test().a
call __getattribute__
Out[2]: 'call __getattr__'
应用对于默认的字典,Python只支持以 class Storage(dict):
''' A Storage object is like a dictionary except `obj.foo` can be used in addition to `obj['foo']`. '''
def __getattr__(self, key):
try:
return self[key]
except KeyError as k:
raise AttributeError(k)
def __setattr__(self, key, value):
self[key] = value
def __delattr__(self, key):
try:
del self[key]
except KeyError as k:
raise AttributeError(k)
def __repr__(self):
return '<Storage ' dict.__repr__(self) '>'
我们来使用一下我们自定义的加强版字典: >>> s = Storage(a=1)
>>> s['a']
1
>>> s.a
1
>>> s.a = 2
>>> s['a']
2
>>> del s.a
>>> s.a
...
AttributeError: 'a'
__getitem__getitem用于通过下标 class MyList(object):
def __init__(self, *args):
self.numbers = args
def __getitem__(self, item):
return self.numbers[item]
my_list = MyList(1, 2, 3, 4, 6, 5, 3)
print my_list[2]
这个实现非常的简陋,不支持slice和step等功能,请读者自行改进,这里我就不重复了。 应用下面是参考requests库中对于 程序有些复杂,我稍微解释一下:由于这里比较简单,没有使用描述符的需求,所以使用了 class CaseInsensitiveDict(dict):
@property
def lower_keys(self):
if not hasattr(self, '_lower_keys') or not self._lower_keys:
self._lower_keys = dict((k.lower(), k) for k in self.keys())
return self._lower_keys
def _clear_lower_keys(self):
if hasattr(self, '_lower_keys'):
self._lower_keys.clear()
def __contains__(self, key):
return key.lower() in self.lower_keys
def __getitem__(self, key):
if key in self:
return dict.__getitem__(self, self.lower_keys[key.lower()])
def __setitem__(self, key, value):
dict.__setitem__(self, key, value)
self._clear_lower_keys()
def __delitem__(self, key):
dict.__delitem__(self, key)
self._lower_keys.clear()
def get(self, key, default=None):
if key in self:
return self[key]
else:
return default
我们来调用一下这个类: >>> d = CaseInsensitiveDict()
>>> d['ziwenxie'] = 'ziwenxie'
>>> d['ZiWenXie'] = 'ZiWenXie'
>>> print(d)
{'ZiWenXie': 'ziwenxie', 'ziwenxie': 'ziwenxie'}
>>> print(d['ziwenxie'])
ziwenxie
# d['ZiWenXie'] => d['ziwenxie']
>>> print(d['ZiWenXie'])
ziwenxie 【责任编辑:seeker TEL:(010)68476606】
|
|