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