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