{{ message }}
fix(oocana): add warnings.warn for deprecated APIs#464
Open
leavesster wants to merge 1 commit into
Open
Conversation
Use warnings.warn with DeprecationWarning for deprecated methods: - pkg_dir property: deprecated in favor of pkg_data_dir - send_error method: deprecated in favor of error() This allows users to catch deprecation warnings and migrate their code.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds runtime deprecation warnings using Python's warnings.warn() for two deprecated APIs in the Context class that previously only had docstring notices. This ensures users are actively notified when using deprecated functionality.
Changes:
- Added
warningsmodule import - Added
warnings.warn()calls withDeprecationWarningforpkg_dirproperty andsend_error()method - Updated docstrings to use proper Sphinx deprecation directive format
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leavesster
changed the title
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
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.
Summary
warnings.warn()withDeprecationWarningfor deprecated APIspkg_dirproperty,send_error()methodProblem
Deprecated APIs had docstring comments but no runtime warnings:
Users wouldn't know they're using deprecated APIs until reading docs.
Solution
Add proper deprecation warnings:
Test Plan