Rename new JSON functions:

- pio.json.to_plotly_json -> pio.json.to_json_plotly - pio.json.from_plotly_json -> pio.json.from_json_plotly
plotly · nicolaskruchten · May 27, 2021 · Dec 5, 2020 · Dec 5, 2020 · Dec 5, 2020
commit 56a8945a1c3b57dfd286c784dab01471f7fc4e73
diff --git a/packages/python/plotly/plotly/io/_json.py b/packages/python/plotly/plotly/io/_json.py
@@ -58,7 +58,7 @@ def coerce_to_strict(const):
         return const
 
 
-def to_plotly_json(plotly_object, pretty=False, engine=None):
+def to_json_plotly(plotly_object, pretty=False, engine=None):
     """
     Convert a plotly/Dash object to a JSON string representation
 
@@ -198,7 +198,7 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
 
     See Also
     --------
-    to_plotly_json : Convert an arbitrary plotly graph_object or Dash component to JSON
+    to_json_plotly : Convert an arbitrary plotly graph_object or Dash component to JSON
     """
     # Validate figure
     # ---------------
@@ -210,7 +210,7 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
         for trace in fig_dict.get("data", []):
             trace.pop("uid", None)
 
-    return to_plotly_json(fig_dict, pretty=pretty, engine=engine)
+    return to_json_plotly(fig_dict, pretty=pretty, engine=engine)
 
 
 def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=None):
@@ -267,7 +267,7 @@ def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=
         file.write(json_str)
 
 
-def from_plotly_json(value, engine=None):
+def from_json_plotly(value, engine=None):
     """
     Parse JSON string using the specified JSON engine
 
@@ -289,6 +289,10 @@ def from_plotly_json(value, engine=None):
     Returns
     -------
     dict
+
+    See Also
+    --------
+    from_json_plotly : Parse JSON with plotly conventions into a dict
     """
     orjson = get_module("orjson", should_load=True)
 
@@ -297,7 +301,7 @@ def from_plotly_json(value, engine=None):
     if not isinstance(value, (string_types, bytes)):
         raise ValueError(
             """
-from_plotly_json requires a string or bytes argument but received value of type {typ}
+from_json_plotly requires a string or bytes argument but received value of type {typ}
     Received value: {value}""".format(
                 typ=type(value), value=value
             )
@@ -368,7 +372,7 @@ def from_json(value, output_type="Figure", skip_invalid=False, engine=None):
 
     # Decode JSON
     # -----------
-    fig_dict = from_plotly_json(value, engine=engine)
+    fig_dict = from_json_plotly(value, engine=engine)
 
     # Validate coerce output type
     # ---------------------------

diff --git a/packages/python/plotly/plotly/io/json.py b/packages/python/plotly/plotly/io/json.py
@@ -4,6 +4,6 @@
     from_json,
     read_json,
     config,
-    to_plotly_json,
-    from_plotly_json,
+    to_json_plotly,
+    from_json_plotly,
 )
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
@@ -51,15 +51,15 @@ def build_test_dict_string(value_string, pretty=False):
 
 
 def check_roundtrip(value, engine, pretty):
-    encoded = pio.to_plotly_json(value, engine=engine, pretty=pretty)
-    decoded = pio.from_plotly_json(encoded, engine=engine)
-    reencoded = pio.to_plotly_json(decoded, engine=engine, pretty=pretty)
+    encoded = pio.to_json_plotly(value, engine=engine, pretty=pretty)
+    decoded = pio.from_json_plotly(encoded, engine=engine)
+    reencoded = pio.to_json_plotly(decoded, engine=engine, pretty=pretty)
     assert encoded == reencoded
 
     # Check from_plotly_json with bytes on Python 3
     if sys.version_info.major == 3:
         encoded_bytes = encoded.encode("utf8")
-        decoded_from_bytes = pio.from_plotly_json(encoded_bytes, engine=engine)
+        decoded_from_bytes = pio.from_json_plotly(encoded_bytes, engine=engine)
         assert decoded == decoded_from_bytes
 
 
@@ -124,15 +124,15 @@ def datetime_array(request, datetime_value):
 # Encoding tests
 def test_graph_object_input(engine, pretty):
     scatter = go.Scatter(x=[1, 2, 3], y=np.array([4, 5, 6]))
-    result = pio.to_plotly_json(scatter, engine=engine)
+    result = pio.to_json_plotly(scatter, engine=engine)
     expected = """{"type":"scatter","x":[1,2,3],"y":[4,5,6]}"""
     assert result == expected
     check_roundtrip(result, engine=engine, pretty=pretty)
 
 
 def test_numeric_numpy_encoding(numeric_numpy_array, engine, pretty):
     value = build_test_dict(numeric_numpy_array)
-    result = pio.to_plotly_json(value, engine=engine, pretty=pretty)
+    result = pio.to_json_plotly(value, engine=engine, pretty=pretty)
 
     array_str = to_json_test(numeric_numpy_array.tolist())
     expected = build_test_dict_string(array_str, pretty=pretty)
@@ -142,7 +142,7 @@ def test_numeric_numpy_encoding(numeric_numpy_array, engine, pretty):
 
 def test_object_numpy_encoding(object_numpy_array, engine, pretty):
     value = build_test_dict(object_numpy_array)
-    result = pio.to_plotly_json(value, engine=engine, pretty=pretty)
+    result = pio.to_json_plotly(value, engine=engine, pretty=pretty)
 
     array_str = to_json_test(object_numpy_array.tolist())
     expected = build_test_dict_string(array_str)
@@ -155,15 +155,15 @@ def test_datetime(datetime_value, engine, pretty):
         pytest.skip("legacy encoder doesn't strip timezone from scalar datetimes")
 
     value = build_test_dict(datetime_value)
-    result = pio.to_plotly_json(value, engine=engine, pretty=pretty)
+    result = pio.to_json_plotly(value, engine=engine, pretty=pretty)
     expected = build_test_dict_string('"{}"'.format(isoformat_test(datetime_value)))
     assert result == expected
     check_roundtrip(result, engine=engine, pretty=pretty)
 
 
 def test_datetime_arrays(datetime_array, engine, pretty):
     value = build_test_dict(datetime_array)
-    result = pio.to_plotly_json(value, engine=engine)
+    result = pio.to_json_plotly(value, engine=engine)
 
     if isinstance(datetime_array, pd.Series):
         dt_values = [d.isoformat() for d in datetime_array.dt.to_pydatetime().tolist()]