Документация Python неофициальный перевод
Содержание страницы

3. Модель данныхData model

3.1. Объекты, значения и типыObjects, values and types

Объекты – это абстракция данных в Python. Все данные в программе Python представлены объектами или отношениями между объектами. (В некотором смысле, и в соответствии с моделью фон Неймана «компьютера с хранимой программой», код также представлен объектами.)

Каждый объект имеет идентификатор, тип и значение. Идентификатор объекта никогда не изменяется после создания; его можно рассматривать как адрес объекта в памяти. Оператор ‘is‘ сравнивает идентификаторы двух объектов; функция id() возвращает целое число, представляющее его идентификатор (в текущей реализации – адрес). Тип объекта также неизменяем. [1] Тип объекта определяет операции, которые объект поддерживает (например, «есть ли у него длина?»), а также задаёт возможные значения для объектов этого типа. Функция type() возвращает тип объекта (сам являющийся объектом). Значение некоторых объектов может меняться. Объекты, значение которых может меняться, называются изменяемыми; объекты, значение которых после создания неизменно, называются неизменяемыми. (Значение неизменяемого контейнерного объекта, содержащего ссылку на изменяемый объект, может измениться при изменении значения последнего; однако контейнер все равно считается неизменяемым, потому что набор объектов, которые он содержит, изменить нельзя. Таким образом, неизменяемость не тождественна неизменности значения – это более тонкое понятие.) Изменяемость объекта определяется его типом; например, числа, строки и кортежи неизменяемы, а словари и списки – изменяемы.

Объекты никогда не уничтожаются явно; однако, когда они становятся недостижимыми, они могут быть собраны сборщиком мусора. Реализация может откладывать сборку мусора или вовсе её не выполнять – качество реализации определяет, как именно реализована сборка мусора, при условии, что не собираются объекты, которые всё ещё достижимы.

Особенность реализации CPython: В CPython используется схема подсчёта ссылок с (опциональным) отложенным обнаружением циклически связанного мусора; она собирает большинство объектов, как только они становятся недостижимыми, но не гарантирует сборку мусора, содержащего циклические ссылки. За информацией об управлении сборкой циклического мусора обращайтесь к документации модуля gc . Другие реализации работают иначе, и поведение CPython может измениться. Не рассчитывайте на немедленную финализацию объектов при их недостижимости (например, всегда закрывайте файлы).

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

Некоторые объекты содержат ссылки на «внешние» ресурсы, такие как открытые файлы или окна. Подразумевается, что эти ресурсы освобождаются при сборке мусора объекта, но поскольку сборка мусора не гарантируется, такие объекты также предоставляют явный способ освобождения внешнего ресурса – обычно метод close(). Программам настоятельно рекомендуется явно закрывать такие объекты. Оператор ‘try...finally‘ и оператор ‘with‘ предоставляют удобные способы сделать это.

Некоторые объекты содержат ссылки на другие объекты; они называются контейнерами. Примерами контейнеров являются кортежи, списки и словари. Ссылки являются частью значения контейнера. В большинстве случаев, когда мы говорим о значении контейнера, мы подразумеваем значения, а не идентификаторы содержащихся объектов; однако, когда мы говорим об изменяемости контейнера, подразумеваются только идентификаторы непосредственно содержащихся объектов. Таким образом, если неизменяемый контейнер (например, кортеж) содержит ссылку на изменяемый объект, его значение изменяется при изменении этого изменяемого объекта.

Типы влияют практически на все аспекты поведения объектов. Даже значимость идентичности объекта в некотором смысле меняется: для неизменяемых типов операции, вычисляющие новые значения, могут фактически возвращать ссылку на любой существующий объект с тем же типом и значением, в то время как для изменяемых объектов это не допускается. Например, после a = 1; b = 1, a и b могут ссылаться или не ссылаться на один и тот же объект со значением 1 в зависимости от реализации, но после c = []; d = [], c и d гарантированно ссылаются на два разных, уникальных, только что созданных пустых списка. (Заметьте, что c = d = [] присваивает один и тот же объект обоим c и d.)

3.2. Стандартная иерархия типовThe standard type hierarchy

Ниже приведён список типов, встроенных в Python. Модули расширения (написанные на C, Java или других языках в зависимости от реализации) могут определять дополнительные типы. Будущие версии Python могут добавлять типы в иерархию (например, рациональные числа, эффективно хранимые массивы целых чисел и т.д.), хотя такие дополнения чаще будут предоставляться через стандартную библиотеку.

Некоторые описания типов ниже содержат абзац, перечисляющий «специальные атрибуты». Это атрибуты, обеспечивающие доступ к реализации и не предназначенные для общего использования. Их определение может измениться в будущем.

None

Этот тип имеет единственное значение. Существует единственный объект с этим значением. Доступ к этому объекту осуществляется через встроенное имя None. Он используется для обозначения отсутствия значения во многих ситуациях, например, возвращается из функций, которые ничего явно не возвращают. Его истинностное значение – ложь.

NotImplemented

У этого типа только одно значение. Существует единственный объект с этим значением. Этот объект доступен по встроенному имени NotImplemented. Числовые методы и методы расширенного сравнения могут вернуть это значение, если они не реализуют операцию для переданных операндов. (Интерпретатор затем попытается выполнить отражённую операцию или другой запасной вариант, в зависимости от оператора.) Его истинностное значение – истина.

Ellipsis

Этот тип имеет единственное значение. Существует единственный объект с этим значением. Доступ к этому объекту осуществляется через литерал ... или встроенное имя Ellipsis. Его истинностное значение – истина.

numbers.Number

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

Python различает целые числа, числа с плавающей запятой и комплексные числа:

numbers.Integral

Они представляют элементы из математического множества целых чисел (положительных и отрицательных).

Существует два типа целых чисел:

Целые числа (int)

Они представляют числа в неограниченном диапазоне, ограниченном лишь доступной (виртуальной) памятью. Для операций сдвига и маскирования используется двоичное представление, а отрицательные числа представляются в варианте дополнительного кода, который создаёт иллюзию бесконечной строки знаковых битов, уходящей влево.
Булевы значения (bool)

Они представляют значения истинности False и True. Два объекта, представляющие значения False и True, являются единственными булевыми объектами. Булев тип – подтип целочисленного типа, и булевы значения ведут себя как значения 0 и 1 соответственно почти во всех контекстах, за исключением того, что при преобразовании в строку возвращаются строки "False" или "True" соответственно.

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

numbers.Real (float)

Они представляют числа с плавающей запятой двойной точности на уровне машины. Вы зависите от нижележащей архитектуры машины (и реализации C или Java) в отношении допустимого диапазона и обработки переполнения. Python не поддерживает числа с плавающей запятой одинарной точности; экономия процессора и памяти, которая обычно является причиной их использования, ничтожна по сравнению с накладными расходами на использование объектов в Python, поэтому нет смысла усложнять язык двумя видами чисел с плавающей запятой.

numbers.Complex (complex)

Они представляют комплексные числа как пару машинных чисел с плавающей запятой двойной точности. К ним применимы те же предостережения, что и к числам с плавающей запятой. Действительная и мнимая части комплексного числа z могут быть получены через атрибуты только для чтения z.real и z.imag.

Последовательности

Они представляют конечные упорядоченные наборы, индексируемые неотрицательными числами. Встроенная функция len() возвращает количество элементов последовательности. Когда длина последовательности равна n, набор индексов содержит числа 0, 1, ..., n-1. Элемент i последовательности a выбирается как a[i].

Последовательности также поддерживают срезы: a[i:j] выбирает все элементы с индексом k таким, что i <= k < j. При использовании в качестве выражения срез является последовательностью того же типа. Это означает, что набор индексов перенумеровывается, начиная с 0.

Некоторые последовательности также поддерживают «расширенные срезы» с третьим параметром «шаг»: a[i:j:k] выбирает все элементы a с индексом x, где x = i + n*k, n >= 0 и i <= x < j.

Последовательности различаются по изменяемости:

Неизменяемые последовательности

Объект неизменяемого типа последовательности не может измениться после создания. (Если объект содержит ссылки на другие объекты, эти другие объекты могут быть изменяемыми и могут изменяться; однако совокупность объектов, на которые непосредственно ссылается неизменяемый объект, измениться не может.)

Следующие типы являются неизменяемыми последовательностями:

