funcobject.h 4.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /* Function object interface */
  2. #ifndef Py_LIMITED_API
  3. #ifndef Py_FUNCOBJECT_H
  4. #define Py_FUNCOBJECT_H
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8. /* Function objects and code objects should not be confused with each other:
  9. *
  10. * Function objects are created by the execution of the 'def' statement.
  11. * They reference a code object in their __code__ attribute, which is a
  12. * purely syntactic object, i.e. nothing more than a compiled version of some
  13. * source code lines. There is one code object per source code "fragment",
  14. * but each code object can be referenced by zero or many function objects
  15. * depending only on how many times the 'def' statement in the source was
  16. * executed so far.
  17. */
  18. typedef struct {
  19. PyObject_HEAD
  20. PyObject *func_code; /* A code object, the __code__ attribute */
  21. PyObject *func_globals; /* A dictionary (other mappings won't do) */
  22. PyObject *func_defaults; /* NULL or a tuple */
  23. PyObject *func_kwdefaults; /* NULL or a dict */
  24. PyObject *func_closure; /* NULL or a tuple of cell objects */
  25. PyObject *func_doc; /* The __doc__ attribute, can be anything */
  26. PyObject *func_name; /* The __name__ attribute, a string object */
  27. PyObject *func_dict; /* The __dict__ attribute, a dict or NULL */
  28. PyObject *func_weakreflist; /* List of weak references */
  29. PyObject *func_module; /* The __module__ attribute, can be anything */
  30. PyObject *func_annotations; /* Annotations, a dict or NULL */
  31. PyObject *func_qualname; /* The qualified name */
  32. vectorcallfunc vectorcall;
  33. /* Invariant:
  34. * func_closure contains the bindings for func_code->co_freevars, so
  35. * PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code)
  36. * (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0).
  37. */
  38. } PyFunctionObject;
  39. PyAPI_DATA(PyTypeObject) PyFunction_Type;
  40. #define PyFunction_Check(op) Py_IS_TYPE(op, &PyFunction_Type)
  41. PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *);
  42. PyAPI_FUNC(PyObject *) PyFunction_NewWithQualName(PyObject *, PyObject *, PyObject *);
  43. PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *);
  44. PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *);
  45. PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *);
  46. PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *);
  47. PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *);
  48. PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *);
  49. PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *);
  50. PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *);
  51. PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *);
  52. PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *);
  53. PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *);
  54. #ifndef Py_LIMITED_API
  55. PyAPI_FUNC(PyObject *) _PyFunction_Vectorcall(
  56. PyObject *func,
  57. PyObject *const *stack,
  58. size_t nargsf,
  59. PyObject *kwnames);
  60. #endif
  61. /* Macros for direct access to these values. Type checks are *not*
  62. done, so use with care. */
  63. #define PyFunction_GET_CODE(func) \
  64. (((PyFunctionObject *)func) -> func_code)
  65. #define PyFunction_GET_GLOBALS(func) \
  66. (((PyFunctionObject *)func) -> func_globals)
  67. #define PyFunction_GET_MODULE(func) \
  68. (((PyFunctionObject *)func) -> func_module)
  69. #define PyFunction_GET_DEFAULTS(func) \
  70. (((PyFunctionObject *)func) -> func_defaults)
  71. #define PyFunction_GET_KW_DEFAULTS(func) \
  72. (((PyFunctionObject *)func) -> func_kwdefaults)
  73. #define PyFunction_GET_CLOSURE(func) \
  74. (((PyFunctionObject *)func) -> func_closure)
  75. #define PyFunction_GET_ANNOTATIONS(func) \
  76. (((PyFunctionObject *)func) -> func_annotations)
  77. /* The classmethod and staticmethod types lives here, too */
  78. PyAPI_DATA(PyTypeObject) PyClassMethod_Type;
  79. PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;
  80. PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);
  81. PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);
  82. #ifdef __cplusplus
  83. }
  84. #endif
  85. #endif /* !Py_FUNCOBJECT_H */
  86. #endif /* Py_LIMITED_API */