refactor: deprecate kwargs in st.plotly_chart and add config dict instead by zyfy29 · Pull Request #12291 · streamlit/streamlit

zyfy29 · 2025-08-22T09:58:36Z

Describe your changes

mark the **kwargs of st.plotly_chart as deprecated, and add a new config argument to directly pass to plot()

GitHub Issue Link (if applicable)

Closes Deprecate **kwargs in st.plotly_chart and add config instead #12280

Testing Plan

This is a refactor and doesn't break the existing e2e tests for st.plotly_chart, so no new tests are needed.

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

…tead

snyk-io · 2025-08-22T09:58:46Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

Copilot

Pull Request Overview

This PR refactors the st.plotly_chart function to deprecate the use of **kwargs and introduces a new config parameter for passing configuration options directly to Plotly's plot() function. This change improves the API's clarity and follows best practices by making the configuration parameter explicit rather than relying on generic keyword arguments.

Key changes:

Added a new config parameter of type dict | None to the function signature
Added deprecation warning for **kwargs usage
Updated parameter documentation to reflect the new config parameter and deprecation

lib/streamlit/elements/plotly_chart.py

Co-authored-by: Copilot <[email protected]>

lib/streamlit/elements/plotly_chart.py

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

graphite-app · 2025-08-22T13:19:00Z

lib/streamlit/elements/plotly_chart.py

            "box",
            "lasso",
        ),
+        config: dict | None = None,


The config parameter requires a more specific type annotation. Replace dict | None with dict[str, Any] | None to specify the dictionary's key-value types. The Python Guide mandates adding proper typing annotations to every new function parameter, and generic dict typing does not meet this requirement.

Suggested change

config: dict | None = None,

config: dict[str, Any] | None = None,

Spotted by Diamond (based on custom rule: Python Guide)

Is this helpful? React 👍 or 👎 to let us know.

graphite-app · 2025-08-22T13:19:02Z

lib/streamlit/elements/plotly_chart.py

+        if config is None:
+            config = dict(kwargs.get("config", {}))
+            # Copy over some kwargs to config dict. Plotly does the same in plot().
+            # TODO: Remove this once we remove the kwargs support.
+            config.setdefault("showLink", kwargs.get("show_link", False))
+            config.setdefault("linkText", kwargs.get("link_text", False))


Issue: When a config parameter is provided, deprecated kwargs like show_link and link_text are silently ignored rather than being merged into the config.

This creates inconsistent behavior where the same kwargs work when config=None but have no effect when a config is provided. For proper backward compatibility during the deprecation period, the kwargs should still be processed and merged into any user-provided config dict.

Consider modifying the code to merge the kwargs into the config regardless of whether config was provided by the user:

config = dict(config or {}) # Always merge kwargs into config for backward compatibility config.setdefault("showLink", kwargs.get("show_link", False)) config.setdefault("linkText", kwargs.get("link_text", False))

Suggested change

if config is None:

config = dict(kwargs.get("config", {}))

# Copy over some kwargs to config dict. Plotly does the same in plot().

# TODO: Remove this once we remove the kwargs support.

config.setdefault("showLink", kwargs.get("show_link", False))

config.setdefault("linkText", kwargs.get("link_text", False))

config = dict(config or {})

# Copy over some kwargs to config dict. Plotly does the same in plot().

# TODO: Remove this once we remove the kwargs support.

config.setdefault("showLink", kwargs.get("show_link", False))

config.setdefault("linkText", kwargs.get("link_text", False))

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

lib/streamlit/elements/plotly_chart.py

sfc-gh-jrieke · 2025-08-22T16:20:19Z

Hey @zyfy29, thanks for the contribution! Looks good from product side overall, I just left a few small comments above and we should also make sure this is raising a deprecation warning if a kwarg is passed (which I think it doesn't currently?). Will let our engineers give you more feedback on the code :)

lib/streamlit/elements/plotly_chart.py

sfc-gh-lwilby · 2025-08-22T22:39:27Z

Hi @zyfy29 ,

Thanks for submitting this PR!

I left one inline comment, but also,

This is a refactor and doesn't break the existing e2e tests for st.plotly_chart, so no new tests are needed.

I think some test coverage is needed to handle the new case of config being provided.

Also, if @jrieke wants us to provide users with a warning if they try to pass kwargs other than the ones mentioned in the docstring, we will need to add some logic to validate the contents of the kwargs dict and then provide the deprecation warning (note we have a util function for this show_deprecation_warning) and it would be good to add test coverage for this as well.

I have run the CI, and it looks like there are some failures that need to be addressed.

Thanks again for your submission! Let me know if you need any more details on getting this PR merge-ready.

lib/streamlit/elements/plotly_chart.py

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

zyfy29 · 2025-08-23T03:55:55Z

Thank you for the suggestions! I've updated my pr and added a unit test case. I noticed that some e2e test cases using the config dict argument already exist. If a new e2e test case is also needed please tell me and I'll try to do that.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

zyfy29 · 2025-08-26T02:22:39Z

Sorry, I submitted 6a1c15c from copilot but forgot the unit tests. Now It should be OK.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

sfc-gh-lwilby

Thanks @zyfy29 this test coverage looks good to me now.

lukasmasuch · 2025-08-29T10:44:57Z

lib/streamlit/elements/plotly_chart.py

-        config = dict(kwargs.get("config", {}))
-        # Copy over some kwargs to config dict. Plotly does the same in plot().
-        config.setdefault("showLink", kwargs.get("show_link", False))
-        config.setdefault("linkText", kwargs.get("link_text", False))


Just double-checking: we already want to fully remove support for kwargs in this PR? The alternative option would be to show a deprecation warning but keep supporting kwargs in addition to config for some time? cc @sfc-gh-jrieke

Oh no, definitely show a deprecation warning for now but keep kwargs support. I think we can already get rid of copying showLink and linkText to config, since those params don't seem to be used.

lukasmasuch · 2025-08-29T12:22:38Z

lib/streamlit/elements/plotly_chart.py

-        config.setdefault("showLink", kwargs.get("show_link", False))
-        config.setdefault("linkText", kwargs.get("link_text", False))
-
+        config = config or {}


I think we need to do something like: config = config or dict(kwargs.get("config", {})) here to still support kwargs for now. See comment from @sfc-gh-jrieke above.

I took another look at the adoption numbers and I think it's actually fine as is: config is the most used kwarg, which we will support here via the explicit config parameter. Besides that, usage of other parameters is almost non-existent and hasn't been supported anyways (other than showLink and linkText)

refactor: deprecate kwargs in st.plotly_chart and add config dict ins…

bdb4cb1

…tead

Copilot AI review requested due to automatic review settings August 22, 2025 09:58

Copilot AI reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

graphite-app bot reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

Update lib/streamlit/elements/plotly_chart.py

43d9f9d

Co-authored-by: Copilot <[email protected]>

graphite-app bot reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

Update lib/streamlit/elements/plotly_chart.py

a8ca4dc

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

style: run ruff format

ff5a959

graphite-app bot reviewed Aug 22, 2025

View reviewed changes

sfc-gh-jrieke reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

sfc-gh-jrieke reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

sfc-gh-jrieke added status:product-approved Community PR is approved by product team and removed status:needs-product-approval PR requires product approval before merging labels Aug 22, 2025

sfc-gh-lwilby reviewed Aug 22, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

zyfy29 added 2 commits August 23, 2025 12:35

fix: left a warning and ignore kwargs in st.plotly_chart

120d305

test: add and edit ut cases to test st.plotly_chart config parameter

951f4c3

graphite-app bot reviewed Aug 23, 2025

View reviewed changes

lib/streamlit/elements/plotly_chart.py Outdated Show resolved Hide resolved

Update lib/streamlit/elements/plotly_chart.py

6a1c15c

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

zyfy29 requested review from Copilot, sfc-gh-jrieke and sfc-gh-lwilby August 23, 2025 03:57

Copilot AI reviewed Aug 23, 2025

View reviewed changes

sfc-gh-bnisco requested a review from Copilot August 25, 2025 16:26

test: correct deprecation warning message in plotly_chart_test

3eeddb0

Copilot AI reviewed Aug 26, 2025

View reviewed changes

sfc-gh-lwilby added the security-assessment-completed label Aug 26, 2025

sfc-gh-lwilby approved these changes Aug 27, 2025

View reviewed changes

lukasmasuch reviewed Aug 29, 2025

View reviewed changes

lukasmasuch requested changes Aug 29, 2025

View reviewed changes

lukasmasuch approved these changes Aug 29, 2025

View reviewed changes

lukasmasuch merged commit a03c8d4 into streamlit:develop Aug 29, 2025
35 of 37 checks passed

Jamiefaber mentioned this pull request Dec 17, 2025

plotly_chart kwargs deprecation warning #13396

Closed

4 tasks

	config: dict \| None = None,
	config: dict[str, Any] \| None = None,

Conversation

zyfy29 commented Aug 22, 2025 • edited by lukasmasuch Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes

GitHub Issue Link (if applicable)

Testing Plan

Uh oh!

snyk-io bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

graphite-app bot Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

graphite-app bot Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sfc-gh-jrieke commented Aug 22, 2025

Uh oh!

Uh oh!

sfc-gh-lwilby commented Aug 22, 2025

Uh oh!

Uh oh!

zyfy29 commented Aug 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

zyfy29 commented Aug 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

sfc-gh-lwilby left a comment

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrieke Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

zyfy29 commented Aug 22, 2025 •

edited by lukasmasuch

Loading

snyk-io bot commented Aug 22, 2025 •

edited

Loading

lukasmasuch Aug 29, 2025 •

edited

Loading

lukasmasuch Aug 29, 2025 •

edited

Loading