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

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

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

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

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

Особенность реализации CPython: Для CPython id(x) – это адрес памяти, где хранится x.

Тип объекта определяет, какие операции он поддерживает (например, «есть ли у него длина?»), а также задаёт возможные значения для объектов этого типа. Функция type() возвращает тип объекта (который сам является объектом). Как и идентификатор, тип объекта также неизменен. 1

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

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

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

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

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

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

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

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

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

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

None

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

NotImplemented

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

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

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. Все кодовые точки в диапазоне U+0000 - U+10FFFF могут быть представлены в строке. В Python нет типа char; вместо этого каждая кодовая точка в строке представлена строковым объектом длины 1. Встроенная функция ord() преобразует кодовую точку из строковой формы в целое число в диапазоне 0 - 10FFFF; chr() преобразует целое число в диапазоне 0 - 10FFFF в соответствующий строковый объект длины 1. str.encode() может использоваться для преобразования str в bytes с использованием заданной текстовой кодировки, а bytes.decode() может использоваться для обратного преобразования.

Кортежи

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

Байты

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

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

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

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

Списки

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

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

Объект 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.

Изменено в версии 3.7: В версиях Python до 3.6 словари не сохраняли порядок вставки. В CPython 3.6 порядок вставки сохранялся, но в то время это считалось деталью реализации, а не гарантией языка.

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

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

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

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

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

Атрибут

Значение

__doc__

Строка документации функции или None, если недоступна; не наследуется подклассами.

Доступно для записи

__name__

Имя функции.

Доступно для записи

__qualname__

Квалифицированное имя функции.

Новое в версии 3.3.

Доступно для записи

__module__

Имя модуля, в котором была определена функция, или None, если недоступно.

Доступно для записи

__defaults__

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

Доступно для записи

__code__

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

Доступно для записи

__globals__

Ссылка на словарь, содержащий глобальные переменные функции – глобальное пространство имён модуля, в котором функция была определена.

Только для чтения

__dict__

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

Доступно для записи

__closure__

None или кортеж ячеек, содержащих привязки для свободных переменных функции. См. ниже информацию об атрибуте cell_contents.

Только для чтения

__annotations__

Словарь, содержащий аннотации параметров. Ключи словаря – имена параметров, а 'return' – для аннотации возвращаемого значения, если она указана.

Доступно для записи

__kwdefaults__

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

Доступно для записи

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

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

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

Дополнительную информацию об определении функции можно получить из её объекта 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), называется функцией-генератором. При вызове такая функция всегда возвращает объект-итератор, который можно использовать для выполнения тела функции: вызов метода iterator.__next__() итератора заставляет функцию выполняться до тех пор, пока она не предоставит значение с помощью оператора yield. Когда функция выполняет оператор return или завершается, возбуждается исключение StopIteration, и итератор достигает конца набора возвращаемых значений.

Корутинные функции

Функция или метод, определённые с помощью async def, называются корутинной функцией. Такая функция при вызове возвращает объект корутины. Она может содержать выражения await, а также инструкции async with и async for. См. также раздел Объекты корутин.

Асинхронные функции-генераторы

Функция или метод, которые определяются с помощью async def и используют оператор yield, называются асинхронной функцией-генератором. При вызове такая функция возвращает асинхронный объект-итератор, который можно использовать в операторе async for для выполнения тела функции.

Вызов метода aiterator.__anext__() асинхронного итератора вернёт ожидаемый объект, который при ожидании будет выполняться до тех пор, пока не предоставит значение с помощью выражения yield. Когда функция выполняет пустой оператор return или доходит до конца, возбуждается исключение StopAsyncIteration, и асинхронный итератор достигает конца набора значений для выдачи.

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

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

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

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

Классы

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

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

Экземпляры произвольных классов можно сделать вызываемыми, определив в их классе метод __call__().

Модули

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

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

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

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

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

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

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

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

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

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

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

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

Экземпляр класса создаётся вызовом объекта класса (см. выше). Экземпляр класса имеет пространство имён, реализованное как словарь, который является первым местом, где ищутся ссылки на атрибуты. Если атрибут не найден там, и класс экземпляра имеет атрибут с таким именем, поиск продолжается среди атрибутов класса. Если найден атрибут класса, являющийся объектом пользовательской функции, он преобразуется в объект метода экземпляра, чьим атрибутом __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_trace_lines в False.

Реализации могут разрешить запрос событий на каждую инструкцию, установив f_trace_opcodes в True. Обратите внимание, что это может привести к неопределённому поведению интерпретатора, если исключения, возбуждённые функцией трассировки, выйдут в трассируемую функцию.

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

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

frame.clear()

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

RuntimeError возбуждается, если фрейм в данный момент выполняется.

Новое в версии 3.4.

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

Объекты трассировки стека представляют стековый след исключения. Объект трассировки стека неявно создаётся при возникновении исключения, а также может быть явно создан вызовом types.TracebackType.

Для неявно созданных трассировок, когда поиск обработчика исключения разворачивает стек выполнения, на каждом развёрнутом уровне объект трассировки вставляется перед текущей трассировкой. Когда обработчик исключения входит в действие, стековый след становится доступен программе. (См. раздел Инструкция try.) Он доступен как третий элемент кортежа, возвращаемого sys.exc_info(), и как атрибут __traceback__ перехваченного исключения.

Если программа не содержит подходящего обработчика, трассировка стека выводится (в удобочитаемом формате) в стандартный поток ошибок; если интерпретатор работает в интерактивном режиме, она также становится доступной пользователю как sys.last_traceback.

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

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

Специальный атрибут для записи: tb_next – следующий уровень в стековом следе (в сторону фрейма, где произошло исключение), или None, если следующего уровня нет.

Изменено в версии 3.7: Объекты трассировки стека теперь можно явно создавать из кода Python, и атрибут tb_next существующих экземпляров можно обновлять.

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

Объекты срезов используются для представления срезов для методов __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).

Установка специального метода в None означает, что соответствующая операция недоступна. Например, если класс устанавливает __iter__() в None, класс не является итерируемым, поэтому вызов iter() на его экземплярах вызовет исключение TypeError (без обращения к __getitem__()). 2

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

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

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

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

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

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

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

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

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

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

Поскольку __new__() и __init__() работают вместе при создании объектов (__new__() создаёт его, а __init__() настраивает), метод __init__() не должен возвращать никакого значения, кроме None; в противном случае во время выполнения будет возбуждено исключение TypeError.

object.__del__(self)

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

Метод __del__() может (хотя это не рекомендуется!) отложить уничтожение экземпляра, создав на него новую ссылку. Это называется воскрешением объекта. Зависит от реализации, будет ли __del__() вызван второй раз, когда воскрешённый объект будет уничтожен; текущая реализация CPython вызывает его только один раз.

Нет гарантии, что методы __del__() будут вызваны для объектов, которые всё ещё существуют при завершении работы интерпретатора.

Примечание

del x не вызывает напрямую x.__del__() – первая уменьшает счётчик ссылок на x на единицу, а вторая вызывается только тогда, когда счётчик ссылок x достигает нуля.

Особенность реализации CPython: Циклическая ссылка может помешать счётчику ссылок объекта достичь нуля. В этом случае цикл будет позднее обнаружен и удалён циклическим сборщиком мусора. Частая причина циклических ссылок – когда исключение было перехвачено в локальной переменной. Тогда локальные переменные фрейма ссылаются на исключение, которое ссылается на свою трассировку стека, а та, в свою очередь, ссылается на локальные переменные всех фреймов, захваченных в трассировку.

См. также

Документация по модулю gc.

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

Из-за ненадёжных обстоятельств, при которых вызываются методы __del__(), исключения, возникающие во время их выполнения, игнорируются, а вместо этого предупреждение выводится в sys.stderr. В частности:

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

  • __del__() может выполняться во время завершения работы интерпретатора. В результате глобальные переменные, к которым ему нужно получить доступ (включая другие модули), могут уже быть удалены или установлены в None. Python гарантирует, что глобальные переменные, имена которых начинаются с одного символа подчёркивания, удаляются из своего модуля раньше, чем остальные; если других ссылок на такие глобальные переменные нет, это может помочь обеспечить доступность импортированных модулей на момент вызова метода __del__().

