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