Heim  >  Artikel  >  Backend-Entwicklung  >  Magische Deskriptoren in Python

Magische Deskriptoren in Python

巴扎黑
巴扎黑Original
2017-03-18 11:36:071393Durchsuche

Einführung

Deskriptoren (Deskriptoren) sind eine tiefgreifende, aber wichtige schwarze Magie in der Python-Sprache. Sie werden häufig im Kern der Python-Sprache verwendet. Die Beherrschung von Deskriptoren hilft Python. Fügt ein Extra hinzu Trick für den Werkzeugkasten des Programmierers. In diesem Artikel werde ich über die Definition von Deskriptoren und einige gängige Szenarien sprechen und am Ende des Artikels werde ich , __getattr, __getattribute__ diese drei __getitem__magischen Methoden hinzufügen beinhalten den Attributzugriff.

Deskriptordefinition

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

(Objektattribut) eine der oben genannten drei Methoden definiert, kann diese Klasse als Deskriptorklasse bezeichnet werden. object attribute

Deskriptor-Grundlagen

Im folgenden Beispiel erstellen wir eine

-Klasse und implementieren die RevealAcess-Methode. Jetzt kann diese Klasse als Deskriptorklasse bezeichnet werden. __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))

EX1-Instanzattribute

Als nächstes werfen wir einen Blick auf die Bedeutung der einzelnen Parameter der

-Methode, __get__ ist die Instanz x der RevealAccess-Klasse, self ist die Instanz m der MyClass-Klasse und obj ist, wie der Name schon sagt, die MyClass-Klasse selbst. Wie aus der Ausgabeanweisung ersichtlich ist, ruft der objtype-Zugriffsdeskriptor m.x die x-Methode auf. __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;>

EX2-Klassenattribut

Wenn auf das Attribut

direkt über die Klasse zugegriffen wird, ist die x-Verbindung direkt None, was einfacher ist zu verstehen, weil Es gibt keine Instanz von 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;>
Prinzip des Deskriptors

Deskriptor-Trigger

Im obigen Beispiel haben wir die Verwendung von Deskriptoren aus der Perspektive von Instanzattributen bzw. Klassenattributen aufgezählt Schauen Sie sich die internen Prinzipien genauer an:

  • Wenn Sie auf

    zugreifen, wird tatsächlich die Methode __getattribute__ des Basisklassenobjekts aufgerufen. In dieser Methode wird obj .d in . 实例属性type(obj).__dict__['d'].__get__(obj, type(obj))

  • Wenn Sie auf
  • zugreifen, entspricht dies dem Aufruf der __getattribute__-Methode des Metaklassentyps, die cls.d in

    übersetzt, hier ist das Objekt von __get__( ). Keine, weil es keine Instanz gibt. 类属性cls.__dict__['d'].__get__(None, cls)

  • Lassen Sie uns kurz über die
magische Methode sprechen. Diese Methode wird bedingungslos aufgerufen, wenn wir auf die Eigenschaften eines Objekts zugreifen. Die detaillierten Details sind wie

, __getattribute__ Ich werde am Ende des Artikels eine zusätzliche Ergänzung machen, aber wir werden uns vorerst nicht näher damit befassen. __getattr__getitem__Deskriptorpriorität

Zunächst werden Deskriptoren in zwei Typen unterteilt:

    Wenn ein Objekt sowohl die Methode __get__() als auch die Methode __set__() definiert , dieser Deskriptor heißt
  • .

    data descriptor

  • Wenn ein Objekt nur die Methode __get__() definiert, heißt dieser Deskriptor
  • .

    non-data descriptor

  • Es gibt vier Situationen, in denen wir auf Attribute zugreifen:

    Datendeskriptor
  • Instanzdikt
  • Nicht-Daten-Deskriptor
  • __getattr__()
  • ihre Priorität Die Größe ist:

Was bedeutet das? Das heißt, wenn
data descriptor > instance dict > non-data descriptor > __getattr__()
und

