Руководство по описателям

Простой пример: Дескриптор, возвращающий константу

Класс Ten — это дескриптор, метод которого __get__() всегда возвращает константу 10:

class Ten:
    def __get__(self, obj, objtype=None):
        return 10

Для использования дескриптора, он должен храниться как переменная класса в другом классе:

class A:
    x = 5                       # Regular class attribute
    y = Ten()                   # Descriptor instance

В интерактивной сессии показаны различия между обычным поиском атрибута и поиском атрибута с помощью дескриптора:

>>> a = A()                     # Make an instance of class A
>>> a.x                         # Normal attribute lookup
5
>>> a.y                         # Descriptor lookup
10

При поиске атрибута a.x, оператор точки находит 'x': 5 в словаре класса. При поиске атрибута a.y, оператор точки находит экземпляр дескриптора, распознаваемый по его методу __get__. Вызов этого метода возвращает 10.

Обратите внимание, что значение 10 не хранится ни в словаре класса, ни в словаре экземпляра. Вместо этого значение 10 вычисляется по требованию.

Этот пример демонстрирует работу простого дескриптора, но он не очень полезен. Для получения констант обычный поиск атрибутов был бы предпочтительнее.

В следующем разделе мы создадим нечто более полезное — динамический поиск.

Динамические запросы

Интересные дескрипторы обычно выполняют вычисления вместо возвращения констант:

import os

class DirectorySize:

    def __get__(self, obj, objtype=None):
        return len(os.listdir(obj.dirname))

class Directory:

    size = DirectorySize()              # Descriptor instance

    def __init__(self, dirname):
        self.dirname = dirname          # Regular instance attribute

В интерактивной сессии показано, что поиск является динамическим — он вычисляет разные, обновленные ответы каждый раз:

>>> s = Directory('songs')
>>> g = Directory('games')
>>> s.size                              # The songs directory has twenty files
20
>>> g.size                              # The games directory has three files
3
>>> os.remove('games/chess')            # Delete a game
>>> g.size                              # File count is automatically updated
2

Помимо демонстрации того, как дескрипторы могут выполнять вычисления, этот пример также раскрывает назначение параметров метода __get__(). Параметр self — это size, экземпляр DirectorySize. Параметр obj — это g или s, экземпляр Directory. Именно параметр obj позволяет методу __get__() узнать целевой каталог. Параметр objtype — это класс Directory.

Управляемые атрибуты

Популярное применение дескрипторов — управление доступом к данным экземпляра. Дескриптор назначается общедоступному атрибуту в словаре класса, в то время как фактические данные хранятся как закрытый атрибут в словаре экземпляра. Методы дескриптора __get__() и __set__() вызываются при обращении к общедоступному атрибуту.

В следующем примере age — это общедоступный атрибут, а _age — закрытый атрибут. При обращении к общедоступному атрибуту дескриптор регистрирует запрос или обновление:

import logging

logging.basicConfig(level=logging.INFO)