Строки

Элементами строкового объекта являются кодовые единицы Unicode. Кодовая единица Unicode представляется строковым объектом из одного элемента и может содержать 16- или 32-битное значение, представляющее порядковый номер Unicode (максимальное значение порядкового номера указано в sys.maxunicode и зависит от конфигурации Python при компиляции). В объекте Unicode могут присутствовать суррогатные пары, и они будут представлены как два отдельных элемента. Встроенные функции chr() и ord() преобразуют кодовые единицы в неотрицательные целые числа, представляющие порядковые номера Unicode согласно стандарту Unicode 3.0, и обратно. Преобразование в другие кодировки и из них возможно через метод строк encode().

Кортежи

Элементами кортежа могут быть произвольные объекты Python. Кортежи из двух и более элементов создаются списками выражений, разделённых запятыми. Кортеж из одного элемента («синглтон») можно создать, добавив запятую к выражению (выражение само по себе не создаёт кортеж, так как круглые скобки должны использоваться для группировки выражений). Пустой кортеж создаётся пустой парой круглых скобок.

Байты

Объект bytes – это неизменяемый массив. Его элементы – 8-битные байты, представленные целыми числами в диапазоне 0 <= x < 256. Литералы bytes (например, b'abc') и встроенная функция bytes() используются для создания объектов bytes. Кроме того, объекты bytes можно декодировать в строки с помощью метода decode().

Изменяемые последовательности

Изменяемые последовательности могут быть изменены после создания. Обозначения индексации и срезов могут использоваться в качестве цели операторов присваивания и del (удаления).

В настоящее время существует два встроенных изменяемых типа последовательностей:

Списки

Элементами списка являются произвольные объекты Python. Списки создаются путём помещения списка выражений, разделённых запятыми, в квадратные скобки. (Обратите внимание, что для создания списков длины 0 или 1 не требуется особых случаев.)

Байтовые массивы

Объект bytearray является изменяемым массивом. Они создаются с помощью встроенного конструктора bytearray(). Помимо изменяемости (и, следовательно, невозможности хеширования), bytearray в остальном предоставляет тот же интерфейс и функциональность, что и неизменяемые объекты bytes.

Модуль расширения array предоставляет дополнительный пример изменяемого типа последовательности, как и модуль collections.

Типы множеств

Они представляют неупорядоченные, конечные множества уникальных неизменяемых объектов. Как таковые, они не могут индексироваться по подстроке. Однако по ним можно итерироваться, а встроенная функция len() возвращает количество элементов в множестве. Обычные применения множеств – быстрая проверка принадлежности, удаление дубликатов из последовательности и вычисление математических операций, таких как пересечение, объединение, разность и симметрическая разность.

Для элементов множества действуют те же правила неизменяемости, что и для ключей словаря. Обратите внимание, что числовые типы следуют обычным правилам числового сравнения: если два числа считаются равными (например, 1 и 1.0), только одно из них может содержаться в множестве.

В настоящее время существует два встроенных типа множеств:

Множества

Они представляют изменяемое множество. Создаются встроенной функцией-конструктором set() и могут изменяться впоследствии различными методами, например add().

Неизменяемые множества

Они представляют неизменяемое множество. Создаются встроенным конструктором frozenset(). Поскольку frozenset неизменяем и хэшируем, его можно использовать как элемент другого множества или как ключ словаря.

Отображения

Они представляют конечные множества объектов, индексируемых произвольными наборами индексов. Обозначение индекса a[k] выбирает элемент по индексу k из отображения a; это можно использовать в выражениях, а также как цель присваивания или оператора del. Встроенная функция len() возвращает количество элементов в отображении.

В настоящее время существует один встроенный тип отображения:

Словари

Они представляют конечные наборы объектов, индексированных почти произвольными значениями. Единственные типы значений, неприемлемые в качестве ключей, – это значения, содержащие списки, словари или другие изменяемые типы, которые сравниваются по значению, а не по идентичности объекта. Причина в том, что эффективная реализация словарей требует, чтобы хеш-значение ключа оставалось постоянным. Числовые типы, используемые для ключей, подчиняются обычным правилам числового сравнения: если два числа считаются равными (например, 1 и 1.0), то они могут использоваться взаимозаменяемо для индексации одной и той же записи словаря.

Словари изменяемы; их можно создать с помощью обозначения {...} (см. раздел Отображения словарей).

Модули расширения dbm.ndbm и dbm.gnu предоставляют дополнительные примеры типов отображений, как и модуль collections.

Вызываемые типы

Это типы, к которым применима операция вызова функции (см. раздел Вызовы):

Определяемые пользователем функции

Объект пользовательской функции создаётся определением функции (см. раздел Определения функций). Она должна вызываться со списком аргументов, содержащим то же количество элементов, что и список формальных параметров функции.

Специальные атрибуты:

Атрибут Значение  
__doc__ Строка документации функции, или None, если отсутствует. Доступно для записи
__name__ Имя функции Доступно для записи
__module__ Имя модуля, в котором была определена функция, или None, если недоступно Доступно для записи
__defaults__ Кортеж, содержащий значения аргументов по умолчанию для тех аргументов, у которых есть значения по умолчанию, или None, если ни один аргумент не имеет значения по умолчанию Доступно для записи
__code__ Объект кода, представляющий скомпилированное тело функции. Доступно для записи
__globals__ Ссылка на словарь, содержащий глобальные переменные функции – глобальное пространство имён модуля, в котором функция была определена. Только для чтения
__dict__ Пространство имён, поддерживающее произвольные атрибуты функции. Доступно для записи
__closure__ None или кортеж ячеек, содержащих привязки для свободных переменных функции Только для чтения
__annotations__ Словарь, содержащий аннотации параметров. Ключами словаря являются имена параметров или 'return' для аннотации возвращаемого значения, если она указана. Доступно для записи
__kwdefaults__ Словарь, содержащий значения по умолчанию для параметров, передаваемых только по ключу. Доступно для записи

Большинство атрибутов, помеченных как «Доступно для записи», проверяют тип присваиваемого значения.

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

Дополнительную информацию об определении функции можно получить из её объекта code; см. описание внутренних типов ниже.

Методы экземпляра

Объект метода экземпляра сочетает в себе класс, экземпляр класса и любой вызываемый объект (обычно функцию, определённую пользователем).

Специальные атрибуты только для чтения: __self__ – объект экземпляра класса, __func__ – объект функции; __doc__ – документация метода (то же самое, что __func__.__doc__); __name__ – это имя метода (то же самое, что __func__.__name__); __module__ – это имя модуля, в котором был определён метод, или None, если недоступно.

Методы также поддерживают доступ (но не установку) произвольных атрибутов функции на базовом объекте функции.

Объекты пользовательских методов могут создаваться при получении атрибута класса (возможно, через экземпляр этого класса), если этот атрибут является пользовательским объектом функции или объектом метода класса.

Когда объект метода экземпляра создаётся путём получения определённого пользователем объекта функции из класса через один из его экземпляров, его атрибут __self__ является экземпляром, и говорят, что метод является привязанным. Атрибут __func__ нового метода – это исходный объект функции

Когда объект определённого пользователем метода создаётся путём получения другого объекта метода из класса или экземпляра, поведение такое же, как для объекта функции, за исключением того, что атрибут __func__ нового экземпляра – это не исходный объект метода, а его атрибут __func__

Когда объект метода экземпляра создаётся путём получения объекта метода класса из класса или экземпляра, его атрибут __self__ – это сам класс, а его атрибут __func__ – это объект функции, лежащий в основе метода класса

При вызове объекта метода экземпляра вызывается нижележащая функция (__func__), при этом экземпляр класса (__self__) вставляется перед списком аргументов. Например, когда C – это класс, содержащий определение функции f(), и x – это экземпляр C, вызов x.f(1) эквивалентен вызову C.f(x, 1)

Когда объект метода экземпляра создаётся из объекта метода класса, «экземпляр класса», хранящийся в __self__, на самом деле будет самим классом, так что вызов x.f(1) или C.f(1) эквивалентен вызову f(C,1), где f – это нижележащая функция

