Add PyErr_WarnEx() so C code can pass the stacklevel to warnings.warn().

This provides the proper warning for struct.pack().
PyErr_Warn() is now deprecated in favor of PyErr_WarnEx().
As mentioned by Tim Peters on python-dev.

diff --git a/Include/pyerrors.h b/Include/pyerrors.h
index 6fa6ed717a246c7f3fae844a4b9d1562d799ff8b..ae1d9905eb641e97bbbef51520f166ffef2f76f5 100644 (file)
--- a/Include/pyerrors.h
+++ b/Include/pyerrors.h
@@ -225,10 +225,14 @@ PyAPI_FUNC(PyObject *) PyErr_NewException(char *name, PyObject *base,
 PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *);
 
 /* Issue a warning or exception */
-PyAPI_FUNC(int) PyErr_Warn(PyObject *, char *);
+PyAPI_FUNC(int) PyErr_WarnEx(PyObject *category, const char *msg,
+                            Py_ssize_t stack_level);
 PyAPI_FUNC(int) PyErr_WarnExplicit(PyObject *, const char *,
                                   const char *, int, 
                                   const char *, PyObject *);
+/* PyErr_Warn is only for backwards compatability and will be removed.
+   Use PyErr_WarnEx instead. */
+#define PyErr_Warn(category, msg) PyErr_WarnEx(category, msg, 1)
 
 /* In sigcheck.c or signalmodule.c */
 PyAPI_FUNC(int) PyErr_CheckSignals(void);

diff --git a/Misc/NEWS b/Misc/NEWS
index 141850db7ad8794b02d35b5e087a26dc7844d7df..dac1129b279b91907ed4a528f2f099ea86c4bbc1 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -12,6 +12,10 @@ What's New in Python 2.5 beta 3?
 Core and builtins
 -----------------
 
+- Add PyErr_WarnEx() so C code can pass the stacklevel to warnings.warn().
+  This provides the proper warning for struct.pack().
+  PyErr_Warn() is now deprecated in favor of PyErr_WarnEx().
+
 - Patch #1531113: Fix augmented assignment with yield expressions.
   Also fix a SystemError when trying to assign to yield expressions.
 

diff --git a/Modules/_struct.c b/Modules/_struct.c
index 7e30892680bec565f3dba63b1be0d1e1f1d47058..3774dfd6b9e07ead626b52497212f4a56ab2c4b9 100644 (file)
--- a/Modules/_struct.c
+++ b/Modules/_struct.c
@@ -214,6 +214,8 @@ get_ulonglong(PyObject *v, unsigned PY_LONG_LONG *p)
 /* Helper routine to get a Python integer and raise the appropriate error
    if it isn't one */
 
+#define INT_OVERFLOW "struct integer overflow masking is deprecated"
+
 static int
 get_wrapped_long(PyObject *v, long *p)
 {
@@ -223,7 +225,7 @@ get_wrapped_long(PyObject *v, long *p)
                        PyObject *wrapped;
                        long x;
                        PyErr_Clear();
-                       if (PyErr_Warn(PyExc_DeprecationWarning, "struct integer overflow masking is deprecated") < 0)
+                       if (PyErr_WarnEx(PyExc_DeprecationWarning, INT_OVERFLOW, 2) < 0)
                                return -1;
                        wrapped = PyNumber_And(v, pylong_ulong_mask);
                        if (wrapped == NULL)
@@ -250,7 +252,7 @@ get_wrapped_ulong(PyObject *v, unsigned long *p)
                wrapped = PyNumber_And(v, pylong_ulong_mask);
                if (wrapped == NULL)
                        return -1;
-               if (PyErr_Warn(PyExc_DeprecationWarning, "struct integer overflow masking is deprecated") < 0) {
+               if (PyErr_WarnEx(PyExc_DeprecationWarning, INT_OVERFLOW, 2) < 0) {
                        Py_DECREF(wrapped);
                        return -1;
                }
@@ -345,8 +347,8 @@ _range_error(const formatdef *f, int is_unsigned)
                Py_XDECREF(ptraceback);
                if (msg == NULL)
                        return -1;
-               rval = PyErr_Warn(PyExc_DeprecationWarning,
-                                 PyString_AS_STRING(msg));
+               rval = PyErr_WarnEx(PyExc_DeprecationWarning,
+                                   PyString_AS_STRING(msg), 2);
                Py_DECREF(msg);
                if (rval == 0)
                        return 0;

diff --git a/Python/errors.c b/Python/errors.c
index 56463a30a07035056a82493611f803ea16e5b917..43d89bd9c8076c416e6110ee6f48a4c01528c5a5 100644 (file)
--- a/Python/errors.c
+++ b/Python/errors.c
@@ -632,7 +632,7 @@ extern PyObject *PyModule_GetWarningsModule(void);
 
 /* Function to issue a warning message; may raise an exception. */
 int
-PyErr_Warn(PyObject *category, char *message)
+PyErr_WarnEx(PyObject *category, const char *message, Py_ssize_t stack_level)
 {
        PyObject *dict, *func = NULL;
        PyObject *warnings_module = PyModule_GetWarningsModule();
@@ -650,7 +650,8 @@ PyErr_Warn(PyObject *category, char *message)
 
                if (category == NULL)
                        category = PyExc_RuntimeWarning;
-               res = PyObject_CallFunction(func, "sO", message, category);
+               res = PyObject_CallFunction(func, "sOn",
+                                           message, category, stack_level);
                if (res == NULL)
                        return -1;
                Py_DECREF(res);
@@ -658,6 +659,16 @@ PyErr_Warn(PyObject *category, char *message)
        }
 }
 
+/* PyErr_Warn is only for backwards compatability and will be removed.
+   Use PyErr_WarnEx instead. */
+
+#undef PyErr_Warn
+
+int
+PyErr_Warn(PyObject *category, char *message)
+{
+       return PyErr_WarnEx(category, message, 1);
+}
 
 /* Warning with explicit origin */
 int