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" |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 5 | |
| 6 | typedef struct { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 7 | PyObject_HEAD |
| 8 | PyObject *md_dict; |
| 9 | } PyModuleObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 11 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 12 | PyModule_New(char *name) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 13 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 14 | PyModuleObject *m; |
| 15 | PyObject *nameobj; |
| 16 | m = PyObject_NEW(PyModuleObject, &PyModule_Type); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 17 | if (m == NULL) |
| 18 | return NULL; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 19 | nameobj = PyString_FromString(name); |
| 20 | m->md_dict = PyDict_New(); |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 21 | PyObject_GC_Init(m); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 22 | if (m->md_dict == NULL || nameobj == NULL) |
| 23 | goto fail; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 24 | if (PyDict_SetItemString(m->md_dict, "__name__", nameobj) != 0) |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 25 | goto fail; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 26 | if (PyDict_SetItemString(m->md_dict, "__doc__", Py_None) != 0) |
Guido van Rossum | 8b14b4c | 1995-01-07 11:59:29 +0000 | [diff] [blame] | 27 | goto fail; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 28 | Py_DECREF(nameobj); |
| 29 | return (PyObject *)m; |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 30 | |
| 31 | fail: |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 32 | Py_XDECREF(nameobj); |
| 33 | Py_DECREF(m); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 34 | return NULL; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 35 | } |
| 36 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 37 | PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 38 | PyModule_GetDict(PyObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 39 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 40 | if (!PyModule_Check(m)) { |
| 41 | PyErr_BadInternalCall(); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 42 | return NULL; |
| 43 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 44 | return ((PyModuleObject *)m) -> md_dict; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 45 | } |
| 46 | |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 47 | char * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 48 | PyModule_GetName(PyObject *m) |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 49 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 50 | PyObject *nameobj; |
| 51 | if (!PyModule_Check(m)) { |
| 52 | PyErr_BadArgument(); |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 53 | return NULL; |
| 54 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 55 | nameobj = PyDict_GetItemString(((PyModuleObject *)m)->md_dict, |
| 56 | "__name__"); |
| 57 | if (nameobj == NULL || !PyString_Check(nameobj)) { |
| 58 | PyErr_SetString(PyExc_SystemError, "nameless module"); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 59 | return NULL; |
| 60 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 61 | return PyString_AsString(nameobj); |
Guido van Rossum | 0558a20 | 1990-10-26 15:00:11 +0000 | [diff] [blame] | 62 | } |
| 63 | |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 64 | char * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 65 | PyModule_GetFilename(PyObject *m) |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 66 | { |
| 67 | PyObject *fileobj; |
| 68 | if (!PyModule_Check(m)) { |
| 69 | PyErr_BadArgument(); |
| 70 | return NULL; |
| 71 | } |
| 72 | fileobj = PyDict_GetItemString(((PyModuleObject *)m)->md_dict, |
| 73 | "__file__"); |
| 74 | if (fileobj == NULL || !PyString_Check(fileobj)) { |
| 75 | PyErr_SetString(PyExc_SystemError, "module filename missing"); |
| 76 | return NULL; |
| 77 | } |
| 78 | return PyString_AsString(fileobj); |
| 79 | } |
| 80 | |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 81 | void |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 82 | _PyModule_Clear(PyObject *m) |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 83 | { |
| 84 | /* To make the execution order of destructors for global |
| 85 | objects a bit more predictable, we first zap all objects |
| 86 | whose name starts with a single underscore, before we clear |
| 87 | the entire dictionary. We zap them by replacing them with |
| 88 | None, rather than deleting them from the dictionary, to |
| 89 | avoid rehashing the dictionary (to some extent). */ |
| 90 | |
| 91 | int pos; |
| 92 | PyObject *key, *value; |
| 93 | PyObject *d; |
| 94 | |
| 95 | d = ((PyModuleObject *)m)->md_dict; |
| 96 | |
| 97 | /* First, clear only names starting with a single underscore */ |
| 98 | pos = 0; |
| 99 | while (PyDict_Next(d, &pos, &key, &value)) { |
| 100 | if (value != Py_None && PyString_Check(key)) { |
| 101 | char *s = PyString_AsString(key); |
| 102 | if (s[0] == '_' && s[1] != '_') { |
| 103 | if (Py_VerboseFlag > 1) |
Guido van Rossum | 2f3667a | 1998-10-12 18:23:55 +0000 | [diff] [blame] | 104 | PySys_WriteStderr("# clear[1] %s\n", s); |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 105 | PyDict_SetItem(d, key, Py_None); |
| 106 | } |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | /* Next, clear all names except for __builtins__ */ |
| 111 | pos = 0; |
| 112 | while (PyDict_Next(d, &pos, &key, &value)) { |
| 113 | if (value != Py_None && PyString_Check(key)) { |
| 114 | char *s = PyString_AsString(key); |
| 115 | if (s[0] != '_' || strcmp(s, "__builtins__") != 0) { |
| 116 | if (Py_VerboseFlag > 1) |
Guido van Rossum | 2f3667a | 1998-10-12 18:23:55 +0000 | [diff] [blame] | 117 | PySys_WriteStderr("# clear[2] %s\n", s); |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 118 | PyDict_SetItem(d, key, Py_None); |
| 119 | } |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | /* Note: we leave __builtins__ in place, so that destructors |
| 124 | of non-global objects defined in this module can still use |
| 125 | builtins, in particularly 'None'. */ |
| 126 | |
| 127 | } |
| 128 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 129 | /* Methods */ |
| 130 | |
| 131 | static void |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 132 | module_dealloc(PyModuleObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 133 | { |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 134 | PyObject_GC_Fini(m); |
Guido van Rossum | 27e916f | 1995-01-26 00:39:00 +0000 | [diff] [blame] | 135 | if (m->md_dict != NULL) { |
Guido van Rossum | f1dc061 | 1998-02-19 20:51:52 +0000 | [diff] [blame] | 136 | _PyModule_Clear((PyObject *)m); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 137 | Py_DECREF(m->md_dict); |
Guido van Rossum | 27e916f | 1995-01-26 00:39:00 +0000 | [diff] [blame] | 138 | } |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 139 | PyObject_DEL(PyObject_AS_GC(m)); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 140 | } |
| 141 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 142 | static PyObject * |
Fred Drake | ee238b9 | 2000-07-09 06:03:25 +0000 | [diff] [blame] | 143 | module_repr(PyModuleObject *m) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 144 | { |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 145 | char buf[400]; |
| 146 | char *name; |
| 147 | char *filename; |
| 148 | name = PyModule_GetName((PyObject *)m); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 149 | if (name == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 150 | PyErr_Clear(); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 151 | name = "?"; |
| 152 | } |
Guido van Rossum | 98cc19f | 1999-02-15 14:47:16 +0000 | [diff] [blame] | 153 | filename = PyModule_GetFilename((PyObject *)m); |
| 154 | if (filename == NULL) { |
| 155 | PyErr_Clear(); |
| 156 | sprintf(buf, "<module '%.80s' (built-in)>", name); |
| 157 | } else { |
| 158 | sprintf(buf, "<module '%.80s' from '%.255s'>", name, filename); |
| 159 | } |
| 160 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 161 | return PyString_FromString(buf); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 162 | } |
| 163 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 164 | static PyObject * |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 165 | module_getattro(PyModuleObject *m, PyObject *name) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 166 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 167 | PyObject *res; |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 168 | char *sname = PyString_AsString(name); |
| 169 | |
| 170 | if (sname[0] == '_' && strcmp(sname, "__dict__") == 0) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 171 | Py_INCREF(m->md_dict); |
Guido van Rossum | e87203a | 1990-10-21 22:12:30 +0000 | [diff] [blame] | 172 | return m->md_dict; |
| 173 | } |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 174 | res = PyDict_GetItem(m->md_dict, name); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 175 | if (res == NULL) { |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 176 | char *modname = PyModule_GetName((PyObject *)m); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 177 | if (modname == NULL) { |
| 178 | PyErr_Clear(); |
| 179 | modname = "?"; |
| 180 | } |
| 181 | PyErr_Format(PyExc_AttributeError, |
| 182 | "'%.50s' module has no attribute '%.400s'", |
Tim Peters | 16cabc0 | 2001-05-12 20:24:22 +0000 | [diff] [blame] | 183 | modname, sname); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 184 | } |
Guido van Rossum | 0add15f | 1997-05-09 01:07:15 +0000 | [diff] [blame] | 185 | else |
| 186 | Py_INCREF(res); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 187 | return res; |
| 188 | } |
| 189 | |
| 190 | static int |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 191 | module_setattro(PyModuleObject *m, PyObject *name, PyObject *v) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 192 | { |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 193 | char *sname = PyString_AsString(name); |
| 194 | if (sname[0] == '_' && strcmp(sname, "__dict__") == 0) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 195 | PyErr_SetString(PyExc_TypeError, |
| 196 | "read-only special attribute"); |
Guido van Rossum | c45611d | 1993-11-17 22:58:56 +0000 | [diff] [blame] | 197 | return -1; |
Guido van Rossum | e87203a | 1990-10-21 22:12:30 +0000 | [diff] [blame] | 198 | } |
Guido van Rossum | 94472a0 | 1992-09-04 09:45:18 +0000 | [diff] [blame] | 199 | if (v == NULL) { |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 200 | int rv = PyDict_DelItem(m->md_dict, name); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 201 | if (rv < 0) { |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 202 | char *modname = PyModule_GetName((PyObject *)m); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 203 | if (modname == NULL) { |
| 204 | PyErr_Clear(); |
| 205 | modname = "?"; |
| 206 | } |
| 207 | PyErr_Format(PyExc_AttributeError, |
| 208 | "'%.50s' module has no attribute '%.400s'", |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 209 | modname, sname); |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 210 | } |
Guido van Rossum | 94472a0 | 1992-09-04 09:45:18 +0000 | [diff] [blame] | 211 | return rv; |
| 212 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 213 | else |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 214 | return PyDict_SetItem(m->md_dict, name, v); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 215 | } |
| 216 | |
Neil Schemenauer | 10e31cf | 2001-01-02 15:58:27 +0000 | [diff] [blame] | 217 | /* We only need a traverse function, no clear function: If the module |
| 218 | is in a cycle, md_dict will be cleared as well, which will break |
| 219 | the cycle. */ |
| 220 | static int |
| 221 | module_traverse(PyModuleObject *m, visitproc visit, void *arg) |
| 222 | { |
| 223 | if (m->md_dict != NULL) |
| 224 | return visit(m->md_dict, arg); |
| 225 | return 0; |
| 226 | } |
| 227 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 228 | PyTypeObject PyModule_Type = { |
| 229 | PyObject_HEAD_INIT(&PyType_Type) |
Tim Peters | d85e102 | 2001-05-11 21:51:48 +0000 | [diff] [blame] | 230 | 0, /* ob_size */ |
| 231 | "module", /* tp_name */ |
| 232 | sizeof(PyModuleObject) + PyGC_HEAD_SIZE,/* tp_size */ |
| 233 | 0, /* tp_itemsize */ |
| 234 | (destructor)module_dealloc, /* tp_dealloc */ |
| 235 | 0, /* tp_print */ |
| 236 | 0, /* tp_getattr */ |
| 237 | 0, /* tp_setattr */ |
| 238 | 0, /* tp_compare */ |
| 239 | (reprfunc)module_repr, /* tp_repr */ |
| 240 | 0, /* tp_as_number */ |
| 241 | 0, /* tp_as_sequence */ |
| 242 | 0, /* tp_as_mapping */ |
| 243 | 0, /* tp_hash */ |
| 244 | 0, /* tp_call */ |
| 245 | 0, /* tp_str */ |
| 246 | (getattrofunc)module_getattro, /* tp_getattro */ |
| 247 | (setattrofunc)module_setattro, /* tp_setattro */ |
| 248 | 0, /* tp_as_buffer */ |
| 249 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /* tp_flags */ |
| 250 | 0, /* tp_doc */ |
| 251 | (traverseproc)module_traverse, /* tp_traverse */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 252 | }; |