123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368 |
- /* Function object implementation */
- #include "Python.h"
- #include "pycore_ceval.h" // _PyEval_BuiltinsFromGlobals()
- #include "pycore_code.h" // _Py_next_func_version
- #include "pycore_object.h" // _PyObject_GC_UNTRACK()
- #include "pycore_pyerrors.h" // _PyErr_Occurred()
- #include "structmember.h" // PyMemberDef
- static PyObject* func_repr(PyFunctionObject *op);
- static const char *
- func_event_name(PyFunction_WatchEvent event) {
- switch (event) {
- #define CASE(op) \
- case PyFunction_EVENT_##op: \
- return "PyFunction_EVENT_" #op;
- PY_FOREACH_FUNC_EVENT(CASE)
- #undef CASE
- }
- Py_UNREACHABLE();
- }
- static void
- notify_func_watchers(PyInterpreterState *interp, PyFunction_WatchEvent event,
- PyFunctionObject *func, PyObject *new_value)
- {
- uint8_t bits = interp->active_func_watchers;
- int i = 0;
- while (bits) {
- assert(i < FUNC_MAX_WATCHERS);
- if (bits & 1) {
- PyFunction_WatchCallback cb = interp->func_watchers[i];
- // callback must be non-null if the watcher bit is set
- assert(cb != NULL);
- if (cb(event, func, new_value) < 0) {
- // Don't risk resurrecting the func if an unraisablehook keeps a
- // reference; pass a string as context.
- PyObject *context = NULL;
- PyObject *repr = func_repr(func);
- if (repr != NULL) {
- context = PyUnicode_FromFormat(
- "%s watcher callback for %U",
- func_event_name(event), repr);
- Py_DECREF(repr);
- }
- if (context == NULL) {
- context = Py_NewRef(Py_None);
- }
- PyErr_WriteUnraisable(context);
- Py_DECREF(context);
- }
- }
- i++;
- bits >>= 1;
- }
- }
- static inline void
- handle_func_event(PyFunction_WatchEvent event, PyFunctionObject *func,
- PyObject *new_value)
- {
- assert(Py_REFCNT(func) > 0);
- PyInterpreterState *interp = _PyInterpreterState_GET();
- assert(interp->_initialized);
- if (interp->active_func_watchers) {
- notify_func_watchers(interp, event, func, new_value);
- }
- }
- int
- PyFunction_AddWatcher(PyFunction_WatchCallback callback)
- {
- PyInterpreterState *interp = _PyInterpreterState_GET();
- assert(interp->_initialized);
- for (int i = 0; i < FUNC_MAX_WATCHERS; i++) {
- if (interp->func_watchers[i] == NULL) {
- interp->func_watchers[i] = callback;
- interp->active_func_watchers |= (1 << i);
- return i;
- }
- }
- PyErr_SetString(PyExc_RuntimeError, "no more func watcher IDs available");
- return -1;
- }
- int
- PyFunction_ClearWatcher(int watcher_id)
- {
- PyInterpreterState *interp = _PyInterpreterState_GET();
- if (watcher_id < 0 || watcher_id >= FUNC_MAX_WATCHERS) {
- PyErr_Format(PyExc_ValueError, "invalid func watcher ID %d",
- watcher_id);
- return -1;
- }
- if (!interp->func_watchers[watcher_id]) {
- PyErr_Format(PyExc_ValueError, "no func watcher set for ID %d",
- watcher_id);
- return -1;
- }
- interp->func_watchers[watcher_id] = NULL;
- interp->active_func_watchers &= ~(1 << watcher_id);
- return 0;
- }
- PyFunctionObject *
- _PyFunction_FromConstructor(PyFrameConstructor *constr)
- {
- PyObject *module = Py_XNewRef(PyDict_GetItemWithError(constr->fc_globals, &_Py_ID(__name__)));
- if (!module && PyErr_Occurred()) {
- return NULL;
- }
- PyFunctionObject *op = PyObject_GC_New(PyFunctionObject, &PyFunction_Type);
- if (op == NULL) {
- Py_XDECREF(module);
- return NULL;
- }
- op->func_globals = Py_NewRef(constr->fc_globals);
- op->func_builtins = Py_NewRef(constr->fc_builtins);
- op->func_name = Py_NewRef(constr->fc_name);
- op->func_qualname = Py_NewRef(constr->fc_qualname);
- op->func_code = Py_NewRef(constr->fc_code);
- op->func_defaults = Py_XNewRef(constr->fc_defaults);
- op->func_kwdefaults = Py_XNewRef(constr->fc_kwdefaults);
- op->func_closure = Py_XNewRef(constr->fc_closure);
- op->func_doc = Py_NewRef(Py_None);
- op->func_dict = NULL;
- op->func_weakreflist = NULL;
- op->func_module = module;
- op->func_annotations = NULL;
- op->func_typeparams = NULL;
- op->vectorcall = _PyFunction_Vectorcall;
- op->func_version = 0;
- _PyObject_GC_TRACK(op);
- handle_func_event(PyFunction_EVENT_CREATE, op, NULL);
- return op;
- }
- PyObject *
- PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)
- {
- assert(globals != NULL);
- assert(PyDict_Check(globals));
- Py_INCREF(globals);
- PyThreadState *tstate = _PyThreadState_GET();
- PyCodeObject *code_obj = (PyCodeObject *)Py_NewRef(code);
- assert(code_obj->co_name != NULL);
- PyObject *name = Py_NewRef(code_obj->co_name);
- if (!qualname) {
- qualname = code_obj->co_qualname;
- }
- assert(qualname != NULL);
- Py_INCREF(qualname);
- PyObject *consts = code_obj->co_consts;
- assert(PyTuple_Check(consts));
- PyObject *doc;
- if (PyTuple_Size(consts) >= 1) {
- doc = PyTuple_GetItem(consts, 0);
- if (!PyUnicode_Check(doc)) {
- doc = Py_None;
- }
- }
- else {
- doc = Py_None;
- }
- Py_INCREF(doc);
- // __module__: Use globals['__name__'] if it exists, or NULL.
- PyObject *module = PyDict_GetItemWithError(globals, &_Py_ID(__name__));
- PyObject *builtins = NULL;
- if (module == NULL && _PyErr_Occurred(tstate)) {
- goto error;
- }
- Py_XINCREF(module);
- builtins = _PyEval_BuiltinsFromGlobals(tstate, globals); // borrowed ref
- if (builtins == NULL) {
- goto error;
- }
- Py_INCREF(builtins);
- PyFunctionObject *op = PyObject_GC_New(PyFunctionObject, &PyFunction_Type);
- if (op == NULL) {
- goto error;
- }
- /* Note: No failures from this point on, since func_dealloc() does not
- expect a partially-created object. */
- op->func_globals = globals;
- op->func_builtins = builtins;
- op->func_name = name;
- op->func_qualname = qualname;
- op->func_code = (PyObject*)code_obj;
- op->func_defaults = NULL; // No default positional arguments
- op->func_kwdefaults = NULL; // No default keyword arguments
- op->func_closure = NULL;
- op->func_doc = doc;
- op->func_dict = NULL;
- op->func_weakreflist = NULL;
- op->func_module = module;
- op->func_annotations = NULL;
- op->func_typeparams = NULL;
- op->vectorcall = _PyFunction_Vectorcall;
- op->func_version = 0;
- _PyObject_GC_TRACK(op);
- handle_func_event(PyFunction_EVENT_CREATE, op, NULL);
- return (PyObject *)op;
- error:
- Py_DECREF(globals);
- Py_DECREF(code_obj);
- Py_DECREF(name);
- Py_DECREF(qualname);
- Py_DECREF(doc);
- Py_XDECREF(module);
- Py_XDECREF(builtins);
- return NULL;
- }
- uint32_t _PyFunction_GetVersionForCurrentState(PyFunctionObject *func)
- {
- if (func->func_version != 0) {
- return func->func_version;
- }
- if (func->vectorcall != _PyFunction_Vectorcall) {
- return 0;
- }
- PyInterpreterState *interp = _PyInterpreterState_GET();
- if (interp->func_state.next_version == 0) {
- return 0;
- }
- uint32_t v = interp->func_state.next_version++;
- func->func_version = v;
- return v;
- }
- PyObject *
- PyFunction_New(PyObject *code, PyObject *globals)
- {
- return PyFunction_NewWithQualName(code, globals, NULL);
- }
- PyObject *
- PyFunction_GetCode(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_code;
- }
- PyObject *
- PyFunction_GetGlobals(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_globals;
- }
- PyObject *
- PyFunction_GetModule(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_module;
- }
- PyObject *
- PyFunction_GetDefaults(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_defaults;
- }
- int
- PyFunction_SetDefaults(PyObject *op, PyObject *defaults)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return -1;
- }
- if (defaults == Py_None)
- defaults = NULL;
- else if (defaults && PyTuple_Check(defaults)) {
- Py_INCREF(defaults);
- }
- else {
- PyErr_SetString(PyExc_SystemError, "non-tuple default args");
- return -1;
- }
- handle_func_event(PyFunction_EVENT_MODIFY_DEFAULTS,
- (PyFunctionObject *) op, defaults);
- ((PyFunctionObject *)op)->func_version = 0;
- Py_XSETREF(((PyFunctionObject *)op)->func_defaults, defaults);
- return 0;
- }
- void
- PyFunction_SetVectorcall(PyFunctionObject *func, vectorcallfunc vectorcall)
- {
- assert(func != NULL);
- func->func_version = 0;
- func->vectorcall = vectorcall;
- }
- PyObject *
- PyFunction_GetKwDefaults(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_kwdefaults;
- }
- int
- PyFunction_SetKwDefaults(PyObject *op, PyObject *defaults)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return -1;
- }
- if (defaults == Py_None)
- defaults = NULL;
- else if (defaults && PyDict_Check(defaults)) {
- Py_INCREF(defaults);
- }
- else {
- PyErr_SetString(PyExc_SystemError,
- "non-dict keyword only default args");
- return -1;
- }
- handle_func_event(PyFunction_EVENT_MODIFY_KWDEFAULTS,
- (PyFunctionObject *) op, defaults);
- ((PyFunctionObject *)op)->func_version = 0;
- Py_XSETREF(((PyFunctionObject *)op)->func_kwdefaults, defaults);
- return 0;
- }
- PyObject *
- PyFunction_GetClosure(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return ((PyFunctionObject *) op) -> func_closure;
- }
- int
- PyFunction_SetClosure(PyObject *op, PyObject *closure)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return -1;
- }
- if (closure == Py_None)
- closure = NULL;
- else if (PyTuple_Check(closure)) {
- Py_INCREF(closure);
- }
- else {
- PyErr_Format(PyExc_SystemError,
- "expected tuple for closure, got '%.100s'",
- Py_TYPE(closure)->tp_name);
- return -1;
- }
- ((PyFunctionObject *)op)->func_version = 0;
- Py_XSETREF(((PyFunctionObject *)op)->func_closure, closure);
- return 0;
- }
- static PyObject *
- func_get_annotation_dict(PyFunctionObject *op)
- {
- if (op->func_annotations == NULL) {
- return NULL;
- }
- if (PyTuple_CheckExact(op->func_annotations)) {
- PyObject *ann_tuple = op->func_annotations;
- PyObject *ann_dict = PyDict_New();
- if (ann_dict == NULL) {
- return NULL;
- }
- assert(PyTuple_GET_SIZE(ann_tuple) % 2 == 0);
- for (Py_ssize_t i = 0; i < PyTuple_GET_SIZE(ann_tuple); i += 2) {
- int err = PyDict_SetItem(ann_dict,
- PyTuple_GET_ITEM(ann_tuple, i),
- PyTuple_GET_ITEM(ann_tuple, i + 1));
- if (err < 0) {
- return NULL;
- }
- }
- Py_SETREF(op->func_annotations, ann_dict);
- }
- assert(PyDict_Check(op->func_annotations));
- return op->func_annotations;
- }
- PyObject *
- PyFunction_GetAnnotations(PyObject *op)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return NULL;
- }
- return func_get_annotation_dict((PyFunctionObject *)op);
- }
- int
- PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)
- {
- if (!PyFunction_Check(op)) {
- PyErr_BadInternalCall();
- return -1;
- }
- if (annotations == Py_None)
- annotations = NULL;
- else if (annotations && PyDict_Check(annotations)) {
- Py_INCREF(annotations);
- }
- else {
- PyErr_SetString(PyExc_SystemError,
- "non-dict annotations");
- return -1;
- }
- ((PyFunctionObject *)op)->func_version = 0;
- Py_XSETREF(((PyFunctionObject *)op)->func_annotations, annotations);
- return 0;
- }
- /* Methods */
- #define OFF(x) offsetof(PyFunctionObject, x)
- static PyMemberDef func_memberlist[] = {
- {"__closure__", T_OBJECT, OFF(func_closure), READONLY},
- {"__doc__", T_OBJECT, OFF(func_doc), 0},
- {"__globals__", T_OBJECT, OFF(func_globals), READONLY},
- {"__module__", T_OBJECT, OFF(func_module), 0},
- {"__builtins__", T_OBJECT, OFF(func_builtins), READONLY},
- {NULL} /* Sentinel */
- };
- static PyObject *
- func_get_code(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- if (PySys_Audit("object.__getattr__", "Os", op, "__code__") < 0) {
- return NULL;
- }
- return Py_NewRef(op->func_code);
- }
- static int
- func_set_code(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- Py_ssize_t nclosure;
- int nfree;
- /* Not legal to del f.func_code or to set it to anything
- * other than a code object. */
- if (value == NULL || !PyCode_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__code__ must be set to a code object");
- return -1;
- }
- if (PySys_Audit("object.__setattr__", "OsO",
- op, "__code__", value) < 0) {
- return -1;
- }
- nfree = ((PyCodeObject *)value)->co_nfreevars;
- nclosure = (op->func_closure == NULL ? 0 :
- PyTuple_GET_SIZE(op->func_closure));
- if (nclosure != nfree) {
- PyErr_Format(PyExc_ValueError,
- "%U() requires a code object with %zd free vars,"
- " not %zd",
- op->func_name,
- nclosure, nfree);
- return -1;
- }
- handle_func_event(PyFunction_EVENT_MODIFY_CODE, op, value);
- op->func_version = 0;
- Py_XSETREF(op->func_code, Py_NewRef(value));
- return 0;
- }
- static PyObject *
- func_get_name(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- return Py_NewRef(op->func_name);
- }
- static int
- func_set_name(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- /* Not legal to del f.func_name or to set it to anything
- * other than a string object. */
- if (value == NULL || !PyUnicode_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__name__ must be set to a string object");
- return -1;
- }
- Py_XSETREF(op->func_name, Py_NewRef(value));
- return 0;
- }
- static PyObject *
- func_get_qualname(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- return Py_NewRef(op->func_qualname);
- }
- static int
- func_set_qualname(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- /* Not legal to del f.__qualname__ or to set it to anything
- * other than a string object. */
- if (value == NULL || !PyUnicode_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__qualname__ must be set to a string object");
- return -1;
- }
- Py_XSETREF(op->func_qualname, Py_NewRef(value));
- return 0;
- }
- static PyObject *
- func_get_defaults(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- if (PySys_Audit("object.__getattr__", "Os", op, "__defaults__") < 0) {
- return NULL;
- }
- if (op->func_defaults == NULL) {
- Py_RETURN_NONE;
- }
- return Py_NewRef(op->func_defaults);
- }
- static int
- func_set_defaults(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- /* Legal to del f.func_defaults.
- * Can only set func_defaults to NULL or a tuple. */
- if (value == Py_None)
- value = NULL;
- if (value != NULL && !PyTuple_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__defaults__ must be set to a tuple object");
- return -1;
- }
- if (value) {
- if (PySys_Audit("object.__setattr__", "OsO",
- op, "__defaults__", value) < 0) {
- return -1;
- }
- } else if (PySys_Audit("object.__delattr__", "Os",
- op, "__defaults__") < 0) {
- return -1;
- }
- handle_func_event(PyFunction_EVENT_MODIFY_DEFAULTS, op, value);
- op->func_version = 0;
- Py_XSETREF(op->func_defaults, Py_XNewRef(value));
- return 0;
- }
- static PyObject *
- func_get_kwdefaults(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- if (PySys_Audit("object.__getattr__", "Os",
- op, "__kwdefaults__") < 0) {
- return NULL;
- }
- if (op->func_kwdefaults == NULL) {
- Py_RETURN_NONE;
- }
- return Py_NewRef(op->func_kwdefaults);
- }
- static int
- func_set_kwdefaults(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- if (value == Py_None)
- value = NULL;
- /* Legal to del f.func_kwdefaults.
- * Can only set func_kwdefaults to NULL or a dict. */
- if (value != NULL && !PyDict_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__kwdefaults__ must be set to a dict object");
- return -1;
- }
- if (value) {
- if (PySys_Audit("object.__setattr__", "OsO",
- op, "__kwdefaults__", value) < 0) {
- return -1;
- }
- } else if (PySys_Audit("object.__delattr__", "Os",
- op, "__kwdefaults__") < 0) {
- return -1;
- }
- handle_func_event(PyFunction_EVENT_MODIFY_KWDEFAULTS, op, value);
- op->func_version = 0;
- Py_XSETREF(op->func_kwdefaults, Py_XNewRef(value));
- return 0;
- }
- static PyObject *
- func_get_annotations(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- if (op->func_annotations == NULL) {
- op->func_annotations = PyDict_New();
- if (op->func_annotations == NULL)
- return NULL;
- }
- PyObject *d = func_get_annotation_dict(op);
- return Py_XNewRef(d);
- }
- static int
- func_set_annotations(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- if (value == Py_None)
- value = NULL;
- /* Legal to del f.func_annotations.
- * Can only set func_annotations to NULL (through C api)
- * or a dict. */
- if (value != NULL && !PyDict_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__annotations__ must be set to a dict object");
- return -1;
- }
- op->func_version = 0;
- Py_XSETREF(op->func_annotations, Py_XNewRef(value));
- return 0;
- }
- static PyObject *
- func_get_type_params(PyFunctionObject *op, void *Py_UNUSED(ignored))
- {
- if (op->func_typeparams == NULL) {
- return PyTuple_New(0);
- }
- assert(PyTuple_Check(op->func_typeparams));
- return Py_NewRef(op->func_typeparams);
- }
- static int
- func_set_type_params(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
- {
- /* Not legal to del f.__type_params__ or to set it to anything
- * other than a tuple object. */
- if (value == NULL || !PyTuple_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "__type_params__ must be set to a tuple");
- return -1;
- }
- Py_XSETREF(op->func_typeparams, Py_NewRef(value));
- return 0;
- }
- PyObject *
- _Py_set_function_type_params(PyThreadState *Py_UNUSED(ignored), PyObject *func,
- PyObject *type_params)
- {
- assert(PyFunction_Check(func));
- assert(PyTuple_Check(type_params));
- PyFunctionObject *f = (PyFunctionObject *)func;
- Py_XSETREF(f->func_typeparams, Py_NewRef(type_params));
- return Py_NewRef(func);
- }
- static PyGetSetDef func_getsetlist[] = {
- {"__code__", (getter)func_get_code, (setter)func_set_code},
- {"__defaults__", (getter)func_get_defaults,
- (setter)func_set_defaults},
- {"__kwdefaults__", (getter)func_get_kwdefaults,
- (setter)func_set_kwdefaults},
- {"__annotations__", (getter)func_get_annotations,
- (setter)func_set_annotations},
- {"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict},
- {"__name__", (getter)func_get_name, (setter)func_set_name},
- {"__qualname__", (getter)func_get_qualname, (setter)func_set_qualname},
- {"__type_params__", (getter)func_get_type_params,
- (setter)func_set_type_params},
- {NULL} /* Sentinel */
- };
- /*[clinic input]
- class function "PyFunctionObject *" "&PyFunction_Type"
- [clinic start generated code]*/
- /*[clinic end generated code: output=da39a3ee5e6b4b0d input=70af9c90aa2e71b0]*/
- #include "clinic/funcobject.c.h"
- /* function.__new__() maintains the following invariants for closures.
- The closure must correspond to the free variables of the code object.
- if len(code.co_freevars) == 0:
- closure = NULL
- else:
- len(closure) == len(code.co_freevars)
- for every elt in closure, type(elt) == cell
- */
- /*[clinic input]
- @classmethod
- function.__new__ as func_new
- code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
- a code object
- globals: object(subclass_of="&PyDict_Type")
- the globals dictionary
- name: object = None
- a string that overrides the name from the code object
- argdefs as defaults: object = None
- a tuple that specifies the default argument values
- closure: object = None
- a tuple that supplies the bindings for free variables
- Create a function object.
- [clinic start generated code]*/
- static PyObject *
- func_new_impl(PyTypeObject *type, PyCodeObject *code, PyObject *globals,
- PyObject *name, PyObject *defaults, PyObject *closure)
- /*[clinic end generated code: output=99c6d9da3a24e3be input=93611752fc2daf11]*/
- {
- PyFunctionObject *newfunc;
- Py_ssize_t nclosure;
- if (name != Py_None && !PyUnicode_Check(name)) {
- PyErr_SetString(PyExc_TypeError,
- "arg 3 (name) must be None or string");
- return NULL;
- }
- if (defaults != Py_None && !PyTuple_Check(defaults)) {
- PyErr_SetString(PyExc_TypeError,
- "arg 4 (defaults) must be None or tuple");
- return NULL;
- }
- if (!PyTuple_Check(closure)) {
- if (code->co_nfreevars && closure == Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "arg 5 (closure) must be tuple");
- return NULL;
- }
- else if (closure != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "arg 5 (closure) must be None or tuple");
- return NULL;
- }
- }
- /* check that the closure is well-formed */
- nclosure = closure == Py_None ? 0 : PyTuple_GET_SIZE(closure);
- if (code->co_nfreevars != nclosure)
- return PyErr_Format(PyExc_ValueError,
- "%U requires closure of length %zd, not %zd",
- code->co_name, code->co_nfreevars, nclosure);
- if (nclosure) {
- Py_ssize_t i;
- for (i = 0; i < nclosure; i++) {
- PyObject *o = PyTuple_GET_ITEM(closure, i);
- if (!PyCell_Check(o)) {
- return PyErr_Format(PyExc_TypeError,
- "arg 5 (closure) expected cell, found %s",
- Py_TYPE(o)->tp_name);
- }
- }
- }
- if (PySys_Audit("function.__new__", "O", code) < 0) {
- return NULL;
- }
- newfunc = (PyFunctionObject *)PyFunction_New((PyObject *)code,
- globals);
- if (newfunc == NULL) {
- return NULL;
- }
- if (name != Py_None) {
- Py_SETREF(newfunc->func_name, Py_NewRef(name));
- }
- if (defaults != Py_None) {
- newfunc->func_defaults = Py_NewRef(defaults);
- }
- if (closure != Py_None) {
- newfunc->func_closure = Py_NewRef(closure);
- }
- return (PyObject *)newfunc;
- }
- static int
- func_clear(PyFunctionObject *op)
- {
- op->func_version = 0;
- Py_CLEAR(op->func_globals);
- Py_CLEAR(op->func_builtins);
- Py_CLEAR(op->func_module);
- Py_CLEAR(op->func_defaults);
- Py_CLEAR(op->func_kwdefaults);
- Py_CLEAR(op->func_doc);
- Py_CLEAR(op->func_dict);
- Py_CLEAR(op->func_closure);
- Py_CLEAR(op->func_annotations);
- Py_CLEAR(op->func_typeparams);
- // Don't Py_CLEAR(op->func_code), since code is always required
- // to be non-NULL. Similarly, name and qualname shouldn't be NULL.
- // However, name and qualname could be str subclasses, so they
- // could have reference cycles. The solution is to replace them
- // with a genuinely immutable string.
- Py_SETREF(op->func_name, Py_NewRef(&_Py_STR(empty)));
- Py_SETREF(op->func_qualname, Py_NewRef(&_Py_STR(empty)));
- return 0;
- }
- static void
- func_dealloc(PyFunctionObject *op)
- {
- assert(Py_REFCNT(op) == 0);
- Py_SET_REFCNT(op, 1);
- handle_func_event(PyFunction_EVENT_DESTROY, op, NULL);
- if (Py_REFCNT(op) > 1) {
- Py_SET_REFCNT(op, Py_REFCNT(op) - 1);
- return;
- }
- Py_SET_REFCNT(op, 0);
- _PyObject_GC_UNTRACK(op);
- if (op->func_weakreflist != NULL) {
- PyObject_ClearWeakRefs((PyObject *) op);
- }
- (void)func_clear(op);
- // These aren't cleared by func_clear().
- Py_DECREF(op->func_code);
- Py_DECREF(op->func_name);
- Py_DECREF(op->func_qualname);
- PyObject_GC_Del(op);
- }
- static PyObject*
- func_repr(PyFunctionObject *op)
- {
- return PyUnicode_FromFormat("<function %U at %p>",
- op->func_qualname, op);
- }
- static int
- func_traverse(PyFunctionObject *f, visitproc visit, void *arg)
- {
- Py_VISIT(f->func_code);
- Py_VISIT(f->func_globals);
- Py_VISIT(f->func_builtins);
- Py_VISIT(f->func_module);
- Py_VISIT(f->func_defaults);
- Py_VISIT(f->func_kwdefaults);
- Py_VISIT(f->func_doc);
- Py_VISIT(f->func_name);
- Py_VISIT(f->func_dict);
- Py_VISIT(f->func_closure);
- Py_VISIT(f->func_annotations);
- Py_VISIT(f->func_typeparams);
- Py_VISIT(f->func_qualname);
- return 0;
- }
- /* Bind a function to an object */
- static PyObject *
- func_descr_get(PyObject *func, PyObject *obj, PyObject *type)
- {
- if (obj == Py_None || obj == NULL) {
- return Py_NewRef(func);
- }
- return PyMethod_New(func, obj);
- }
- PyTypeObject PyFunction_Type = {
- PyVarObject_HEAD_INIT(&PyType_Type, 0)
- "function",
- sizeof(PyFunctionObject),
- 0,
- (destructor)func_dealloc, /* tp_dealloc */
- offsetof(PyFunctionObject, vectorcall), /* tp_vectorcall_offset */
- 0, /* tp_getattr */
- 0, /* tp_setattr */
- 0, /* tp_as_async */
- (reprfunc)func_repr, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- 0, /* tp_hash */
- PyVectorcall_Call, /* tp_call */
- 0, /* tp_str */
- 0, /* tp_getattro */
- 0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
- Py_TPFLAGS_HAVE_VECTORCALL |
- Py_TPFLAGS_METHOD_DESCRIPTOR, /* tp_flags */
- func_new__doc__, /* tp_doc */
- (traverseproc)func_traverse, /* tp_traverse */
- (inquiry)func_clear, /* tp_clear */
- 0, /* tp_richcompare */
- offsetof(PyFunctionObject, func_weakreflist), /* tp_weaklistoffset */
- 0, /* tp_iter */
- 0, /* tp_iternext */
- 0, /* tp_methods */
- func_memberlist, /* tp_members */
- func_getsetlist, /* tp_getset */
- 0, /* tp_base */
- 0, /* tp_dict */
- func_descr_get, /* tp_descr_get */
- 0, /* tp_descr_set */
- offsetof(PyFunctionObject, func_dict), /* tp_dictoffset */
- 0, /* tp_init */
- 0, /* tp_alloc */
- func_new, /* tp_new */
- };
- static int
- functools_copy_attr(PyObject *wrapper, PyObject *wrapped, PyObject *name)
- {
- PyObject *value = PyObject_GetAttr(wrapped, name);
- if (value == NULL) {
- if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
- PyErr_Clear();
- return 0;
- }
- return -1;
- }
- int res = PyObject_SetAttr(wrapper, name, value);
- Py_DECREF(value);
- return res;
- }
- // Similar to functools.wraps(wrapper, wrapped)
- static int
- functools_wraps(PyObject *wrapper, PyObject *wrapped)
- {
- #define COPY_ATTR(ATTR) \
- do { \
- if (functools_copy_attr(wrapper, wrapped, &_Py_ID(ATTR)) < 0) { \
- return -1; \
- } \
- } while (0) \
- COPY_ATTR(__module__);
- COPY_ATTR(__name__);
- COPY_ATTR(__qualname__);
- COPY_ATTR(__doc__);
- COPY_ATTR(__annotations__);
- return 0;
- #undef COPY_ATTR
- }
- /* Class method object */
- /* A class method receives the class as implicit first argument,
- just like an instance method receives the instance.
- To declare a class method, use this idiom:
- class C:
- @classmethod
- def f(cls, arg1, arg2, argN):
- ...
- It can be called either on the class (e.g. C.f()) or on an instance
- (e.g. C().f()); the instance is ignored except for its class.
- If a class method is called for a derived class, the derived class
- object is passed as the implied first argument.
- Class methods are different than C++ or Java static methods.
- If you want those, see static methods below.
- */
- typedef struct {
- PyObject_HEAD
- PyObject *cm_callable;
- PyObject *cm_dict;
- } classmethod;
- static void
- cm_dealloc(classmethod *cm)
- {
- _PyObject_GC_UNTRACK((PyObject *)cm);
- Py_XDECREF(cm->cm_callable);
- Py_XDECREF(cm->cm_dict);
- Py_TYPE(cm)->tp_free((PyObject *)cm);
- }
- static int
- cm_traverse(classmethod *cm, visitproc visit, void *arg)
- {
- Py_VISIT(cm->cm_callable);
- Py_VISIT(cm->cm_dict);
- return 0;
- }
- static int
- cm_clear(classmethod *cm)
- {
- Py_CLEAR(cm->cm_callable);
- Py_CLEAR(cm->cm_dict);
- return 0;
- }
- static PyObject *
- cm_descr_get(PyObject *self, PyObject *obj, PyObject *type)
- {
- classmethod *cm = (classmethod *)self;
- if (cm->cm_callable == NULL) {
- PyErr_SetString(PyExc_RuntimeError,
- "uninitialized classmethod object");
- return NULL;
- }
- if (type == NULL)
- type = (PyObject *)(Py_TYPE(obj));
- if (Py_TYPE(cm->cm_callable)->tp_descr_get != NULL) {
- return Py_TYPE(cm->cm_callable)->tp_descr_get(cm->cm_callable, type,
- type);
- }
- return PyMethod_New(cm->cm_callable, type);
- }
- static int
- cm_init(PyObject *self, PyObject *args, PyObject *kwds)
- {
- classmethod *cm = (classmethod *)self;
- PyObject *callable;
- if (!_PyArg_NoKeywords("classmethod", kwds))
- return -1;
- if (!PyArg_UnpackTuple(args, "classmethod", 1, 1, &callable))
- return -1;
- Py_XSETREF(cm->cm_callable, Py_NewRef(callable));
- if (functools_wraps((PyObject *)cm, cm->cm_callable) < 0) {
- return -1;
- }
- return 0;
- }
- static PyMemberDef cm_memberlist[] = {
- {"__func__", T_OBJECT, offsetof(classmethod, cm_callable), READONLY},
- {"__wrapped__", T_OBJECT, offsetof(classmethod, cm_callable), READONLY},
- {NULL} /* Sentinel */
- };
- static PyObject *
- cm_get___isabstractmethod__(classmethod *cm, void *closure)
- {
- int res = _PyObject_IsAbstract(cm->cm_callable);
- if (res == -1) {
- return NULL;
- }
- else if (res) {
- Py_RETURN_TRUE;
- }
- Py_RETURN_FALSE;
- }
- static PyGetSetDef cm_getsetlist[] = {
- {"__isabstractmethod__",
- (getter)cm_get___isabstractmethod__, NULL, NULL, NULL},
- {"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict, NULL, NULL},
- {NULL} /* Sentinel */
- };
- static PyObject*
- cm_repr(classmethod *cm)
- {
- return PyUnicode_FromFormat("<classmethod(%R)>", cm->cm_callable);
- }
- PyDoc_STRVAR(classmethod_doc,
- "classmethod(function) -> method\n\
- \n\
- Convert a function to be a class method.\n\
- \n\
- A class method receives the class as implicit first argument,\n\
- just like an instance method receives the instance.\n\
- To declare a class method, use this idiom:\n\
- \n\
- class C:\n\
- @classmethod\n\
- def f(cls, arg1, arg2, argN):\n\
- ...\n\
- \n\
- It can be called either on the class (e.g. C.f()) or on an instance\n\
- (e.g. C().f()). The instance is ignored except for its class.\n\
- If a class method is called for a derived class, the derived class\n\
- object is passed as the implied first argument.\n\
- \n\
- Class methods are different than C++ or Java static methods.\n\
- If you want those, see the staticmethod builtin.");
- PyTypeObject PyClassMethod_Type = {
- PyVarObject_HEAD_INIT(&PyType_Type, 0)
- "classmethod",
- sizeof(classmethod),
- 0,
- (destructor)cm_dealloc, /* tp_dealloc */
- 0, /* tp_vectorcall_offset */
- 0, /* tp_getattr */
- 0, /* tp_setattr */
- 0, /* tp_as_async */
- (reprfunc)cm_repr, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- 0, /* tp_hash */
- 0, /* tp_call */
- 0, /* tp_str */
- 0, /* tp_getattro */
- 0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
- classmethod_doc, /* tp_doc */
- (traverseproc)cm_traverse, /* tp_traverse */
- (inquiry)cm_clear, /* tp_clear */
- 0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- 0, /* tp_iter */
- 0, /* tp_iternext */
- 0, /* tp_methods */
- cm_memberlist, /* tp_members */
- cm_getsetlist, /* tp_getset */
- 0, /* tp_base */
- 0, /* tp_dict */
- cm_descr_get, /* tp_descr_get */
- 0, /* tp_descr_set */
- offsetof(classmethod, cm_dict), /* tp_dictoffset */
- cm_init, /* tp_init */
- PyType_GenericAlloc, /* tp_alloc */
- PyType_GenericNew, /* tp_new */
- PyObject_GC_Del, /* tp_free */
- };
- PyObject *
- PyClassMethod_New(PyObject *callable)
- {
- classmethod *cm = (classmethod *)
- PyType_GenericAlloc(&PyClassMethod_Type, 0);
- if (cm != NULL) {
- cm->cm_callable = Py_NewRef(callable);
- }
- return (PyObject *)cm;
- }
- /* Static method object */
- /* A static method does not receive an implicit first argument.
- To declare a static method, use this idiom:
- class C:
- @staticmethod
- def f(arg1, arg2, argN):
- ...
- It can be called either on the class (e.g. C.f()) or on an instance
- (e.g. C().f()). Both the class and the instance are ignored, and
- neither is passed implicitly as the first argument to the method.
- Static methods in Python are similar to those found in Java or C++.
- For a more advanced concept, see class methods above.
- */
- typedef struct {
- PyObject_HEAD
- PyObject *sm_callable;
- PyObject *sm_dict;
- } staticmethod;
- static void
- sm_dealloc(staticmethod *sm)
- {
- _PyObject_GC_UNTRACK((PyObject *)sm);
- Py_XDECREF(sm->sm_callable);
- Py_XDECREF(sm->sm_dict);
- Py_TYPE(sm)->tp_free((PyObject *)sm);
- }
- static int
- sm_traverse(staticmethod *sm, visitproc visit, void *arg)
- {
- Py_VISIT(sm->sm_callable);
- Py_VISIT(sm->sm_dict);
- return 0;
- }
- static int
- sm_clear(staticmethod *sm)
- {
- Py_CLEAR(sm->sm_callable);
- Py_CLEAR(sm->sm_dict);
- return 0;
- }
- static PyObject *
- sm_descr_get(PyObject *self, PyObject *obj, PyObject *type)
- {
- staticmethod *sm = (staticmethod *)self;
- if (sm->sm_callable == NULL) {
- PyErr_SetString(PyExc_RuntimeError,
- "uninitialized staticmethod object");
- return NULL;
- }
- return Py_NewRef(sm->sm_callable);
- }
- static int
- sm_init(PyObject *self, PyObject *args, PyObject *kwds)
- {
- staticmethod *sm = (staticmethod *)self;
- PyObject *callable;
- if (!_PyArg_NoKeywords("staticmethod", kwds))
- return -1;
- if (!PyArg_UnpackTuple(args, "staticmethod", 1, 1, &callable))
- return -1;
- Py_XSETREF(sm->sm_callable, Py_NewRef(callable));
- if (functools_wraps((PyObject *)sm, sm->sm_callable) < 0) {
- return -1;
- }
- return 0;
- }
- static PyObject*
- sm_call(PyObject *callable, PyObject *args, PyObject *kwargs)
- {
- staticmethod *sm = (staticmethod *)callable;
- return PyObject_Call(sm->sm_callable, args, kwargs);
- }
- static PyMemberDef sm_memberlist[] = {
- {"__func__", T_OBJECT, offsetof(staticmethod, sm_callable), READONLY},
- {"__wrapped__", T_OBJECT, offsetof(staticmethod, sm_callable), READONLY},
- {NULL} /* Sentinel */
- };
- static PyObject *
- sm_get___isabstractmethod__(staticmethod *sm, void *closure)
- {
- int res = _PyObject_IsAbstract(sm->sm_callable);
- if (res == -1) {
- return NULL;
- }
- else if (res) {
- Py_RETURN_TRUE;
- }
- Py_RETURN_FALSE;
- }
- static PyGetSetDef sm_getsetlist[] = {
- {"__isabstractmethod__",
- (getter)sm_get___isabstractmethod__, NULL, NULL, NULL},
- {"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict, NULL, NULL},
- {NULL} /* Sentinel */
- };
- static PyObject*
- sm_repr(staticmethod *sm)
- {
- return PyUnicode_FromFormat("<staticmethod(%R)>", sm->sm_callable);
- }
- PyDoc_STRVAR(staticmethod_doc,
- "staticmethod(function) -> method\n\
- \n\
- Convert a function to be a static method.\n\
- \n\
- A static method does not receive an implicit first argument.\n\
- To declare a static method, use this idiom:\n\
- \n\
- class C:\n\
- @staticmethod\n\
- def f(arg1, arg2, argN):\n\
- ...\n\
- \n\
- It can be called either on the class (e.g. C.f()) or on an instance\n\
- (e.g. C().f()). Both the class and the instance are ignored, and\n\
- neither is passed implicitly as the first argument to the method.\n\
- \n\
- Static methods in Python are similar to those found in Java or C++.\n\
- For a more advanced concept, see the classmethod builtin.");
- PyTypeObject PyStaticMethod_Type = {
- PyVarObject_HEAD_INIT(&PyType_Type, 0)
- "staticmethod",
- sizeof(staticmethod),
- 0,
- (destructor)sm_dealloc, /* tp_dealloc */
- 0, /* tp_vectorcall_offset */
- 0, /* tp_getattr */
- 0, /* tp_setattr */
- 0, /* tp_as_async */
- (reprfunc)sm_repr, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- 0, /* tp_hash */
- sm_call, /* tp_call */
- 0, /* tp_str */
- 0, /* tp_getattro */
- 0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
- staticmethod_doc, /* tp_doc */
- (traverseproc)sm_traverse, /* tp_traverse */
- (inquiry)sm_clear, /* tp_clear */
- 0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- 0, /* tp_iter */
- 0, /* tp_iternext */
- 0, /* tp_methods */
- sm_memberlist, /* tp_members */
- sm_getsetlist, /* tp_getset */
- 0, /* tp_base */
- 0, /* tp_dict */
- sm_descr_get, /* tp_descr_get */
- 0, /* tp_descr_set */
- offsetof(staticmethod, sm_dict), /* tp_dictoffset */
- sm_init, /* tp_init */
- PyType_GenericAlloc, /* tp_alloc */
- PyType_GenericNew, /* tp_new */
- PyObject_GC_Del, /* tp_free */
- };
- PyObject *
- PyStaticMethod_New(PyObject *callable)
- {
- staticmethod *sm = (staticmethod *)
- PyType_GenericAlloc(&PyStaticMethod_Type, 0);
- if (sm != NULL) {
- sm->sm_callable = Py_NewRef(callable);
- }
- return (PyObject *)sm;
- }
|