(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_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 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_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 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

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.

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

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

3.12 :

PyFunction_PYFUNC_EVENT_MODIFY_QUALNAME

3.15 .

PY_FOREACH_FUNC_EVENT(V): Apply the macro V to each suffix of PyFunction_WatchEvent constants. Currently expands to V(CREATE) V(DESTROY) V(MODIFY_CODE) V(MODIFY_DEFAULTS) V(MODIFY_KWDEFAULTS) V(MODIFY_QUALNAME). The macro V must accept one event name and supply any punctuation needed between expansions.

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.

3.12 .