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" 字段相同的值
   。

   Added in version 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 函数的行
   为！

   Added in version 3.12.

PyObject *PyFunction_GetKwDefaults(PyObject *op)
    *返回值：借入的引用。*

   返回函数对象 *op* 的仅限关键字参数默认值。这可以是一个参数字典或
   "NULL"。

int PyFunction_SetKwDefaults(PyObject *op, PyObject *defaults)

   设置函数对象 *op* 的仅限关键字参数默认值。 *defaults* 必须是由仅限
   关键字参数组成的字典或为 "Py_None"。

   此函数成功时返回 "0"，失败时返回 "-1" 并设置一个异常。

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"。

PyObject *PyFunction_GET_CODE(PyObject *op)
PyObject *PyFunction_GET_GLOBALS(PyObject *op)
PyObject *PyFunction_GET_MODULE(PyObject *op)
PyObject *PyFunction_GET_DEFAULTS(PyObject *op)
PyObject *PyFunction_GET_KW_DEFAULTS(PyObject *op)
PyObject *PyFunction_GET_CLOSURE(PyObject *op)
PyObject *PyFunction_GET_ANNOTATIONS(PyObject *op)
    *返回值：借入的引用。*

   这些函数与它们的 "PyFunction_Get*" 对应物类似，但不会进行类型检查。
   传入 "PyFunction_Type" 的实例以外的任何东西都是未定义的行为。

int PyFunction_AddWatcher(PyFunction_WatchCallback callback)

   注册 *callback* 作为当前解释器的函数监视器。返回一个可被传给
   "PyFunction_ClearWatcher()" 的 ID。如果出现错误（比如没有足够的可用
   监视器 ID），则返回 "-1" 并设置一个异常。

   Added in version 3.12.

int PyFunction_ClearWatcher(int watcher_id)

   清空当前解释器在之前从 "PyFunction_AddWatcher()" 返回的由
   *watcher_id* 所标识的监视器。成功时返回 "0"，或者出错时（比如当给定
   的 *watcher_id* 未被注册）返回 "-1" 并设置一个异常。

   Added in version 3.12.

type PyFunction_WatchEvent

      由可能的函数监视事件组成的枚举：

      * "PyFunction_EVENT_CREATE"

      * "PyFunction_EVENT_DESTROY"

      * "PyFunction_EVENT_MODIFY_CODE"

      * "PyFunction_EVENT_MODIFY_DEFAULTS"

      * "PyFunction_EVENT_MODIFY_KWDEFAULTS"

   Added in version 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 除非它先保存并清空异常状态，并在返回之前恢复它。

   Added in version 3.12.