Обратите внимание, что преобразование объекта функции в объект метода экземпляра происходит каждый раз при получении атрибута из экземпляра. В некоторых случаях полезной оптимизацией является присвоение атрибута локальной переменной и вызов этой локальной переменной. Также заметьте, что это преобразование происходит только для пользовательских функций; другие вызываемые объекты (и все невызываемые объекты) извлекаются без преобразования. Важно также отметить, что пользовательские функции, которые являются атрибутами экземпляра класса, не преобразуются в связанные методы; это происходит только, когда функция является атрибутом класса.

Функции-генераторы

Функция или метод, в котором используется оператор yield (см. раздел Оператор yield), называется функцией-генератором. При вызове такая функция всегда возвращает итератор, который можно использовать для выполнения тела функции: вызов метода __next__() этого итератора заставляет функцию выполняться до тех пор, пока она не предоставит значение с помощью оператора yield. Когда функция выполняет оператор return или завершается естественным образом, возбуждается исключение StopIteration, и итератор достигает конца множества возвращаемых значений.

Встроенные функции

Объект встроенной функции – это обёртка над функцией на C. Примеры встроенных функций: len() и math.sin() (math – это стандартный встроенный модуль). Количество и типы аргументов определяются функцией на C. Специальные атрибуты только для чтения: __doc__ – строка документации функции, или None, если недоступно; __name__ – имя функции; __self__ установлено в None (но см. следующий пункт); __module__ – имя модуля, в котором функция была определена, или None, если недоступно.

Встроенные методы

По сути, это другая разновидность встроенной функции, на этот раз содержащая объект, передаваемый функции на C как неявный дополнительный аргумент. Пример встроенного метода: alist.append(), если предположить, что alist – это объект списка. В этом случае специальный атрибут только для чтения __self__ устанавливается на объект, обозначаемый alist

Классы
Классы вызываемы. Обычно эти объекты действуют как фабрики для создания новых экземпляров самих себя, но возможны варианты для типов классов, которые переопределяют __new__(). Аргументы вызова передаются в __new__() и, в типичном случае, в __init__() для инициализации нового экземпляра
Экземпляры классов
Экземпляры произвольных классов можно сделать вызываемыми, определив метод __call__() в их классе
Модули

Модули импортируются с помощью оператора import (см. раздел Оператор import). Объект модуля имеет пространство имён, реализованное словарём (этот словарь доступен через атрибут __globals__ функций, определённых в модуле). Обращения к атрибутам преобразуются в поиск по этому словарю, например, m.x эквивалентно m.__dict__["x"]. Объект модуля не содержит объект кода, использованный для инициализации модуля (поскольку после завершения инициализации он не нужен).

Присваивание атрибута обновляет словарь пространства имён модуля, например m.x = 1 эквивалентно m.__dict__["x"] = 1.

Специальный атрибут только для чтения: __dict__ – это пространство имён модуля в виде объекта словаря.

Особенность реализации CPython: Из-за того, как CPython очищает словари модулей, словарь модуля будет очищен, когда модуль выйдет из области видимости, даже если на словарь ещё есть активные ссылки. Чтобы этого избежать, скопируйте словарь или держите модуль в памяти, пока используете его словарь напрямую.

Предопределённые (изменяемые) атрибуты: __name__ – имя модуля; __doc__ – строка документации модуля, или None, если недоступна; __file__ – путь к файлу, из которого был загружен модуль, если он загружен из файла. Атрибут __file__ отсутствует для C-модулей, статически скомпонованных с интерпретатором; для модулей расширения, динамически загружаемых из разделяемой библиотеки, это путь к файлу разделяемой библиотеки.

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

Пользовательские типы классов обычно создаются определениями классов (см. раздел Class definitions). Класс имеет пространство имён, реализованное словарём. Ссылки на атрибуты класса преобразуются в поиск по этому словарю, например, C.x преобразуется в C.__dict__["x"] (хотя существуют несколько перехватчиков, позволяющих иные способы поиска атрибутов). Если имя атрибута не найдено там, поиск продолжается в базовых классах. Этот поиск по базовым классам использует C3-линеаризацию (порядок разрешения методов), которая корректно работает даже при наличии «ромбовидной» иерархии наследования, где есть несколько путей наследования к общему предку. Дополнительные сведения о C3 MRO, используемом Python, можно найти в документации к версии 2.3 по адресу http://www.python.org/download/releases/2.3/mro/.

Когда ссылка на атрибут класса (для класса C, скажем) возвращает объект метода класса, он преобразуется в объект метода экземпляра, атрибут __self__ которого равен C. Когда возвращается объект статического метода, он преобразуется в объект, обёрнутый этим статическим методом. См. раздел Реализация дескрипторов для другого способа, которым атрибуты, извлекаемые из класса, могут отличаться от тех, что фактически содержатся в его __dict__.

Присваивание атрибутов класса обновляет словарь самого класса, но никогда не словарь базового класса.

Объект класса можно вызвать (см. выше), чтобы получить экземпляр класса (см. ниже).

Специальные атрибуты: __name__ – имя класса; __module__ – имя модуля, в котором определён класс; __dict__ – словарь, содержащий пространство имён класса; __bases__ – кортеж (возможно пустой или из одного элемента), содержащий базовые классы в порядке их перечисления в списке базовых классов; __doc__ – строка документации класса, или None, если не определена.

Экземпляры классов

Экземпляр класса создаётся вызовом объекта класса (см. выше). Экземпляр класса имеет пространство имён, реализованное в виде словаря, который является первым местом поиска ссылок на атрибуты. Когда атрибут не найден там, а у класса экземпляра есть атрибут с таким именем, поиск продолжается среди атрибутов класса. Если найденный атрибут класса – это объект пользовательской функции, он преобразуется в объект метода экземпляра, атрибут __self__ которого указывает на экземпляр. Объекты статических методов и методов класса также преобразуются; см. выше раздел «Классы». Другой способ, которым атрибуты класса, получаемые через его экземпляры, могут отличаться от реально хранящихся в __dict__ класса, описан в разделе Реализация дескрипторов. Если атрибут класса не найден, а у объекта класса есть метод __getattr__(), он вызывается для завершения поиска.

Назначение и удаление атрибутов изменяют словарь экземпляра, но никогда не словарь класса. Если у класса есть метод __setattr__() или __delattr__(), он вызывается вместо прямого изменения словаря экземпляра.

Экземпляры классов могут вести себя как числа, последовательности или отображения, если у них есть методы с определёнными специальными именами. См. раздел Имена специальных методов.

Специальные атрибуты: __dict__ – словарь атрибутов; __class__ – класс экземпляра.

Объекты ввода-вывода (также известные как файловые объекты)

Файловый объект представляет открытый файл. Для создания файловых объектов доступны различные сокращённые способы: встроенная функция open(), а также os.popen(), os.fdopen() и метод makefile() объектов сокетов (а возможно, и другие функции или методы, предоставляемые модулями расширения).

Объекты sys.stdin, sys.stdout и sys.stderr инициализируются как файловые объекты, соответствующие стандартному потоку ввода, вывода и ошибок интерпретатора; все они открыты в текстовом режиме и, следовательно, следуют интерфейсу, определённому абстрактным классом io.TextIOBase.

Внутренние типы

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

Объекты кода

Объекты кода представляют собой скомпилированный в байт-код исполняемый код Python, или байт-код. Разница между объектом кода и объектом функции в том, что объект функции содержит явную ссылку на глобальные переменные функции (модуль, в котором она определена), тогда как объект кода не содержит контекста; кроме того, значения аргументов по умолчанию хранятся в объекте функции, а не в объекте кода (поскольку они представляют значения, вычисляемые во время выполнения). В отличие от объектов функций, объекты кода неизменяемы и не содержат ссылок (прямых или косвенных) на изменяемые объекты.

Специальные атрибуты только для чтения: co_name – имя функции; co_argcount – количество позиционных аргументов (включая аргументы со значениями по умолчанию); co_nlocals – количество локальных переменных, используемых функцией (включая аргументы); co_varnames – кортеж имён локальных переменных (начиная с имён аргументов); co_cellvars – кортеж имён локальных переменных, на которые ссылаются вложенные функции; co_freevars – кортеж имён свободных переменных; co_code – строка, представляющая последовательность инструкций байткода; co_consts – кортеж литералов, используемых байткодом; co_names – кортеж имён, используемых байткодом; co_filename – имя файла, из которого был скомпилирован код; co_firstlineno – номер первой строки функции; co_lnotab – строка, кодирующая соответствие между смещениями в байткоде и номерами строк (подробнее см. исходный код интерпретатора); co_stacksize – требуемый размер стека (включая локальные переменные); co_flags – целое число, кодирующее ряд флагов для интерпретатора.

