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