funcobject.h 4.08 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2
/* Function object interface */
3
#ifndef Py_LIMITED_API
4 5 6 7 8 9
#ifndef Py_FUNCOBJECT_H
#define Py_FUNCOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

10 11 12
/* Function objects and code objects should not be confused with each other:
 *
 * Function objects are created by the execution of the 'def' statement.
Neal Norwitz's avatar
Neal Norwitz committed
13
 * They reference a code object in their __code__ attribute, which is a
14 15 16 17 18 19 20
 * 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.
 */

21
typedef struct {
22
    PyObject_HEAD
23 24 25 26 27 28 29 30 31 32 33
    PyObject *func_code;        /* A code object, the __code__ attribute */
    PyObject *func_globals;     /* A dictionary (other mappings won't do) */
    PyObject *func_defaults;    /* NULL or a tuple */
    PyObject *func_kwdefaults;  /* NULL or a dict */
    PyObject *func_closure;     /* NULL or a tuple of cell objects */
    PyObject *func_doc;         /* The __doc__ attribute, can be anything */
    PyObject *func_name;        /* The __name__ attribute, a string object */
    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 */
34
    PyObject *func_qualname;    /* The qualified name */
35 36 37 38 39 40

    /* 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).
     */
41
} PyFunctionObject;
42

43
PyAPI_DATA(PyTypeObject) PyFunction_Type;
Guido van Rossum's avatar
Guido van Rossum committed
44

45
#define PyFunction_Check(op) (Py_TYPE(op) == &PyFunction_Type)
Guido van Rossum's avatar
Guido van Rossum committed
46

47
PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *);
48
PyAPI_FUNC(PyObject *) PyFunction_NewWithQualName(PyObject *, PyObject *, PyObject *);
49 50
PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *);
PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *);
51
PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *);
52 53
PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *);
PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *);
54 55
PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *);
PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *);
56 57
PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *);
PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *);
58 59
PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *);
PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *);
60

61
#ifndef Py_LIMITED_API
62
PyAPI_FUNC(PyObject *) _PyFunction_FastCallDict(
63
    PyObject *func,
64
    PyObject *const *args,
65
    Py_ssize_t nargs,
66
    PyObject *kwargs);
67 68 69

PyAPI_FUNC(PyObject *) _PyFunction_FastCallKeywords(
    PyObject *func,
70
    PyObject *const *stack,
71 72
    Py_ssize_t nargs,
    PyObject *kwnames);
73 74
#endif

75 76 77 78 79
/* Macros for direct access to these values. Type checks are *not*
   done, so use with care. */
#define PyFunction_GET_CODE(func) \
        (((PyFunctionObject *)func) -> func_code)
#define PyFunction_GET_GLOBALS(func) \
80
        (((PyFunctionObject *)func) -> func_globals)
81
#define PyFunction_GET_MODULE(func) \
82
        (((PyFunctionObject *)func) -> func_module)
83
#define PyFunction_GET_DEFAULTS(func) \
84
        (((PyFunctionObject *)func) -> func_defaults)
85
#define PyFunction_GET_KW_DEFAULTS(func) \
86
        (((PyFunctionObject *)func) -> func_kwdefaults)
Jeremy Hylton's avatar
Jeremy Hylton committed
87
#define PyFunction_GET_CLOSURE(func) \
88
        (((PyFunctionObject *)func) -> func_closure)
89
#define PyFunction_GET_ANNOTATIONS(func) \
90
        (((PyFunctionObject *)func) -> func_annotations)
91

92
/* The classmethod and staticmethod types lives here, too */
93 94
PyAPI_DATA(PyTypeObject) PyClassMethod_Type;
PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;
95

96 97
PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);
PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);
98

99 100 101 102
#ifdef __cplusplus
}
#endif
#endif /* !Py_FUNCOBJECT_H */
103
#endif /* Py_LIMITED_API */