Для co_flags определены следующие биты флагов: бит 0x04 установлен, если функция использует синтаксис *arguments для приёма произвольного количества позиционных аргументов; бит 0x08 установлен, если функция использует синтаксис **keywords для приёма произвольных именованных аргументов; бит 0x20 установлен, если функция является генератором.

Объявления будущих возможностей (from __future__ import division) также используют биты в co_flags, чтобы указать, был ли объект кода скомпилирован с определённой включённой возможностью: бит 0x2000 установлен, если функция была скомпилирована с включённым future division; биты 0x10 и 0x1000 использовались в более ранних версиях Python.

Остальные биты в co_flags зарезервированы для внутреннего использования.

Если объект кода представляет функцию, первый элемент в co_consts – это строка документации функции или None, если не определена.

Объекты фреймов

Объекты фреймов представляют фреймы выполнения. Они могут встречаться в объектах трассировки стека (см. ниже).

Специальные атрибуты только для чтения: f_back – ссылка на предыдущий фрейм стека (в сторону вызвавшего), или None, если это нижний фрейм; f_code – объект кода, выполняемый в этом фрейме; f_locals – словарь, используемый для поиска локальных переменных; f_globals – словарь для глобальных переменных; f_builtins – словарь для встроенных имён; f_lasti – точная инструкция (индекс в строке байткода объекта кода).

Специальные изменяемые атрибуты: f_trace, если не None, – это функция, вызываемая в начале каждой строки исходного кода (используется отладчиком); f_lineno – текущий номер строки фрейма – запись в него изнутри трассировочной функции переходит на указанную строку (только для самого нижнего фрейма). Отладчик может реализовать команду Jump (также называемую Set Next Statement) записью в f_lineno.

Объекты трассировки стека

Объекты traceback представляют стек вызовов исключения. Объект traceback создаётся при возникновении исключения. Когда поиск обработчика исключения разворачивает стек выполнения, на каждом раскрученном уровне объект traceback вставляется перед текущим traceback. Когда обработчик исключения входит в работу, стек вызовов становится доступен программе. (См. раздел Оператор try.) Он доступен как третий элемент кортежа, возвращаемого sys.exc_info(). Когда программа не содержит подходящего обработчика, стек вызовов выводится (в отформатированном виде) в стандартный поток ошибок; если интерпретатор работает в интерактивном режиме, он также становится доступен пользователю как sys.last_traceback.

Специальные атрибуты только для чтения: tb_next – следующий уровень в стеке вызовов (в сторону фрейма, где произошло исключение), или None, если следующего уровня нет; tb_frame указывает на фрейм выполнения текущего уровня; tb_lineno – номер строки, в которой произошло исключение; tb_lasti – точная инструкция. Номер строки и последняя инструкция в traceback могут отличаться от номера строки его объекта фрейма, если исключение произошло в операторе try без подходящего except-предложения или с finally-предложением.

Объекты срезов

Объекты срезов используются для представления срезов в методах __getitem__(). Они также создаются встроенной функцией slice().

Специальные атрибуты только для чтения: start – нижняя граница; stop – верхняя граница; step – шаг; каждый из них равен None, если опущен. Эти атрибуты могут иметь любой тип.

Объекты slice поддерживают один метод:

slice.indices(self, length)
Этот метод принимает единственный целочисленный аргумент length и вычисляет информацию о срезе, который объект среза описывал бы, если бы был применен к последовательности из length элементов. Он возвращает кортеж из трех целых чисел; соответственно это индексы start и stop, а также step или длина шага среза. Пропущенные или выходящие за границы индексы обрабатываются так же, как и для обычных срезов.
Объекты статических методов
Статические методы предоставляют способ предотвратить преобразование объектов функций в объекты методов, описанное выше. Объект статического метода – это обёртка вокруг любого другого объекта, обычно пользовательского метода. Когда объект статического метода извлекается из класса или экземпляра класса, фактически возвращается обёрнутый объект, который не подвергается дальнейшим преобразованиям. Сами объекты статических методов не являются вызываемыми, хотя объекты, которые они оборачивают, обычно вызываемы. Объекты статических методов создаются встроенным конструктором staticmethod().
Объекты методов классов
Объект метода класса, как и объект статического метода, является обёрткой вокруг другого объекта, изменяющей способ извлечения этого объекта из классов и экземпляров классов. Поведение объектов методов класса при таком извлечении описано выше, в разделе «Пользовательские методы». Объекты методов класса создаются встроенным конструктором classmethod().

3.3. Имена специальных методовSpecial method names

Класс может реализовать определённые операции, вызываемые специальным синтаксисом (например, арифметические операции или индексация и срезы), определяя методы со специальными именами. Это подход Python к перегрузке операторов, позволяющий классам определять собственное поведение в отношении операторов языка. Например, если класс определяет метод с именем __getitem__(), и x – экземпляр этого класса, то x[i] примерно эквивалентно type(x).__getitem__(x, i). Если не указано иное, попытка выполнить операцию при отсутствии соответствующего метода вызывает исключение (обычно AttributeError или TypeError).

При реализации класса, имитирующего какой-либо встроенный тип, важно, чтобы имитация реализовывалась лишь в той степени, в которой это имеет смысл для моделируемого объекта. Например, некоторые последовательности могут хорошо работать с извлечением отдельных элементов, но извлечение среза может не иметь смысла. (Один из примеров – интерфейс NodeList из объектной модели документов W3C.)

3.3.1. Базовая настройкаBasic customization

object.__new__(cls[, ...])

Вызывается для создания нового экземпляра класса cls. __new__() – это статический метод (обрабатывается особым образом, так что объявлять его таковым не требуется), который первым аргументом принимает класс, экземпляр которого запрашивается. Остальные аргументы – те, что переданы выражению конструктора объекта (вызову класса). Возвращаемое значение __new__() должно быть новым экземпляром объекта (обычно экземпляром cls).

Типичные реализации создают новый экземпляр класса, вызывая метод __new__() суперкласса через super(currentclass, cls).__new__(cls[, ...]) с соответствующими аргументами, а затем модифицируя вновь созданный экземпляр по мере необходимости перед возвратом.

Если __new__() возвращает экземпляр cls, то метод __init__() нового экземпляра будет вызван как __init__(self[, ...]), где self – новый экземпляр, а остальные аргументы – те же, что были переданы в __new__().

Если __new__() не возвращает экземпляр cls, то метод __init__() нового экземпляра не будет вызван.

__new__() в первую очередь предназначен для того, чтобы подклассы неизменяемых типов (например, int, str или tuple) могли настраивать создание экземпляров. Он также часто переопределяется в пользовательских метаклассах для настройки создания классов.

object.__init__(self[, ...])

Вызывается при создании экземпляра. Аргументами являются те, что передаются в выражение конструктора класса. Если у базового класса есть метод __init__(), то метод __init__() производного класса (если он определён) должен явно вызывать его для обеспечения правильной инициализации части экземпляра, относящейся к базовому классу; например: BaseClass.__init__(self, [args...]). В качестве особого ограничения для конструкторов: они не должны возвращать никакого значения; попытка вернуть значение вызовет TypeError во время выполнения.

object.__del__(self)

Вызывается, когда экземпляр собирается быть уничтожен. Это также называется деструктором. Если базовый класс имеет метод __del__(), то метод __del__() производного класса (если он есть) должен явно вызвать его, чтобы обеспечить правильное удаление базовой части экземпляра. Обратите внимание, что метод __del__() может (хотя это и не рекомендуется!) отложить уничтожение экземпляра, создав на него новую ссылку. Тогда он будет вызван позже, когда эта новая ссылка будет удалена. Не гарантируется, что методы __del__() будут вызваны для объектов, которые все еще существуют при завершении интерпретатора.

Примечание

