Обробка винятків¶
The functions described in this chapter will let you handle and raise Python
exceptions. It is important to understand some of the basics of Python
exception handling. It works somewhat like the POSIX errno
variable:
there is a global indicator (per thread) of the last error that occurred. Most
C API functions don’t clear this on success, but will set it to indicate the
cause of the error on failure. Most C API functions also return an error
indicator, usually NULL
if they are supposed to return a pointer, or -1
if they return an integer (exception: the PyArg_*()
functions
return 1
for success and 0
for failure).
Зокрема, індикатор помилки складається з трьох покажчиків на об’єкти: тип винятку, значення винятку та об’єкт трасування. Будь-який із цих покажчиків може бути NULL
, якщо не встановлено (хоча деякі комбінації заборонені, наприклад, ви не можете мати не NULL
трасування, якщо тип винятку NULL
).
Коли функція повинна вийти з ладу через те, що якась викликана нею функція вийшла з ладу, вона зазвичай не встановлює індикатор помилки; викликана ним функція вже встановила його. Він відповідає або за обробку помилки та очищення виняткової ситуації, або за повернення після очищення будь-яких ресурсів, які він утримує (наприклад, посилання на об’єкти чи розподіл пам’яті); він не повинен продовжуватися нормально, якщо він не готовий обробити помилку. Якщо ви повертаєтеся через помилку, важливо вказати абоненту, що була встановлена помилка. Якщо помилку не обробляти або ретельно розповсюджувати, додаткові виклики API Python/C можуть не працювати належним чином і можуть виникати загадкові збої.
Примітка
The error indicator is not the result of sys.exc_info()
.
The former corresponds to an exception that is not yet caught (and is
therefore still propagating), while the latter returns an exception after
it is caught (and has therefore stopped propagating).
Друк та розчистка¶
-
void
PyErr_Clear
()¶ Очистіть індикатор помилки. Якщо індикатор помилки не встановлено, ефекту немає.
-
void
PyErr_PrintEx
(int set_sys_last_vars)¶ Надрукуйте стандартне відстеження до
sys.stderr
і очистіть індикатор помилки. Якщо помилка не єSystemExit
, у такому випадку трасування не друкується, і процес Python завершить роботу з кодом помилки, указаним екземпляромSystemExit
.Викликайте цю функцію лише, коли встановлено індикатор помилки. Інакше це призведе до фатальної помилки!
If set_sys_last_vars is nonzero, the variables
sys.last_type
,sys.last_value
andsys.last_traceback
will be set to the type, value and traceback of the printed exception, respectively.
-
void
PyErr_Print
()¶ Псевдонім для
PyErr_PrintEx(1)
.
-
void
PyErr_WriteUnraisable
(PyObject *obj)¶ Викликайте
sys.unraisablehook()
, використовуючи поточний виняток і аргумент obj.This utility function prints a warning message to
sys.stderr
when an exception has been set but it is impossible for the interpreter to actually raise the exception. It is used, for example, when an exception occurs in an__del__()
method.The function is called with a single argument obj that identifies the context in which the unraisable exception occurred. If possible, the repr of obj will be printed in the warning message.
При виклику цієї функції необхідно встановити виняток.
Створення винятків¶
Ці функції допомагають встановити індикатор помилки поточного потоку. Для зручності деякі з цих функцій завжди повертатимуть покажчик NULL
для використання в операторі return
.
-
void
PyErr_SetString
(PyObject *type, const char *message)¶ This is the most common way to set the error indicator. The first argument specifies the exception type; it is normally one of the standard exceptions, e.g.
PyExc_RuntimeError
. You need not increment its reference count. The second argument is an error message; it is decoded from'utf-8'
.
-
void
PyErr_SetObject
(PyObject *type, PyObject *value)¶ Ця функція схожа на
PyErr_SetString()
, але дозволяє вказати довільний об’єкт Python для «значення» винятку.
-
PyObject*
PyErr_Format
(PyObject *exception, const char *format, ...)¶ - Return value: Always NULL.
Ця функція встановлює індикатор помилки та повертає
NULL
. exception має бути класом винятків Python. format і наступні параметри допомагають відформатувати повідомлення про помилку; вони мають те саме значення та значення, що й уPyUnicode_FromFormat()
. format — це рядок у кодуванні ASCII.
-
PyObject*
PyErr_FormatV
(PyObject *exception, const char *format, va_list vargs)¶ - Return value: Always NULL.
Те саме, що
PyErr_Format()
, але приймає аргументva_list
, а не змінну кількість аргументів.Нове в версії 3.5.
-
int
PyErr_BadArgument
()¶ Це скорочення для
PyErr_SetString(PyExc_TypeError, повідомлення)
, де повідомлення вказує на те, що вбудовану операцію було викликано з недопустимим аргументом. В основному він призначений для внутрішнього використання.
-
PyObject*
PyErr_NoMemory
()¶ - Return value: Always NULL.
Це скорочення для
PyErr_SetNone(PyExc_MemoryError)
; він повертаєNULL
, тому функція розподілу об’єктів може написатиreturn PyErr_NoMemory();
, коли їй вичерпується пам’ять.
-
PyObject*
PyErr_SetFromErrno
(PyObject *type)¶ - Return value: Always NULL.
This is a convenience function to raise an exception when a C library function has returned an error and set the C variable
errno
. It constructs a tuple object whose first item is the integererrno
value and whose second item is the corresponding error message (gotten fromstrerror()
), and then callsPyErr_SetObject(type, object)
. On Unix, when theerrno
value isEINTR
, indicating an interrupted system call, this callsPyErr_CheckSignals()
, and if that set the error indicator, leaves it set to that. The function always returnsNULL
, so a wrapper function around a system call can writereturn PyErr_SetFromErrno(type);
when the system call returns an error.
-
PyObject*
PyErr_SetFromErrnoWithFilenameObject
(PyObject *type, PyObject *filenameObject)¶ - Return value: Always NULL.
Similar to
PyErr_SetFromErrno()
, with the additional behavior that if filenameObject is notNULL
, it is passed to the constructor of type as a third parameter. In the case ofOSError
exception, this is used to define thefilename
attribute of the exception instance.
-
PyObject*
PyErr_SetFromErrnoWithFilenameObjects
(PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)¶ - Return value: Always NULL.
Подібно до
PyErr_SetFromErrnoWithFilenameObject()
, але приймає другий об’єкт імені файлу, щоб викликати помилки, коли функція, яка приймає два імені файлу, виходить з ладу.Нове в версії 3.4.
-
PyObject*
PyErr_SetFromErrnoWithFilename
(PyObject *type, const char *filename)¶ - Return value: Always NULL.
Similar to
PyErr_SetFromErrnoWithFilenameObject()
, but the filename is given as a C string. filename is decoded from the filesystem encoding (os.fsdecode()
).
-
PyObject*
PyErr_SetFromWindowsErr
(int ierr)¶ - Return value: Always NULL.
This is a convenience function to raise
WindowsError
. If called with ierr of0
, the error code returned by a call toGetLastError()
is used instead. It calls the Win32 functionFormatMessage()
to retrieve the Windows description of error code given by ierr orGetLastError()
, then it constructs a tuple object whose first item is the ierr value and whose second item is the corresponding error message (gotten fromFormatMessage()
), and then callsPyErr_SetObject(PyExc_WindowsError, object)
. This function always returnsNULL
.Availability: Windows.
-
PyObject*
PyErr_SetExcFromWindowsErr
(PyObject *type, int ierr)¶ - Return value: Always NULL.
Подібно до
PyErr_SetFromWindowsErr()
, з додатковим параметром, що визначає тип винятку, який буде створено.Availability: Windows.
-
PyObject*
PyErr_SetFromWindowsErrWithFilename
(int ierr, const char *filename)¶ - Return value: Always NULL.
Similar to
PyErr_SetFromWindowsErrWithFilenameObject()
, but the filename is given as a C string. filename is decoded from the filesystem encoding (os.fsdecode()
).Availability: Windows.
-
PyObject*
PyErr_SetExcFromWindowsErrWithFilenameObject
(PyObject *type, int ierr, PyObject *filename)¶ - Return value: Always NULL.
Similar to
PyErr_SetFromWindowsErrWithFilenameObject()
, with an additional parameter specifying the exception type to be raised.Availability: Windows.
-
PyObject*
PyErr_SetExcFromWindowsErrWithFilenameObjects
(PyObject *type, int ierr, PyObject *filename, PyObject *filename2)¶ - Return value: Always NULL.
Подібно до
PyErr_SetExcFromWindowsErrWithFilenameObject()
, але приймає другий об’єкт імені файлу.Availability: Windows.
Нове в версії 3.4.
-
PyObject*
PyErr_SetExcFromWindowsErrWithFilename
(PyObject *type, int ierr, const char *filename)¶ - Return value: Always NULL.
Подібно до
PyErr_SetFromWindowsErrWithFilename()
, з додатковим параметром, що визначає тип винятку, який буде створено.Availability: Windows.
-
PyObject*
PyErr_SetImportError
(PyObject *msg, PyObject *name, PyObject *path)¶ - Return value: Always NULL.
Це зручна функція для виклику
ImportError
. msg буде встановлено як рядок повідомлення винятку. name і path, обидва з яких можуть мати значенняNULL
, буде встановлено як відповідні атрибутиname
іpath
ImportError
.Нове в версії 3.3.
-
PyObject*
PyErr_SetImportErrorSubclass
(PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)¶ - Return value: Always NULL.
Дуже схоже на
PyErr_SetImportError()
, але ця функція дозволяє вказати підкласImportError
для підвищення.Нове в версії 3.6.
-
void
PyErr_SyntaxLocationObject
(PyObject *filename, int lineno, int col_offset)¶ Установіть інформацію про файл, рядок і зсув для поточного винятку. Якщо поточний виняток не є
SyntaxError
, тоді він встановлює додаткові атрибути, які змушують підсистему друку виключення вважати, що виняток єSyntaxError
.Нове в версії 3.4.
-
void
PyErr_SyntaxLocationEx
(const char *filename, int lineno, int col_offset)¶ Like
PyErr_SyntaxLocationObject()
, but filename is a byte string decoded from the filesystem encoding (os.fsdecode()
).Нове в версії 3.2.
-
void
PyErr_SyntaxLocation
(const char *filename, int lineno)¶ Як
PyErr_SyntaxLocationEx()
, але параметр col_offset опущено.
-
void
PyErr_BadInternalCall
()¶ Це скорочення для
PyErr_SetString(PyExc_SystemError, повідомлення)
, де повідомлення вказує на те, що внутрішня операція (наприклад, функція Python/C API) була викликана з недопустимим аргументом. В основному він призначений для внутрішнього використання.
Винесення попереджень¶
Використовуйте ці функції, щоб видавати попередження з коду C. Вони відображають аналогічні функції, експортовані модулем Python warnings
. Зазвичай вони друкують попередження на sys.stderr; однак також можливо, що користувач вказав, що попередження потрібно перетворити на помилки, і в такому випадку вони викличуть виняток. Також можливо, що функції викликають виняток через проблему з механізмом попередження. Повертається значення 0
, якщо не викликається виняткова ситуація, або -1
, якщо виникає виняток. (Неможливо визначити, чи справді друкується попереджувальне повідомлення, а також причину винятку; це навмисно.) Якщо виникає виняток, абонент, що викликає, має виконати звичайну обробку винятків (наприклад, Py_DECREF()
належать посилання та повертають значення помилки).
-
int
PyErr_WarnEx
(PyObject *category, const char *message, Py_ssize_t stack_level)¶ Видавати попереджувальне повідомлення. Аргумент category є категорією попередження (див. нижче) або
NULL
; аргумент message — це рядок у кодуванні UTF-8. stack_level — додатне число, яке дає кількість кадрів стека; попередження буде видано з поточного рядка коду в цьому фреймі стека. Stack_level 1 — це функція, яка викликаєPyErr_WarnEx()
, 2 — це функція, яка стоїть вище, і так далі.Категорії попереджень мають бути підкласами
PyExc_Warning
;PyExc_Warning
є підкласомPyExc_Exception
; стандартна категорія попередження:PyExc_RuntimeWarning
. Стандартні категорії попереджень Python доступні як глобальні змінні, імена яких пронумеровані в Стандартні категорії попереджень.Щоб отримати інформацію про керування попередженнями, перегляньте документацію до модуля
warnings
і опції-W
у документації командного рядка. Немає C API для керування попередженнями.
-
int
PyErr_WarnExplicitObject
(PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)¶ Видавати попереджувальне повідомлення з явним керуванням усіма атрибутами попередження. Це проста обгортка функції Python
warnings.warn_explicit()
; дивіться там для отримання додаткової інформації. Для аргументів module і registry можна встановити значенняNULL
, щоб отримати описаний там ефект за замовчуванням.Нове в версії 3.4.
-
int
PyErr_WarnExplicit
(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)¶ Similar to
PyErr_WarnExplicitObject()
except that message and module are UTF-8 encoded strings, and filename is decoded from the filesystem encoding (os.fsdecode()
).
-
int
PyErr_WarnFormat
(PyObject *category, Py_ssize_t stack_level, const char *format, ...)¶ Функція схожа на
PyErr_WarnEx()
, але використовуйтеPyUnicode_FromFormat()
для форматування повідомлення попередження. format — це рядок у кодуванні ASCII.Нове в версії 3.2.
-
int
PyErr_ResourceWarning
(PyObject *source, Py_ssize_t stack_level, const char *format, ...)¶ Function similar to
PyErr_WarnFormat()
, but category isResourceWarning
and it passes source towarnings.WarningMessage()
.Нове в версії 3.6.
Запит індикатора помилки¶
-
PyObject*
PyErr_Occurred
()¶ - Return value: Borrowed reference.
Test whether the error indicator is set. If set, return the exception type (the first argument to the last call to one of the
PyErr_Set*()
functions or toPyErr_Restore()
). If not set, returnNULL
. You do not own a reference to the return value, so you do not need toPy_DECREF()
it.Абонент повинен тримати GIL.
Примітка
Не порівнюйте повернуте значення з певним винятком; замість цього використовуйте
PyErr_ExceptionMatches()
, як показано нижче. (Порівняння може бути легко невдалим, оскільки виняток може бути екземпляром замість класу, у випадку винятку класу, або він може бути підкласом очікуваного винятку.)
-
int
PyErr_ExceptionMatches
(PyObject *exc)¶ Еквівалент
PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)
. Це слід викликати лише тоді, коли фактично встановлено виняток; порушення доступу до пам’яті відбудеться, якщо не було викликано жодного винятку.
-
int
PyErr_GivenExceptionMatches
(PyObject *given, PyObject *exc)¶ Повертає true, якщо given виняток відповідає типу винятку в exc. Якщо exc є об’єктом класу, це також повертає true, коли given є екземпляром підкласу. Якщо exc є кортежем, усі типи винятків у кортежі (і рекурсивно в підкортежах) шукаються на відповідність.
-
void
PyErr_Fetch
(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)¶ Отримати індикатор помилки в трьох змінних, адреси яких передано. Якщо індикатор помилки не встановлено, установіть для всіх трьох змінних значення
NULL
. Якщо його встановлено, його буде очищено, і ви матимете посилання на кожен отриманий об’єкт. Значення та об’єкт трасування можуть бутиNULL
, навіть якщо об’єкт типу не є таким.Примітка
This function is normally only used by code that needs to catch exceptions or by code that needs to save and restore the error indicator temporarily, e.g.:
{ PyObject *type, *value, *traceback; PyErr_Fetch(&type, &value, &traceback); /* ... code that might produce other errors ... */ PyErr_Restore(type, value, traceback); }
-
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 aNULL
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.)Примітка
This function is normally only used by code that needs to save and restore the error indicator temporarily. Use
PyErr_Fetch()
to save the current error indicator.
-
void
PyErr_NormalizeException
(PyObject **exc, PyObject **val, PyObject **tb)¶ За певних обставин значення, які повертає
PyErr_Fetch()
нижче, можуть бути «ненормалізованими», тобто*exc
є об’єктом класу, але*val
не є екземпляром того самого класу . У цьому випадку цю функцію можна використовувати для створення екземпляра класу. Якщо значення вже нормалізовані, нічого не відбувається. Відкладену нормалізацію реалізовано для покращення продуктивності.Примітка
This function does not implicitly set the
__traceback__
attribute on the exception value. If setting the traceback appropriately is desired, the following additional snippet is needed:if (tb != NULL) { PyException_SetTraceback(val, tb); }
-
void
PyErr_GetExcInfo
(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)¶ Retrieve the exception info, as known from
sys.exc_info()
. This refers to an exception that was already caught, not to an exception that was freshly raised. Returns new references for the three objects, any of which may beNULL
. Does not modify the exception info state.Примітка
Ця функція зазвичай не використовується кодом, який хоче обробляти винятки. Натомість його можна використовувати, коли коду потрібно тимчасово зберегти та відновити винятковий стан. Використовуйте
PyErr_SetExcInfo()
, щоб відновити або видалити винятковий стан.Нове в версії 3.3.
-
void
PyErr_SetExcInfo
(PyObject *type, PyObject *value, PyObject *traceback)¶ Set the exception info, as known from
sys.exc_info()
. This refers to an exception that was already caught, not to an exception that was freshly raised. This function steals the references of the arguments. To clear the exception state, passNULL
for all three arguments. For general rules about the three arguments, seePyErr_Restore()
.Примітка
Ця функція зазвичай не використовується кодом, який хоче обробляти винятки. Натомість його можна використовувати, коли коду потрібно тимчасово зберегти та відновити винятковий стан. Використовуйте
PyErr_GetExcInfo()
, щоб прочитати винятковий стан.Нове в версії 3.3.
Обробка сигналів¶
-
int
PyErr_CheckSignals
()¶ This function interacts with Python’s signal handling. It checks whether a signal has been sent to the processes and if so, invokes the corresponding signal handler. If the
signal
module is supported, this can invoke a signal handler written in Python. In all cases, the default effect forSIGINT
is to raise theKeyboardInterrupt
exception. If an exception is raised the error indicator is set and the function returns-1
; otherwise the function returns0
. The error indicator may or may not be cleared if it was previously set.
-
void
PyErr_SetInterrupt
()¶ Simulate the effect of a
SIGINT
signal arriving. The next timePyErr_CheckSignals()
is called, the Python signal handler forSIGINT
will be called.If
SIGINT
isn’t handled by Python (it was set tosignal.SIG_DFL
orsignal.SIG_IGN
), this function does nothing.
-
int
PySignal_SetWakeupFd
(int fd)¶ Ця допоміжна функція вказує дескриптор файлу, до якого номер сигналу записується як один байт кожного разу, коли надходить сигнал. fd має бути неблокуючим. Він повертає попередній такий файловий дескриптор.
Значення
-1
вимикає функцію; це початковий стан. Це еквівалентноsignal.set_wakeup_fd()
у Python, але без перевірки помилок. fd має бути дійсним дескриптором файлу. Функцію слід викликати лише з основного потоку.Змінено в версії 3.5: У Windows функція тепер також підтримує ручки сокетів.
Виняткові класи¶
-
PyObject*
PyErr_NewException
(const char *name, PyObject *base, PyObject *dict)¶ - Return value: New reference.
Ця службова функція створює та повертає новий клас винятків. Аргумент name має бути назвою нового винятку, рядком C у формі
module.classname
. Аргументи base і dict зазвичай мають значенняNULL
. Це створює об’єкт класу, похідний відException
(доступний у C якPyExc_Exception
).The
__module__
attribute of the new class is set to the first part (up to the last dot) of the name argument, and the class name is set to the last part (after the last dot). The base argument can be used to specify alternate base classes; it can either be only one class or a tuple of classes. The dict argument can be used to specify a dictionary of class variables and methods.
-
PyObject*
PyErr_NewExceptionWithDoc
(const char *name, const char *doc, PyObject *base, PyObject *dict)¶ - Return value: New reference.
Те саме, що
PyErr_NewException()
, за винятком того, що новому класу винятків можна легко надати рядок документації: якщо doc не єNULL
, він використовуватиметься як рядок документації для класу винятків.Нове в версії 3.2.
Об’єкти винятків¶
-
PyObject*
PyException_GetTraceback
(PyObject *ex)¶ - Return value: New reference.
Return the traceback associated with the exception as a new reference, as accessible from Python through
__traceback__
. If there is no traceback associated, this returnsNULL
.
-
int
PyException_SetTraceback
(PyObject *ex, PyObject *tb)¶ Установіть для трасування, пов’язаного з винятком, значення tb. Використовуйте
Py_None
, щоб очистити його.
-
PyObject*
PyException_GetContext
(PyObject *ex)¶ - Return value: New reference.
Return the context (another exception instance during whose handling ex was raised) associated with the exception as a new reference, as accessible from Python through
__context__
. If there is no context associated, this returnsNULL
.
-
void
PyException_SetContext
(PyObject *ex, PyObject *ctx)¶ Установіть для контексту, пов’язаного з винятком, значення ctx. Щоб очистити його, використовуйте
NULL
. Немає перевірки типу, щоб переконатися, що ctx є винятком. Це краде посилання на ctx.
-
PyObject*
PyException_GetCause
(PyObject *ex)¶ - Return value: New reference.
Return the cause (either an exception instance, or
None
, set byraise ... from ...
) associated with the exception as a new reference, as accessible from Python through__cause__
.
-
void
PyException_SetCause
(PyObject *ex, PyObject *cause)¶ Set the cause associated with the exception to cause. Use
NULL
to clear it. There is no type check to make sure that cause is either an exception instance orNone
. This steals a reference to cause.__suppress_context__
is implicitly set toTrue
by this function.
Виняткові об’єкти Unicode¶
Наступні функції використовуються для створення та зміни винятків Unicode з C.
-
PyObject*
PyUnicodeDecodeError_Create
(const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)¶ - Return value: New reference.
Створіть об’єкт
UnicodeDecodeError
з атрибутами encoding, object, length, start, end і reason. encoding і reason є рядками в кодуванні UTF-8.
-
PyObject*
PyUnicodeEncodeError_Create
(const char *encoding, const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)¶ - Return value: New reference.
Create a
UnicodeEncodeError
object with the attributes encoding, object, length, start, end and reason. encoding and reason are UTF-8 encoded strings.Застаріло починаючи з версії 3.3: 3.11
Py_UNICODE
is deprecated since Python 3.3. Please migrate toPyObject_CallFunction(PyExc_UnicodeEncodeError, "sOnns", ...)
.
-
PyObject*
PyUnicodeTranslateError_Create
(const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)¶ - Return value: New reference.
Create a
UnicodeTranslateError
object with the attributes object, length, start, end and reason. reason is a UTF-8 encoded string.Застаріло починаючи з версії 3.3: 3.11
Py_UNICODE
is deprecated since Python 3.3. Please migrate toPyObject_CallFunction(PyExc_UnicodeTranslateError, "Onns", ...)
.
-
PyObject*
PyUnicodeDecodeError_GetEncoding
(PyObject *exc)¶ -
PyObject*
PyUnicodeEncodeError_GetEncoding
(PyObject *exc)¶ - Return value: New reference.
Повертає атрибут encoding даного об’єкта винятку.
-
PyObject*
PyUnicodeDecodeError_GetObject
(PyObject *exc)¶ -
PyObject*
PyUnicodeEncodeError_GetObject
(PyObject *exc)¶ -
PyObject*
PyUnicodeTranslateError_GetObject
(PyObject *exc)¶ - Return value: New reference.
Повертає атрибут object даного об’єкта винятку.
-
int
PyUnicodeDecodeError_GetStart
(PyObject *exc, Py_ssize_t *start)¶ -
int
PyUnicodeEncodeError_GetStart
(PyObject *exc, Py_ssize_t *start)¶ -
int
PyUnicodeTranslateError_GetStart
(PyObject *exc, Py_ssize_t *start)¶ Отримайте атрибут start даного об’єкта винятку та помістіть його в *start. початок не має бути
NULL
. Повертає0
в разі успіху,-1
у випадку невдачі.
-
int
PyUnicodeDecodeError_SetStart
(PyObject *exc, Py_ssize_t start)¶ -
int
PyUnicodeEncodeError_SetStart
(PyObject *exc, Py_ssize_t start)¶ -
int
PyUnicodeTranslateError_SetStart
(PyObject *exc, Py_ssize_t start)¶ Установіть для атрибута start даного об’єкта винятку значення start. Повертає
0
в разі успіху,-1
у випадку невдачі.
-
int
PyUnicodeDecodeError_GetEnd
(PyObject *exc, Py_ssize_t *end)¶ -
int
PyUnicodeEncodeError_GetEnd
(PyObject *exc, Py_ssize_t *end)¶ -
int
PyUnicodeTranslateError_GetEnd
(PyObject *exc, Py_ssize_t *end)¶ Отримайте атрибут end даного об’єкта винятку та помістіть його в *end. end не має бути
NULL
. Повертає0
в разі успіху,-1
у випадку невдачі.
-
int
PyUnicodeDecodeError_SetEnd
(PyObject *exc, Py_ssize_t end)¶ -
int
PyUnicodeEncodeError_SetEnd
(PyObject *exc, Py_ssize_t end)¶ -
int
PyUnicodeTranslateError_SetEnd
(PyObject *exc, Py_ssize_t end)¶ Установіть для атрибута end даного об’єкта винятку значення end. Повертає
0
в разі успіху,-1
у випадку невдачі.
-
PyObject*
PyUnicodeDecodeError_GetReason
(PyObject *exc)¶ -
PyObject*
PyUnicodeEncodeError_GetReason
(PyObject *exc)¶ -
PyObject*
PyUnicodeTranslateError_GetReason
(PyObject *exc)¶ - Return value: New reference.
Повертає атрибут reason даного об’єкта винятку.
-
int
PyUnicodeDecodeError_SetReason
(PyObject *exc, const char *reason)¶ -
int
PyUnicodeEncodeError_SetReason
(PyObject *exc, const char *reason)¶ -
int
PyUnicodeTranslateError_SetReason
(PyObject *exc, const char *reason)¶ Установіть для атрибута reason даного об’єкта винятку значення reason. Повертає
0
в разі успіху,-1
у випадку невдачі.
Контроль рекурсії¶
Ці дві функції забезпечують спосіб виконання безпечних рекурсивних викликів на рівні C, як в ядрі, так і в модулях розширення. Вони потрібні, якщо рекурсивний код не обов’язково викликає код Python (який автоматично відстежує глибину рекурсії). Вони також не потрібні для реалізації tp_call, оскільки протокол виклику піклується про обробку рекурсії.
-
int
Py_EnterRecursiveCall
(const char *where)¶ Позначає точку, де має бути виконано рекурсивний виклик C-рівня.
If
USE_STACKCHECK
is defined, this function checks if the OS stack overflowed usingPyOS_CheckStack()
. In this is the case, it sets aMemoryError
and returns a nonzero value.Потім функція перевіряє, чи досягнуто обмеження рекурсії. Якщо це так, встановлюється
RecursionError
і повертається ненульове значення. В іншому випадку повертається нуль.де має бути рядок у кодуванні UTF-8, такий як
" у перевірці екземпляра"
, який об’єднується з повідомленнямRecursionError
, спричиненим обмеженням глибини рекурсії.Змінено в версії 3.9: This function is now also available in the limited API.
-
void
Py_LeaveRecursiveCall
(void)¶ Завершує
Py_EnterRecursiveCall()
. Потрібно викликати один раз для кожного успішного викликуPy_EnterRecursiveCall()
.Змінено в версії 3.9: This function is now also available in the limited API.
Правильна реалізація tp_repr
для типів контейнерів вимагає спеціальної обробки рекурсії. Окрім захисту стека, tp_repr
також має відстежувати об’єкти, щоб запобігти циклам. Наступні дві функції полегшують цю функцію. По суті, це C еквівалент reprlib.recursive_repr()
.
-
int
Py_ReprEnter
(PyObject *object)¶ Викликається на початку реалізації
tp_repr
для виявлення циклів.Якщо об’єкт уже оброблено, функція повертає додатне ціле число. У цьому випадку реалізація
tp_repr
має повертати рядковий об’єкт, що вказує на цикл. Як приклад, об’єктиdict
повертають{...}
, а об’єктиlist
повертають[...]
.Функція поверне від’ємне ціле число, якщо досягнуто обмеження рекурсії. У цьому випадку реалізація
tp_repr
зазвичай повинна повертатиNULL
.В іншому випадку функція повертає нуль, і реалізація
tp_repr
може продовжуватися нормально.
-
void
Py_ReprLeave
(PyObject *object)¶ Завершує
Py_ReprEnter()
. Потрібно викликати один раз для кожного викликуPy_ReprEnter()
, який повертає нуль.
Стандартні винятки¶
All standard Python exceptions are available as global variables whose names are
PyExc_
followed by the Python exception name. These have the type
PyObject*
; they are all class objects. For completeness, here are all
the variables:
C Назва |
Назва Python |
Примітки |
---|---|---|
|
||
|
||
|
||
|
||
|
||
|
||
|
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
|
|
|
||
|
|
|
|
|
|
|
||
|
|
Нове в версії 3.3: PyExc_BlockingIOError
, PyExc_BrokenPipeError
, PyExc_ChildProcessError
, PyExc_ConnectionError
, PyExc_ConnectionAbortedError
, PyExc_ConnectionRefusedError
, PyExc_ConnectionResetError
, PyExc_FileExistsError
, PyExc_FileNotFoundError
, PyExc_InterruptedError
, PyExc_IsADirectoryError
, PyExc_NotADirectoryError
, PyExc_PermissionError
, PyExc_ProcessLookupError
і PyExc_TimeoutError
були представлені після PEP 3151.
Нове в версії 3.5: PyExc_StopAsyncIteration
і PyExc_RecursionError
.
Нове в версії 3.6: PyExc_ModuleNotFoundError
.
Це псевдоніми сумісності з PyExc_OSError
:
C Назва |
Примітки |
---|---|
|
|
|
|
|
Змінено в версії 3.3: Раніше ці псевдоніми були окремими типами винятків.
Примітки:
Стандартні категорії попереджень¶
All standard Python warning categories are available as global variables whose
names are PyExc_
followed by the Python exception name. These have the type
PyObject*
; they are all class objects. For completeness, here are all
the variables:
C Назва |
Назва Python |
Примітки |
---|---|---|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
|
|
|
Нове в версії 3.2: PyExc_ResourceWarning
.
Примітки:
- 3
Це базовий клас для інших стандартних категорій попереджень.