class LoggedAgeAccess:

    def __get__(self, obj, objtype=None):
        value = obj._age
        logging.info('Accessing %r giving %r', 'age', value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', 'age', value)
        obj._age = value

class Person:

    age = LoggedAgeAccess()             # Descriptor instance

    def __init__(self, name, age):
        self.name = name                # Regular instance attribute
        self.age = age                  # Calls __set__()

    def birthday(self):
        self.age += 1                   # Calls both __get__() and __set__()

В интерактивной сессии показано, что все обращения к управляемому атрибуту age регистрируются, но регулярный атрибут name не регистрируется:

>>> mary = Person('Mary M', 30)         # The initial age update is logged
INFO:root:Updating 'age' to 30
>>> dave = Person('David D', 40)
INFO:root:Updating 'age' to 40

>>> vars(mary)                          # The actual data is in a private attribute
{'name': 'Mary M', '_age': 30}
>>> vars(dave)
{'name': 'David D', '_age': 40}

>>> mary.age                            # Access the data and log the lookup
INFO:root:Accessing 'age' giving 30
30
>>> mary.birthday()                     # Updates are logged as well
INFO:root:Accessing 'age' giving 30
INFO:root:Updating 'age' to 31

>>> dave.name                           # Regular attribute lookup isn't logged
'David D'
>>> dave.age                            # Only the managed attribute is logged
INFO:root:Accessing 'age' giving 40
40

Одна из основных проблем этого примера заключается в том, что закрытое имя _age жестко закодировано в классе LoggedAgeAccess. Это означает, что каждый экземпляр может иметь только один зарегистрированный атрибут, и его имя нельзя изменить. В следующем примере мы решим эту проблему.

Настраиваемые имена

Когда класс использует дескрипторы, он может сообщить каждому дескриптору, какое имя переменной было использовано.

В этом примере класс Person имеет два экземпляра дескрипторов, name и age. Когда определен класс Person , он вызывает метод __set_name__() в LoggedAccess, чтобы имена полей могли быть записаны, присваивая каждому дескриптору свой public_name и private_name:

import logging

logging.basicConfig(level=logging.INFO)

class LoggedAccess:

    def __set_name__(self, owner, name):
        self.public_name = name
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        value = getattr(obj, self.private_name)
        logging.info('Accessing %r giving %r', self.public_name, value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', self.public_name, value)
        setattr(obj, self.private_name, value)

class Person:

    name = LoggedAccess()                # First descriptor instance
    age = LoggedAccess()                 # Second descriptor instance

    def __init__(self, name, age):
        self.name = name                 # Calls the first descriptor
        self.age = age                   # Calls the second descriptor

    def birthday(self):
        self.age += 1

В интерактивной сессии показано, что класс Person вызвал метод __set_name__(), чтобы имена полей были записаны. Здесь мы вызываем метод vars() для поиска дескриптора без его вызова:

>>> vars(vars(Person)['name'])
{'public_name': 'name', 'private_name': '_name'}
>>> vars(vars(Person)['age'])
{'public_name': 'age', 'private_name': '_age'}

Новый класс теперь регистрирует доступ к обоим атрибутам name и age:

>>> pete = Person('Peter P', 10)
INFO:root:Updating 'name' to 'Peter P'
INFO:root:Updating 'age' to 10
>>> kate = Person('Catherine C', 20)
INFO:root:Updating 'name' to 'Catherine C'
INFO:root:Updating 'age' to 20

Два экземпляра класса Person содержат только закрытые имена:

>>> vars(pete)
{'_name': 'Peter P', '_age': 10}
>>> vars(kate)
{'_name': 'Catherine C', '_age': 20}

Заключительные замечания

Дескриптор — это любой объект, который определяет __get__(), __set__() или __delete__().

Необязательно, дескрипторы могут иметь метод __set_name__(). Это используется только в тех случаях, когда дескриптору необходимо знать либо класс, в котором он был создан, либо имя переменной класса, которому он был назначен. (Если этот метод присутствует, он вызывается, даже если класс не является дескриптором.)

Дескрипторы вызываются оператором точки во время поиска атрибута. Если к дескриптору обращаются косвенно с помощью vars(some_class)[descriptor_name], возвращается экземпляр дескриптора без его вызова.

Дескрипторы работают только при использовании в качестве переменных класса. При размещении в экземплярах они не оказывают никакого влияния.

Основная мотивация дескрипторов — предоставить крючок, позволяющий объектам, хранящимся в переменных класса, контролировать то, что происходит во время поиска атрибута.

Традиционно класс-вызывающий контролирует то, что происходит во время поиска. Дескрипторы меняют эту связь и позволяют данным, которые ищутся, иметь право голоса в этом вопросе.

Дескрипторы используются на протяжении всего языка. Именно так функции превращаются в связанные методы. Такие распространенные инструменты, как classmethod(), staticmethod(), property() и functools.cached_property() реализованы как дескрипторы.

Класс валидатора

Валидатор — это дескриптор для управления доступом к атрибутам. Перед сохранением любых данных он проверяет, удовлетворяет ли новое значение различным ограничениям типа и диапазона. Если эти ограничения не соблюдаются, он генерирует исключение, чтобы предотвратить повреждение данных в источнике.

Этот класс Validator является одновременно абстрактным базовым классом и дескриптором управляемого атрибута:

from abc import ABC, abstractmethod

class Validator(ABC):

    def __set_name__(self, owner, name):
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        return getattr(obj, self.private_name)

    def __set__(self, obj, value):
        self.validate(value)
        setattr(obj, self.private_name, value)

    @abstractmethod
    def validate(self, value):
        pass

Пользовательские валидаторы должны наследоваться от Validator и должны предоставить метод validate() для проверки различных ограничений по мере необходимости.

Пользовательские валидаторы

Вот три практические утилиты проверки данных:

1. OneOf проверяет, является ли значение одним из ограниченного набора вариантов.
2. Number проверяет, является ли значение либо int, либо float. Необязательно, он проверяет, находится ли значение между заданным минимумом или максимумом.
3. String проверяет, является ли значение str. Необязательно, он проверяет заданную минимальную или максимальную длину. Он также может проверять пользовательское предикат.

class OneOf(Validator):

    def __init__(self, *options):
        self.options = set(options)

    def validate(self, value):
        if value not in self.options:
            raise ValueError(
                f'Expected {value!r} to be one of {self.options!r}'
            )

class Number(Validator):

    def __init__(self, minvalue=None, maxvalue=None):
        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, predicate=None):
        self.minsize = minsize
        self.maxsize = maxsize
        self.predicate = predicate

    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}'
            )
        if self.predicate is not None and not self.predicate(value):
            raise ValueError(
                f'Expected {self.predicate} to be true for {value!r}'
            )

