mirror of https://github.com/python/cpython
bpo-45635: refactor print_exception_recursive into smaller functions to standardize error handling (GH-30015)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
This commit is contained in:
Irit Katriel
GitHub
parent
c1051e08b3
commit
0fe104fce7
|
|
@ -1253,84 +1253,97 @@ print_chained(struct exception_print_context* ctx, PyObject *value,
|
|||
return 0;
|
||||
}
|
||||
|
||||
static void
|
||||
print_exception_recursive(struct exception_print_context* ctx, PyObject *value)
|
||||
/* Return true if value is in seen or there was a lookup error.
|
||||
* Return false if lookup succeeded and the item was not found.
|
||||
* We suppress errors because this makes us err on the side of
|
||||
* under-printing which is better than over-printing irregular
|
||||
* exceptions (e.g., unhashable ones).
|
||||
*/
|
||||
static bool
|
||||
print_exception_seen_lookup(struct exception_print_context *ctx,
|
||||
PyObject *value)
|
||||
{
|
||||
int err = 0, res;
|
||||
PyObject *cause, *context;
|
||||
|
||||
if (ctx->seen != NULL) {
|
||||
/* Exception chaining */
|
||||
PyObject *value_id = PyLong_FromVoidPtr(value);
|
||||
if (value_id == NULL || PySet_Add(ctx->seen, value_id) == -1)
|
||||
PyErr_Clear();
|
||||
else if (PyExceptionInstance_Check(value)) {
|
||||
PyObject *check_id = NULL;
|
||||
|
||||
cause = PyException_GetCause(value);
|
||||
context = PyException_GetContext(value);
|
||||
if (cause) {
|
||||
check_id = PyLong_FromVoidPtr(cause);
|
||||
PyObject *check_id = PyLong_FromVoidPtr(value);
|
||||
if (check_id == NULL) {
|
||||
res = -1;
|
||||
} else {
|
||||
res = PySet_Contains(ctx->seen, check_id);
|
||||
Py_DECREF(check_id);
|
||||
}
|
||||
if (res == -1)
|
||||
PyErr_Clear();
|
||||
if (res == 0) {
|
||||
return true;
|
||||
}
|
||||
|
||||
int in_seen = PySet_Contains(ctx->seen, check_id);
|
||||
Py_DECREF(check_id);
|
||||
if (in_seen == -1) {
|
||||
PyErr_Clear();
|
||||
return true;
|
||||
}
|
||||
|
||||
if (in_seen == 1) {
|
||||
/* value is in seen */
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
static int
|
||||
print_exception_cause_and_context(struct exception_print_context *ctx,
|
||||
PyObject *value)
|
||||
{
|
||||
PyObject *value_id = PyLong_FromVoidPtr(value);
|
||||
if (value_id == NULL || PySet_Add(ctx->seen, value_id) == -1) {
|
||||
PyErr_Clear();
|
||||
Py_XDECREF(value_id);
|
||||
return 0;
|
||||
}
|
||||
Py_DECREF(value_id);
|
||||
|
||||
if (!PyExceptionInstance_Check(value)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
PyObject *cause = PyException_GetCause(value);
|
||||
if (cause) {
|
||||
int err = 0;
|
||||
if (!print_exception_seen_lookup(ctx, cause)) {
|
||||
err = print_chained(ctx, cause, cause_message, "cause");
|
||||
}
|
||||
Py_DECREF(cause);
|
||||
return err;
|
||||
}
|
||||
else if (context &&
|
||||
!((PyBaseExceptionObject *)value)->suppress_context) {
|
||||
check_id = PyLong_FromVoidPtr(context);
|
||||
if (check_id == NULL) {
|
||||
res = -1;
|
||||
} else {
|
||||
res = PySet_Contains(ctx->seen, check_id);
|
||||
Py_DECREF(check_id);
|
||||
if (((PyBaseExceptionObject *)value)->suppress_context) {
|
||||
return 0;
|
||||
}
|
||||
if (res == -1)
|
||||
PyErr_Clear();
|
||||
if (res == 0) {
|
||||
PyObject *context = PyException_GetContext(value);
|
||||
if (context) {
|
||||
int err = 0;
|
||||
if (!print_exception_seen_lookup(ctx, context)) {
|
||||
err = print_chained(ctx, context, context_message, "context");
|
||||
}
|
||||
Py_DECREF(context);
|
||||
return err;
|
||||
}
|
||||
Py_XDECREF(context);
|
||||
Py_XDECREF(cause);
|
||||
}
|
||||
Py_XDECREF(value_id);
|
||||
}
|
||||
if (err) {
|
||||
/* don't do anything else */
|
||||
}
|
||||
else if (!_PyBaseExceptionGroup_Check(value)) {
|
||||
print_exception(ctx, value);
|
||||
}
|
||||
else if (ctx->exception_group_depth > ctx->max_group_depth) {
|
||||
/* exception group but depth exceeds limit */
|
||||
return 0;
|
||||
}
|
||||
|
||||
PyObject *line = PyUnicode_FromFormat(
|
||||
"... (max_group_depth is %d)\n", ctx->max_group_depth);
|
||||
|
||||
if (line) {
|
||||
static int
|
||||
print_exception_group(struct exception_print_context *ctx, PyObject *value)
|
||||
{
|
||||
PyObject *f = ctx->file;
|
||||
if (err == 0) {
|
||||
err = write_indented_margin(ctx, f);
|
||||
|
||||
if (ctx->exception_group_depth > ctx->max_group_depth) {
|
||||
/* depth exceeds limit */
|
||||
|
||||
if (write_indented_margin(ctx, f) < 0) {
|
||||
return -1;
|
||||
}
|
||||
if (err == 0) {
|
||||
err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
|
||||
PyObject *line = PyUnicode_FromFormat("... (max_group_depth is %d)\n",
|
||||
ctx->max_group_depth);
|
||||
if (line == NULL) {
|
||||
return -1;
|
||||
}
|
||||
int err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
Py_DECREF(line);
|
||||
return err;
|
||||
}
|
||||
else {
|
||||
err = -1;
|
||||
}
|
||||
}
|
||||
else {
|
||||
/* format exception group */
|
||||
|
||||
if (ctx->exception_group_depth == 0) {
|
||||
ctx->exception_group_depth += 1;
|
||||
|
|
@ -1349,17 +1362,19 @@ print_exception_recursive(struct exception_print_context* ctx, PyObject *value)
|
|||
n = ctx->max_group_width + 1;
|
||||
}
|
||||
|
||||
PyObject *f = ctx->file;
|
||||
|
||||
ctx->need_close = false;
|
||||
for (Py_ssize_t i = 0; i < n; i++) {
|
||||
int last_exc = (i == n - 1);
|
||||
bool last_exc = (i == n - 1);
|
||||
if (last_exc) {
|
||||
// The closing frame may be added in a recursive call
|
||||
ctx->need_close = true;
|
||||
}
|
||||
PyObject *line;
|
||||
|
||||
if (_Py_WriteIndent(EXC_INDENT(ctx), f) < 0) {
|
||||
return -1;
|
||||
}
|
||||
bool truncated = (i >= ctx->max_group_width);
|
||||
PyObject *line;
|
||||
if (!truncated) {
|
||||
line = PyUnicode_FromFormat(
|
||||
"%s+---------------- %zd ----------------\n",
|
||||
|
|
@ -1370,67 +1385,90 @@ print_exception_recursive(struct exception_print_context* ctx, PyObject *value)
|
|||
"%s+---------------- ... ----------------\n",
|
||||
(i == 0) ? "+-" : " ");
|
||||
}
|
||||
|
||||
if (line) {
|
||||
if (err == 0) {
|
||||
err = _Py_WriteIndent(EXC_INDENT(ctx), f);
|
||||
}
|
||||
if (err == 0) {
|
||||
err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
if (line == NULL) {
|
||||
return -1;
|
||||
}
|
||||
int err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
Py_DECREF(line);
|
||||
}
|
||||
else {
|
||||
err = -1;
|
||||
if (err < 0) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
if (err == 0) {
|
||||
ctx->exception_group_depth += 1;
|
||||
PyObject *exc = PyTuple_GET_ITEM(excs, i);
|
||||
|
||||
if (!truncated) {
|
||||
if (!Py_EnterRecursiveCall(" in print_exception_recursive")) {
|
||||
if (Py_EnterRecursiveCall(" in print_exception_recursive") != 0) {
|
||||
return -1;
|
||||
}
|
||||
print_exception_recursive(ctx, exc);
|
||||
Py_LeaveRecursiveCall();
|
||||
}
|
||||
else {
|
||||
err = -1;
|
||||
}
|
||||
}
|
||||
else {
|
||||
Py_ssize_t excs_remaining = num_excs - ctx->max_group_width;
|
||||
|
||||
if (write_indented_margin(ctx, f) < 0) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
PyObject *line = PyUnicode_FromFormat(
|
||||
"and %zd more exception%s\n",
|
||||
excs_remaining, excs_remaining > 1 ? "s" : "");
|
||||
|
||||
if (line) {
|
||||
if (err == 0) {
|
||||
err = write_indented_margin(ctx, f);
|
||||
}
|
||||
if (err == 0) {
|
||||
err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
if (line == NULL) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
int err = PyFile_WriteObject(line, f, Py_PRINT_RAW);
|
||||
Py_DECREF(line);
|
||||
}
|
||||
else {
|
||||
err = -1;
|
||||
if (err < 0) {
|
||||
return -1;
|
||||
}
|
||||
}
|
||||
|
||||
if (err == 0 && last_exc && ctx->need_close) {
|
||||
err = _Py_WriteIndent(EXC_INDENT(ctx), f);
|
||||
if (err == 0) {
|
||||
err = PyFile_WriteString(
|
||||
"+------------------------------------\n", f);
|
||||
if (last_exc && ctx->need_close) {
|
||||
if (_Py_WriteIndent(EXC_INDENT(ctx), f) < 0) {
|
||||
return -1;
|
||||
}
|
||||
if (PyFile_WriteString(
|
||||
"+------------------------------------\n", f) < 0) {
|
||||
return -1;
|
||||
}
|
||||
ctx->need_close = false;
|
||||
}
|
||||
ctx->exception_group_depth -= 1;
|
||||
}
|
||||
}
|
||||
|
||||
if (ctx->exception_group_depth == 1) {
|
||||
ctx->exception_group_depth -= 1;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void
|
||||
print_exception_recursive(struct exception_print_context *ctx, PyObject *value)
|
||||
{
|
||||
int err = 0;
|
||||
if (ctx->seen != NULL) {
|
||||
/* Exception chaining */
|
||||
err = print_exception_cause_and_context(ctx, value);
|
||||
}
|
||||
if (err) {
|
||||
/* don't do anything else */
|
||||
}
|
||||
else if (!_PyBaseExceptionGroup_Check(value)) {
|
||||
print_exception(ctx, value);
|
||||
}
|
||||
else {
|
||||
int prev_depth = ctx->exception_group_depth;
|
||||
err = print_exception_group(ctx, value);
|
||||
if (err < 0) {
|
||||
/* restore the depth as long as we're ignoring errors */
|
||||
ctx->exception_group_depth = prev_depth;
|
||||
}
|
||||
else {
|
||||
assert(prev_depth == ctx->exception_group_depth);
|
||||
}
|
||||
}
|
||||
if (err != 0)
|
||||
PyErr_Clear();
|
||||
|
|
|
|||
Loading…
Reference in New Issue