object.__repr__(self)

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

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

object.__str__(self)

Вызывается функциями str(object) и встроенными функциями format() и print() для вычисления «неформального» или хорошо читаемого строкового представления объекта. Возвращаемое значение должно быть объектом строки.

Этот метод отличается от object.__repr__() тем, что от __str__() не ожидается возврат корректного выражения Python: можно использовать более удобное или краткое представление.

Реализация по умолчанию, определённая встроенным типом object, вызывает object.__repr__().

object.__bytes__(self)

Вызывается функцией bytes для вычисления байтового представления объекта. Должен возвращать объект bytes.

object.__format__(self, format_spec)

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

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

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

Изменено в версии 3.4: Метод __format__ самого object вызывает TypeError, если ему передана непустая строка.

Изменено в версии 3.7: object.__format__(x, '') теперь эквивалентен str(x) вместо format(str(self), '').

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() для этого значения, чтобы определить, истинно оно или ложно.

По умолчанию __ne__() делегирует полномочия __eq__() и инвертирует результат, если только он не равен NotImplemented. Между операторами сравнения нет других неявных связей: например, истинность (x<y or x==y) не влечёт x<=y. Для автоматической генерации операций упорядочивания из одной корневой операции см. functools.total_ordering().

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

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

object.__hash__(self)

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

def __hash__(self):
    return hash((self.name, self.nick, self.color))

Примечание

hash() усекает значение, возвращаемое пользовательским методом __hash__() объекта, до размера Py_ssize_t. Обычно это 8 байт в 64-битных сборках и 4 байта в 32-битных. Если __hash__() объекта должна работать в сборках с разной разрядностью, обязательно проверьте ширину во всех поддерживаемых сборках. Простой способ сделать это – с помощью python -c "import sys; print(sys.hash_info.width)".

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

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

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

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

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

Примечание

По умолчанию значения __hash__() объектов str, bytes и datetime «солятся» непредсказуемым случайным значением. Хотя они остаются постоянными в рамках одного процесса Python, их нельзя предсказать при повторных запусках Python.

Это предназначено для защиты от отказа в обслуживании, вызванного специально подобранными входными данными, которые используют наихудшую производительность вставки в dict (сложность O(n^2)). Подробнее см. на http://www.ocert.org/advisories/ocert-2011-003.html.

Изменение хеш-значений влияет на порядок перебора множеств. Python никогда не давал гарантий относительно этого порядка (и он обычно различается между 32-битными и 64-битными сборками).

См. также PYTHONHASHSEED.

Изменено в версии 3.3: Рандомизация хешей включена по умолчанию.

object.__bool__(self)

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

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

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

object.__getattr__(self, name)

Вызывается, когда обычный доступ к атрибуту завершается исключением AttributeError (либо __getattribute__() вызывает AttributeError, потому что имя не является атрибутом экземпляра или атрибутом в дереве классов для self; либо __get__() свойства имя вызывает AttributeError). Этот метод должен либо вернуть (вычисленное) значение атрибута, либо вызвать исключение 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(). Должна быть возвращена последовательность. dir() преобразует возвращённую последовательность в список и сортирует его.

3.3.2.1. Настройка доступа к атрибутам модуляCustomizing module attribute access

Специальные имена __getattr__ и __dir__ также могут использоваться для настройки доступа к атрибутам модуля. Функция __getattr__ на уровне модуля должна принимать один аргумент – имя атрибута – и возвращать вычисленное значение или вызывать исключение AttributeError. Если атрибут не найден на объекте модуля через обычный поиск, т.е. object.__getattribute__(), то __getattr__ ищется в модуле __dict__ перед вызовом AttributeError. Если найдена, она вызывается с именем атрибута, и результат возвращается.

Функция __dir__ не должна принимать аргументов и должна возвращать последовательность строк, представляющих имена, доступные в модуле. При наличии эта функция переопределяет стандартный поиск dir() в модуле.

