funcobject.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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_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_FastCallDict(
  56. PyObject *func,
  57. PyObject *const *args,
  58. Py_ssize_t nargs,
  59. PyObject *kwargs);
  60. PyAPI_FUNC(PyObject *) _PyFunction_Vectorcall(
  61. PyObject *func,
  62. PyObject *const *stack,
  63. size_t nargsf,
  64. PyObject *kwnames);
  65. #endif
  66. /* Macros for direct access to these values. Type checks are *not*
  67. done, so use with care. */
  68. #define PyFunction_GET_CODE(func) \
  69. (((PyFunctionObject *)func) -> func_code)
  70. #define PyFunction_GET_GLOBALS(func) \
  71. (((PyFunctionObject *)func) -> func_globals)
  72. #define PyFunction_GET_MODULE(func) \
  73. (((PyFunctionObject *)func) -> func_module)
  74. #define PyFunction_GET_DEFAULTS(func) \
  75. (((PyFunctionObject *)func) -> func_defaults)
  76. #define PyFunction_GET_KW_DEFAULTS(func) \
  77. (((PyFunctionObject *)func) -> func_kwdefaults)
  78. #define PyFunction_GET_CLOSURE(func) \
  79. (((PyFunctionObject *)func) -> func_closure)
  80. #define PyFunction_GET_ANNOTATIONS(func) \
  81. (((PyFunctionObject *)func) -> func_annotations)
  82. /* The classmethod and staticmethod types lives here, too */
  83. PyAPI_DATA(PyTypeObject) PyClassMethod_Type;
  84. PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;
  85. PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);
  86. PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);
  87. #ifdef __cplusplus
  88. }
  89. #endif
  90. #endif /* !Py_FUNCOBJECT_H */
  91. #endif /* Py_LIMITED_API */