add utf-8 encoding to file handlers for logging #1916
Merged
Conversation
This file contains 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
nponeccop
approved these changes
Apr 16, 2023
cschiller
reviewed
Apr 16, 2023
| @@ -46,15 +46,19 @@ def __init__(self): | |||
| self.console_handler.setFormatter(console_formatter) | |||
|
|
|||
| # Info handler in activity.log | |||
| self.file_handler = logging.FileHandler(os.path.join(log_dir, log_file)) | |||
| self.file_handler = logging.FileHandler( | |||
| os.path.join(log_dir, log_file), 'a', 'utf-8' | |||
There was a problem hiding this comment.
Specifying the mode 'a' is unnecessary, since this is the default. Just adding encoding='utf-8' is enough, and is also more readable.
So the change becomes:
self.file_handler = logging.FileHandler(os.path.join(log_dir, log_file), encoding='utf-8')
cschiller
reviewed
Apr 16, 2023
| self.file_handler.setLevel(logging.DEBUG) | ||
| info_formatter = AutoGptFormatter( | ||
| "%(asctime)s %(levelname)s %(title)s %(message_no_color)s" | ||
| ) | ||
| self.file_handler.setFormatter(info_formatter) | ||
|
|
||
| # Error handler error.log | ||
| error_handler = logging.FileHandler(os.path.join(log_dir, error_file)) | ||
| error_handler = logging.FileHandler( | ||
| os.path.join(log_dir, error_file), 'a', 'utf-8' |
There was a problem hiding this comment.
Specifying the mode 'a' is unnecessary, since this is the default. Just adding encoding='utf-8' is enough, and is also more readable.
So the change becomes:
error_handler = logging.FileHandler(os.path.join(log_dir, error_file), encoding='utf-8')
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Background
Using characters (like “→”) not in cp1252 causes logger to throw error:
UnicodeEncodeError: 'charmap' codec can't encode character '\u2192' in position 48: character maps to <undefined>Changes
Added 'utf-8' parameter to Logger's FileHandlers.
PR Quality Checklist