del x не вызывает напрямую x.__del__() – первая конструкция уменьшает счётчик ссылок на x на единицу, а вторая вызывается только когда счётчик ссылок x достигает нуля. Некоторые типичные ситуации, которые могут помешать счётчику ссылок объекта достичь нуля, включают: циклические ссылки между объектами (например, двусвязный список или древовидная структура данных с указателями на родителя и потомка); ссылка на объект в стековом кадре функции, перехватившей исключение (трассировка, сохранённая в sys.exc_info()[2], поддерживает стековый кадр живым); или ссылка на объект в стековом кадре, возбудившем необработанное исключение в интерактивном режиме (трассировка, сохранённая в sys.last_traceback, поддерживает стековый кадр живым). Первая ситуация может быть исправлена только явным разрывом циклов; две последние ситуации можно решить, сохранив None в sys.last_traceback. Циклические ссылки, ставшие мусором, обнаруживаются, когда включён детектор циклов (по умолчанию он включён), но могут быть удалены, только если в них не задействованы методы __del__() уровня Python. Обратитесь к документации модуля gc за дополнительной информацией о том, как детектор циклов обрабатывает методы __del__(), в частности к описанию значения garbage.

Предупреждение

Из-за ненадежных обстоятельств, при которых вызываются методы __del__(), исключения, возникающие во время их выполнения, игнорируются, а вместо этого предупреждение выводится в sys.stderr. Кроме того, когда __del__() вызывается в ответ на удаление модуля (например, при завершении программы), другие глобальные переменные, на которые ссылается метод __del__(), могут уже быть удалены или находиться в процессе уничтожения (например, механизм импорта завершает работу). По этой причине методы __del__() должны делать абсолютный минимум, необходимый для поддержания внешних инвариантов. Начиная с версии 1.5, Python гарантирует, что глобальные переменные, имена которых начинаются с одного подчеркивания, удаляются из своего модуля до удаления других глобальных переменных; если других ссылок на такие глобалы не существует, это может помочь обеспечить доступность импортированных модулей на момент вызова метода __del__().

object.__repr__(self)

Вызывается встроенной функцией repr() для вычисления «официального» строкового представления объекта. По возможности это представление должно выглядеть как допустимое выражение Python, которое можно использовать для воссоздания объекта с тем же значением (при наличии подходящего окружения). Если это невозможно, следует вернуть строку вида <...какое-нибудь полезное описание...>. Возвращаемое значение должно быть строкой. Если класс определяет __repr__(), но не __str__(), то __repr__() также используется, когда требуется «неформальное» строковое представление экземпляров этого класса.

Обычно используется для отладки, поэтому важно, чтобы представление было информативным и однозначным.

object.__str__(self)

Вызывается встроенной функцией str() и функцией print() для получения «неформального» строкового представления объекта. Отличается от __repr__() тем, что возвращаемое значение не обязано быть корректным выражением Python: вместо этого можно использовать более удобное или краткое представление. Возвращаемое значение должно быть строковым объектом.

object.__format__(self, format_spec)

Вызывается встроенной функцией format() (и, соответственно, методом format() класса str) для получения «форматированного» строкового представления объекта. Аргумент format_spec – это строка, содержащая описание желаемых параметров форматирования. Интерпретация аргумента format_spec зависит от типа, реализующего __format__(); однако большинство классов либо делегирует форматирование одному из встроенных типов, либо использует аналогичный синтаксис параметров форматирования.

См. мини-язык спецификации формата для описания стандартного синтаксиса форматирования.

Возвращаемое значение должно быть строковым объектом.

object.__lt__(self, other)
object.__le__(self, other)
object.__eq__(self, other)
object.__ne__(self, other)
object.__gt__(self, other)
object.__ge__(self, other)

Это так называемые методы «богатого сравнения». Соответствие между символами операторов и именами методов следующее: x<y вызывает x.__lt__(y), x<=y вызывает x.__le__(y), x==y вызывает x.__eq__(y), x!=y вызывает x.__ne__(y), x>y вызывает x.__gt__(y), а x>=y вызывает x.__ge__(y).

Метод богатого сравнения может вернуть синглтон NotImplemented, если он не реализует операцию для данной пары аргументов. По соглашению, при успешном сравнении возвращаются False и True. Однако эти методы могут возвращать любое значение, поэтому если оператор сравнения используется в логическом контексте (например, в условии оператора if), Python вызовет bool() для этого значения, чтобы определить, истинно оно или ложно.

Неявных отношений между операторами сравнения не существует. Истинность x==y не означает, что x!=y ложно. Соответственно, при определении __eq__() следует также определить __ne__(), чтобы операторы вели себя как ожидается. Обратитесь к параграфу о __hash__() для важных замечаний по созданию хэшируемых объектов, которые поддерживают пользовательские операции сравнения и могут использоваться как ключи словаря.

Перевёрнутых версий этих методов (используемых, когда левый аргумент не поддерживает операцию, а правый поддерживает) не существует; скорее, __lt__() и __gt__() являются зеркальными отражениями друг друга, __le__() и __ge__() – тоже, а __eq__() и __ne__() являются собственными отражениями.

Аргументы методов расширенного сравнения никогда не приводятся.

Чтобы автоматически генерировать операции упорядочивания из одной корневой операции, см. рецепт Total Ordering в поваренной книге ASPN.

object.__hash__(self)

Вызывается встроенной функцией hash(), а также для операций над элементами хешируемых коллекций, включая set, frozenset и dict. __hash__() должна возвращать целое число. Единственное обязательное свойство: объекты, которые сравниваются как равные, должны иметь одинаковое хеш-значение; рекомендуется каким-то образом смешивать (например, с помощью исключающего ИЛИ) хеш-значения тех компонентов объекта, которые также участвуют в сравнении объектов.

Если класс не определяет метод __eq__(), он не должен определять и операцию __hash__(); если он определяет __eq__(), но не __hash__(), его экземпляры нельзя будет использовать как элементы в хешируемых коллекциях. Если класс определяет изменяемые объекты и реализует метод __eq__(), он не должен реализовывать __hash__(), поскольку реализация хешируемых коллекций требует, чтобы хеш-значение ключа было неизменным (если хеш-значение объекта изменится, он окажется не в той хеш-корзине).

Пользовательские классы по умолчанию имеют методы __eq__() и __hash__(); с их помощью все объекты сравниваются как неравные (кроме сравнения с самим собой), а x.__hash__() возвращает id(x).

Классы, которые наследуют метод __hash__() от родительского класса, но изменяют смысл __eq__() таким образом, что возвращаемое хеш-значение перестаёт быть подходящим (например, переключаясь на основанное на значении понятие равенства вместо стандартного основанного на идентичности), могут явно указать, что они нехешируемы, установив __hash__ = None в определении класса. Это означает, что не только экземпляры класса будут возбуждать соответствующее TypeError при попытке программы получить их хеш-значение, но и будут корректно определяться как нехешируемые при проверке isinstance(obj, collections.Hashable) (в отличие от классов, которые определяют собственный __hash__(), чтобы явно возбуждать TypeError).

Если класс, который переопределяет __eq__(), должен сохранить реализацию __hash__() от родительского класса, интерпретатору необходимо явно указать это, установив __hash__ = <ParentClass>.__hash__. В противном случае наследование __hash__() будет заблокировано, как если бы __hash__ был явно установлен в None.

См. также опцию командной строки -R.

object.__bool__(self)

Вызывается для реализации проверки истинности и встроенной операции bool(); должна возвращать False или True. Если этот метод не определён, вызывается __len__() (если он определён), и объект считается истинным, если его результат не равен нулю. Если класс не определяет ни __len__(), ни __bool__(), все его экземпляры считаются истинными.

3.3.2. Настройка доступа к атрибутамCustomizing attribute access

Следующие методы могут быть определены для настройки смысла доступа к атрибутам (использование, присваивание или удаление x.name) для экземпляров классов.

object.__getattr__(self, name)

Вызывается, когда поиск атрибута не нашёл его в обычных местах (то есть это не атрибут экземпляра и он не найден в дереве классов для self). name – имя атрибута. Этот метод должен возвращать (вычисленное) значение атрибута или вызывать исключение AttributeError.

Обратите внимание, что если атрибут найден через обычный механизм, __getattr__() не вызывается. (Это намеренная асимметрия между __getattr__() и __setattr__().) Это сделано как из соображений эффективности, так и потому, что иначе __getattr__() не имел бы способа получить доступ к другим атрибутам экземпляра. Также учтите, что по крайней мере для переменных экземпляра можно имитировать полный контроль, не вставляя никакие значения в словарь атрибутов экземпляра (а вставляя их в другой объект). См. метод __getattribute__() ниже, чтобы узнать, как на самом деле получить полный контроль над доступом к атрибутам.

