Обработка исключений¶Exception Handling

Функции, описанные в этой главе, позволяют обрабатывать и возбуждать исключения Python. Важно понимать некоторые основы обработки исключений в Python. Она работает примерно как переменная errno в Unix: существует глобальный индикатор (на каждый поток) последней произошедшей ошибки. Большинство функций не сбрасывают его при успехе, но устанавливают его для указания причины ошибки при неудаче. Большинство функций также возвращают индикатор ошибки, обычно NULL, если они должны возвращать указатель, или -1, если возвращают целое число (исключение: функции PyArg_*() возвращают 1 при успехе и 0 при неудаче).

Когда функция должна завершиться ошибкой, потому что вызванная ей функция завершилась ошибкой, она обычно не устанавливает индикатор ошибки; его уже установила вызванная функция. Она отвечает либо за обработку ошибки и очистку исключения, либо за возврат после освобождения всех удерживаемых ресурсов (таких как ссылки на объекты или выделенная память); она не должна продолжать нормальное выполнение, если не готова обработать ошибку. При возврате из-за ошибки важно указать вызывающему коду, что ошибка была установлена. Если ошибка не обрабатывается или не аккуратно распространяется, последующие вызовы Python/C API могут вести себя не так, как задумано, и могут отказать загадочным образом.

Индикатор ошибки состоит из трёх объектов Python, соответствующих переменным Python sys.exc_type, sys.exc_value и sys.exc_traceback. Существуют функции API для взаимодействия с индикатором ошибки различными способами. Для каждого потока существует отдельный индикатор ошибки.

void PyErr_PrintEx(int set_sys_last_vars)¶

Выводит стандартную трассировку в sys.stderr и очищает индикатор ошибки. Если только ошибка не является SystemExit. В этом случае трассировка не выводится, и процесс Python завершится с кодом ошибки, указанным экземпляром SystemExit.

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

Если set_sys_last_vars ненулевое, переменные sys.last_type, sys.last_value и sys.last_traceback будут установлены в тип, значение и трассировку напечатанного исключения соответственно.

void PyErr_Print()¶

Псевдоним для PyErr_PrintEx(1).

PyObject* PyErr_Occurred()¶

Возвращаемое значение: заимствованная ссылка.

Проверяет, установлен ли индикатор ошибки. Если установлен, возвращает type исключения (первый аргумент последнего вызова одной из функций PyErr_Set*() или PyErr_Restore()). Если не установлен, возвращает NULL. Вы не владеете ссылкой на возвращаемое значение, поэтому вам не нужно его Py_DECREF().

Примечание

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

int PyErr_ExceptionMatches(PyObject *exc)¶

Эквивалентно PyErr_GivenExceptionMatches(PyErr_Occurred(), exc). Эту функцию следует вызывать только тогда, когда исключение действительно установлено; при отсутствии возбуждённого исключения произойдёт нарушение доступа к памяти.

int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc)¶

Возвращает истину, если исключение given соответствует исключению в exc. Если exc – объект класса, также возвращает истину, когда given является экземпляром подкласса. Если exc – кортеж, выполняется поиск совпадения по всем исключениям кортежа (и рекурсивно по вложенным кортежам).

void PyErr_NormalizeException(PyObject**exc, PyObject**val, PyObject**tb)¶

При определенных обстоятельствах значения, возвращаемые PyErr_Fetch() ниже, могут быть «ненормализованными», то есть *exc является объектом класса, но *val не является экземпляром того же класса. В этом случае данная функция может использоваться для создания экземпляра класса. Если значения уже нормализованы, ничего не происходит. Отложенная нормализация реализована для повышения производительности.

void PyErr_Clear()¶

Очищает индикатор ошибки. Если индикатор ошибки не установлен, эффекта нет.

void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)¶

Извлекает индикатор ошибки в три переменные, адреса которых передаются. Если индикатор ошибки не установлен, устанавливает все три переменные в NULL. Если установлен, он будет очищен, и вы получаете владение ссылкой на каждый извлечённый объект. Значение и объект traceback могут быть NULL, даже если объект типа не NULL.

Примечание

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

void PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)¶

Set the error indicator from the three objects. If the error indicator is already set, it is cleared first. If the objects are NULL, the error indicator is cleared. Do not pass a NULL type and non-NULL value or traceback. The exception type should be a class. Do not pass an invalid exception type or value. (Violating these rules will cause subtle problems later.) This call takes away a reference to each object: you must own a reference to each object before the call and after the call you no longer own these references. (If you don’t understand this, don’t use this function. I warned you.)

Примечание

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

void PyErr_SetString(PyObject *type, const char *message)¶

Это наиболее распространённый способ установки индикатора ошибки. Первый аргумент задаёт тип исключения; обычно это одно из стандартных исключений, например PyExc_RuntimeError. Увеличивать счётчик ссылок на него не требуется. Второй аргумент – сообщение об ошибке; оно преобразуется в строковый объект.

void PyErr_SetObject(PyObject *type, PyObject *value)¶

Эта функция аналогична PyErr_SetString(), но позволяет указать произвольный объект Python для «значения» исключения.

PyObject* PyErr_Format(PyObject *exception, const char *format, ...)¶

Возвращаемое значение: всегда NULL.

Эта функция устанавливает индикатор ошибки и возвращает NULL. Аргумент exception должен быть классом исключения Python. Параметры format и последующие помогают форматировать сообщение об ошибке; их смысл и значения совпадают с PyString_FromFormat().

void PyErr_SetNone(PyObject *type)¶

Это сокращение для PyErr_SetObject(type, Py_None).

int PyErr_BadArgument()¶

Это сокращение для PyErr_SetString(PyExc_TypeError, message), где message указывает, что встроенная операция была вызвана с недопустимым аргументом. В основном предназначено для внутреннего использования.

PyObject* PyErr_NoMemory()¶

Возвращаемое значение: всегда NULL.

Это сокращённая запись для PyErr_SetNone(PyExc_MemoryError); она возвращает NULL, чтобы функция выделения объекта могла записать return PyErr_NoMemory(); при нехватке памяти.

PyObject* PyErr_SetFromErrno(PyObject *type)¶

Возвращаемое значение: всегда NULL.

Это удобная функция для возбуждения исключения, когда библиотечная функция C вернула ошибку и установила переменную C errno. Она создаёт объект-кортеж, первый элемент которого – целое значение errno, а второй – соответствующее сообщение об ошибке (полученное из strerror()), и затем вызывает PyErr_SetObject(type, object). В Unix, когда значение errno равно EINTR, что указывает на прерванный системный вызов, эта функция вызывает PyErr_CheckSignals(), и если тот устанавливает индикатор ошибки, оставляет его установленным. Функция всегда возвращает NULL, поэтому функция-обёртка вокруг системного вызова может записать return PyErr_SetFromErrno(type);, когда системный вызов возвращает ошибку.

PyObject* PyErr_SetFromErrnoWithFilenameObject(PyObject *type, PyObject *filenameObject)¶

Аналогично PyErr_SetFromErrno(), с дополнительным поведением: если filenameObject не равен NULL, он передаётся конструктору type в качестве третьего параметра. Для таких исключений, как IOError и OSError, это используется для определения атрибута filename экземпляра исключения.

PyObject* PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename)¶

Возвращаемое значение: всегда NULL.

Аналогично PyErr_SetFromErrnoWithFilenameObject(), но имя файла передаётся в виде строки C.

PyObject* PyErr_SetFromWindowsErr(int ierr)¶

Возвращаемое значение: всегда NULL.

Это удобная функция для возбуждения WindowsError. Если она вызвана с ierr равным 0, используется код ошибки, возвращённый вызовом GetLastError(). Она вызывает функцию Win32 FormatMessage() для получения описания Windows для кода ошибки, заданного ierr или GetLastError(), затем создаёт объект-кортеж, первый элемент которого – значение ierr, а второй – соответствующее сообщение об ошибке (полученное из FormatMessage()), и затем вызывает PyErr_SetObject(PyExc_WindowsError, object). Эта функция всегда возвращает NULL. Доступность: Windows.

PyObject* PyErr_SetExcFromWindowsErr(PyObject *type, int ierr)¶

Возвращаемое значение: всегда NULL.

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

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

PyObject* PyErr_SetFromWindowsErrWithFilenameObject(int ierr, PyObject *filenameObject)¶

Аналогично PyErr_SetFromWindowsErr(), с дополнительным поведением: если filenameObject не равен NULL, он передаётся конструктору WindowsError в качестве третьего параметра. Доступность: Windows.

PyObject* PyErr_SetFromWindowsErrWithFilename(int ierr, const char *filename)¶

Возвращаемое значение: всегда NULL.

Аналогично PyErr_SetFromWindowsErrWithFilenameObject(), но имя файла передаётся в виде строки C. Доступность: Windows.

PyObject* PyErr_SetExcFromWindowsErrWithFilenameObject(PyObject *type, int ierr, PyObject *filename)¶

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

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

PyObject* PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename)¶

Возвращаемое значение: всегда NULL.

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

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

void PyErr_BadInternalCall()¶

Это сокращение для PyErr_SetString(PyExc_SystemError, message), где message указывает, что внутренняя операция (например, функция Python/C API) была вызвана с недопустимым аргументом. Предназначено в основном для внутреннего использования.

int PyErr_WarnEx(PyObject *category, char *message, int stacklevel)¶

Выдаёт предупреждающее сообщение. Аргумент category – категория предупреждения (см. ниже) или NULL; аргумент message – строка сообщения. stacklevel – положительное число, указывающее количество кадров стека; предупреждение будет выдано из текущей выполняемой строки кода в этом кадре стека. Значение stacklevel, равное 1, соответствует функции, вызывающей PyErr_WarnEx(), 2 – функции выше неё, и так далее.

