[ Россум, Дрейк, Откидач ] Язык программирования Python

__self__

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

11.4.4Классы

Когда вызывается объект-класс, создается и возвращается новый экземпляр этого класса. При этом подразумевается вызов специального метода класса __init__ (если он определен) с аргументами, с которыми вызывается объект-класс. Если метод __init__ не определен, объект-класс должен вызываться без аргументов. Свойства объектовклассов описаны в разделе 11.6.1.

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

Если для класса определить метод __call__() (см. раздел 11.6.3), то его экземпляры будут поддерживать вызов: вызов экземпляра (x(arglist)) преобразуется в вызов метода __call__() с теми же аргументами (x.__call__(arglist)). Свойства экземпляров классов описаны в разделе 11.6.2.

11.5Модули

Единственная операция, поддерживаемая объектами-модулями — доступ к их атрибутам: m.name, где m — модуль и name — имя, определенное в пространстве имен модуля m (Вы можете как получить, так и присвоить новое значение атрибуту модуля). Для создания объекта модуля предназначена инструкция import (см. раздел 10.3.10).

Объекты модули имеют следующие атрибуты:

__dict__

Словарь, являющийся таблицей имен модуля. Внося в него изменения, Вы меняете таблицу имен модуля, однако присваивание атрибуту __dict__ невозможно (то есть Вы можете написать m.__dict__[’a’] = 1, тем самым определив m.a равным 1, но не можете написать m.__dict__ = {}).

__name__

Имя модуля.

__doc__

Строка документации модуля.

__file__

Полное имя файла, содержащего определение модуля (у модулей, статически встроенных в интерпретатор, атрибут __file__ отсутствует).

атрибутов производится в первую очередь. Если атрибут не найден, поиск продолжается среди атрибутов класса (см. раздел 11.6.1). При этом атрибут класса, являющийся методом, становится привязанным к данному экземпляру класса (см. раздел 11.4.2). Если нет атрибута класса с таким именем, вызывается специальный метод __getattr__(). Если же метод __getattr__() не определен, генерируется исключение AttributeError.

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

Объекты-экземпляры имеют следующие атрибуты:

__dict__

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

__class__

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

11.6.3Специальные методы

Определив для класса методы со специальными именами, Вы можете реализовать над его экземплярами определенные операции, которые вызываются с помощью специального синтаксиса.

Инициализация и очистка

__init__(self [, args...])

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

__del__(self)

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

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

Замечания:

Инструкция ‘del x’ не вызывает напрямую x.__del__(), а лишь удаляет имя ’x’ из локального пространства имен, тем самым уменьшая число ссылок на объект на единицу. Когда число ссылок на объект достигает нуля, для него вызывается метод __del__(). Наиболее часто встречающаяся причина, по которой количество ссылок на объект не достигает нуля — существование циклических ссылок между объектами. Такая ситуация возникает, например, при использовании двоесвязных списков или графов. В этом случае единственное средство — явно разорвать циклы. Циклические ссылки также создаются, если Вы сохраняете объект traceback, полученный с помощью функции sys.exc_info() (см. описание модуля sys). В интерактивном режиме объект traceback, относящийся к последнему не перехваченному исключению, хранится в sys.last_traceback. Он содержит ссылку на кадр стека функции, в которой возникла исключительная ситуация, и, соответственно, на все переменные функции. Чтобы разорвать эту связь достаточно присвоить None

переменной sys.last_traceback.

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

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

Истинность и сравнение

__cmp__(self, other)

Вызывается (для первого или второго операнда) при выполнении всех операций сравнения, кроме случаев, когда оба операнда являются экземплярами классов и при этом для первого операнда не определен метод __cmp__(). Должен возвращать целое число: отрицательное, если self < other, ноль, если self == other, и положительное целое число, если self > other (см. также описание функции cmp() в главе 12). Если метод __cmp__() (или __rcmp__()) не определен, сравнение экземпляров производится по идентификаторам.

__rcmp__(self, other)

Вызывается для второго операнда, если оба операнда являются экземплярами

self == other, и положительное целое число, если self < other. Нет смысла определять cmp(y, x) отличным от -cmp(x, y), поэтому метод __rcmp__() обычно определяют в виде:

def __rcmp__(self, other): return -cmp(self, other)

__hash__(self)