object.__getattribute__(self, name)

Вызывается безусловно для реализации доступа к атрибутам экземпляров класса. Если класс также определяет __getattr__(), последний не будет вызван, если только __getattribute__() не вызовет его явно или не вызовет исключение AttributeError. Этот метод должен возвращать (вычисленное) значение атрибута или вызывать исключение AttributeError. Чтобы избежать бесконечной рекурсии в этом методе, его реализация должна всегда вызывать метод базового класса с тем же именем для доступа к любым необходимым атрибутам, например, object.__getattribute__(self, name).

Примечание

Этот метод всё равно может быть обойдён при поиске специальных методов в результате неявного вызова через синтаксис языка или встроенные функции. См. Поиск специальных методов.

object.__setattr__(self, name, value)

Вызывается при попытке присвоения атрибута. Этот метод вызывается вместо обычного механизма (т.е. сохранения значения в словаре экземпляра). name – имя атрибута, value – значение, которое ему присваивается.

Если __setattr__() хочет присвоить значение атрибуту экземпляра, он должен вызвать метод базового класса с тем же именем, например, object.__setattr__(self, name, value).

object.__delattr__(self, name)
Действует как __setattr__(), но для удаления атрибута, а не присваивания. Следует реализовывать только если del obj.name имеет смысл для объекта.
object.__dir__(self)
Вызывается, когда для объекта вызывается dir(). Должен возвращать список.

3.3.2.1. Реализация дескрипторовImplementing Descriptors

Следующие методы применяются только тогда, когда экземпляр класса, содержащего метод (так называемый класс-дескриптор), появляется в классе-владельце (дескриптор должен находиться либо в словаре класса владельца, либо в словаре класса одного из его родителей). В приведённых ниже примерах «атрибут» относится к атрибуту, имя которого является ключом свойства в __dict__ класса-владельца.

object.__get__(self, instance, owner)
Вызывается для получения атрибута класса-владельца (доступ к атрибуту класса) или экземпляра этого класса (доступ к атрибуту экземпляра). owner всегда является классом-владельцем, а instance – экземпляр, через который был получен доступ к атрибуту, или None, если атрибут получен через owner. Этот метод должен возвращать (вычисленное) значение атрибута или вызывать исключение AttributeError.
object.__set__(self, instance, value)
Вызывается для установки атрибута экземпляра instance класса-владельца в новое значение value.
object.__delete__(self, instance)
Вызывается для удаления атрибута экземпляра instance класса-владельца.

3.3.2.2. Вызов дескрипторовInvoking Descriptors

В общем случае дескриптор – это атрибут объекта с «поведением привязки», доступ к которому переопределён методами протокола дескриптора: __get__(), __set__() и __delete__(). Если для объекта определён хотя бы один из этих методов, он считается дескриптором.

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

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

Отправная точка для вызова дескриптора – это привязка, a.x. Как собираются аргументы, зависит от a.

Прямой вызов
Самый простой и самый редкий вызов – когда пользовательский код напрямую вызывает метод дескриптора: x.__get__(a).
Привязка к экземпляру
При привязке к экземпляру объекта a.x преобразуется в вызов: type(a).__dict__['x'].__get__(a, type(a)).
Привязка к классу
При привязке к классу A.x преобразуется в вызов: A.__dict__['x'].__get__(None, A).
Привязка через super
Если a является экземпляром super, то привязка super(B, obj).m() ищет в obj.__class__.__mro__ базовый класс A, непосредственно предшествующий B, и затем вызывает дескриптор вызовом: A.__dict__['m'].__get__(obj, obj.__class__).

Для привязок к экземплярам приоритет вызова дескриптора зависит от того, какие методы дескриптора определены. Дескриптор может определить любую комбинацию из __get__(), __set__() и __delete__(). Если он не определяет __get__(), то обращение к атрибуту вернёт сам объект дескриптора, если только в словаре экземпляра объекта нет соответствующего значения. Если дескриптор определяет __set__() и/или __delete__(), это дескриптор данных; если он не определяет ни одного из них, это дескриптор не-данных. Обычно дескрипторы данных определяют как __get__(), так и __set__(), в то время как дескрипторы не-данных имеют только метод __get__(). Дескрипторы данных с определёнными __set__() и __get__() всегда переопределяют переопределение в словаре экземпляра. В отличие от них, дескрипторы не-данных могут быть переопределены экземплярами.

Методы Python (включая staticmethod() и classmethod()) реализованы как дескрипторы не-данных. Соответственно, экземпляры могут переопределять методы. Это позволяет отдельным экземплярам приобретать поведение, отличное от других экземпляров того же класса.

Функция property() реализована как дескриптор данных. Соответственно, экземпляры не могут переопределить поведение свойства.

3.3.2.3. __slots__

По умолчанию экземпляры классов имеют словарь для хранения атрибутов. Это расходует память для объектов с очень небольшим количеством переменных экземпляра. Расход памяти может стать критическим при создании большого числа экземпляров.

Поведение по умолчанию можно переопределить, определив __slots__ в определении класса. Объявление __slots__ принимает последовательность переменных экземпляра и резервирует ровно столько памяти в каждом экземпляре, чтобы хранить значение для каждой переменной. Память экономится, поскольку __dict__ не создаётся для каждого экземпляра.

object.__slots__
Этой переменной класса можно присвоить строку, итерируемый объект или последовательность строк с именами переменных, используемых экземплярами. Если определена в классе, __slots__ резервирует место для объявленных переменных и предотвращает автоматическое создание __dict__ и __weakref__ для каждого экземпляра.
3.3.2.3.1. Примечания по использованию __slots__Notes on using __slots__
  • При наследовании от класса без __slots__ атрибут __dict__ этого класса всегда будет доступен, поэтому определение __slots__ в подклассе не имеет смысла.
  • Без переменной __dict__ экземплярам нельзя присваивать новые переменные, не перечисленные в определении __slots__. Попытка присвоить имя переменной, не входящей в список, вызывает AttributeError. Если требуется динамическое присваивание новых переменных, добавьте '__dict__' в последовательность строк в объявлении __slots__.
  • Без переменной __weakref__ для каждого экземпляра классы, определяющие __slots__, не поддерживают слабые ссылки на свои экземпляры. Если требуется поддержка слабых ссылок, добавьте '__weakref__' в последовательность строк в объявлении __slots__.
  • __slots__ реализуются на уровне класса путём создания дескрипторов (Реализация дескрипторов) для каждого имени переменной. В результате атрибуты класса нельзя использовать для установки значений по умолчанию для переменных экземпляра, определённых __slots__; в противном случае атрибут класса перезаписал бы присваивание дескриптора.
  • Действие объявления __slots__ ограничено классом, в котором оно определено. В результате подклассы будут иметь __dict__, если только они также не определят __slots__ (который должен содержать только имена дополнительных слотов).
  • Если класс определяет слот, который также определён в базовом классе, переменная экземпляра, определённая слотом базового класса, становится недоступной (за исключением прямого получения её дескриптора из базового класса). Это делает поведение программы неопределённым. В будущем может быть добавлена проверка для предотвращения такой ситуации.
  • Непустой __slots__ не работает для классов, производных от встроенных типов с «переменной длиной», таких как int, str и tuple.
  • Любому итерируемому объекту, не являющемуся строкой, может быть присвоено __slots__. Также могут использоваться отображения; однако в будущем значениям, соответствующим каждому ключу, может быть присвоен особый смысл.
  • Присваивание __class__ работает, только если оба класса имеют одинаковые __slots__.

3.3.3. Настройка создания классовCustomizing class creation

По умолчанию классы создаются с помощью type(). Определение класса читается в отдельное пространство имён, и имя класса связывается с результатом type(name, bases, dict).

Когда определение класса обрабатывается, если после базовых классов указан именованный аргумент metaclass, то вместо type() будет вызван переданный вызываемый объект. Если переданы другие именованные аргументы, они также будут переданы метаклассу. Это позволяет писать классы или функции, которые отслеживают или изменяют процесс создания класса:

  • Изменение словаря класса до его создания.
  • Возврат экземпляра другого класса – по сути выполнение роли фабричной функции.

Эти шаги должны выполняться в методе __new__() метакласса – затем из этого метода можно вызвать type.__new__(), чтобы создать класс с другими свойствами. В этом примере в словарь класса добавляется новый элемент перед его созданием:

