From: Brian Curtin <brian@python.org>
Date: Mon, 16 Apr 2012 20:14:36 +0000 (-0500)
Subject: Add documentation for the new PyErr_SetFromImport* functions
X-Git-Tag: v3.3.0a3~190
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bd4397403783fa9b98f98e15bbb1a39d5710ee04;p=thirdparty%2FPython%2Fcpython.git

Add documentation for the new PyErr_SetFromImport* functions
---

diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index fd7aee746030..983901ad7f0d 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -229,6 +229,24 @@ in various ways.  There is a separate error indicator for each thread.
    Similar to :c:func:`PyErr_SetFromWindowsErrWithFilename`, with an additional
    parameter specifying the exception type to be raised. Availability: Windows.
 
+.. c:function:: PyObject* PyErr_SetExcWithArgsKwargs(PyObject *exc, PyObject *args, PyObject *kwargs)
+
+   This is a convenience function to set an *exc* with the given *args* and
+   *kwargs* values. If *args* is ``NULL``, an empty :func:`tuple` will be
+   created when *exc* is created via :c:func:`PyObject_Call`.
+
+.. c:function:: PyObject* PyErr_SetFromImportErrorWithName(PyObject *msg, PyObject *name)
+
+   This is a convenience function to raise :exc:`ImportError`. *msg* will be
+   set as the exception's message string, and *name* will be set as the
+   :exc:`ImportError`'s ``name`` attribute.
+
+.. c:function:: PyObject* PyErr_SetFromImportErrorWithNameAndPath(PyObject *msg, PyObject *name, PyObject *path)
+
+   This is a convenience function to raise :exc:`ImportError`. *msg* will be
+   set as the exception's message string. Both *name* and *path* will be set
+   as the :exc:`ImportError`'s respective ``name`` and ``path`` attributes.
+
 
 .. c:function:: void PyErr_SyntaxLocationEx(char *filename, int lineno, int col_offset)