Descripteurs magiques en Python

Introduction

Les descripteurs (descripteurs) sont une magie noire profonde mais importante dans le langage Python. Ils sont largement utilisés au cœur du langage Python. La maîtrise des descripteurs aidera Python Ajoute un supplément. astuce pour la boîte à outils du programmeur. Dans cet article, je parlerai de la définition des descripteurs et de quelques scénarios courants, et à la fin de l'article j'ajouterai , __getattr, __getattribute__ ces trois __getitem__méthodes magiques qui aussi impliquent l’accès aux attributs.

Définition du descripteur

descr__get__(self, obj, objtype=None) --> value
descr.__set__(self, obj, value) --> None
descr.__delete__(self, obj) --> None

Tant qu'un

(attribut d'objet) définit l'une des trois méthodes ci-dessus, alors cette classe peut être appelée une classe de descripteur. object attribute

Bases du descripteur

Dans l'exemple suivant, nous créons une classe

et implémentons la méthode RevealAcess. Cette classe peut maintenant être appelée une classe de descripteur. __get__

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))

Attributs de l'instance EX1

Jetons ensuite un œil à la signification de chaque paramètre de la méthode

Dans l'exemple suivant, __get__. est l'instance x de la classe RevealAccess, self est l'instance m de la classe MyClass et obj, comme son nom l'indique, est la classe MyClass elle-même. Comme le montre l'instruction de sortie, le objtype descripteur d'accès m.x appellera la méthode x. __get__

>>> 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 &#39;__main__.MyClass&#39;>

Attribut de classe EX2

Si l'attribut

est accessible directement via la classe, alors la connexion x est directement Aucune, ce qui est plus simple à comprendre, car il n'y a aucune instance de MyClass. obj

>>> MyClass.x
self in RevealAccess: <__main__.RevealAccess object at 0x7f53651070f0>
self: <__main__.RevealAccess object at 0x7f53651070f0>
obj: None
objtype: <class &#39;__main__.MyClass&#39;>

Principe du descripteur

Déclencheur de descripteur

Dans l'exemple ci-dessus, nous avons énuméré l'utilisation des descripteurs du point de vue des attributs d'instance et des attributs de classe respectivement. un examen plus approfondi des principes internes :

• Si vous accédez à

  , la méthode __getattribute__ de l'objet de classe de base est en fait appelée. Dans cette méthode, obj .d est traduit en <.>. 实例属性type(obj).__dict__['d'].__get__(obj, type(obj))

Si vous accédez à
• , cela équivaut à appeler la méthode __getattribute__ de type métaclasse, qui traduit cls.d en

  , ici l'obj de __get__( ) est Aucun car il n'y a pas d'instance. 类属性cls.__dict__['d'].__get__(None, cls)

Parlons brièvement de la méthode magique

Cette méthode sera appelée sans condition lorsque nous accéderons aux propriétés d'un objet. Les détails détaillés sont comme

, __getattribute__. Je ferai un supplément supplémentaire à la fin de l'article, mais nous n'y reviendrons pas pour l'instant. __getattr__getitem__Priorité des descripteurs

Tout d'abord, les descripteurs sont divisés en deux types :

Si un objet définit à la fois la méthode __get__() et __set__() , ce descripteur s'appelle
• .

  data descriptor

Si un objet définit uniquement la méthode __get__(), ce descripteur est appelé
• .

  non-data descriptor

Il existe quatre situations dans lesquelles nous accédons aux attributs :

descripteur de données
instance dict
descripteur de non-données
__getattr__()
leur priorité La taille est :

Qu'est-ce que cela signifie ? C'est-à-dire que si

data descriptor > instance dict > non-data descriptor > __getattr__()

et

avec le même nom apparaissent dans l'objet instance obj, lorsque data descriptor->d accède à l'attribut instance attribute->d, puisque le descripteur de données a une priorité plus élevée, Python appellera obj.d au lieu d'appeler obj.__dict__['d']. Mais si le descripteur n'est pas un descripteur de données, Python appellera d. type(obj).__dict__['d'].__get__(obj, type(obj))obj.__dict__['d']Propriété

Définir une classe de descripteur à chaque fois qu'un descripteur est utilisé semble très fastidieux. Python fournit un moyen concis d'ajouter des descripteurs de données aux propriétés.

