graphs from plotly >= 5.8 don't render in databricks

displaying a python figure in an iframe within databricks works with plotly==5.7 but when I attempt to do it using 5.8 it fails with Uncaught SyntaxError: Unexpected token '&&':

How to fix:

by plotly: publish a new plotly version on Pypi that fixes this error
by users:
Until the fix is released by plotly on pypi, users can self-fix via adding the following code to their python scripts or notebooks:

import plotly.io._html as piohtml
piohtml._mathjax_config = """<script type="text/javascript">if (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: "STIX-Web"}});}</script>"""

Background:
This error affects Databricks notebooks with plotly==5.8.0 (and potentially other environments that use a Plotly HTML renderer)
I stumbled across this as part of my work for Databricks.

The root cause of the error is in https://github.com/plotly/plotly.py/blob/HEAD/packages/python/plotly/plotly/io/_html.py#L23

There is a duplicate, consequent &&

The line should say:
if (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: "STIX-Web"}});}\

@fwetdb

Thanks @fwetdb! I'm embarrassed that that got through code review 🙈

@nicolaskruchten

You're welcome! I am glad that I could help! Without plotly being so widely used and open-source at the same time, this fix (including the investigation) would have been neither needed nor possible.

What are your thoughts on the timeline when the fix can be released, @nicolaskruchten ?
Should I open a PR or will you do it internally?

No need for a PR, I can do it. I will try to do a point release tonight or tomorrow morning.

Awesome, thank you for the fast reaction!

There is a stackoverflow question that relates to this. I wanted to comment but I do not have enough reputation for that. Also, I was not able to answer.

Can someone refer them to this issue?
https://stackoverflow.com/questions/72466969/plotly-uncaught-syntaxerror-unexpected-token

fixes type and closes #3756

Merge pull request #3763 from plotly/fix_and_and

@fwetdb

@fwetdb I can't reply to a closed question either, sorry

(actually I can comment, and I did)

https://github.com/plotly/plotly.py/releases/tag/v5.8.1 is out!

@nicolaskruchten

I tried to verify the bug fix but it seems to me like the release does not contain the new code?

Here is what I executed both in a cell both in Databricks and in a binder notebook e.g. the one at bamboolib.com/demo

!pip install plotly==5.8.1

import plotly
plotly.__version__ # 5.8.1

import plotly.io._html as piohtml
display(piohtml._mathjax_config)  # still contains the duplicate &&

import plotly.express as px
df = px.data.medals_long()

fig = px.bar(df, x="medal", y="count", color="nation")
fig

This still shows the error (because the mathjax config is still the old one).

What do you think @nicolaskruchten ?

Huh, that's very strange. I'll admit I didn't do this check myself, I merged the PR and ran the build process so something must be wrong with the build process :(

I'll dig into it and do another release. Sorry!

Another release, coming up!

OK here we go: https://github.com/plotly/plotly.py/releases/tag/v5.8.2

Sorry and thanks for pointing this out :)

Great, thank you and I validated that 5.8.2 works as expected.
Again, awesome response time!

Navigation Menu

Repository navigation

graphs from plotly >= 5.8 don't render in databricks #3756

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

graphs from plotly >= 5.8 don't render in databricks #3756

Description

Activity

fwetdb commented on Jun 7, 2022

nicolaskruchten commented on Jun 7, 2022

fwetdb commented on Jun 7, 2022

nicolaskruchten commented on Jun 7, 2022

fwetdb commented on Jun 7, 2022

fwetdb commented on Jun 7, 2022

nicolaskruchten commented on Jun 8, 2022

nicolaskruchten commented on Jun 8, 2022

nicolaskruchten commented on Jun 8, 2022

fwetdb commented on Jun 9, 2022

nicolaskruchten commented on Jun 10, 2022

nicolaskruchten commented on Jun 10, 2022

nicolaskruchten commented on Jun 10, 2022

fwetdb commented on Jun 10, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions