Skip to content

fix: Resolve issue causing extraneous engine deprecation warnings #5287

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

Merged
merged 2 commits into from
Aug 1, 2025

Conversation

jdbeel
Copy link
Contributor

@jdbeel jdbeel commented Jul 21, 2025

Code PR

  • I have read through the contributing notes and understand the structure of the package. In particular, if my PR modifies code of plotly.graph_objects, my modifications concern the code generator and not the generated files.
  • I have added tests or modified existing tests.
  • For a new feature, I have added documentation examples (please see the doc checklist as well).
  • I have added a CHANGELOG entry if changing anything substantial.
  • For a new feature or a change in behavior, I have updated the relevant docstrings in the code.

@jdbeel
Copy link
Contributor Author

jdbeel commented Jul 21, 2025

Fixes the issue in #5286

I don't believe any docstrings need updating as the ones for the classes/methods I changed do not reference the default for the engine argument. The default was also changed to None further up the API. I believe this should basically be a NOP for most users/flows. If this warrants a change in the CHANGELOG, please let me know. I figured for the above reasons it did not.

@gvwilson gvwilson requested a review from emilykl August 1, 2025 12:18
@gvwilson gvwilson added P1 needed for current cycle community community contribution fix fixes something broken labels Aug 1, 2025
@emilykl emilykl changed the title Update external image renderer engine defaults fix: Resolve issue causing extraneous engine deprecation warnings Aug 1, 2025
Copy link
Contributor

@emilykl emilykl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for running this down @jdbeel, this is great.

I agree, this should be a noop since inside the to_image function, engine is set to "auto" if None is passed.

Once the engine argument is removed from the to_image and write_image functions, we should remove it from these functions as well. Until then this is a good solution.

🚀

@emilykl emilykl merged commit 480a1af into plotly:main Aug 1, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community community contribution fix fixes something broken P1 needed for current cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants