1993-07-28 09:05:47 +00:00
|
|
|
#ifndef Py_ERRORS_H
|
|
|
|
#define Py_ERRORS_H
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
1991-02-19 12:39:46 +00:00
|
|
|
/***********************************************************
|
1995-01-04 19:06:22 +00:00
|
|
|
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
|
|
|
|
The Netherlands.
|
1991-02-19 12:39:46 +00:00
|
|
|
|
|
|
|
All Rights Reserved
|
|
|
|
|
1996-10-25 14:44:06 +00:00
|
|
|
Permission to use, copy, modify, and distribute this software and its
|
|
|
|
documentation for any purpose and without fee is hereby granted,
|
1991-02-19 12:39:46 +00:00
|
|
|
provided that the above copyright notice appear in all copies and that
|
1996-10-25 14:44:06 +00:00
|
|
|
both that copyright notice and this permission notice appear in
|
1991-02-19 12:39:46 +00:00
|
|
|
supporting documentation, and that the names of Stichting Mathematisch
|
1996-10-25 14:44:06 +00:00
|
|
|
Centrum or CWI or Corporation for National Research Initiatives or
|
|
|
|
CNRI not be used in advertising or publicity pertaining to
|
|
|
|
distribution of the software without specific, written prior
|
|
|
|
permission.
|
|
|
|
|
|
|
|
While CWI is the initial source for this software, a modified version
|
|
|
|
is made available by the Corporation for National Research Initiatives
|
|
|
|
(CNRI) at the Internet address ftp://ftp.python.org.
|
|
|
|
|
|
|
|
STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
|
|
|
|
REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
|
|
|
|
CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
|
|
|
|
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
|
|
|
|
PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
|
|
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
|
|
PERFORMANCE OF THIS SOFTWARE.
|
1991-02-19 12:39:46 +00:00
|
|
|
|
|
|
|
******************************************************************/
|
|
|
|
|
1990-10-14 12:07:46 +00:00
|
|
|
/* Error handling definitions */
|
|
|
|
|
1998-12-04 18:48:25 +00:00
|
|
|
DL_IMPORT(void) PyErr_SetNone Py_PROTO((PyObject *));
|
|
|
|
DL_IMPORT(void) PyErr_SetObject Py_PROTO((PyObject *, PyObject *));
|
|
|
|
DL_IMPORT(void) PyErr_SetString Py_PROTO((PyObject *, const char *));
|
|
|
|
DL_IMPORT(PyObject *) PyErr_Occurred Py_PROTO((void));
|
|
|
|
DL_IMPORT(void) PyErr_Clear Py_PROTO((void));
|
|
|
|
DL_IMPORT(void) PyErr_Fetch Py_PROTO((PyObject **, PyObject **, PyObject **));
|
|
|
|
DL_IMPORT(void) PyErr_Restore Py_PROTO((PyObject *, PyObject *, PyObject *));
|
1990-10-14 12:07:46 +00:00
|
|
|
|
Three new C API functions:
- int PyErr_GivenExceptionMatches(obj1, obj2)
Returns 1 if obj1 and obj2 are the same object, or if obj1 is an
instance of type obj2, or of a class derived from obj2
- int PyErr_ExceptionMatches(obj)
Higher level wrapper around PyErr_GivenExceptionMatches() which uses
PyErr_Occurred() as obj1. This will be the more commonly called
function.
- void PyErr_NormalizeException(typeptr, valptr, tbptr)
Normalizes exceptions, and places the normalized values in the
arguments. If type is not a class, this does nothing. If type is a
class, then it makes sure that value is an instance of the class by:
1. if instance is of the type, or a class derived from type, it does
nothing.
2. otherwise it instantiates the class, using the value as an
argument. If value is None, it uses an empty arg tuple, and if
the value is a tuple, it uses just that.
1997-08-22 21:22:58 +00:00
|
|
|
/* Error testing and normalization */
|
1998-12-04 18:48:25 +00:00
|
|
|
DL_IMPORT(int) PyErr_GivenExceptionMatches Py_PROTO((PyObject *, PyObject *));
|
|
|
|
DL_IMPORT(int) PyErr_ExceptionMatches Py_PROTO((PyObject *));
|
|
|
|
DL_IMPORT(void) PyErr_NormalizeException Py_PROTO((PyObject**, PyObject**, PyObject**));
|
Three new C API functions:
- int PyErr_GivenExceptionMatches(obj1, obj2)
Returns 1 if obj1 and obj2 are the same object, or if obj1 is an
instance of type obj2, or of a class derived from obj2
- int PyErr_ExceptionMatches(obj)
Higher level wrapper around PyErr_GivenExceptionMatches() which uses
PyErr_Occurred() as obj1. This will be the more commonly called
function.
- void PyErr_NormalizeException(typeptr, valptr, tbptr)
Normalizes exceptions, and places the normalized values in the
arguments. If type is not a class, this does nothing. If type is a
class, then it makes sure that value is an instance of the class by:
1. if instance is of the type, or a class derived from type, it does
nothing.
2. otherwise it instantiates the class, using the value as an
argument. If value is None, it uses an empty arg tuple, and if
the value is a tuple, it uses just that.
1997-08-22 21:22:58 +00:00
|
|
|
|
|
|
|
|
1990-12-20 15:06:42 +00:00
|
|
|
/* Predefined exceptions */
|
1990-10-14 20:00:25 +00:00
|
|
|
|
1997-09-16 18:43:15 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_Exception;
|
1997-08-29 21:56:07 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_StandardError;
|
1997-09-16 21:50:36 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_ArithmeticError;
|
1997-08-29 21:56:07 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_LookupError;
|
|
|
|
|
1997-04-02 05:22:53 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_AssertionError;
|
1995-02-27 10:17:52 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_AttributeError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_EOFError;
|
1997-02-14 22:53:12 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_FloatingPointError;
|
1998-07-23 15:57:34 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_EnvironmentError;
|
1995-02-27 10:17:52 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_IOError;
|
1998-07-23 15:57:34 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_OSError;
|
1995-02-27 10:17:52 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_ImportError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_IndexError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_KeyError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_KeyboardInterrupt;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_MemoryError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_NameError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_OverflowError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_RuntimeError;
|
1998-12-01 18:34:01 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_NotImplementedError;
|
1995-02-27 10:17:52 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_SyntaxError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_SystemError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_SystemExit;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_TypeError;
|
Patch by Tim Peters:
Introduce a new builtin exception, UnboundLocalError, raised when ceval.c
tries to retrieve or delete a local name that isn't bound to a value.
Currently raises NameError, which makes this behavior a FAQ since the same
error is raised for "missing" global names too: when the user has a global
of the same name as the unbound local, NameError makes no sense to them.
Even in the absence of shadowing, knowing whether a bogus name is local or
global is a real aid to quick understanding.
Example:
D:\src\PCbuild>type local.py
x = 42
def f():
print x
x = 13
return x
f()
D:\src\PCbuild>python local.py
Traceback (innermost last):
File "local.py", line 8, in ?
f()
File "local.py", line 4, in f
print x
UnboundLocalError: x
D:\src\PCbuild>
Note that UnboundLocalError is a subclass of NameError, for compatibility
with existing class-exception code that may be trying to catch this as a
NameError. Unfortunately, I see no way to make this wholly compatible
with -X (see comments in bltinmodule.c): under -X, [UnboundLocalError
is an alias for NameError --GvR].
[The ceval.c patch differs slightly from the second version that Tim
submitted; I decided not to raise UnboundLocalError for DELETE_NAME,
only for DELETE_LOCAL. DELETE_NAME is only generated at the module
level, and since at that level a NameError is raised for referencing
an undefined name, it should also be raised for deleting one.]
1999-06-22 14:47:32 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_UnboundLocalError;
|
1995-02-27 10:17:52 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_ValueError;
|
|
|
|
extern DL_IMPORT(PyObject *) PyExc_ZeroDivisionError;
|
1990-10-21 22:09:30 +00:00
|
|
|
|
1997-08-29 21:56:07 +00:00
|
|
|
extern DL_IMPORT(PyObject *) PyExc_MemoryErrorInst;
|
|
|
|
|
|
|
|
|
1990-10-14 20:00:25 +00:00
|
|
|
/* Convenience functions */
|
|
|
|
|
1998-12-04 18:48:25 +00:00
|
|
|
extern DL_IMPORT(int) PyErr_BadArgument Py_PROTO((void));
|
|
|
|
extern DL_IMPORT(PyObject *) PyErr_NoMemory Py_PROTO((void));
|
|
|
|
extern DL_IMPORT(PyObject *) PyErr_SetFromErrno Py_PROTO((PyObject *));
|
|
|
|
extern DL_IMPORT(PyObject *) PyErr_SetFromErrnoWithFilename Py_PROTO((PyObject *, char *));
|
|
|
|
extern DL_IMPORT(PyObject *) PyErr_Format Py_PROTO((PyObject *, const char *, ...));
|
1990-10-21 22:09:30 +00:00
|
|
|
|
1998-12-04 18:48:25 +00:00
|
|
|
extern DL_IMPORT(void) PyErr_BadInternalCall Py_PROTO((void));
|
1993-05-19 14:50:45 +00:00
|
|
|
|
1997-09-16 21:50:37 +00:00
|
|
|
/* Function to create a new exception */
|
1998-12-04 18:48:25 +00:00
|
|
|
DL_IMPORT(PyObject *) PyErr_NewException Py_PROTO((char *name, PyObject *base,
|
1997-09-16 21:50:37 +00:00
|
|
|
PyObject *dict));
|
|
|
|
|
1997-01-03 00:15:03 +00:00
|
|
|
/* In sigcheck.c or signalmodule.c */
|
1998-12-04 18:48:25 +00:00
|
|
|
extern DL_IMPORT(int) PyErr_CheckSignals Py_PROTO((void));
|
|
|
|
extern DL_IMPORT(void) PyErr_SetInterrupt Py_PROTO((void));
|
1997-01-03 00:15:03 +00:00
|
|
|
|
1994-08-01 11:34:53 +00:00
|
|
|
|
1993-07-28 09:05:47 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif /* !Py_ERRORS_H */
|