異常處理?

本章描述的函數(shù)將讓你處理和觸發(fā) Python 異常。了解一些 Python 異常處理的基本知識是很重要的。 它的工作原理有點像 POSIX 的 errno 變量:(每個線程)有一個全局指示器顯示最近發(fā)生的錯誤。 大多數(shù) C API 函數(shù)不會在成功時理會它,但會在失敗時設置它來指示錯誤的原因。 多數(shù) C API 函數(shù)也返回一個錯誤指示器,如果它們應該返回一個指針,通常返回 NULL,如果返回一個整數(shù),則返回 -1 (例外: PyArg_* 函數(shù)成功時返回 1 而失敗時返回 0)。

具體地說,錯誤指示器由三個對象指針組成:異常的類型,異常的值,和回溯對象。如果沒有錯誤被設置,這些指針都可以是 NULL (盡管一些組合使禁止的,例如,如果異常類型是 NULL,你不能有一個非 NULL 的回溯)。

當一個函數(shù)由于它調(diào)用的某個函數(shù)失敗而必須失敗時,通常不會設置錯誤指示器;它調(diào)用的那個函數(shù)已經(jīng)設置了它。而它負責處理錯誤和清理異常,或在清除其擁有的所有資源后返回(如對象應用或內(nèi)存分配)。如果不準備處理異常,則 應該正常地繼續(xù)。如果是由于一個錯誤返回,那么一定要向調(diào)用者表明已經(jīng)設置了錯誤。如果錯誤沒有得到處理或小心傳播,對 Python/C API的其它調(diào)用可能不會有預期的行為,并且可能會以某種神秘的方式失敗。

備注

錯誤指示器 不是 sys.exc_info() 的執(zhí)行結果。前者對應尚未捕獲的異常(異常還在傳播),而后者在捕獲異常后返回這個異常(異常已經(jīng)停止傳播)。

打印和清理?

void PyErr_Clear()?
Part of the Stable ABI.

清除錯誤指示器。如果沒有設置錯誤指示器,則不會有作用。

void PyErr_PrintEx(int set_sys_last_vars)?
Part of the Stable ABI.

將標準回溯打印到 sys.stderr 并清除錯誤指示器。除非 錯誤是 SystemExit,這種情況下不會打印回溯進程,且會退出 Python 進程,并顯示 SystemExit 實例指定的錯誤代碼。

只有在錯誤指示器被設置時才需要調(diào)用這個函數(shù),否則這會導致錯誤!

如果 set_sys_last_vars 非零,則變量 sys.last_type,sys.last_valuesys.last_traceback 將分別設置為打印異常的類型,值和回溯。

void PyErr_Print()?
Part of the Stable ABI.

PyErr_PrintEx(1) 的別名。

void PyErr_WriteUnraisable(PyObject *obj)?
Part of the Stable ABI.

使用當前異常和 obj 參數(shù)調(diào)用 sys.unraisablehook()。

當設置了異常,但解釋器不可能實際地觸發(fā)異常時,這個實用函數(shù)向 sys.stderr 打印一個警告信息。例如,當 __del__() 方法中發(fā)生異常時使用這個函數(shù)。

該函數(shù)使用單個參數(shù) obj 進行調(diào)用,該參數(shù)標識發(fā)生不可觸發(fā)異常的上下文。如果可能,obj 的報告將打印在警告消息中。

調(diào)用此函數(shù)時必須設置一個異常。

拋出異常?

這些函數(shù)可幫助你設置當前線程的錯誤指示器。為了方便起見,一些函數(shù)將始終返回 NULL 指針,以便用于 return 語句。

void PyErr_SetString(PyObject *type, const char *message)?
Part of the Stable ABI.

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)?
Part of the Stable ABI.

此函數(shù)類似于 PyErr_SetString(),但是允許你為異常的“值”指定任意一個 Python 對象。

PyObject *PyErr_Format(PyObject *exception, const char *format, ...)?
Return value: Always NULL. Part of the Stable ABI.

這個函數(shù)設置了一個錯誤指示器并且返回了 NULL,exception 應當是一個 Python 中的異常類。format 和隨后的形參會幫助格式化這個錯誤的信息;它們與 PyUnicode_FromFormat() 有著相同的含義和值。format 是一個ASCII編碼的字符串。

PyObject *PyErr_FormatV(PyObject *exception, const char *format, va_list vargs)?
Return value: Always NULL. Part of the Stable ABI since version 3.5.

PyErr_Format() 相同,但它接受一個 va_list 類型的參數(shù)而不是可變數(shù)量的參數(shù)集。

3.5 新版功能.

void PyErr_SetNone(PyObject *type)?
Part of the Stable ABI.

這是 PyErr_SetObject(type, Py_None) 的簡寫。

int PyErr_BadArgument()?
Part of the Stable ABI.

這是 PyErr_SetString(PyExc_TypeError, message) 的簡寫,其中 message 指出使用了非法參數(shù)調(diào)用內(nèi)置操作。它主要用于內(nèi)部使用。

PyObject *PyErr_NoMemory()?
Return value: Always NULL. Part of the Stable ABI.

這是 PyErr_SetNone(PyExc_MemoryError) 的簡寫;它返回 NULL ,以便當內(nèi)存耗盡時,對象分配函數(shù)可以寫 return PyErr_NoMemory(); 。

PyObject *PyErr_SetFromErrno(PyObject *type)?
Return value: Always NULL. Part of the Stable ABI.

這是個便捷函數(shù),當 C 庫函數(shù)返回錯誤并設置 errno 時,這個函數(shù)會觸發(fā)異常。它構造一個元組對象,其第一項是整數(shù)值 errno,第二項是相應的錯誤消息(從 strerror() 獲?。?,然后調(diào)用 PyErr_SetObject(type, object)。在 Unix 上,當 errno 值是 EINTR ,即中斷的系統(tǒng)調(diào)用時,這個函數(shù)會調(diào)用 PyErr_CheckSignals() ,如果設置了錯誤指示器,則將其設置為該值。該函數(shù)永遠返回 NULL ,因此當系統(tǒng)調(diào)用返回錯誤時,圍繞系統(tǒng)調(diào)用的包裝函數(shù)可以寫成 return PyErr_SetFromErrno(type);。

PyObject *PyErr_SetFromErrnoWithFilenameObject(PyObject *type, PyObject *filenameObject)?
Return value: Always NULL. Part of the Stable ABI.

類似于 PyErr_SetFromErrno() ,附加的行為是如果 filenameObject 不為 NULL ,它將作為第三個參數(shù)傳遞給 type 的構造函數(shù)。舉個例子,在 OSError 異常中,filenameObject 將用來定義異常實例的 filename 屬性。

PyObject *PyErr_SetFromErrnoWithFilenameObjects(PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)?
Return value: Always NULL. Part of the Stable ABI since version 3.7.

類似于 PyErr_SetFromErrnoWithFilenameObject() ,但接受第二個 filename 對象,用于當一個接受兩個 filename 的函數(shù)失敗時觸發(fā)錯誤。

3.4 新版功能.

PyObject *PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename)?
Return value: Always NULL. Part of the Stable ABI.

Similar to PyErr_SetFromErrnoWithFilenameObject(), but the filename is given as a C string. filename is decoded from the filesystem encoding and error handler.

PyObject *PyErr_SetFromWindowsErr(int ierr)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

這是觸發(fā) WindowsError 的方便的函數(shù)。如果 lerr0 ,則改用調(diào)用 GetLastError() 返回的錯誤代碼。它調(diào)用 Win32 函數(shù) FormatMessage() 來檢索 ierrGetLastError() 給定的錯誤代碼的 Windows 描述,然后構造一個元組對象,其第一項是 ierr 值,第二項是相應的錯誤信息(從 FormatMessage() 獲取),然后調(diào)用 PyErr_SetObject(PyExc_WindowsError, object) 。該函數(shù)永遠返回 NULL 。

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErr(PyObject *type, int ierr)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

類似于 PyErr_SetFromWindowsErr() ,額外的參數(shù)指定要觸發(fā)的異常類型。

可用性: Windows。

PyObject *PyErr_SetFromWindowsErrWithFilename(int ierr, const char *filename)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

類似于 PyErr_SetFromWindowsErrWithFilenameObject() ,但是 filename 是以 C 字符串形式給出的。 filename 是從文件系統(tǒng)編碼(os.fsdecode())解碼出來的。

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErrWithFilenameObject(PyObject *type, int ierr, PyObject *filename)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

