NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

DOC: Suggest replacement for tostring_rgb#25502

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

QuLogic merged 3 commits intomatplotlib:mainfromlarsoner:doc

Mar 23, 2023

Merged

DOC: Suggest replacement for tostring_rgb#25502

QuLogic merged 3 commits intomatplotlib:mainfromlarsoner:doc

Mar 23, 2023

Conversation

Copy link

Contributor

larsoner commentedMar 19, 2023•
edited
Loading

We hit thisDeprecationWarning in MNE-Python (EDIT: After9c79686) and I had to go to the commits to see the comment thatargb should cover most use cases.

If this makes sense to add then I'll modify the actual warning itself, too, which would have made finding the workaround even faster.

DOC: Suggest replacement

3ac1b53

larsoner marked this pull request as draft

March 19, 2023 11:02

Copy link

Member

oscargus commentedMar 19, 2023

I think this makes sense!

timhoffm reviewed

Mar 19, 2023

View reviewed changes

doc/api/next_api_changes/deprecations/XXXXX-AL.rst OutdatedShow resolvedHide resolved

Copy link

Member

tacaswell commentedMar 20, 2023

I am 👍🏻 on this and adding the note to the message itself as well.

Copy link

Contributor

anntzer commentedMar 20, 2023

Note that it was also suggested to deprecate tostring_argb (#25484 (review)). In the use case of mne-python (mne-tools/mne-python#11574?) I would suggest using e.g.np.array(canvas.buffer_rgba()) instead.

Copy link

ContributorAuthor

larsoner commentedMar 20, 2023

I would suggest using e.g. np.array(canvas.buffer_rgba()) instead.

It seems like this should be the suggested replacement then, right?

Copy link

Contributor

anntzer commentedMar 20, 2023

It's not really a direct replacement, as the channel order is not the same; it depends on what exactly you want (but in the case of MNE python you're really just checking that the values are the same, so the channel order doesn't matter). Also this doesn't do the conversion-to-a-string that in MNE-python's case gets immediately undone by np.frombuffer.