class metacls(type):
    def __new__(mcs, name, bases, dict):
        dict['foo'] = 'metacls was here'
        return type.__new__(mcs, name, bases, dict)

Разумеется, можно также переопределять другие методы класса (или добавлять новые); например, определение пользовательского метода __call__() в метаклассе позволяет задать особое поведение при вызове класса, например не всегда создавать новый экземпляр.

Если у метакласса есть атрибут __prepare__() (обычно реализованный как метод класса или статический метод), он вызывается до вычисления тела класса с именем класса и кортежем его базовых классов в качестве аргументов. Он должен вернуть объект, поддерживающий интерфейс отображения, который будет использоваться для хранения пространства имён класса. По умолчанию это обычный словарь. Это можно использовать, например, для отслеживания порядка объявления атрибутов класса, возвращая упорядоченный словарь.

Подходящий метакласс определяется следующими правилами приоритета:

  • Если вместе с базовыми классами передан именованный аргумент metaclass, то используется он.
  • В противном случае, если есть хотя бы один базовый класс, используется его метакласс.
  • В противном случае используется метакласс по умолчанию (type).

Потенциальные применения метаклассов безграничны. Некоторые из изученных идей включают логирование, проверку интерфейсов, автоматическое делегирование, автоматическое создание свойств, прокси, фреймворки и автоматическую блокировку/синхронизацию ресурсов.

Вот пример метакласса, который использует collections.OrderedDict для запоминания порядка, в котором были определены члены класса:

class OrderedClass(type):

     @classmethod
     def __prepare__(metacls, name, bases, **kwds):
        return collections.OrderedDict()

     def __new__(cls, name, bases, classdict):
        result = type.__new__(cls, name, bases, dict(classdict))
        result.members = tuple(classdict)
        return result

class A(metaclass=OrderedClass):
    def one(self): pass
    def two(self): pass
    def three(self): pass
    def four(self): pass

>>> A.members
('__module__', 'one', 'two', 'three', 'four')

Когда выполняется определение класса для A, процесс начинается с вызова метода метакласса __prepare__(), который возвращает пустой collections.OrderedDict. Это отображение записывает методы и атрибуты A по мере их определения в теле оператора класса. Как только эти определения выполнены, упорядоченный словарь полностью заполняется, и вызывается метод метакласса __new__(). Этот метод создаёт новый тип и сохраняет ключи упорядоченного словаря в атрибуте с именем members.

3.3.4. Настройка проверок экземпляров и подклассовCustomizing instance and subclass checks

Следующие методы используются для переопределения поведения по умолчанию встроенных функций isinstance() и issubclass().

В частности, метакласс abc.ABCMeta реализует эти методы, чтобы разрешить добавление абстрактных базовых классов (ABC) в качестве «виртуальных базовых классов» к любому классу или типу (включая встроенные типы), в том числе к другим ABC.

class.__instancecheck__(self, instance)
Возвращает true, если instance должен считаться (прямым или косвенным) экземпляром class. Если определён, вызывается для реализации isinstance(instance, class).
class.__subclasscheck__(self, subclass)
Возвращает true, если subclass должен считаться (прямым или косвенным) подклассом class. Если определён, вызывается для реализации issubclass(subclass, class).

Обратите внимание, что эти методы ищутся на типе (метаклассе) класса. Их нельзя определить как методы класса в самом классе. Это согласуется с поиском специальных методов, которые вызываются на экземплярах, только в данном случае экземпляром является сам класс.

См. также

PEP 3119 – Введение абстрактных базовых классов
Содержит спецификацию настройки поведения isinstance() и issubclass() через методы __instancecheck__() и __subclasscheck__(), а также обоснование этой функциональности в контексте добавления абстрактных базовых классов (см. модуль abc) в язык.

3.3.5. Эмуляция вызываемых объектовEmulating callable objects

object.__call__(self[, args...])

Вызывается, когда экземпляр «вызывается» как функция; если этот метод определён, x(arg1, arg2, ...) является краткой записью для x.__call__(arg1, arg2, ...).

3.3.6. Эмуляция типов-контейнеровEmulating container types

Следующие методы можно определить для реализации объектов-контейнеров. Контейнеры обычно – это последовательности (например, списки или кортежи) или отображения (например, словари), но могут представлять и другие контейнеры. Первый набор методов используется для эмуляции последовательности или отображения; разница в том, что для последовательности допустимыми ключами должны быть целые числа k, для которых 0 <= k < N, где N – длина последовательности, или объекты среза, задающие диапазон элементов. Также рекомендуется, чтобы отображения предоставляли методы keys(), values(), items(), get(), clear(), setdefault(), pop(), popitem(), copy() и update(), поведение которых аналогично соответствующим методам стандартного словаря Python. Модуль collections предоставляет абстрактный базовый класс MutableMapping помогающий создать эти методы на основе базового набора __getitem__(), __setitem__(), __delitem__() и keys(). Изменяемые последовательности должны предоставлять методы append(), count(), index(), extend(), insert(), pop(), remove(), reverse() и sort(), как стандартные объекты списков Python. Наконец, типы последовательностей должны реализовывать сложение (означающее конкатенацию) и умножение (означающее повторение), определяя методы __add__(), __radd__(), __iadd__(), __mul__(), __rmul__() и __imul__(), описанные ниже; они не должны определять другие числовые операторы. Рекомендуется, чтобы и отображения, и последовательности реализовывали метод __contains__() для эффективного использования оператора in; для отображений in должен искать по ключам отображения; для последовательностей – по значениям. Также рекомендуется, чтобы и отображения, и последовательности реализовывали метод __iter__() для эффективной итерации по контейнеру; для отображений __iter__() должен быть эквивалентен keys(); для последовательностей – итерация по значениям.

object.__len__(self)

Вызывается для реализации встроенной функции len(). Должен возвращать длину объекта – целое число >= 0. Кроме того, объект, не определяющий метод __bool__() и у которого метод __len__() возвращает ноль, считается ложным в логическом контексте.

Примечание

Срез выполняется исключительно с помощью следующих трёх методов. Вызов вида

a[1:2] = b

преобразуется в

a[slice(1, 2, None)] = b

и так далее. Пропущенные элементы среза всегда заполняются None.

object.__getitem__(self, key)

Вызывается для вычисления self[key]. Для типов последовательностей допустимыми ключами должны быть целые числа и объекты срезов. Обратите внимание, что специальная интерпретация отрицательных индексов (если класс хочет эмулировать тип последовательности) возлагается на метод __getitem__(). Если key имеет неподходящий тип, может быть вызвано TypeError; если значение выходит за пределы множества индексов последовательности (после любой специальной интерпретации отрицательных значений), должно быть вызвано IndexError. Для типов отображений, если key отсутствует (не находится в контейнере), должно быть вызвано KeyError.

Примечание

Циклы for ожидают, что для недопустимых индексов будет вызвано IndexError, чтобы обеспечить корректное обнаружение конца последовательности.

object.__setitem__(self, key, value)
Вызывается для реализации присваивания self[key]. Те же замечания, что и для __getitem__(). Следует реализовывать только для отображений, если объекты поддерживают изменение значений по ключам или добавление новых ключей, или для последовательностей, если элементы могут быть заменены. Для неправильных значений key следует вызывать те же исключения, что и для метода __getitem__().
object.__delitem__(self, key)
Вызывается для реализации удаления self[key]. Те же замечания, что и для __getitem__(). Следует реализовывать только для отображений, если объекты поддерживают удаление ключей, или для последовательностей, если элементы могут быть удалены из последовательности. Для неправильных значений key следует вызывать те же исключения, что и для метода __getitem__().
object.__iter__(self)

Этот метод вызывается, когда для контейнера требуется итератор. Он должен возвращать новый объект-итератор, способный перебирать все объекты в контейнере. Для отображений он должен перебирать ключи контейнера, а также быть доступным в качестве метода keys().

Объекты-итераторы также должны реализовывать этот метод; они обязаны возвращать самих себя. Для получения дополнительной информации об объектах-итераторах см. Типы итераторов.

object.__reversed__(self)

Вызывается (если присутствует) встроенной функцией reversed() для реализации обратной итерации. Должен возвращать новый объект-итератор, который перебирает все объекты в контейнере в обратном порядке.