Практическое применение

Вот как можно использовать валидаторы данных в реальном классе:

class Component:

    name = String(minsize=3, maxsize=10, predicate=str.isupper)
    kind = OneOf('wood', 'metal', 'plastic')
    quantity = Number(minvalue=0)

    def __init__(self, name, kind, quantity):
        self.name = name
        self.kind = kind
        self.quantity = quantity

Дескрипторы предотвращают создание недействительных экземпляров:

>>> Component('Widget', 'metal', 5)      # Blocked: 'Widget' is not all uppercase
Traceback (most recent call last):
    ...
ValueError: Expected <method 'isupper' of 'str' objects> to be true for 'Widget'

>>> Component('WIDGET', 'metle', 5)      # Blocked: 'metle' is misspelled
Traceback (most recent call last):
    ...
ValueError: Expected 'metle' to be one of {'metal', 'plastic', 'wood'}

>>> Component('WIDGET', 'metal', -5)     # Blocked: -5 is negative
Traceback (most recent call last):
    ...
ValueError: Expected -5 to be at least 0

>>> Component('WIDGET', 'metal', 'V')    # Blocked: 'V' isn't a number
Traceback (most recent call last):
    ...
TypeError: Expected 'V' to be an int or float

>>> c = Component('WIDGET', 'metal', 5)  # Allowed:  The inputs are valid

Аннотация

Определяет дескрипторы, обобщает протокол и показывает, как вызываются дескрипторы. Приведен пример, демонстрирующий, как работают объектно-реляционные отображения.

Изучение дескрипторов не только расширяет набор инструментов, но и углубляет понимание принципов работы Python.

Определение и введение

В общем случае, дескриптор — это значение атрибута, имеющее один из методов протокола дескриптора. Эти методы — __get__(), __set__() и __delete__(). Если для атрибута определен любой из этих методов, он называется дескриптором.

По умолчанию доступ к атрибуту осуществляется путем получения, задания или удаления атрибута из словаря объекта. Например, a.x имеет цепочку поиска, начинающуюся с a.__dict__['x'], затем type(a).__dict__['x'], и продолжающуюся через порядок разрешения методов type(a). Если найденное значение является объектом, определяющим один из методов дескриптора, Python может переопределить поведение по умолчанию и вместо этого вызвать метод дескриптора. Местоположение в цепочке приоритета зависит от определенных методов дескриптора.

Дескрипторы — мощный и универсальный протокол. Они являются механизмом, стоящим за свойствами, методами, статическими методами, методами класса и super(). Они используются во всем Python. Дескрипторы упрощают базовый C-код и предлагают гибкий набор новых инструментов для повседневных программ на Python.

Протокол дескриптора

descr.__get__(self, obj, type=None)

descr.__set__(self, obj, value)

descr.__delete__(self, obj)

Вот и все. Определив любой из этих методов, объект считается дескриптором и может переопределять поведение по умолчанию при обращении к нему как к атрибуту.

Если объект определяет __set__() или __delete__(), он считается дескриптором данных. Дескрипторы, которые определяют только __get__(), называются дескрипторами без данных (они часто используются для методов, но возможны и другие применения).

