Function オブジェクト
*********************

Functionオブジェクト固有の関数はわずかです。

type PyFunctionObject

   関数に使われるCの構造体。

PyTypeObject PyFunction_Type

   "PyTypeObject" 型のインスタンスで、 Python の関数型を表します。これ
   は Python プログラムに "types.FunctionType" として公開されています
   。

int PyFunction_Check(PyObject *o)

   *o* が関数オブジェクト ("PyFunction_Type" 型である) 場合に真を返し
   ます。パラメータは "NULL" にできません。この関数は常に成功します。

PyObject *PyFunction_New(PyObject *code, PyObject *globals)
    *戻り値: 新しい参照。*

   コードオブジェクト *code* に関連付けられた新しい関数オブジェクトを
   返します。*globals* はこの関数からアクセスできるグローバル変数の辞
   書でなければなりません。

   関数のドキュメント文字列と名前はコードオブジェクトから取得されます
   。 "__module__" は *globals* から取得されます。 引数のデフォルト値
   やアノテーション、クロージャは "NULL" に設定されます。
   "__qualname__" はコードオブジェクトの "co_qualname" フィールドと同
   じ値に設定されます。

PyObject *PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)
    *戻り値: 新しい参照。*

   "PyFunction_New()" に似ていますが、関数オブジェクトの
   "__qualname__" 属性に値をセットできます。 *qualname* はユニコードオ
   ブジェクトか "NULL" でなくてはなりません。"NULL" だった場合、
   "__qualname__" 属性にはコードオブジェクトの "co_qualname" フィール
   ドと同じ値がセットされます。

   Added in version 3.3.

PyObject *PyFunction_GetCode(PyObject *op)
    *戻り値: 借用参照。*

   関数オブジェクト *op* に関連付けられたコードオブジェクトを返します
   。

PyObject *PyFunction_GetGlobals(PyObject *op)
    *戻り値: 借用参照。*

   関数オブジェクト *op* に関連付けられたglobals辞書を返します。

PyObject *PyFunction_GetModule(PyObject *op)
    *戻り値: 借用参照。*

   Return a *borrowed reference* to the "__module__" attribute of the
   function object *op*. It can be *NULL*.

   This is normally a "string" containing the module name, but can be
   set to any other object by Python code.

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)

   Set the vectorcall field of a given function object *func*.

   Warning: extensions using this API must preserve the behavior of
   the unaltered (default) vectorcall function!

   Added in version 3.12.

PyObject *PyFunction_GetKwDefaults(PyObject *op)
    *戻り値: 借用参照。*

   Return the keyword-only argument default values of the function
   object *op*. This can be a dictionary of arguments or "NULL".

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)
    *戻り値: 借用参照。*

   These functions are similar to their "PyFunction_Get*"
   counterparts, but do not do type checking. Passing anything other
   than an instance of "PyFunction_Type" is undefined behavior.

int PyFunction_AddWatcher(PyFunction_WatchCallback callback)

   Register *callback* as a function watcher for the current
   interpreter. Return an ID which may be passed to
   "PyFunction_ClearWatcher()". In case of error (e.g. no more watcher
   IDs available), return "-1" and set an exception.

   Added in version 3.12.

int PyFunction_ClearWatcher(int watcher_id)

   Clear watcher identified by *watcher_id* previously returned from
   "PyFunction_AddWatcher()" for the current interpreter. Return "0"
   on success, or "-1" and set an exception on error (e.g.  if the
   given *watcher_id* was never registered.)

   Added in version 3.12.

type PyFunction_WatchEvent

      Enumeration of possible function watcher events:

      * "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)

   Type of a function watcher callback function.

   If *event* is "PyFunction_EVENT_CREATE" or
   "PyFunction_EVENT_DESTROY" then *new_value* will be "NULL".
   Otherwise, *new_value* will hold a *borrowed reference* to the new
   value that is about to be stored in *func* for the attribute that
   is being modified.

   The callback may inspect but must not modify *func*; doing so could
   have unpredictable effects, including infinite recursion.

   If *event* is "PyFunction_EVENT_CREATE", then the callback is
   invoked after *func* has been fully initialized. Otherwise, the
   callback is invoked before the modification to *func* takes place,
   so the prior state of *func* can be inspected. The runtime is
   permitted to optimize away the creation of function objects when
   possible. In such cases no event will be emitted. Although this
   creates the possibility of an observable difference of runtime
   behavior depending on optimization decisions, it does not change
   the semantics of the Python code being executed.

   If *event* is "PyFunction_EVENT_DESTROY",  Taking a reference in
   the callback to the about-to-be-destroyed function will resurrect
   it, preventing it from being freed at this time. When the
   resurrected object is destroyed later, any watcher callbacks active
   at that time will be called again.

   If the callback sets an exception, it must return "-1"; this
   exception will be printed as an unraisable exception using
   "PyErr_WriteUnraisable()". Otherwise it should return "0".

   There may already be a pending exception set on entry to the
   callback. In this case, the callback should return "0" with the
   same exception still set. This means the callback may not call any
   other API that can set an exception unless it saves and clears the
   exception state first, and restores it before returning.

   Added in version 3.12.
