Repository navigation
Handle serializing dicts with ints and strings #3380
Description
The current to_json_plotly doesn't handle dicts with integers and strings as keys. This used to work before we set sort_keys=True.
This is relatively common in Dash.
Here is a MWE:
import pandas as pd
from plotly.io.json import to_json_plotly
df = pd.DataFrame({'a': [0], 1: [0]})
to_json_plotly(df.to_dict('records'))TypeError: '<' not supported between instances of 'int' and 'str'
Here is the issue in the Python tracker: https://bugs.python.org/issue25457 re sort_keys=True
Originally reported in https://community.plotly.com/t/dash-2-0-0-migration-error/56478/7
Activity
nicolaskruchten commentedon Sep 13, 2021
@jonmmease is this something you could take a look at please? There's going to be some ambiguity if the same dict has
1and"1"as keys...nicolaskruchten commentedon Sep 13, 2021
Admittedly, that's an ambiguity that JSON imposes.
jonmmease commentedon Sep 14, 2021
FWIW, this can be reproduced without plotly.py
The reason that we're hitting this now is that we switched to using
sort_keys=Trueduring theorjsonrefactor.As @chriddyp pointed out, there is a 2+ year long discussion in https://bugs.python.org/issue25457 on whether this is actually a bug in the Python 3 json module.
Maybe it was a mistake to set
sort_keys=True. This is the behavior of orjson, and at the time it seemed reasonable to align the output across json engines 🙂I don' t see a way to address this from within our custom
PlotlyJSONEncoder, so I see two options:sort_keys=True, adjusting tests to accept that the json engines will not produce identical resultsjson.dumpsand catch the exception. If the exception is raised, clone the input dict and modify it to convert non-string keys to strings before runningjson.dumpsagain.Thoughts @nicolaskruchten ?
nicolaskruchten commentedon Sep 15, 2021
Hmmm yeah, it kinda feels like "Remove sort_keys=True, adjusting tests to accept that the json engines will not produce identical results" is the safer route... basically getting folks to opt-in to
orjsonand any related constraints. Sorry!