Эта функция обычно выводит сообщение предупреждения в sys.stderr; однако возможно, что пользователь указал превращать предупреждения в ошибки, и в этом случае будет возбуждено исключение. Также возможно, что функция возбуждает исключение из-за проблемы в механизме предупреждений (реализация импортирует модуль warnings для выполнения основной работы). Возвращаемое значение равно 0, если исключение не возбуждено, или -1, если исключение возбуждено. (Нельзя определить, было ли сообщение предупреждения на самом деле выведено, а также причину исключения; это сделано намеренно.) Если исключение возбуждено, вызывающий код должен выполнить обычную обработку исключения (например, Py_DECREF() принадлежащие ссылки и вернуть значение ошибки).

Категории предупреждений должны быть подклассами PyExc_Warning; PyExc_Warning является подклассом PyExc_Exception; категория предупреждений по умолчанию – PyExc_RuntimeWarning. Стандартные категории предупреждений Python доступны в виде глобальных переменных, имена которых перечислены в разделе Стандартные категории предупреждений.

Информацию об управлении предупреждениями см. в документации модуля warnings и опции -W в документации командной строки. API для управления предупреждениями на C не существует.

int PyErr_Warn(PyObject *category, char *message)¶

Выдаёт предупреждающее сообщение. Аргумент category – категория предупреждения (см. ниже) или NULL; аргумент message – строка сообщения. Предупреждение будет выглядеть так, как будто оно выдано из функции, вызывающей PyErr_Warn(), что эквивалентно вызову PyErr_WarnEx() с stacklevel, равным 1.

Устарело; используйте PyErr_WarnEx() вместо этого.

int PyErr_WarnExplicit(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)¶

Выдаёт предупреждение с явным контролем всех атрибутов предупреждения. Это прямая обёртка вокруг функции Python warnings.warn_explicit(); обратитесь к ней за дополнительной информацией. Аргументы module и registry могут быть установлены в NULL для получения описанного там эффекта по умолчанию.

int PyErr_WarnPy3k(char *message, int stacklevel)¶

Выдаёт DeprecationWarning с указанными message и stacklevel, если включён флаг Py_Py3kWarningFlag.

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

int PyErr_CheckSignals()¶

Эта функция взаимодействует с обработкой сигналов Python. Она проверяет, был ли отправлен сигнал процессам, и если да, вызывает соответствующий обработчик сигнала. Если модуль signal поддерживается, может быть вызван обработчик сигнала, написанный на Python. Во всех случаях эффект по умолчанию для SIGINT – возбуждение исключения KeyboardInterrupt. Если исключение возбуждено, устанавливается индикатор ошибки, и функция возвращает -1; в противном случае функция возвращает 0. Индикатор ошибки может быть сброшен или не сброшен, если он был установлен ранее.

void PyErr_SetInterrupt()¶

Эта функция имитирует действие сигнала SIGINT – при следующем вызове PyErr_CheckSignals() будет возбуждено KeyboardInterrupt. Её можно вызывать, не удерживая блокировку интерпретатора.

int PySignal_SetWakeupFd(int fd)¶

Эта вспомогательная функция задаёт файловый дескриптор, в который будет записан байт '\0' при получении сигнала. Возвращается предыдущий такой дескриптор. Значение -1 отключает эту возможность; это состояние по умолчанию. Эта функция эквивалентна signal.set_wakeup_fd() в Python, но без проверки ошибок. fd должен быть корректным файловым дескриптором. Функцию следует вызывать только из главного потока.

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

PyObject* PyErr_NewException(char *name, PyObject *base, PyObject *dict)¶

Возвращаемое значение: новая ссылка.

Эта вспомогательная функция создаёт и возвращает новый класс исключений. Аргумент name должен быть именем нового исключения – C-строка вида module.classname. Аргументы base и dict обычно равны NULL. В результате создаётся объект класса, производный от Exception (доступен в C как PyExc_Exception).

Атрибут __module__ нового класса устанавливается в первую часть (до последней точки) аргумента name, а имя класса – в последнюю часть (после последней точки). Аргумент base можно использовать для указания альтернативных базовых классов; это может быть как один класс, так и кортеж классов. Аргумент dict можно использовать для указания словаря переменных и методов класса.

PyObject* PyErr_NewExceptionWithDoc(char *name, char *doc, PyObject *base, PyObject *dict)¶

Возвращаемое значение: новая ссылка.

То же, что и PyErr_NewException(), с тем отличием, что новому классу исключений можно легко задать docstring: если doc не равно NULL, оно будет использоваться как строка документации для класса исключений.

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

void PyErr_WriteUnraisable(PyObject *obj)¶

Эта вспомогательная функция выводит предупреждающее сообщение в sys.stderr, когда исключение было установлено, но интерпретатор не может его фактически возбудить. Она используется, например, когда исключение возникает в методе __del__().

Функция вызывается с единственным аргументом obj, идентифицирующим контекст, в котором возникло необрабатываемое исключение. Если возможно, в предупреждающем сообщении будет выведено представление (repr) obj.