Если метод __reversed__() не предоставлен, встроенная функция reversed() вернется к использованию протокола последовательности (__len__() и __getitem__()). Объекты, поддерживающие протокол последовательности, должны предоставлять __reversed__() только в том случае, если они могут дать реализацию, более эффективную, чем предоставленная функцией reversed().

Операторы проверки принадлежности (in и not in) обычно реализуются как итерация по последовательности. Однако объекты-контейнеры могут предоставить следующий специальный метод с более эффективной реализацией, которая также не требует, чтобы объект был последовательностью.

object.__contains__(self, item)

Вызывается для реализации операторов проверки вхождения. Должен возвращать true, если элемент находится в self, и false в противном случае. Для объектов-отображений следует учитывать ключи отображения, а не значения или пары ключ-значение.

Для объектов, не определяющих __contains__(), проверка принадлежности сначала пытается итерироваться через __iter__(), затем через старый протокол итерации последовательности через __getitem__(); см. этот раздел в справочнике по языку.

3.3.7. Эмуляция числовых типовEmulating numeric types

Следующие методы можно определить для эмуляции числовых объектов. Методы, соответствующие операциям, которые не поддерживаются конкретным типом реализуемого числа (например, побитовые операции для нецелых чисел), следует оставить неопределёнными.

object.__add__(self, other)
object.__sub__(self, other)
object.__mul__(self, other)
object.__truediv__(self, other)
object.__floordiv__(self, other)
object.__mod__(self, other)
object.__divmod__(self, other)
object.__pow__(self, other[, modulo])
object.__lshift__(self, other)
object.__rshift__(self, other)
object.__and__(self, other)
object.__xor__(self, other)
object.__or__(self, other)

Эти методы вызываются для реализации бинарных арифметических операций (+, -, *, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |). Например, для вычисления выражения x + y, где x – экземпляр класса, у которого есть метод __add__(), вызывается x.__add__(y). Метод __divmod__() должен быть эквивалентен использованию __floordiv__() и __mod__(); он не должен быть связан с __truediv__(). Обратите внимание, что __pow__() должен быть определён так, чтобы принимать необязательный третий аргумент, если требуется поддержка троичной версии встроенной функции pow().

Если один из этих методов не поддерживает операцию с переданными аргументами, он должен возвращать NotImplemented.

object.__radd__(self, other)
object.__rsub__(self, other)
object.__rmul__(self, other)
object.__rtruediv__(self, other)
object.__rfloordiv__(self, other)
object.__rmod__(self, other)
object.__rdivmod__(self, other)
object.__rpow__(self, other)
object.__rlshift__(self, other)
object.__rrshift__(self, other)
object.__rand__(self, other)
object.__rxor__(self, other)
object.__ror__(self, other)

Эти методы вызываются для реализации бинарных арифметических операций (+, -, *, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |) с отражёнными (переставленными) операндами. Эти функции вызываются только в том случае, если левый операнд не поддерживает соответствующую операцию и операнды имеют разные типы. [2] Например, для вычисления выражения x - y, где y – экземпляр класса, у которого есть метод __rsub__(), вызывается y.__rsub__(x), если x.__sub__(y) возвращает NotImplemented.

Обратите внимание, что троичная pow() не будет пытаться вызывать __rpow__() (правила приведения типов стали бы слишком сложными).

Примечание

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

object.__iadd__(self, other)
object.__isub__(self, other)
object.__imul__(self, other)
object.__itruediv__(self, other)
object.__ifloordiv__(self, other)
object.__imod__(self, other)
object.__ipow__(self, other[, modulo])
object.__ilshift__(self, other)
object.__irshift__(self, other)
object.__iand__(self, other)
object.__ixor__(self, other)
object.__ior__(self, other)
Эти методы вызываются для реализации составных арифметических присваиваний (+=, -=, *=, /=, //=, %=, **=, <<=, >>=, &=, ^=, |=). Эти методы должны пытаться выполнить операцию на месте (изменяя self) и возвращать результат (который может быть, но не обязан быть self). Если конкретный метод не определён, составное присваивание использует обычные методы. Например, для выполнения выражения x += y, где x – экземпляр класса, у которого есть метод __iadd__(), вызывается x.__iadd__(y). Если x – экземпляр класса, в котором не определён метод __iadd__(), то рассматриваются x.__add__(y) и y.__radd__(x), как и при вычислении x + y.
object.__neg__(self)
object.__pos__(self)
object.__abs__(self)
object.__invert__(self)

Вызывается для реализации унарных арифметических операций (-, +, abs() и ~).

object.__complex__(self)
object.__int__(self)
object.__float__(self)
object.__round__(self[, n])

Вызывается для реализации встроенных функций complex(), int(), float() и round(). Должен возвращать значение соответствующего типа.

object.__index__(self)
Вызывается для реализации operator.index(). Также вызывается всякий раз, когда Python требуется целочисленный объект (например, при срезе или во встроенных функциях bin(), hex() и oct()). Должна возвращать целое число.

3.3.8. Контекстные менеджеры оператора withWith Statement Context Managers

Контекстный менеджер – это объект, который определяет контекст выполнения, устанавливаемый при выполнении оператора with. Контекстный менеджер управляет входом в желаемый контекст выполнения и выходом из него для исполнения блока кода. Обычно контекстные менеджеры вызываются с помощью оператора with (описанного в разделе Оператор with), но также могут быть использованы путём прямого вызова их методов.

Типичные случаи использования контекстных менеджеров включают сохранение и восстановление различных видов глобального состояния, блокировку и разблокировку ресурсов, закрытие открытых файлов и т.д.

Для получения дополнительной информации о контекстных менеджерах см. Типы контекстных менеджеров.

object.__enter__(self)
Входит в контекст выполнения, связанный с этим объектом. Оператор with привяжет возвращаемое значение этого метода к цели (целям), указанной в предложении as оператора (если оно есть).
object.__exit__(self, exc_type, exc_value, traceback)

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

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

Обратите внимание, что методы __exit__() не должны повторно возбуждать переданное исключение; это обязанность вызывающего кода.

См. также

PEP 0343 – оператор «with»
Спецификация, предыстория и примеры для оператора with в Python.

3.3.9. Поиск специальных методовSpecial method lookup

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

>>> class C:
...     pass
...
>>> c = C()
>>> c.__len__ = lambda: 5
>>> len(c)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: object of type 'C' has no len()

Причина такого поведения кроется в ряде специальных методов, таких как __hash__() и __repr__(), которые реализованы для всех объектов, включая объекты типов. Если бы неявный поиск этих методов использовал обычный процесс поиска, он бы не срабатывал при вызове на самом объекте типа:

>>> 1 .__hash__() == hash(1)
True
>>> int.__hash__() == hash(int)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: descriptor '__hash__' of 'int' object needs an argument

Попытка некорректного вызова несвязанного метода класса таким образом иногда называется «путаницей метаклассов»; её можно избежать, обходя экземпляр при поиске специальных методов:

>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True

Помимо обхода атрибутов экземпляра в целях корректности, неявный поиск специальных методов обычно также обходит метод __getattribute__() даже метакласса объекта:

>>> class Meta(type):
...    def __getattribute__(*args):
...       print("Metaclass getattribute invoked")
...       return type.__getattribute__(*args)
...
>>> class C(object, metaclass=Meta):
...     def __len__(self):
...         return 10
...     def __getattribute__(*args):
...         print("Class getattribute invoked")
...         return object.__getattribute__(*args)
...
>>> c = C()
>>> c.__len__()                 # Явный поиск через экземпляр
Class getattribute invoked
10
>>> type(c).__len__(c)          # Явный поиск через тип
Metaclass getattribute invoked
10
>>> len(c)                      # Неявный поиск
10

Обход механизма __getattribute__() таким образом даёт широкие возможности для оптимизации скорости в интерпретаторе ценой некоторой гибкости в обработке специальных методов (специальный метод должен быть установлен на самом объекте класса, чтобы интерпретатор мог его последовательно вызывать).

Сноски

[1]It is possible in some cases to change an object’s type, under certain controlled conditions. It generally isn’t a good idea though, since it can lead to some very strange behaviour if it is handled incorrectly.
[2]Для операндов одного типа предполагается, что если неотражённый метод (например, __add__()) не работает, то операция не поддерживается, поэтому отражённый метод не вызывается.