Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1 | #include "Python.h" |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 2 | #include "internal/pystate.h" |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 3 | #include "frameobject.h" |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 4 | #include "clinic/_warnings.c.h" |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 5 | |
| 6 | #define MODULE_NAME "_warnings" |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 7 | |
| 8 | PyDoc_STRVAR(warnings__doc__, |
| 9 | MODULE_NAME " provides basic warning filtering support.\n" |
| 10 | "It is a helper module to speed up interpreter start-up."); |
| 11 | |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 12 | _Py_IDENTIFIER(argv); |
| 13 | _Py_IDENTIFIER(stderr); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 14 | |
| 15 | static int |
| 16 | check_matched(PyObject *obj, PyObject *arg) |
| 17 | { |
| 18 | PyObject *result; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 19 | _Py_IDENTIFIER(match); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 20 | int rc; |
| 21 | |
| 22 | if (obj == Py_None) |
| 23 | return 1; |
Victor Stinner | 55ba38a | 2016-12-09 16:09:30 +0100 | [diff] [blame] | 24 | result = _PyObject_CallMethodIdObjArgs(obj, &PyId_match, arg, NULL); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 25 | if (result == NULL) |
| 26 | return -1; |
| 27 | |
| 28 | rc = PyObject_IsTrue(result); |
| 29 | Py_DECREF(result); |
| 30 | return rc; |
| 31 | } |
| 32 | |
| 33 | /* |
| 34 | Returns a new reference. |
| 35 | A NULL return value can mean false or an error. |
| 36 | */ |
| 37 | static PyObject * |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 38 | get_warnings_attr(const char *attr, int try_import) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 39 | { |
| 40 | static PyObject *warnings_str = NULL; |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 41 | PyObject *warnings_module, *obj; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 42 | |
| 43 | if (warnings_str == NULL) { |
| 44 | warnings_str = PyUnicode_InternFromString("warnings"); |
| 45 | if (warnings_str == NULL) |
| 46 | return NULL; |
| 47 | } |
| 48 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 49 | /* don't try to import after the start of the Python finallization */ |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 50 | if (try_import && !_Py_IsFinalizing()) { |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 51 | warnings_module = PyImport_Import(warnings_str); |
| 52 | if (warnings_module == NULL) { |
| 53 | /* Fallback to the C implementation if we cannot get |
| 54 | the Python implementation */ |
| 55 | PyErr_Clear(); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 56 | return NULL; |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 57 | } |
| 58 | } |
| 59 | else { |
Eric Snow | 3f9eee6 | 2017-09-15 16:35:20 -0600 | [diff] [blame] | 60 | warnings_module = PyImport_GetModule(warnings_str); |
Victor Stinner | 023654f | 2016-03-23 17:48:22 +0100 | [diff] [blame] | 61 | if (warnings_module == NULL) |
| 62 | return NULL; |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | if (!PyObject_HasAttrString(warnings_module, attr)) { |
| 66 | Py_DECREF(warnings_module); |
| 67 | return NULL; |
| 68 | } |
| 69 | |
| 70 | obj = PyObject_GetAttrString(warnings_module, attr); |
| 71 | Py_DECREF(warnings_module); |
| 72 | return obj; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 73 | } |
| 74 | |
| 75 | |
Neal Norwitz | 32dde22 | 2008-04-15 06:43:13 +0000 | [diff] [blame] | 76 | static PyObject * |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 77 | get_once_registry(void) |
| 78 | { |
| 79 | PyObject *registry; |
| 80 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 81 | registry = get_warnings_attr("onceregistry", 0); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 82 | if (registry == NULL) { |
| 83 | if (PyErr_Occurred()) |
| 84 | return NULL; |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 85 | return _PyRuntime.warnings.once_registry; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 86 | } |
Oren Milman | 252033d | 2017-09-11 09:28:39 +0300 | [diff] [blame] | 87 | if (!PyDict_Check(registry)) { |
| 88 | PyErr_SetString(PyExc_TypeError, |
| 89 | "warnings.onceregistry must be a dict"); |
| 90 | Py_DECREF(registry); |
| 91 | return NULL; |
| 92 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 93 | Py_DECREF(_PyRuntime.warnings.once_registry); |
| 94 | _PyRuntime.warnings.once_registry = registry; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 95 | return registry; |
| 96 | } |
| 97 | |
| 98 | |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 99 | static PyObject * |
| 100 | get_default_action(void) |
| 101 | { |
| 102 | PyObject *default_action; |
| 103 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 104 | default_action = get_warnings_attr("defaultaction", 0); |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 105 | if (default_action == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 106 | if (PyErr_Occurred()) { |
| 107 | return NULL; |
| 108 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 109 | return _PyRuntime.warnings.default_action; |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 110 | } |
Oren Milman | 9d984fd | 2017-09-12 00:18:09 +0300 | [diff] [blame] | 111 | if (!PyUnicode_Check(default_action)) { |
| 112 | PyErr_Format(PyExc_TypeError, |
| 113 | MODULE_NAME ".defaultaction must be a string, " |
| 114 | "not '%.200s'", |
| 115 | Py_TYPE(default_action)->tp_name); |
| 116 | Py_DECREF(default_action); |
| 117 | return NULL; |
| 118 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 119 | Py_DECREF(_PyRuntime.warnings.default_action); |
| 120 | _PyRuntime.warnings.default_action = default_action; |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 121 | return default_action; |
| 122 | } |
| 123 | |
| 124 | |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 125 | /* The item is a new reference. */ |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 126 | static PyObject* |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 127 | get_filter(PyObject *category, PyObject *text, Py_ssize_t lineno, |
| 128 | PyObject *module, PyObject **item) |
| 129 | { |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 130 | PyObject *action; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 131 | Py_ssize_t i; |
| 132 | PyObject *warnings_filters; |
| 133 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 134 | warnings_filters = get_warnings_attr("filters", 0); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 135 | if (warnings_filters == NULL) { |
| 136 | if (PyErr_Occurred()) |
| 137 | return NULL; |
| 138 | } |
| 139 | else { |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 140 | Py_DECREF(_PyRuntime.warnings.filters); |
| 141 | _PyRuntime.warnings.filters = warnings_filters; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 142 | } |
| 143 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 144 | PyObject *filters = _PyRuntime.warnings.filters; |
| 145 | if (filters == NULL || !PyList_Check(filters)) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 146 | PyErr_SetString(PyExc_ValueError, |
| 147 | MODULE_NAME ".filters must be a list"); |
| 148 | return NULL; |
| 149 | } |
| 150 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 151 | /* _PyRuntime.warnings.filters could change while we are iterating over it. */ |
| 152 | for (i = 0; i < PyList_GET_SIZE(filters); i++) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 153 | PyObject *tmp_item, *action, *msg, *cat, *mod, *ln_obj; |
| 154 | Py_ssize_t ln; |
| 155 | int is_subclass, good_msg, good_mod; |
| 156 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 157 | tmp_item = PyList_GET_ITEM(filters, i); |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 158 | if (!PyTuple_Check(tmp_item) || PyTuple_GET_SIZE(tmp_item) != 5) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 159 | PyErr_Format(PyExc_ValueError, |
| 160 | MODULE_NAME ".filters item %zd isn't a 5-tuple", i); |
| 161 | return NULL; |
| 162 | } |
| 163 | |
| 164 | /* Python code: action, msg, cat, mod, ln = item */ |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 165 | Py_INCREF(tmp_item); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 166 | action = PyTuple_GET_ITEM(tmp_item, 0); |
| 167 | msg = PyTuple_GET_ITEM(tmp_item, 1); |
| 168 | cat = PyTuple_GET_ITEM(tmp_item, 2); |
| 169 | mod = PyTuple_GET_ITEM(tmp_item, 3); |
| 170 | ln_obj = PyTuple_GET_ITEM(tmp_item, 4); |
| 171 | |
Oren Milman | 9d984fd | 2017-09-12 00:18:09 +0300 | [diff] [blame] | 172 | if (!PyUnicode_Check(action)) { |
| 173 | PyErr_Format(PyExc_TypeError, |
| 174 | "action must be a string, not '%.200s'", |
| 175 | Py_TYPE(action)->tp_name); |
| 176 | Py_DECREF(tmp_item); |
| 177 | return NULL; |
| 178 | } |
| 179 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 180 | good_msg = check_matched(msg, text); |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 181 | if (good_msg == -1) { |
| 182 | Py_DECREF(tmp_item); |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 183 | return NULL; |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 184 | } |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 185 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 186 | good_mod = check_matched(mod, module); |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 187 | if (good_mod == -1) { |
| 188 | Py_DECREF(tmp_item); |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 189 | return NULL; |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 190 | } |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 191 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 192 | is_subclass = PyObject_IsSubclass(category, cat); |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 193 | if (is_subclass == -1) { |
| 194 | Py_DECREF(tmp_item); |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 195 | return NULL; |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 196 | } |
Victor Stinner | 3cd04aa | 2013-10-31 14:46:00 +0100 | [diff] [blame] | 197 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 198 | ln = PyLong_AsSsize_t(ln_obj); |
Benjamin Peterson | 8c59816 | 2015-05-03 11:28:46 -0400 | [diff] [blame] | 199 | if (ln == -1 && PyErr_Occurred()) { |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 200 | Py_DECREF(tmp_item); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 201 | return NULL; |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 202 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 203 | |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 204 | if (good_msg && is_subclass && good_mod && (ln == 0 || lineno == ln)) { |
| 205 | *item = tmp_item; |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 206 | return action; |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | Py_DECREF(tmp_item); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 210 | } |
| 211 | |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 212 | action = get_default_action(); |
| 213 | if (action != NULL) { |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 214 | Py_INCREF(Py_None); |
| 215 | *item = Py_None; |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 216 | return action; |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 217 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 218 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 219 | return NULL; |
| 220 | } |
| 221 | |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 222 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 223 | static int |
| 224 | already_warned(PyObject *registry, PyObject *key, int should_set) |
| 225 | { |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 226 | PyObject *version_obj, *already_warned; |
| 227 | _Py_IDENTIFIER(version); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 228 | |
| 229 | if (key == NULL) |
| 230 | return -1; |
| 231 | |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 232 | version_obj = _PyDict_GetItemId(registry, &PyId_version); |
| 233 | if (version_obj == NULL |
| 234 | || !PyLong_CheckExact(version_obj) |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 235 | || PyLong_AsLong(version_obj) != _PyRuntime.warnings.filters_version) { |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 236 | PyDict_Clear(registry); |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 237 | version_obj = PyLong_FromLong(_PyRuntime.warnings.filters_version); |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 238 | if (version_obj == NULL) |
| 239 | return -1; |
| 240 | if (_PyDict_SetItemId(registry, &PyId_version, version_obj) < 0) { |
| 241 | Py_DECREF(version_obj); |
| 242 | return -1; |
| 243 | } |
| 244 | Py_DECREF(version_obj); |
| 245 | } |
| 246 | else { |
| 247 | already_warned = PyDict_GetItem(registry, key); |
| 248 | if (already_warned != NULL) { |
| 249 | int rc = PyObject_IsTrue(already_warned); |
| 250 | if (rc != 0) |
| 251 | return rc; |
| 252 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | /* This warning wasn't found in the registry, set it. */ |
| 256 | if (should_set) |
| 257 | return PyDict_SetItem(registry, key, Py_True); |
| 258 | return 0; |
| 259 | } |
| 260 | |
| 261 | /* New reference. */ |
| 262 | static PyObject * |
| 263 | normalize_module(PyObject *filename) |
| 264 | { |
| 265 | PyObject *module; |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 266 | int kind; |
| 267 | void *data; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 268 | Py_ssize_t len; |
| 269 | |
Victor Stinner | 9e30aa5 | 2011-11-21 02:49:52 +0100 | [diff] [blame] | 270 | len = PyUnicode_GetLength(filename); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 271 | if (len < 0) |
| 272 | return NULL; |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 273 | |
| 274 | if (len == 0) |
| 275 | return PyUnicode_FromString("<unknown>"); |
| 276 | |
| 277 | kind = PyUnicode_KIND(filename); |
| 278 | data = PyUnicode_DATA(filename); |
| 279 | |
| 280 | /* if filename.endswith(".py"): */ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 281 | if (len >= 3 && |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 282 | PyUnicode_READ(kind, data, len-3) == '.' && |
| 283 | PyUnicode_READ(kind, data, len-2) == 'p' && |
| 284 | PyUnicode_READ(kind, data, len-1) == 'y') |
| 285 | { |
Victor Stinner | 9e30aa5 | 2011-11-21 02:49:52 +0100 | [diff] [blame] | 286 | module = PyUnicode_Substring(filename, 0, len-3); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 287 | } |
| 288 | else { |
| 289 | module = filename; |
| 290 | Py_INCREF(module); |
| 291 | } |
| 292 | return module; |
| 293 | } |
| 294 | |
| 295 | static int |
| 296 | update_registry(PyObject *registry, PyObject *text, PyObject *category, |
| 297 | int add_zero) |
| 298 | { |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 299 | PyObject *altkey; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 300 | int rc; |
| 301 | |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 302 | if (add_zero) |
| 303 | altkey = PyTuple_Pack(3, text, category, _PyLong_Zero); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 304 | else |
| 305 | altkey = PyTuple_Pack(2, text, category); |
| 306 | |
| 307 | rc = already_warned(registry, altkey, 1); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 308 | Py_XDECREF(altkey); |
| 309 | return rc; |
| 310 | } |
| 311 | |
| 312 | static void |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 313 | show_warning(PyObject *filename, int lineno, PyObject *text, |
| 314 | PyObject *category, PyObject *sourceline) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 315 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 316 | PyObject *f_stderr; |
| 317 | PyObject *name; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 318 | char lineno_str[128]; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 319 | _Py_IDENTIFIER(__name__); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 320 | |
| 321 | PyOS_snprintf(lineno_str, sizeof(lineno_str), ":%d: ", lineno); |
| 322 | |
Martin v. Löwis | 1ee1b6f | 2011-10-10 18:11:30 +0200 | [diff] [blame] | 323 | name = _PyObject_GetAttrId(category, &PyId___name__); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 324 | if (name == NULL) /* XXX Can an object lack a '__name__' attribute? */ |
Victor Stinner | ae233ea | 2013-10-31 14:51:38 +0100 | [diff] [blame] | 325 | goto error; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 326 | |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 327 | f_stderr = _PySys_GetObjectId(&PyId_stderr); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 328 | if (f_stderr == NULL) { |
| 329 | fprintf(stderr, "lost sys.stderr\n"); |
Victor Stinner | ae233ea | 2013-10-31 14:51:38 +0100 | [diff] [blame] | 330 | goto error; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 331 | } |
| 332 | |
| 333 | /* Print "filename:lineno: category: text\n" */ |
Victor Stinner | ae233ea | 2013-10-31 14:51:38 +0100 | [diff] [blame] | 334 | if (PyFile_WriteObject(filename, f_stderr, Py_PRINT_RAW) < 0) |
| 335 | goto error; |
| 336 | if (PyFile_WriteString(lineno_str, f_stderr) < 0) |
| 337 | goto error; |
| 338 | if (PyFile_WriteObject(name, f_stderr, Py_PRINT_RAW) < 0) |
| 339 | goto error; |
| 340 | if (PyFile_WriteString(": ", f_stderr) < 0) |
| 341 | goto error; |
| 342 | if (PyFile_WriteObject(text, f_stderr, Py_PRINT_RAW) < 0) |
| 343 | goto error; |
| 344 | if (PyFile_WriteString("\n", f_stderr) < 0) |
| 345 | goto error; |
| 346 | Py_CLEAR(name); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 347 | |
| 348 | /* Print " source_line\n" */ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 349 | if (sourceline) { |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 350 | int kind; |
| 351 | void *data; |
| 352 | Py_ssize_t i, len; |
| 353 | Py_UCS4 ch; |
| 354 | PyObject *truncated; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 355 | |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 356 | if (PyUnicode_READY(sourceline) < 1) |
| 357 | goto error; |
| 358 | |
| 359 | kind = PyUnicode_KIND(sourceline); |
| 360 | data = PyUnicode_DATA(sourceline); |
| 361 | len = PyUnicode_GET_LENGTH(sourceline); |
| 362 | for (i=0; i<len; i++) { |
| 363 | ch = PyUnicode_READ(kind, data, i); |
| 364 | if (ch != ' ' && ch != '\t' && ch != '\014') |
| 365 | break; |
| 366 | } |
| 367 | |
| 368 | truncated = PyUnicode_Substring(sourceline, i, len); |
| 369 | if (truncated == NULL) |
| 370 | goto error; |
| 371 | |
| 372 | PyFile_WriteObject(sourceline, f_stderr, Py_PRINT_RAW); |
| 373 | Py_DECREF(truncated); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 374 | PyFile_WriteString("\n", f_stderr); |
| 375 | } |
Victor Stinner | 78e2c98 | 2013-07-16 01:54:37 +0200 | [diff] [blame] | 376 | else { |
| 377 | _Py_DisplaySourceLine(f_stderr, filename, lineno, 2); |
| 378 | } |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 379 | |
| 380 | error: |
Victor Stinner | ae233ea | 2013-10-31 14:51:38 +0100 | [diff] [blame] | 381 | Py_XDECREF(name); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 382 | PyErr_Clear(); |
| 383 | } |
| 384 | |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 385 | static int |
| 386 | call_show_warning(PyObject *category, PyObject *text, PyObject *message, |
| 387 | PyObject *filename, int lineno, PyObject *lineno_obj, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 388 | PyObject *sourceline, PyObject *source) |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 389 | { |
| 390 | PyObject *show_fn, *msg, *res, *warnmsg_cls = NULL; |
| 391 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 392 | /* If the source parameter is set, try to get the Python implementation. |
| 393 | The Python implementation is able to log the traceback where the source |
| 394 | was allocated, whereas the C implementation doesnt. */ |
| 395 | show_fn = get_warnings_attr("_showwarnmsg", source != NULL); |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 396 | if (show_fn == NULL) { |
| 397 | if (PyErr_Occurred()) |
| 398 | return -1; |
| 399 | show_warning(filename, lineno, text, category, sourceline); |
| 400 | return 0; |
| 401 | } |
| 402 | |
| 403 | if (!PyCallable_Check(show_fn)) { |
| 404 | PyErr_SetString(PyExc_TypeError, |
| 405 | "warnings._showwarnmsg() must be set to a callable"); |
| 406 | goto error; |
| 407 | } |
| 408 | |
Victor Stinner | e98445a | 2016-03-23 00:54:48 +0100 | [diff] [blame] | 409 | warnmsg_cls = get_warnings_attr("WarningMessage", 0); |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 410 | if (warnmsg_cls == NULL) { |
| 411 | PyErr_SetString(PyExc_RuntimeError, |
| 412 | "unable to get warnings.WarningMessage"); |
| 413 | goto error; |
| 414 | } |
| 415 | |
| 416 | msg = PyObject_CallFunctionObjArgs(warnmsg_cls, message, category, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 417 | filename, lineno_obj, Py_None, Py_None, source, |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 418 | NULL); |
| 419 | Py_DECREF(warnmsg_cls); |
| 420 | if (msg == NULL) |
| 421 | goto error; |
| 422 | |
Victor Stinner | de4ae3d | 2016-12-04 22:59:09 +0100 | [diff] [blame] | 423 | res = PyObject_CallFunctionObjArgs(show_fn, msg, NULL); |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 424 | Py_DECREF(show_fn); |
| 425 | Py_DECREF(msg); |
| 426 | |
| 427 | if (res == NULL) |
| 428 | return -1; |
| 429 | |
| 430 | Py_DECREF(res); |
| 431 | return 0; |
| 432 | |
| 433 | error: |
| 434 | Py_XDECREF(show_fn); |
| 435 | return -1; |
| 436 | } |
| 437 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 438 | static PyObject * |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 439 | warn_explicit(PyObject *category, PyObject *message, |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 440 | PyObject *filename, int lineno, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 441 | PyObject *module, PyObject *registry, PyObject *sourceline, |
| 442 | PyObject *source) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 443 | { |
| 444 | PyObject *key = NULL, *text = NULL, *result = NULL, *lineno_obj = NULL; |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 445 | PyObject *item = NULL; |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 446 | PyObject *action; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 447 | int rc; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 448 | |
Victor Stinner | dcdd05b | 2013-11-01 00:55:30 +0100 | [diff] [blame] | 449 | /* module can be None if a warning is emitted late during Python shutdown. |
| 450 | In this case, the Python warnings module was probably unloaded, filters |
| 451 | are no more available to choose as action. It is safer to ignore the |
| 452 | warning and do nothing. */ |
| 453 | if (module == Py_None) |
| 454 | Py_RETURN_NONE; |
| 455 | |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 456 | if (registry && !PyDict_Check(registry) && (registry != Py_None)) { |
Oren Milman | 252033d | 2017-09-11 09:28:39 +0300 | [diff] [blame] | 457 | PyErr_SetString(PyExc_TypeError, "'registry' must be a dict or None"); |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 458 | return NULL; |
| 459 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 460 | |
| 461 | /* Normalize module. */ |
| 462 | if (module == NULL) { |
| 463 | module = normalize_module(filename); |
| 464 | if (module == NULL) |
| 465 | return NULL; |
| 466 | } |
| 467 | else |
| 468 | Py_INCREF(module); |
| 469 | |
| 470 | /* Normalize message. */ |
| 471 | Py_INCREF(message); /* DECREF'ed in cleanup. */ |
| 472 | rc = PyObject_IsInstance(message, PyExc_Warning); |
| 473 | if (rc == -1) { |
| 474 | goto cleanup; |
| 475 | } |
| 476 | if (rc == 1) { |
| 477 | text = PyObject_Str(message); |
Hirokazu Yamamoto | 1c0c003 | 2009-07-17 06:55:42 +0000 | [diff] [blame] | 478 | if (text == NULL) |
| 479 | goto cleanup; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 480 | category = (PyObject*)message->ob_type; |
| 481 | } |
| 482 | else { |
| 483 | text = message; |
Victor Stinner | 7bfb42d | 2016-12-05 17:04:32 +0100 | [diff] [blame] | 484 | message = PyObject_CallFunctionObjArgs(category, message, NULL); |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 485 | if (message == NULL) |
| 486 | goto cleanup; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 487 | } |
| 488 | |
| 489 | lineno_obj = PyLong_FromLong(lineno); |
| 490 | if (lineno_obj == NULL) |
| 491 | goto cleanup; |
| 492 | |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 493 | if (source == Py_None) { |
| 494 | source = NULL; |
| 495 | } |
| 496 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 497 | /* Create key. */ |
| 498 | key = PyTuple_Pack(3, text, category, lineno_obj); |
| 499 | if (key == NULL) |
| 500 | goto cleanup; |
| 501 | |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 502 | if ((registry != NULL) && (registry != Py_None)) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 503 | rc = already_warned(registry, key, 0); |
| 504 | if (rc == -1) |
| 505 | goto cleanup; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 506 | else if (rc == 1) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 507 | goto return_none; |
| 508 | /* Else this warning hasn't been generated before. */ |
| 509 | } |
| 510 | |
| 511 | action = get_filter(category, text, lineno, module, &item); |
| 512 | if (action == NULL) |
| 513 | goto cleanup; |
| 514 | |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 515 | if (_PyUnicode_EqualToASCIIString(action, "error")) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 516 | PyErr_SetObject(category, message); |
| 517 | goto cleanup; |
| 518 | } |
| 519 | |
| 520 | /* Store in the registry that we've been here, *except* when the action |
| 521 | is "always". */ |
| 522 | rc = 0; |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 523 | if (!_PyUnicode_EqualToASCIIString(action, "always")) { |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 524 | if (registry != NULL && registry != Py_None && |
| 525 | PyDict_SetItem(registry, key, Py_True) < 0) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 526 | goto cleanup; |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 527 | else if (_PyUnicode_EqualToASCIIString(action, "ignore")) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 528 | goto return_none; |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 529 | else if (_PyUnicode_EqualToASCIIString(action, "once")) { |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 530 | if (registry == NULL || registry == Py_None) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 531 | registry = get_once_registry(); |
| 532 | if (registry == NULL) |
| 533 | goto cleanup; |
| 534 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 535 | /* _PyRuntime.warnings.once_registry[(text, category)] = 1 */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 536 | rc = update_registry(registry, text, category, 0); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 537 | } |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 538 | else if (_PyUnicode_EqualToASCIIString(action, "module")) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 539 | /* registry[(text, category, 0)] = 1 */ |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 540 | if (registry != NULL && registry != Py_None) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 541 | rc = update_registry(registry, text, category, 0); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 542 | } |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 543 | else if (!_PyUnicode_EqualToASCIIString(action, "default")) { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 544 | PyErr_Format(PyExc_RuntimeError, |
Victor Stinner | a4c704b | 2013-10-29 23:43:41 +0100 | [diff] [blame] | 545 | "Unrecognized action (%R) in warnings.filters:\n %R", |
| 546 | action, item); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 547 | goto cleanup; |
| 548 | } |
| 549 | } |
| 550 | |
Christian Heimes | 1a8501c | 2008-10-02 19:56:01 +0000 | [diff] [blame] | 551 | if (rc == 1) /* Already warned for this module. */ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 552 | goto return_none; |
| 553 | if (rc == 0) { |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 554 | if (call_show_warning(category, text, message, filename, lineno, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 555 | lineno_obj, sourceline, source) < 0) |
Victor Stinner | 1231a46 | 2016-03-19 00:47:17 +0100 | [diff] [blame] | 556 | goto cleanup; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 557 | } |
| 558 | else /* if (rc == -1) */ |
| 559 | goto cleanup; |
| 560 | |
| 561 | return_none: |
| 562 | result = Py_None; |
| 563 | Py_INCREF(result); |
| 564 | |
| 565 | cleanup: |
Benjamin Peterson | deff2b7 | 2015-05-03 11:23:37 -0400 | [diff] [blame] | 566 | Py_XDECREF(item); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 567 | Py_XDECREF(key); |
| 568 | Py_XDECREF(text); |
| 569 | Py_XDECREF(lineno_obj); |
| 570 | Py_DECREF(module); |
Brett Cannon | db73491 | 2008-06-27 00:52:15 +0000 | [diff] [blame] | 571 | Py_XDECREF(message); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 572 | return result; /* Py_None or NULL. */ |
| 573 | } |
| 574 | |
Larry Hastings | 714e493 | 2015-09-06 00:39:37 -0700 | [diff] [blame] | 575 | static int |
| 576 | is_internal_frame(PyFrameObject *frame) |
| 577 | { |
| 578 | static PyObject *importlib_string = NULL; |
| 579 | static PyObject *bootstrap_string = NULL; |
| 580 | PyObject *filename; |
| 581 | int contains; |
| 582 | |
| 583 | if (importlib_string == NULL) { |
| 584 | importlib_string = PyUnicode_FromString("importlib"); |
| 585 | if (importlib_string == NULL) { |
| 586 | return 0; |
| 587 | } |
| 588 | |
| 589 | bootstrap_string = PyUnicode_FromString("_bootstrap"); |
| 590 | if (bootstrap_string == NULL) { |
| 591 | Py_DECREF(importlib_string); |
| 592 | return 0; |
| 593 | } |
| 594 | Py_INCREF(importlib_string); |
| 595 | Py_INCREF(bootstrap_string); |
| 596 | } |
| 597 | |
| 598 | if (frame == NULL || frame->f_code == NULL || |
| 599 | frame->f_code->co_filename == NULL) { |
| 600 | return 0; |
| 601 | } |
| 602 | filename = frame->f_code->co_filename; |
| 603 | if (!PyUnicode_Check(filename)) { |
| 604 | return 0; |
| 605 | } |
| 606 | contains = PyUnicode_Contains(filename, importlib_string); |
| 607 | if (contains < 0) { |
| 608 | return 0; |
| 609 | } |
| 610 | else if (contains > 0) { |
| 611 | contains = PyUnicode_Contains(filename, bootstrap_string); |
| 612 | if (contains < 0) { |
| 613 | return 0; |
| 614 | } |
| 615 | else if (contains > 0) { |
| 616 | return 1; |
| 617 | } |
| 618 | } |
| 619 | |
| 620 | return 0; |
| 621 | } |
| 622 | |
| 623 | static PyFrameObject * |
| 624 | next_external_frame(PyFrameObject *frame) |
| 625 | { |
| 626 | do { |
| 627 | frame = frame->f_back; |
| 628 | } while (frame != NULL && is_internal_frame(frame)); |
| 629 | |
| 630 | return frame; |
| 631 | } |
| 632 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 633 | /* filename, module, and registry are new refs, globals is borrowed */ |
| 634 | /* Returns 0 on error (no new refs), 1 on success */ |
| 635 | static int |
| 636 | setup_context(Py_ssize_t stack_level, PyObject **filename, int *lineno, |
| 637 | PyObject **module, PyObject **registry) |
| 638 | { |
| 639 | PyObject *globals; |
| 640 | |
| 641 | /* Setup globals and lineno. */ |
| 642 | PyFrameObject *f = PyThreadState_GET()->frame; |
Larry Hastings | 714e493 | 2015-09-06 00:39:37 -0700 | [diff] [blame] | 643 | // Stack level comparisons to Python code is off by one as there is no |
| 644 | // warnings-related stack level to avoid. |
| 645 | if (stack_level <= 0 || is_internal_frame(f)) { |
| 646 | while (--stack_level > 0 && f != NULL) { |
| 647 | f = f->f_back; |
| 648 | } |
| 649 | } |
| 650 | else { |
| 651 | while (--stack_level > 0 && f != NULL) { |
| 652 | f = next_external_frame(f); |
| 653 | } |
| 654 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 655 | |
| 656 | if (f == NULL) { |
| 657 | globals = PyThreadState_Get()->interp->sysdict; |
| 658 | *lineno = 1; |
| 659 | } |
| 660 | else { |
| 661 | globals = f->f_globals; |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 662 | *lineno = PyFrame_GetLineNumber(f); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 663 | } |
| 664 | |
| 665 | *module = NULL; |
| 666 | |
| 667 | /* Setup registry. */ |
| 668 | assert(globals != NULL); |
| 669 | assert(PyDict_Check(globals)); |
| 670 | *registry = PyDict_GetItemString(globals, "__warningregistry__"); |
| 671 | if (*registry == NULL) { |
| 672 | int rc; |
| 673 | |
| 674 | *registry = PyDict_New(); |
| 675 | if (*registry == NULL) |
| 676 | return 0; |
| 677 | |
| 678 | rc = PyDict_SetItemString(globals, "__warningregistry__", *registry); |
| 679 | if (rc < 0) |
| 680 | goto handle_error; |
| 681 | } |
| 682 | else |
| 683 | Py_INCREF(*registry); |
| 684 | |
| 685 | /* Setup module. */ |
| 686 | *module = PyDict_GetItemString(globals, "__name__"); |
| 687 | if (*module == NULL) { |
| 688 | *module = PyUnicode_FromString("<string>"); |
| 689 | if (*module == NULL) |
| 690 | goto handle_error; |
| 691 | } |
| 692 | else |
| 693 | Py_INCREF(*module); |
| 694 | |
| 695 | /* Setup filename. */ |
| 696 | *filename = PyDict_GetItemString(globals, "__file__"); |
Victor Stinner | 8b0508e | 2011-07-04 02:43:09 +0200 | [diff] [blame] | 697 | if (*filename != NULL && PyUnicode_Check(*filename)) { |
Victor Stinner | b62a7b2 | 2011-10-06 02:34:51 +0200 | [diff] [blame] | 698 | Py_ssize_t len; |
| 699 | int kind; |
| 700 | void *data; |
| 701 | |
| 702 | if (PyUnicode_READY(*filename)) |
| 703 | goto handle_error; |
| 704 | |
Victor Stinner | 9e30aa5 | 2011-11-21 02:49:52 +0100 | [diff] [blame] | 705 | len = PyUnicode_GetLength(*filename); |
Victor Stinner | b62a7b2 | 2011-10-06 02:34:51 +0200 | [diff] [blame] | 706 | kind = PyUnicode_KIND(*filename); |
| 707 | data = PyUnicode_DATA(*filename); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 708 | |
Benjamin Peterson | 21e0da2 | 2012-01-11 21:00:42 -0500 | [diff] [blame] | 709 | #define ascii_lower(c) ((c <= 127) ? Py_TOLOWER(c) : 0) |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 710 | /* if filename.lower().endswith(".pyc"): */ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 711 | if (len >= 4 && |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 712 | PyUnicode_READ(kind, data, len-4) == '.' && |
Benjamin Peterson | 21e0da2 | 2012-01-11 21:00:42 -0500 | [diff] [blame] | 713 | ascii_lower(PyUnicode_READ(kind, data, len-3)) == 'p' && |
| 714 | ascii_lower(PyUnicode_READ(kind, data, len-2)) == 'y' && |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 715 | ascii_lower(PyUnicode_READ(kind, data, len-1)) == 'c') |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 716 | { |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 717 | *filename = PyUnicode_Substring(*filename, 0, |
| 718 | PyUnicode_GET_LENGTH(*filename)-1); |
Victor Stinner | 2e5f117 | 2010-08-08 22:12:45 +0000 | [diff] [blame] | 719 | if (*filename == NULL) |
| 720 | goto handle_error; |
| 721 | } |
| 722 | else |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 723 | Py_INCREF(*filename); |
| 724 | } |
| 725 | else { |
Benjamin Peterson | bb4a747 | 2011-07-04 22:27:16 -0500 | [diff] [blame] | 726 | *filename = NULL; |
Serhiy Storchaka | f4934ea | 2016-11-16 10:17:58 +0200 | [diff] [blame] | 727 | if (*module != Py_None && _PyUnicode_EqualToASCIIString(*module, "__main__")) { |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 728 | PyObject *argv = _PySys_GetObjectId(&PyId_argv); |
Victor Stinner | ce5f4fb | 2013-10-28 18:47:22 +0100 | [diff] [blame] | 729 | /* PyList_Check() is needed because sys.argv is set to None during |
| 730 | Python finalization */ |
| 731 | if (argv != NULL && PyList_Check(argv) && PyList_Size(argv) > 0) { |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 732 | int is_true; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 733 | *filename = PyList_GetItem(argv, 0); |
| 734 | Py_INCREF(*filename); |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 735 | /* If sys.argv[0] is false, then use '__main__'. */ |
| 736 | is_true = PyObject_IsTrue(*filename); |
| 737 | if (is_true < 0) { |
| 738 | Py_DECREF(*filename); |
| 739 | goto handle_error; |
| 740 | } |
| 741 | else if (!is_true) { |
Serhiy Storchaka | 57a01d3 | 2016-04-10 18:05:40 +0300 | [diff] [blame] | 742 | Py_SETREF(*filename, PyUnicode_FromString("__main__")); |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 743 | if (*filename == NULL) |
| 744 | goto handle_error; |
| 745 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 746 | } |
| 747 | else { |
| 748 | /* embedded interpreters don't have sys.argv, see bug #839151 */ |
| 749 | *filename = PyUnicode_FromString("__main__"); |
Victor Stinner | 856f45f | 2013-10-30 00:04:59 +0100 | [diff] [blame] | 750 | if (*filename == NULL) |
| 751 | goto handle_error; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 752 | } |
| 753 | } |
| 754 | if (*filename == NULL) { |
| 755 | *filename = *module; |
| 756 | Py_INCREF(*filename); |
| 757 | } |
| 758 | } |
| 759 | |
| 760 | return 1; |
| 761 | |
| 762 | handle_error: |
| 763 | /* filename not XDECREF'ed here as there is no way to jump here with a |
| 764 | dangling reference. */ |
| 765 | Py_XDECREF(*registry); |
| 766 | Py_XDECREF(*module); |
| 767 | return 0; |
| 768 | } |
| 769 | |
| 770 | static PyObject * |
| 771 | get_category(PyObject *message, PyObject *category) |
| 772 | { |
| 773 | int rc; |
| 774 | |
| 775 | /* Get category. */ |
| 776 | rc = PyObject_IsInstance(message, PyExc_Warning); |
| 777 | if (rc == -1) |
| 778 | return NULL; |
| 779 | |
| 780 | if (rc == 1) |
| 781 | category = (PyObject*)message->ob_type; |
Berker Peksag | d8089e0 | 2014-07-11 19:50:25 +0300 | [diff] [blame] | 782 | else if (category == NULL || category == Py_None) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 783 | category = PyExc_UserWarning; |
| 784 | |
| 785 | /* Validate category. */ |
| 786 | rc = PyObject_IsSubclass(category, PyExc_Warning); |
Berker Peksag | d8089e0 | 2014-07-11 19:50:25 +0300 | [diff] [blame] | 787 | /* category is not a subclass of PyExc_Warning or |
| 788 | PyObject_IsSubclass raised an error */ |
| 789 | if (rc == -1 || rc == 0) { |
| 790 | PyErr_Format(PyExc_TypeError, |
| 791 | "category must be a Warning subclass, not '%s'", |
| 792 | Py_TYPE(category)->tp_name); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 793 | return NULL; |
| 794 | } |
| 795 | |
| 796 | return category; |
| 797 | } |
| 798 | |
| 799 | static PyObject * |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 800 | do_warn(PyObject *message, PyObject *category, Py_ssize_t stack_level, |
| 801 | PyObject *source) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 802 | { |
| 803 | PyObject *filename, *module, *registry, *res; |
| 804 | int lineno; |
| 805 | |
| 806 | if (!setup_context(stack_level, &filename, &lineno, &module, ®istry)) |
| 807 | return NULL; |
| 808 | |
Victor Stinner | dcdd05b | 2013-11-01 00:55:30 +0100 | [diff] [blame] | 809 | res = warn_explicit(category, message, filename, lineno, module, registry, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 810 | NULL, source); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 811 | Py_DECREF(filename); |
| 812 | Py_DECREF(registry); |
| 813 | Py_DECREF(module); |
| 814 | return res; |
| 815 | } |
| 816 | |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 817 | /*[clinic input] |
| 818 | warn as warnings_warn |
| 819 | |
| 820 | message: object |
| 821 | category: object = None |
| 822 | stacklevel: Py_ssize_t = 1 |
| 823 | source: object = None |
| 824 | |
| 825 | Issue a warning, or maybe ignore it or raise an exception. |
| 826 | [clinic start generated code]*/ |
| 827 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 828 | static PyObject * |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 829 | warnings_warn_impl(PyObject *module, PyObject *message, PyObject *category, |
| 830 | Py_ssize_t stacklevel, PyObject *source) |
| 831 | /*[clinic end generated code: output=31ed5ab7d8d760b2 input=bfdf5cf99f6c4edd]*/ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 832 | { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 833 | category = get_category(message, category); |
| 834 | if (category == NULL) |
| 835 | return NULL; |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 836 | return do_warn(message, category, stacklevel, source); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 837 | } |
| 838 | |
| 839 | static PyObject * |
| 840 | warnings_warn_explicit(PyObject *self, PyObject *args, PyObject *kwds) |
| 841 | { |
| 842 | static char *kwd_list[] = {"message", "category", "filename", "lineno", |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 843 | "module", "registry", "module_globals", |
| 844 | "source", 0}; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 845 | PyObject *message; |
| 846 | PyObject *category; |
| 847 | PyObject *filename; |
| 848 | int lineno; |
| 849 | PyObject *module = NULL; |
| 850 | PyObject *registry = NULL; |
| 851 | PyObject *module_globals = NULL; |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 852 | PyObject *sourceobj = NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 853 | |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 854 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOUi|OOOO:warn_explicit", |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 855 | kwd_list, &message, &category, &filename, &lineno, &module, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 856 | ®istry, &module_globals, &sourceobj)) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 857 | return NULL; |
| 858 | |
| 859 | if (module_globals) { |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 860 | _Py_IDENTIFIER(get_source); |
| 861 | _Py_IDENTIFIER(splitlines); |
| 862 | PyObject *tmp; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 863 | PyObject *loader; |
| 864 | PyObject *module_name; |
| 865 | PyObject *source; |
| 866 | PyObject *source_list; |
| 867 | PyObject *source_line; |
| 868 | PyObject *returned; |
| 869 | |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 870 | if ((tmp = _PyUnicode_FromId(&PyId_get_source)) == NULL) |
| 871 | return NULL; |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 872 | if ((tmp = _PyUnicode_FromId(&PyId_splitlines)) == NULL) |
| 873 | return NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 874 | |
| 875 | /* Check/get the requisite pieces needed for the loader. */ |
| 876 | loader = PyDict_GetItemString(module_globals, "__loader__"); |
| 877 | module_name = PyDict_GetItemString(module_globals, "__name__"); |
| 878 | |
| 879 | if (loader == NULL || module_name == NULL) |
| 880 | goto standard_call; |
| 881 | |
| 882 | /* Make sure the loader implements the optional get_source() method. */ |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 883 | if (!_PyObject_HasAttrId(loader, &PyId_get_source)) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 884 | goto standard_call; |
| 885 | /* Call get_source() to get the source code. */ |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 886 | source = PyObject_CallMethodObjArgs(loader, PyId_get_source.object, |
| 887 | module_name, NULL); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 888 | if (!source) |
| 889 | return NULL; |
| 890 | else if (source == Py_None) { |
| 891 | Py_DECREF(Py_None); |
| 892 | goto standard_call; |
| 893 | } |
| 894 | |
| 895 | /* Split the source into lines. */ |
Victor Stinner | 9e30aa5 | 2011-11-21 02:49:52 +0100 | [diff] [blame] | 896 | source_list = PyObject_CallMethodObjArgs(source, |
Martin v. Löwis | 1c67dd9 | 2011-10-14 15:16:45 +0200 | [diff] [blame] | 897 | PyId_splitlines.object, |
| 898 | NULL); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 899 | Py_DECREF(source); |
| 900 | if (!source_list) |
| 901 | return NULL; |
| 902 | |
| 903 | /* Get the source line. */ |
| 904 | source_line = PyList_GetItem(source_list, lineno-1); |
| 905 | if (!source_line) { |
| 906 | Py_DECREF(source_list); |
| 907 | return NULL; |
| 908 | } |
| 909 | |
| 910 | /* Handle the warning. */ |
| 911 | returned = warn_explicit(category, message, filename, lineno, module, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 912 | registry, source_line, sourceobj); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 913 | Py_DECREF(source_list); |
| 914 | return returned; |
| 915 | } |
| 916 | |
| 917 | standard_call: |
| 918 | return warn_explicit(category, message, filename, lineno, module, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 919 | registry, NULL, sourceobj); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 920 | } |
| 921 | |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 922 | static PyObject * |
| 923 | warnings_filters_mutated(PyObject *self, PyObject *args) |
| 924 | { |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 925 | _PyRuntime.warnings.filters_version++; |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 926 | Py_RETURN_NONE; |
| 927 | } |
| 928 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 929 | |
| 930 | /* Function to issue a warning message; may raise an exception. */ |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 931 | |
| 932 | static int |
| 933 | warn_unicode(PyObject *category, PyObject *message, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 934 | Py_ssize_t stack_level, PyObject *source) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 935 | { |
| 936 | PyObject *res; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 937 | |
| 938 | if (category == NULL) |
| 939 | category = PyExc_RuntimeWarning; |
| 940 | |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 941 | res = do_warn(message, category, stack_level, source); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 942 | if (res == NULL) |
| 943 | return -1; |
| 944 | Py_DECREF(res); |
| 945 | |
| 946 | return 0; |
| 947 | } |
| 948 | |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 949 | static int |
| 950 | _PyErr_WarnFormatV(PyObject *source, |
| 951 | PyObject *category, Py_ssize_t stack_level, |
| 952 | const char *format, va_list vargs) |
| 953 | { |
| 954 | PyObject *message; |
| 955 | int res; |
| 956 | |
| 957 | message = PyUnicode_FromFormatV(format, vargs); |
| 958 | if (message == NULL) |
| 959 | return -1; |
| 960 | |
| 961 | res = warn_unicode(category, message, stack_level, source); |
| 962 | Py_DECREF(message); |
| 963 | return res; |
| 964 | } |
| 965 | |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 966 | int |
| 967 | PyErr_WarnFormat(PyObject *category, Py_ssize_t stack_level, |
| 968 | const char *format, ...) |
| 969 | { |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 970 | int res; |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 971 | va_list vargs; |
| 972 | |
| 973 | #ifdef HAVE_STDARG_PROTOTYPES |
| 974 | va_start(vargs, format); |
| 975 | #else |
| 976 | va_start(vargs); |
| 977 | #endif |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 978 | res = _PyErr_WarnFormatV(NULL, category, stack_level, format, vargs); |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 979 | va_end(vargs); |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 980 | return res; |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 981 | } |
| 982 | |
| 983 | int |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 984 | PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, |
| 985 | const char *format, ...) |
| 986 | { |
| 987 | int res; |
| 988 | va_list vargs; |
| 989 | |
| 990 | #ifdef HAVE_STDARG_PROTOTYPES |
| 991 | va_start(vargs, format); |
| 992 | #else |
| 993 | va_start(vargs); |
| 994 | #endif |
| 995 | res = _PyErr_WarnFormatV(source, PyExc_ResourceWarning, |
| 996 | stack_level, format, vargs); |
| 997 | va_end(vargs); |
| 998 | return res; |
| 999 | } |
| 1000 | |
| 1001 | |
| 1002 | int |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 1003 | PyErr_WarnEx(PyObject *category, const char *text, Py_ssize_t stack_level) |
| 1004 | { |
| 1005 | int ret; |
| 1006 | PyObject *message = PyUnicode_FromString(text); |
| 1007 | if (message == NULL) |
| 1008 | return -1; |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 1009 | ret = warn_unicode(category, message, stack_level, NULL); |
Victor Stinner | 4a2b7a1 | 2010-08-13 14:03:48 +0000 | [diff] [blame] | 1010 | Py_DECREF(message); |
| 1011 | return ret; |
| 1012 | } |
| 1013 | |
Ezio Melotti | 42da663 | 2011-03-15 05:18:48 +0200 | [diff] [blame] | 1014 | /* PyErr_Warn is only for backwards compatibility and will be removed. |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1015 | Use PyErr_WarnEx instead. */ |
| 1016 | |
| 1017 | #undef PyErr_Warn |
| 1018 | |
| 1019 | PyAPI_FUNC(int) |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 1020 | PyErr_Warn(PyObject *category, const char *text) |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1021 | { |
| 1022 | return PyErr_WarnEx(category, text, 1); |
| 1023 | } |
| 1024 | |
| 1025 | /* Warning with explicit origin */ |
| 1026 | int |
Victor Stinner | 14e461d | 2013-08-26 22:28:21 +0200 | [diff] [blame] | 1027 | PyErr_WarnExplicitObject(PyObject *category, PyObject *message, |
| 1028 | PyObject *filename, int lineno, |
| 1029 | PyObject *module, PyObject *registry) |
| 1030 | { |
| 1031 | PyObject *res; |
| 1032 | if (category == NULL) |
| 1033 | category = PyExc_RuntimeWarning; |
| 1034 | res = warn_explicit(category, message, filename, lineno, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 1035 | module, registry, NULL, NULL); |
Victor Stinner | 14e461d | 2013-08-26 22:28:21 +0200 | [diff] [blame] | 1036 | if (res == NULL) |
| 1037 | return -1; |
| 1038 | Py_DECREF(res); |
| 1039 | return 0; |
| 1040 | } |
| 1041 | |
| 1042 | int |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1043 | PyErr_WarnExplicit(PyObject *category, const char *text, |
| 1044 | const char *filename_str, int lineno, |
| 1045 | const char *module_str, PyObject *registry) |
| 1046 | { |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1047 | PyObject *message = PyUnicode_FromString(text); |
Victor Stinner | cb428f0 | 2010-12-27 20:10:36 +0000 | [diff] [blame] | 1048 | PyObject *filename = PyUnicode_DecodeFSDefault(filename_str); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1049 | PyObject *module = NULL; |
| 1050 | int ret = -1; |
| 1051 | |
| 1052 | if (message == NULL || filename == NULL) |
| 1053 | goto exit; |
| 1054 | if (module_str != NULL) { |
| 1055 | module = PyUnicode_FromString(module_str); |
Antoine Pitrou | 070cb3c | 2013-05-08 13:23:25 +0200 | [diff] [blame] | 1056 | if (module == NULL) |
| 1057 | goto exit; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1058 | } |
| 1059 | |
Victor Stinner | 14e461d | 2013-08-26 22:28:21 +0200 | [diff] [blame] | 1060 | ret = PyErr_WarnExplicitObject(category, message, filename, lineno, |
| 1061 | module, registry); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1062 | |
| 1063 | exit: |
| 1064 | Py_XDECREF(message); |
| 1065 | Py_XDECREF(module); |
| 1066 | Py_XDECREF(filename); |
| 1067 | return ret; |
| 1068 | } |
| 1069 | |
Antoine Pitrou | 070cb3c | 2013-05-08 13:23:25 +0200 | [diff] [blame] | 1070 | int |
| 1071 | PyErr_WarnExplicitFormat(PyObject *category, |
| 1072 | const char *filename_str, int lineno, |
| 1073 | const char *module_str, PyObject *registry, |
| 1074 | const char *format, ...) |
| 1075 | { |
| 1076 | PyObject *message; |
| 1077 | PyObject *module = NULL; |
| 1078 | PyObject *filename = PyUnicode_DecodeFSDefault(filename_str); |
| 1079 | int ret = -1; |
| 1080 | va_list vargs; |
| 1081 | |
| 1082 | if (filename == NULL) |
| 1083 | goto exit; |
| 1084 | if (module_str != NULL) { |
| 1085 | module = PyUnicode_FromString(module_str); |
| 1086 | if (module == NULL) |
| 1087 | goto exit; |
| 1088 | } |
| 1089 | |
| 1090 | #ifdef HAVE_STDARG_PROTOTYPES |
| 1091 | va_start(vargs, format); |
| 1092 | #else |
| 1093 | va_start(vargs); |
| 1094 | #endif |
| 1095 | message = PyUnicode_FromFormatV(format, vargs); |
| 1096 | if (message != NULL) { |
| 1097 | PyObject *res; |
| 1098 | res = warn_explicit(category, message, filename, lineno, |
Victor Stinner | 914cde8 | 2016-03-19 01:03:51 +0100 | [diff] [blame] | 1099 | module, registry, NULL, NULL); |
Antoine Pitrou | 070cb3c | 2013-05-08 13:23:25 +0200 | [diff] [blame] | 1100 | Py_DECREF(message); |
| 1101 | if (res != NULL) { |
| 1102 | Py_DECREF(res); |
| 1103 | ret = 0; |
| 1104 | } |
| 1105 | } |
| 1106 | va_end(vargs); |
| 1107 | exit: |
| 1108 | Py_XDECREF(module); |
| 1109 | Py_XDECREF(filename); |
| 1110 | return ret; |
| 1111 | } |
| 1112 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1113 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1114 | PyDoc_STRVAR(warn_explicit_doc, |
| 1115 | "Low-level inferface to warnings functionality."); |
| 1116 | |
| 1117 | static PyMethodDef warnings_functions[] = { |
Victor Stinner | 22f1875 | 2016-12-09 18:08:18 +0100 | [diff] [blame] | 1118 | WARNINGS_WARN_METHODDEF |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1119 | {"warn_explicit", (PyCFunction)warnings_warn_explicit, |
| 1120 | METH_VARARGS | METH_KEYWORDS, warn_explicit_doc}, |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 1121 | {"_filters_mutated", (PyCFunction)warnings_filters_mutated, METH_NOARGS, |
| 1122 | NULL}, |
Christian Heimes | 1a8501c | 2008-10-02 19:56:01 +0000 | [diff] [blame] | 1123 | /* XXX(brett.cannon): add showwarning? */ |
| 1124 | /* XXX(brett.cannon): Reasonable to add formatwarning? */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1125 | {NULL, NULL} /* sentinel */ |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1126 | }; |
| 1127 | |
| 1128 | |
| 1129 | static PyObject * |
| 1130 | create_filter(PyObject *category, const char *action) |
| 1131 | { |
| 1132 | static PyObject *ignore_str = NULL; |
| 1133 | static PyObject *error_str = NULL; |
| 1134 | static PyObject *default_str = NULL; |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 1135 | static PyObject *always_str = NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1136 | PyObject *action_obj = NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1137 | |
| 1138 | if (!strcmp(action, "ignore")) { |
| 1139 | if (ignore_str == NULL) { |
| 1140 | ignore_str = PyUnicode_InternFromString("ignore"); |
| 1141 | if (ignore_str == NULL) |
| 1142 | return NULL; |
| 1143 | } |
| 1144 | action_obj = ignore_str; |
| 1145 | } |
| 1146 | else if (!strcmp(action, "error")) { |
| 1147 | if (error_str == NULL) { |
| 1148 | error_str = PyUnicode_InternFromString("error"); |
| 1149 | if (error_str == NULL) |
| 1150 | return NULL; |
| 1151 | } |
| 1152 | action_obj = error_str; |
| 1153 | } |
| 1154 | else if (!strcmp(action, "default")) { |
| 1155 | if (default_str == NULL) { |
| 1156 | default_str = PyUnicode_InternFromString("default"); |
| 1157 | if (default_str == NULL) |
| 1158 | return NULL; |
| 1159 | } |
| 1160 | action_obj = default_str; |
| 1161 | } |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 1162 | else if (!strcmp(action, "always")) { |
| 1163 | if (always_str == NULL) { |
| 1164 | always_str = PyUnicode_InternFromString("always"); |
| 1165 | if (always_str == NULL) |
| 1166 | return NULL; |
| 1167 | } |
| 1168 | action_obj = always_str; |
| 1169 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1170 | else { |
| 1171 | Py_FatalError("unknown action"); |
| 1172 | } |
| 1173 | |
| 1174 | /* This assumes the line number is zero for now. */ |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1175 | return PyTuple_Pack(5, action_obj, Py_None, |
| 1176 | category, Py_None, _PyLong_Zero); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1177 | } |
| 1178 | |
| 1179 | static PyObject * |
| 1180 | init_filters(void) |
| 1181 | { |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 1182 | PyObject *filters = PyList_New(5); |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1183 | unsigned int pos = 0; /* Post-incremented in each use. */ |
| 1184 | unsigned int x; |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 1185 | const char *bytes_action, *resource_action; |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1186 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1187 | if (filters == NULL) |
| 1188 | return NULL; |
| 1189 | |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1190 | PyList_SET_ITEM(filters, pos++, |
| 1191 | create_filter(PyExc_DeprecationWarning, "ignore")); |
| 1192 | PyList_SET_ITEM(filters, pos++, |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1193 | create_filter(PyExc_PendingDeprecationWarning, "ignore")); |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1194 | PyList_SET_ITEM(filters, pos++, |
| 1195 | create_filter(PyExc_ImportWarning, "ignore")); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1196 | if (Py_BytesWarningFlag > 1) |
| 1197 | bytes_action = "error"; |
| 1198 | else if (Py_BytesWarningFlag) |
| 1199 | bytes_action = "default"; |
| 1200 | else |
| 1201 | bytes_action = "ignore"; |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1202 | PyList_SET_ITEM(filters, pos++, create_filter(PyExc_BytesWarning, |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1203 | bytes_action)); |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 1204 | /* resource usage warnings are enabled by default in pydebug mode */ |
| 1205 | #ifdef Py_DEBUG |
| 1206 | resource_action = "always"; |
| 1207 | #else |
| 1208 | resource_action = "ignore"; |
| 1209 | #endif |
| 1210 | PyList_SET_ITEM(filters, pos++, create_filter(PyExc_ResourceWarning, |
| 1211 | resource_action)); |
Benjamin Peterson | 7ab4b8d | 2010-06-28 00:01:59 +0000 | [diff] [blame] | 1212 | for (x = 0; x < pos; x += 1) { |
| 1213 | if (PyList_GET_ITEM(filters, x) == NULL) { |
| 1214 | Py_DECREF(filters); |
| 1215 | return NULL; |
| 1216 | } |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1217 | } |
| 1218 | |
| 1219 | return filters; |
| 1220 | } |
| 1221 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1222 | static struct PyModuleDef warningsmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1223 | PyModuleDef_HEAD_INIT, |
| 1224 | MODULE_NAME, |
| 1225 | warnings__doc__, |
| 1226 | 0, |
| 1227 | warnings_functions, |
| 1228 | NULL, |
| 1229 | NULL, |
| 1230 | NULL, |
| 1231 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1232 | }; |
| 1233 | |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1234 | |
| 1235 | PyMODINIT_FUNC |
| 1236 | _PyWarnings_Init(void) |
| 1237 | { |
Brett Cannon | 0759dd6 | 2009-04-01 18:13:07 +0000 | [diff] [blame] | 1238 | PyObject *m; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1239 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1240 | m = PyModule_Create(&warningsmodule); |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1241 | if (m == NULL) |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1242 | return NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1243 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1244 | if (_PyRuntime.warnings.filters == NULL) { |
| 1245 | _PyRuntime.warnings.filters = init_filters(); |
| 1246 | if (_PyRuntime.warnings.filters == NULL) |
Antoine Pitrou | aa5c5c6 | 2012-01-18 21:45:15 +0100 | [diff] [blame] | 1247 | return NULL; |
| 1248 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1249 | Py_INCREF(_PyRuntime.warnings.filters); |
| 1250 | if (PyModule_AddObject(m, "filters", _PyRuntime.warnings.filters) < 0) |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1251 | return NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1252 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1253 | if (_PyRuntime.warnings.once_registry == NULL) { |
| 1254 | _PyRuntime.warnings.once_registry = PyDict_New(); |
| 1255 | if (_PyRuntime.warnings.once_registry == NULL) |
Antoine Pitrou | aa5c5c6 | 2012-01-18 21:45:15 +0100 | [diff] [blame] | 1256 | return NULL; |
| 1257 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1258 | Py_INCREF(_PyRuntime.warnings.once_registry); |
| 1259 | if (PyModule_AddObject(m, "_onceregistry", |
| 1260 | _PyRuntime.warnings.once_registry) < 0) |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1261 | return NULL; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1262 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1263 | if (_PyRuntime.warnings.default_action == NULL) { |
| 1264 | _PyRuntime.warnings.default_action = PyUnicode_FromString("default"); |
| 1265 | if (_PyRuntime.warnings.default_action == NULL) |
Antoine Pitrou | aa5c5c6 | 2012-01-18 21:45:15 +0100 | [diff] [blame] | 1266 | return NULL; |
| 1267 | } |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1268 | Py_INCREF(_PyRuntime.warnings.default_action); |
| 1269 | if (PyModule_AddObject(m, "_defaultaction", |
| 1270 | _PyRuntime.warnings.default_action) < 0) |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1271 | return NULL; |
Antoine Pitrou | cb0a006 | 2014-09-18 02:40:46 +0200 | [diff] [blame] | 1272 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1273 | _PyRuntime.warnings.filters_version = 0; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1274 | return m; |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 1275 | } |