]> granicus.if.org Git - python/commitdiff
Add documentation for the new PyErr_SetFromImport* functions
authorBrian Curtin <brian@python.org>
Mon, 16 Apr 2012 20:14:36 +0000 (15:14 -0500)
committerBrian Curtin <brian@python.org>
Mon, 16 Apr 2012 20:14:36 +0000 (15:14 -0500)
Doc/c-api/exceptions.rst

index fd7aee746030a9111f57b106bc634e26a2d12a65..983901ad7f0d31e8ec43dffaa86f43d10ce2961a 100644 (file)
@@ -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)