fget, fset et fdel sont respectivement les méthodes getter, setter et deleter de la classe. Nous utilisons l'exemple suivant pour illustrer comment utiliser Property :

property(fget=None, fset=None, fdel=None, doc=None) -> property attribute

Si acct est une instance de Account, acct.acct_num appellera le getter, acct.acct_num = value appellera le setter, del acct_num. acct_num delete sera appelé.

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.')

Python fournit également le décorateur

>>> acct = Account()
>>> acct.acct_num = 1000
>>> acct.acct_num
1000

, qui peut être utilisé pour créer des attributs pour des scénarios d'application simples. Un objet de propriété possède des méthodes de décorateur getter, setter et delete, qui peuvent être utilisées pour créer des copies de la propriété via les fonctions d'accès des fonctions décorées correspondantes.

@property

Si vous souhaitez que la propriété soit en lecture seule, supprimez simplement la méthode setter.

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

Créer des descripteurs au moment de l'exécution

Nous pouvons ajouter des propriétés au moment de l'exécution :

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)

Méthodes statiques et méthodes de classe

>>> 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'}

Nous pouvons utiliser des descripteurs pour simuler l'implémentation de

et

en Python. Parcourons d’abord le tableau ci-dessous : @staticmethod

Transformation	Called from an Object	Called from a Class
function	f(obj, *args)	f(*args)
staticmethod	f(*args)	f(*args)
classmethod	f(type(obj), *args)	f(klass, *args)

静态方法

对于静态方法f。c.f和C.f是等价的，都是直接查询object.__getattribute__(c, ‘f’)或者object.__getattribute__(C, ’f‘)。静态方法一个明显的特征就是没有self变量。

静态方法有什么用呢？假设有一个处理专门数据的容器类，它提供了一些方法来求平均数，中位数等统计数据方式，这些方法都是要依赖于相应的数据的。但是类中可能还有一些方法，并不依赖这些数据，这个时候我们可以将这些方法声明为静态方法，同时这也可以提高代码的可读性。

使用非数据描述符来模拟一下静态方法的实现：

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的@classmethod和@staticmethod的用法有些类似，但是还是有些不同，当某些方法只需要得到类的引用而不关心类中的相应的数据的时候就需要使用classmethod了。

使用非数据描述符来模拟一下类方法的实现：

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魔术方法的时候，我也被__get__, __getattribute__, __getattr__, __getitem__之间的区别困扰到了，它们都是和属性访问相关的魔术方法，其中重写__getattr__，__getitem__来构造一个自己的集合类非常的常用，下面我们就通过一些例子来看一下它们的应用。

__getattr__

Python默认访问类/实例的某个属性都是通过__getattribute__来调用的，__getattribute__会被无条件调用，没有找到的话就会调用__getattr__。如果我们要定制某个类，通常情况下我们不应该重写__getattribute__，而是应该重写__getattr__，很少看见重写__getattribute__的情况。

从下面的输出可以看出，当一个属性通过__getattribute__无法找到的时候会调用__getattr__。

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只支持以obj['foo']形式来访问，不支持obj.foo的形式，我们可以通过重写__getattr__让字典也支持obj['foo']的访问形式，这是一个非常经典常用的用法：

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 &#39;<Storage &#39; + dict.__repr__(self) + &#39;>&#39;

我们来使用一下我们自定义的加强版字典：

>>> 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用于通过下标[]的形式来获取对象中的元素，下面我们通过重写__getitem__来实现一个自己的list。

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库中对于__getitem__的一个使用，我们定制了一个忽略属性大小写的字典类。

程序有些复杂，我稍微解释一下：由于这里比较简单，没有使用描述符的需求，所以使用了@property装饰器来代替，lower_keys的功能是将实例字典中的键全部转换成小写并且存储在字典self._lower_keys中。重写了__getitem__方法，以后我们访问某个属性首先会将键转换为小写的方式，然后并不会直接访问实例字典，而是会访问字典self._lower_keys去查找。赋值/删除操作的时候由于实例字典会进行变更，为了保持self._lower_keys和实例字典同步，首先清除self._lower_keys的内容，以后我们重新查找键的时候再调用__getitem__的时候会重新新建一个self._lower_keys。

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!