Дескрипторы данных и дескрипторы без данных отличаются тем, как вычисляются переопределения по отношению к записям в словаре экземпляра. Если словарь экземпляра содержит запись с тем же именем, что и дескриптор данных, дескриптор данных имеет приоритет. Если словарь экземпляра содержит запись с тем же именем, что и дескриптор без данных, приоритет имеет запись в словаре.

Чтобы создать дескриптор данных только для чтения, определите как __get__(), так и __set__() с __set__(), который вызывает AttributeError при вызове. Определение метода __set__() с исключением достаточно для того, чтобы сделать его дескриптором данных.

Обзор вызова дескрипторов

Дескриптор можно вызвать напрямую с помощью desc.__get__(obj) или desc.__get__(None, cls).

Однако чаще дескриптор вызывается автоматически при доступе к атрибуту.

Выражение obj.x ищет атрибут x в цепочке пространств имен для obj. Если поиск находит дескриптор за пределами экземпляра __dict__, вызывается его метод __get__() в соответствии с правилами приоритета, перечисленными ниже.

Подробности вызова зависят от того, является ли obj объектом, классом или экземпляром super.

Вызов из экземпляра

Поиск в экземпляре проходит по цепочке пространств имен, отдавая приоритет дескрипторам данных, затем переменным экземпляра, затем дескрипторам без данных, затем переменным класса и, наконец, __getattr__(), если он предоставлен.

Если для a.x найден дескриптор, он вызывается с помощью: desc.__get__(a, type(a)).

Логика для точечного поиска находится в object.__getattribute__(). Вот чистый эквивалент на Python:

def find_name_in_mro(cls, name, default):
    "Emulate _PyType_Lookup() in Objects/typeobject.c"
    for base in cls.__mro__:
        if name in vars(base):
            return vars(base)[name]
    return default

def object_getattribute(obj, name):
    "Emulate PyObject_GenericGetAttr() in Objects/object.c"
    null = object()
    objtype = type(obj)
    cls_var = find_name_in_mro(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)     # data descriptor
    if hasattr(obj, '__dict__') and name in vars(obj):
        return vars(obj)[name]                          # instance variable
    if descr_get is not null:
        return descr_get(cls_var, obj, objtype)         # non-data descriptor
    if cls_var is not null:
        return cls_var                                  # class variable
    raise AttributeError(name)

Обратите внимание, что нет крючка __getattr__() в коде __getattribute__(). Вот почему вызов __getattribute__() напрямую или с помощью super().__getattribute__ полностью обойдет __getattr__().

Вместо этого за вызов __getattr__() отвечают оператор точки и функция getattr() всякий раз, когда __getattribute__() вызывает AttributeError. Их логика инкапсулирована в вспомогательной функции:

def getattr_hook(obj, name):
    "Emulate slot_tp_getattr_hook() in Objects/typeobject.c"
    try:
        return obj.__getattribute__(name)
    except AttributeError:
        if not hasattr(type(obj), '__getattr__'):
            raise
    return type(obj).__getattr__(obj, name)             # __getattr__

Вызов из класса

Логика точечного поиска, такого как A.x находится в type.__getattribute__(). Шаги аналогичны шагам для object.__getattribute__(), но поиск в словаре экземпляра заменяется поиском в порядке разрешения методов класса.

Если найден дескриптор, он вызывается с помощью desc.__get__(None, A).

Полная реализация на C находится в type_getattro() и _PyType_Lookup() в Objects/typeobject.c.

Вызов из super

Логика точечного поиска super находится в методе __getattribute__() для объекта, возвращаемого super().

Точечный поиск, такой как super(A, obj).m ищет obj.__class__.__mro__ у базового класса B непосредственно после A и затем возвращает B.__dict__['m'].__get__(obj, A). Если не дескриптор, возвращается m без изменений.

Полная реализация на C находится в super_getattro() в Objects/typeobject.c. Чистый эквивалент на Python можно найти в руководстве Гвидо.

Резюме логики вызова

Механизм дескрипторов встроен в методы __getattribute__() для object, type и super().

Важные моменты, которые следует запомнить:

• Дескрипторы вызываются методом __getattribute__().
• Классы наследуют эту машину от object, type или super().
• Переопределение __getattribute__() предотвращает автоматические вызовы дескрипторов, поскольку вся логика дескриптора находится в этом методе.
• object.__getattribute__() и type.__getattribute__() делают разные вызовы __get__(). Первый включает экземпляр и может включать класс. Второй помещает None для экземпляра и всегда включает класс.
• Дескрипторы данных всегда переопределяют словари экземпляров.
• Дескрипторы без данных могут быть переопределены словарями экземпляров.

