summaryrefslogtreecommitdiffstats
path: root/Doc/api/exceptions.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/api/exceptions.tex')
-rw-r--r--Doc/api/exceptions.tex18
1 files changed, 16 insertions, 2 deletions
diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 6dbe818..2a9db54 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -256,10 +256,14 @@ error indicator for each thread.
argument. It is mostly for internal use.
\end{cfuncdesc}
-\begin{cfuncdesc}{int}{PyErr_Warn}{PyObject *category, char *message}
+\begin{cfuncdesc}{int}{PyErr_WarnEx}{PyObject *category, char *message, int stacklevel}
Issue a warning message. The \var{category} argument is a warning
category (see below) or \NULL; the \var{message} argument is a
- message string.
+ message string. \var{stacklevel} is a positive number giving a
+ number of stack frames; the warning will be issued from the
+ currently executing line of code in that stack frame. A \var{stacklevel}
+ of 1 is the function calling \cfunction{PyErr_WarnEx()}, 2 is
+ the function above that, and so forth.
This function normally prints a warning message to \var{sys.stderr};
however, it is also possible that the user has specified that
@@ -291,6 +295,16 @@ error indicator for each thread.
command line documentation. There is no C API for warning control.
\end{cfuncdesc}
+\begin{cfuncdesc}{int}{PyErr_Warn}{PyObject *category, char *message}
+ Issue a warning message. The \var{category} argument is a warning
+ category (see below) or \NULL; the \var{message} argument is a
+ message string. The warning will appear to be issued from the function
+ calling \cfunction{PyErr_Warn()}, equivalent to calling
+ \cfunction{PyErr_WarnEx()} with a \var{stacklevel} of 1.
+
+ Deprecated; use \cfunction{PyErr_WarnEx()} instead.
+\end{cfuncdesc}
+
\begin{cfuncdesc}{int}{PyErr_WarnExplicit}{PyObject *category,
const char *message, const char *filename, int lineno,
const char *module, PyObject *registry}