Метод предназначен для получения хэш-значения объекта. Вызывается для объектов, используемых в качестве ключа при операциях над словарями, а также при использовании встроенной функции hash(). Должен возвращать 32-битное целое число. Объекты, которые при сравнении считаются равными, должны иметь равные хэш-значения. Рекомендуется использовать своего рода смесь (используя, например, исключающее ИЛИ) хэш-значений компонентов объекта, играющих роль при сравнении. Если для класса не определен метод __cmp__(), то по умолчанию в качестве хэш-значения для его экземпляров будет использоваться идентификатор объекта, определение же метода __hash__() лишь замедлит выполнение программы. Если же у класса есть метод __cmp__(), но нет метода __hash__(), его экземпляры не могут быть использованы в качестве ключа в операциях над словарями. Хэш-значение должно быть постоянно на протяжении всего времени жизни объекта, поэтому изменяемые объекты не должны иметь метода __hash__().

__nonzero__(self)

Вызывается для определения истинности объекта, должен возвращать 0 или 1. Если этот метод не определен, используется метод __len__() (см. раздел 11.6.3); если же для класса не определен ни один из этих методов, все его экземпляры будут истинными.

Доступ к атрибутам

Вы можете изменить действия, выполняемые при доступе к атрибутам: получении значения, присваивании и удалении. Для повышения производительности эти методы кэшируются в объекте-классе в момент выполнения определения класса. Поэтому их изменение после выполнения определения класса не даст желаемого результата.

__getattr__(self, name)

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

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

156 Глава 11. Встроенные типы данных

__setattr__(self, name, value)

Вызывается при попытке присваивания атрибуту вместо обычного механизма, который сохраняет значение в словаре __dict__ экземпляра. name — имя атрибута, value — присваиваемое значение.

Обратите внимание, что попытка присвоить значение атрибуту экземпляра (например, ‘setattr(self, name, value)’) внутри метода __setattr__() приведет к его рекурсивному вызову. Вместо этого следует добавить соответствующую запись в словарь атрибутов экземпляра: ‘self.__dict__[name] = value’.

__delattr__(self, name)

Вызывается при попытке удаления атрибута. Этот метод следует определять только в том случае, когда для объектов имеет смысл инструкция ‘del self.name’.

Операция вызова

__call__(self [, args...])

Вызывается при вызове экземпляра класса, то есть ‘x(arg1, arg2, ...)’ является короткой записью для ‘x.__call__(arg1, arg2, ...)’.

Эмуляция последовательностей и отображений

Для того, чтобы определенные Вами объекты вели себя так же, как и встроенные типы string, tuple, list и dictionary, для них необходимо определить методы, описанные в этом разделе. Разница между последовательностями и отображениями заключается в том, что для последовательностей допустимыми ключами (индексами) являются целые числа k, такие что 0 <= k < N, где N — длина последовательности. Для отображений же ключом может являться объект любого типа10. Кроме того, при применении к последовательности операции среза, в качестве ключа выступает объект, представляющий один (объект типа slice или ellipsis) или несколько (кортеж из объектов типа slice и ellipsis) срезов (см. раздел 11.8.3).

Кроме описанных здесь методов, для отображений рекомендуется реализовать методы keys(), values(), items(), has_key(), get(), clear(), copy(), и update(), ведущие себя так же, как и для объектов dictionary (см. раздел 11.3); для изменяемых последовательностей следует реализовать методы, характерные для объектов list: append(), count(), index(), insert(), pop(), remove(), reverse() и sort() (см. раздел 11.2.6). И, наконец, специальные методы __add__(),

__radd__(), __iadd__(), __mul__(), __rmul__() и __imul__(), реализующие характерные для последовательностей операции сложения (объединение последовательностей) и умножения (размножение последовательностей), описаны в разделе 11.6.3. Для совместимости с предыдущими версиями, могут быть определены специальные ме-

10Тип dictionary налагает дополнительные ограничения: для его ключа должна быть определена операция получения хэш-значения (см. описание встроенной функции hash() в главе 12).

тоды __getslice__(), __setslice__() и __delslice__() (см. ниже), которые будут обрабатывать операции с простой (но не расширенной) записью среза.

__len__(self)

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

__getitem__(self, key)

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

__setitem__(self, key, value)

