# Objetos función

Hay algunas funciones específicas para las funciones de Python.

type PyFunctionObject

  La estructura C utilizada para las funciones.

PyTypeObject PyFunction_Type

  Esta es una instancia de `PyTypeObject` y representa el tipo función de Python. Está expuesto a los programadores de Python como `types.FunctionType`.

int PyFunction_Check(PyObject *o)

  Retorna verdadero si o es un objeto función (tiene tipo `PyFunction_Type`). El parámetro no debe ser `NULL`. Esta función siempre finaliza con éxito.

PyObject *PyFunction_New(PyObject *code, PyObject *globals)
  Return value: New reference.

  Retorna un nuevo objeto función asociado con el objeto código code. globals debe ser un diccionario con las variables globales accesibles para la función.

  The function’s docstring and name are retrieved from the code object. `__module__` is retrieved from globals. The argument defaults, annotations and closure are set to `NULL`. `__qualname__` is set to the same value as the code object’s `co_qualname` field.

PyObject *PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)
  Return value: New reference.

  As `PyFunction_New()`, but also allows setting the function object’s `__qualname__` 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 `co_qualname` field.

  Added in version 3.3.

PyObject *PyFunction_GetCode(PyObject *op)
  Return value: Borrowed reference.

  Retorna el objeto código asociado con el objeto función op.

PyObject *PyFunction_GetGlobals(PyObject *op)
  Return value: Borrowed reference.

  Retorna el diccionario global asociado con el objeto función op.

PyObject *PyFunction_GetModule(PyObject *op)
  Return value: Borrowed reference.

  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)
  Return value: Borrowed reference.

  Retorna los valores predeterminados del argumento del objeto función op. Esto puede ser una tupla de argumentos o `NULL`.

int PyFunction_SetDefaults(PyObject *op, PyObject *defaults)

  Establece los valores predeterminados del argumento para el objeto función op. defaults deben ser `Py_None` o una tupla.

  Lanza `SystemError` y retorna `-1` en caso de error.

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_GetClosure(PyObject *op)
  Return value: Borrowed reference.

  Retorna el cierre asociado con el objeto función op. Esto puede ser `NULL` o una tupla de objetos celda.

int PyFunction_SetClosure(PyObject *op, PyObject *closure)

  Establece el cierre asociado con el objeto función op. cierre debe ser `Py_None` o una tupla de objetos celda.

  Lanza `SystemError` y retorna `-1` en caso de error.

PyObject *PyFunction_GetAnnotations(PyObject *op)
  Return value: Borrowed reference.

  Retorna las anotaciones del objeto función op. Este puede ser un diccionario mutable o `NULL`.

int PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)

  Establece las anotaciones para el objeto función op. annotations debe ser un diccionario o `Py_None`.

  Lanza `SystemError` y retorna `-1` en caso de error.

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.