mit demselben Namen im Instanzobjekt obj erscheinen und data descriptor->d auf das Attribut instance attribute->d zugreift, ruft Python obj.d auf, da der Datendeskriptor eine höhere Priorität hat Stattdessen wird obj.__dict__['d'] aufgerufen. Wenn der Deskriptor jedoch kein Datendeskriptor ist, ruft Python d auf. type(obj).__dict__['d'].__get__(obj, type(obj))obj.__dict__['d']Eigenschaft

Es erscheint sehr umständlich, bei jeder Verwendung eines Deskriptors eine Deskriptorklasse zu definieren. Python bietet eine übersichtliche Möglichkeit, Datendeskriptoren zu Eigenschaften hinzuzufügen.

fget, fset und fdel sind die Getter-, Setter- und Deleter-Methoden der Klasse. Wir verwenden das folgende Beispiel, um die Verwendung von Property zu veranschaulichen:
property(fget=None, fset=None, fdel=None, doc=None) -> property attribute

Wenn acct eine Instanz von Account ist, ruft acct.acct_num den Getter auf, acct.acct_num = value ruft den Setter auf, del acct_num. acct_num delete wird aufgerufen.
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, &#39;_acct_num property.&#39;)

Python stellt außerdem den
>>> acct = Account()
>>> acct.acct_num = 1000
>>> acct.acct_num
1000
Decorator zur Verfügung, mit dem Attribute für einfache Anwendungsszenarien erstellt werden können. Ein Eigenschaftsobjekt verfügt über Getter-, Setter- und Lösch-Dekoratormethoden, mit denen über die Zugriffsfunktionen der entsprechenden dekorierten Funktionen Kopien der Eigenschaft erstellt werden können.

@property

Wenn Sie möchten, dass die Eigenschaft schreibgeschützt ist, entfernen Sie einfach die Setter-Methode.
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

Deskriptoren zur Laufzeit erstellen

Wir können Eigenschaften zur Laufzeit hinzufügen:

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, &#39;_&#39; + attribute, value.title())
    def _getProperty(self, attribute):
        print("Getting: {}".format(attribute))
        return getattr(self, &#39;_&#39; + attribute)
Statische Methoden und Klassenmethoden
>>> user = Person()
>>> user.addProperty(&#39;name&#39;)
>>> user.addProperty(&#39;phone&#39;)
>>> user.name = &#39;john smith&#39;
Setting: name = john smith
>>> user.phone = &#39;12345&#39;
Setting: phone = 12345
>>> user.name
Getting: name
&#39;John Smith&#39;
>>> user.__dict__
{&#39;_phone&#39;: &#39;12345&#39;, &#39;_name&#39;: &#39;John Smith&#39;}

Wir können Deskriptoren verwenden um die Implementierung von

und

in Python zu simulieren. Schauen wir uns zunächst die folgende Tabelle an: @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)

静态方法

对于静态方法fc.fC.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(&#39;call __getattribute__&#39;)
    ...:         return super(Test, self).__getattribute__(item)
    ...:     def __getattr__(self, item):
    ...:         return &#39;call __getattr__&#39;
    ...:
In [2]: Test().a
call __getattribute__
Out[2]: &#39;call __getattr__&#39;

应用

对于默认的字典,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[&#39;foo&#39;]`.
    """
    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[&#39;a&#39;]
1
>>> s.a
1
>>> s.a = 2
>>> s[&#39;a&#39;]
2
>>> del s.a
>>> s.a
...
AttributeError: &#39;a&#39;

__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, &#39;_lower_keys&#39;) 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, &#39;_lower_keys&#39;):
            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[&#39;ziwenxie&#39;] = &#39;ziwenxie&#39;
>>> d[&#39;ZiWenXie&#39;] = &#39;ZiWenXie&#39;
>>> print(d)
{&#39;ZiWenXie&#39;: &#39;ziwenxie&#39;, &#39;ziwenxie&#39;: &#39;ziwenxie&#39;}
>>> print(d[&#39;ziwenxie&#39;])
ziwenxie
# d[&#39;ZiWenXie&#39;] => d[&#39;ziwenxie&#39;]
>>> print(d[&#39;ZiWenXie&#39;])
ziwenxie

Das obige ist der detaillierte Inhalt vonMagische Deskriptoren in Python. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn