Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename OutputEventRequestState -> OutputRequestStateEvent #210

Open
heuer opened this issue Dec 19, 2024 · 1 comment · May be fixed by #211
Open

Rename OutputEventRequestState -> OutputRequestStateEvent #210

heuer opened this issue Dec 19, 2024 · 1 comment · May be fixed by #211

Comments

@heuer
Copy link
Contributor

heuer commented Dec 19, 2024

For all other events we use "Event" as Suffix (i.e. RequestStartDragEvent, KeyboardKeyEvent, TouchMotionEvent, …).

output.OutputEventRequestState should adapt that scheme.

Maybe deprecate it in the next subrelease and remove it in 0.19?

Or deprecate it in 0.18?

@heuer
Copy link
Contributor Author

heuer commented Dec 19, 2024

On further reflection, deprecation is difficult because pywlroots creates instances of the class, not the user.

We can use something like this:

class OutputRequestStateEvent(Ptr):
    # […]

OutputEventRequestState = OutputRequestStateEvent

to keep mypy etc. happy but I think it's not possible to warn users about the name change.

heuer added a commit to heuer/pywlroots that referenced this issue Dec 20, 2024
* Added support for various wlr_output_event… structs (fixes flacjacket#209)
* Python API exposes more wlr_output_state properties
* Renamed OutputEventRequestState to OutputRequestStateEvent and added
an alias for the previous name (fixes flacjacket#210)
* Updated CHANGES
@heuer heuer linked a pull request Dec 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant