move array_to_imagestr function to be part of public API #2879
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
| pil_imported = False | ||
|
|
||
|
|
||
| def array_to_imagestr(img, backend="pil", compression=4, ext="png"): |
There was a problem hiding this comment.
the name here is maybe something to think about? technically what we are doing here is representing an image array as a data URI so I would vote for something like image_array_to_data_url ?
|
|
||
|
|
||
| def array_to_imagestr(img, backend="pil", compression=4, ext="png"): | ||
| """Converts a numpy array of uint8 into a base64 png string. |
There was a problem hiding this comment.
docstring nit: this isn't always PNG now :)
|
💃 |
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.
Solves #2863.
Now you can do
from plotly.utils import array_to_imagestrHowever,
plotly.utilsis not a subpackage but just a module so it does not appear in the API doc. It'd be easy to change this to use a subpackage like what was done forplotly.colorswhen working on the API doc. One the other hand it's enough for me if the function appears in image-related docs of plotly.py and dash so I won't push hard for this change.