Expose plotly.io.get_chrome()
#5282
Merged
Conversation
This file contains hidden or 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
gvwilson
approved these changes
Jul 16, 2025
| The path to the directory where Chrome should be installed. | ||
| If None, the default download path will be used. | ||
| """ | ||
| if not kaleido_available() or kaleido_major() < 1: |
There was a problem hiding this comment.
why a confirmation? (not arguing, just think it's very unlikely someone would call the function by accident)
There was a problem hiding this comment.
Do you mean the one on line 837? I agree it's unlikely to be called by accident, but I mainly put it there so users could confirm that the install path makes sense.
In any case, the confirmation only appears when using the command-line plotly_get_chrome command, not when calling the plotly.io.get_chrome() function within a script.
LiamConnors
approved these changes
Jul 16, 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.
Closes #5272
Expose
plotly.io.get_chrome()as a function which can be called from within a Python script.get_chrome()accepts one optional argument,path, which is the location to download Chrome to; if not supplied, the default location defined bychoreographerwill be used.This PR also slightly refactors
get_chrome()into two functions:get_chrome(), which is intended to be called directly in code, andplotly_get_chrome(), which is a CLI wrapper forget_chrome()and intended to be called via theplotly_get_chromecommand from the command line.On this branch, running the following code should work: