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

6. Встроенные исключенияBuilt-in Exceptions

Исключения должны быть объектами классов. Исключения определены в модуле exceptions. Этот модуль никогда не нужно импортировать явно: исключения предоставляются во встроенном пространстве имен, а также в модуле exceptions.

Для исключений-классов в операторе try с предложением except которое упоминает конкретный класс, это предложение также обрабатывает любые классы исключений, производные от этого класса (но не классы исключений, от которых он унаследован). Два класса исключений, не связанных отношением наследования, никогда не эквивалентны, даже если они имеют одинаковое имя.

Перечисленные ниже встроенные исключения могут быть сгенерированы интерпретатором или встроенными функциями. Если не указано иное, они имеют «связанное значение», указывающее подробную причину ошибки. Это может быть строка или кортеж, содержащий несколько элементов информации (например, код ошибки и строка, объясняющая код). Связанное значение – это второй аргумент оператора raise. Если класс исключения унаследован от стандартного корневого класса BaseException, связанное значение присутствует как атрибут args экземпляра исключения.

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

Встроенные классы исключений могут быть подклассифицированы для определения новых исключений; программистам рекомендуется наследовать новые исключения от класса Exception или одного из его подклассов, а не от BaseException. Дополнительная информация об определении исключений доступна в Python Tutorial в разделе Пользовательские исключения.

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

exception BaseException

Базовый класс для всех встроенных исключений. Он не предназначен для прямого наследования пользовательскими классами (для этого используйте Exception). Если str() или unicode() вызывается для экземпляра этого класса, возвращается представление аргумента(ов) экземпляра или пустая строка, если аргументов не было.

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

args

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

exception Exception

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

Изменено в версии 2.5: Изменено наследование от BaseException.

exception StandardError

Базовый класс для всех встроенных исключений, кроме StopIteration, GeneratorExit, KeyboardInterrupt и SystemExit. Сам StandardError унаследован от Exception.

exception ArithmeticError

Базовый класс для встроенных исключений, которые возбуждаются при различных арифметических ошибках: OverflowError, ZeroDivisionError, FloatingPointError.

exception BufferError

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

exception LookupError

Базовый класс для исключений, возбуждаемых, когда ключ или индекс, используемые в отображении или последовательности, недействительны: IndexError, KeyError. Оно может быть возбуждено напрямую с помощью codecs.lookup().

exception EnvironmentError

Базовый класс для исключений, которые могут возникать вне системы Python: IOError, OSError. Когда исключения этого типа создаются с кортежем из двух элементов, первый элемент доступен в атрибуте errno экземпляра (предполагается, что это номер ошибки), а второй элемент – в атрибуте strerror (обычно это связанное сообщение об ошибке). Сам кортеж также доступен в атрибуте args.

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

Когда исключение EnvironmentError создается с кортежем из трех элементов, первые два элемента доступны, как указано выше, а третий элемент доступен в атрибуте filename. Однако для обратной совместимости атрибут args содержит только кортеж из двух элементов – первых двух аргументов конструктора.

Атрибут filename равен None, когда это исключение создается с количеством аргументов, отличным от 3. Атрибуты errno и strerror также равны None, когда экземпляр создан с количеством аргументов, отличным от 2 или 3. В последнем случае args содержит точные аргументы конструктора в виде кортежа.

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

exception AssertionError

Возбуждается, когда оператор assert завершается неудачно.

exception AttributeError

Возбуждается при неудачном обращении к атрибуту (см. Обращения к атрибутам) или присваивании. (Если объект вообще не поддерживает обращения к атрибутам или их присваивание, возбуждается TypeError.)

exception EOFError

Возбуждается, когда одна из встроенных функций (input() или raw_input()) достигает условия конца файла (EOF), не прочитав никаких данных. (Примечание: методы file.read() и file.readline() возвращают пустую строку при достижении EOF.)

exception FloatingPointError

Возникает при ошибке операции с плавающей запятой. Это исключение всегда определено, но может быть вызвано только при сборке Python с опцией --with-fpectl, или если символ WANT_SIGFPE_HANDLER определён в файле pyconfig.h.

exception GeneratorExit

Возбуждается, когда вызывается метод close() генератора. Он напрямую наследуется от BaseException вместо StandardError поскольку технически не является ошибкой.

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