Автоматическое уведомление о имени

Иногда желательно, чтобы описатель знал, к какому имени переменной класса он был назначен. Когда создается новый класс, метакласс type сканирует словарь нового класса. Если какие-либо записи являются описателями и если они определяют __set_name__(), этот метод вызывается с двумя аргументами. Владелец — это класс, где используется описатель, а имя — это переменная класса, которой был назначен описатель.

Подробности реализации находятся в type_new() и set_names() в Objects/typeobject.c.

Поскольку логика обновления находится в type.__new__(), уведомления происходят только во время создания класса. Если описатели добавляются в класс позже, __set_name__() необходимо будет вызвать вручную.

Пример ORM

Следующий код представляет собой упрощенную структуру, показывающую, как описатели данных можно использовать для реализации отображения объект-реляционная модель.

Суть в том, что данные хранятся во внешней базе данных. Экземпляры Python содержат только ключи к таблицам базы данных. Описатели занимаются поиском или обновлением:

class Field:

    def __set_name__(self, owner, name):
        self.fetch = f'SELECT {name} FROM {owner.table} WHERE {owner.key}=?;'
        self.store = f'UPDATE {owner.table} SET {name}=? WHERE {owner.key}=?;'

    def __get__(self, obj, objtype=None):
        return conn.execute(self.fetch, [obj.key]).fetchone()[0]

    def __set__(self, obj, value):
        conn.execute(self.store, [value, obj.key])
        conn.commit()

Мы можем использовать класс Field для определения моделей, которые описывают схему для каждой таблицы в базе данных:

class Movie:
    table = 'Movies'                    # Table name
    key = 'title'                       # Primary key
    director = Field()
    year = Field()

    def __init__(self, key):
        self.key = key

class Song:
    table = 'Music'
    key = 'title'
    artist = Field()
    year = Field()
    genre = Field()

    def __init__(self, key):
        self.key = key

Чтобы использовать модели, сначала подключитесь к базе данных:

>>> import sqlite3
>>> conn = sqlite3.connect('entertainment.db')

Интерактивный сеанс демонстрирует, как данные извлекаются из базы данных и как они могут быть обновлены:

>>> Movie('Star Wars').director
'George Lucas'
>>> jaws = Movie('Jaws')
>>> f'Released in {jaws.year} by {jaws.director}'
'Released in 1975 by Steven Spielberg'

>>> Song('Country Roads').artist
'John Denver'

>>> Movie('Star Wars').director = 'J.J. Abrams'
>>> Movie('Star Wars').director
'J.J. Abrams'

Свойства

Вызов property() — лаконичный способ построения дескриптора данных, который запускает вызов функции при обращении к атрибуту. Его сигнатура:

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

Документация демонстрирует типичное использование для определения управляемого атрибута x:

class C:
    def getx(self): return self.__x
    def setx(self, value): self.__x = value
    def delx(self): del self.__x
    x = property(getx, setx, delx, "I'm the 'x' property.")

Чтобы увидеть, как property() реализован в терминах протокола дескриптора, вот чистый эквивалент на Python, который реализует большую часть основной функциональности:

class Property:
    "Emulate PyProperty_Type() in Objects/descrobject.c"

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        if doc is None and fget is not None:
            doc = fget.__doc__
        self.__doc__ = doc

    def __set_name__(self, owner, name):
        self.__name__ = name

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError
        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__)

Встроенная функция property() полезна всякий раз, когда пользовательский интерфейс предоставляет доступ к атрибуту, а последующие изменения требуют вмешательства метода.

Например, класс электронной таблицы может предоставить доступ к значению ячейки через Cell('b10').value. Последующие улучшения программы требуют перерасчета ячейки при каждом обращении; однако программист не хочет влиять на существующий клиентский код, который обращается к атрибуту напрямую. Решение состоит в том, чтобы обернуть доступ к атрибуту value в дескриптор свойства:

class Cell:
    ...

    @property
    def value(self):
        "Recalculate the cell before returning value"
        self.recalc()
        return self._value

В этом примере сработает либо встроенная функция property(), либо наш Property() эквивалент.

Функции и методы

Объектно-ориентированные возможности Python построены на функциональной среде. С помощью дескрипторов, не являющихся данными, оба объединяются без проблем.

Функции, хранящиеся в словарях классов, превращаются в методы при вызове. Методы отличаются от обычных функций только тем, что экземпляр объекта добавляется перед другими аргументами. По соглашению, экземпляр называется self, но может называться this или любым другим именем переменной.

Методы можно создавать вручную с помощью types.MethodType, что примерно эквивалентно:

class MethodType:
    "Emulate PyMethod_Type in Objects/classobject.c"

    def __init__(self, func, obj):
        self.__func__ = func
        self.__self__ = obj

    def __call__(self, *args, **kwargs):
        func = self.__func__
        obj = self.__self__
        return func(obj, *args, **kwargs)

    def __getattribute__(self, name):
        "Emulate method_getset() in Objects/classobject.c"
        if name == '__doc__':
            return self.__func__.__doc__
        return object.__getattribute__(self, name)

    def __getattr__(self, name):
        "Emulate method_getattro() in Objects/classobject.c"
        return getattr(self.__func__, name)

    def __get__(self, obj, objtype=None):
        "Emulate method_descr_get() in Objects/classobject.c"
        return self

Для поддержки автоматического создания методов функции включают метод __get__() для связывания методов во время доступа к атрибуту. Это означает, что функции являются дескрипторами, не являющимися данными, которые возвращают связанные методы при точечном поиске из экземпляра. Вот как это работает:

class Function:
    ...

    def __get__(self, obj, objtype=None):
        "Simulate func_descr_get() in Objects/funcobject.c"
        if obj is None:
            return self
        return MethodType(self, obj)

Выполнение следующего класса в интерпретаторе показывает, как работает дескриптор функции на практике:

class D:
    def f(self):
         return self

class D2:
    pass

Функция имеет атрибут полного имени для поддержки интроспекции:

>>> D.f.__qualname__
'D.f'

Доступ к функции через словарь класса не вызывает __get__(). Вместо этого он просто возвращает лежащий в основе объект функции:

>>> D.__dict__['f']
<function D.f at 0x00C45070>

Точечный доступ из класса вызывает __get__(), который просто возвращает лежащую в основе функцию без изменений:

>>> D.f
<function D.f at 0x00C45070>

Интересное поведение возникает при точечном доступе из экземпляра. Точечный поиск вызывает __get__(), который возвращает объект связанного метода:

>>> d = D()
>>> d.f
<bound method D.f of <__main__.D object at 0x00B18C90>>

Внутренне, связанный метод хранит лежащую в основе функцию и связанный экземпляр:

>>> d.f.__func__
<function D.f at 0x00C45070>

>>> d.f.__self__
<__main__.D object at 0x00B18C90>

Если вы когда-нибудь задумывались, откуда self появляется в обычных методах или откуда cls появляется в методах класса, вот ответ!

Виды методов

Дескрипторы, не являющиеся данными, предоставляют простой механизм для вариантов обычных шаблонов связывания функций в методы.

В качестве напоминания, у функций есть метод __get__(), так что их можно преобразовать в метод при обращении как к атрибутам. Дескриптор, не являющийся данными, преобразует вызов obj.f(*args) в f(obj, *args). Вызов cls.f(*args) становится f(*args).

В этой таблице обобщается связывание и два наиболее полезных его варианта:

Статические методы

Статические методы возвращают лежащую в основе функцию без изменений. Вызов либо c.f либо C.f эквивалентен прямому поиску в object.__getattribute__(c, "f") или object.__getattribute__(C, "f"). В результате функция становится одинаково доступной как из объекта, так и из класса.

Хорошими кандидатами для статических методов являются методы, которые не ссылаются на переменную self.

Например, пакет статистики может включать в себя контейнерный класс для экспериментальных данных. Класс предоставляет обычные методы для вычисления среднего значения, среднего, медианы и других описательных статистических данных, которые зависят от данных. Однако могут быть полезные функции, которые концептуально связаны, но не зависят от данных. Например, erf(x) — это удобная процедура преобразования, которая возникает в статистической работе, но напрямую не зависит от конкретного набора данных. Она может быть вызвана как из объекта, так и из класса: s.erf(1.5) --> 0.9332 или Sample.erf(1.5) --> 0.9332.

Поскольку статические методы возвращают лежащую в основе функцию без изменений, примеры вызовов не вызывают интереса:

class E:
    @staticmethod
    def f(x):
        return x * 10

>>> E.f(3)
30
>>> E().f(3)
30

Используя протокол дескриптора, не являющегося данными, чистая версия Python staticmethod() будет выглядеть так:

import functools

class StaticMethod:
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, objtype=None):
        return self.f

    def __call__(self, *args, **kwds):
        return self.f(*args, **kwds)

Вызов functools.update_wrapper() добавляет атрибут __wrapped__, который ссылается на лежащую в основе функцию. Также он передает атрибуты, необходимые для того, чтобы обёртка выглядела как обернутая функция: __name__, __qualname__, __doc__ и __annotations__.

Методы класса

В отличие от статических методов, методы класса добавляют ссылку на класс к списку аргументов перед вызовом функции. Этот формат одинаков независимо от того, вызывается ли метод из объекта или класса:

class F:
    @classmethod
    def f(cls, x):
        return cls.__name__, x

>>> F.f(3)
('F', 3)
>>> F().f(3)
('F', 3)

Это поведение полезно, когда метод должен только иметь ссылку на класс и не полагается на данные, хранящиеся в конкретном экземпляре. Одно из применений методов класса — создание альтернативных конструкторов класса. Например, метод класса dict.fromkeys() создаёт новый словарь из списка ключей. Чистый эквивалент на Python выглядит так:

class Dict(dict):
    @classmethod
    def fromkeys(cls, iterable, value=None):
        "Emulate dict_fromkeys() in Objects/dictobject.c"
        d = cls()
        for key in iterable:
            d[key] = value
        return d

Теперь новый словарь уникальных ключей можно создать так:

>>> d = Dict.fromkeys('abracadabra')
>>> type(d) is Dict
True
>>> d
{'a': None, 'b': None, 'r': None, 'c': None, 'd': None}

Используя протокол дескриптора, не являющегося данными, чистая версия Python classmethod() будет выглядеть так:

import functools

class ClassMethod:
    "Emulate PyClassMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, cls=None):
        if cls is None:
            cls = type(obj)
        return MethodType(self.f, cls)

Вызов functools.update_wrapper() в ClassMethod добавляет атрибут __wrapped__, который ссылается на лежащую в основе функцию. Также он передает атрибуты, необходимые для того, чтобы обёртка выглядела как обернутая функция: __name__, __qualname__, __doc__ и __annotations__.

Объекты-члены и __slots__

Когда класс определяет __slots__, он заменяет словари экземпляров массивом фиксированной длины значений слотов. С точки зрения пользователя это имеет несколько последствий:

1. Обеспечивает немедленное обнаружение ошибок из-за неправильного написания имен атрибутов. Разрешены только имена атрибутов, указанные в __slots__:

class Vehicle:
    __slots__ = ('id_number', 'make', 'model')

>>> auto = Vehicle()
>>> auto.id_nubmer = 'VYE483814LQEX'
Traceback (most recent call last):
    ...
AttributeError: 'Vehicle' object has no attribute 'id_nubmer'

2. Помогает создавать неизменяемые объекты, где дескрипторы управляют доступом к закрытым атрибутам, хранящимся в __slots__:

class Immutable:

    __slots__ = ('_dept', '_name')          # Replace the instance dictionary

    def __init__(self, dept, name):
        self._dept = dept                   # Store to private attribute
        self._name = name                   # Store to private attribute

    @property                               # Read-only descriptor
    def dept(self):
        return self._dept

    @property
    def name(self):                         # Read-only descriptor
        return self._name

>>> mark = Immutable('Botany', 'Mark Watney')
>>> mark.dept
'Botany'
>>> mark.dept = 'Space Pirate'
Traceback (most recent call last):
    ...
AttributeError: property 'dept' of 'Immutable' object has no setter
>>> mark.location = 'Mars'
Traceback (most recent call last):
    ...
AttributeError: 'Immutable' object has no attribute 'location'

3. Экономит память. В 64-разрядной сборке Linux экземпляр с двумя атрибутами занимает 48 байт с __slots__ и 152 байта без него. Этот паттерн проектирования Flyweight вероятно, имеет значение только при создании большого числа экземпляров.

4. Повышает скорость. Чтение переменных экземпляра на 35% быстрее с __slots__ (измерено с Python 3.10 на процессоре Apple M1).

