Where Online Learning is simpler!
The C and C++ Include Header Files
cat -n /usr/include/python3.12/cpython/funcobject.h
1 /* Function object interface */ 2 3 #ifndef Py_LIMITED_API 4 #ifndef Py_FUNCOBJECT_H 5 #define Py_FUNCOBJECT_H 6 #ifdef __cplusplus 7 extern "C" { 8 #endif 9 10 11 #define _Py_COMMON_FIELDS(PREFIX) \ 12 PyObject *PREFIX ## globals; \ 13 PyObject *PREFIX ## builtins; \ 14 PyObject *PREFIX ## name; \ 15 PyObject *PREFIX ## qualname; \ 16 PyObject *PREFIX ## code; /* A code object, the __code__ attribute */ \ 17 PyObject *PREFIX ## defaults; /* NULL or a tuple */ \ 18 PyObject *PREFIX ## kwdefaults; /* NULL or a dict */ \ 19 PyObject *PREFIX ## closure; /* NULL or a tuple of cell objects */ 20 21 typedef struct { 22 _Py_COMMON_FIELDS(fc_) 23 } PyFrameConstructor; 24 25 /* Function objects and code objects should not be confused with each other: 26 * 27 * Function objects are created by the execution of the 'def' statement. 28 * They reference a code object in their __code__ attribute, which is a 29 * purely syntactic object, i.e. nothing more than a compiled version of some 30 * source code lines. There is one code object per source code "fragment", 31 * but each code object can be referenced by zero or many function objects 32 * depending only on how many times the 'def' statement in the source was 33 * executed so far. 34 */ 35 36 typedef struct { 37 PyObject_HEAD 38 _Py_COMMON_FIELDS(func_) 39 PyObject *func_doc; /* The __doc__ attribute, can be anything */ 40 PyObject *func_dict; /* The __dict__ attribute, a dict or NULL */ 41 PyObject *func_weakreflist; /* List of weak references */ 42 PyObject *func_module; /* The __module__ attribute, can be anything */ 43 PyObject *func_annotations; /* Annotations, a dict or NULL */ 44 PyObject *func_typeparams; /* Tuple of active type variables or NULL */ 45 vectorcallfunc vectorcall; 46 /* Version number for use by specializer. 47 * Can set to non-zero when we want to specialize. 48 * Will be set to zero if any of these change: 49 * defaults 50 * kwdefaults (only if the object changes, not the contents of the dict) 51 * code 52 * annotations 53 * vectorcall function pointer */ 54 uint32_t func_version; 55 56 /* Invariant: 57 * func_closure contains the bindings for func_code->co_freevars, so 58 * PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code) 59 * (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0). 60 */ 61 } PyFunctionObject; 62 63 #undef _Py_COMMON_FIELDS 64 65 PyAPI_DATA(PyTypeObject) PyFunction_Type; 66 67 #define PyFunction_Check(op) Py_IS_TYPE((op), &PyFunction_Type) 68 69 PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *); 70 PyAPI_FUNC(PyObject *) PyFunction_NewWithQualName(PyObject *, PyObject *, PyObject *); 71 PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *); 72 PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *); 73 PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *); 74 PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *); 75 PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *); 76 PyAPI_FUNC(void) PyFunction_SetVectorcall(PyFunctionObject *, vectorcallfunc); 77 PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *); 78 PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *); 79 PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *); 80 PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *); 81 PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *); 82 PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *); 83 84 PyAPI_FUNC(PyObject *) _PyFunction_Vectorcall( 85 PyObject *func, 86 PyObject *const *stack, 87 size_t nargsf, 88 PyObject *kwnames); 89 90 #define _PyFunction_CAST(func) \ 91 (assert(PyFunction_Check(func)), _Py_CAST(PyFunctionObject*, func)) 92 93 /* Static inline functions for direct access to these values. 94 Type checks are *not* done, so use with care. */ 95 static inline PyObject* PyFunction_GET_CODE(PyObject *func) { 96 return _PyFunction_CAST(func)->func_code; 97 } 98 #define PyFunction_GET_CODE(func) PyFunction_GET_CODE(_PyObject_CAST(func)) 99 100 static inline PyObject* PyFunction_GET_GLOBALS(PyObject *func) { 101 return _PyFunction_CAST(func)->func_globals; 102 } 103 #define PyFunction_GET_GLOBALS(func) PyFunction_GET_GLOBALS(_PyObject_CAST(func)) 104 105 static inline PyObject* PyFunction_GET_MODULE(PyObject *func) { 106 return _PyFunction_CAST(func)->func_module; 107 } 108 #define PyFunction_GET_MODULE(func) PyFunction_GET_MODULE(_PyObject_CAST(func)) 109 110 static inline PyObject* PyFunction_GET_DEFAULTS(PyObject *func) { 111 return _PyFunction_CAST(func)->func_defaults; 112 } 113 #define PyFunction_GET_DEFAULTS(func) PyFunction_GET_DEFAULTS(_PyObject_CAST(func)) 114 115 static inline PyObject* PyFunction_GET_KW_DEFAULTS(PyObject *func) { 116 return _PyFunction_CAST(func)->func_kwdefaults; 117 } 118 #define PyFunction_GET_KW_DEFAULTS(func) PyFunction_GET_KW_DEFAULTS(_PyObject_CAST(func)) 119 120 static inline PyObject* PyFunction_GET_CLOSURE(PyObject *func) { 121 return _PyFunction_CAST(func)->func_closure; 122 } 123 #define PyFunction_GET_CLOSURE(func) PyFunction_GET_CLOSURE(_PyObject_CAST(func)) 124 125 static inline PyObject* PyFunction_GET_ANNOTATIONS(PyObject *func) { 126 return _PyFunction_CAST(func)->func_annotations; 127 } 128 #define PyFunction_GET_ANNOTATIONS(func) PyFunction_GET_ANNOTATIONS(_PyObject_CAST(func)) 129 130 /* The classmethod and staticmethod types lives here, too */ 131 PyAPI_DATA(PyTypeObject) PyClassMethod_Type; 132 PyAPI_DATA(PyTypeObject) PyStaticMethod_Type; 133 134 PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *); 135 PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *); 136 137 #define PY_FOREACH_FUNC_EVENT(V) \ 138 V(CREATE) \ 139 V(DESTROY) \ 140 V(MODIFY_CODE) \ 141 V(MODIFY_DEFAULTS) \ 142 V(MODIFY_KWDEFAULTS) 143 144 typedef enum { 145 #define PY_DEF_EVENT(EVENT) PyFunction_EVENT_##EVENT, 146 PY_FOREACH_FUNC_EVENT(PY_DEF_EVENT) 147 #undef PY_DEF_EVENT 148 } PyFunction_WatchEvent; 149 150 /* 151 * A callback that is invoked for different events in a function's lifecycle. 152 * 153 * The callback is invoked with a borrowed reference to func, after it is 154 * created and before it is modified or destroyed. The callback should not 155 * modify func. 156 * 157 * When a function's code object, defaults, or kwdefaults are modified the 158 * callback will be invoked with the respective event and new_value will 159 * contain a borrowed reference to the new value that is about to be stored in 160 * the function. Otherwise the third argument is NULL. 161 * 162 * If the callback returns with an exception set, it must return -1. Otherwise 163 * it should return 0. 164 */ 165 typedef int (*PyFunction_WatchCallback)( 166 PyFunction_WatchEvent event, 167 PyFunctionObject *func, 168 PyObject *new_value); 169 170 /* 171 * Register a per-interpreter callback that will be invoked for function lifecycle 172 * events. 173 * 174 * Returns a handle that may be passed to PyFunction_ClearWatcher on success, 175 * or -1 and sets an error if no more handles are available. 176 */ 177 PyAPI_FUNC(int) PyFunction_AddWatcher(PyFunction_WatchCallback callback); 178 179 /* 180 * Clear the watcher associated with the watcher_id handle. 181 * 182 * Returns 0 on success or -1 if no watcher exists for the supplied id. 183 */ 184 PyAPI_FUNC(int) PyFunction_ClearWatcher(int watcher_id); 185 186 #ifdef __cplusplus 187 } 188 #endif 189 #endif /* !Py_FUNCOBJECT_H */ 190 #endif /* Py_LIMITED_API */