類似于 PyErr_SetFromWindowsErrWithFilenameObject() ,額外參數(shù)指定要觸發(fā)的異常類型。

可用性: Windows。

PyObject *PyErr_SetExcFromWindowsErrWithFilenameObjects(PyObject *type, int ierr, PyObject *filename, PyObject *filename2)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

類似于 PyErr_SetExcFromWindowsErrWithFilenameObject() ,但是接受第二個 filename 對象。

可用性: Windows。

3.4 新版功能.

PyObject *PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename)?
Return value: Always NULL. Part of the Stable ABI on Windows since version 3.7.

類似于 PyErr_SetFromWindowsErrWithFilename() ,額外參數(shù)指定要觸發(fā)的異常類型。

可用性: Windows。

PyObject *PyErr_SetImportError(PyObject *msg, PyObject *name, PyObject *path)?
Return value: Always NULL. Part of the Stable ABI since version 3.7.

這是觸發(fā) ImportError 的便捷函數(shù)。 msg 將被設為異常的消息字符串。 namepath ,(都可以為 NULL ),將用來被設置 ImportError 對應的屬性 namepath。

3.3 新版功能.

PyObject *PyErr_SetImportErrorSubclass(PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)?
Return value: Always NULL. Part of the Stable ABI since version 3.6.

PyErr_SetImportError() 很類似,但這個函數(shù)允許指定一個 ImportError 的子類來觸發(fā)。

3.6 新版功能.

void PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset)?

設置當前異常的文件,行和偏移信息。如果當前異常不是 SyntaxError ,則它設置額外的屬性,使異常打印子系統(tǒng)認為異常是 SyntaxError

3.4 新版功能.

void PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)?
Part of the Stable ABI since version 3.7.

Like PyErr_SyntaxLocationObject(), but filename is a byte string decoded from the filesystem encoding and error handler.

3.2 新版功能.

void PyErr_SyntaxLocation(const char *filename, int lineno)?
Part of the Stable ABI.

Like PyErr_SyntaxLocationEx(), but the col_offset parameter is omitted.

void PyErr_BadInternalCall()?
Part of the Stable ABI.

這是 PyErr_SetString(PyExc_SystemError, message) 的縮寫,其中 message 表示使用了非法參數(shù)調(diào)用內(nèi)部操作(例如,Python/C API 函數(shù))。它主要用于內(nèi)部使用。

發(fā)出警告?

這些函數(shù)可以從 C 代碼中發(fā)出警告。它們仿照了由 Python 模塊 warnings 導出的那些函數(shù)。它們通常向 sys.stderr 打印一條警告信息;當然,用戶也有可能已經(jīng)指定將警告轉換為錯誤,在這種情況下,它們將觸發(fā)異常。也有可能由于警告機制出現(xiàn)問題,使得函數(shù)觸發(fā)異常。如果沒有觸發(fā)異常,返回值為 0 ;如果觸發(fā)異常,返回值為 -1。(無法確定是否實際打印了警告信息,也無法確定異常觸發(fā)的原因。這是故意為之)。如果觸發(fā)了異常,調(diào)用者應該進行正常的異常處理(例如,Py_DECREF() 持有引用并返回一個錯誤值)。

int PyErr_WarnEx(PyObject *category, const char *message, Py_ssize_t stack_level)?
Part of the Stable ABI.

發(fā)出一個警告信息。參數(shù) category 是一個警告類別(見下面)或 NULL ; message 是一個 UTF-8 編碼的字符串。 stack_level 是一個給出棧幀數(shù)量的正數(shù);警告將從該棧幀中當前正在執(zhí)行的代碼行發(fā)出。 stack_level 為 1 的是調(diào)用 PyErr_WarnEx() 的函數(shù),2 是在此之上的函數(shù),以此類推。

警告類別必須是 PyExc_Warning 的子類, PyExc_WarningPyExc_Exception 的子類;默認警告類別是 PyExc_RuntimeWarning 。標準 Python 警告類別作為全局變量可用,所有其名稱見 標準警告類別 。

有關警告控制的信息,參見模塊文檔 warnings 和命令行文檔中的 -W 選項。沒有用于警告控制的 C API。

int PyErr_WarnExplicitObject(PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)?

Issue a warning message with explicit control over all warning attributes. This is a straightforward wrapper around the Python function warnings.warn_explicit(); see there for more information. The module and registry arguments may be set to NULL to get the default effect described there.

3.4 新版功能.

int PyErr_WarnExplicit(PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)?
Part of the Stable ABI.

Similar to PyErr_WarnExplicitObject() except that message and module are UTF-8 encoded strings, and filename is decoded from the filesystem encoding and error handler.

int PyErr_WarnFormat(PyObject *category, Py_ssize_t stack_level, const char *format, ...)?
Part of the Stable ABI.

Function similar to PyErr_WarnEx(), but use PyUnicode_FromFormat() to format the warning message. format is an ASCII-encoded string.

3.2 新版功能.

int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)?
Part of the Stable ABI since version 3.6.

Function similar to PyErr_WarnFormat(), but category is ResourceWarning and it passes source to warnings.WarningMessage().

3.6 新版功能.

查詢錯誤指示器?

PyObject *PyErr_Occurred()?
Return value: Borrowed reference. Part of the Stable ABI.

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 to PyErr_Restore()). If not set, return NULL. You do not own a reference to the return value, so you do not need to Py_DECREF() it.

呼叫者必須持有GIL。

備注

Do not compare the return value to a specific exception; use PyErr_ExceptionMatches() instead, shown below. (The comparison could easily fail since the exception may be an instance instead of a class, in the case of a class exception, or it may be a subclass of the expected exception.)

int PyErr_ExceptionMatches(PyObject *exc)?
Part of the Stable ABI.

Equivalent to PyErr_GivenExceptionMatches(PyErr_Occurred(), exc). This should only be called when an exception is actually set; a memory access violation will occur if no exception has been raised.

int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc)?
Part of the Stable ABI.

Return true if the given exception matches the exception type in exc. If exc is a class object, this also returns true when given is an instance of a subclass. If exc is a tuple, all exception types in the tuple (and recursively in subtuples) are searched for a match.

void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)?
Part of the Stable ABI.

Retrieve the error indicator into three variables whose addresses are passed. If the error indicator is not set, set all three variables to NULL. If it is set, it will be cleared and you own a reference to each object retrieved. The value and traceback object may be NULL even when the type object is not.

備注

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)?
Part of the Stable ABI.

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.)

備注

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)?
Part of the Stable ABI.

Under certain circumstances, the values returned by PyErr_Fetch() below can be "unnormalized", meaning that *exc is a class object but *val is not an instance of the same class. This function can be used to instantiate the class in that case. If the values are already normalized, nothing happens. The delayed normalization is implemented to improve performance.

備注

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);
}
PyObject *PyErr_GetHandledException(void)?
Part of the Stable ABI since version 3.11.

Retrieve the active exception instance, as would be returned by sys.exception(). This refers to an exception that was already caught, not to an exception that was freshly raised. Returns a new reference to the exception or NULL. Does not modify the interpreter's exception state.

備注

This function is not normally used by code that wants to handle exceptions. Rather, it can be used when code needs to save and restore the exception state temporarily. Use PyErr_SetHandledException() to restore or clear the exception state.

3.11 新版功能.

void PyErr_SetHandledException(PyObject *exc)?
Part of the Stable ABI since version 3.11.

Set the active exception, as known from sys.exception(). This refers to an exception that was already caught, not to an exception that was freshly raised. To clear the exception state, pass NULL.

備注

This function is not normally used by code that wants to handle exceptions. Rather, it can be used when code needs to save and restore the exception state temporarily. Use PyErr_GetHandledException() to get the exception state.

3.11 新版功能.

void PyErr_GetExcInfo(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)?
Part of the Stable ABI since version 3.7.

Retrieve the old-style representation of 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 be NULL. Does not modify the exception info state. This function is kept for backwards compatibility. Prefer using PyErr_GetHandledException().

備注

This function is not normally used by code that wants to handle exceptions. Rather, it can be used when code needs to save and restore the exception state temporarily. Use PyErr_SetExcInfo() to restore or clear the exception state.

3.3 新版功能.

void PyErr_SetExcInfo(PyObject *type, PyObject *value, PyObject *traceback)?
Part of the Stable ABI since version 3.7.

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, pass NULL for all three arguments. This function is kept for backwards compatibility. Prefer using PyErr_SetHandledException().

備注

This function is not normally used by code that wants to handle exceptions. Rather, it can be used when code needs to save and restore the exception state temporarily. Use PyErr_GetExcInfo() to read the exception state.

3.3 新版功能.

在 3.11 版更改: The type and traceback arguments are no longer used and can be NULL. The interpreter now derives them from the exception instance (the value argument). The function still steals references of all three arguments.

信號處理?

int PyErr_CheckSignals()?
Part of the Stable ABI.

這個函數(shù)與Python的信號處理交互。

如果在主 Python 解釋器下從主線程調(diào)用該函數(shù),它將檢查是否向進程發(fā)送了信號,如果是,則發(fā)起調(diào)用相應的信號處理句柄。 如果支持 signal 模塊,則可以發(fā)起調(diào)用以 Python 編寫的信號處理句柄。

該函數(shù)會嘗試處理所有待處理信號,然后返回 0。 但是,如果 Python 信號處理句柄引發(fā)了異常,則設置錯誤指示符并且函數(shù)將立即返回 -1 (這樣其他待處理信號可能還沒有被處理:它們將在下次發(fā)起調(diào)用 PyErr_CheckSignals() 時被處理)。

如果函數(shù)從非主線程調(diào)用,或在非主Python解釋器下調(diào)用,則它不執(zhí)行任何操作并返回0。

這個函數(shù)可以由希望被用戶請求(例如按Ctrl-C)中斷的長時間運行的C代碼調(diào)用。

備注

針對 SIGINT 的默認 Python 信號處理句柄會引發(fā) KeyboardInterrupt 異常。

void PyErr_SetInterrupt()?
Part of the Stable ABI.

Simulate the effect of a SIGINT signal arriving. This is equivalent to PyErr_SetInterruptEx(SIGINT).

備注

This function is async-signal-safe. It can be called without the GIL and from a C signal handler.

int PyErr_SetInterruptEx(int signum)?
Part of the Stable ABI since version 3.10.

Simulate the effect of a signal arriving. The next time PyErr_CheckSignals() is called, the Python signal handler for the given signal number will be called.

This function can be called by C code that sets up its own signal handling and wants Python signal handlers to be invoked as expected when an interruption is requested (for example when the user presses Ctrl-C to interrupt an operation).

If the given signal isn't handled by Python (it was set to signal.SIG_DFL or signal.SIG_IGN), it will be ignored.

If signum is outside of the allowed range of signal numbers, -1 is returned. Otherwise, 0 is returned. The error indicator is never changed by this function.

備注

This function is async-signal-safe. It can be called without the GIL and from a C signal handler.

3.10 新版功能.

int PySignal_SetWakeupFd(int fd)?

This utility function specifies a file descriptor to which the signal number is written as a single byte whenever a signal is received. fd must be non-blocking. It returns the previous such file descriptor.

The value -1 disables the feature; this is the initial state. This is equivalent to signal.set_wakeup_fd() in Python, but without any error checking. fd should be a valid file descriptor. The function should only be called from the main thread.

在 3.5 版更改: 在 Windows 上,此函數(shù)現(xiàn)在也支持套接字處理。

Exception 類?

PyObject *PyErr_NewException(const char *name, PyObject *base, PyObject *dict)?
Return value: New reference. Part of the Stable ABI.

This utility function creates and returns a new exception class. The name argument must be the name of the new exception, a C string of the form module.classname. The base and dict arguments are normally NULL. This creates a class object derived from Exception (accessible in C as 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. Part of the Stable ABI.

PyErr_NewException() 一樣,除了可以輕松地給新的異常類一個文檔字符串:如果 doc 屬性非空,它將用作異常類的文檔字符串。

3.2 新版功能.

異常對象?

PyObject *PyException_GetTraceback(PyObject *ex)?
Return value: New reference. Part of the Stable ABI.

Return the traceback associated with the exception as a new reference, as accessible from Python through __traceback__. If there is no traceback associated, this returns NULL.

int PyException_SetTraceback(PyObject *ex, PyObject *tb)?
Part of the Stable ABI.

將異常關聯(lián)的回溯設置為 tb 。使用``Py_None``清除它。

PyObject *PyException_GetContext(PyObject *ex)?
Return value: New reference. Part of the Stable ABI.

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 returns NULL.

void PyException_SetContext(PyObject *ex, PyObject *ctx)?
Part of the Stable ABI.

Set the context associated with the exception to ctx. Use NULL to clear it. There is no type check to make sure that ctx is an exception instance. This steals a reference to ctx.

PyObject *PyException_GetCause(PyObject *ex)?
Return value: New reference. Part of the Stable ABI.

Return the cause (either an exception instance, or None, set by raise ... from ...) associated with the exception as a new reference, as accessible from Python through __cause__.

void PyException_SetCause(PyObject *ex, PyObject *cause)?
Part of the Stable ABI.

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 or None. This steals a reference to cause.

__suppress_context__ is implicitly set to True by this function.

Unicode 異常對象?

The following functions are used to create and modify Unicode exceptions from 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. Part of the Stable ABI.

Create a UnicodeDecodeError object with the attributes encoding, object, length, start, end and reason. encoding and reason are UTF-8 encoded strings.

PyObject *PyUnicodeDecodeError_GetEncoding(PyObject *exc)?
PyObject *PyUnicodeEncodeError_GetEncoding(PyObject *exc)?
Return value: New reference. Part of the Stable ABI.

返回給定異常對象的 encoding 屬性

PyObject *PyUnicodeDecodeError_GetObject(PyObject *exc)?
PyObject *PyUnicodeEncodeError_GetObject(PyObject *exc)?
PyObject *PyUnicodeTranslateError_GetObject(PyObject *exc)?
Return value: New reference. Part of the Stable ABI.

返回給定異常對象的 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)?
Part of the Stable ABI.

Get the start attribute of the given exception object and place it into *start. start must not be NULL. Return 0 on success, -1 on failure.

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)?
Part of the Stable ABI.

Set the start attribute of the given exception object to start. Return 0 on success, -1 on failure.

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)?
Part of the Stable ABI.

Get the end attribute of the given exception object and place it into *end. end must not be NULL. Return 0 on success, -1 on failure.

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)?
Part of the Stable ABI.

Set the end attribute of the given exception object to end. Return 0 on success, -1 on failure.

PyObject *PyUnicodeDecodeError_GetReason(PyObject *exc)?
PyObject *PyUnicodeEncodeError_GetReason(PyObject *exc)?
PyObject *PyUnicodeTranslateError_GetReason(PyObject *exc)?
Return value: New reference. Part of the Stable ABI.

返回給定異常對象的 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)?
Part of the Stable ABI.

Set the reason attribute of the given exception object to reason. Return 0 on success, -1 on failure.

遞歸控制?

These two functions provide a way to perform safe recursive calls at the C level, both in the core and in extension modules. They are needed if the recursive code does not necessarily invoke Python code (which tracks its recursion depth automatically). They are also not needed for tp_call implementations because the call protocol takes care of recursion handling.

int Py_EnterRecursiveCall(const char *where)?
Part of the Stable ABI since version 3.9.

Marks a point where a recursive C-level call is about to be performed.

如果定義了 USE_STACKCHECK,此函數(shù)會使用 PyOS_CheckStack() 來檢查操作系統(tǒng)堆棧是否溢出。 在這種情況下,它將設置一個 MemoryError 并返回非零值。

The function then checks if the recursion limit is reached. If this is the case, a RecursionError is set and a nonzero value is returned. Otherwise, zero is returned.

where should be a UTF-8 encoded string such as " in instance check" to be concatenated to the RecursionError message caused by the recursion depth limit.

在 3.9 版更改: This function is now also available in the limited API.

void Py_LeaveRecursiveCall(void)?
Part of the Stable ABI since version 3.9.

Ends a Py_EnterRecursiveCall(). Must be called once for each successful invocation of Py_EnterRecursiveCall().

在 3.9 版更改: This function is now also available in the limited API.

Properly implementing tp_repr for container types requires special recursion handling. In addition to protecting the stack, tp_repr also needs to track objects to prevent cycles. The following two functions facilitate this functionality. Effectively, these are the C equivalent to reprlib.recursive_repr().

int Py_ReprEnter(PyObject *object)?
Part of the Stable ABI.

Called at the beginning of the tp_repr implementation to detect cycles.

If the object has already been processed, the function returns a positive integer. In that case the tp_repr implementation should return a string object indicating a cycle. As examples, dict objects return {...} and list objects return [...].

The function will return a negative integer if the recursion limit is reached. In that case the tp_repr implementation should typically return NULL.

