Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | /* Function object implementation */ |
| 3 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 4 | #include "Python.h" |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 5 | #include "code.h" |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 6 | #include "eval.h" |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 7 | #include "structmember.h" |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 8 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 9 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 10 | PyFunction_New(PyObject *code, PyObject *globals) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 11 | { |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 12 | PyFunctionObject *op = PyObject_GC_New(PyFunctionObject, |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 13 | &PyFunction_Type); |
Martin v. Löwis | 321c9ab | 2004-03-23 18:40:15 +0000 | [diff] [blame] | 14 | static PyObject *__name__ = 0; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 15 | if (op != NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 16 | PyObject *doc; |
| 17 | PyObject *consts; |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 18 | PyObject *module; |
Fred Drake | db81e8d | 2001-03-23 04:19:27 +0000 | [diff] [blame] | 19 | op->func_weakreflist = NULL; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 20 | Py_INCREF(code); |
Guido van Rossum | 846e431 | 1990-11-18 17:44:06 +0000 | [diff] [blame] | 21 | op->func_code = code; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 22 | Py_INCREF(globals); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 23 | op->func_globals = globals; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 24 | op->func_name = ((PyCodeObject *)code)->co_name; |
| 25 | Py_INCREF(op->func_name); |
Guido van Rossum | 2271bf7 | 1995-07-18 14:30:34 +0000 | [diff] [blame] | 26 | op->func_defaults = NULL; /* No default arguments */ |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 27 | op->func_kwdefaults = NULL; /* No keyword only defaults */ |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 28 | op->func_closure = NULL; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 29 | consts = ((PyCodeObject *)code)->co_consts; |
| 30 | if (PyTuple_Size(consts) >= 1) { |
| 31 | doc = PyTuple_GetItem(consts, 0); |
Guido van Rossum | ec5b776 | 2000-04-27 20:14:13 +0000 | [diff] [blame] | 32 | if (!PyString_Check(doc) && !PyUnicode_Check(doc)) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 33 | doc = Py_None; |
Guido van Rossum | 5bd3805 | 1995-01-07 12:01:30 +0000 | [diff] [blame] | 34 | } |
| 35 | else |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 36 | doc = Py_None; |
| 37 | Py_INCREF(doc); |
Guido van Rossum | 5bd3805 | 1995-01-07 12:01:30 +0000 | [diff] [blame] | 38 | op->func_doc = doc; |
Barry Warsaw | d6a9e84 | 2001-01-15 20:40:19 +0000 | [diff] [blame] | 39 | op->func_dict = NULL; |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 40 | op->func_module = NULL; |
| 41 | |
| 42 | /* __module__: If module name is in globals, use it. |
| 43 | Otherwise, use None. |
| 44 | */ |
Martin v. Löwis | 321c9ab | 2004-03-23 18:40:15 +0000 | [diff] [blame] | 45 | if (!__name__) { |
| 46 | __name__ = PyString_InternFromString("__name__"); |
| 47 | if (!__name__) { |
| 48 | Py_DECREF(op); |
| 49 | return NULL; |
| 50 | } |
| 51 | } |
| 52 | module = PyDict_GetItem(globals, __name__); |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 53 | if (module) { |
| 54 | Py_INCREF(module); |
| 55 | op->func_module = module; |
| 56 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 57 | } |
Barry Warsaw | d6a9e84 | 2001-01-15 20:40:19 +0000 | [diff] [blame] | 58 | else |
| 59 | return NULL; |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 60 | _PyObject_GC_TRACK(op); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 61 | return (PyObject *)op; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 62 | } |
| 63 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 64 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 65 | PyFunction_GetCode(PyObject *op) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 66 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 67 | if (!PyFunction_Check(op)) { |
| 68 | PyErr_BadInternalCall(); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 69 | return NULL; |
| 70 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 71 | return ((PyFunctionObject *) op) -> func_code; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 72 | } |
| 73 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 74 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 75 | PyFunction_GetGlobals(PyObject *op) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 76 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 77 | if (!PyFunction_Check(op)) { |
| 78 | PyErr_BadInternalCall(); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 79 | return NULL; |
| 80 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 81 | return ((PyFunctionObject *) op) -> func_globals; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 82 | } |
| 83 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 84 | PyObject * |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 85 | PyFunction_GetModule(PyObject *op) |
| 86 | { |
| 87 | if (!PyFunction_Check(op)) { |
| 88 | PyErr_BadInternalCall(); |
| 89 | return NULL; |
| 90 | } |
| 91 | return ((PyFunctionObject *) op) -> func_module; |
| 92 | } |
| 93 | |
| 94 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 95 | PyFunction_GetDefaults(PyObject *op) |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 96 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 97 | if (!PyFunction_Check(op)) { |
| 98 | PyErr_BadInternalCall(); |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 99 | return NULL; |
| 100 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 101 | return ((PyFunctionObject *) op) -> func_defaults; |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | int |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 105 | PyFunction_SetDefaults(PyObject *op, PyObject *defaults) |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 106 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 107 | if (!PyFunction_Check(op)) { |
| 108 | PyErr_BadInternalCall(); |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 109 | return -1; |
| 110 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 111 | if (defaults == Py_None) |
Guido van Rossum | 2271bf7 | 1995-07-18 14:30:34 +0000 | [diff] [blame] | 112 | defaults = NULL; |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 113 | else if (defaults && PyTuple_Check(defaults)) { |
| 114 | Py_INCREF(defaults); |
Guido van Rossum | 1109fbc | 1998-04-10 22:16:39 +0000 | [diff] [blame] | 115 | } |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 116 | else { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 117 | PyErr_SetString(PyExc_SystemError, "non-tuple default args"); |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 118 | return -1; |
| 119 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 120 | Py_XDECREF(((PyFunctionObject *) op) -> func_defaults); |
| 121 | ((PyFunctionObject *) op) -> func_defaults = defaults; |
Guido van Rossum | 1d5735e | 1994-08-30 08:27:36 +0000 | [diff] [blame] | 122 | return 0; |
| 123 | } |
| 124 | |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 125 | PyObject * |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 126 | PyFunction_GetKwDefaults(PyObject *op) |
| 127 | { |
| 128 | if (!PyFunction_Check(op)) { |
| 129 | PyErr_BadInternalCall(); |
| 130 | return NULL; |
| 131 | } |
| 132 | return ((PyFunctionObject *) op) -> func_kwdefaults; |
| 133 | } |
| 134 | |
| 135 | int |
| 136 | PyFunction_SetKwDefaults(PyObject *op, PyObject *defaults) |
| 137 | { |
| 138 | if (!PyFunction_Check(op)) { |
| 139 | PyErr_BadInternalCall(); |
| 140 | return -1; |
| 141 | } |
| 142 | if (defaults == Py_None) |
| 143 | defaults = NULL; |
| 144 | else if (defaults && PyDict_Check(defaults)) { |
| 145 | Py_INCREF(defaults); |
| 146 | } |
| 147 | else { |
| 148 | PyErr_SetString(PyExc_SystemError, |
| 149 | "non-dict keyword only default args"); |
| 150 | return -1; |
| 151 | } |
| 152 | Py_XDECREF(((PyFunctionObject *)op) -> func_kwdefaults); |
| 153 | ((PyFunctionObject *) op) -> func_kwdefaults = defaults; |
| 154 | return 0; |
| 155 | } |
| 156 | |
| 157 | PyObject * |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 158 | PyFunction_GetClosure(PyObject *op) |
| 159 | { |
| 160 | if (!PyFunction_Check(op)) { |
| 161 | PyErr_BadInternalCall(); |
| 162 | return NULL; |
| 163 | } |
| 164 | return ((PyFunctionObject *) op) -> func_closure; |
| 165 | } |
| 166 | |
| 167 | int |
| 168 | PyFunction_SetClosure(PyObject *op, PyObject *closure) |
| 169 | { |
| 170 | if (!PyFunction_Check(op)) { |
| 171 | PyErr_BadInternalCall(); |
| 172 | return -1; |
| 173 | } |
| 174 | if (closure == Py_None) |
| 175 | closure = NULL; |
| 176 | else if (PyTuple_Check(closure)) { |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 177 | Py_INCREF(closure); |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 178 | } |
| 179 | else { |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 180 | PyErr_Format(PyExc_SystemError, |
| 181 | "expected tuple for closure, got '%.100s'", |
| 182 | closure->ob_type->tp_name); |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 183 | return -1; |
| 184 | } |
| 185 | Py_XDECREF(((PyFunctionObject *) op) -> func_closure); |
| 186 | ((PyFunctionObject *) op) -> func_closure = closure; |
| 187 | return 0; |
| 188 | } |
| 189 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 190 | /* Methods */ |
| 191 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 192 | #define OFF(x) offsetof(PyFunctionObject, x) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 193 | |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 194 | static PyMemberDef func_memberlist[] = { |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 195 | {"func_closure", T_OBJECT, OFF(func_closure), |
| 196 | RESTRICTED|READONLY}, |
| 197 | {"func_doc", T_OBJECT, OFF(func_doc), WRITE_RESTRICTED}, |
| 198 | {"__doc__", T_OBJECT, OFF(func_doc), WRITE_RESTRICTED}, |
| 199 | {"func_globals", T_OBJECT, OFF(func_globals), |
| 200 | RESTRICTED|READONLY}, |
Guido van Rossum | 6b29c01 | 2003-02-18 17:18:35 +0000 | [diff] [blame] | 201 | {"__module__", T_OBJECT, OFF(func_module), WRITE_RESTRICTED}, |
Barry Warsaw | 0395fdd | 2001-01-19 19:53:29 +0000 | [diff] [blame] | 202 | {NULL} /* Sentinel */ |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 203 | }; |
| 204 | |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 205 | static int |
| 206 | restricted(void) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 207 | { |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 208 | if (!PyEval_GetRestricted()) |
| 209 | return 0; |
| 210 | PyErr_SetString(PyExc_RuntimeError, |
| 211 | "function attributes not accessible in restricted mode"); |
| 212 | return 1; |
| 213 | } |
| 214 | |
| 215 | static PyObject * |
| 216 | func_get_dict(PyFunctionObject *op) |
| 217 | { |
| 218 | if (restricted()) |
Guido van Rossum | 10393b1 | 1995-01-10 10:39:49 +0000 | [diff] [blame] | 219 | return NULL; |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 220 | if (op->func_dict == NULL) { |
| 221 | op->func_dict = PyDict_New(); |
| 222 | if (op->func_dict == NULL) |
Barry Warsaw | 142865c | 2001-08-14 18:23:58 +0000 | [diff] [blame] | 223 | return NULL; |
| 224 | } |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 225 | Py_INCREF(op->func_dict); |
| 226 | return op->func_dict; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 227 | } |
| 228 | |
Guido van Rossum | 0dabace | 1998-05-22 00:55:34 +0000 | [diff] [blame] | 229 | static int |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 230 | func_set_dict(PyFunctionObject *op, PyObject *value) |
Guido van Rossum | 0dabace | 1998-05-22 00:55:34 +0000 | [diff] [blame] | 231 | { |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 232 | PyObject *tmp; |
Barry Warsaw | d6a9e84 | 2001-01-15 20:40:19 +0000 | [diff] [blame] | 233 | |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 234 | if (restricted()) |
| 235 | return -1; |
| 236 | /* It is illegal to del f.func_dict */ |
| 237 | if (value == NULL) { |
| 238 | PyErr_SetString(PyExc_TypeError, |
| 239 | "function's dictionary may not be deleted"); |
Guido van Rossum | 0dabace | 1998-05-22 00:55:34 +0000 | [diff] [blame] | 240 | return -1; |
| 241 | } |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 242 | /* Can only set func_dict to a dictionary */ |
| 243 | if (!PyDict_Check(value)) { |
| 244 | PyErr_SetString(PyExc_TypeError, |
Barry Warsaw | 142865c | 2001-08-14 18:23:58 +0000 | [diff] [blame] | 245 | "setting function's dictionary to a non-dict"); |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 246 | return -1; |
Barry Warsaw | d6a9e84 | 2001-01-15 20:40:19 +0000 | [diff] [blame] | 247 | } |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 248 | tmp = op->func_dict; |
| 249 | Py_INCREF(value); |
| 250 | op->func_dict = value; |
| 251 | Py_XDECREF(tmp); |
| 252 | return 0; |
Guido van Rossum | 0dabace | 1998-05-22 00:55:34 +0000 | [diff] [blame] | 253 | } |
| 254 | |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 255 | static PyObject * |
| 256 | func_get_code(PyFunctionObject *op) |
| 257 | { |
| 258 | if (restricted()) |
| 259 | return NULL; |
| 260 | Py_INCREF(op->func_code); |
| 261 | return op->func_code; |
| 262 | } |
| 263 | |
| 264 | static int |
| 265 | func_set_code(PyFunctionObject *op, PyObject *value) |
| 266 | { |
| 267 | PyObject *tmp; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 268 | Py_ssize_t nfree, nclosure; |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 269 | |
| 270 | if (restricted()) |
| 271 | return -1; |
| 272 | /* Not legal to del f.func_code or to set it to anything |
| 273 | * other than a code object. */ |
| 274 | if (value == NULL || !PyCode_Check(value)) { |
| 275 | PyErr_SetString(PyExc_TypeError, |
| 276 | "func_code must be set to a code object"); |
| 277 | return -1; |
| 278 | } |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 279 | nfree = PyCode_GetNumFree((PyCodeObject *)value); |
| 280 | nclosure = (op->func_closure == NULL ? 0 : |
| 281 | PyTuple_GET_SIZE(op->func_closure)); |
| 282 | if (nclosure != nfree) { |
| 283 | PyErr_Format(PyExc_ValueError, |
Martin v. Löwis | 2c95cc6 | 2006-02-16 06:54:25 +0000 | [diff] [blame] | 284 | "%s() requires a code object with %zd free vars," |
| 285 | " not %zd", |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 286 | PyString_AsString(op->func_name), |
Martin v. Löwis | e0e89f7 | 2006-02-16 06:59:22 +0000 | [diff] [blame] | 287 | nclosure, nfree); |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 288 | return -1; |
| 289 | } |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 290 | tmp = op->func_code; |
| 291 | Py_INCREF(value); |
| 292 | op->func_code = value; |
| 293 | Py_DECREF(tmp); |
| 294 | return 0; |
| 295 | } |
| 296 | |
| 297 | static PyObject * |
Michael W. Hudson | 5e89795 | 2004-08-12 18:12:44 +0000 | [diff] [blame] | 298 | func_get_name(PyFunctionObject *op) |
| 299 | { |
Michael W. Hudson | 5e89795 | 2004-08-12 18:12:44 +0000 | [diff] [blame] | 300 | Py_INCREF(op->func_name); |
| 301 | return op->func_name; |
| 302 | } |
| 303 | |
| 304 | static int |
| 305 | func_set_name(PyFunctionObject *op, PyObject *value) |
| 306 | { |
| 307 | PyObject *tmp; |
| 308 | |
| 309 | if (restricted()) |
| 310 | return -1; |
| 311 | /* Not legal to del f.func_name or to set it to anything |
| 312 | * other than a string object. */ |
| 313 | if (value == NULL || !PyString_Check(value)) { |
| 314 | PyErr_SetString(PyExc_TypeError, |
| 315 | "func_name must be set to a string object"); |
| 316 | return -1; |
| 317 | } |
| 318 | tmp = op->func_name; |
| 319 | Py_INCREF(value); |
| 320 | op->func_name = value; |
| 321 | Py_DECREF(tmp); |
| 322 | return 0; |
| 323 | } |
| 324 | |
| 325 | static PyObject * |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 326 | func_get_defaults(PyFunctionObject *op) |
| 327 | { |
| 328 | if (restricted()) |
| 329 | return NULL; |
| 330 | if (op->func_defaults == NULL) { |
| 331 | Py_INCREF(Py_None); |
| 332 | return Py_None; |
| 333 | } |
| 334 | Py_INCREF(op->func_defaults); |
| 335 | return op->func_defaults; |
| 336 | } |
| 337 | |
| 338 | static int |
| 339 | func_set_defaults(PyFunctionObject *op, PyObject *value) |
| 340 | { |
| 341 | PyObject *tmp; |
| 342 | |
| 343 | if (restricted()) |
| 344 | return -1; |
| 345 | /* Legal to del f.func_defaults. |
| 346 | * Can only set func_defaults to NULL or a tuple. */ |
| 347 | if (value == Py_None) |
| 348 | value = NULL; |
| 349 | if (value != NULL && !PyTuple_Check(value)) { |
| 350 | PyErr_SetString(PyExc_TypeError, |
| 351 | "func_defaults must be set to a tuple object"); |
| 352 | return -1; |
| 353 | } |
| 354 | tmp = op->func_defaults; |
| 355 | Py_XINCREF(value); |
| 356 | op->func_defaults = value; |
| 357 | Py_XDECREF(tmp); |
| 358 | return 0; |
| 359 | } |
| 360 | |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 361 | static PyObject * |
| 362 | func_get_kwdefaults(PyFunctionObject *op) |
| 363 | { |
| 364 | if (restricted()) |
| 365 | return NULL; |
| 366 | if (op->func_kwdefaults == NULL) { |
| 367 | Py_INCREF(Py_None); |
| 368 | return Py_None; |
| 369 | } |
| 370 | Py_INCREF(op->func_kwdefaults); |
| 371 | return op->func_kwdefaults; |
| 372 | } |
| 373 | |
| 374 | static int |
| 375 | func_set_kwdefaults(PyFunctionObject *op, PyObject *value) |
| 376 | { |
| 377 | PyObject *tmp; |
| 378 | |
| 379 | if (restricted()) |
| 380 | return -1; |
| 381 | |
| 382 | if (value == Py_None) |
| 383 | value = NULL; |
| 384 | /* Legal to del f.func_defaults. |
| 385 | * Can only set func_kwdefaults to NULL or a dict. */ |
| 386 | if (value != NULL && !PyDict_Check(value)) { |
| 387 | PyErr_SetString(PyExc_TypeError, |
| 388 | "func_kwdefaults must be set to a dict object"); |
| 389 | return -1; |
| 390 | } |
| 391 | tmp = op->func_kwdefaults; |
| 392 | Py_XINCREF(value); |
| 393 | op->func_kwdefaults = value; |
| 394 | Py_XDECREF(tmp); |
| 395 | return 0; |
| 396 | } |
| 397 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 398 | static PyGetSetDef func_getsetlist[] = { |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 399 | {"func_code", (getter)func_get_code, (setter)func_set_code}, |
| 400 | {"func_defaults", (getter)func_get_defaults, |
| 401 | (setter)func_set_defaults}, |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 402 | {"func_kwdefaults", (getter)func_get_kwdefaults, |
| 403 | (setter)func_set_kwdefaults}, |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 404 | {"func_dict", (getter)func_get_dict, (setter)func_set_dict}, |
| 405 | {"__dict__", (getter)func_get_dict, (setter)func_set_dict}, |
Michael W. Hudson | 5e89795 | 2004-08-12 18:12:44 +0000 | [diff] [blame] | 406 | {"func_name", (getter)func_get_name, (setter)func_set_name}, |
| 407 | {"__name__", (getter)func_get_name, (setter)func_set_name}, |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 408 | {NULL} /* Sentinel */ |
| 409 | }; |
| 410 | |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 411 | PyDoc_STRVAR(func_doc, |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 412 | "function(code, globals[, name[, argdefs[, closure]]])\n\ |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 413 | \n\ |
| 414 | Create a function object from a code object and a dictionary.\n\ |
| 415 | The optional name string overrides the name from the code object.\n\ |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 416 | The optional argdefs tuple specifies the default argument values.\n\ |
| 417 | The optional closure tuple supplies the bindings for free variables."); |
| 418 | |
| 419 | /* func_new() maintains the following invariants for closures. The |
| 420 | closure must correspond to the free variables of the code object. |
| 421 | |
| 422 | if len(code.co_freevars) == 0: |
| 423 | closure = NULL |
| 424 | else: |
| 425 | len(closure) == len(code.co_freevars) |
| 426 | for every elt in closure, type(elt) == cell |
| 427 | */ |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 428 | |
| 429 | static PyObject * |
| 430 | func_new(PyTypeObject* type, PyObject* args, PyObject* kw) |
| 431 | { |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 432 | PyCodeObject *code; |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 433 | PyObject *globals; |
| 434 | PyObject *name = Py_None; |
| 435 | PyObject *defaults = Py_None; |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 436 | PyObject *closure = Py_None; |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 437 | PyFunctionObject *newfunc; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 438 | Py_ssize_t nfree, nclosure; |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 439 | static char *kwlist[] = {"code", "globals", "name", |
Raymond Hettinger | 8657845 | 2003-05-06 09:01:41 +0000 | [diff] [blame] | 440 | "argdefs", "closure", 0}; |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 441 | |
Raymond Hettinger | 8657845 | 2003-05-06 09:01:41 +0000 | [diff] [blame] | 442 | if (!PyArg_ParseTupleAndKeywords(args, kw, "O!O!|OOO:function", |
| 443 | kwlist, |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 444 | &PyCode_Type, &code, |
| 445 | &PyDict_Type, &globals, |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 446 | &name, &defaults, &closure)) |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 447 | return NULL; |
| 448 | if (name != Py_None && !PyString_Check(name)) { |
| 449 | PyErr_SetString(PyExc_TypeError, |
| 450 | "arg 3 (name) must be None or string"); |
| 451 | return NULL; |
| 452 | } |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 453 | if (defaults != Py_None && !PyTuple_Check(defaults)) { |
| 454 | PyErr_SetString(PyExc_TypeError, |
| 455 | "arg 4 (defaults) must be None or tuple"); |
| 456 | return NULL; |
| 457 | } |
| 458 | nfree = PyTuple_GET_SIZE(code->co_freevars); |
| 459 | if (!PyTuple_Check(closure)) { |
| 460 | if (nfree && closure == Py_None) { |
| 461 | PyErr_SetString(PyExc_TypeError, |
| 462 | "arg 5 (closure) must be tuple"); |
| 463 | return NULL; |
| 464 | } |
| 465 | else if (closure != Py_None) { |
| 466 | PyErr_SetString(PyExc_TypeError, |
| 467 | "arg 5 (closure) must be None or tuple"); |
| 468 | return NULL; |
| 469 | } |
| 470 | } |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 471 | |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 472 | /* check that the closure is well-formed */ |
| 473 | nclosure = closure == Py_None ? 0 : PyTuple_GET_SIZE(closure); |
| 474 | if (nfree != nclosure) |
| 475 | return PyErr_Format(PyExc_ValueError, |
Martin v. Löwis | 2c95cc6 | 2006-02-16 06:54:25 +0000 | [diff] [blame] | 476 | "%s requires closure of length %zd, not %zd", |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 477 | PyString_AS_STRING(code->co_name), |
Martin v. Löwis | e0e89f7 | 2006-02-16 06:59:22 +0000 | [diff] [blame] | 478 | nfree, nclosure); |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 479 | if (nclosure) { |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 480 | Py_ssize_t i; |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 481 | for (i = 0; i < nclosure; i++) { |
| 482 | PyObject *o = PyTuple_GET_ITEM(closure, i); |
| 483 | if (!PyCell_Check(o)) { |
| 484 | return PyErr_Format(PyExc_TypeError, |
| 485 | "arg 5 (closure) expected cell, found %s", |
| 486 | o->ob_type->tp_name); |
| 487 | } |
| 488 | } |
| 489 | } |
| 490 | |
| 491 | newfunc = (PyFunctionObject *)PyFunction_New((PyObject *)code, |
| 492 | globals); |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 493 | if (newfunc == NULL) |
| 494 | return NULL; |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 495 | |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 496 | if (name != Py_None) { |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 497 | Py_INCREF(name); |
| 498 | Py_DECREF(newfunc->func_name); |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 499 | newfunc->func_name = name; |
| 500 | } |
| 501 | if (defaults != Py_None) { |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 502 | Py_INCREF(defaults); |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 503 | newfunc->func_defaults = defaults; |
| 504 | } |
Jeremy Hylton | df3f793 | 2002-07-11 18:30:27 +0000 | [diff] [blame] | 505 | if (closure != Py_None) { |
| 506 | Py_INCREF(closure); |
| 507 | newfunc->func_closure = closure; |
| 508 | } |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 509 | |
| 510 | return (PyObject *)newfunc; |
| 511 | } |
| 512 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 513 | static void |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 514 | func_dealloc(PyFunctionObject *op) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 515 | { |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 516 | _PyObject_GC_UNTRACK(op); |
Fred Drake | c916f5a | 2001-10-26 17:56:51 +0000 | [diff] [blame] | 517 | if (op->func_weakreflist != NULL) |
| 518 | PyObject_ClearWeakRefs((PyObject *) op); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 519 | Py_DECREF(op->func_code); |
| 520 | Py_DECREF(op->func_globals); |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 521 | Py_XDECREF(op->func_module); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 522 | Py_DECREF(op->func_name); |
| 523 | Py_XDECREF(op->func_defaults); |
| 524 | Py_XDECREF(op->func_doc); |
Barry Warsaw | d6a9e84 | 2001-01-15 20:40:19 +0000 | [diff] [blame] | 525 | Py_XDECREF(op->func_dict); |
Jeremy Hylton | a52e8fe | 2001-03-01 06:06:37 +0000 | [diff] [blame] | 526 | Py_XDECREF(op->func_closure); |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 527 | PyObject_GC_Del(op); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 528 | } |
| 529 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 530 | static PyObject* |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 531 | func_repr(PyFunctionObject *op) |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 532 | { |
Barry Warsaw | 7ce3694 | 2001-08-24 18:34:26 +0000 | [diff] [blame] | 533 | return PyString_FromFormat("<function %s at %p>", |
| 534 | PyString_AsString(op->func_name), |
| 535 | op); |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 536 | } |
| 537 | |
Guido van Rossum | 2e8f8a3 | 1993-11-05 10:20:10 +0000 | [diff] [blame] | 538 | static int |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 539 | func_traverse(PyFunctionObject *f, visitproc visit, void *arg) |
| 540 | { |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 541 | Py_VISIT(f->func_code); |
| 542 | Py_VISIT(f->func_globals); |
| 543 | Py_VISIT(f->func_module); |
| 544 | Py_VISIT(f->func_defaults); |
| 545 | Py_VISIT(f->func_doc); |
| 546 | Py_VISIT(f->func_name); |
| 547 | Py_VISIT(f->func_dict); |
| 548 | Py_VISIT(f->func_closure); |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 549 | return 0; |
| 550 | } |
| 551 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 552 | static PyObject * |
| 553 | function_call(PyObject *func, PyObject *arg, PyObject *kw) |
| 554 | { |
| 555 | PyObject *result; |
| 556 | PyObject *argdefs; |
| 557 | PyObject **d, **k; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 558 | Py_ssize_t nk, nd; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 559 | |
| 560 | argdefs = PyFunction_GET_DEFAULTS(func); |
| 561 | if (argdefs != NULL && PyTuple_Check(argdefs)) { |
| 562 | d = &PyTuple_GET_ITEM((PyTupleObject *)argdefs, 0); |
| 563 | nd = PyTuple_Size(argdefs); |
| 564 | } |
| 565 | else { |
| 566 | d = NULL; |
| 567 | nd = 0; |
| 568 | } |
| 569 | |
| 570 | if (kw != NULL && PyDict_Check(kw)) { |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 571 | Py_ssize_t pos, i; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 572 | nk = PyDict_Size(kw); |
| 573 | k = PyMem_NEW(PyObject *, 2*nk); |
| 574 | if (k == NULL) { |
| 575 | PyErr_NoMemory(); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 576 | return NULL; |
| 577 | } |
| 578 | pos = i = 0; |
| 579 | while (PyDict_Next(kw, &pos, &k[i], &k[i+1])) |
| 580 | i += 2; |
| 581 | nk = i/2; |
| 582 | /* XXX This is broken if the caller deletes dict items! */ |
| 583 | } |
| 584 | else { |
| 585 | k = NULL; |
| 586 | nk = 0; |
| 587 | } |
| 588 | |
| 589 | result = PyEval_EvalCodeEx( |
| 590 | (PyCodeObject *)PyFunction_GET_CODE(func), |
| 591 | PyFunction_GET_GLOBALS(func), (PyObject *)NULL, |
| 592 | &PyTuple_GET_ITEM(arg, 0), PyTuple_Size(arg), |
| 593 | k, nk, d, nd, |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 594 | PyFunction_GET_KW_DEFAULTS(func), |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 595 | PyFunction_GET_CLOSURE(func)); |
| 596 | |
| 597 | if (k != NULL) |
| 598 | PyMem_DEL(k); |
| 599 | |
| 600 | return result; |
| 601 | } |
| 602 | |
| 603 | /* Bind a function to an object */ |
| 604 | static PyObject * |
| 605 | func_descr_get(PyObject *func, PyObject *obj, PyObject *type) |
| 606 | { |
| 607 | if (obj == Py_None) |
| 608 | obj = NULL; |
| 609 | return PyMethod_New(func, obj, type); |
| 610 | } |
| 611 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 612 | PyTypeObject PyFunction_Type = { |
| 613 | PyObject_HEAD_INIT(&PyType_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 614 | 0, |
| 615 | "function", |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 616 | sizeof(PyFunctionObject), |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 617 | 0, |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 618 | (destructor)func_dealloc, /* tp_dealloc */ |
| 619 | 0, /* tp_print */ |
| 620 | 0, /* tp_getattr */ |
| 621 | 0, /* tp_setattr */ |
| 622 | 0, /* tp_compare */ |
| 623 | (reprfunc)func_repr, /* tp_repr */ |
| 624 | 0, /* tp_as_number */ |
| 625 | 0, /* tp_as_sequence */ |
| 626 | 0, /* tp_as_mapping */ |
| 627 | 0, /* tp_hash */ |
| 628 | function_call, /* tp_call */ |
| 629 | 0, /* tp_str */ |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 630 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 631 | PyObject_GenericSetAttr, /* tp_setattro */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 632 | 0, /* tp_as_buffer */ |
Neil Schemenauer | e83c00e | 2001-08-29 23:54:21 +0000 | [diff] [blame] | 633 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */ |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 634 | func_doc, /* tp_doc */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 635 | (traverseproc)func_traverse, /* tp_traverse */ |
| 636 | 0, /* tp_clear */ |
| 637 | 0, /* tp_richcompare */ |
Fred Drake | db81e8d | 2001-03-23 04:19:27 +0000 | [diff] [blame] | 638 | offsetof(PyFunctionObject, func_weakreflist), /* tp_weaklistoffset */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 639 | 0, /* tp_iter */ |
| 640 | 0, /* tp_iternext */ |
| 641 | 0, /* tp_methods */ |
| 642 | func_memberlist, /* tp_members */ |
Guido van Rossum | d9d1d4a | 2001-09-17 23:46:56 +0000 | [diff] [blame] | 643 | func_getsetlist, /* tp_getset */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 644 | 0, /* tp_base */ |
| 645 | 0, /* tp_dict */ |
| 646 | func_descr_get, /* tp_descr_get */ |
| 647 | 0, /* tp_descr_set */ |
| 648 | offsetof(PyFunctionObject, func_dict), /* tp_dictoffset */ |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 649 | 0, /* tp_init */ |
| 650 | 0, /* tp_alloc */ |
| 651 | func_new, /* tp_new */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 652 | }; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 653 | |
| 654 | |
| 655 | /* Class method object */ |
| 656 | |
| 657 | /* A class method receives the class as implicit first argument, |
| 658 | just like an instance method receives the instance. |
| 659 | To declare a class method, use this idiom: |
| 660 | |
| 661 | class C: |
| 662 | def f(cls, arg1, arg2, ...): ... |
| 663 | f = classmethod(f) |
| 664 | |
| 665 | It can be called either on the class (e.g. C.f()) or on an instance |
| 666 | (e.g. C().f()); the instance is ignored except for its class. |
| 667 | If a class method is called for a derived class, the derived class |
| 668 | object is passed as the implied first argument. |
| 669 | |
| 670 | Class methods are different than C++ or Java static methods. |
| 671 | If you want those, see static methods below. |
| 672 | */ |
| 673 | |
| 674 | typedef struct { |
| 675 | PyObject_HEAD |
| 676 | PyObject *cm_callable; |
| 677 | } classmethod; |
| 678 | |
| 679 | static void |
| 680 | cm_dealloc(classmethod *cm) |
| 681 | { |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 682 | _PyObject_GC_UNTRACK((PyObject *)cm); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 683 | Py_XDECREF(cm->cm_callable); |
Guido van Rossum | 9475a23 | 2001-10-05 20:51:39 +0000 | [diff] [blame] | 684 | cm->ob_type->tp_free((PyObject *)cm); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 685 | } |
| 686 | |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 687 | static int |
| 688 | cm_traverse(classmethod *cm, visitproc visit, void *arg) |
| 689 | { |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 690 | Py_VISIT(cm->cm_callable); |
| 691 | return 0; |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 692 | } |
| 693 | |
| 694 | static int |
| 695 | cm_clear(classmethod *cm) |
| 696 | { |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 697 | Py_CLEAR(cm->cm_callable); |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 698 | return 0; |
| 699 | } |
| 700 | |
| 701 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 702 | static PyObject * |
| 703 | cm_descr_get(PyObject *self, PyObject *obj, PyObject *type) |
| 704 | { |
| 705 | classmethod *cm = (classmethod *)self; |
| 706 | |
| 707 | if (cm->cm_callable == NULL) { |
| 708 | PyErr_SetString(PyExc_RuntimeError, |
| 709 | "uninitialized classmethod object"); |
| 710 | return NULL; |
| 711 | } |
Guido van Rossum | 7e30548 | 2002-03-18 03:09:06 +0000 | [diff] [blame] | 712 | if (type == NULL) |
| 713 | type = (PyObject *)(obj->ob_type); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 714 | return PyMethod_New(cm->cm_callable, |
| 715 | type, (PyObject *)(type->ob_type)); |
| 716 | } |
| 717 | |
| 718 | static int |
| 719 | cm_init(PyObject *self, PyObject *args, PyObject *kwds) |
| 720 | { |
| 721 | classmethod *cm = (classmethod *)self; |
| 722 | PyObject *callable; |
| 723 | |
Raymond Hettinger | ea3fdf4 | 2002-12-29 16:33:45 +0000 | [diff] [blame] | 724 | if (!PyArg_UnpackTuple(args, "classmethod", 1, 1, &callable)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 725 | return -1; |
Georg Brandl | d02db40 | 2006-02-21 22:13:44 +0000 | [diff] [blame] | 726 | if (!_PyArg_NoKeywords("classmethod", kwds)) |
| 727 | return -1; |
Raymond Hettinger | be97153 | 2003-06-18 01:13:41 +0000 | [diff] [blame] | 728 | if (!PyCallable_Check(callable)) { |
| 729 | PyErr_Format(PyExc_TypeError, "'%s' object is not callable", |
| 730 | callable->ob_type->tp_name); |
| 731 | return -1; |
| 732 | } |
| 733 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 734 | Py_INCREF(callable); |
| 735 | cm->cm_callable = callable; |
| 736 | return 0; |
| 737 | } |
| 738 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 739 | PyDoc_STRVAR(classmethod_doc, |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 740 | "classmethod(function) -> method\n\ |
| 741 | \n\ |
| 742 | Convert a function to be a class method.\n\ |
| 743 | \n\ |
| 744 | A class method receives the class as implicit first argument,\n\ |
| 745 | just like an instance method receives the instance.\n\ |
| 746 | To declare a class method, use this idiom:\n\ |
| 747 | \n\ |
| 748 | class C:\n\ |
| 749 | def f(cls, arg1, arg2, ...): ...\n\ |
| 750 | f = classmethod(f)\n\ |
| 751 | \n\ |
| 752 | It can be called either on the class (e.g. C.f()) or on an instance\n\ |
| 753 | (e.g. C().f()). The instance is ignored except for its class.\n\ |
| 754 | If a class method is called for a derived class, the derived class\n\ |
| 755 | object is passed as the implied first argument.\n\ |
Sjoerd Mullender | 564980b | 2001-12-17 11:39:56 +0000 | [diff] [blame] | 756 | \n\ |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 757 | Class methods are different than C++ or Java static methods.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 758 | If you want those, see the staticmethod builtin."); |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 759 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 760 | PyTypeObject PyClassMethod_Type = { |
| 761 | PyObject_HEAD_INIT(&PyType_Type) |
| 762 | 0, |
| 763 | "classmethod", |
| 764 | sizeof(classmethod), |
| 765 | 0, |
| 766 | (destructor)cm_dealloc, /* tp_dealloc */ |
| 767 | 0, /* tp_print */ |
| 768 | 0, /* tp_getattr */ |
| 769 | 0, /* tp_setattr */ |
| 770 | 0, /* tp_compare */ |
| 771 | 0, /* tp_repr */ |
| 772 | 0, /* tp_as_number */ |
| 773 | 0, /* tp_as_sequence */ |
| 774 | 0, /* tp_as_mapping */ |
| 775 | 0, /* tp_hash */ |
| 776 | 0, /* tp_call */ |
| 777 | 0, /* tp_str */ |
| 778 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 779 | 0, /* tp_setattro */ |
| 780 | 0, /* tp_as_buffer */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 781 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 782 | classmethod_doc, /* tp_doc */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 783 | (traverseproc)cm_traverse, /* tp_traverse */ |
| 784 | (inquiry)cm_clear, /* tp_clear */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 785 | 0, /* tp_richcompare */ |
| 786 | 0, /* tp_weaklistoffset */ |
| 787 | 0, /* tp_iter */ |
| 788 | 0, /* tp_iternext */ |
| 789 | 0, /* tp_methods */ |
| 790 | 0, /* tp_members */ |
| 791 | 0, /* tp_getset */ |
| 792 | 0, /* tp_base */ |
| 793 | 0, /* tp_dict */ |
| 794 | cm_descr_get, /* tp_descr_get */ |
| 795 | 0, /* tp_descr_set */ |
| 796 | 0, /* tp_dictoffset */ |
| 797 | cm_init, /* tp_init */ |
| 798 | PyType_GenericAlloc, /* tp_alloc */ |
| 799 | PyType_GenericNew, /* tp_new */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 800 | PyObject_GC_Del, /* tp_free */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 801 | }; |
| 802 | |
| 803 | PyObject * |
| 804 | PyClassMethod_New(PyObject *callable) |
| 805 | { |
| 806 | classmethod *cm = (classmethod *) |
| 807 | PyType_GenericAlloc(&PyClassMethod_Type, 0); |
| 808 | if (cm != NULL) { |
| 809 | Py_INCREF(callable); |
| 810 | cm->cm_callable = callable; |
| 811 | } |
| 812 | return (PyObject *)cm; |
| 813 | } |
| 814 | |
| 815 | |
| 816 | /* Static method object */ |
| 817 | |
| 818 | /* A static method does not receive an implicit first argument. |
| 819 | To declare a static method, use this idiom: |
| 820 | |
| 821 | class C: |
| 822 | def f(arg1, arg2, ...): ... |
| 823 | f = staticmethod(f) |
| 824 | |
| 825 | It can be called either on the class (e.g. C.f()) or on an instance |
| 826 | (e.g. C().f()); the instance is ignored except for its class. |
| 827 | |
| 828 | Static methods in Python are similar to those found in Java or C++. |
| 829 | For a more advanced concept, see class methods above. |
| 830 | */ |
| 831 | |
| 832 | typedef struct { |
| 833 | PyObject_HEAD |
| 834 | PyObject *sm_callable; |
| 835 | } staticmethod; |
| 836 | |
| 837 | static void |
| 838 | sm_dealloc(staticmethod *sm) |
| 839 | { |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 840 | _PyObject_GC_UNTRACK((PyObject *)sm); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 841 | Py_XDECREF(sm->sm_callable); |
Guido van Rossum | 9475a23 | 2001-10-05 20:51:39 +0000 | [diff] [blame] | 842 | sm->ob_type->tp_free((PyObject *)sm); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 843 | } |
| 844 | |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 845 | static int |
| 846 | sm_traverse(staticmethod *sm, visitproc visit, void *arg) |
| 847 | { |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 848 | Py_VISIT(sm->sm_callable); |
| 849 | return 0; |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 850 | } |
| 851 | |
| 852 | static int |
| 853 | sm_clear(staticmethod *sm) |
| 854 | { |
| 855 | Py_XDECREF(sm->sm_callable); |
| 856 | sm->sm_callable = NULL; |
| 857 | |
| 858 | return 0; |
| 859 | } |
| 860 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 861 | static PyObject * |
| 862 | sm_descr_get(PyObject *self, PyObject *obj, PyObject *type) |
| 863 | { |
| 864 | staticmethod *sm = (staticmethod *)self; |
| 865 | |
| 866 | if (sm->sm_callable == NULL) { |
| 867 | PyErr_SetString(PyExc_RuntimeError, |
| 868 | "uninitialized staticmethod object"); |
| 869 | return NULL; |
| 870 | } |
| 871 | Py_INCREF(sm->sm_callable); |
| 872 | return sm->sm_callable; |
| 873 | } |
| 874 | |
| 875 | static int |
| 876 | sm_init(PyObject *self, PyObject *args, PyObject *kwds) |
| 877 | { |
| 878 | staticmethod *sm = (staticmethod *)self; |
| 879 | PyObject *callable; |
| 880 | |
Raymond Hettinger | ea3fdf4 | 2002-12-29 16:33:45 +0000 | [diff] [blame] | 881 | if (!PyArg_UnpackTuple(args, "staticmethod", 1, 1, &callable)) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 882 | return -1; |
Georg Brandl | d02db40 | 2006-02-21 22:13:44 +0000 | [diff] [blame] | 883 | if (!_PyArg_NoKeywords("staticmethod", kwds)) |
| 884 | return -1; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 885 | Py_INCREF(callable); |
| 886 | sm->sm_callable = callable; |
| 887 | return 0; |
| 888 | } |
| 889 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 890 | PyDoc_STRVAR(staticmethod_doc, |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 891 | "staticmethod(function) -> method\n\ |
| 892 | \n\ |
| 893 | Convert a function to be a static method.\n\ |
| 894 | \n\ |
| 895 | A static method does not receive an implicit first argument.\n\ |
| 896 | To declare a static method, use this idiom:\n\ |
| 897 | \n\ |
| 898 | class C:\n\ |
| 899 | def f(arg1, arg2, ...): ...\n\ |
| 900 | f = staticmethod(f)\n\ |
| 901 | \n\ |
| 902 | It can be called either on the class (e.g. C.f()) or on an instance\n\ |
| 903 | (e.g. C().f()). The instance is ignored except for its class.\n\ |
| 904 | \n\ |
| 905 | Static methods in Python are similar to those found in Java or C++.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 906 | For a more advanced concept, see the classmethod builtin."); |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 907 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 908 | PyTypeObject PyStaticMethod_Type = { |
| 909 | PyObject_HEAD_INIT(&PyType_Type) |
| 910 | 0, |
| 911 | "staticmethod", |
| 912 | sizeof(staticmethod), |
| 913 | 0, |
| 914 | (destructor)sm_dealloc, /* tp_dealloc */ |
| 915 | 0, /* tp_print */ |
| 916 | 0, /* tp_getattr */ |
| 917 | 0, /* tp_setattr */ |
| 918 | 0, /* tp_compare */ |
| 919 | 0, /* tp_repr */ |
| 920 | 0, /* tp_as_number */ |
| 921 | 0, /* tp_as_sequence */ |
| 922 | 0, /* tp_as_mapping */ |
| 923 | 0, /* tp_hash */ |
| 924 | 0, /* tp_call */ |
| 925 | 0, /* tp_str */ |
| 926 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 927 | 0, /* tp_setattro */ |
| 928 | 0, /* tp_as_buffer */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 929 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
Guido van Rossum | 33c1a88 | 2001-12-17 02:53:53 +0000 | [diff] [blame] | 930 | staticmethod_doc, /* tp_doc */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 931 | (traverseproc)sm_traverse, /* tp_traverse */ |
| 932 | (inquiry)sm_clear, /* tp_clear */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 933 | 0, /* tp_richcompare */ |
| 934 | 0, /* tp_weaklistoffset */ |
| 935 | 0, /* tp_iter */ |
| 936 | 0, /* tp_iternext */ |
| 937 | 0, /* tp_methods */ |
| 938 | 0, /* tp_members */ |
| 939 | 0, /* tp_getset */ |
| 940 | 0, /* tp_base */ |
| 941 | 0, /* tp_dict */ |
| 942 | sm_descr_get, /* tp_descr_get */ |
| 943 | 0, /* tp_descr_set */ |
| 944 | 0, /* tp_dictoffset */ |
| 945 | sm_init, /* tp_init */ |
| 946 | PyType_GenericAlloc, /* tp_alloc */ |
| 947 | PyType_GenericNew, /* tp_new */ |
Jeremy Hylton | 400d8ee | 2003-04-08 21:28:47 +0000 | [diff] [blame] | 948 | PyObject_GC_Del, /* tp_free */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 949 | }; |
| 950 | |
| 951 | PyObject * |
| 952 | PyStaticMethod_New(PyObject *callable) |
| 953 | { |
| 954 | staticmethod *sm = (staticmethod *) |
| 955 | PyType_GenericAlloc(&PyStaticMethod_Type, 0); |
| 956 | if (sm != NULL) { |
| 957 | Py_INCREF(callable); |
| 958 | sm->sm_callable = callable; |
| 959 | } |
| 960 | return (PyObject *)sm; |
| 961 | } |