Remove the new "json" encoder

jonmmease · jonmmease · commit 80be8bd272d0 · 2021-01-22T12:38:37.000-05:00
since it's sometimes slower, and never faster, than current encoder.

Rename "legacy" to "json".
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
@@ -3416,9 +3416,8 @@ def to_json(self, *args, **kwargs):
 
         engine: str (default None)
             The JSON encoding engine to use. One of:
-              - "json" for a rewritten encoder based on the built-in Python json module
+              - "json" for an encoder based on the built-in Python json module
               - "orjson" for a fast encoder the requires the orjson package
-              - "legacy" for the legacy JSON encoder.
             If not specified, the default encoder is set to the current value of
             plotly.io.json.config.default_encoder.
 
@@ -3480,9 +3479,8 @@ def write_json(self, *args, **kwargs):
 
         engine: str (default None)
             The JSON encoding engine to use. One of:
-              - "json" for a rewritten encoder based on the built-in Python json module
+              - "json" for an encoder based on the built-in Python json module
               - "orjson" for a fast encoder the requires the orjson package
-              - "legacy" for the legacy JSON encoder.
             If not specified, the default encoder is set to the current value of
             plotly.io.json.config.default_encoder.
 
diff --git a/packages/python/plotly/plotly/io/_json.py b/packages/python/plotly/plotly/io/_json.py
@@ -13,7 +13,7 @@
 # Orca configuration class
 # ------------------------
 class JsonConfig(object):
-    _valid_engines = ("legacy", "json", "orjson", "auto")
+    _valid_engines = ("json", "orjson", "auto")
 
     def __init__(self):
         self._default_engine = "auto"
@@ -74,7 +74,6 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
         The JSON encoding engine to use. One of:
           - "json" for an engine based on the built-in Python json module
           - "orjson" for a faster engine that requires the orjson package
-          - "legacy" for the legacy JSON engine.
           - "auto" for the "orjson" engine if available, otherwise "json"
         If not specified, the default engine is set to the current value of
         plotly.io.json.config.default_engine.
@@ -99,7 +98,7 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
             engine = "orjson"
         else:
             engine = "json"
-    elif engine not in ["orjson", "json", "legacy"]:
+    elif engine not in ["orjson", "json"]:
         raise ValueError("Invalid json engine: %s" % engine)
 
     modules = {
@@ -111,43 +110,17 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
 
     # Dump to a JSON string and return
     # --------------------------------
-    if engine in ("json", "legacy"):
+    if engine == "json":
         opts = {"sort_keys": True}
         if pretty:
             opts["indent"] = 2
         else:
             # Remove all whitespace
             opts["separators"] = (",", ":")
 
-        if engine == "json":
-            cleaned = clean_to_json_compatible(
-                plotly_object,
-                numpy_allowed=False,
-                datetime_allowed=False,
-                modules=modules,
-            )
-            encoded_o = json.dumps(cleaned, **opts)
-
-            if not ("NaN" in encoded_o or "Infinity" in encoded_o):
-                return encoded_o
-
-            # now:
-            #    1. `loads` to switch Infinity, -Infinity, NaN to None
-            #    2. `dumps` again so you get 'null' instead of extended JSON
-            try:
-                new_o = json.loads(encoded_o, parse_constant=coerce_to_strict)
-            except ValueError:
-                # invalid separators will fail here. raise a helpful exception
-                raise ValueError(
-                    "Encoding into strict JSON failed. Did you set the separators "
-                    "valid JSON separators?"
-                )
-            else:
-                return json.dumps(new_o, **opts)
-        else:
-            from _plotly_utils.utils import PlotlyJSONEncoder
+        from _plotly_utils.utils import PlotlyJSONEncoder
 
-            return json.dumps(plotly_object, cls=PlotlyJSONEncoder, **opts)
+        return json.dumps(plotly_object, cls=PlotlyJSONEncoder, **opts)
     elif engine == "orjson":
         JsonConfig.validate_orjson()
         opts = orjson.OPT_SORT_KEYS | orjson.OPT_SERIALIZE_NUMPY
@@ -197,7 +170,6 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
         The JSON encoding engine to use. One of:
           - "json" for an engine based on the built-in Python json module
           - "orjson" for a faster engine that requires the orjson package
-          - "legacy" for the legacy JSON engine.
           - "auto" for the "orjson" engine if available, otherwise "json"
         If not specified, the default engine is set to the current value of
         plotly.io.json.config.default_engine.
@@ -249,7 +221,6 @@ def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=
         The JSON encoding engine to use. One of:
           - "json" for an engine based on the built-in Python json module
           - "orjson" for a faster engine that requires the orjson package
-          - "legacy" for the legacy JSON engine.
           - "auto" for the "orjson" engine if available, otherwise "json"
         If not specified, the default engine is set to the current value of
         plotly.io.json.config.default_engine.
@@ -289,7 +260,7 @@ def from_json_plotly(value, engine=None):
 
     engine: str (default None)
         The JSON decoding engine to use. One of:
-          - if "json" or "legacy", parse JSON using built in json module
+          - if "json", parse JSON using built in json module
           - if "orjson", parse using the faster orjson module, requires the orjson
             package
           - if "auto" use orjson module if available, otherwise use the json module
@@ -327,7 +298,7 @@ def from_json_plotly(value, engine=None):
             engine = "orjson"
         else:
             engine = "json"
-    elif engine not in ["orjson", "json", "legacy"]:
+    elif engine not in ["orjson", "json"]:
         raise ValueError("Invalid json engine: %s" % engine)
 
     if engine == "orjson":
@@ -362,7 +333,7 @@ def from_json(value, output_type="Figure", skip_invalid=False, engine=None):
 
     engine: str (default None)
         The JSON decoding engine to use. One of:
-          - if "json" or "legacy", parse JSON using built in json module
+          - if "json", parse JSON using built in json module
           - if "orjson", parse using the faster orjson module, requires the orjson
             package
           - if "auto" use orjson module if available, otherwise use the json module
@@ -416,7 +387,7 @@ def read_json(file, output_type="Figure", skip_invalid=False, engine=None):
 
     engine: str (default None)
         The JSON decoding engine to use. One of:
-          - if "json" or "legacy", parse JSON using built in json module
+          - if "json", parse JSON using built in json module
           - if "orjson", parse using the faster orjson module, requires the orjson
             package
           - if "auto" use orjson module if available, otherwise use the json module
diff --git a/packages/python/plotly/plotly/tests/test_io/test_to_from_plotly_json.py b/packages/python/plotly/plotly/tests/test_io/test_to_from_plotly_json.py
@@ -65,9 +65,9 @@ def check_roundtrip(value, engine, pretty):
 
 # Fixtures
 if orjson is not None:
-    engines = ["json", "orjson", "legacy", "auto"]
+    engines = ["json", "orjson", "auto"]
 else:
-    engines = ["json", "legacy", "auto"]
+    engines = ["json", "auto"]
 
 
 @pytest.fixture(scope="module", params=engines)
