cpython/Include/cpython/funcobject.h at 3.15 · python/cpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

/* Function object interface */

#ifndef Py_LIMITED_API

#ifndef Py_FUNCOBJECT_H

#define Py_FUNCOBJECT_H

#ifdef __cplusplus

extern "C" {

#endif

#define _Py_COMMON_FIELDS(PREFIX) \

PyObject *PREFIX ## globals; \

PyObject *PREFIX ## builtins; \

PyObject *PREFIX ## name; \

PyObject *PREFIX ## qualname; \

PyObject *PREFIX ## code; /* A code object, the __code__ attribute */ \

PyObject *PREFIX ## defaults; /* NULL or a tuple */ \

PyObject *PREFIX ## kwdefaults; /* NULL or a dict */ \

PyObject *PREFIX ## closure; /* NULL or a tuple of cell objects */

typedef struct {

_Py_COMMON_FIELDS(fc_)

} PyFrameConstructor;

/* Function objects and code objects should not be confused with each other:

* Function objects are created by the execution of the 'def' statement.

* They reference a code object in their __code__ attribute, which is a

* purely syntactic object, i.e. nothing more than a compiled version of some

* source code lines. There is one code object per source code "fragment",

* but each code object can be referenced by zero or many function objects

* depending only on how many times the 'def' statement in the source was

* executed so far.

typedef struct {

PyObject_HEAD

_Py_COMMON_FIELDS(func_)

PyObject *func_doc; /* The __doc__ attribute, can be anything */

PyObject *func_dict; /* The __dict__ attribute, a dict or NULL */

PyObject *func_weakreflist; /* List of weak references */

PyObject *func_module; /* The __module__ attribute, can be anything */

PyObject *func_annotations; /* Annotations, a dict or NULL */

PyObject *func_annotate; /* Callable to fill the annotations dictionary */

PyObject *func_typeparams; /* Tuple of active type variables or NULL */

vectorcallfunc vectorcall;

/* Version number for use by specializer.

* Can set to non-zero when we want to specialize.

* Will be set to zero if any of these change:

* defaults

* kwdefaults (only if the object changes, not the contents of the dict)

* code

* annotations

* vectorcall function pointer */

uint32_t func_version;

/* Invariant:

* func_closure contains the bindings for func_code->co_freevars, so

* PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code)

* (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0).

} PyFunctionObject;

#undef _Py_COMMON_FIELDS

PyAPI_DATA(PyTypeObject) PyFunction_Type;

#define PyFunction_Check(op) Py_IS_TYPE((op), &PyFunction_Type)

PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_NewWithQualName(PyObject *, PyObject *, PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *);

PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *);

PyAPI_FUNC(void) PyFunction_SetVectorcall(PyFunctionObject *, vectorcallfunc);

PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *);

PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *);

PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *);

PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *);

PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *);

#define _PyFunction_CAST(func) \

(assert(PyFunction_Check(func)), _Py_CAST(PyFunctionObject*, func))

/* Static inline functions for direct access to these values.

Type checks are *not* done, so use with care. */

static inline PyObject* PyFunction_GET_CODE(PyObject *func) {

return _PyFunction_CAST(func)->func_code;

}

#define PyFunction_GET_CODE(func) PyFunction_GET_CODE(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_GLOBALS(PyObject *func) {

return _PyFunction_CAST(func)->func_globals;

}

#define PyFunction_GET_GLOBALS(func) PyFunction_GET_GLOBALS(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_MODULE(PyObject *func) {

return _PyFunction_CAST(func)->func_module;

}

#define PyFunction_GET_MODULE(func) PyFunction_GET_MODULE(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_DEFAULTS(PyObject *func) {

return _PyFunction_CAST(func)->func_defaults;

}

#define PyFunction_GET_DEFAULTS(func) PyFunction_GET_DEFAULTS(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_KW_DEFAULTS(PyObject *func) {

return _PyFunction_CAST(func)->func_kwdefaults;

}

#define PyFunction_GET_KW_DEFAULTS(func) PyFunction_GET_KW_DEFAULTS(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_CLOSURE(PyObject *func) {

return _PyFunction_CAST(func)->func_closure;

}

#define PyFunction_GET_CLOSURE(func) PyFunction_GET_CLOSURE(_PyObject_CAST(func))

static inline PyObject* PyFunction_GET_ANNOTATIONS(PyObject *func) {

return _PyFunction_CAST(func)->func_annotations;

}

#define PyFunction_GET_ANNOTATIONS(func) PyFunction_GET_ANNOTATIONS(_PyObject_CAST(func))

/* The classmethod and staticmethod types lives here, too */

PyAPI_DATA(PyTypeObject) PyClassMethod_Type;

PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;

PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);

PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);

#define PY_FOREACH_FUNC_EVENT(V) \

V(CREATE) \

V(DESTROY) \

V(MODIFY_CODE) \

V(MODIFY_DEFAULTS) \

V(MODIFY_KWDEFAULTS) \

V(MODIFY_QUALNAME)

typedef enum {

#define _Py_DEF_EVENT(EVENT) PyFunction_EVENT_##EVENT,

PY_FOREACH_FUNC_EVENT(_Py_DEF_EVENT)

#undef _Py_DEF_EVENT

} PyFunction_WatchEvent;

* A callback that is invoked for different events in a function's lifecycle.

* The callback is invoked with a borrowed reference to func, after it is

* created and before it is modified or destroyed. The callback should not

* modify func.

* When a function's code object, defaults, or kwdefaults are modified the

* callback will be invoked with the respective event and new_value will

* contain a borrowed reference to the new value that is about to be stored in

* the function. Otherwise the third argument is NULL.

* If the callback returns with an exception set, it must return -1. Otherwise

* it should return 0.

typedef int (*PyFunction_WatchCallback)(

PyFunction_WatchEvent event,

PyFunctionObject *func,

PyObject *new_value);

* Register a per-interpreter callback that will be invoked for function lifecycle

* events.

* Returns a handle that may be passed to PyFunction_ClearWatcher on success,

* or -1 and sets an error if no more handles are available.

PyAPI_FUNC(int) PyFunction_AddWatcher(PyFunction_WatchCallback callback);

* Clear the watcher associated with the watcher_id handle.

* Returns 0 on success or -1 if no watcher exists for the supplied id.

PyAPI_FUNC(int) PyFunction_ClearWatcher(int watcher_id);

#ifdef __cplusplus

}

#endif

#endif /* !Py_FUNCOBJECT_H */

#endif /* Py_LIMITED_API */

cpython/Include/cpython/funcobject.h at 3.15 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

funcobject.h

Latest commit

History

Breadcrumbs

funcobject.h

File metadata and controls