函式物件 (Function Objects)¶
這有一些特用於 Python 函式的函式。
-
type PyFunctionObject¶
用於函式的 C 結構。
-
PyTypeObject PyFunction_Type¶
這是個
PyTypeObject的實例，且代表了 Python 函式型別，Python 程式設計者可透過types.FunctionType使用它。
-
int PyFunction_Check(PyObject *o)¶
如果 o 是個函式物件（擁有
PyFunction_Type的型別）則回傳 true。參數必須不為NULL。此函式必能成功執行。
-
PyObject *PyFunction_New(PyObject *code, PyObject *globals)¶
- 回傳值：新的參照。
回傳一個與程式碼物件 code 相關聯的函式物件。globals 必須是一個帶有函式能夠存取的全域變數的字典。
函式的文件字串 (docstring) 和名稱是從程式碼物件所取得，__module__ 是自 globals 所取得。引數預設值、標註 (annotation) 和閉包 (closure) 被設為
NULL，__qualname__ 被設為和程式碼物件co_qualname欄位相同的值。
-
PyObject *PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)¶
- 回傳值：新的參照。
和
PyFunction_New()相似，但也允許函式物件__qualname__屬性的設定，qualname 應為一個 unicode 物件或是NULL；如為NULL，__qualname__屬性會被設為與程式碼物件co_qualname欄位相同的值。在 3.3 版本新加入.
-
PyObject *PyFunction_GetModule(PyObject *op)¶
- 回傳值：借用參照。
回傳一個函式物件 op 之 __module__ 屬性的 borrowed reference，它可以是 NULL。
這通常是個包含模組名稱的字串，但可以被 Python 程式設為任何其他物件。
-
PyObject *PyFunction_GetDefaults(PyObject *op)¶
- 回傳值：借用參照。
回傳函式物件 op 的引數預設值，這可以是一個含有多個引數的 tuple（元組）或
NULL。
-
int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)¶
設定函式物件 op 的引數預設值。defaults 必須是
Py_None或一個 tuple。引發
SystemError且在失敗時回傳-1。
-
void PyFunction_SetVectorcall(PyFunctionObject *func, vectorcallfunc vectorcall)¶
為一個給定的函式物件 func 設定 vectorcall 欄位。
警告：使用此 API 的扩展必须保留未修改的（默认） vectorcall 函数的行为！
在 3.12 版本新加入.
-
PyObject *PyFunction_GetClosure(PyObject *op)¶
- 回傳值：借用參照。
回傳與函式物件 op 相關聯的閉包，這可以是個
NULL或是一個包含 cell 物件的 tuple。
-
int PyFunction_SetClosure(PyObject *op, PyObject *closure)¶
設定與函式物件 op 相關聯的閉包，closure 必須是
Py_None或是一個包含 cell 物件的 tuple。引發
SystemError且在失敗時回傳-1。
-
PyObject *PyFunction_GetAnnotations(PyObject *op)¶
- 回傳值：借用參照。
回傳函式物件 op 的標註，這可以是一個可變動的 (mutable) 字典或
NULL。
-
int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)¶
設定函式物件 op 的標註，annotations 必須是一個字典或
Py_None。引發
SystemError且在失敗時回傳-1。
-
int PyFunction_AddWatcher(PyFunction_WatchCallback callback)¶
注册 callback 作为当前解释器的函数监视器。 返回一个可被传给
PyFunction_ClearWatcher()的 ID。 如果出现错误（比如没有足够的可用监视器 ID），则返回-1并设置一个异常。在 3.12 版本新加入.
-
int PyFunction_ClearWatcher(int watcher_id)¶
清空当前解释器在之前从Clear watcher identified by previously returned from
PyFunction_AddWatcher()返回的由 watcher_id 所标识的监视器。 成功时返回0，或者出错时（比如当给定的 watcher_id 未被注册）返回-1并设置一个异常。在 3.12 版本新加入.
-
type PyFunction_WatchEvent¶
由以下可能的函数监视器事件组成的枚举: -
PyFunction_EVENT_CREATE-PyFunction_EVENT_DESTROY-PyFunction_EVENT_MODIFY_CODE-PyFunction_EVENT_MODIFY_DEFAULTS-PyFunction_EVENT_MODIFY_KWDEFAULTS在 3.12 版本新加入.
-
typedef int (*PyFunction_WatchCallback)(PyFunction_WatchEvent event, PyFunctionObject *func, PyObject *new_value)¶
函数监视器回调函数的类型。
如果 event 为
PyFunction_EVENT_CREATE或PyFunction_EVENT_DESTROY则 new_value 将为NULL。 在其他情况下，new_value 将为被修改的属性持有一个指向要保存在 func 中的新值的 borrowed reference。该回调可以检查但不能修改 func; 这样做可能具有不可预知的影响，包括无限递归。
如果 event 是
PyFunction_EVENT_CREATE，则该回调会在 func 完成初始化之后被发起调用。 在其他情况下，该回调会在对 func 进行修改之前被发起调用，这样就可以检查 func 之前的状态。 如有可能函数对象的创建允许被运行时优化掉。 在此情况下将不发出任何事件。 虽然根据不同的优化决定这会产生可被观察到的运行时行为变化，但是它不会改变被运行的 Python 代码的语义。如果 event 是
PyFunction_EVENT_DESTROY，则在回调中接受一个即将销毁的函数的引用将使其重生，并阻止其在此时被释放。 当重生的对象以后再被销毁时，任何在当时已激活的监视器回调将再次被调用。如果该回调设置了一个异常，则它必须返回
-1；此异常将作为不可引发的异常使用PyErr_WriteUnraisable()打印出来。 在其他情况下它应当返回0。在进入回调时可能已经设置了尚未处理的异常。 在此情况下，回调应当返回
0并仍然设置同样的异常。 这意味着该回调可能不会调用任何其他可设置异常的 API 除非它先保存并清空异常状态，并在返回之前恢复它。在 3.12 版本新加入.