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

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

Класс 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__(), этот метод вызывается с двумя аргументами. owner — класс, где используется дескриптор, а 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
        self._name = ''

    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(
                f'property {self._name!r} of {type(obj).__name__!r} object has no getter'
             )
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError(
                f'property {self._name!r} of {type(obj).__name__!r} object has no setter'
             )
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError(
                f'property {self._name!r} of {type(obj).__name__!r} object has no deleter'
             )
        self.fdel(obj)

    def getter(self, fget):
        prop = type(self)(fget, self.fset, self.fdel, self.__doc__)
        prop._name = self._name
        return prop

    def setter(self, fset):
        prop = type(self)(self.fget, fset, self.fdel, self.__doc__)
        prop._name = self._name
        return prop

    def deleter(self, fdel):
        prop = type(self)(self.fget, self.fset, fdel, self.__doc__)
        prop._name = self._name
        return prop

Встроенный 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)

Для поддержки автоматического создания методов функции включают метод __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, x):
         return x

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

>>> 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) --> .9332 или Sample.erf(1.5) --> .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() будет выглядеть так:

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

Путь кода для hasattr(type(self.f), '__get__') был добавлен в Python 3.9 и позволяет classmethod() поддерживать цепочку декораторов. Например, можно объединить метод класса и свойство. В Python 3.11 эта функциональность была устаревшей.

class G:
    @classmethod
    @property
    def __doc__(cls):
        return f'A doc for {cls.__name__!r}'

>>> G.__doc__
"A doc for 'G'"

Вызов 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'