Изменено в версии 2.6: Изменено наследование от BaseException.

exception IOError

Возбуждается, когда операция ввода-вывода (например, оператор print, встроенная функция open() или метод файлового объекта) завершается ошибкой по причине, связанной с вводом-выводом, например «файл не найден» или «диск заполнен».

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

Изменено в версии 2.6: Изменено: socket.error теперь использует этот класс как базовый.

exception ImportError

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

exception IndexError

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

exception KeyError

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

exception KeyboardInterrupt

Возбуждается, когда пользователь нажимает клавишу прерывания (обычно Control-C или Delete). Во время выполнения регулярно выполняется проверка на наличие прерываний. Прерывания, введенные, когда встроенная функция input() или raw_input() ожидает ввода, также вызывают это исключение. Исключение наследуется от BaseException, чтобы не быть случайно перехваченным кодом, который перехватывает Exception, и тем самым не препятствовать выходу интерпретатора.

Изменено в версии 2.5: Изменено наследование от BaseException.

exception MemoryError

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

exception NameError

Вызывается, когда не найдено локальное или глобальное имя. Это относится только к неквалифицированным именам. Связанное значение – сообщение об ошибке, которое включает имя, которое не удалось найти.

exception NotImplementedError

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

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

exception OSError

Это исключение унаследовано от EnvironmentError. Оно возбуждается, когда функция возвращает системную ошибку (не для недопустимых типов аргументов или других incidental ошибок). Атрибут errno – это числовой код ошибки из errno, а атрибут strerror – это соответствующая строка, которая была бы выведена функцией C perror(). См. модуль errno, который содержит имена кодов ошибок, определенных базовой операционной системой.

Для исключений, связанных с путем файловой системы (таких как chdir() или unlink()), экземпляр исключения будет содержать третий атрибут, filename, который представляет собой имя файла, переданное функции.

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

exception OverflowError

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

exception ReferenceError

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

Новое в версии 2.2: Ранее было известно как исключение weakref.ReferenceError.

exception RuntimeError

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

exception StopIteration

Возбуждается методом next() итератора для сигнализации об отсутствии дальнейших значений. Он унаследован от Exception вместо StandardError, поскольку в нормальном применении это не считается ошибкой.

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

exception SyntaxError

Возбуждается, когда парсер обнаруживает синтаксическую ошибку. Это может произойти в операторе import, в операторе exec, при вызове встроенной функции eval() или input(), или при чтении начального скрипта или стандартного ввода (также в интерактивном режиме).

Экземпляры этого класса имеют атрибуты filename, lineno, offset и text для упрощения доступа к подробностям. str() экземпляра исключения возвращает только сообщение.

exception IndentationError

Базовый класс для синтаксических ошибок, связанных с неверным отступом. Является подклассом SyntaxError.

exception TabError

Возбуждается, когда отступ содержит непоследовательное использование табуляции и пробелов. Является подклассом IndentationError.

exception SystemError

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

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

exception SystemExit

Это исключение возбуждается функцией sys.exit(). Если оно не обработано, интерпретатор Python завершает работу; трассировка стека не выводится. Если связанное значение является обычным целым числом, оно задает системный статус выхода (передается функции exit() в C); если это None, статус выхода равен нулю; если оно имеет другой тип (например, строку), значение объекта выводится, а статус выхода равен единице.

Экземпляры имеют атрибут code, который устанавливается в предлагаемый статус выхода или сообщение об ошибке (по умолчанию None). Кроме того, это исключение напрямую наследуется от BaseException и не от StandardError, поскольку это не является ошибкой технически.

Вызов sys.exit() преобразуется в исключение, чтобы могли выполниться обработчики очистки (блоки finally операторов try), а также чтобы отладчик мог выполнить скрипт без риска потерять управление. Функцию os._exit() можно использовать, если абсолютно необходимо выйти немедленно (например, в дочернем процессе после вызова os.fork()).

Исключение наследуется от BaseException вместо StandardError или Exception, чтобы оно не было случайно перехвачено кодом, который перехватывает Exception. Это позволяет исключению правильно распространяться вверх и вызывает завершение работы интерпретатора.

Изменено в версии 2.5: Изменено наследование от BaseException.

exception TypeError

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

exception UnboundLocalError

