Update to_plotly_json docstring, and implement helper method to creat…

…e a json string easily.
plotly · alexcjohnson · Aug 22, 2023 · Jul 28, 2023 · Aug 2, 2023 · Aug 11, 2023
commit 092e8ba97cbb8c3edeb2df7d5e83c60ed536c54d
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
@@ -8,6 +8,7 @@
 from copy import deepcopy, copy
 import itertools
 from functools import reduce
+import json
 
 from _plotly_utils.utils import (
     _natural_sort_strings,
@@ -17,6 +18,7 @@
     display_string_positions,
     chomp_empty_strings,
     find_closest_string,
+    PlotlyJSONEncoder,
 )
 from _plotly_utils.exceptions import PlotlyKeyError
 from .optional_imports import get_module
@@ -3316,14 +3318,26 @@ def to_dict(self):
 
     def to_plotly_json(self):
         """
-        Convert figure to a JSON representation as a Python dict
+        Convert figure to a JSON representation as a Python dict.
+
+        Note: May include some JSON-invalid data types, use the `PlotlyJSONEncoder` util when encoding.
 
         Returns
         -------
         dict
         """
         return self.to_dict()
 
+    def to_json_str(self):
+        """
+        Convert to a JSON string representation.
+
+        Returns
+        -------
+        str
+        """
+        return json.dumps(self.to_plotly_json(), cls=PlotlyJSONEncoder)
+
     @staticmethod
     def _to_ordered_dict(d, skip_uid=False):
         """
@@ -5603,6 +5617,16 @@ def to_plotly_json(self):
         """
         return deepcopy(self._props if self._props is not None else {})
 
+    def to_json_str(self):
+        """
+        Convert to a JSON string representation.
+
+        Returns
+        -------
+        str
+        """
+        return json.dumps(self.to_plotly_json(), cls=PlotlyJSONEncoder)
+
     @staticmethod
     def _vals_equal(v1, v2):
         """