Вызывается для реализации присваивания элементу с заданным ключом или индексом (‘self[key] = value’). Этот метод необходим только для отображений, допускающих изменение значения, соответствующего определенному ключу, или добавление записи с новым ключом, а также для последовательностей, допускающих изменение элементов. Если Вы эмулируете последовательность, то, в случае выхода индекса за пределы допустимых значений (с учетом преобразований отрицательных индексов), следует генерировать исключение IndexError.

__delitem__(self, key)

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

До версии 2.0, для того, чтобы последовательность поддерживала операцию с простой записью среза, необходимо было определить следующие три метода (для неизменяемых последовательностей нужен только метод __getslice__()). Для всех трех методов опущенные значения индексов i и j заменяются на ноль и sys.maxint соответственно. Если в записи среза используются отрицательные индексы, к ним добавляется длина последовательности. Если же метод __len__() не реализован, генерируется исключение AttributeError. Заметим, что нет никакой гарантии того, что после добавления длины последовательности индекс не будет отрицательным. Индексы, превышающие длину последовательности, остаются неизменными. Обратите внимание, что эти методы используются только для реализации операций с простой записью среза.

__getslice__(self, i, j)

Вызывается для реализации получения подпоследовательности (self[i:j]).

__setslice__(self, i, j, sequence)

Вызывается для реализации присваивания срезу, то есть замены подпоследовательности (‘self[i:j] = sequence’).

__delslice__(self, i, j)

Вызывается для реализации удаления подпоследовательности (‘del self[i:j]’).

Для реализации операций, касающихся расширенной записи срезов, используются методы __getitem__(), __setitem__() и __delitem__(). В этом случае в качестве ключа выступает объект типа slice, объект Ellipsis или кортеж из них (см. раздел 11.8.3). Если вы реализовали поддержку расширенной записи среза, то, начиная с версии 2.0, нет необходимости реализовывать методы __getslice__(), __setslice__() и __delslice__(): при их отсутствии автоматически будет вызван метод method__getitem__(), __setitem__() или __delitem__().

Следующий пример показывает, как Вы можете сохранить возможность работы Вашей программы (модуля) со старыми версиями интерпретатора (предполагается, что методы method__getitem__(), __setitem__() или __delitem__() поддерживают объекты, представляющие срез, в качестве аргумента):

class MyClass:

...

def __getitem__(self, item):

...

def __setitem__(self, item, value):

...

def __delitem__(self, item):

...

if sys.hexversion<0x020000F0:

#ьФЙ НЕФПДЩ ОЕ ВХДХФ ПРТЕДЕМЕОЩ, ЕУМЙ

#ЙУРПМШЪХЕФУС ЧЕТУЙС 2.0 (ЖЙОБМШОБС) ЙМЙ ОПЧЕЕ def __getslice__(self, i, j):

return self[max(0, i):max(0, j):] def __setslice__(self, i, j, seq):

self[max(0, i):max(0, j):] = seq def __delslice__(self, i, j):

del self[max(0, i):max(0, j):]

...

Обратите внимание на использование функции max(). В то время как методы __*item__() всегда получают индексы без изменений, перед вызовом методов __*slice__() к отрицательным индексам добавляется длина последовательности. После такого преобразования индекс может остаться отрицательным и быть неверно интерпретирован метами __*item__(). Использование max(0, i) гарантирует, что индексы всегда будут интерпретироваться корректно.

__complex__(self)

__int__(self)

__long__(self)

__float__(self)

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

Арифметические и битовые операции

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

Унарные операции

__neg__(self)

__pos__(self)

__invert__(self)

__abs__(self)

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

Бинарные операции

Для того, чтобы вычислить выражение x op y, предпринимаются следующие шаги (__op__() и __rop__() — методы, реализующие оператор op, например, __add__()

и__radd__() реализуют оператор +):

1.Если x является строкой и op является оператором форматирования (%), выполняется форматирование и все остальные шаги пропускаются.

2.Если x является экземпляром класса:

(a)Если для x определен метод __coerce__(), x и y заменяются значениями, содержащимися в кортеже x.__coerce__(y); если же метод __coerce__() возвращает None, перейти к пункту 3.

(b)Если после преобразований ни x, ни y не является экземпляром, перейти к пункту 4.

(c)Если для x определен метод __op__, вернуть x.__op__(y), в противном случае восстановить значения x и y, которые были перед выполнением пункта 2a.