Function 对象

Function 对象

有一些特定于 Python 函数的函数。

type PyFunctionObject

用于函数的 C 结构体。

PyTypeObject PyFunction_Type

这是一个 PyTypeObject 实例并表示 Python 函数类型。它作为 types.FunctionType 向 Python 程序员公开。

int PyFunction_Check(PyObject *o)

如果 o 是一个函数对象 (类型为 PyFunction_Type) 则返回真值。形参必须不为 NULL。此函数总是会成功执行。

PyObject *PyFunction_New(PyObject *code, PyObject *globals)

返回值：新的引用。

返回与代码对象 code 关联的新函数对象。 globals 必须是一个字典，该函数可以访问全局变量。

函数的文档字符串和名称是从代码对象中提取的。 \_module__ 是从 _globals 中提取的。参数 defaults, annotations 和 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_GetCode(PyObject *op)

返回值：借入的引用。

返回与函数对象 op 关联的代码对象。

PyObject *PyFunction_GetGlobals(PyObject *op)

返回值：借入的引用。

返回与函数对象*op*相关联的全局字典。

PyObject *PyFunction_GetModule(PyObject *op)

返回值：借入的引用。

向函数对象 op 的 \_module__ 属性返回一个 borrowed reference。该值可以为 _NULL。

这通常为一个包含模块名称的字符串，但可以通过 Python 代码设为任何其他对象。

PyObject *PyFunction_GetDefaults(PyObject *op)

返回值：借入的引用。

返回函数对象 op 的参数默认值。这可以是一个参数元组或 NULL。

int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)

为函数对象 op 设置参数默认值。 defaults 必须为 Py_None 或一个元组。

失败时引发 SystemError 异常并返回 -1 。

void PyFunction_SetVectorcall(PyFunctionObject *func, vectorcallfunc vectorcall)

设置给定函数对象 func 的 vectorcall 字段。

警告：使用此 API 的扩展必须保留未修改的（默认） vectorcall 函数的行为！

3.12 新版功能.

PyObject *PyFunction_GetClosure(PyObject *op)

返回值：借入的引用。

返回关联到函数对象 op 的闭包。这可以是 NULL 或 cell 对象的元组。

int PyFunction_SetClosure(PyObject *op, PyObject *closure)

设置关联到函数对象 op 的闭包。 closure 必须为 Py_None 或 cell 对象的元组。

失败时引发 SystemError 异常并返回 -1 。

PyObject *PyFunction_GetAnnotations(PyObject *op)

返回值：借入的引用。

返回函数对象 op 的标注。这可以是一个可变字典或 NULL。

int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)

设置函数对象 op 的标注。 annotations 必须为一个字典或 Py_None。

失败时引发 SystemError 异常并返回 -1 。

int PyFunction_AddWatcher(PyFunction_WatchCallback callback)

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 新版功能.