change the traceback format to print in one line#362
Merged
Conversation
astuyve
approved these changes
Aug 22, 2023
| traceback.print_exc() | ||
| except Exception as e: | ||
| logger.error( | ||
| "Error %s. Traceback: %s", e, traceback.format_exc().replace("\n", "\r") |
Contributor
There was a problem hiding this comment.
oh interesting. This is good, but is there no default method for tracebacks which does this?
Contributor
Author
There was a problem hiding this comment.
i don't think so. it seems that python just uses \n. i saw some people replace it with \\n. i added a screen shot in the description to show the difference.
astuyve
reviewed
Aug 22, 2023
| traceback.print_exc() | ||
| except Exception as e: | ||
| logger.error( | ||
| "Error %s. Traceback: %s", e, traceback.format_exc().replace("\n", "\r") |
Contributor
There was a problem hiding this comment.
One minor nit, we might consider splitting this out into a small util method, as we've got it in a few places and there doesn't seem to be something we'd change depending on input. Maybe the message? Even that can be a param.
Contributor
Author
There was a problem hiding this comment.
been thinking about this. will do.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Format the traceback printout to one line
Motivation
Otherwise the printout would be split into multiple lines and would be hard to read and search.
Testing Guidelines
This trick is just to replace
\nwith\rand the result looks like this:Before:
After:
If we replace with
\nwith\\ninstead:Additional Notes
Types of Changes
Check all that apply