blob: 543e0bb4cac63ccc1576b2eff4d3cbc5e78fd147 [file] [log] [blame]
Christian Heimes33fe8092008-04-13 13:53:33 +00001#include "Python.h"
2#include "frameobject.h"
3
4#define MODULE_NAME "_warnings"
Christian Heimes33fe8092008-04-13 13:53:33 +00005
6PyDoc_STRVAR(warnings__doc__,
7MODULE_NAME " provides basic warning filtering support.\n"
8"It is a helper module to speed up interpreter start-up.");
9
10/* Both 'filters' and 'onceregistry' can be set in warnings.py;
11 get_warnings_attr() will reset these variables accordingly. */
12static PyObject *_filters; /* List */
13static PyObject *_once_registry; /* Dict */
Brett Cannon0759dd62009-04-01 18:13:07 +000014static PyObject *_default_action; /* String */
Christian Heimes33fe8092008-04-13 13:53:33 +000015
16
17static int
18check_matched(PyObject *obj, PyObject *arg)
19{
20 PyObject *result;
21 int rc;
22
23 if (obj == Py_None)
24 return 1;
25 result = PyObject_CallMethod(obj, "match", "O", arg);
26 if (result == NULL)
27 return -1;
28
29 rc = PyObject_IsTrue(result);
30 Py_DECREF(result);
31 return rc;
32}
33
34/*
35 Returns a new reference.
36 A NULL return value can mean false or an error.
37*/
38static PyObject *
39get_warnings_attr(const char *attr)
40{
41 static PyObject *warnings_str = NULL;
42 PyObject *all_modules;
43 PyObject *warnings_module;
44 int result;
45
46 if (warnings_str == NULL) {
47 warnings_str = PyUnicode_InternFromString("warnings");
48 if (warnings_str == NULL)
49 return NULL;
50 }
51
52 all_modules = PyImport_GetModuleDict();
53 result = PyDict_Contains(all_modules, warnings_str);
54 if (result == -1 || result == 0)
55 return NULL;
56
57 warnings_module = PyDict_GetItem(all_modules, warnings_str);
58 if (!PyObject_HasAttrString(warnings_module, attr))
59 return NULL;
60 return PyObject_GetAttrString(warnings_module, attr);
61}
62
63
Neal Norwitz32dde222008-04-15 06:43:13 +000064static PyObject *
Christian Heimes33fe8092008-04-13 13:53:33 +000065get_once_registry(void)
66{
67 PyObject *registry;
68
69 registry = get_warnings_attr("onceregistry");
70 if (registry == NULL) {
71 if (PyErr_Occurred())
72 return NULL;
73 return _once_registry;
74 }
75 Py_DECREF(_once_registry);
76 _once_registry = registry;
77 return registry;
78}
79
80
Brett Cannon0759dd62009-04-01 18:13:07 +000081static PyObject *
82get_default_action(void)
83{
84 PyObject *default_action;
85
86 default_action = get_warnings_attr("defaultaction");
87 if (default_action == NULL) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000088 if (PyErr_Occurred()) {
89 return NULL;
90 }
91 return _default_action;
Brett Cannon0759dd62009-04-01 18:13:07 +000092 }
93
94 Py_DECREF(_default_action);
95 _default_action = default_action;
96 return default_action;
97}
98
99
Christian Heimes33fe8092008-04-13 13:53:33 +0000100/* The item is a borrowed reference. */
101static const char *
102get_filter(PyObject *category, PyObject *text, Py_ssize_t lineno,
103 PyObject *module, PyObject **item)
104{
Brett Cannon0759dd62009-04-01 18:13:07 +0000105 PyObject *action;
Christian Heimes33fe8092008-04-13 13:53:33 +0000106 Py_ssize_t i;
107 PyObject *warnings_filters;
108
109 warnings_filters = get_warnings_attr("filters");
110 if (warnings_filters == NULL) {
111 if (PyErr_Occurred())
112 return NULL;
113 }
114 else {
115 Py_DECREF(_filters);
116 _filters = warnings_filters;
117 }
118
Victor Stinner148051a2010-05-20 21:00:34 +0000119 if (_filters == NULL || !PyList_Check(_filters)) {
Christian Heimes33fe8092008-04-13 13:53:33 +0000120 PyErr_SetString(PyExc_ValueError,
121 MODULE_NAME ".filters must be a list");
122 return NULL;
123 }
124
125 /* _filters could change while we are iterating over it. */
126 for (i = 0; i < PyList_GET_SIZE(_filters); i++) {
127 PyObject *tmp_item, *action, *msg, *cat, *mod, *ln_obj;
128 Py_ssize_t ln;
129 int is_subclass, good_msg, good_mod;
130
131 tmp_item = *item = PyList_GET_ITEM(_filters, i);
132 if (PyTuple_Size(tmp_item) != 5) {
133 PyErr_Format(PyExc_ValueError,
134 MODULE_NAME ".filters item %zd isn't a 5-tuple", i);
135 return NULL;
136 }
137
138 /* Python code: action, msg, cat, mod, ln = item */
139 action = PyTuple_GET_ITEM(tmp_item, 0);
140 msg = PyTuple_GET_ITEM(tmp_item, 1);
141 cat = PyTuple_GET_ITEM(tmp_item, 2);
142 mod = PyTuple_GET_ITEM(tmp_item, 3);
143 ln_obj = PyTuple_GET_ITEM(tmp_item, 4);
144
145 good_msg = check_matched(msg, text);
146 good_mod = check_matched(mod, module);
147 is_subclass = PyObject_IsSubclass(category, cat);
148 ln = PyLong_AsSsize_t(ln_obj);
149 if (good_msg == -1 || good_mod == -1 || is_subclass == -1 ||
150 (ln == -1 && PyErr_Occurred()))
151 return NULL;
152
153 if (good_msg && is_subclass && good_mod && (ln == 0 || lineno == ln))
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000154 return _PyUnicode_AsString(action);
Christian Heimes33fe8092008-04-13 13:53:33 +0000155 }
156
Brett Cannon0759dd62009-04-01 18:13:07 +0000157 action = get_default_action();
158 if (action != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000159 return _PyUnicode_AsString(action);
Brett Cannon0759dd62009-04-01 18:13:07 +0000160 }
Christian Heimes33fe8092008-04-13 13:53:33 +0000161
162 PyErr_SetString(PyExc_ValueError,
Brett Cannon0759dd62009-04-01 18:13:07 +0000163 MODULE_NAME ".defaultaction not found");
Christian Heimes33fe8092008-04-13 13:53:33 +0000164 return NULL;
165}
166
Brett Cannon0759dd62009-04-01 18:13:07 +0000167
Christian Heimes33fe8092008-04-13 13:53:33 +0000168static int
169already_warned(PyObject *registry, PyObject *key, int should_set)
170{
171 PyObject *already_warned;
172
173 if (key == NULL)
174 return -1;
175
176 already_warned = PyDict_GetItem(registry, key);
177 if (already_warned != NULL) {
178 int rc = PyObject_IsTrue(already_warned);
179 if (rc != 0)
180 return rc;
181 }
182
183 /* This warning wasn't found in the registry, set it. */
184 if (should_set)
185 return PyDict_SetItem(registry, key, Py_True);
186 return 0;
187}
188
189/* New reference. */
190static PyObject *
191normalize_module(PyObject *filename)
192{
193 PyObject *module;
194 const char *mod_str;
195 Py_ssize_t len;
196
197 int rc = PyObject_IsTrue(filename);
198 if (rc == -1)
199 return NULL;
200 else if (rc == 0)
201 return PyUnicode_FromString("<unknown>");
202
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000203 mod_str = _PyUnicode_AsString(filename);
Christian Heimes33fe8092008-04-13 13:53:33 +0000204 if (mod_str == NULL)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000205 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000206 len = PyUnicode_GetSize(filename);
207 if (len < 0)
208 return NULL;
209 if (len >= 3 &&
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000210 strncmp(mod_str + (len - 3), ".py", 3) == 0) {
Christian Heimes33fe8092008-04-13 13:53:33 +0000211 module = PyUnicode_FromStringAndSize(mod_str, len-3);
212 }
213 else {
214 module = filename;
215 Py_INCREF(module);
216 }
217 return module;
218}
219
220static int
221update_registry(PyObject *registry, PyObject *text, PyObject *category,
222 int add_zero)
223{
224 PyObject *altkey, *zero = NULL;
225 int rc;
226
227 if (add_zero) {
228 zero = PyLong_FromLong(0);
229 if (zero == NULL)
230 return -1;
231 altkey = PyTuple_Pack(3, text, category, zero);
232 }
233 else
234 altkey = PyTuple_Pack(2, text, category);
235
236 rc = already_warned(registry, altkey, 1);
237 Py_XDECREF(zero);
238 Py_XDECREF(altkey);
239 return rc;
240}
241
242static void
243show_warning(PyObject *filename, int lineno, PyObject *text, PyObject
244 *category, PyObject *sourceline)
245{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000246 PyObject *f_stderr;
247 PyObject *name;
Christian Heimes33fe8092008-04-13 13:53:33 +0000248 char lineno_str[128];
249
250 PyOS_snprintf(lineno_str, sizeof(lineno_str), ":%d: ", lineno);
251
252 name = PyObject_GetAttrString(category, "__name__");
253 if (name == NULL) /* XXX Can an object lack a '__name__' attribute? */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000254 return;
Christian Heimes33fe8092008-04-13 13:53:33 +0000255
256 f_stderr = PySys_GetObject("stderr");
257 if (f_stderr == NULL) {
258 fprintf(stderr, "lost sys.stderr\n");
259 Py_DECREF(name);
260 return;
261 }
262
263 /* Print "filename:lineno: category: text\n" */
264 PyFile_WriteObject(filename, f_stderr, Py_PRINT_RAW);
265 PyFile_WriteString(lineno_str, f_stderr);
266 PyFile_WriteObject(name, f_stderr, Py_PRINT_RAW);
267 PyFile_WriteString(": ", f_stderr);
268 PyFile_WriteObject(text, f_stderr, Py_PRINT_RAW);
269 PyFile_WriteString("\n", f_stderr);
270 Py_XDECREF(name);
271
272 /* Print " source_line\n" */
Christian Heimes33fe8092008-04-13 13:53:33 +0000273 if (sourceline) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000274 char *source_line_str = _PyUnicode_AsString(sourceline);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000275 if (source_line_str == NULL)
276 return;
Christian Heimes33fe8092008-04-13 13:53:33 +0000277 while (*source_line_str == ' ' || *source_line_str == '\t' ||
278 *source_line_str == '\014')
279 source_line_str++;
280
281 PyFile_WriteString(source_line_str, f_stderr);
282 PyFile_WriteString("\n", f_stderr);
283 }
284 else
Victor Stinner25bb0fd2010-06-17 23:23:37 +0000285 if (_Py_DisplaySourceLine(f_stderr, filename, lineno, 2) < 0)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000286 return;
Christian Heimes33fe8092008-04-13 13:53:33 +0000287 PyErr_Clear();
288}
289
290static PyObject *
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000291warn_explicit(PyObject *category, PyObject *message,
Christian Heimes33fe8092008-04-13 13:53:33 +0000292 PyObject *filename, int lineno,
293 PyObject *module, PyObject *registry, PyObject *sourceline)
294{
295 PyObject *key = NULL, *text = NULL, *result = NULL, *lineno_obj = NULL;
296 PyObject *item = Py_None;
297 const char *action;
298 int rc;
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000299
Brett Cannondb734912008-06-27 00:52:15 +0000300 if (registry && !PyDict_Check(registry) && (registry != Py_None)) {
301 PyErr_SetString(PyExc_TypeError, "'registry' must be a dict");
302 return NULL;
303 }
Christian Heimes33fe8092008-04-13 13:53:33 +0000304
305 /* Normalize module. */
306 if (module == NULL) {
307 module = normalize_module(filename);
308 if (module == NULL)
309 return NULL;
310 }
311 else
312 Py_INCREF(module);
313
314 /* Normalize message. */
315 Py_INCREF(message); /* DECREF'ed in cleanup. */
316 rc = PyObject_IsInstance(message, PyExc_Warning);
317 if (rc == -1) {
318 goto cleanup;
319 }
320 if (rc == 1) {
321 text = PyObject_Str(message);
Hirokazu Yamamoto680ac292009-07-17 07:02:18 +0000322 if (text == NULL)
323 goto cleanup;
Christian Heimes33fe8092008-04-13 13:53:33 +0000324 category = (PyObject*)message->ob_type;
325 }
326 else {
327 text = message;
328 message = PyObject_CallFunction(category, "O", message);
Brett Cannondb734912008-06-27 00:52:15 +0000329 if (message == NULL)
330 goto cleanup;
Christian Heimes33fe8092008-04-13 13:53:33 +0000331 }
332
333 lineno_obj = PyLong_FromLong(lineno);
334 if (lineno_obj == NULL)
335 goto cleanup;
336
337 /* Create key. */
338 key = PyTuple_Pack(3, text, category, lineno_obj);
339 if (key == NULL)
340 goto cleanup;
341
Brett Cannondb734912008-06-27 00:52:15 +0000342 if ((registry != NULL) && (registry != Py_None)) {
Christian Heimes33fe8092008-04-13 13:53:33 +0000343 rc = already_warned(registry, key, 0);
344 if (rc == -1)
345 goto cleanup;
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000346 else if (rc == 1)
Christian Heimes33fe8092008-04-13 13:53:33 +0000347 goto return_none;
348 /* Else this warning hasn't been generated before. */
349 }
350
351 action = get_filter(category, text, lineno, module, &item);
352 if (action == NULL)
353 goto cleanup;
354
355 if (strcmp(action, "error") == 0) {
356 PyErr_SetObject(category, message);
357 goto cleanup;
358 }
359
360 /* Store in the registry that we've been here, *except* when the action
361 is "always". */
362 rc = 0;
363 if (strcmp(action, "always") != 0) {
Brett Cannondb734912008-06-27 00:52:15 +0000364 if (registry != NULL && registry != Py_None &&
365 PyDict_SetItem(registry, key, Py_True) < 0)
Christian Heimes33fe8092008-04-13 13:53:33 +0000366 goto cleanup;
367 else if (strcmp(action, "ignore") == 0)
368 goto return_none;
369 else if (strcmp(action, "once") == 0) {
Brett Cannondb734912008-06-27 00:52:15 +0000370 if (registry == NULL || registry == Py_None) {
Christian Heimes33fe8092008-04-13 13:53:33 +0000371 registry = get_once_registry();
372 if (registry == NULL)
373 goto cleanup;
374 }
375 /* _once_registry[(text, category)] = 1 */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000376 rc = update_registry(registry, text, category, 0);
Christian Heimes33fe8092008-04-13 13:53:33 +0000377 }
378 else if (strcmp(action, "module") == 0) {
379 /* registry[(text, category, 0)] = 1 */
Brett Cannondb734912008-06-27 00:52:15 +0000380 if (registry != NULL && registry != Py_None)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000381 rc = update_registry(registry, text, category, 0);
Christian Heimes33fe8092008-04-13 13:53:33 +0000382 }
383 else if (strcmp(action, "default") != 0) {
384 PyObject *to_str = PyObject_Str(item);
385 const char *err_str = "???";
386
Brett Cannon54bd41d2008-09-02 04:01:42 +0000387 if (to_str != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000388 err_str = _PyUnicode_AsString(to_str);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000389 if (err_str == NULL)
390 goto cleanup;
391 }
Christian Heimes33fe8092008-04-13 13:53:33 +0000392 PyErr_Format(PyExc_RuntimeError,
393 "Unrecognized action (%s) in warnings.filters:\n %s",
394 action, err_str);
395 Py_XDECREF(to_str);
396 goto cleanup;
397 }
398 }
399
Christian Heimes1a8501c2008-10-02 19:56:01 +0000400 if (rc == 1) /* Already warned for this module. */
Christian Heimes33fe8092008-04-13 13:53:33 +0000401 goto return_none;
402 if (rc == 0) {
403 PyObject *show_fxn = get_warnings_attr("showwarning");
404 if (show_fxn == NULL) {
405 if (PyErr_Occurred())
406 goto cleanup;
407 show_warning(filename, lineno, text, category, sourceline);
408 }
409 else {
Brett Cannonec92e182008-09-02 02:46:59 +0000410 PyObject *res;
Christian Heimes8dc226f2008-05-06 23:45:46 +0000411
Brett Cannonec92e182008-09-02 02:46:59 +0000412 if (!PyMethod_Check(show_fxn) && !PyFunction_Check(show_fxn)) {
413 PyErr_SetString(PyExc_TypeError,
414 "warnings.showwarning() must be set to a "
415 "function or method");
Christian Heimes8dc226f2008-05-06 23:45:46 +0000416 Py_DECREF(show_fxn);
Brett Cannonec92e182008-09-02 02:46:59 +0000417 goto cleanup;
Christian Heimes8dc226f2008-05-06 23:45:46 +0000418 }
Brett Cannonec92e182008-09-02 02:46:59 +0000419
420 res = PyObject_CallFunctionObjArgs(show_fxn, message, category,
421 filename, lineno_obj,
422 NULL);
423 Py_DECREF(show_fxn);
424 Py_XDECREF(res);
425 if (res == NULL)
426 goto cleanup;
Christian Heimes33fe8092008-04-13 13:53:33 +0000427 }
428 }
429 else /* if (rc == -1) */
430 goto cleanup;
431
432 return_none:
433 result = Py_None;
434 Py_INCREF(result);
435
436 cleanup:
437 Py_XDECREF(key);
438 Py_XDECREF(text);
439 Py_XDECREF(lineno_obj);
440 Py_DECREF(module);
Brett Cannondb734912008-06-27 00:52:15 +0000441 Py_XDECREF(message);
Christian Heimes33fe8092008-04-13 13:53:33 +0000442 return result; /* Py_None or NULL. */
443}
444
445/* filename, module, and registry are new refs, globals is borrowed */
446/* Returns 0 on error (no new refs), 1 on success */
447static int
448setup_context(Py_ssize_t stack_level, PyObject **filename, int *lineno,
449 PyObject **module, PyObject **registry)
450{
451 PyObject *globals;
452
453 /* Setup globals and lineno. */
454 PyFrameObject *f = PyThreadState_GET()->frame;
Christian Heimes5d8da202008-05-06 13:58:24 +0000455 while (--stack_level > 0 && f != NULL)
Christian Heimes33fe8092008-04-13 13:53:33 +0000456 f = f->f_back;
Christian Heimes33fe8092008-04-13 13:53:33 +0000457
458 if (f == NULL) {
459 globals = PyThreadState_Get()->interp->sysdict;
460 *lineno = 1;
461 }
462 else {
463 globals = f->f_globals;
464 *lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);
465 }
466
467 *module = NULL;
468
469 /* Setup registry. */
470 assert(globals != NULL);
471 assert(PyDict_Check(globals));
472 *registry = PyDict_GetItemString(globals, "__warningregistry__");
473 if (*registry == NULL) {
474 int rc;
475
476 *registry = PyDict_New();
477 if (*registry == NULL)
478 return 0;
479
480 rc = PyDict_SetItemString(globals, "__warningregistry__", *registry);
481 if (rc < 0)
482 goto handle_error;
483 }
484 else
485 Py_INCREF(*registry);
486
487 /* Setup module. */
488 *module = PyDict_GetItemString(globals, "__name__");
489 if (*module == NULL) {
490 *module = PyUnicode_FromString("<string>");
491 if (*module == NULL)
492 goto handle_error;
493 }
494 else
495 Py_INCREF(*module);
496
497 /* Setup filename. */
498 *filename = PyDict_GetItemString(globals, "__file__");
499 if (*filename != NULL) {
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000500 Py_ssize_t len = PyUnicode_GetSize(*filename);
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000501 const char *file_str = _PyUnicode_AsString(*filename);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000502 if (file_str == NULL || (len < 0 && PyErr_Occurred()))
Christian Heimes33fe8092008-04-13 13:53:33 +0000503 goto handle_error;
504
505 /* if filename.lower().endswith((".pyc", ".pyo")): */
506 if (len >= 4 &&
507 file_str[len-4] == '.' &&
508 tolower(file_str[len-3]) == 'p' &&
509 tolower(file_str[len-2]) == 'y' &&
510 (tolower(file_str[len-1]) == 'c' ||
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000511 tolower(file_str[len-1]) == 'o'))
512 {
Christian Heimes33fe8092008-04-13 13:53:33 +0000513 *filename = PyUnicode_FromStringAndSize(file_str, len-1);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000514 if (*filename == NULL)
515 goto handle_error;
516 }
517 else
Christian Heimes33fe8092008-04-13 13:53:33 +0000518 Py_INCREF(*filename);
519 }
520 else {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000521 const char *module_str = _PyUnicode_AsString(*module);
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000522 if (module_str == NULL)
523 goto handle_error;
Brett Cannon54bd41d2008-09-02 04:01:42 +0000524 if (strcmp(module_str, "__main__") == 0) {
Christian Heimes33fe8092008-04-13 13:53:33 +0000525 PyObject *argv = PySys_GetObject("argv");
526 if (argv != NULL && PyList_Size(argv) > 0) {
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000527 int is_true;
Christian Heimes33fe8092008-04-13 13:53:33 +0000528 *filename = PyList_GetItem(argv, 0);
529 Py_INCREF(*filename);
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000530 /* If sys.argv[0] is false, then use '__main__'. */
531 is_true = PyObject_IsTrue(*filename);
532 if (is_true < 0) {
533 Py_DECREF(*filename);
534 goto handle_error;
535 }
536 else if (!is_true) {
537 Py_DECREF(*filename);
Benjamin Peterson9f4bf1d2008-05-04 23:22:13 +0000538 *filename = PyUnicode_FromString("__main__");
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000539 if (*filename == NULL)
540 goto handle_error;
541 }
Christian Heimes33fe8092008-04-13 13:53:33 +0000542 }
543 else {
544 /* embedded interpreters don't have sys.argv, see bug #839151 */
545 *filename = PyUnicode_FromString("__main__");
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000546 if (*filename == NULL)
547 goto handle_error;
Christian Heimes33fe8092008-04-13 13:53:33 +0000548 }
549 }
550 if (*filename == NULL) {
551 *filename = *module;
552 Py_INCREF(*filename);
553 }
554 }
555
556 return 1;
557
558 handle_error:
559 /* filename not XDECREF'ed here as there is no way to jump here with a
560 dangling reference. */
561 Py_XDECREF(*registry);
562 Py_XDECREF(*module);
563 return 0;
564}
565
566static PyObject *
567get_category(PyObject *message, PyObject *category)
568{
569 int rc;
570
571 /* Get category. */
572 rc = PyObject_IsInstance(message, PyExc_Warning);
573 if (rc == -1)
574 return NULL;
575
576 if (rc == 1)
577 category = (PyObject*)message->ob_type;
578 else if (category == NULL)
579 category = PyExc_UserWarning;
580
581 /* Validate category. */
582 rc = PyObject_IsSubclass(category, PyExc_Warning);
583 if (rc == -1)
584 return NULL;
585 if (rc == 0) {
586 PyErr_SetString(PyExc_ValueError,
587 "category is not a subclass of Warning");
588 return NULL;
589 }
590
591 return category;
592}
593
594static PyObject *
595do_warn(PyObject *message, PyObject *category, Py_ssize_t stack_level)
596{
597 PyObject *filename, *module, *registry, *res;
598 int lineno;
599
600 if (!setup_context(stack_level, &filename, &lineno, &module, &registry))
601 return NULL;
602
603 res = warn_explicit(category, message, filename, lineno, module, registry,
604 NULL);
605 Py_DECREF(filename);
606 Py_DECREF(registry);
607 Py_DECREF(module);
608 return res;
609}
610
611static PyObject *
612warnings_warn(PyObject *self, PyObject *args, PyObject *kwds)
613{
614 static char *kw_list[] = { "message", "category", "stacklevel", 0 };
615 PyObject *message, *category = NULL;
616 Py_ssize_t stack_level = 1;
617
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000618 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|On:warn", kw_list,
Christian Heimes33fe8092008-04-13 13:53:33 +0000619 &message, &category, &stack_level))
620 return NULL;
621
622 category = get_category(message, category);
623 if (category == NULL)
624 return NULL;
625 return do_warn(message, category, stack_level);
626}
627
628static PyObject *
629warnings_warn_explicit(PyObject *self, PyObject *args, PyObject *kwds)
630{
631 static char *kwd_list[] = {"message", "category", "filename", "lineno",
632 "module", "registry", "module_globals", 0};
633 PyObject *message;
634 PyObject *category;
635 PyObject *filename;
636 int lineno;
637 PyObject *module = NULL;
638 PyObject *registry = NULL;
639 PyObject *module_globals = NULL;
640
641 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOOi|OOO:warn_explicit",
642 kwd_list, &message, &category, &filename, &lineno, &module,
643 &registry, &module_globals))
644 return NULL;
645
646 if (module_globals) {
647 static PyObject *get_source_name = NULL;
648 static PyObject *splitlines_name = NULL;
649 PyObject *loader;
650 PyObject *module_name;
651 PyObject *source;
652 PyObject *source_list;
653 PyObject *source_line;
654 PyObject *returned;
655
656 if (get_source_name == NULL) {
657 get_source_name = PyUnicode_InternFromString("get_source");
658 if (!get_source_name)
659 return NULL;
660 }
661 if (splitlines_name == NULL) {
662 splitlines_name = PyUnicode_InternFromString("splitlines");
663 if (!splitlines_name)
664 return NULL;
665 }
666
667 /* Check/get the requisite pieces needed for the loader. */
668 loader = PyDict_GetItemString(module_globals, "__loader__");
669 module_name = PyDict_GetItemString(module_globals, "__name__");
670
671 if (loader == NULL || module_name == NULL)
672 goto standard_call;
673
674 /* Make sure the loader implements the optional get_source() method. */
675 if (!PyObject_HasAttrString(loader, "get_source"))
676 goto standard_call;
677 /* Call get_source() to get the source code. */
678 source = PyObject_CallMethodObjArgs(loader, get_source_name,
679 module_name, NULL);
680 if (!source)
681 return NULL;
682 else if (source == Py_None) {
683 Py_DECREF(Py_None);
684 goto standard_call;
685 }
686
687 /* Split the source into lines. */
688 source_list = PyObject_CallMethodObjArgs(source, splitlines_name,
689 NULL);
690 Py_DECREF(source);
691 if (!source_list)
692 return NULL;
693
694 /* Get the source line. */
695 source_line = PyList_GetItem(source_list, lineno-1);
696 if (!source_line) {
697 Py_DECREF(source_list);
698 return NULL;
699 }
700
701 /* Handle the warning. */
702 returned = warn_explicit(category, message, filename, lineno, module,
703 registry, source_line);
704 Py_DECREF(source_list);
705 return returned;
706 }
707
708 standard_call:
709 return warn_explicit(category, message, filename, lineno, module,
710 registry, NULL);
711}
712
713
714/* Function to issue a warning message; may raise an exception. */
715int
716PyErr_WarnEx(PyObject *category, const char *text, Py_ssize_t stack_level)
717{
718 PyObject *res;
719 PyObject *message = PyUnicode_FromString(text);
720 if (message == NULL)
721 return -1;
722
723 if (category == NULL)
724 category = PyExc_RuntimeWarning;
725
726 res = do_warn(message, category, stack_level);
727 Py_DECREF(message);
728 if (res == NULL)
729 return -1;
730 Py_DECREF(res);
731
732 return 0;
733}
734
Ezio Melotti42da6632011-03-15 05:18:48 +0200735/* PyErr_Warn is only for backwards compatibility and will be removed.
Christian Heimes33fe8092008-04-13 13:53:33 +0000736 Use PyErr_WarnEx instead. */
737
738#undef PyErr_Warn
739
740PyAPI_FUNC(int)
741PyErr_Warn(PyObject *category, char *text)
742{
743 return PyErr_WarnEx(category, text, 1);
744}
745
746/* Warning with explicit origin */
747int
748PyErr_WarnExplicit(PyObject *category, const char *text,
749 const char *filename_str, int lineno,
750 const char *module_str, PyObject *registry)
751{
752 PyObject *res;
753 PyObject *message = PyUnicode_FromString(text);
754 PyObject *filename = PyUnicode_FromString(filename_str);
755 PyObject *module = NULL;
756 int ret = -1;
757
758 if (message == NULL || filename == NULL)
759 goto exit;
760 if (module_str != NULL) {
761 module = PyUnicode_FromString(module_str);
762 if (module == NULL)
763 goto exit;
764 }
765
766 if (category == NULL)
767 category = PyExc_RuntimeWarning;
768 res = warn_explicit(category, message, filename, lineno, module, registry,
769 NULL);
770 if (res == NULL)
771 goto exit;
772 Py_DECREF(res);
773 ret = 0;
774
775 exit:
776 Py_XDECREF(message);
777 Py_XDECREF(module);
778 Py_XDECREF(filename);
779 return ret;
780}
781
782
783PyDoc_STRVAR(warn_doc,
784"Issue a warning, or maybe ignore it or raise an exception.");
785
786PyDoc_STRVAR(warn_explicit_doc,
787"Low-level inferface to warnings functionality.");
788
789static PyMethodDef warnings_functions[] = {
790 {"warn", (PyCFunction)warnings_warn, METH_VARARGS | METH_KEYWORDS,
791 warn_doc},
792 {"warn_explicit", (PyCFunction)warnings_warn_explicit,
793 METH_VARARGS | METH_KEYWORDS, warn_explicit_doc},
Christian Heimes1a8501c2008-10-02 19:56:01 +0000794 /* XXX(brett.cannon): add showwarning? */
795 /* XXX(brett.cannon): Reasonable to add formatwarning? */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000796 {NULL, NULL} /* sentinel */
Christian Heimes33fe8092008-04-13 13:53:33 +0000797};
798
799
800static PyObject *
801create_filter(PyObject *category, const char *action)
802{
803 static PyObject *ignore_str = NULL;
804 static PyObject *error_str = NULL;
805 static PyObject *default_str = NULL;
806 PyObject *action_obj = NULL;
807 PyObject *lineno, *result;
808
809 if (!strcmp(action, "ignore")) {
810 if (ignore_str == NULL) {
811 ignore_str = PyUnicode_InternFromString("ignore");
812 if (ignore_str == NULL)
813 return NULL;
814 }
815 action_obj = ignore_str;
816 }
817 else if (!strcmp(action, "error")) {
818 if (error_str == NULL) {
819 error_str = PyUnicode_InternFromString("error");
820 if (error_str == NULL)
821 return NULL;
822 }
823 action_obj = error_str;
824 }
825 else if (!strcmp(action, "default")) {
826 if (default_str == NULL) {
827 default_str = PyUnicode_InternFromString("default");
828 if (default_str == NULL)
829 return NULL;
830 }
831 action_obj = default_str;
832 }
833 else {
834 Py_FatalError("unknown action");
835 }
836
837 /* This assumes the line number is zero for now. */
838 lineno = PyLong_FromLong(0);
839 if (lineno == NULL)
840 return NULL;
841 result = PyTuple_Pack(5, action_obj, Py_None, category, Py_None, lineno);
842 Py_DECREF(lineno);
843 return result;
844}
845
846static PyObject *
847init_filters(void)
848{
849 PyObject *filters = PyList_New(3);
850 const char *bytes_action;
851 if (filters == NULL)
852 return NULL;
853
854 PyList_SET_ITEM(filters, 0,
855 create_filter(PyExc_PendingDeprecationWarning, "ignore"));
856 PyList_SET_ITEM(filters, 1, create_filter(PyExc_ImportWarning, "ignore"));
857 if (Py_BytesWarningFlag > 1)
858 bytes_action = "error";
859 else if (Py_BytesWarningFlag)
860 bytes_action = "default";
861 else
862 bytes_action = "ignore";
863 PyList_SET_ITEM(filters, 2, create_filter(PyExc_BytesWarning,
864 bytes_action));
865
866 if (PyList_GET_ITEM(filters, 0) == NULL ||
867 PyList_GET_ITEM(filters, 1) == NULL ||
868 PyList_GET_ITEM(filters, 2) == NULL) {
869 Py_DECREF(filters);
870 return NULL;
871 }
872
873 return filters;
874}
875
Martin v. Löwis1a214512008-06-11 05:26:20 +0000876static struct PyModuleDef warningsmodule = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000877 PyModuleDef_HEAD_INIT,
878 MODULE_NAME,
879 warnings__doc__,
880 0,
881 warnings_functions,
882 NULL,
883 NULL,
884 NULL,
885 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +0000886};
887
Christian Heimes33fe8092008-04-13 13:53:33 +0000888
889PyMODINIT_FUNC
890_PyWarnings_Init(void)
891{
Brett Cannon0759dd62009-04-01 18:13:07 +0000892 PyObject *m;
Christian Heimes33fe8092008-04-13 13:53:33 +0000893
Martin v. Löwis1a214512008-06-11 05:26:20 +0000894 m = PyModule_Create(&warningsmodule);
Christian Heimes33fe8092008-04-13 13:53:33 +0000895 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000896 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000897
898 _filters = init_filters();
899 if (_filters == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000900 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000901 Py_INCREF(_filters);
902 if (PyModule_AddObject(m, "filters", _filters) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000903 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000904
905 _once_registry = PyDict_New();
906 if (_once_registry == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000907 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000908 Py_INCREF(_once_registry);
909 if (PyModule_AddObject(m, "once_registry", _once_registry) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000910 return NULL;
Christian Heimes33fe8092008-04-13 13:53:33 +0000911
Brett Cannon0759dd62009-04-01 18:13:07 +0000912 _default_action = PyUnicode_FromString("default");
913 if (_default_action == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000914 return NULL;
Brett Cannon0759dd62009-04-01 18:13:07 +0000915 if (PyModule_AddObject(m, "default_action", _default_action) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000916 return NULL;
917 return m;
Christian Heimes33fe8092008-04-13 13:53:33 +0000918}