mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-08 18:01:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Add documentation for the new PyErr_SetFromImport* functions

Browse source
This commit is contained in:
Brian Curtin 2012-04-16 15:14:36 -05:00
parent 22a1d17bb5
commit bd43974037
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/c-api/exceptions.rst
View 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)