blob: 3e7dda7db8f80ac729c1b74dd191c2e9ea24beba [file] [log] [blame]
Brett Cannone9746892008-04-12 23:44:07 +00001#include "Python.h"
2#include "frameobject.h"
3
4#define MODULE_NAME "_warnings"
5#define DEFAULT_ACTION_NAME "default_action"
6
7PyDoc_STRVAR(warnings__doc__,
8MODULE_NAME " provides basic warning filtering support.\n"
9"It is a helper module to speed up interpreter start-up.");
10
11/* Both 'filters' and 'onceregistry' can be set in warnings.py;
12 get_warnings_attr() will reset these variables accordingly. */
13static PyObject *_filters; /* List */
14static PyObject *_once_registry; /* Dict */
15
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) {
Christian Heimes67153522008-04-13 09:33:24 +000047 warnings_str = PyString_InternFromString("warnings");
Brett Cannone9746892008-04-12 23:44:07 +000048 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
Amaury Forgeot d'Arcf9e7ebe2008-04-14 20:07:48 +000064static PyObject *
Brett Cannone9746892008-04-12 23:44:07 +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
81/* The item is a borrowed reference. */
82static const char *
83get_filter(PyObject *category, PyObject *text, Py_ssize_t lineno,
84 PyObject *module, PyObject **item)
85{
86 PyObject *action, *m, *d;
87 Py_ssize_t i;
88 PyObject *warnings_filters;
89
90 warnings_filters = get_warnings_attr("filters");
91 if (warnings_filters == NULL) {
92 if (PyErr_Occurred())
93 return NULL;
94 }
95 else {
96 Py_DECREF(_filters);
97 _filters = warnings_filters;
98 }
99
100 if (!PyList_Check(_filters)) {
101 PyErr_SetString(PyExc_ValueError,
102 MODULE_NAME ".filters must be a list");
103 return NULL;
104 }
105
106 /* _filters could change while we are iterating over it. */
107 for (i = 0; i < PyList_GET_SIZE(_filters); i++) {
108 PyObject *tmp_item, *action, *msg, *cat, *mod, *ln_obj;
109 Py_ssize_t ln;
110 int is_subclass, good_msg, good_mod;
111
112 tmp_item = *item = PyList_GET_ITEM(_filters, i);
113 if (PyTuple_Size(tmp_item) != 5) {
114 PyErr_Format(PyExc_ValueError,
115 MODULE_NAME ".filters item %zd isn't a 5-tuple", i);
116 return NULL;
117 }
118
119 /* Python code: action, msg, cat, mod, ln = item */
120 action = PyTuple_GET_ITEM(tmp_item, 0);
121 msg = PyTuple_GET_ITEM(tmp_item, 1);
122 cat = PyTuple_GET_ITEM(tmp_item, 2);
123 mod = PyTuple_GET_ITEM(tmp_item, 3);
124 ln_obj = PyTuple_GET_ITEM(tmp_item, 4);
125
126 good_msg = check_matched(msg, text);
127 good_mod = check_matched(mod, module);
128 is_subclass = PyObject_IsSubclass(category, cat);
129 ln = PyInt_AsSsize_t(ln_obj);
130 if (good_msg == -1 || good_mod == -1 || is_subclass == -1 ||
131 (ln == -1 && PyErr_Occurred()))
132 return NULL;
133
134 if (good_msg && is_subclass && good_mod && (ln == 0 || lineno == ln))
135 return PyString_AsString(action);
136 }
137
138 m = PyImport_ImportModule(MODULE_NAME);
139 if (m == NULL)
140 return NULL;
141 d = PyModule_GetDict(m);
142 Py_DECREF(m);
143 if (d == NULL)
144 return NULL;
145 action = PyDict_GetItemString(d, DEFAULT_ACTION_NAME);
146 if (action != NULL)
147 return PyString_AsString(action);
148
149 PyErr_SetString(PyExc_ValueError,
150 MODULE_NAME "." DEFAULT_ACTION_NAME " not found");
151 return NULL;
152}
153
154static int
155already_warned(PyObject *registry, PyObject *key, int should_set)
156{
157 PyObject *already_warned;
158
159 if (key == NULL)
160 return -1;
161
162 already_warned = PyDict_GetItem(registry, key);
163 if (already_warned != NULL) {
164 int rc = PyObject_IsTrue(already_warned);
165 if (rc != 0)
166 return rc;
167 }
168
169 /* This warning wasn't found in the registry, set it. */
170 if (should_set)
171 return PyDict_SetItem(registry, key, Py_True);
172 return 0;
173}
174
175/* New reference. */
176static PyObject *
177normalize_module(PyObject *filename)
178{
179 PyObject *module;
180 const char *mod_str;
181 Py_ssize_t len;
182
183 int rc = PyObject_IsTrue(filename);
184 if (rc == -1)
185 return NULL;
186 else if (rc == 0)
187 return PyString_FromString("<unknown>");
188
189 mod_str = PyString_AsString(filename);
190 if (mod_str == NULL)
191 return NULL;
192 len = PyString_Size(filename);
193 if (len < 0)
194 return NULL;
195 if (len >= 3 &&
196 strncmp(mod_str + (len - 3), ".py", 3) == 0) {
197 module = PyString_FromStringAndSize(mod_str, len-3);
198 }
199 else {
200 module = filename;
201 Py_INCREF(module);
202 }
203 return module;
204}
205
206static int
207update_registry(PyObject *registry, PyObject *text, PyObject *category,
208 int add_zero)
209{
210 PyObject *altkey, *zero = NULL;
211 int rc;
212
213 if (add_zero) {
214 zero = PyInt_FromLong(0);
215 if (zero == NULL)
216 return -1;
217 altkey = PyTuple_Pack(3, text, category, zero);
218 }
219 else
220 altkey = PyTuple_Pack(2, text, category);
221
222 rc = already_warned(registry, altkey, 1);
223 Py_XDECREF(zero);
224 Py_XDECREF(altkey);
225 return rc;
226}
227
228static void
229show_warning(PyObject *filename, int lineno, PyObject *text, PyObject
230 *category, PyObject *sourceline)
231{
Brett Cannon8a232cc2008-05-05 05:32:07 +0000232 PyObject *f_stderr;
233 PyObject *name;
Brett Cannone9746892008-04-12 23:44:07 +0000234 char lineno_str[128];
235
236 PyOS_snprintf(lineno_str, sizeof(lineno_str), ":%d: ", lineno);
237
238 name = PyObject_GetAttrString(category, "__name__");
239 if (name == NULL) /* XXX Can an object lack a '__name__' attribute? */
240 return;
241
242 f_stderr = PySys_GetObject("stderr");
243 if (f_stderr == NULL) {
244 fprintf(stderr, "lost sys.stderr\n");
245 Py_DECREF(name);
246 return;
247 }
248
249 /* Print "filename:lineno: category: text\n" */
250 PyFile_WriteObject(filename, f_stderr, Py_PRINT_RAW);
251 PyFile_WriteString(lineno_str, f_stderr);
252 PyFile_WriteObject(name, f_stderr, Py_PRINT_RAW);
253 PyFile_WriteString(": ", f_stderr);
254 PyFile_WriteObject(text, f_stderr, Py_PRINT_RAW);
255 PyFile_WriteString("\n", f_stderr);
256 Py_XDECREF(name);
257
258 /* Print " source_line\n" */
259 PyFile_WriteString(" ", f_stderr);
260 if (sourceline) {
261 char *source_line_str = PyString_AS_STRING(sourceline);
262 while (*source_line_str == ' ' || *source_line_str == '\t' ||
263 *source_line_str == '\014')
264 source_line_str++;
265
266 PyFile_WriteString(source_line_str, f_stderr);
267 PyFile_WriteString("\n", f_stderr);
268 }
269 else
270 Py_DisplaySourceLine(f_stderr, PyString_AS_STRING(filename), lineno);
271 PyErr_Clear();
272}
273
274static PyObject *
Brett Cannon8a232cc2008-05-05 05:32:07 +0000275warn_explicit(PyObject *category, PyObject *message,
Brett Cannone9746892008-04-12 23:44:07 +0000276 PyObject *filename, int lineno,
277 PyObject *module, PyObject *registry, PyObject *sourceline)
278{
279 PyObject *key = NULL, *text = NULL, *result = NULL, *lineno_obj = NULL;
280 PyObject *item = Py_None;
281 const char *action;
282 int rc;
283
284 /* Normalize module. */
285 if (module == NULL) {
286 module = normalize_module(filename);
287 if (module == NULL)
288 return NULL;
289 }
290 else
291 Py_INCREF(module);
292
293 /* Normalize message. */
294 Py_INCREF(message); /* DECREF'ed in cleanup. */
295 rc = PyObject_IsInstance(message, PyExc_Warning);
296 if (rc == -1) {
297 goto cleanup;
298 }
299 if (rc == 1) {
300 text = PyObject_Str(message);
301 category = (PyObject*)message->ob_type;
302 }
303 else {
304 text = message;
305 message = PyObject_CallFunction(category, "O", message);
306 }
307
308 lineno_obj = PyInt_FromLong(lineno);
309 if (lineno_obj == NULL)
310 goto cleanup;
311
312 /* Create key. */
313 key = PyTuple_Pack(3, text, category, lineno_obj);
314 if (key == NULL)
315 goto cleanup;
316
317 if (registry != NULL) {
318 rc = already_warned(registry, key, 0);
319 if (rc == -1)
320 goto cleanup;
321 else if (rc == 1)
322 goto return_none;
323 /* Else this warning hasn't been generated before. */
324 }
325
326 action = get_filter(category, text, lineno, module, &item);
327 if (action == NULL)
328 goto cleanup;
329
330 if (strcmp(action, "error") == 0) {
331 PyErr_SetObject(category, message);
332 goto cleanup;
333 }
334
335 /* Store in the registry that we've been here, *except* when the action
336 is "always". */
337 rc = 0;
338 if (strcmp(action, "always") != 0) {
339 if (registry != NULL && PyDict_SetItem(registry, key, Py_True) < 0)
340 goto cleanup;
341 else if (strcmp(action, "ignore") == 0)
342 goto return_none;
343 else if (strcmp(action, "once") == 0) {
344 if (registry == NULL) {
345 registry = get_once_registry();
346 if (registry == NULL)
347 goto cleanup;
348 }
349 /* _once_registry[(text, category)] = 1 */
Brett Cannon8a232cc2008-05-05 05:32:07 +0000350 rc = update_registry(registry, text, category, 0);
Brett Cannone9746892008-04-12 23:44:07 +0000351 }
352 else if (strcmp(action, "module") == 0) {
353 /* registry[(text, category, 0)] = 1 */
354 if (registry != NULL)
Brett Cannon8a232cc2008-05-05 05:32:07 +0000355 rc = update_registry(registry, text, category, 0);
Brett Cannone9746892008-04-12 23:44:07 +0000356 }
357 else if (strcmp(action, "default") != 0) {
358 PyObject *to_str = PyObject_Str(item);
359 const char *err_str = "???";
360
361 if (to_str != NULL)
362 err_str = PyString_AS_STRING(to_str);
363 PyErr_Format(PyExc_RuntimeError,
364 "Unrecognized action (%s) in warnings.filters:\n %s",
365 action, err_str);
366 Py_XDECREF(to_str);
367 goto cleanup;
368 }
369 }
370
371 if (rc == 1) // Already warned for this module. */
372 goto return_none;
373 if (rc == 0) {
374 PyObject *show_fxn = get_warnings_attr("showwarning");
375 if (show_fxn == NULL) {
376 if (PyErr_Occurred())
377 goto cleanup;
378 show_warning(filename, lineno, text, category, sourceline);
379 }
380 else {
Brett Cannon8a232cc2008-05-05 05:32:07 +0000381 const char *msg = "functions overriding warnings.showwarning() "
382 "must support the 'line' argument";
383 const char *text_char = PyString_AS_STRING(text);
384
385 if (strcmp(msg, text_char) == 0) {
386 /* Prevent infinite recursion by using built-in implementation
387 of showwarning(). */
388 show_warning(filename, lineno, text, category, sourceline);
389 }
390 else {
391 PyObject *check_fxn;
392 PyObject *defaults;
393 PyObject *res;
394
395 if (PyMethod_Check(show_fxn))
396 check_fxn = PyMethod_Function(show_fxn);
397 else if (PyFunction_Check(show_fxn))
398 check_fxn = show_fxn;
399 else {
400 PyErr_SetString(PyExc_TypeError,
401 "warnings.showwarning() must be set to a "
402 "function or method");
403 }
404
405 defaults = PyFunction_GetDefaults(check_fxn);
406 /* A proper implementation of warnings.showwarning() should
407 have at least two default arguments. */
408 if ((defaults == NULL) || (PyTuple_Size(defaults) < 2)) {
409 if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1) < 0)
410 goto cleanup;
411 }
412 res = PyObject_CallFunctionObjArgs(show_fxn, message, category,
Brett Cannone9746892008-04-12 23:44:07 +0000413 filename, lineno_obj,
Brett Cannone9746892008-04-12 23:44:07 +0000414 NULL);
Brett Cannon8a232cc2008-05-05 05:32:07 +0000415 Py_DECREF(show_fxn);
416 Py_XDECREF(res);
417 if (res == NULL)
418 goto cleanup;
419 }
Brett Cannone9746892008-04-12 23:44:07 +0000420 }
421 }
422 else /* if (rc == -1) */
423 goto cleanup;
424
425 return_none:
426 result = Py_None;
427 Py_INCREF(result);
428
429 cleanup:
430 Py_XDECREF(key);
431 Py_XDECREF(text);
432 Py_XDECREF(lineno_obj);
433 Py_DECREF(module);
434 Py_DECREF(message);
435 return result; /* Py_None or NULL. */
436}
437
438/* filename, module, and registry are new refs, globals is borrowed */
439/* Returns 0 on error (no new refs), 1 on success */
440static int
441setup_context(Py_ssize_t stack_level, PyObject **filename, int *lineno,
442 PyObject **module, PyObject **registry)
443{
444 PyObject *globals;
445
446 /* Setup globals and lineno. */
447 PyFrameObject *f = PyThreadState_GET()->frame;
448 while (--stack_level > 0 && f != NULL) {
449 f = f->f_back;
450 --stack_level;
451 }
452
453 if (f == NULL) {
454 globals = PyThreadState_Get()->interp->sysdict;
455 *lineno = 1;
456 }
457 else {
458 globals = f->f_globals;
459 *lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);
460 }
461
462 *module = NULL;
463
464 /* Setup registry. */
465 assert(globals != NULL);
466 assert(PyDict_Check(globals));
467 *registry = PyDict_GetItemString(globals, "__warningregistry__");
468 if (*registry == NULL) {
469 int rc;
470
471 *registry = PyDict_New();
472 if (*registry == NULL)
473 return 0;
474
475 rc = PyDict_SetItemString(globals, "__warningregistry__", *registry);
476 if (rc < 0)
477 goto handle_error;
478 }
479 else
480 Py_INCREF(*registry);
481
482 /* Setup module. */
483 *module = PyDict_GetItemString(globals, "__name__");
484 if (*module == NULL) {
485 *module = PyString_FromString("<string>");
486 if (*module == NULL)
487 goto handle_error;
488 }
489 else
490 Py_INCREF(*module);
491
492 /* Setup filename. */
493 *filename = PyDict_GetItemString(globals, "__file__");
494 if (*filename != NULL) {
Brett Cannonab9cc1b2008-05-03 01:02:41 +0000495 Py_ssize_t len = PyString_Size(*filename);
Brett Cannone9746892008-04-12 23:44:07 +0000496 const char *file_str = PyString_AsString(*filename);
Brett Cannonab9cc1b2008-05-03 01:02:41 +0000497 if (file_str == NULL || (len < 0 && PyErr_Occurred()))
Brett Cannone9746892008-04-12 23:44:07 +0000498 goto handle_error;
499
500 /* if filename.lower().endswith((".pyc", ".pyo")): */
501 if (len >= 4 &&
502 file_str[len-4] == '.' &&
503 tolower(file_str[len-3]) == 'p' &&
504 tolower(file_str[len-2]) == 'y' &&
505 (tolower(file_str[len-1]) == 'c' ||
Brett Cannonab9cc1b2008-05-03 01:02:41 +0000506 tolower(file_str[len-1]) == 'o'))
507 {
Brett Cannone9746892008-04-12 23:44:07 +0000508 *filename = PyString_FromStringAndSize(file_str, len-1);
Brett Cannonab9cc1b2008-05-03 01:02:41 +0000509 if (*filename == NULL)
510 goto handle_error;
511 }
512 else
Brett Cannone9746892008-04-12 23:44:07 +0000513 Py_INCREF(*filename);
514 }
515 else {
516 const char *module_str = PyString_AsString(*module);
517 if (module_str && strcmp(module_str, "__main__") == 0) {
518 PyObject *argv = PySys_GetObject("argv");
519 if (argv != NULL && PyList_Size(argv) > 0) {
Brett Cannon64a4bbe2008-05-03 03:19:39 +0000520 int is_true;
Brett Cannone9746892008-04-12 23:44:07 +0000521 *filename = PyList_GetItem(argv, 0);
522 Py_INCREF(*filename);
Brett Cannon64a4bbe2008-05-03 03:19:39 +0000523 /* If sys.argv[0] is false, then use '__main__'. */
524 is_true = PyObject_IsTrue(*filename);
525 if (is_true < 0) {
526 Py_DECREF(*filename);
527 goto handle_error;
528 }
529 else if (!is_true) {
530 Py_DECREF(*filename);
531 *filename = PyString_FromString("__main__");
532 if (*filename == NULL)
533 goto handle_error;
534 }
Brett Cannone9746892008-04-12 23:44:07 +0000535 }
536 else {
537 /* embedded interpreters don't have sys.argv, see bug #839151 */
538 *filename = PyString_FromString("__main__");
Brett Cannonab9cc1b2008-05-03 01:02:41 +0000539 if (*filename == NULL)
540 goto handle_error;
Brett Cannone9746892008-04-12 23:44:07 +0000541 }
542 }
543 if (*filename == NULL) {
544 *filename = *module;
545 Py_INCREF(*filename);
546 }
547 }
548
549 return 1;
550
551 handle_error:
552 /* filename not XDECREF'ed here as there is no way to jump here with a
553 dangling reference. */
554 Py_XDECREF(*registry);
555 Py_XDECREF(*module);
556 return 0;
557}
558
559static PyObject *
560get_category(PyObject *message, PyObject *category)
561{
562 int rc;
563
564 /* Get category. */
565 rc = PyObject_IsInstance(message, PyExc_Warning);
566 if (rc == -1)
567 return NULL;
568
569 if (rc == 1)
570 category = (PyObject*)message->ob_type;
571 else if (category == NULL)
572 category = PyExc_UserWarning;
573
574 /* Validate category. */
575 rc = PyObject_IsSubclass(category, PyExc_Warning);
576 if (rc == -1)
577 return NULL;
578 if (rc == 0) {
579 PyErr_SetString(PyExc_ValueError,
580 "category is not a subclass of Warning");
581 return NULL;
582 }
583
584 return category;
585}
586
587static PyObject *
588do_warn(PyObject *message, PyObject *category, Py_ssize_t stack_level)
589{
590 PyObject *filename, *module, *registry, *res;
591 int lineno;
592
593 if (!setup_context(stack_level, &filename, &lineno, &module, &registry))
594 return NULL;
595
596 res = warn_explicit(category, message, filename, lineno, module, registry,
597 NULL);
598 Py_DECREF(filename);
599 Py_DECREF(registry);
600 Py_DECREF(module);
601 return res;
602}
603
604static PyObject *
605warnings_warn(PyObject *self, PyObject *args, PyObject *kwds)
606{
607 static char *kw_list[] = { "message", "category", "stacklevel", 0 };
608 PyObject *message, *category = NULL;
609 Py_ssize_t stack_level = 1;
610
Brett Cannon8a232cc2008-05-05 05:32:07 +0000611 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|On:warn", kw_list,
Brett Cannone9746892008-04-12 23:44:07 +0000612 &message, &category, &stack_level))
613 return NULL;
614
615 category = get_category(message, category);
616 if (category == NULL)
617 return NULL;
618 return do_warn(message, category, stack_level);
619}
620
621static PyObject *
622warnings_warn_explicit(PyObject *self, PyObject *args, PyObject *kwds)
623{
624 static char *kwd_list[] = {"message", "category", "filename", "lineno",
625 "module", "registry", "module_globals", 0};
626 PyObject *message;
627 PyObject *category;
628 PyObject *filename;
629 int lineno;
630 PyObject *module = NULL;
631 PyObject *registry = NULL;
632 PyObject *module_globals = NULL;
633
634 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOOi|OOO:warn_explicit",
635 kwd_list, &message, &category, &filename, &lineno, &module,
636 &registry, &module_globals))
637 return NULL;
638
639 if (module_globals) {
640 static PyObject *get_source_name = NULL;
641 static PyObject *splitlines_name = NULL;
642 PyObject *loader;
643 PyObject *module_name;
644 PyObject *source;
645 PyObject *source_list;
646 PyObject *source_line;
647 PyObject *returned;
648
649 if (get_source_name == NULL) {
Christian Heimes67153522008-04-13 09:33:24 +0000650 get_source_name = PyString_InternFromString("get_source");
Brett Cannone9746892008-04-12 23:44:07 +0000651 if (!get_source_name)
652 return NULL;
653 }
654 if (splitlines_name == NULL) {
Christian Heimes67153522008-04-13 09:33:24 +0000655 splitlines_name = PyString_InternFromString("splitlines");
Brett Cannone9746892008-04-12 23:44:07 +0000656 if (!splitlines_name)
657 return NULL;
658 }
659
660 /* Check/get the requisite pieces needed for the loader. */
661 loader = PyDict_GetItemString(module_globals, "__loader__");
662 module_name = PyDict_GetItemString(module_globals, "__name__");
663
664 if (loader == NULL || module_name == NULL)
665 goto standard_call;
666
667 /* Make sure the loader implements the optional get_source() method. */
668 if (!PyObject_HasAttrString(loader, "get_source"))
669 goto standard_call;
670 /* Call get_source() to get the source code. */
671 source = PyObject_CallMethodObjArgs(loader, get_source_name,
672 module_name, NULL);
673 if (!source)
674 return NULL;
675 else if (source == Py_None) {
676 Py_DECREF(Py_None);
677 goto standard_call;
678 }
679
680 /* Split the source into lines. */
681 source_list = PyObject_CallMethodObjArgs(source, splitlines_name,
682 NULL);
683 Py_DECREF(source);
684 if (!source_list)
685 return NULL;
686
687 /* Get the source line. */
688 source_line = PyList_GetItem(source_list, lineno-1);
689 if (!source_line) {
690 Py_DECREF(source_list);
691 return NULL;
692 }
693
694 /* Handle the warning. */
695 returned = warn_explicit(category, message, filename, lineno, module,
696 registry, source_line);
697 Py_DECREF(source_list);
698 return returned;
699 }
700
701 standard_call:
702 return warn_explicit(category, message, filename, lineno, module,
703 registry, NULL);
704}
705
706
707/* Function to issue a warning message; may raise an exception. */
708int
709PyErr_WarnEx(PyObject *category, const char *text, Py_ssize_t stack_level)
710{
711 PyObject *res;
712 PyObject *message = PyString_FromString(text);
713 if (message == NULL)
714 return -1;
715
716 if (category == NULL)
717 category = PyExc_RuntimeWarning;
718
719 res = do_warn(message, category, stack_level);
720 Py_DECREF(message);
721 if (res == NULL)
722 return -1;
723 Py_DECREF(res);
724
725 return 0;
726}
727
728/* PyErr_Warn is only for backwards compatability and will be removed.
729 Use PyErr_WarnEx instead. */
730
731#undef PyErr_Warn
732
733PyAPI_FUNC(int)
734PyErr_Warn(PyObject *category, char *text)
735{
736 return PyErr_WarnEx(category, text, 1);
737}
738
739/* Warning with explicit origin */
740int
741PyErr_WarnExplicit(PyObject *category, const char *text,
742 const char *filename_str, int lineno,
743 const char *module_str, PyObject *registry)
744{
745 PyObject *res;
746 PyObject *message = PyString_FromString(text);
747 PyObject *filename = PyString_FromString(filename_str);
748 PyObject *module = NULL;
749 int ret = -1;
750
751 if (message == NULL || filename == NULL)
752 goto exit;
753 if (module_str != NULL) {
754 module = PyString_FromString(module_str);
755 if (module == NULL)
756 goto exit;
757 }
758
759 if (category == NULL)
760 category = PyExc_RuntimeWarning;
761 res = warn_explicit(category, message, filename, lineno, module, registry,
762 NULL);
763 if (res == NULL)
764 goto exit;
765 Py_DECREF(res);
766 ret = 0;
767
768 exit:
769 Py_XDECREF(message);
770 Py_XDECREF(module);
771 Py_XDECREF(filename);
772 return ret;
773}
774
775
Benjamin Petersona692c4d2008-04-27 02:28:02 +0000776int
777PyErr_WarnPy3k(const char *text, Py_ssize_t stacklevel)
778{
779 if (Py_Py3kWarningFlag)
780 return PyErr_WarnEx(PyExc_DeprecationWarning, text, stacklevel);
781 return 0;
782}
783
784
Brett Cannone9746892008-04-12 23:44:07 +0000785PyDoc_STRVAR(warn_doc,
786"Issue a warning, or maybe ignore it or raise an exception.");
787
788PyDoc_STRVAR(warn_explicit_doc,
789"Low-level inferface to warnings functionality.");
790
791static PyMethodDef warnings_functions[] = {
792 {"warn", (PyCFunction)warnings_warn, METH_VARARGS | METH_KEYWORDS,
793 warn_doc},
794 {"warn_explicit", (PyCFunction)warnings_warn_explicit,
795 METH_VARARGS | METH_KEYWORDS, warn_explicit_doc},
796 // XXX(brett.cannon): add showwarning?
797 // XXX(brett.cannon): Reasonable to add formatwarning?
798 {NULL, NULL} /* sentinel */
799};
800
801
802static PyObject *
803create_filter(PyObject *category, const char *action)
804{
805 static PyObject *ignore_str = NULL;
806 static PyObject *error_str = NULL;
807 static PyObject *default_str = NULL;
808 PyObject *action_obj = NULL;
809 PyObject *lineno, *result;
810
811 if (!strcmp(action, "ignore")) {
812 if (ignore_str == NULL) {
813 ignore_str = PyString_InternFromString("ignore");
814 if (ignore_str == NULL)
815 return NULL;
816 }
817 action_obj = ignore_str;
818 }
819 else if (!strcmp(action, "error")) {
820 if (error_str == NULL) {
821 error_str = PyString_InternFromString("error");
822 if (error_str == NULL)
823 return NULL;
824 }
825 action_obj = error_str;
826 }
827 else if (!strcmp(action, "default")) {
828 if (default_str == NULL) {
829 default_str = PyString_InternFromString("default");
830 if (default_str == NULL)
831 return NULL;
832 }
833 action_obj = default_str;
834 }
835 else {
836 Py_FatalError("unknown action");
837 }
838
839 /* This assumes the line number is zero for now. */
840 lineno = PyInt_FromLong(0);
841 if (lineno == NULL)
842 return NULL;
843 result = PyTuple_Pack(5, action_obj, Py_None, category, Py_None, lineno);
844 Py_DECREF(lineno);
845 return result;
846}
847
848static PyObject *
849init_filters(void)
850{
851 PyObject *filters = PyList_New(3);
852 const char *bytes_action;
853 if (filters == NULL)
854 return NULL;
855
856 PyList_SET_ITEM(filters, 0,
857 create_filter(PyExc_PendingDeprecationWarning, "ignore"));
858 PyList_SET_ITEM(filters, 1, create_filter(PyExc_ImportWarning, "ignore"));
859 if (Py_BytesWarningFlag > 1)
860 bytes_action = "error";
861 else if (Py_BytesWarningFlag)
862 bytes_action = "default";
863 else
864 bytes_action = "ignore";
865 PyList_SET_ITEM(filters, 2, create_filter(PyExc_BytesWarning,
866 bytes_action));
867
868 if (PyList_GET_ITEM(filters, 0) == NULL ||
869 PyList_GET_ITEM(filters, 1) == NULL ||
870 PyList_GET_ITEM(filters, 2) == NULL) {
871 Py_DECREF(filters);
872 return NULL;
873 }
874
875 return filters;
876}
877
878
879PyMODINIT_FUNC
880_PyWarnings_Init(void)
881{
882 PyObject *m, *default_action;
883
884 m = Py_InitModule3(MODULE_NAME, warnings_functions, warnings__doc__);
885 if (m == NULL)
886 return;
887
888 _filters = init_filters();
889 if (_filters == NULL)
890 return;
891 Py_INCREF(_filters);
892 if (PyModule_AddObject(m, "filters", _filters) < 0)
893 return;
894
895 _once_registry = PyDict_New();
896 if (_once_registry == NULL)
897 return;
898 Py_INCREF(_once_registry);
899 if (PyModule_AddObject(m, "once_registry", _once_registry) < 0)
900 return;
901
902 default_action = PyString_InternFromString("default");
903 if (default_action == NULL)
904 return;
905 if (PyModule_AddObject(m, DEFAULT_ACTION_NAME, default_action) < 0)
906 return;
907}