5. Блокирует инструменты, такие как functools.cached_property(), которые требуют словаря экземпляра для корректной работы:

from functools import cached_property

class CP:
    __slots__ = ()                          # Eliminates the instance dict

    @cached_property                        # Requires an instance dict
    def pi(self):
        return 4 * sum((-1.0)**n / (2.0*n + 1.0)
                       for n in reversed(range(100_000)))

>>> CP().pi
Traceback (most recent call last):
  ...
TypeError: No '__dict__' attribute on 'CP' instance to cache 'pi' property.

Невозможно создать точную прямую чистую версию Python __slots__, потому что она требует прямого доступа к C-структурам и контроля над выделением памяти объектов. Однако мы можем создать приближенную симуляцию, где фактическая C-структура слотов эмулируется приватным списком _slotvalues. Чтение и запись в эту закрытую структуру управляются дескрипторами членов:

null = object()

class Member:

    def __init__(self, name, clsname, offset):
        'Emulate PyMemberDef in Include/structmember.h'
        # Also see descr_new() in Objects/descrobject.c
        self.name = name
        self.clsname = clsname
        self.offset = offset

    def __get__(self, obj, objtype=None):
        'Emulate member_get() in Objects/descrobject.c'
        # Also see PyMember_GetOne() in Python/structmember.c
        if obj is None:
            return self
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        return value

    def __set__(self, obj, value):
        'Emulate member_set() in Objects/descrobject.c'
        obj._slotvalues[self.offset] = value

    def __delete__(self, obj):
        'Emulate member_delete() in Objects/descrobject.c'
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        obj._slotvalues[self.offset] = null

    def __repr__(self):
        'Emulate member_repr() in Objects/descrobject.c'
        return f'<Member {self.name!r} of {self.clsname!r}>'

Метод type.__new__() отвечает за добавление объектов-членов в переменные класса:

class Type(type):
    'Simulate how the type metaclass adds member objects for slots'

    def __new__(mcls, clsname, bases, mapping, **kwargs):
        'Emulate type_new() in Objects/typeobject.c'
        # type_new() calls PyTypeReady() which calls add_methods()
        slot_names = mapping.get('slot_names', [])
        for offset, name in enumerate(slot_names):
            mapping[name] = Member(name, clsname, offset)
        return type.__new__(mcls, clsname, bases, mapping, **kwargs)

Метод object.__new__() отвечает за создание экземпляров, имеющих слоты вместо словаря экземпляра. Вот грубая симуляция на чистом Python:

class Object:
    'Simulate how object.__new__() allocates memory for __slots__'

    def __new__(cls, *args, **kwargs):
        'Emulate object_new() in Objects/typeobject.c'
        inst = super().__new__(cls)
        if hasattr(cls, 'slot_names'):
            empty_slots = [null] * len(cls.slot_names)
            object.__setattr__(inst, '_slotvalues', empty_slots)
        return inst

    def __setattr__(self, name, value):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'{cls.__name__!r} object has no attribute {name!r}'
            )
        super().__setattr__(name, value)

    def __delattr__(self, name):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'{cls.__name__!r} object has no attribute {name!r}'
            )
        super().__delattr__(name)

Чтобы использовать симуляцию в реальном классе, просто унаследуйте от Object и установите метакласс на Type:

class H(Object, metaclass=Type):
    'Instance variables stored in slots'

    slot_names = ['x', 'y']

    def __init__(self, x, y):
        self.x = x
        self.y = y

На этом этапе метакласс загрузил объекты-члены для x и y:

>>> from pprint import pp
>>> pp(dict(vars(H)))
{'__module__': '__main__',
 '__doc__': 'Instance variables stored in slots',
 'slot_names': ['x', 'y'],
 '__init__': <function H.__init__ at 0x7fb5d302f9d0>,
 'x': <Member 'x' of 'H'>,
 'y': <Member 'y' of 'H'>}

При создании экземпляров у них есть список slot_values, где хранятся атрибуты:

>>> h = H(10, 20)
>>> vars(h)
{'_slotvalues': [10, 20]}
>>> h.x = 55
>>> vars(h)
{'_slotvalues': [55, 20]}

Неправильно написанные или неназначенные атрибуты вызовут исключение:

>>> h.xz
Traceback (most recent call last):
    ...
AttributeError: 'H' object has no attribute 'xz'