Для более тонкой настройки поведения модуля (установка атрибутов, свойств и т.д.) можно установить атрибут __class__ объекта модуля в подкласс types.ModuleType. Например:

import sys
from types import ModuleType

class VerboseModule(ModuleType):
    def __repr__(self):
        return f'Verbose {self.__name__}'

    def __setattr__(self, attr, value):
        print(f'Setting {attr}...')
        super().__setattr__(attr, value)

sys.modules[__name__].__class__ = VerboseModule

Примечание

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

Изменено в версии 3.5: атрибут модуля __class__ теперь доступен для записи.

Новое в версии 3.7: __getattr__ и __dir__ – атрибуты модуля.

См. также

PEP 562 – Модули __getattr__ и __dir__

Описывает функции __getattr__ и __dir__ для модулей.

3.3.2.2. Реализация дескрипторов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 класса-владельца.

object.__set_name__(self, owner, name)

Вызывается при создании класса-владельца owner. Дескриптор был присвоен name.

Примечание

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

class A:
   pass
descr = custom_descriptor()
A.attr = descr
descr.__set_name__(A, 'attr')

Подробнее см. Создание объекта класса.

Новое в версии 3.6.

Атрибут __objclass__ интерпретируется модулем inspect как указание класса, в котором был определён этот объект (правильная установка может помочь при интроспекции динамических атрибутов класса во время выполнения). Для вызываемых объектов он может указывать, что в качестве первого позиционного аргумента ожидается или требуется экземпляр указанного типа (или подкласса) (например, CPython устанавливает этот атрибут для несвязанных методов, реализованных на C).

3.3.2.3. Вызов дескрипторов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.4. __slots__

__slots__ позволяет явно объявлять члены данных (например, свойства) и запрещает создание __dict__ и __weakref__ (если только они не объявлены явно в __slots__ или не доступны в родительском классе).

Экономия места по сравнению с использованием __dict__ может быть значительной. Скорость поиска атрибутов также может быть значительно улучшена.

object.__slots__

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

3.3.2.4.1. Примечания по использованию __slots__Notes on using __slots__
  • При наследовании от класса без __slots__ атрибуты __dict__ и __weakref__ экземпляров всегда будут доступны.

  • Без переменной __dict__ экземплярам нельзя присваивать новые переменные, не перечисленные в определении __slots__. Попытки присвоить имя переменной, не указанной в списке, вызывают AttributeError. Если требуется динамическое присваивание новых переменных, добавьте '__dict__' в последовательность строк в объявлении __slots__.

  • Без переменной __weakref__ для каждого экземпляра классы, определяющие __slots__, не поддерживают слабые ссылки на свои экземпляры. Если требуется поддержка слабых ссылок, добавьте '__weakref__' в последовательность строк в объявлении __slots__.

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

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

  • Если класс определяет слот, который также определён в базовом классе, переменная экземпляра, определённая слотом базового класса, становится недоступной (за исключением прямого получения её дескриптора из базового класса). Это делает поведение программы неопределённым. В будущем может быть добавлена проверка для предотвращения такой ситуации.

  • Непустой __slots__ не работает для классов, производных от встроенных типов «переменной длины», таких как int, bytes и tuple.

  • Любому итерируемому объекту, не являющемуся строкой, может быть присвоено __slots__. Также могут использоваться отображения; однако в будущем значениям, соответствующим каждому ключу, может быть присвоен особый смысл.

  • Присваивание __class__ работает, только если оба класса имеют одинаковые __slots__.

  • Множественное наследование с несколькими родительскими классами, имеющими слоты, может использоваться, но только один родитель может иметь атрибуты, созданные слотами (остальные базовые классы должны иметь пустые макеты слотов) – нарушения вызывают TypeError.

  • Если для __slots__ используется итератор, то для каждого значения итератора создаётся дескриптор. Однако атрибут __slots__ будет пустым итератором.

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

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

classmethod object.__init_subclass__(cls)

