Skip to content

A potential fix for messy error box when Error is KeyError #1932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

A potential fix for messy error box when Error is KeyError #1932

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
adf73fe
A potential fix for messy error boxes by RuntimeError
dafnapension Sep 1, 2025
e934737
solve by extension class of KeyError
dafnapension Sep 2, 2025
e3769ea
better cast
dafnapension Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions src/unitxt/error_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def _get_existing_context(error: Exception):
existing["context_object"],
existing["context"],
)
return str(error), None, {}
return error.original_error if type(error) == ExtKeyError else str(error), None, {}


def _format_object_context(obj: Any) -> Optional[str]:
Expand Down Expand Up @@ -239,13 +239,22 @@ def _store_context_attributes(
"original_message": original_message,
}
try:
error.original_error = type(error)(original_message)
error.original_error = (
original_message
if type(error) == KeyError
else type(error)(original_message)
)
except (TypeError, ValueError):
error.original_error = Exception(original_message)
error.context_object = context_object
error.context = context


class ExtKeyError(KeyError):
def __str__(self):
return "\n" + self.args[0]


def _add_context_to_exception(
original_error: Exception, context_object: Any = None, **context
):
Expand All @@ -262,14 +271,17 @@ def _add_context_to_exception(
}
context_parts = _build_context_parts(final_context_object, final_context)
context_message = _create_context_box(context_parts)
_store_context_attributes(
original_error, final_context_object, final_context, original_message
)
if type(original_error) == KeyError:
f = ExtKeyError(KeyError(original_error))
else:
f = original_error
_store_context_attributes(f, final_context_object, final_context, original_message)
if context_parts:
formatted_message = f"\n{context_message}\n\n{original_message}"
original_error.args = (formatted_message,)
f.args = (formatted_message,)
else:
original_error.args = (original_message,)
f.args = (original_message,)
return f


@contextmanager
Expand Down Expand Up @@ -298,5 +310,5 @@ def error_context(context_object: Any = None, **context):
try:
yield
except Exception as e:
_add_context_to_exception(e, context_object, **context)
raise
f = _add_context_to_exception(e, context_object, **context)
raise f from None