blob: d03b4528db46fe70ae06d92a063e4acae0a0c744 [file] [log] [blame]
Christian Heimes33fe8092008-04-13 13:53:33 +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) {
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
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 = PyLong_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 PyUnicode_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 PyUnicode_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 PyUnicode_FromString("<unknown>");
188
189 mod_str = PyUnicode_AsString(filename);
190 if (mod_str == NULL)
191 return NULL;
192 len = PyUnicode_GetSize(filename);
193 if (len < 0)
194 return NULL;
195 if (len >= 3 &&
196 strncmp(mod_str + (len - 3), ".py", 3) == 0) {
197 module = PyUnicode_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 = PyLong_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{
232 PyObject *f_stderr;
233 PyObject *name;
234 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 = PyUnicode_AsString(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, PyUnicode_AsString(filename), lineno);
271 PyErr_Clear();
272}
273
274static PyObject *
275warn_explicit(PyObject *category, PyObject *message,
276 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 = PyLong_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 */
350 rc = update_registry(registry, text, category, 0);
351 }
352 else if (strcmp(action, "module") == 0) {
353 /* registry[(text, category, 0)] = 1 */
354 if (registry != NULL)
355 rc = update_registry(registry, text, category, 0);
356 }
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 = PyUnicode_AsString(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 {
Neal Norwitz32dde222008-04-15 06:43:13 +0000381 PyObject *res;
Christian Heimes33fe8092008-04-13 13:53:33 +0000382
Neal Norwitz32dde222008-04-15 06:43:13 +0000383 res = PyObject_CallFunctionObjArgs(show_fxn, message, category,
Christian Heimes33fe8092008-04-13 13:53:33 +0000384 filename, lineno_obj,
Christian Heimes33fe8092008-04-13 13:53:33 +0000385 NULL);
Neal Norwitz32dde222008-04-15 06:43:13 +0000386 Py_DECREF(show_fxn);
387 Py_XDECREF(res);
388 if (res == NULL)
Christian Heimes33fe8092008-04-13 13:53:33 +0000389 goto cleanup;
390 }
391 }
392 else /* if (rc == -1) */
393 goto cleanup;
394
395 return_none:
396 result = Py_None;
397 Py_INCREF(result);
398
399 cleanup:
400 Py_XDECREF(key);
401 Py_XDECREF(text);
402 Py_XDECREF(lineno_obj);
403 Py_DECREF(module);
404 Py_DECREF(message);
405 return result; /* Py_None or NULL. */
406}
407
408/* filename, module, and registry are new refs, globals is borrowed */
409/* Returns 0 on error (no new refs), 1 on success */
410static int
411setup_context(Py_ssize_t stack_level, PyObject **filename, int *lineno,
412 PyObject **module, PyObject **registry)
413{
414 PyObject *globals;
415
416 /* Setup globals and lineno. */
417 PyFrameObject *f = PyThreadState_GET()->frame;
Christian Heimes5d8da202008-05-06 13:58:24 +0000418 while (--stack_level > 0 && f != NULL)
Christian Heimes33fe8092008-04-13 13:53:33 +0000419 f = f->f_back;
Christian Heimes33fe8092008-04-13 13:53:33 +0000420
421 if (f == NULL) {
422 globals = PyThreadState_Get()->interp->sysdict;
423 *lineno = 1;
424 }
425 else {
426 globals = f->f_globals;
427 *lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);
428 }
429
430 *module = NULL;
431
432 /* Setup registry. */
433 assert(globals != NULL);
434 assert(PyDict_Check(globals));
435 *registry = PyDict_GetItemString(globals, "__warningregistry__");
436 if (*registry == NULL) {
437 int rc;
438
439 *registry = PyDict_New();
440 if (*registry == NULL)
441 return 0;
442
443 rc = PyDict_SetItemString(globals, "__warningregistry__", *registry);
444 if (rc < 0)
445 goto handle_error;
446 }
447 else
448 Py_INCREF(*registry);
449
450 /* Setup module. */
451 *module = PyDict_GetItemString(globals, "__name__");
452 if (*module == NULL) {
453 *module = PyUnicode_FromString("<string>");
454 if (*module == NULL)
455 goto handle_error;
456 }
457 else
458 Py_INCREF(*module);
459
460 /* Setup filename. */
461 *filename = PyDict_GetItemString(globals, "__file__");
462 if (*filename != NULL) {
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000463 Py_ssize_t len = PyUnicode_GetSize(*filename);
Christian Heimes33fe8092008-04-13 13:53:33 +0000464 const char *file_str = PyUnicode_AsString(*filename);
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000465 if (file_str == NULL || (len < 0 && PyErr_Occurred()))
Christian Heimes33fe8092008-04-13 13:53:33 +0000466 goto handle_error;
467
468 /* if filename.lower().endswith((".pyc", ".pyo")): */
469 if (len >= 4 &&
470 file_str[len-4] == '.' &&
471 tolower(file_str[len-3]) == 'p' &&
472 tolower(file_str[len-2]) == 'y' &&
473 (tolower(file_str[len-1]) == 'c' ||
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000474 tolower(file_str[len-1]) == 'o'))
475 {
Christian Heimes33fe8092008-04-13 13:53:33 +0000476 *filename = PyUnicode_FromStringAndSize(file_str, len-1);
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000477 if (*filename == NULL)
478 goto handle_error;
479 }
480 else
Christian Heimes33fe8092008-04-13 13:53:33 +0000481 Py_INCREF(*filename);
482 }
483 else {
484 const char *module_str = PyUnicode_AsString(*module);
485 if (module_str && strcmp(module_str, "__main__") == 0) {
486 PyObject *argv = PySys_GetObject("argv");
487 if (argv != NULL && PyList_Size(argv) > 0) {
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000488 int is_true;
Christian Heimes33fe8092008-04-13 13:53:33 +0000489 *filename = PyList_GetItem(argv, 0);
490 Py_INCREF(*filename);
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000491 /* If sys.argv[0] is false, then use '__main__'. */
492 is_true = PyObject_IsTrue(*filename);
493 if (is_true < 0) {
494 Py_DECREF(*filename);
495 goto handle_error;
496 }
497 else if (!is_true) {
498 Py_DECREF(*filename);
Benjamin Peterson9f4bf1d2008-05-04 23:22:13 +0000499 *filename = PyUnicode_FromString("__main__");
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000500 if (*filename == NULL)
501 goto handle_error;
502 }
Christian Heimes33fe8092008-04-13 13:53:33 +0000503 }
504 else {
505 /* embedded interpreters don't have sys.argv, see bug #839151 */
506 *filename = PyUnicode_FromString("__main__");
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000507 if (*filename == NULL)
508 goto handle_error;
Christian Heimes33fe8092008-04-13 13:53:33 +0000509 }
510 }
511 if (*filename == NULL) {
512 *filename = *module;
513 Py_INCREF(*filename);
514 }
515 }
516
517 return 1;
518
519 handle_error:
520 /* filename not XDECREF'ed here as there is no way to jump here with a
521 dangling reference. */
522 Py_XDECREF(*registry);
523 Py_XDECREF(*module);
524 return 0;
525}
526
527static PyObject *
528get_category(PyObject *message, PyObject *category)
529{
530 int rc;
531
532 /* Get category. */
533 rc = PyObject_IsInstance(message, PyExc_Warning);
534 if (rc == -1)
535 return NULL;
536
537 if (rc == 1)
538 category = (PyObject*)message->ob_type;
539 else if (category == NULL)
540 category = PyExc_UserWarning;
541
542 /* Validate category. */
543 rc = PyObject_IsSubclass(category, PyExc_Warning);
544 if (rc == -1)
545 return NULL;
546 if (rc == 0) {
547 PyErr_SetString(PyExc_ValueError,
548 "category is not a subclass of Warning");
549 return NULL;
550 }
551
552 return category;
553}
554
555static PyObject *
556do_warn(PyObject *message, PyObject *category, Py_ssize_t stack_level)
557{
558 PyObject *filename, *module, *registry, *res;
559 int lineno;
560
561 if (!setup_context(stack_level, &filename, &lineno, &module, &registry))
562 return NULL;
563
564 res = warn_explicit(category, message, filename, lineno, module, registry,
565 NULL);
566 Py_DECREF(filename);
567 Py_DECREF(registry);
568 Py_DECREF(module);
569 return res;
570}
571
572static PyObject *
573warnings_warn(PyObject *self, PyObject *args, PyObject *kwds)
574{
575 static char *kw_list[] = { "message", "category", "stacklevel", 0 };
576 PyObject *message, *category = NULL;
577 Py_ssize_t stack_level = 1;
578
579 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|On:warn", kw_list,
580 &message, &category, &stack_level))
581 return NULL;
582
583 category = get_category(message, category);
584 if (category == NULL)
585 return NULL;
586 return do_warn(message, category, stack_level);
587}
588
589static PyObject *
590warnings_warn_explicit(PyObject *self, PyObject *args, PyObject *kwds)
591{
592 static char *kwd_list[] = {"message", "category", "filename", "lineno",
593 "module", "registry", "module_globals", 0};
594 PyObject *message;
595 PyObject *category;
596 PyObject *filename;
597 int lineno;
598 PyObject *module = NULL;
599 PyObject *registry = NULL;
600 PyObject *module_globals = NULL;
601
602 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOOi|OOO:warn_explicit",
603 kwd_list, &message, &category, &filename, &lineno, &module,
604 &registry, &module_globals))
605 return NULL;
606
607 if (module_globals) {
608 static PyObject *get_source_name = NULL;
609 static PyObject *splitlines_name = NULL;
610 PyObject *loader;
611 PyObject *module_name;
612 PyObject *source;
613 PyObject *source_list;
614 PyObject *source_line;
615 PyObject *returned;
616
617 if (get_source_name == NULL) {
618 get_source_name = PyUnicode_InternFromString("get_source");
619 if (!get_source_name)
620 return NULL;
621 }
622 if (splitlines_name == NULL) {
623 splitlines_name = PyUnicode_InternFromString("splitlines");
624 if (!splitlines_name)
625 return NULL;
626 }
627
628 /* Check/get the requisite pieces needed for the loader. */
629 loader = PyDict_GetItemString(module_globals, "__loader__");
630 module_name = PyDict_GetItemString(module_globals, "__name__");
631
632 if (loader == NULL || module_name == NULL)
633 goto standard_call;
634
635 /* Make sure the loader implements the optional get_source() method. */
636 if (!PyObject_HasAttrString(loader, "get_source"))
637 goto standard_call;
638 /* Call get_source() to get the source code. */
639 source = PyObject_CallMethodObjArgs(loader, get_source_name,
640 module_name, NULL);
641 if (!source)
642 return NULL;
643 else if (source == Py_None) {
644 Py_DECREF(Py_None);
645 goto standard_call;
646 }
647
648 /* Split the source into lines. */
649 source_list = PyObject_CallMethodObjArgs(source, splitlines_name,
650 NULL);
651 Py_DECREF(source);
652 if (!source_list)
653 return NULL;
654
655 /* Get the source line. */
656 source_line = PyList_GetItem(source_list, lineno-1);
657 if (!source_line) {
658 Py_DECREF(source_list);
659 return NULL;
660 }
661
662 /* Handle the warning. */
663 returned = warn_explicit(category, message, filename, lineno, module,
664 registry, source_line);
665 Py_DECREF(source_list);
666 return returned;
667 }
668
669 standard_call:
670 return warn_explicit(category, message, filename, lineno, module,
671 registry, NULL);
672}
673
674
675/* Function to issue a warning message; may raise an exception. */
676int
677PyErr_WarnEx(PyObject *category, const char *text, Py_ssize_t stack_level)
678{
679 PyObject *res;
680 PyObject *message = PyUnicode_FromString(text);
681 if (message == NULL)
682 return -1;
683
684 if (category == NULL)
685 category = PyExc_RuntimeWarning;
686
687 res = do_warn(message, category, stack_level);
688 Py_DECREF(message);
689 if (res == NULL)
690 return -1;
691 Py_DECREF(res);
692
693 return 0;
694}
695
696/* PyErr_Warn is only for backwards compatability and will be removed.
697 Use PyErr_WarnEx instead. */
698
699#undef PyErr_Warn
700
701PyAPI_FUNC(int)
702PyErr_Warn(PyObject *category, char *text)
703{
704 return PyErr_WarnEx(category, text, 1);
705}
706
707/* Warning with explicit origin */
708int
709PyErr_WarnExplicit(PyObject *category, const char *text,
710 const char *filename_str, int lineno,
711 const char *module_str, PyObject *registry)
712{
713 PyObject *res;
714 PyObject *message = PyUnicode_FromString(text);
715 PyObject *filename = PyUnicode_FromString(filename_str);
716 PyObject *module = NULL;
717 int ret = -1;
718
719 if (message == NULL || filename == NULL)
720 goto exit;
721 if (module_str != NULL) {
722 module = PyUnicode_FromString(module_str);
723 if (module == NULL)
724 goto exit;
725 }
726
727 if (category == NULL)
728 category = PyExc_RuntimeWarning;
729 res = warn_explicit(category, message, filename, lineno, module, registry,
730 NULL);
731 if (res == NULL)
732 goto exit;
733 Py_DECREF(res);
734 ret = 0;
735
736 exit:
737 Py_XDECREF(message);
738 Py_XDECREF(module);
739 Py_XDECREF(filename);
740 return ret;
741}
742
743
744PyDoc_STRVAR(warn_doc,
745"Issue a warning, or maybe ignore it or raise an exception.");
746
747PyDoc_STRVAR(warn_explicit_doc,
748"Low-level inferface to warnings functionality.");
749
750static PyMethodDef warnings_functions[] = {
751 {"warn", (PyCFunction)warnings_warn, METH_VARARGS | METH_KEYWORDS,
752 warn_doc},
753 {"warn_explicit", (PyCFunction)warnings_warn_explicit,
754 METH_VARARGS | METH_KEYWORDS, warn_explicit_doc},
755 // XXX(brett.cannon): add showwarning?
756 // XXX(brett.cannon): Reasonable to add formatwarning?
757 {NULL, NULL} /* sentinel */
758};
759
760
761static PyObject *
762create_filter(PyObject *category, const char *action)
763{
764 static PyObject *ignore_str = NULL;
765 static PyObject *error_str = NULL;
766 static PyObject *default_str = NULL;
767 PyObject *action_obj = NULL;
768 PyObject *lineno, *result;
769
770 if (!strcmp(action, "ignore")) {
771 if (ignore_str == NULL) {
772 ignore_str = PyUnicode_InternFromString("ignore");
773 if (ignore_str == NULL)
774 return NULL;
775 }
776 action_obj = ignore_str;
777 }
778 else if (!strcmp(action, "error")) {
779 if (error_str == NULL) {
780 error_str = PyUnicode_InternFromString("error");
781 if (error_str == NULL)
782 return NULL;
783 }
784 action_obj = error_str;
785 }
786 else if (!strcmp(action, "default")) {
787 if (default_str == NULL) {
788 default_str = PyUnicode_InternFromString("default");
789 if (default_str == NULL)
790 return NULL;
791 }
792 action_obj = default_str;
793 }
794 else {
795 Py_FatalError("unknown action");
796 }
797
798 /* This assumes the line number is zero for now. */
799 lineno = PyLong_FromLong(0);
800 if (lineno == NULL)
801 return NULL;
802 result = PyTuple_Pack(5, action_obj, Py_None, category, Py_None, lineno);
803 Py_DECREF(lineno);
804 return result;
805}
806
807static PyObject *
808init_filters(void)
809{
810 PyObject *filters = PyList_New(3);
811 const char *bytes_action;
812 if (filters == NULL)
813 return NULL;
814
815 PyList_SET_ITEM(filters, 0,
816 create_filter(PyExc_PendingDeprecationWarning, "ignore"));
817 PyList_SET_ITEM(filters, 1, create_filter(PyExc_ImportWarning, "ignore"));
818 if (Py_BytesWarningFlag > 1)
819 bytes_action = "error";
820 else if (Py_BytesWarningFlag)
821 bytes_action = "default";
822 else
823 bytes_action = "ignore";
824 PyList_SET_ITEM(filters, 2, create_filter(PyExc_BytesWarning,
825 bytes_action));
826
827 if (PyList_GET_ITEM(filters, 0) == NULL ||
828 PyList_GET_ITEM(filters, 1) == NULL ||
829 PyList_GET_ITEM(filters, 2) == NULL) {
830 Py_DECREF(filters);
831 return NULL;
832 }
833
834 return filters;
835}
836
837
838PyMODINIT_FUNC
839_PyWarnings_Init(void)
840{
841 PyObject *m, *default_action;
842
843 m = Py_InitModule3(MODULE_NAME, warnings_functions, warnings__doc__);
844 if (m == NULL)
845 return;
846
847 _filters = init_filters();
848 if (_filters == NULL)
849 return;
850 Py_INCREF(_filters);
851 if (PyModule_AddObject(m, "filters", _filters) < 0)
852 return;
853
854 _once_registry = PyDict_New();
855 if (_once_registry == NULL)
856 return;
857 Py_INCREF(_once_registry);
858 if (PyModule_AddObject(m, "once_registry", _once_registry) < 0)
859 return;
860
861 default_action = PyUnicode_InternFromString("default");
862 if (default_action == NULL)
863 return;
864 if (PyModule_AddObject(m, DEFAULT_ACTION_NAME, default_action) < 0)
865 return;
866}