Этот метод вызывается всякий раз, когда содержащий его класс наследуется. cls – это новый подкласс. Если метод определён как обычный метод экземпляра, он неявно преобразуется в метод класса.

Именованные аргументы, переданные новому классу, передаются в __init_subclass__ родительского класса. Для совместимости с другими классами, использующими __init_subclass__, следует извлечь нужные именованные аргументы, а остальные передать базовому классу, как в примере:

class Philosopher:
    def __init_subclass__(cls, default_name, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.default_name = default_name

class AustralianPhilosopher(Philosopher, default_name="Bruce"):
    pass

Реализация по умолчанию object.__init_subclass__ ничего не делает, но возбуждает ошибку, если вызвана с какими-либо аргументами.

Примечание

Подсказка метакласса metaclass потребляется остальной частью механизма типов и никогда не передаётся в реализации __init_subclass__. Фактический метакласс (а не явная подсказка) доступен как type(cls).

Новое в версии 3.6.

3.3.3.1. МетаклассыMetaclasses

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

Процесс создания класса можно настроить, передав metaclass ключевой аргумент в строке определения класса или унаследовавшись от существующего класса, который содержит такой аргумент. В следующем примере как MyClass, так и MySubclass являются экземплярами Meta:

class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass

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

При выполнении определения класса происходят следующие шаги:

  • разрешаются записи MRO;

  • определяется подходящий метакласс;

  • подготавливается пространство имён класса;

  • выполняется тело класса;

  • создаётся объект класса.

3.3.3.2. Разрешение записей MROResolving MRO entries

Если базовый класс, указанный в определении класса, не является экземпляром type, то на нём ищется метод __mro_entries__. Если он найден, он вызывается с исходным кортежем базовых классов. Этот метод должен возвращать кортеж классов, который будет использоваться вместо этого базового класса. Кортеж может быть пустым; в таком случае исходный базовый класс игнорируется.

См. также

PEP 560 – Базовая поддержка модуля typing и обобщённых типов

3.3.3.3. Определение подходящего метаклассаDetermining the appropriate metaclass

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

  • если не указаны ни базовые классы, ни явный метакласс, то используется type();

  • если указан явный метакласс и он не является экземпляром type(), то он используется непосредственно как метакласс;

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

Наиболее производный метакласс выбирается из явно указанного метакласса (если есть) и метаклассов (т.е. type(cls)) всех указанных базовых классов. Наиболее производный метакласс – это такой метакласс, который является подтипом всех этих кандидатов. Если ни один из кандидатов не удовлетворяет этому критерию, то определение класса завершится ошибкой TypeError.

3.3.3.4. Подготовка пространства имён классаPreparing the class namespace

После того как подходящий метакласс определён, подготавливается пространство имён класса. Если у метакласса есть атрибут __prepare__, он вызывается как namespace = metaclass.__prepare__(name, bases, **kwds) (где дополнительные ключевые аргументы, если таковые имеются, берутся из определения класса). Метод __prepare__ должен быть реализован как classmethod(). Пространство имён, возвращённое __prepare__, передаётся в __new__, но когда окончательный объект класса создаётся, пространство имён копируется в новый dict.

Если у метакласса нет атрибута __prepare__, то пространство имён класса инициализируется как пустое упорядоченное отображение.

См. также

PEP 3115 – Метаклассы в Python 3000

Ввёл перехватчик пространства имён __prepare__

3.3.3.5. Выполнение тела классаExecuting the class body

Тело класса выполняется (приблизительно) как exec(body, globals(), namespace). Ключевое отличие от обычного вызова exec() заключается в том, что лексическая область видимости позволяет телу класса (включая любые методы) ссылаться на имена из текущей и внешних областей видимости, когда определение класса находится внутри функции.

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

3.3.3.6. Создание объекта классаCreating the class object

После заполнения пространства имён класса путём выполнения тела класса объект класса создаётся вызовом metaclass(name, bases, namespace, **kwds) (дополнительные ключевые аргументы, переданные здесь, те же, что и переданные в __prepare__).

Этот объект класса – тот самый, на который будет ссылаться форма без аргументов super(). __class__ – это неявная ссылка на замыкание, создаваемая компилятором, если какой-либо метод в теле класса обращается к __class__ или super. Благодаря этому форма без аргументов super() может корректно определить определяемый класс, исходя из лексической области видимости, а класс или экземпляр, использованный для текущего вызова, определяется по первому аргументу, переданному методу.

Особенность реализации CPython: В CPython 3.6 и новее ячейка __class__ передаётся метаклассу как запись __classcell__ в пространстве имён класса. Если она присутствует, она должна быть передана до вызова type.__new__ для правильной инициализации класса. Несоблюдение этого требования приведёт к DeprecationWarning в Python 3.6 и RuntimeError в Python 3.8.

При использовании метакласса по умолчанию type или любого метакласса, который в итоге вызывает type.__new__, после создания объекта класса выполняются следующие дополнительные шаги настройки:

  • во-первых, type.__new__ собирает все дескрипторы в пространстве имён класса, которые определяют метод __set_name__();

  • во-вторых, все эти методы __set_name__ вызываются с передачей определяемого класса и присвоенного имени этого конкретного дескриптора;

  • наконец, хук __init_subclass__() вызывается для непосредственного родителя нового класса в порядке разрешения его методов.

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

Когда новый класс создаётся с помощью type.__new__, объект, переданный как параметр namespace, копируется в новое упорядоченное отображение, а исходный объект отбрасывается. Новая копия оборачивается в прокси только для чтения,\который становится атрибутом __dict__ объекта класса.

См. также

PEP 3135 – Новый super

Описывает неявную ссылку на замыкание __class__

3.3.3.7. Uses for metaclasses

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

3.3.4. Customizing instance and subclass checks

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

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

class.__instancecheck__(self, instance)

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

class.__subclasscheck__(self, subclass)

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

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

См. также

PEP 3119 – Введение абстрактных базовых классов

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

3.3.5. Эмуляция обобщённых типовEmulating generic types

Можно реализовать синтаксис обобщённого класса, определённый в PEP 484 (например, List[int]), определив специальный метод:

classmethod object.__class_getitem__(cls, key)

Возвращает объект, представляющий специализацию обобщённого класса по аргументам типа, переданным в key.

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

См. также

PEP 560 – Базовая поддержка модуля typing и обобщённых типов

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

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

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

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

Следующие методы могут быть определены для реализации объектов-контейнеров. Контейнеры обычно являются последовательностями (например, списки или кортежи) или отображениями (например, словари), но могут представлять и другие контейнеры. Первый набор методов используется либо для эмуляции последовательности, либо для эмуляции отображения; разница в том, что для последовательности допустимыми ключами должны быть целые числа k, для которых 0 <= k < N, где N – длина последовательности, или объекты срезов, определяющие диапазон элементов. Также рекомендуется, чтобы отображения предоставляли методы keys(), values(), items(), get(), clear(), setdefault(), pop(), popitem(), copy(), update(), ведущие себя аналогично методам стандартного словаря Python. Модуль collections.abc предоставляет абстрактный базовый класс 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__() должен перебирать ключи объекта; для последовательностей – значения.

object.__len__(self)

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

Особенность реализации CPython: В CPython длина должна быть не более sys.maxsize. Если длина больше sys.maxsize, некоторые возможности (например, len()) могут вызывать OverflowError. Чтобы предотвратить вызов OverflowError при проверке истинности, объект должен определять метод __bool__().

object.__length_hint__(self)

Вызывается для реализации operator.length_hint(). Должен возвращать предполагаемую длину объекта (которая может быть больше или меньше фактической длины). Длина должна быть целым числом >= 0. Возвращаемое значение также может быть NotImplemented, которое обрабатывается так же, как если бы метод __length_hint__ вообще не существовал. Этот метод является исключительно оптимизацией и никогда не требуется для корректности.

Новое в версии 3.4.

Примечание

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

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__(). Этот метод следует реализовывать только для отображений, если объекты поддерживают изменение значений по ключам или добавление новых ключей, или для последовательностей, если элементы можно заменять. Те же исключения должны возбуждаться для неправильных значений ключа, что и для метода __getitem__().

object.__delitem__(self, key)

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

object.__missing__(self, key)

Вызывается методом dict.__getitem__() для реализации self[key] в подклассах dict, когда ключ отсутствует в словаре.

object.__iter__(self)

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

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

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.8. Эмуляция числовых типовEmulating numeric types

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

object.__add__(self, other)
object.__sub__(self, other)
object.__mul__(self, other)
object.__matmul__(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.__rmatmul__(self, other)
object.__rtruediv__(self, other)
object.__rfloordiv__(self, other)
object.__rmod__(self, other)
object.__rdivmod__(self, other)
object.__rpow__(self, other[, modulo])
object.__rlshift__(self, other)
object.__rrshift__(self, other)
object.__rand__(self, other)
object.__rxor__(self, other)
object.__ror__(self, other)

Эти методы вызываются для реализации бинарных арифметических операций (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |) с отражёнными (переставленными) операндами. Эти функции вызываются только в том случае, если левый операнд не поддерживает соответствующую операцию 3 и операнды относятся к разным типам. 4 Например, для вычисления выражения 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.__imatmul__(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 является экземпляром класса с методом __iadd__(), то x += y эквивалентно x = x.__iadd__(y). В противном случае рассматриваются x.__add__(y) и y.__radd__(x), как при вычислении x + y. В некоторых ситуациях составное присваивание может приводить к неожиданным ошибкам (см. Почему a_tuple[i] += ['item'] вызывает исключение, хотя сложение работает?), но такое поведение на самом деле является частью модели данных.

object.__neg__(self)
object.__pos__(self)
object.__abs__(self)
object.__invert__(self)

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

object.__complex__(self)
object.__int__(self)
object.__float__(self)

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

object.__index__(self)

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

Примечание

Чтобы обеспечить целостность класса целочисленного типа, вместе с __index__() следует также определять __int__(), и оба метода должны возвращать одно и то же значение.

object.__round__(self[, ndigits])
object.__trunc__(self)
object.__floor__(self)
object.__ceil__(self)

Вызывается для реализации встроенной функции round() и функций math: trunc(), floor() и ceil(). Если ndigits не передан в __round__(), все эти методы должны возвращать значение объекта, усечённое до Integral (обычно int).

Если __int__() не определён, то встроенная функция int() использует __trunc__() в качестве запасного варианта.

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

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

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

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

object.__enter__(self)

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

object.__exit__(self, exc_type, exc_value, traceback)

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

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

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

См. также

PEP 343 – Оператор «with»

Спецификация, предыстория и примеры для инструкции with в Python.

3.3.10. Поиск специальных методов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__() таким образом даёт значительную возможность для оптимизации скорости в интерпретаторе, ценой некоторой гибкости в обработке специальных методов (специальный метод должен быть установлен на самом объекте класса, чтобы интерпретатор мог его последовательно вызывать).

3.4. КорутиныCoroutines

3.4.1. Ожидаемые объектыAwaitable Objects

Объект ожидаемый объект обычно реализует метод __await__(). Объекты корутина, возвращаемые функциями async def, являются ожидаемыми.

Примечание

Объекты итератора генератора, возвращаемые из генераторов, декорированных с помощью types.coroutine() или asyncio.coroutine(), также являются ожидаемыми, но не реализуют __await__().

object.__await__(self)

Должен возвращать итератор. Следует использовать для реализации объектов ожидаемых. Например, asyncio.Future реализует этот метод для совместимости с выражением await.

Новое в версии 3.5.

См. также

PEP 492 для получения дополнительной информации об ожидаемых объектах.

3.4.2. Объекты корутинCoroutine Objects

Объекты корутина являются объектами ожидаемый. Выполнение корутины можно контролировать, вызывая __await__() и итерируя результат. Когда корутина завершает выполнение и возвращает значение, итератор возбуждает StopIteration, а атрибут value исключения содержит возвращаемое значение. Если корутина возбуждает исключение, оно распространяется итератором. Корутины не должны напрямую возбуждать необработанные исключения StopIteration.

Корутины также имеют методы, перечисленные ниже, которые аналогичны методам генераторов (см. Методы итератора генератора). Однако, в отличие от генераторов, корутины напрямую не поддерживают итерацию.

Изменено в версии 3.5.2: Ожидание корутины более одного раза является RuntimeError.

coroutine.send(value)

Запускает или возобновляет выполнение корутины. Если value равно None, это эквивалентно продвижению итератора, возвращаемого __await__(). Если value не равно None, этот метод делегирует методу send() итератора, который вызвал приостановку корутины. Результат (возвращаемое значение, StopIteration или другое исключение) такой же, как при итерации по возвращаемому значению __await__(), описанной выше.

coroutine.throw(type[, value[, traceback]])

Возбуждает указанное исключение в корутине. Этот метод делегирует методу throw() итератора, который вызвал приостановку корутины, если у него есть такой метод. В противном случае исключение возбуждается в точке приостановки. Результат (возвращаемое значение, StopIteration или другое исключение) такой же, как при итерации по возвращаемому значению __await__(), описанной выше. Если исключение не перехвачено в корутине, оно распространяется обратно к вызывающему.

coroutine.close()

Заставляет корутину выполнить очистку и завершиться. Если корутина приостановлена, этот метод сначала делегирует методу close() итератора, который вызвал приостановку корутины, если у него есть такой метод. Затем он возбуждает GeneratorExit в точке приостановки, заставляя корутину немедленно выполнить очистку. Наконец, корутина помечается как завершившая выполнение, даже если она никогда не была запущена.

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

3.4.3. Асинхронные итераторыAsynchronous Iterators

Объект асинхронный итератор может вызывать асинхронный код в своем методе __anext__.

Асинхронные итераторы можно использовать в операторе async for.

object.__aiter__(self)

Должен возвращать объект асинхронный итератор.

object.__anext__(self)

Должен возвращать ожидаемый объект, который даёт следующее значение итератора. Должен возбуждать ошибку StopAsyncIteration, когда итерация завершена.

Пример асинхронного итерируемого объекта:

class Reader:
    async def readline(self):
        ...

    def __aiter__(self):
        return self

    async def __anext__(self):
        val = await self.readline()
        if val == b'':
            raise StopAsyncIteration
        return val

Новое в версии 3.5.

Изменено в версии 3.7: До Python 3.7 __aiter__ мог возвращать ожидаемый объект, который разрешался в асинхронный итератор.

Начиная с Python 3.7, __aiter__ должен возвращать объект асинхронного итератора. Возврат чего-либо ещё приводит к ошибке TypeError.

3.4.4. Асинхронные менеджеры контекстаAsynchronous Context Managers

Асинхронный менеджер контекста – это менеджер контекста, способный приостанавливать выполнение в своих методах __aenter__ и __aexit__.

Асинхронные менеджеры контекста можно использовать в инструкции async with.

object.__aenter__(self)

Этот метод семантически похож на __enter__(), с той лишь разницей, что он должен возвращать ожидаемый объект.

object.__aexit__(self, exc_type, exc_value, traceback)

Этот метод семантически похож на __exit__(), с той лишь разницей, что он должен возвращать ожидаемый объект.

Пример класса асинхронного менеджера контекста:

class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')

Новое в версии 3.5.

Сноски

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

Методы __hash__(), __iter__(), __reversed__() и __contains__() имеют специальную обработку для этого; остальные всё равно вызовут TypeError, но могут сделать это, полагаясь на то, что None не является вызываемым.

3

«Не поддерживает» здесь означает, что у класса нет такого метода или метод возвращает NotImplemented. Не устанавливайте метод в None, если хотите принудительно вернуться к отражённому методу правого операнда – это даст противоположный эффект, явно блокируя такой возврат.

4

Для операндов одного типа предполагается, что если неотражённый метод (например, __add__()) завершается неудачей, операция не поддерживается, поэтому отражённый метод не вызывается.