There are a few functions specific to Python functions.
typePyFunctionObject
The C structure used for functions.
PyFunction_Type
This is an instance of
and represents the Python function type. It is exposed to Python programmers as types.FunctionType.
intPyFunction_Check(
*o)
Return true if o is a function object (has type
). The parameter must not be NULL. This function always succeeds.
*PyFunction_New(
*code,
*globals)
Return value: New reference.Return a new function object associated with the code object code. globals must be a dictionary with the global variables accessible to the function.
The function’s docstring and name are retrieved from the code object.
is retrieved from globals. The argument defaults, annotations and closure are set to NULL.
is set to the same value as the code object’s
field.
*PyFunction_NewWithQualName(
*code,
*globals,
*qualname)
Return value: New reference.As
, but also allows setting the function object’s
attribute. qualname should be a unicode object or NULL; if NULL, the __qualname__ attribute is set to the same value as the code object’s
field.
Added in version 3.3.
*PyFunction_GetCode(
*op)
Return value: Borrowed reference.Return the code object associated with the function object op.
*PyFunction_GetGlobals(
*op)
Return value: Borrowed reference.Return the globals dictionary associated with the function object op.
*PyFunction_GetModule(
*op)
Return value: Borrowed reference.Return a
to the
attribute of the
op. It can be NULL.
This is normally a
containing the module name, but can be set to any other object by Python code.
*PyFunction_GetDefaults(
*op)
Return value: Borrowed reference.Return the argument default values of the function object op. This can be a tuple of arguments or NULL.
intPyFunction_SetDefaults(
*op,
*defaults)
Set the argument default values for the function object op. defaults must be Py_None or a tuple.
Raises
and returns -1 on failure.
voidPyFunction_SetVectorcall(
*func,
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.
*PyFunction_GetKwDefaults(
*op)
Return value: Borrowed reference.Return the keyword-only argument default values of the function object op. This can be a dictionary of arguments or NULL.
intPyFunction_SetKwDefaults(
*op,
*defaults)
Set the keyword-only argument default values of the function object op. defaults must be a dictionary of keyword-only arguments or Py_None.
This function returns 0 on success, and returns -1 with an exception set on failure.
*PyFunction_GetClosure(
*op)
Return value: Borrowed reference.Return the closure associated with the function object op. This can be NULL or a tuple of cell objects.
intPyFunction_SetClosure(
*op,
*closure)
Set the closure associated with the function object op. closure must be Py_None or a tuple of cell objects.
Raises
and returns -1 on failure.
*PyFunction_GetAnnotations(
*op)
Return value: Borrowed reference.Return the annotations of the function object op. This can be a mutable dictionary or NULL.
intPyFunction_SetAnnotations(
*op,
*annotations)
Set the annotations for the function object op. annotations must be a dictionary or Py_None.
Raises
and returns -1 on failure.
*PyFunction_GET_CODE(
*op)
*PyFunction_GET_GLOBALS(
*op)
*PyFunction_GET_MODULE(
*op)
*PyFunction_GET_DEFAULTS(
*op)
*PyFunction_GET_KW_DEFAULTS(
*op)
*PyFunction_GET_CLOSURE(
*op)
*PyFunction_GET_ANNOTATIONS(
*op)
Return value: Borrowed reference.These functions are similar to their PyFunction_Get* counterparts, but do not do type checking. Passing anything other than an instance of
is undefined behavior.
intPyFunction_AddWatcher(
callback)
Register callback as a function watcher for the current interpreter. Return an ID which may be passed to
. In case of error (e.g. no more watcher IDs available), return -1 and set an exception.
Added in version 3.12.
intPyFunction_ClearWatcher(intwatcher_id)
Clear watcher identified by watcher_id previously returned from
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.
typePyFunction_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.
typedefint(*PyFunction_WatchCallback)(
event,
*func,
*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
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
. 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.