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 | /* Module object implementation */ |
| 3 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 4 | #include "Python.h" |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 5 | #include "structmember.h" |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 6 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 7 | static Py_ssize_t max_module_number; |
| 8 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 9 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 10 | PyObject_HEAD |
| 11 | PyObject *md_dict; |
| 12 | struct PyModuleDef *md_def; |
| 13 | void *md_state; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 14 | } PyModuleObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 15 | |
Neil Schemenauer | f23473f | 2001-10-21 22:28:58 +0000 | [diff] [blame] | 16 | static PyMemberDef module_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 17 | {"__dict__", T_OBJECT, offsetof(PyModuleObject, md_dict), READONLY}, |
| 18 | {0} |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 19 | }; |
| 20 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 21 | static PyTypeObject moduledef_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 22 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 23 | "moduledef", /* tp_name */ |
| 24 | sizeof(struct PyModuleDef), /* tp_size */ |
| 25 | 0, /* tp_itemsize */ |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 26 | }; |
| 27 | |
| 28 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 29 | PyObject * |
Victor Stinner | 0639b56 | 2011-03-04 12:57:07 +0000 | [diff] [blame] | 30 | PyModule_NewObject(PyObject *name) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 31 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 32 | PyModuleObject *m; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 33 | m = PyObject_GC_New(PyModuleObject, &PyModule_Type); |
| 34 | if (m == NULL) |
| 35 | return NULL; |
| 36 | m->md_def = NULL; |
| 37 | m->md_state = NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 38 | m->md_dict = PyDict_New(); |
Victor Stinner | 0639b56 | 2011-03-04 12:57:07 +0000 | [diff] [blame] | 39 | if (m->md_dict == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 40 | goto fail; |
Victor Stinner | 0639b56 | 2011-03-04 12:57:07 +0000 | [diff] [blame] | 41 | if (PyDict_SetItemString(m->md_dict, "__name__", name) != 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 42 | goto fail; |
| 43 | if (PyDict_SetItemString(m->md_dict, "__doc__", Py_None) != 0) |
| 44 | goto fail; |
| 45 | if (PyDict_SetItemString(m->md_dict, "__package__", Py_None) != 0) |
| 46 | goto fail; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 47 | PyObject_GC_Track(m); |
| 48 | return (PyObject *)m; |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 49 | |
| 50 | fail: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 51 | Py_DECREF(m); |
| 52 | return NULL; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 53 | } |
| 54 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 55 | PyObject * |
Victor Stinner | 0639b56 | 2011-03-04 12:57:07 +0000 | [diff] [blame] | 56 | PyModule_New(const char *name) |
| 57 | { |
| 58 | PyObject *nameobj, *module; |
| 59 | nameobj = PyUnicode_FromString(name); |
| 60 | if (nameobj == NULL) |
| 61 | return NULL; |
| 62 | module = PyModule_NewObject(nameobj); |
| 63 | Py_DECREF(nameobj); |
| 64 | return module; |
| 65 | } |
| 66 | |
| 67 | |
| 68 | PyObject * |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 69 | PyModule_Create2(struct PyModuleDef* module, int module_api_version) |
| 70 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 71 | PyObject *d, *v, *n; |
| 72 | PyMethodDef *ml; |
| 73 | const char* name; |
| 74 | PyModuleObject *m; |
R. David Murray | ce4b170 | 2010-12-14 23:06:25 +0000 | [diff] [blame] | 75 | PyInterpreterState *interp = PyThreadState_Get()->interp; |
| 76 | if (interp->modules == NULL) |
| 77 | Py_FatalError("Python import machinery not initialized"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 78 | if (PyType_Ready(&moduledef_type) < 0) |
| 79 | return NULL; |
| 80 | if (module->m_base.m_index == 0) { |
| 81 | max_module_number++; |
| 82 | Py_REFCNT(module) = 1; |
| 83 | Py_TYPE(module) = &moduledef_type; |
| 84 | module->m_base.m_index = max_module_number; |
| 85 | } |
| 86 | name = module->m_name; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 87 | if (module_api_version != PYTHON_API_VERSION && module_api_version != PYTHON_ABI_VERSION) { |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 88 | int err; |
| 89 | err = PyErr_WarnFormat(PyExc_RuntimeWarning, 1, |
| 90 | "Python C API version mismatch for module %.100s: " |
| 91 | "This Python has API version %d, module %.100s has version %d.", |
| 92 | name, |
| 93 | PYTHON_API_VERSION, name, module_api_version); |
| 94 | if (err) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 95 | return NULL; |
| 96 | } |
| 97 | /* Make sure name is fully qualified. |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 98 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 99 | This is a bit of a hack: when the shared library is loaded, |
| 100 | the module name is "package.module", but the module calls |
| 101 | PyModule_Create*() with just "module" for the name. The shared |
| 102 | library loader squirrels away the true name of the module in |
| 103 | _Py_PackageContext, and PyModule_Create*() will substitute this |
| 104 | (if the name actually matches). |
| 105 | */ |
| 106 | if (_Py_PackageContext != NULL) { |
| 107 | char *p = strrchr(_Py_PackageContext, '.'); |
| 108 | if (p != NULL && strcmp(module->m_name, p+1) == 0) { |
| 109 | name = _Py_PackageContext; |
| 110 | _Py_PackageContext = NULL; |
| 111 | } |
| 112 | } |
| 113 | if ((m = (PyModuleObject*)PyModule_New(name)) == NULL) |
| 114 | return NULL; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 115 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 116 | if (module->m_size > 0) { |
| 117 | m->md_state = PyMem_MALLOC(module->m_size); |
| 118 | if (!m->md_state) { |
| 119 | PyErr_NoMemory(); |
| 120 | Py_DECREF(m); |
| 121 | return NULL; |
| 122 | } |
| 123 | memset(m->md_state, 0, module->m_size); |
| 124 | } |
| 125 | |
| 126 | d = PyModule_GetDict((PyObject*)m); |
| 127 | if (module->m_methods != NULL) { |
| 128 | n = PyUnicode_FromString(name); |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 129 | if (n == NULL) { |
| 130 | Py_DECREF(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 131 | return NULL; |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 132 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 133 | for (ml = module->m_methods; ml->ml_name != NULL; ml++) { |
| 134 | if ((ml->ml_flags & METH_CLASS) || |
| 135 | (ml->ml_flags & METH_STATIC)) { |
| 136 | PyErr_SetString(PyExc_ValueError, |
| 137 | "module functions cannot set" |
| 138 | " METH_CLASS or METH_STATIC"); |
| 139 | Py_DECREF(n); |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 140 | Py_DECREF(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 141 | return NULL; |
| 142 | } |
| 143 | v = PyCFunction_NewEx(ml, (PyObject*)m, n); |
| 144 | if (v == NULL) { |
| 145 | Py_DECREF(n); |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 146 | Py_DECREF(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 147 | return NULL; |
| 148 | } |
| 149 | if (PyDict_SetItemString(d, ml->ml_name, v) != 0) { |
| 150 | Py_DECREF(v); |
| 151 | Py_DECREF(n); |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 152 | Py_DECREF(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 153 | return NULL; |
| 154 | } |
| 155 | Py_DECREF(v); |
| 156 | } |
| 157 | Py_DECREF(n); |
| 158 | } |
| 159 | if (module->m_doc != NULL) { |
| 160 | v = PyUnicode_FromString(module->m_doc); |
| 161 | if (v == NULL || PyDict_SetItemString(d, "__doc__", v) != 0) { |
| 162 | Py_XDECREF(v); |
Meador Inge | 29e49d6 | 2012-07-19 13:45:43 -0500 | [diff] [blame] | 163 | Py_DECREF(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 164 | return NULL; |
| 165 | } |
| 166 | Py_DECREF(v); |
| 167 | } |
| 168 | m->md_def = module; |
| 169 | return (PyObject*)m; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 173 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 174 | PyModule_GetDict(PyObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 175 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 176 | PyObject *d; |
| 177 | if (!PyModule_Check(m)) { |
| 178 | PyErr_BadInternalCall(); |
| 179 | return NULL; |
| 180 | } |
| 181 | d = ((PyModuleObject *)m) -> md_dict; |
| 182 | if (d == NULL) |
| 183 | ((PyModuleObject *)m) -> md_dict = d = PyDict_New(); |
| 184 | return d; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 185 | } |
| 186 | |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 187 | PyObject* |
| 188 | PyModule_GetNameObject(PyObject *m) |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 189 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 190 | PyObject *d; |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 191 | PyObject *name; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 192 | if (!PyModule_Check(m)) { |
| 193 | PyErr_BadArgument(); |
| 194 | return NULL; |
| 195 | } |
| 196 | d = ((PyModuleObject *)m)->md_dict; |
| 197 | if (d == NULL || |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 198 | (name = PyDict_GetItemString(d, "__name__")) == NULL || |
| 199 | !PyUnicode_Check(name)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 200 | { |
| 201 | PyErr_SetString(PyExc_SystemError, "nameless module"); |
| 202 | return NULL; |
| 203 | } |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 204 | Py_INCREF(name); |
| 205 | return name; |
| 206 | } |
| 207 | |
| 208 | const char * |
| 209 | PyModule_GetName(PyObject *m) |
| 210 | { |
| 211 | PyObject *name = PyModule_GetNameObject(m); |
| 212 | if (name == NULL) |
| 213 | return NULL; |
| 214 | Py_DECREF(name); /* module dict has still a reference */ |
| 215 | return _PyUnicode_AsString(name); |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 216 | } |
| 217 | |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 218 | PyObject* |
| 219 | PyModule_GetFilenameObject(PyObject *m) |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 220 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 221 | PyObject *d; |
| 222 | PyObject *fileobj; |
| 223 | if (!PyModule_Check(m)) { |
| 224 | PyErr_BadArgument(); |
| 225 | return NULL; |
| 226 | } |
| 227 | d = ((PyModuleObject *)m)->md_dict; |
| 228 | if (d == NULL || |
| 229 | (fileobj = PyDict_GetItemString(d, "__file__")) == NULL || |
| 230 | !PyUnicode_Check(fileobj)) |
| 231 | { |
| 232 | PyErr_SetString(PyExc_SystemError, "module filename missing"); |
| 233 | return NULL; |
| 234 | } |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 235 | Py_INCREF(fileobj); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 236 | return fileobj; |
Victor Stinner | 8124feb | 2010-05-07 00:50:12 +0000 | [diff] [blame] | 237 | } |
| 238 | |
| 239 | const char * |
| 240 | PyModule_GetFilename(PyObject *m) |
| 241 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 242 | PyObject *fileobj; |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 243 | char *utf8; |
| 244 | fileobj = PyModule_GetFilenameObject(m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 245 | if (fileobj == NULL) |
| 246 | return NULL; |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 247 | utf8 = _PyUnicode_AsString(fileobj); |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 248 | Py_DECREF(fileobj); /* module dict has still a reference */ |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 249 | return utf8; |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 250 | } |
| 251 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 252 | PyModuleDef* |
| 253 | PyModule_GetDef(PyObject* m) |
| 254 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 255 | if (!PyModule_Check(m)) { |
| 256 | PyErr_BadArgument(); |
| 257 | return NULL; |
| 258 | } |
| 259 | return ((PyModuleObject *)m)->md_def; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 260 | } |
| 261 | |
| 262 | void* |
| 263 | PyModule_GetState(PyObject* m) |
| 264 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 265 | if (!PyModule_Check(m)) { |
| 266 | PyErr_BadArgument(); |
| 267 | return NULL; |
| 268 | } |
| 269 | return ((PyModuleObject *)m)->md_state; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 270 | } |
| 271 | |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 272 | void |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 273 | _PyModule_Clear(PyObject *m) |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 274 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 275 | /* To make the execution order of destructors for global |
| 276 | objects a bit more predictable, we first zap all objects |
| 277 | whose name starts with a single underscore, before we clear |
| 278 | the entire dictionary. We zap them by replacing them with |
| 279 | None, rather than deleting them from the dictionary, to |
| 280 | avoid rehashing the dictionary (to some extent). */ |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 281 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 282 | Py_ssize_t pos; |
| 283 | PyObject *key, *value; |
| 284 | PyObject *d; |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 285 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 286 | d = ((PyModuleObject *)m)->md_dict; |
| 287 | if (d == NULL) |
| 288 | return; |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 289 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 290 | /* First, clear only names starting with a single underscore */ |
| 291 | pos = 0; |
| 292 | while (PyDict_Next(d, &pos, &key, &value)) { |
| 293 | if (value != Py_None && PyUnicode_Check(key)) { |
Brett Cannon | 62228db | 2012-04-29 14:38:11 -0400 | [diff] [blame] | 294 | if (PyUnicode_READ_CHAR(key, 0) == '_' && |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 295 | PyUnicode_READ_CHAR(key, 1) != '_') { |
Victor Stinner | f3f22a2 | 2010-05-19 00:03:09 +0000 | [diff] [blame] | 296 | if (Py_VerboseFlag > 1) { |
| 297 | const char *s = _PyUnicode_AsString(key); |
| 298 | if (s != NULL) |
| 299 | PySys_WriteStderr("# clear[1] %s\n", s); |
| 300 | else |
| 301 | PyErr_Clear(); |
| 302 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 303 | PyDict_SetItem(d, key, Py_None); |
| 304 | } |
| 305 | } |
| 306 | } |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 307 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 308 | /* Next, clear all names except for __builtins__ */ |
| 309 | pos = 0; |
| 310 | while (PyDict_Next(d, &pos, &key, &value)) { |
| 311 | if (value != Py_None && PyUnicode_Check(key)) { |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 312 | if (PyUnicode_READ_CHAR(key, 0) != '_' || |
| 313 | PyUnicode_CompareWithASCIIString(key, "__builtins__") != 0) |
Victor Stinner | f3f22a2 | 2010-05-19 00:03:09 +0000 | [diff] [blame] | 314 | { |
| 315 | if (Py_VerboseFlag > 1) { |
| 316 | const char *s = _PyUnicode_AsString(key); |
| 317 | if (s != NULL) |
| 318 | PySys_WriteStderr("# clear[2] %s\n", s); |
| 319 | else |
| 320 | PyErr_Clear(); |
| 321 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 322 | PyDict_SetItem(d, key, Py_None); |
| 323 | } |
| 324 | } |
| 325 | } |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 326 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 327 | /* Note: we leave __builtins__ in place, so that destructors |
| 328 | of non-global objects defined in this module can still use |
| 329 | builtins, in particularly 'None'. */ |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 330 | |
| 331 | } |
| 332 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 333 | /* Methods */ |
| 334 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 335 | static int |
Guido van Rossum | c3a787e | 2002-06-04 05:52:47 +0000 | [diff] [blame] | 336 | module_init(PyModuleObject *m, PyObject *args, PyObject *kwds) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 337 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 338 | static char *kwlist[] = {"name", "doc", NULL}; |
| 339 | PyObject *dict, *name = Py_None, *doc = Py_None; |
| 340 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "U|O:module.__init__", |
| 341 | kwlist, &name, &doc)) |
| 342 | return -1; |
| 343 | dict = m->md_dict; |
| 344 | if (dict == NULL) { |
| 345 | dict = PyDict_New(); |
| 346 | if (dict == NULL) |
| 347 | return -1; |
| 348 | m->md_dict = dict; |
| 349 | } |
| 350 | if (PyDict_SetItemString(dict, "__name__", name) < 0) |
| 351 | return -1; |
| 352 | if (PyDict_SetItemString(dict, "__doc__", doc) < 0) |
| 353 | return -1; |
| 354 | return 0; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 355 | } |
| 356 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 357 | static void |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 358 | module_dealloc(PyModuleObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 359 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 360 | PyObject_GC_UnTrack(m); |
| 361 | if (m->md_def && m->md_def->m_free) |
| 362 | m->md_def->m_free(m); |
| 363 | if (m->md_dict != NULL) { |
Benjamin Peterson | 5c4bfc4 | 2010-10-12 22:57:59 +0000 | [diff] [blame] | 364 | _PyModule_Clear((PyObject *)m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 365 | Py_DECREF(m->md_dict); |
| 366 | } |
| 367 | if (m->md_state != NULL) |
| 368 | PyMem_FREE(m->md_state); |
| 369 | Py_TYPE(m)->tp_free((PyObject *)m); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 370 | } |
| 371 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 372 | static PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 373 | module_repr(PyModuleObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 374 | { |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 375 | PyObject *name, *filename, *repr, *loader = NULL; |
Barry Warsaw | 2907fe6 | 2001-08-16 20:39:24 +0000 | [diff] [blame] | 376 | |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 377 | /* See if the module has an __loader__. If it does, give the loader the |
| 378 | * first shot at producing a repr for the module. |
| 379 | */ |
| 380 | if (m->md_dict != NULL) { |
| 381 | loader = PyDict_GetItemString(m->md_dict, "__loader__"); |
| 382 | } |
| 383 | if (loader != NULL) { |
| 384 | repr = PyObject_CallMethod(loader, "module_repr", "(O)", |
| 385 | (PyObject *)m, NULL); |
| 386 | if (repr == NULL) { |
| 387 | PyErr_Clear(); |
| 388 | } |
| 389 | else { |
| 390 | return repr; |
| 391 | } |
| 392 | } |
| 393 | /* __loader__.module_repr(m) did not provide us with a repr. Next, see if |
| 394 | * the module has an __file__. If it doesn't then use repr(__loader__) if |
| 395 | * it exists, otherwise, just use module.__name__. |
| 396 | */ |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 397 | name = PyModule_GetNameObject((PyObject *)m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 398 | if (name == NULL) { |
| 399 | PyErr_Clear(); |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 400 | name = PyUnicode_FromStringAndSize("?", 1); |
| 401 | if (name == NULL) |
| 402 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 403 | } |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 404 | filename = PyModule_GetFilenameObject((PyObject *)m); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 405 | if (filename == NULL) { |
| 406 | PyErr_Clear(); |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 407 | /* There's no m.__file__, so if there was an __loader__, use that in |
| 408 | * the repr, otherwise, the only thing you can use is m.__name__ |
| 409 | */ |
| 410 | if (loader == NULL) { |
| 411 | repr = PyUnicode_FromFormat("<module %R>", name); |
| 412 | } |
| 413 | else { |
| 414 | repr = PyUnicode_FromFormat("<module %R (%R)>", name, loader); |
| 415 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 416 | } |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 417 | /* Finally, use m.__file__ */ |
Victor Stinner | bd47511 | 2011-02-23 00:21:43 +0000 | [diff] [blame] | 418 | else { |
| 419 | repr = PyUnicode_FromFormat("<module %R from %R>", name, filename); |
| 420 | Py_DECREF(filename); |
| 421 | } |
| 422 | Py_DECREF(name); |
Victor Stinner | 6c00c14 | 2010-08-17 23:37:11 +0000 | [diff] [blame] | 423 | return repr; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 424 | } |
| 425 | |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 426 | static int |
| 427 | module_traverse(PyModuleObject *m, visitproc visit, void *arg) |
| 428 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 429 | if (m->md_def && m->md_def->m_traverse) { |
| 430 | int res = m->md_def->m_traverse((PyObject*)m, visit, arg); |
| 431 | if (res) |
| 432 | return res; |
| 433 | } |
| 434 | Py_VISIT(m->md_dict); |
| 435 | return 0; |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 436 | } |
| 437 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 438 | static int |
| 439 | module_clear(PyModuleObject *m) |
| 440 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 441 | if (m->md_def && m->md_def->m_clear) { |
| 442 | int res = m->md_def->m_clear((PyObject*)m); |
| 443 | if (res) |
| 444 | return res; |
| 445 | } |
| 446 | Py_CLEAR(m->md_dict); |
| 447 | return 0; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 448 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 449 | |
Benjamin Peterson | 82b00c1 | 2011-05-24 11:09:06 -0500 | [diff] [blame] | 450 | static PyObject * |
| 451 | module_dir(PyObject *self, PyObject *args) |
| 452 | { |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 453 | _Py_IDENTIFIER(__dict__); |
Benjamin Peterson | 82b00c1 | 2011-05-24 11:09:06 -0500 | [diff] [blame] | 454 | PyObject *result = NULL; |
Martin v. Löwis | 1ee1b6f | 2011-10-10 18:11:30 +0200 | [diff] [blame] | 455 | PyObject *dict = _PyObject_GetAttrId(self, &PyId___dict__); |
Benjamin Peterson | 82b00c1 | 2011-05-24 11:09:06 -0500 | [diff] [blame] | 456 | |
| 457 | if (dict != NULL) { |
| 458 | if (PyDict_Check(dict)) |
| 459 | result = PyDict_Keys(dict); |
| 460 | else { |
| 461 | const char *name = PyModule_GetName(self); |
| 462 | if (name) |
| 463 | PyErr_Format(PyExc_TypeError, |
| 464 | "%.200s.__dict__ is not a dictionary", |
| 465 | name); |
| 466 | } |
| 467 | } |
| 468 | |
| 469 | Py_XDECREF(dict); |
| 470 | return result; |
| 471 | } |
| 472 | |
| 473 | static PyMethodDef module_methods[] = { |
| 474 | {"__dir__", module_dir, METH_NOARGS, |
Benjamin Peterson | c728412 | 2011-05-24 12:46:15 -0500 | [diff] [blame] | 475 | PyDoc_STR("__dir__() -> list\nspecialized dir() implementation")}, |
Benjamin Peterson | 82b00c1 | 2011-05-24 11:09:06 -0500 | [diff] [blame] | 476 | {0} |
| 477 | }; |
| 478 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 479 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 480 | PyDoc_STRVAR(module_doc, |
Guido van Rossum | ed3e09f | 2002-06-04 06:02:35 +0000 | [diff] [blame] | 481 | "module(name[, doc])\n\ |
| 482 | \n\ |
| 483 | Create a module object.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 484 | The name must be a string; the optional doc argument can have any type."); |
Guido van Rossum | ed3e09f | 2002-06-04 06:02:35 +0000 | [diff] [blame] | 485 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 486 | PyTypeObject PyModule_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 487 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 488 | "module", /* tp_name */ |
| 489 | sizeof(PyModuleObject), /* tp_size */ |
| 490 | 0, /* tp_itemsize */ |
| 491 | (destructor)module_dealloc, /* tp_dealloc */ |
| 492 | 0, /* tp_print */ |
| 493 | 0, /* tp_getattr */ |
| 494 | 0, /* tp_setattr */ |
| 495 | 0, /* tp_reserved */ |
| 496 | (reprfunc)module_repr, /* tp_repr */ |
| 497 | 0, /* tp_as_number */ |
| 498 | 0, /* tp_as_sequence */ |
| 499 | 0, /* tp_as_mapping */ |
| 500 | 0, /* tp_hash */ |
| 501 | 0, /* tp_call */ |
| 502 | 0, /* tp_str */ |
| 503 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 504 | PyObject_GenericSetAttr, /* tp_setattro */ |
| 505 | 0, /* tp_as_buffer */ |
| 506 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | |
| 507 | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
| 508 | module_doc, /* tp_doc */ |
| 509 | (traverseproc)module_traverse, /* tp_traverse */ |
| 510 | (inquiry)module_clear, /* tp_clear */ |
| 511 | 0, /* tp_richcompare */ |
| 512 | 0, /* tp_weaklistoffset */ |
| 513 | 0, /* tp_iter */ |
| 514 | 0, /* tp_iternext */ |
Benjamin Peterson | 82b00c1 | 2011-05-24 11:09:06 -0500 | [diff] [blame] | 515 | module_methods, /* tp_methods */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 516 | module_members, /* tp_members */ |
| 517 | 0, /* tp_getset */ |
| 518 | 0, /* tp_base */ |
| 519 | 0, /* tp_dict */ |
| 520 | 0, /* tp_descr_get */ |
| 521 | 0, /* tp_descr_set */ |
| 522 | offsetof(PyModuleObject, md_dict), /* tp_dictoffset */ |
| 523 | (initproc)module_init, /* tp_init */ |
| 524 | PyType_GenericAlloc, /* tp_alloc */ |
| 525 | PyType_GenericNew, /* tp_new */ |
| 526 | PyObject_GC_Del, /* tp_free */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 527 | }; |