Adding deprecated to command and parameter decorators #526
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
TheBurchLog
reviewed
Jan 2, 2025
brewtils/decorators.py
Outdated
| @@ -473,6 +485,24 @@ def pre_shutdown(self): | |||
| return _wrapped | |||
|
|
|||
|
|
|||
| def deprecated(_wrapped=None): | |||
There was a problem hiding this comment.
This will conflict with the python provided solution. Instead we need to inspect for this being set.
https://docs.python.org/3/library/warnings.html#warnings.deprecated
There was a problem hiding this comment.
Removed deprecated in favor of deprecated decorator in standard library.
Prior to 3.13: from typing_extensions import deprecated
Python 3.13 and later: from warnings import deprecated
@deprecated("Do not use")
|
Could you add a unit test in this file to ensure things get marked as hidden and the flags are set: |
TheBurchLog
approved these changes
Jan 24, 2025
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.
No description provided.