SG-38932 Issue a deprecation warning for the use of the engine::log_ methods #1059
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds deprecation warnings to legacy logging methods in the Engine class to encourage migration to the newer logger interface. The change is part of preparing for the eventual removal of these legacy methods after January 2026.
Key Changes
- Added deprecation warnings to all five legacy logging methods (
log_debug,log_info,log_warning,log_error,log_exception) - Imported the
warningsmodule to support the deprecation functionality - Set consistent warning messages with a removal timeline of 2026-01
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
+1307
to
+1312
| warnings.warn( | ||
| "The `Engine.log_debug` method is deprecated and will be removed " | ||
| "at any time after 2026-01. Use `Engine.logger` instead", | ||
| DeprecationWarning, | ||
| stacklevel=2 | ||
| ) |
There was a problem hiding this comment.
The deprecation warning message is duplicated across all five logging methods. Consider extracting this into a constant or helper function to improve maintainability and ensure consistency.
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.