Вызывается, когда осуществляется обращение к локальной переменной функции или метода, но этой переменной не присвоено значение. Является подклассом NameError.

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

exception UnicodeError

Вызывается при ошибке кодирования или декодирования, связанной с Unicode. Является подклассом ValueError.

UnicodeError имеет атрибуты, описывающие ошибку кодирования или декодирования. Например, err.object[err.start:err.end] содержит конкретные недопустимые входные данные, на которых споткнулся кодек.

encoding

Имя кодировки, вызвавшей ошибку.

reason

Строка, описывающая конкретную ошибку кодека.

object

Объект, который кодек пытался закодировать или декодировать.

start

Первый индекс недопустимых данных в object.

end

Индекс, следующий за последними недопустимыми данными в object.

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

exception UnicodeEncodeError

Вызывается при ошибке, связанной с Unicode, во время кодирования. Является подклассом UnicodeError.

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

exception UnicodeDecodeError

Вызывается при ошибке, связанной с Unicode, во время декодирования. Является подклассом UnicodeError.

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

exception UnicodeTranslateError

Вызывается при ошибке, связанной с Unicode, во время трансляции. Является подклассом UnicodeError.

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

exception ValueError

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

exception VMSError

Доступно только в VMS. Возникает, когда происходит специфичная для VMS ошибка.

exception WindowsError

Возбуждается, когда происходит ошибка, специфичная для Windows, или когда номер ошибки не соответствует значению errno. Значения winerror и strerror создаются из возвращаемых значений функций GetLastError() и FormatMessage() из Windows Platform API. Значение errno отображает значение winerror в соответствующие значения errno.h. Это подкласс OSError.

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

Изменено в версии 2.5: В предыдущих версиях коды GetLastError() помещались в errno.

exception ZeroDivisionError

Вызывается, когда второй аргумент операции деления или взятия остатка равен нулю. Связанное значение – строка, указывающая тип операндов и операцию.

Следующие исключения используются как категории предупреждений; дополнительную информацию см. в модуле warnings .

exception Warning

Базовый класс для категорий предупреждений.

exception UserWarning

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

exception DeprecationWarning

Базовый класс для предупреждений об устаревших возможностях.

exception PendingDeprecationWarning

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

exception SyntaxWarning

Базовый класс для предупреждений о сомнительном синтаксисе.

exception RuntimeWarning

Базовый класс для предупреждений о сомнительном поведении во время выполнения.

exception FutureWarning

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

exception ImportWarning

Базовый класс для предупреждений о возможных ошибках при импорте модулей.

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

exception UnicodeWarning

Базовый класс для предупреждений, связанных с Unicode.

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

exception BytesWarning

Базовый класс для предупреждений, связанных с bytes и bytearray.

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

6.1. Иерархия исключенийException hierarchy

Иерархия классов для встроенных исключений:

BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StandardError
      |    +-- BufferError
      |    +-- ArithmeticError
      |    |    +-- FloatingPointError
      |    |    +-- OverflowError
      |    |    +-- ZeroDivisionError
      |    +-- AssertionError
      |    +-- AttributeError
      |    +-- EnvironmentError
      |    |    +-- IOError
      |    |    +-- OSError
      |    |         +-- WindowsError (Windows)
      |    |         +-- VMSError (VMS)
      |    +-- EOFError
      |    +-- ImportError
      |    +-- LookupError
      |    |    +-- IndexError
      |    |    +-- KeyError
      |    +-- MemoryError
      |    +-- NameError
      |    |    +-- UnboundLocalError
      |    +-- ReferenceError
      |    +-- RuntimeError
      |    |    +-- NotImplementedError
      |    +-- SyntaxError
      |    |    +-- IndentationError
      |    |         +-- TabError
      |    +-- SystemError
      |    +-- TypeError
      |    +-- ValueError
      |         +-- UnicodeError
      |              +-- UnicodeDecodeError
      |              +-- UnicodeEncodeError
      |              +-- UnicodeTranslateError
      +-- Warning
           +-- DeprecationWarning
           +-- PendingDeprecationWarning
           +-- RuntimeWarning
           +-- SyntaxWarning
           +-- UserWarning
           +-- FutureWarning
	   +-- ImportWarning
	   +-- UnicodeWarning
	   +-- BytesWarning