Otherwise, the function returns zero and the tp_repr implementation can continue normally.

void Py_ReprLeave(PyObject *object)?
Part of the Stable ABI.

Ends a Py_ReprEnter(). Must be called once for each invocation of Py_ReprEnter() that returns zero.

標準異常?

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 名稱

備注

PyExc_BaseException

BaseException

1

PyExc_Exception

Exception

1

PyExc_ArithmeticError

ArithmeticError

1

PyExc_AssertionError

AssertionError

PyExc_AttributeError

AttributeError

PyExc_BlockingIOError

BlockingIOError

PyExc_BrokenPipeError

BrokenPipeError

PyExc_BufferError

BufferError

PyExc_ChildProcessError

ChildProcessError

PyExc_ConnectionAbortedError

ConnectionAbortedError

PyExc_ConnectionError

ConnectionError

PyExc_ConnectionRefusedError

ConnectionRefusedError

PyExc_ConnectionResetError

ConnectionResetError

PyExc_EOFError

EOFError

PyExc_FileExistsError

FileExistsError

PyExc_FileNotFoundError

FileNotFoundError

PyExc_FloatingPointError

FloatingPointError

PyExc_GeneratorExit

GeneratorExit

PyExc_ImportError

ImportError

PyExc_IndentationError

IndentationError

PyExc_IndexError

IndexError

PyExc_InterruptedError

InterruptedError

PyExc_IsADirectoryError

IsADirectoryError

PyExc_KeyError

KeyError

PyExc_KeyboardInterrupt

KeyboardInterrupt

PyExc_LookupError

LookupError

1

PyExc_MemoryError

MemoryError

PyExc_ModuleNotFoundError

ModuleNotFoundError

PyExc_NameError

NameError

PyExc_NotADirectoryError

NotADirectoryError

PyExc_NotImplementedError

NotImplementedError

PyExc_OSError

OSError

1

PyExc_OverflowError

OverflowError

PyExc_PermissionError

PermissionError

PyExc_ProcessLookupError

ProcessLookupError

PyExc_RecursionError

RecursionError

PyExc_ReferenceError

ReferenceError

PyExc_RuntimeError

RuntimeError

PyExc_StopAsyncIteration

StopAsyncIteration

PyExc_StopIteration

StopIteration

PyExc_SyntaxError

SyntaxError

PyExc_SystemError

SystemError

PyExc_SystemExit

SystemExit

PyExc_TabError

TabError

PyExc_TimeoutError

TimeoutError

PyExc_TypeError

TypeError

PyExc_UnboundLocalError

UnboundLocalError

PyExc_UnicodeDecodeError

UnicodeDecodeError

PyExc_UnicodeEncodeError

UnicodeEncodeError

PyExc_UnicodeError

UnicodeError

PyExc_UnicodeTranslateError

UnicodeTranslateError

PyExc_ValueError

ValueError

PyExc_ZeroDivisionError

ZeroDivisionError

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 and PyExc_TimeoutError 介紹如下 PEP 3151.

3.5 新版功能: PyExc_StopAsyncIterationPyExc_RecursionError.

3.6 新版功能: PyExc_ModuleNotFoundError.

這些是兼容性別名 PyExc_OSError:

C 名稱

備注

PyExc_EnvironmentError

PyExc_IOError

PyExc_WindowsError

2

在 3.3 版更改: 這些別名曾經(jīng)是單獨的異常類型。

注釋:

1(1,2,3,4,5)

這是其他標準異常的基類。

2

Only defined on Windows; protect code that uses this by testing that the preprocessor macro MS_WINDOWS is defined.

標準警告類別?

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 名稱

備注

PyExc_Warning

Warning

3

PyExc_BytesWarning

BytesWarning

PyExc_DeprecationWarning

DeprecationWarning

PyExc_FutureWarning

FutureWarning

PyExc_ImportWarning

ImportWarning

PyExc_PendingDeprecationWarning

PendingDeprecationWarning

PyExc_ResourceWarning

ResourceWarning

PyExc_RuntimeWarning

RuntimeWarning

PyExc_SyntaxWarning

SyntaxWarning

PyExc_UnicodeWarning

UnicodeWarning

PyExc_UserWarning

UserWarning

3.2 新版功能: PyExc_ResourceWarning.

注釋:

3

這是其他標準警告類別的基類。