Mark old xType aliases as deprecated #3288
Open
+48
−9
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
Doesn't touch JoystickType because the C code still works the old way I think, doesn't touch CameraType because CameraType is not in the stubs. In fact CameraType might be removable as an internal implementation detail.
ankith26
reviewed
Jan 10, 2025
| class RectType(Rect): ... | ||
|
|
||
| @deprecated("Use `FRect` instead (this is an old alias)") | ||
| class FRectType(FRect): ... |
There was a problem hiding this comment.
Not really a review but an observation, it's funny that FRectType exists in the first place because I'm fairly sure FRect was added after we decided that *Type was not needed anymore and stopped doing it.
| class EventType: | ||
| # Duplicated Event fields here because it is marked as final and can't be | ||
| # subclassed like the other xType aliases are to allow @deprecated. | ||
|
|
There was a problem hiding this comment.
I like how all other instances are elegantly marked as deprecated without duplication, and there's there's this that sticks out.
I get why it's done, but can we find a workaround that doesn't need the duplication? Something like
EventType = deprecated("Use Event instead (this is an old alias)")(Event) should be a one-liner that could work? If it does, this style could be used everywhere
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.
Starts to handle #3239
It would be a huge pain to put in deprecation warnings about this, but the deprecation decorator is easy and we're now using it in other places so lets use it here.
Doesn't touch JoystickType because the C code still works the old way I think, doesn't touch CameraType because CameraType is not in the stubs. In fact CameraType might be removable as an internal implementation detail.