mirror of
https://github.com/python/cpython
synced 2024-11-02 14:48:31 +00:00
81c72044a1
We're no longer using _Py_IDENTIFIER() (or _Py_static_string()) in any core CPython code. It is still used in a number of non-builtin stdlib modules. The replacement is: PyUnicodeObject (not pointer) fields under _PyRuntimeState, statically initialized as part of _PyRuntime. A new _Py_GET_GLOBAL_IDENTIFIER() macro facilitates lookup of the fields (along with _Py_GET_GLOBAL_STRING() for non-identifier strings). https://bugs.python.org/issue46541#msg411799 explains the rationale for this change. The core of the change is in: * (new) Include/internal/pycore_global_strings.h - the declarations for the global strings, along with the macros * Include/internal/pycore_runtime_init.h - added the static initializers for the global strings * Include/internal/pycore_global_objects.h - where the struct in pycore_global_strings.h is hooked into _PyRuntimeState * Tools/scripts/generate_global_objects.py - added generation of the global string declarations and static initializers I've also added a --check flag to generate_global_objects.py (along with make check-global-objects) to check for unused global strings. That check is added to the PR CI config. The remainder of this change updates the core code to use _Py_GET_GLOBAL_IDENTIFIER() instead of _Py_IDENTIFIER() and the related _Py*Id functions (likewise for _Py_GET_GLOBAL_STRING() instead of _Py_static_string()). This includes adding a few functions where there wasn't already an alternative to _Py*Id(), replacing the _Py_Identifier * parameter with PyObject *. The following are not changed (yet): * stop using _Py_IDENTIFIER() in the stdlib modules * (maybe) get rid of _Py_IDENTIFIER(), etc. entirely -- this may not be doable as at least one package on PyPI using this (private) API * (maybe) intern the strings during runtime init https://bugs.python.org/issue46541
1817 lines
49 KiB
C
1817 lines
49 KiB
C
|
|
/* Error handling */
|
|
|
|
#include "Python.h"
|
|
#include "pycore_call.h" // _PyObject_CallNoArgs()
|
|
#include "pycore_initconfig.h" // _PyStatus_ERR()
|
|
#include "pycore_pyerrors.h" // _PyErr_Format()
|
|
#include "pycore_pystate.h" // _PyThreadState_GET()
|
|
#include "pycore_structseq.h" // _PyStructSequence_FiniType()
|
|
#include "pycore_sysmodule.h" // _PySys_Audit()
|
|
#include "pycore_traceback.h" // _PyTraceBack_FromFrame()
|
|
|
|
#ifndef __STDC__
|
|
#ifndef MS_WINDOWS
|
|
extern char *strerror(int);
|
|
#endif
|
|
#endif
|
|
|
|
#include <ctype.h>
|
|
#ifdef MS_WINDOWS
|
|
# include <windows.h>
|
|
# include <winbase.h>
|
|
# include <stdlib.h> // _sys_nerr
|
|
#endif
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Forward declarations */
|
|
static PyObject *
|
|
_PyErr_FormatV(PyThreadState *tstate, PyObject *exception,
|
|
const char *format, va_list vargs);
|
|
|
|
|
|
void
|
|
_PyErr_Restore(PyThreadState *tstate, PyObject *type, PyObject *value,
|
|
PyObject *traceback)
|
|
{
|
|
PyObject *oldtype, *oldvalue, *oldtraceback;
|
|
|
|
if (traceback != NULL && !PyTraceBack_Check(traceback)) {
|
|
/* XXX Should never happen -- fatal error instead? */
|
|
/* Well, it could be None. */
|
|
Py_DECREF(traceback);
|
|
traceback = NULL;
|
|
}
|
|
|
|
/* Save these in locals to safeguard against recursive
|
|
invocation through Py_XDECREF */
|
|
oldtype = tstate->curexc_type;
|
|
oldvalue = tstate->curexc_value;
|
|
oldtraceback = tstate->curexc_traceback;
|
|
|
|
tstate->curexc_type = type;
|
|
tstate->curexc_value = value;
|
|
tstate->curexc_traceback = traceback;
|
|
|
|
Py_XDECREF(oldtype);
|
|
Py_XDECREF(oldvalue);
|
|
Py_XDECREF(oldtraceback);
|
|
}
|
|
|
|
void
|
|
PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_Restore(tstate, type, value, traceback);
|
|
}
|
|
|
|
|
|
_PyErr_StackItem *
|
|
_PyErr_GetTopmostException(PyThreadState *tstate)
|
|
{
|
|
_PyErr_StackItem *exc_info = tstate->exc_info;
|
|
assert(exc_info);
|
|
|
|
while ((exc_info->exc_value == NULL || exc_info->exc_value == Py_None) &&
|
|
exc_info->previous_item != NULL)
|
|
{
|
|
exc_info = exc_info->previous_item;
|
|
}
|
|
return exc_info;
|
|
}
|
|
|
|
static PyObject*
|
|
_PyErr_CreateException(PyObject *exception_type, PyObject *value)
|
|
{
|
|
PyObject *exc;
|
|
|
|
if (value == NULL || value == Py_None) {
|
|
exc = _PyObject_CallNoArgs(exception_type);
|
|
}
|
|
else if (PyTuple_Check(value)) {
|
|
exc = PyObject_Call(exception_type, value, NULL);
|
|
}
|
|
else {
|
|
exc = PyObject_CallOneArg(exception_type, value);
|
|
}
|
|
|
|
if (exc != NULL && !PyExceptionInstance_Check(exc)) {
|
|
PyErr_Format(PyExc_TypeError,
|
|
"calling %R should have returned an instance of "
|
|
"BaseException, not %s",
|
|
exception_type, Py_TYPE(exc)->tp_name);
|
|
Py_CLEAR(exc);
|
|
}
|
|
|
|
return exc;
|
|
}
|
|
|
|
void
|
|
_PyErr_SetObject(PyThreadState *tstate, PyObject *exception, PyObject *value)
|
|
{
|
|
PyObject *exc_value;
|
|
PyObject *tb = NULL;
|
|
|
|
if (exception != NULL &&
|
|
!PyExceptionClass_Check(exception)) {
|
|
_PyErr_Format(tstate, PyExc_SystemError,
|
|
"_PyErr_SetObject: "
|
|
"exception %R is not a BaseException subclass",
|
|
exception);
|
|
return;
|
|
}
|
|
|
|
Py_XINCREF(value);
|
|
exc_value = _PyErr_GetTopmostException(tstate)->exc_value;
|
|
if (exc_value != NULL && exc_value != Py_None) {
|
|
/* Implicit exception chaining */
|
|
Py_INCREF(exc_value);
|
|
if (value == NULL || !PyExceptionInstance_Check(value)) {
|
|
/* We must normalize the value right now */
|
|
PyObject *fixed_value;
|
|
|
|
/* Issue #23571: functions must not be called with an
|
|
exception set */
|
|
_PyErr_Clear(tstate);
|
|
|
|
fixed_value = _PyErr_CreateException(exception, value);
|
|
Py_XDECREF(value);
|
|
if (fixed_value == NULL) {
|
|
Py_DECREF(exc_value);
|
|
return;
|
|
}
|
|
|
|
value = fixed_value;
|
|
}
|
|
|
|
/* Avoid creating new reference cycles through the
|
|
context chain, while taking care not to hang on
|
|
pre-existing ones.
|
|
This is O(chain length) but context chains are
|
|
usually very short. Sensitive readers may try
|
|
to inline the call to PyException_GetContext. */
|
|
if (exc_value != value) {
|
|
PyObject *o = exc_value, *context;
|
|
PyObject *slow_o = o; /* Floyd's cycle detection algo */
|
|
int slow_update_toggle = 0;
|
|
while ((context = PyException_GetContext(o))) {
|
|
Py_DECREF(context);
|
|
if (context == value) {
|
|
PyException_SetContext(o, NULL);
|
|
break;
|
|
}
|
|
o = context;
|
|
if (o == slow_o) {
|
|
/* pre-existing cycle - all exceptions on the
|
|
path were visited and checked. */
|
|
break;
|
|
}
|
|
if (slow_update_toggle) {
|
|
slow_o = PyException_GetContext(slow_o);
|
|
Py_DECREF(slow_o);
|
|
}
|
|
slow_update_toggle = !slow_update_toggle;
|
|
}
|
|
PyException_SetContext(value, exc_value);
|
|
}
|
|
else {
|
|
Py_DECREF(exc_value);
|
|
}
|
|
}
|
|
if (value != NULL && PyExceptionInstance_Check(value))
|
|
tb = PyException_GetTraceback(value);
|
|
Py_XINCREF(exception);
|
|
_PyErr_Restore(tstate, exception, value, tb);
|
|
}
|
|
|
|
void
|
|
PyErr_SetObject(PyObject *exception, PyObject *value)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_SetObject(tstate, exception, value);
|
|
}
|
|
|
|
/* Set a key error with the specified argument, wrapping it in a
|
|
* tuple automatically so that tuple keys are not unpacked as the
|
|
* exception arguments. */
|
|
void
|
|
_PyErr_SetKeyError(PyObject *arg)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
PyObject *tup = PyTuple_Pack(1, arg);
|
|
if (!tup) {
|
|
/* caller will expect error to be set anyway */
|
|
return;
|
|
}
|
|
_PyErr_SetObject(tstate, PyExc_KeyError, tup);
|
|
Py_DECREF(tup);
|
|
}
|
|
|
|
void
|
|
_PyErr_SetNone(PyThreadState *tstate, PyObject *exception)
|
|
{
|
|
_PyErr_SetObject(tstate, exception, (PyObject *)NULL);
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_SetNone(PyObject *exception)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_SetNone(tstate, exception);
|
|
}
|
|
|
|
|
|
void
|
|
_PyErr_SetString(PyThreadState *tstate, PyObject *exception,
|
|
const char *string)
|
|
{
|
|
PyObject *value = PyUnicode_FromString(string);
|
|
_PyErr_SetObject(tstate, exception, value);
|
|
Py_XDECREF(value);
|
|
}
|
|
|
|
void
|
|
PyErr_SetString(PyObject *exception, const char *string)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_SetString(tstate, exception, string);
|
|
}
|
|
|
|
|
|
PyObject* _Py_HOT_FUNCTION
|
|
PyErr_Occurred(void)
|
|
{
|
|
/* The caller must hold the GIL. */
|
|
assert(PyGILState_Check());
|
|
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
return _PyErr_Occurred(tstate);
|
|
}
|
|
|
|
|
|
int
|
|
PyErr_GivenExceptionMatches(PyObject *err, PyObject *exc)
|
|
{
|
|
if (err == NULL || exc == NULL) {
|
|
/* maybe caused by "import exceptions" that failed early on */
|
|
return 0;
|
|
}
|
|
if (PyTuple_Check(exc)) {
|
|
Py_ssize_t i, n;
|
|
n = PyTuple_Size(exc);
|
|
for (i = 0; i < n; i++) {
|
|
/* Test recursively */
|
|
if (PyErr_GivenExceptionMatches(
|
|
err, PyTuple_GET_ITEM(exc, i)))
|
|
{
|
|
return 1;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
/* err might be an instance, so check its class. */
|
|
if (PyExceptionInstance_Check(err))
|
|
err = PyExceptionInstance_Class(err);
|
|
|
|
if (PyExceptionClass_Check(err) && PyExceptionClass_Check(exc)) {
|
|
return PyType_IsSubtype((PyTypeObject *)err, (PyTypeObject *)exc);
|
|
}
|
|
|
|
return err == exc;
|
|
}
|
|
|
|
|
|
int
|
|
_PyErr_ExceptionMatches(PyThreadState *tstate, PyObject *exc)
|
|
{
|
|
return PyErr_GivenExceptionMatches(_PyErr_Occurred(tstate), exc);
|
|
}
|
|
|
|
|
|
int
|
|
PyErr_ExceptionMatches(PyObject *exc)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
return _PyErr_ExceptionMatches(tstate, exc);
|
|
}
|
|
|
|
|
|
#ifndef Py_NORMALIZE_RECURSION_LIMIT
|
|
#define Py_NORMALIZE_RECURSION_LIMIT 32
|
|
#endif
|
|
|
|
/* Used in many places to normalize a raised exception, including in
|
|
eval_code2(), do_raise(), and PyErr_Print()
|
|
|
|
XXX: should PyErr_NormalizeException() also call
|
|
PyException_SetTraceback() with the resulting value and tb?
|
|
*/
|
|
void
|
|
_PyErr_NormalizeException(PyThreadState *tstate, PyObject **exc,
|
|
PyObject **val, PyObject **tb)
|
|
{
|
|
int recursion_depth = 0;
|
|
tstate->recursion_headroom++;
|
|
PyObject *type, *value, *initial_tb;
|
|
|
|
restart:
|
|
type = *exc;
|
|
if (type == NULL) {
|
|
/* There was no exception, so nothing to do. */
|
|
tstate->recursion_headroom--;
|
|
return;
|
|
}
|
|
|
|
value = *val;
|
|
/* If PyErr_SetNone() was used, the value will have been actually
|
|
set to NULL.
|
|
*/
|
|
if (!value) {
|
|
value = Py_None;
|
|
Py_INCREF(value);
|
|
}
|
|
|
|
/* Normalize the exception so that if the type is a class, the
|
|
value will be an instance.
|
|
*/
|
|
if (PyExceptionClass_Check(type)) {
|
|
PyObject *inclass = NULL;
|
|
int is_subclass = 0;
|
|
|
|
if (PyExceptionInstance_Check(value)) {
|
|
inclass = PyExceptionInstance_Class(value);
|
|
is_subclass = PyObject_IsSubclass(inclass, type);
|
|
if (is_subclass < 0) {
|
|
goto error;
|
|
}
|
|
}
|
|
|
|
/* If the value was not an instance, or is not an instance
|
|
whose class is (or is derived from) type, then use the
|
|
value as an argument to instantiation of the type
|
|
class.
|
|
*/
|
|
if (!is_subclass) {
|
|
PyObject *fixed_value = _PyErr_CreateException(type, value);
|
|
if (fixed_value == NULL) {
|
|
goto error;
|
|
}
|
|
Py_DECREF(value);
|
|
value = fixed_value;
|
|
}
|
|
/* If the class of the instance doesn't exactly match the
|
|
class of the type, believe the instance.
|
|
*/
|
|
else if (inclass != type) {
|
|
Py_INCREF(inclass);
|
|
Py_DECREF(type);
|
|
type = inclass;
|
|
}
|
|
}
|
|
*exc = type;
|
|
*val = value;
|
|
tstate->recursion_headroom--;
|
|
return;
|
|
|
|
error:
|
|
Py_DECREF(type);
|
|
Py_DECREF(value);
|
|
recursion_depth++;
|
|
if (recursion_depth == Py_NORMALIZE_RECURSION_LIMIT) {
|
|
_PyErr_SetString(tstate, PyExc_RecursionError,
|
|
"maximum recursion depth exceeded "
|
|
"while normalizing an exception");
|
|
}
|
|
/* If the new exception doesn't set a traceback and the old
|
|
exception had a traceback, use the old traceback for the
|
|
new exception. It's better than nothing.
|
|
*/
|
|
initial_tb = *tb;
|
|
_PyErr_Fetch(tstate, exc, val, tb);
|
|
assert(*exc != NULL);
|
|
if (initial_tb != NULL) {
|
|
if (*tb == NULL)
|
|
*tb = initial_tb;
|
|
else
|
|
Py_DECREF(initial_tb);
|
|
}
|
|
/* Abort when Py_NORMALIZE_RECURSION_LIMIT has been exceeded, and the
|
|
corresponding RecursionError could not be normalized, and the
|
|
MemoryError raised when normalize this RecursionError could not be
|
|
normalized. */
|
|
if (recursion_depth >= Py_NORMALIZE_RECURSION_LIMIT + 2) {
|
|
if (PyErr_GivenExceptionMatches(*exc, PyExc_MemoryError)) {
|
|
Py_FatalError("Cannot recover from MemoryErrors "
|
|
"while normalizing exceptions.");
|
|
}
|
|
else {
|
|
Py_FatalError("Cannot recover from the recursive normalization "
|
|
"of an exception.");
|
|
}
|
|
}
|
|
goto restart;
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_NormalizeException(PyObject **exc, PyObject **val, PyObject **tb)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_NormalizeException(tstate, exc, val, tb);
|
|
}
|
|
|
|
|
|
void
|
|
_PyErr_Fetch(PyThreadState *tstate, PyObject **p_type, PyObject **p_value,
|
|
PyObject **p_traceback)
|
|
{
|
|
*p_type = tstate->curexc_type;
|
|
*p_value = tstate->curexc_value;
|
|
*p_traceback = tstate->curexc_traceback;
|
|
|
|
tstate->curexc_type = NULL;
|
|
tstate->curexc_value = NULL;
|
|
tstate->curexc_traceback = NULL;
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_Fetch(PyObject **p_type, PyObject **p_value, PyObject **p_traceback)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_Fetch(tstate, p_type, p_value, p_traceback);
|
|
}
|
|
|
|
|
|
void
|
|
_PyErr_Clear(PyThreadState *tstate)
|
|
{
|
|
_PyErr_Restore(tstate, NULL, NULL, NULL);
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_Clear(void)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
|
|
static PyObject*
|
|
get_exc_type(PyObject *exc_value) /* returns a borrowed ref */
|
|
{
|
|
if (exc_value == NULL || exc_value == Py_None) {
|
|
return Py_None;
|
|
}
|
|
else {
|
|
assert(PyExceptionInstance_Check(exc_value));
|
|
PyObject *type = PyExceptionInstance_Class(exc_value);
|
|
assert(type != NULL);
|
|
return type;
|
|
}
|
|
}
|
|
|
|
static PyObject*
|
|
get_exc_traceback(PyObject *exc_value) /* returns a borrowed ref */
|
|
{
|
|
if (exc_value == NULL || exc_value == Py_None) {
|
|
return Py_None;
|
|
}
|
|
else {
|
|
assert(PyExceptionInstance_Check(exc_value));
|
|
PyObject *tb = PyException_GetTraceback(exc_value);
|
|
Py_XDECREF(tb);
|
|
return tb ? tb : Py_None;
|
|
}
|
|
}
|
|
|
|
void
|
|
_PyErr_GetExcInfo(PyThreadState *tstate,
|
|
PyObject **p_type, PyObject **p_value, PyObject **p_traceback)
|
|
{
|
|
_PyErr_StackItem *exc_info = _PyErr_GetTopmostException(tstate);
|
|
|
|
*p_type = get_exc_type(exc_info->exc_value);
|
|
*p_value = exc_info->exc_value;
|
|
*p_traceback = get_exc_traceback(exc_info->exc_value);
|
|
|
|
Py_XINCREF(*p_type);
|
|
Py_XINCREF(*p_value);
|
|
Py_XINCREF(*p_traceback);
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_GetExcInfo(PyObject **p_type, PyObject **p_value, PyObject **p_traceback)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_GetExcInfo(tstate, p_type, p_value, p_traceback);
|
|
}
|
|
|
|
void
|
|
PyErr_SetExcInfo(PyObject *type, PyObject *value, PyObject *traceback)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
|
|
PyObject *oldvalue = tstate->exc_info->exc_value;
|
|
|
|
tstate->exc_info->exc_value = value;
|
|
|
|
/* These args are no longer used, but we still need to steal a ref */
|
|
Py_XDECREF(type);
|
|
Py_XDECREF(traceback);
|
|
|
|
Py_XDECREF(oldvalue);
|
|
}
|
|
|
|
|
|
PyObject*
|
|
_PyErr_StackItemToExcInfoTuple(_PyErr_StackItem *err_info)
|
|
{
|
|
PyObject *exc_value = err_info->exc_value;
|
|
|
|
assert(exc_value == NULL ||
|
|
exc_value == Py_None ||
|
|
PyExceptionInstance_Check(exc_value));
|
|
|
|
PyObject *exc_type = get_exc_type(exc_value);
|
|
PyObject *exc_traceback = get_exc_traceback(exc_value);
|
|
|
|
return Py_BuildValue(
|
|
"(OOO)",
|
|
exc_type ? exc_type : Py_None,
|
|
exc_value ? exc_value : Py_None,
|
|
exc_traceback ? exc_traceback : Py_None);
|
|
}
|
|
|
|
|
|
/* Like PyErr_Restore(), but if an exception is already set,
|
|
set the context associated with it.
|
|
|
|
The caller is responsible for ensuring that this call won't create
|
|
any cycles in the exception context chain. */
|
|
void
|
|
_PyErr_ChainExceptions(PyObject *typ, PyObject *val, PyObject *tb)
|
|
{
|
|
if (typ == NULL)
|
|
return;
|
|
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
|
|
if (!PyExceptionClass_Check(typ)) {
|
|
_PyErr_Format(tstate, PyExc_SystemError,
|
|
"_PyErr_ChainExceptions: "
|
|
"exception %R is not a BaseException subclass",
|
|
typ);
|
|
return;
|
|
}
|
|
|
|
if (_PyErr_Occurred(tstate)) {
|
|
PyObject *typ2, *val2, *tb2;
|
|
_PyErr_Fetch(tstate, &typ2, &val2, &tb2);
|
|
_PyErr_NormalizeException(tstate, &typ, &val, &tb);
|
|
if (tb != NULL) {
|
|
PyException_SetTraceback(val, tb);
|
|
Py_DECREF(tb);
|
|
}
|
|
Py_DECREF(typ);
|
|
_PyErr_NormalizeException(tstate, &typ2, &val2, &tb2);
|
|
PyException_SetContext(val2, val);
|
|
_PyErr_Restore(tstate, typ2, val2, tb2);
|
|
}
|
|
else {
|
|
_PyErr_Restore(tstate, typ, val, tb);
|
|
}
|
|
}
|
|
|
|
/* Set the currently set exception's context to the given exception.
|
|
|
|
If the provided exc_info is NULL, then the current Python thread state's
|
|
exc_info will be used for the context instead.
|
|
|
|
This function can only be called when _PyErr_Occurred() is true.
|
|
Also, this function won't create any cycles in the exception context
|
|
chain to the extent that _PyErr_SetObject ensures this. */
|
|
void
|
|
_PyErr_ChainStackItem(_PyErr_StackItem *exc_info)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
assert(_PyErr_Occurred(tstate));
|
|
|
|
int exc_info_given;
|
|
if (exc_info == NULL) {
|
|
exc_info_given = 0;
|
|
exc_info = tstate->exc_info;
|
|
} else {
|
|
exc_info_given = 1;
|
|
}
|
|
|
|
if (exc_info->exc_value == NULL || exc_info->exc_value == Py_None) {
|
|
return;
|
|
}
|
|
|
|
_PyErr_StackItem *saved_exc_info;
|
|
if (exc_info_given) {
|
|
/* Temporarily set the thread state's exc_info since this is what
|
|
_PyErr_SetObject uses for implicit exception chaining. */
|
|
saved_exc_info = tstate->exc_info;
|
|
tstate->exc_info = exc_info;
|
|
}
|
|
|
|
PyObject *typ, *val, *tb;
|
|
_PyErr_Fetch(tstate, &typ, &val, &tb);
|
|
|
|
/* _PyErr_SetObject sets the context from PyThreadState. */
|
|
_PyErr_SetObject(tstate, typ, val);
|
|
Py_DECREF(typ); // since _PyErr_Occurred was true
|
|
Py_XDECREF(val);
|
|
Py_XDECREF(tb);
|
|
|
|
if (exc_info_given) {
|
|
tstate->exc_info = saved_exc_info;
|
|
}
|
|
}
|
|
|
|
static PyObject *
|
|
_PyErr_FormatVFromCause(PyThreadState *tstate, PyObject *exception,
|
|
const char *format, va_list vargs)
|
|
{
|
|
PyObject *exc, *val, *val2, *tb;
|
|
|
|
assert(_PyErr_Occurred(tstate));
|
|
_PyErr_Fetch(tstate, &exc, &val, &tb);
|
|
_PyErr_NormalizeException(tstate, &exc, &val, &tb);
|
|
if (tb != NULL) {
|
|
PyException_SetTraceback(val, tb);
|
|
Py_DECREF(tb);
|
|
}
|
|
Py_DECREF(exc);
|
|
assert(!_PyErr_Occurred(tstate));
|
|
|
|
_PyErr_FormatV(tstate, exception, format, vargs);
|
|
|
|
_PyErr_Fetch(tstate, &exc, &val2, &tb);
|
|
_PyErr_NormalizeException(tstate, &exc, &val2, &tb);
|
|
Py_INCREF(val);
|
|
PyException_SetCause(val2, val);
|
|
PyException_SetContext(val2, val);
|
|
_PyErr_Restore(tstate, exc, val2, tb);
|
|
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
_PyErr_FormatFromCauseTstate(PyThreadState *tstate, PyObject *exception,
|
|
const char *format, ...)
|
|
{
|
|
va_list vargs;
|
|
#ifdef HAVE_STDARG_PROTOTYPES
|
|
va_start(vargs, format);
|
|
#else
|
|
va_start(vargs);
|
|
#endif
|
|
_PyErr_FormatVFromCause(tstate, exception, format, vargs);
|
|
va_end(vargs);
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
_PyErr_FormatFromCause(PyObject *exception, const char *format, ...)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
va_list vargs;
|
|
#ifdef HAVE_STDARG_PROTOTYPES
|
|
va_start(vargs, format);
|
|
#else
|
|
va_start(vargs);
|
|
#endif
|
|
_PyErr_FormatVFromCause(tstate, exception, format, vargs);
|
|
va_end(vargs);
|
|
return NULL;
|
|
}
|
|
|
|
/* Convenience functions to set a type error exception and return 0 */
|
|
|
|
int
|
|
PyErr_BadArgument(void)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_SetString(tstate, PyExc_TypeError,
|
|
"bad argument type for built-in operation");
|
|
return 0;
|
|
}
|
|
|
|
PyObject *
|
|
_PyErr_NoMemory(PyThreadState *tstate)
|
|
{
|
|
if (Py_IS_TYPE(PyExc_MemoryError, NULL)) {
|
|
/* PyErr_NoMemory() has been called before PyExc_MemoryError has been
|
|
initialized by _PyExc_Init() */
|
|
Py_FatalError("Out of memory and PyExc_MemoryError is not "
|
|
"initialized yet");
|
|
}
|
|
_PyErr_SetNone(tstate, PyExc_MemoryError);
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_NoMemory(void)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
return _PyErr_NoMemory(tstate);
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_SetFromErrnoWithFilenameObject(PyObject *exc, PyObject *filenameObject)
|
|
{
|
|
return PyErr_SetFromErrnoWithFilenameObjects(exc, filenameObject, NULL);
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_SetFromErrnoWithFilenameObjects(PyObject *exc, PyObject *filenameObject, PyObject *filenameObject2)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
PyObject *message;
|
|
PyObject *v, *args;
|
|
int i = errno;
|
|
#ifdef MS_WINDOWS
|
|
WCHAR *s_buf = NULL;
|
|
#endif /* Unix/Windows */
|
|
|
|
#ifdef EINTR
|
|
if (i == EINTR && PyErr_CheckSignals())
|
|
return NULL;
|
|
#endif
|
|
|
|
#ifndef MS_WINDOWS
|
|
if (i != 0) {
|
|
const char *s = strerror(i);
|
|
message = PyUnicode_DecodeLocale(s, "surrogateescape");
|
|
}
|
|
else {
|
|
/* Sometimes errno didn't get set */
|
|
message = PyUnicode_FromString("Error");
|
|
}
|
|
#else
|
|
if (i == 0)
|
|
message = PyUnicode_FromString("Error"); /* Sometimes errno didn't get set */
|
|
else
|
|
{
|
|
/* Note that the Win32 errors do not lineup with the
|
|
errno error. So if the error is in the MSVC error
|
|
table, we use it, otherwise we assume it really _is_
|
|
a Win32 error code
|
|
*/
|
|
if (i > 0 && i < _sys_nerr) {
|
|
message = PyUnicode_FromString(_sys_errlist[i]);
|
|
}
|
|
else {
|
|
int len = FormatMessageW(
|
|
FORMAT_MESSAGE_ALLOCATE_BUFFER |
|
|
FORMAT_MESSAGE_FROM_SYSTEM |
|
|
FORMAT_MESSAGE_IGNORE_INSERTS,
|
|
NULL, /* no message source */
|
|
i,
|
|
MAKELANGID(LANG_NEUTRAL,
|
|
SUBLANG_DEFAULT),
|
|
/* Default language */
|
|
(LPWSTR) &s_buf,
|
|
0, /* size not used */
|
|
NULL); /* no args */
|
|
if (len==0) {
|
|
/* Only ever seen this in out-of-mem
|
|
situations */
|
|
s_buf = NULL;
|
|
message = PyUnicode_FromFormat("Windows Error 0x%x", i);
|
|
} else {
|
|
/* remove trailing cr/lf and dots */
|
|
while (len > 0 && (s_buf[len-1] <= L' ' || s_buf[len-1] == L'.'))
|
|
s_buf[--len] = L'\0';
|
|
message = PyUnicode_FromWideChar(s_buf, len);
|
|
}
|
|
}
|
|
}
|
|
#endif /* Unix/Windows */
|
|
|
|
if (message == NULL)
|
|
{
|
|
#ifdef MS_WINDOWS
|
|
LocalFree(s_buf);
|
|
#endif
|
|
return NULL;
|
|
}
|
|
|
|
if (filenameObject != NULL) {
|
|
if (filenameObject2 != NULL)
|
|
args = Py_BuildValue("(iOOiO)", i, message, filenameObject, 0, filenameObject2);
|
|
else
|
|
args = Py_BuildValue("(iOO)", i, message, filenameObject);
|
|
} else {
|
|
assert(filenameObject2 == NULL);
|
|
args = Py_BuildValue("(iO)", i, message);
|
|
}
|
|
Py_DECREF(message);
|
|
|
|
if (args != NULL) {
|
|
v = PyObject_Call(exc, args, NULL);
|
|
Py_DECREF(args);
|
|
if (v != NULL) {
|
|
_PyErr_SetObject(tstate, (PyObject *) Py_TYPE(v), v);
|
|
Py_DECREF(v);
|
|
}
|
|
}
|
|
#ifdef MS_WINDOWS
|
|
LocalFree(s_buf);
|
|
#endif
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_SetFromErrnoWithFilename(PyObject *exc, const char *filename)
|
|
{
|
|
PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
|
|
PyObject *result = PyErr_SetFromErrnoWithFilenameObjects(exc, name, NULL);
|
|
Py_XDECREF(name);
|
|
return result;
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_SetFromErrno(PyObject *exc)
|
|
{
|
|
return PyErr_SetFromErrnoWithFilenameObjects(exc, NULL, NULL);
|
|
}
|
|
|
|
#ifdef MS_WINDOWS
|
|
/* Windows specific error code handling */
|
|
PyObject *PyErr_SetExcFromWindowsErrWithFilenameObject(
|
|
PyObject *exc,
|
|
int ierr,
|
|
PyObject *filenameObject)
|
|
{
|
|
return PyErr_SetExcFromWindowsErrWithFilenameObjects(exc, ierr,
|
|
filenameObject, NULL);
|
|
}
|
|
|
|
PyObject *PyErr_SetExcFromWindowsErrWithFilenameObjects(
|
|
PyObject *exc,
|
|
int ierr,
|
|
PyObject *filenameObject,
|
|
PyObject *filenameObject2)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
int len;
|
|
WCHAR *s_buf = NULL; /* Free via LocalFree */
|
|
PyObject *message;
|
|
PyObject *args, *v;
|
|
|
|
DWORD err = (DWORD)ierr;
|
|
if (err==0) {
|
|
err = GetLastError();
|
|
}
|
|
|
|
len = FormatMessageW(
|
|
/* Error API error */
|
|
FORMAT_MESSAGE_ALLOCATE_BUFFER |
|
|
FORMAT_MESSAGE_FROM_SYSTEM |
|
|
FORMAT_MESSAGE_IGNORE_INSERTS,
|
|
NULL, /* no message source */
|
|
err,
|
|
MAKELANGID(LANG_NEUTRAL,
|
|
SUBLANG_DEFAULT), /* Default language */
|
|
(LPWSTR) &s_buf,
|
|
0, /* size not used */
|
|
NULL); /* no args */
|
|
if (len==0) {
|
|
/* Only seen this in out of mem situations */
|
|
message = PyUnicode_FromFormat("Windows Error 0x%x", err);
|
|
s_buf = NULL;
|
|
} else {
|
|
/* remove trailing cr/lf and dots */
|
|
while (len > 0 && (s_buf[len-1] <= L' ' || s_buf[len-1] == L'.'))
|
|
s_buf[--len] = L'\0';
|
|
message = PyUnicode_FromWideChar(s_buf, len);
|
|
}
|
|
|
|
if (message == NULL)
|
|
{
|
|
LocalFree(s_buf);
|
|
return NULL;
|
|
}
|
|
|
|
if (filenameObject == NULL) {
|
|
assert(filenameObject2 == NULL);
|
|
filenameObject = filenameObject2 = Py_None;
|
|
}
|
|
else if (filenameObject2 == NULL)
|
|
filenameObject2 = Py_None;
|
|
/* This is the constructor signature for OSError.
|
|
The POSIX translation will be figured out by the constructor. */
|
|
args = Py_BuildValue("(iOOiO)", 0, message, filenameObject, err, filenameObject2);
|
|
Py_DECREF(message);
|
|
|
|
if (args != NULL) {
|
|
v = PyObject_Call(exc, args, NULL);
|
|
Py_DECREF(args);
|
|
if (v != NULL) {
|
|
_PyErr_SetObject(tstate, (PyObject *) Py_TYPE(v), v);
|
|
Py_DECREF(v);
|
|
}
|
|
}
|
|
LocalFree(s_buf);
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *PyErr_SetExcFromWindowsErrWithFilename(
|
|
PyObject *exc,
|
|
int ierr,
|
|
const char *filename)
|
|
{
|
|
PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
|
|
PyObject *ret = PyErr_SetExcFromWindowsErrWithFilenameObjects(exc,
|
|
ierr,
|
|
name,
|
|
NULL);
|
|
Py_XDECREF(name);
|
|
return ret;
|
|
}
|
|
|
|
PyObject *PyErr_SetExcFromWindowsErr(PyObject *exc, int ierr)
|
|
{
|
|
return PyErr_SetExcFromWindowsErrWithFilename(exc, ierr, NULL);
|
|
}
|
|
|
|
PyObject *PyErr_SetFromWindowsErr(int ierr)
|
|
{
|
|
return PyErr_SetExcFromWindowsErrWithFilename(PyExc_OSError,
|
|
ierr, NULL);
|
|
}
|
|
|
|
PyObject *PyErr_SetFromWindowsErrWithFilename(
|
|
int ierr,
|
|
const char *filename)
|
|
{
|
|
PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
|
|
PyObject *result = PyErr_SetExcFromWindowsErrWithFilenameObjects(
|
|
PyExc_OSError,
|
|
ierr, name, NULL);
|
|
Py_XDECREF(name);
|
|
return result;
|
|
}
|
|
|
|
#endif /* MS_WINDOWS */
|
|
|
|
PyObject *
|
|
PyErr_SetImportErrorSubclass(PyObject *exception, PyObject *msg,
|
|
PyObject *name, PyObject *path)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
int issubclass;
|
|
PyObject *kwargs, *error;
|
|
|
|
issubclass = PyObject_IsSubclass(exception, PyExc_ImportError);
|
|
if (issubclass < 0) {
|
|
return NULL;
|
|
}
|
|
else if (!issubclass) {
|
|
_PyErr_SetString(tstate, PyExc_TypeError,
|
|
"expected a subclass of ImportError");
|
|
return NULL;
|
|
}
|
|
|
|
if (msg == NULL) {
|
|
_PyErr_SetString(tstate, PyExc_TypeError,
|
|
"expected a message argument");
|
|
return NULL;
|
|
}
|
|
|
|
if (name == NULL) {
|
|
name = Py_None;
|
|
}
|
|
if (path == NULL) {
|
|
path = Py_None;
|
|
}
|
|
|
|
kwargs = PyDict_New();
|
|
if (kwargs == NULL) {
|
|
return NULL;
|
|
}
|
|
if (PyDict_SetItemString(kwargs, "name", name) < 0) {
|
|
goto done;
|
|
}
|
|
if (PyDict_SetItemString(kwargs, "path", path) < 0) {
|
|
goto done;
|
|
}
|
|
|
|
error = PyObject_VectorcallDict(exception, &msg, 1, kwargs);
|
|
if (error != NULL) {
|
|
_PyErr_SetObject(tstate, (PyObject *)Py_TYPE(error), error);
|
|
Py_DECREF(error);
|
|
}
|
|
|
|
done:
|
|
Py_DECREF(kwargs);
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_SetImportError(PyObject *msg, PyObject *name, PyObject *path)
|
|
{
|
|
return PyErr_SetImportErrorSubclass(PyExc_ImportError, msg, name, path);
|
|
}
|
|
|
|
void
|
|
_PyErr_BadInternalCall(const char *filename, int lineno)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_Format(tstate, PyExc_SystemError,
|
|
"%s:%d: bad argument to internal function",
|
|
filename, lineno);
|
|
}
|
|
|
|
/* Remove the preprocessor macro for PyErr_BadInternalCall() so that we can
|
|
export the entry point for existing object code: */
|
|
#undef PyErr_BadInternalCall
|
|
void
|
|
PyErr_BadInternalCall(void)
|
|
{
|
|
assert(0 && "bad argument to internal function");
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_PyErr_SetString(tstate, PyExc_SystemError,
|
|
"bad argument to internal function");
|
|
}
|
|
#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
|
|
|
|
|
|
static PyObject *
|
|
_PyErr_FormatV(PyThreadState *tstate, PyObject *exception,
|
|
const char *format, va_list vargs)
|
|
{
|
|
PyObject* string;
|
|
|
|
/* Issue #23571: PyUnicode_FromFormatV() must not be called with an
|
|
exception set, it calls arbitrary Python code like PyObject_Repr() */
|
|
_PyErr_Clear(tstate);
|
|
|
|
string = PyUnicode_FromFormatV(format, vargs);
|
|
|
|
_PyErr_SetObject(tstate, exception, string);
|
|
Py_XDECREF(string);
|
|
return NULL;
|
|
}
|
|
|
|
|
|
PyObject *
|
|
PyErr_FormatV(PyObject *exception, const char *format, va_list vargs)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
return _PyErr_FormatV(tstate, exception, format, vargs);
|
|
}
|
|
|
|
|
|
PyObject *
|
|
_PyErr_Format(PyThreadState *tstate, PyObject *exception,
|
|
const char *format, ...)
|
|
{
|
|
va_list vargs;
|
|
#ifdef HAVE_STDARG_PROTOTYPES
|
|
va_start(vargs, format);
|
|
#else
|
|
va_start(vargs);
|
|
#endif
|
|
_PyErr_FormatV(tstate, exception, format, vargs);
|
|
va_end(vargs);
|
|
return NULL;
|
|
}
|
|
|
|
|
|
PyObject *
|
|
PyErr_Format(PyObject *exception, const char *format, ...)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
va_list vargs;
|
|
#ifdef HAVE_STDARG_PROTOTYPES
|
|
va_start(vargs, format);
|
|
#else
|
|
va_start(vargs);
|
|
#endif
|
|
_PyErr_FormatV(tstate, exception, format, vargs);
|
|
va_end(vargs);
|
|
return NULL;
|
|
}
|
|
|
|
|
|
PyObject *
|
|
PyErr_NewException(const char *name, PyObject *base, PyObject *dict)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
PyObject *modulename = NULL;
|
|
PyObject *mydict = NULL;
|
|
PyObject *bases = NULL;
|
|
PyObject *result = NULL;
|
|
|
|
const char *dot = strrchr(name, '.');
|
|
if (dot == NULL) {
|
|
_PyErr_SetString(tstate, PyExc_SystemError,
|
|
"PyErr_NewException: name must be module.class");
|
|
return NULL;
|
|
}
|
|
if (base == NULL) {
|
|
base = PyExc_Exception;
|
|
}
|
|
if (dict == NULL) {
|
|
dict = mydict = PyDict_New();
|
|
if (dict == NULL)
|
|
goto failure;
|
|
}
|
|
|
|
int r = PyDict_Contains(dict, &_Py_ID(__module__));
|
|
if (r < 0) {
|
|
goto failure;
|
|
}
|
|
if (r == 0) {
|
|
modulename = PyUnicode_FromStringAndSize(name,
|
|
(Py_ssize_t)(dot-name));
|
|
if (modulename == NULL)
|
|
goto failure;
|
|
if (PyDict_SetItem(dict, &_Py_ID(__module__), modulename) != 0)
|
|
goto failure;
|
|
}
|
|
if (PyTuple_Check(base)) {
|
|
bases = base;
|
|
/* INCREF as we create a new ref in the else branch */
|
|
Py_INCREF(bases);
|
|
} else {
|
|
bases = PyTuple_Pack(1, base);
|
|
if (bases == NULL)
|
|
goto failure;
|
|
}
|
|
/* Create a real class. */
|
|
result = PyObject_CallFunction((PyObject *)&PyType_Type, "sOO",
|
|
dot+1, bases, dict);
|
|
failure:
|
|
Py_XDECREF(bases);
|
|
Py_XDECREF(mydict);
|
|
Py_XDECREF(modulename);
|
|
return result;
|
|
}
|
|
|
|
|
|
/* Create an exception with docstring */
|
|
PyObject *
|
|
PyErr_NewExceptionWithDoc(const char *name, const char *doc,
|
|
PyObject *base, PyObject *dict)
|
|
{
|
|
int result;
|
|
PyObject *ret = NULL;
|
|
PyObject *mydict = NULL; /* points to the dict only if we create it */
|
|
PyObject *docobj;
|
|
|
|
if (dict == NULL) {
|
|
dict = mydict = PyDict_New();
|
|
if (dict == NULL) {
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
if (doc != NULL) {
|
|
docobj = PyUnicode_FromString(doc);
|
|
if (docobj == NULL)
|
|
goto failure;
|
|
result = PyDict_SetItemString(dict, "__doc__", docobj);
|
|
Py_DECREF(docobj);
|
|
if (result < 0)
|
|
goto failure;
|
|
}
|
|
|
|
ret = PyErr_NewException(name, base, dict);
|
|
failure:
|
|
Py_XDECREF(mydict);
|
|
return ret;
|
|
}
|
|
|
|
|
|
PyDoc_STRVAR(UnraisableHookArgs__doc__,
|
|
"UnraisableHookArgs\n\
|
|
\n\
|
|
Type used to pass arguments to sys.unraisablehook.");
|
|
|
|
static PyTypeObject UnraisableHookArgsType;
|
|
|
|
static PyStructSequence_Field UnraisableHookArgs_fields[] = {
|
|
{"exc_type", "Exception type"},
|
|
{"exc_value", "Exception value"},
|
|
{"exc_traceback", "Exception traceback"},
|
|
{"err_msg", "Error message"},
|
|
{"object", "Object causing the exception"},
|
|
{0}
|
|
};
|
|
|
|
static PyStructSequence_Desc UnraisableHookArgs_desc = {
|
|
.name = "UnraisableHookArgs",
|
|
.doc = UnraisableHookArgs__doc__,
|
|
.fields = UnraisableHookArgs_fields,
|
|
.n_in_sequence = 5
|
|
};
|
|
|
|
|
|
PyStatus
|
|
_PyErr_InitTypes(PyInterpreterState *interp)
|
|
{
|
|
if (!_Py_IsMainInterpreter(interp)) {
|
|
return _PyStatus_OK();
|
|
}
|
|
|
|
if (UnraisableHookArgsType.tp_name == NULL) {
|
|
if (PyStructSequence_InitType2(&UnraisableHookArgsType,
|
|
&UnraisableHookArgs_desc) < 0) {
|
|
return _PyStatus_ERR("failed to initialize UnraisableHookArgs type");
|
|
}
|
|
}
|
|
return _PyStatus_OK();
|
|
}
|
|
|
|
|
|
void
|
|
_PyErr_FiniTypes(PyInterpreterState *interp)
|
|
{
|
|
if (!_Py_IsMainInterpreter(interp)) {
|
|
return;
|
|
}
|
|
|
|
_PyStructSequence_FiniType(&UnraisableHookArgsType);
|
|
}
|
|
|
|
|
|
static PyObject *
|
|
make_unraisable_hook_args(PyThreadState *tstate, PyObject *exc_type,
|
|
PyObject *exc_value, PyObject *exc_tb,
|
|
PyObject *err_msg, PyObject *obj)
|
|
{
|
|
PyObject *args = PyStructSequence_New(&UnraisableHookArgsType);
|
|
if (args == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
Py_ssize_t pos = 0;
|
|
#define ADD_ITEM(exc_type) \
|
|
do { \
|
|
if (exc_type == NULL) { \
|
|
exc_type = Py_None; \
|
|
} \
|
|
Py_INCREF(exc_type); \
|
|
PyStructSequence_SET_ITEM(args, pos++, exc_type); \
|
|
} while (0)
|
|
|
|
|
|
ADD_ITEM(exc_type);
|
|
ADD_ITEM(exc_value);
|
|
ADD_ITEM(exc_tb);
|
|
ADD_ITEM(err_msg);
|
|
ADD_ITEM(obj);
|
|
#undef ADD_ITEM
|
|
|
|
if (_PyErr_Occurred(tstate)) {
|
|
Py_DECREF(args);
|
|
return NULL;
|
|
}
|
|
return args;
|
|
}
|
|
|
|
|
|
|
|
/* Default implementation of sys.unraisablehook.
|
|
|
|
It can be called to log the exception of a custom sys.unraisablehook.
|
|
|
|
Do nothing if sys.stderr attribute doesn't exist or is set to None. */
|
|
static int
|
|
write_unraisable_exc_file(PyThreadState *tstate, PyObject *exc_type,
|
|
PyObject *exc_value, PyObject *exc_tb,
|
|
PyObject *err_msg, PyObject *obj, PyObject *file)
|
|
{
|
|
if (obj != NULL && obj != Py_None) {
|
|
if (err_msg != NULL && err_msg != Py_None) {
|
|
if (PyFile_WriteObject(err_msg, file, Py_PRINT_RAW) < 0) {
|
|
return -1;
|
|
}
|
|
if (PyFile_WriteString(": ", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
else {
|
|
if (PyFile_WriteString("Exception ignored in: ", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
if (PyFile_WriteObject(obj, file, 0) < 0) {
|
|
_PyErr_Clear(tstate);
|
|
if (PyFile_WriteString("<object repr() failed>", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
if (PyFile_WriteString("\n", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
else if (err_msg != NULL && err_msg != Py_None) {
|
|
if (PyFile_WriteObject(err_msg, file, Py_PRINT_RAW) < 0) {
|
|
return -1;
|
|
}
|
|
if (PyFile_WriteString(":\n", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
if (exc_tb != NULL && exc_tb != Py_None) {
|
|
if (PyTraceBack_Print(exc_tb, file) < 0) {
|
|
/* continue even if writing the traceback failed */
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
|
|
if (exc_type == NULL || exc_type == Py_None) {
|
|
return -1;
|
|
}
|
|
|
|
assert(PyExceptionClass_Check(exc_type));
|
|
|
|
PyObject *modulename = PyObject_GetAttr(exc_type, &_Py_ID(__module__));
|
|
if (modulename == NULL || !PyUnicode_Check(modulename)) {
|
|
Py_XDECREF(modulename);
|
|
_PyErr_Clear(tstate);
|
|
if (PyFile_WriteString("<unknown>", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
else {
|
|
if (!_PyUnicode_Equal(modulename, &_Py_ID(builtins)) &&
|
|
!_PyUnicode_Equal(modulename, &_Py_ID(__main__))) {
|
|
if (PyFile_WriteObject(modulename, file, Py_PRINT_RAW) < 0) {
|
|
Py_DECREF(modulename);
|
|
return -1;
|
|
}
|
|
Py_DECREF(modulename);
|
|
if (PyFile_WriteString(".", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
else {
|
|
Py_DECREF(modulename);
|
|
}
|
|
}
|
|
|
|
PyObject *qualname = PyType_GetQualName((PyTypeObject *)exc_type);
|
|
if (qualname == NULL || !PyUnicode_Check(qualname)) {
|
|
Py_XDECREF(qualname);
|
|
_PyErr_Clear(tstate);
|
|
if (PyFile_WriteString("<unknown>", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
else {
|
|
if (PyFile_WriteObject(qualname, file, Py_PRINT_RAW) < 0) {
|
|
Py_DECREF(qualname);
|
|
return -1;
|
|
}
|
|
Py_DECREF(qualname);
|
|
}
|
|
|
|
if (exc_value && exc_value != Py_None) {
|
|
if (PyFile_WriteString(": ", file) < 0) {
|
|
return -1;
|
|
}
|
|
if (PyFile_WriteObject(exc_value, file, Py_PRINT_RAW) < 0) {
|
|
_PyErr_Clear(tstate);
|
|
if (PyFile_WriteString("<exception str() failed>", file) < 0) {
|
|
return -1;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (PyFile_WriteString("\n", file) < 0) {
|
|
return -1;
|
|
}
|
|
|
|
/* Explicitly call file.flush() */
|
|
PyObject *res = _PyObject_CallMethodNoArgs(file, &_Py_ID(flush));
|
|
if (!res) {
|
|
return -1;
|
|
}
|
|
Py_DECREF(res);
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
static int
|
|
write_unraisable_exc(PyThreadState *tstate, PyObject *exc_type,
|
|
PyObject *exc_value, PyObject *exc_tb, PyObject *err_msg,
|
|
PyObject *obj)
|
|
{
|
|
PyObject *file = _PySys_GetAttr(tstate, &_Py_ID(stderr));
|
|
if (file == NULL || file == Py_None) {
|
|
return 0;
|
|
}
|
|
|
|
/* Hold a strong reference to ensure that sys.stderr doesn't go away
|
|
while we use it */
|
|
Py_INCREF(file);
|
|
int res = write_unraisable_exc_file(tstate, exc_type, exc_value, exc_tb,
|
|
err_msg, obj, file);
|
|
Py_DECREF(file);
|
|
|
|
return res;
|
|
}
|
|
|
|
|
|
PyObject*
|
|
_PyErr_WriteUnraisableDefaultHook(PyObject *args)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
|
|
if (!Py_IS_TYPE(args, &UnraisableHookArgsType)) {
|
|
_PyErr_SetString(tstate, PyExc_TypeError,
|
|
"sys.unraisablehook argument type "
|
|
"must be UnraisableHookArgs");
|
|
return NULL;
|
|
}
|
|
|
|
/* Borrowed references */
|
|
PyObject *exc_type = PyStructSequence_GET_ITEM(args, 0);
|
|
PyObject *exc_value = PyStructSequence_GET_ITEM(args, 1);
|
|
PyObject *exc_tb = PyStructSequence_GET_ITEM(args, 2);
|
|
PyObject *err_msg = PyStructSequence_GET_ITEM(args, 3);
|
|
PyObject *obj = PyStructSequence_GET_ITEM(args, 4);
|
|
|
|
if (write_unraisable_exc(tstate, exc_type, exc_value, exc_tb, err_msg, obj) < 0) {
|
|
return NULL;
|
|
}
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
|
|
/* Call sys.unraisablehook().
|
|
|
|
This function can be used when an exception has occurred but there is no way
|
|
for Python to handle it. For example, when a destructor raises an exception
|
|
or during garbage collection (gc.collect()).
|
|
|
|
If err_msg_str is non-NULL, the error message is formatted as:
|
|
"Exception ignored %s" % err_msg_str. Otherwise, use "Exception ignored in"
|
|
error message.
|
|
|
|
An exception must be set when calling this function. */
|
|
void
|
|
_PyErr_WriteUnraisableMsg(const char *err_msg_str, PyObject *obj)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
_Py_EnsureTstateNotNULL(tstate);
|
|
|
|
PyObject *err_msg = NULL;
|
|
PyObject *exc_type, *exc_value, *exc_tb;
|
|
_PyErr_Fetch(tstate, &exc_type, &exc_value, &exc_tb);
|
|
|
|
assert(exc_type != NULL);
|
|
|
|
if (exc_type == NULL) {
|
|
/* sys.unraisablehook requires that at least exc_type is set */
|
|
goto default_hook;
|
|
}
|
|
|
|
if (exc_tb == NULL) {
|
|
PyFrameObject *frame = PyThreadState_GetFrame(tstate);
|
|
if (frame != NULL) {
|
|
exc_tb = _PyTraceBack_FromFrame(NULL, frame);
|
|
if (exc_tb == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_DECREF(frame);
|
|
}
|
|
}
|
|
|
|
_PyErr_NormalizeException(tstate, &exc_type, &exc_value, &exc_tb);
|
|
|
|
if (exc_tb != NULL && exc_tb != Py_None && PyTraceBack_Check(exc_tb)) {
|
|
if (PyException_SetTraceback(exc_value, exc_tb) < 0) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
|
|
if (err_msg_str != NULL) {
|
|
err_msg = PyUnicode_FromFormat("Exception ignored %s", err_msg_str);
|
|
if (err_msg == NULL) {
|
|
PyErr_Clear();
|
|
}
|
|
}
|
|
|
|
PyObject *hook_args = make_unraisable_hook_args(
|
|
tstate, exc_type, exc_value, exc_tb, err_msg, obj);
|
|
if (hook_args == NULL) {
|
|
err_msg_str = ("Exception ignored on building "
|
|
"sys.unraisablehook arguments");
|
|
goto error;
|
|
}
|
|
|
|
PyObject *hook = _PySys_GetAttr(tstate, &_Py_ID(unraisablehook));
|
|
if (hook == NULL) {
|
|
Py_DECREF(hook_args);
|
|
goto default_hook;
|
|
}
|
|
|
|
if (_PySys_Audit(tstate, "sys.unraisablehook", "OO", hook, hook_args) < 0) {
|
|
Py_DECREF(hook_args);
|
|
err_msg_str = "Exception ignored in audit hook";
|
|
obj = NULL;
|
|
goto error;
|
|
}
|
|
|
|
if (hook == Py_None) {
|
|
Py_DECREF(hook_args);
|
|
goto default_hook;
|
|
}
|
|
|
|
PyObject *res = PyObject_CallOneArg(hook, hook_args);
|
|
Py_DECREF(hook_args);
|
|
if (res != NULL) {
|
|
Py_DECREF(res);
|
|
goto done;
|
|
}
|
|
|
|
/* sys.unraisablehook failed: log its error using default hook */
|
|
obj = hook;
|
|
err_msg_str = NULL;
|
|
|
|
error:
|
|
/* err_msg_str and obj have been updated and we have a new exception */
|
|
Py_XSETREF(err_msg, PyUnicode_FromString(err_msg_str ?
|
|
err_msg_str : "Exception ignored in sys.unraisablehook"));
|
|
Py_XDECREF(exc_type);
|
|
Py_XDECREF(exc_value);
|
|
Py_XDECREF(exc_tb);
|
|
_PyErr_Fetch(tstate, &exc_type, &exc_value, &exc_tb);
|
|
|
|
default_hook:
|
|
/* Call the default unraisable hook (ignore failure) */
|
|
(void)write_unraisable_exc(tstate, exc_type, exc_value, exc_tb,
|
|
err_msg, obj);
|
|
|
|
done:
|
|
Py_XDECREF(exc_type);
|
|
Py_XDECREF(exc_value);
|
|
Py_XDECREF(exc_tb);
|
|
Py_XDECREF(err_msg);
|
|
_PyErr_Clear(tstate); /* Just in case */
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_WriteUnraisable(PyObject *obj)
|
|
{
|
|
_PyErr_WriteUnraisableMsg(NULL, obj);
|
|
}
|
|
|
|
|
|
void
|
|
PyErr_SyntaxLocation(const char *filename, int lineno)
|
|
{
|
|
PyErr_SyntaxLocationEx(filename, lineno, -1);
|
|
}
|
|
|
|
|
|
/* Set file and line information for the current exception.
|
|
If the exception is not a SyntaxError, also sets additional attributes
|
|
to make printing of exceptions believe it is a syntax error. */
|
|
|
|
static void
|
|
PyErr_SyntaxLocationObjectEx(PyObject *filename, int lineno, int col_offset,
|
|
int end_lineno, int end_col_offset)
|
|
{
|
|
PyObject *exc, *v, *tb, *tmp;
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
|
|
/* add attributes for the line number and filename for the error */
|
|
_PyErr_Fetch(tstate, &exc, &v, &tb);
|
|
_PyErr_NormalizeException(tstate, &exc, &v, &tb);
|
|
/* XXX check that it is, indeed, a syntax error. It might not
|
|
* be, though. */
|
|
tmp = PyLong_FromLong(lineno);
|
|
if (tmp == NULL)
|
|
_PyErr_Clear(tstate);
|
|
else {
|
|
if (PyObject_SetAttr(v, &_Py_ID(lineno), tmp)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_DECREF(tmp);
|
|
}
|
|
tmp = NULL;
|
|
if (col_offset >= 0) {
|
|
tmp = PyLong_FromLong(col_offset);
|
|
if (tmp == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
if (PyObject_SetAttr(v, &_Py_ID(offset), tmp ? tmp : Py_None)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_XDECREF(tmp);
|
|
|
|
tmp = NULL;
|
|
if (end_lineno >= 0) {
|
|
tmp = PyLong_FromLong(end_lineno);
|
|
if (tmp == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
if (PyObject_SetAttr(v, &_Py_ID(end_lineno), tmp ? tmp : Py_None)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_XDECREF(tmp);
|
|
|
|
tmp = NULL;
|
|
if (end_col_offset >= 0) {
|
|
tmp = PyLong_FromLong(end_col_offset);
|
|
if (tmp == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
if (PyObject_SetAttr(v, &_Py_ID(end_offset), tmp ? tmp : Py_None)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_XDECREF(tmp);
|
|
|
|
tmp = NULL;
|
|
if (filename != NULL) {
|
|
if (PyObject_SetAttr(v, &_Py_ID(filename), filename)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
|
|
tmp = PyErr_ProgramTextObject(filename, lineno);
|
|
if (tmp) {
|
|
if (PyObject_SetAttr(v, &_Py_ID(text), tmp)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_DECREF(tmp);
|
|
}
|
|
else {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
if (exc != PyExc_SyntaxError) {
|
|
if (_PyObject_LookupAttr(v, &_Py_ID(msg), &tmp) < 0) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
else if (tmp) {
|
|
Py_DECREF(tmp);
|
|
}
|
|
else {
|
|
tmp = PyObject_Str(v);
|
|
if (tmp) {
|
|
if (PyObject_SetAttr(v, &_Py_ID(msg), tmp)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
Py_DECREF(tmp);
|
|
}
|
|
else {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
|
|
if (_PyObject_LookupAttr(v, &_Py_ID(print_file_and_line), &tmp) < 0) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
else if (tmp) {
|
|
Py_DECREF(tmp);
|
|
}
|
|
else {
|
|
if (PyObject_SetAttr(v, &_Py_ID(print_file_and_line), Py_None)) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
}
|
|
_PyErr_Restore(tstate, exc, v, tb);
|
|
}
|
|
|
|
void
|
|
PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset) {
|
|
PyErr_SyntaxLocationObjectEx(filename, lineno, col_offset, lineno, -1);
|
|
}
|
|
|
|
void
|
|
PyErr_RangedSyntaxLocationObject(PyObject *filename, int lineno, int col_offset,
|
|
int end_lineno, int end_col_offset) {
|
|
PyErr_SyntaxLocationObjectEx(filename, lineno, col_offset, end_lineno, end_col_offset);
|
|
}
|
|
|
|
void
|
|
PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)
|
|
{
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
PyObject *fileobj;
|
|
if (filename != NULL) {
|
|
fileobj = PyUnicode_DecodeFSDefault(filename);
|
|
if (fileobj == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
}
|
|
}
|
|
else {
|
|
fileobj = NULL;
|
|
}
|
|
PyErr_SyntaxLocationObject(fileobj, lineno, col_offset);
|
|
Py_XDECREF(fileobj);
|
|
}
|
|
|
|
/* Attempt to load the line of text that the exception refers to. If it
|
|
fails, it will return NULL but will not set an exception.
|
|
|
|
XXX The functionality of this function is quite similar to the
|
|
functionality in tb_displayline() in traceback.c. */
|
|
|
|
static PyObject *
|
|
err_programtext(PyThreadState *tstate, FILE *fp, int lineno, const char* encoding)
|
|
{
|
|
int i;
|
|
char linebuf[1000];
|
|
if (fp == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
for (i = 0; i < lineno; i++) {
|
|
char *pLastChar = &linebuf[sizeof(linebuf) - 2];
|
|
do {
|
|
*pLastChar = '\0';
|
|
if (Py_UniversalNewlineFgets(linebuf, sizeof linebuf,
|
|
fp, NULL) == NULL) {
|
|
goto after_loop;
|
|
}
|
|
/* fgets read *something*; if it didn't get as
|
|
far as pLastChar, it must have found a newline
|
|
or hit the end of the file; if pLastChar is \n,
|
|
it obviously found a newline; else we haven't
|
|
yet seen a newline, so must continue */
|
|
} while (*pLastChar != '\0' && *pLastChar != '\n');
|
|
}
|
|
|
|
after_loop:
|
|
fclose(fp);
|
|
if (i == lineno) {
|
|
PyObject *res;
|
|
if (encoding != NULL) {
|
|
res = PyUnicode_Decode(linebuf, strlen(linebuf), encoding, "replace");
|
|
} else {
|
|
res = PyUnicode_FromString(linebuf);
|
|
}
|
|
if (res == NULL)
|
|
_PyErr_Clear(tstate);
|
|
return res;
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_ProgramText(const char *filename, int lineno)
|
|
{
|
|
if (filename == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
PyObject *filename_obj = PyUnicode_DecodeFSDefault(filename);
|
|
if (filename_obj == NULL) {
|
|
PyErr_Clear();
|
|
return NULL;
|
|
}
|
|
PyObject *res = PyErr_ProgramTextObject(filename_obj, lineno);
|
|
Py_DECREF(filename_obj);
|
|
return res;
|
|
}
|
|
|
|
PyObject *
|
|
_PyErr_ProgramDecodedTextObject(PyObject *filename, int lineno, const char* encoding)
|
|
{
|
|
if (filename == NULL || lineno <= 0) {
|
|
return NULL;
|
|
}
|
|
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
FILE *fp = _Py_fopen_obj(filename, "r" PY_STDIOTEXTMODE);
|
|
if (fp == NULL) {
|
|
_PyErr_Clear(tstate);
|
|
return NULL;
|
|
}
|
|
return err_programtext(tstate, fp, lineno, encoding);
|
|
}
|
|
|
|
PyObject *
|
|
PyErr_ProgramTextObject(PyObject *filename, int lineno)
|
|
{
|
|
return _PyErr_ProgramDecodedTextObject(filename, lineno, NULL);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|