ENH: allow for disallowing pickle on encoding.

Author: phmbressan

rocketpy/_encoders.py

@@ -13,12 +13,41 @@
 
 class RocketPyEncoder(json.JSONEncoder):
     """Custom JSON encoder for RocketPy objects. It defines how to encode
-    different types of objects to a JSON supported format."""
+    different types of objects to a JSON supported format.
+    """
 
     def __init__(self, *args, **kwargs):
+        """Initializes the encoder with parameter options.
+
+        Parameters
+        ----------
+        *args : tuple
+            Positional arguments to pass to the parent class.
+        **kwargs : dict
+            Keyword arguments to configure the encoder. The following
+            options are available:
+            - include_outputs: bool, whether to include simulation outputs.
+              Default is False.
+            - include_function_data: bool, whether to include Function
+              data in the encoding. If False, Functions will be encoded by their
+              ``__repr__``. This is useful for reducing the size of the outputs,
+              but it prevents full restoration of the object upon decoding.
+              Default is True.
+            - discretize: bool, whether to discretize Functions whose source
+              are callables. If True, the accuracy of the decoding may be reduced.
+              Default is False.
+            - pickle_callables: bool, whether to pickle callable objects. If
+              False, callable sources (such as user-defined functions, parachute
+              triggers or simulation callable outputs) will have their name
+              stored instead of the function itself. This is useful for
+              reducing the size of the outputs, but it prevents full restoration
+              of the object upon decoding.
+              Default is True.
+        """
         self.include_outputs = kwargs.pop("include_outputs", False)
-        self.discretize = kwargs.pop("discretize", False)
         self.include_function_data = kwargs.pop("include_function_data", True)
+        self.discretize = kwargs.pop("discretize", False)
+        self.pickle_callables = kwargs.pop("pickle_callables", True)
         super().__init__(*args, **kwargs)
 
     def default(self, o):
@@ -35,13 +64,17 @@ def default(self, o):
                 return str(o)
             else:
                 encoding = o.to_dict(
-                    include_outputs=self.include_outputs, discretize=self.discretize
+                    include_outputs=self.include_outputs,
+                    discretize=self.discretize,
+                    pickle_callables=self.pickle_callables,
                 )
                 encoding["signature"] = get_class_signature(o)
                 return encoding
         elif hasattr(o, "to_dict"):
             encoding = o.to_dict(
-                include_outputs=self.include_outputs, discretize=self.discretize
+                include_outputs=self.include_outputs,
+                discretize=self.discretize,
+                pickle_callables=self.pickle_callables,
             )
             encoding = remove_circular_references(encoding)
 

rocketpy/mathutils/function.py

@@ -3578,7 +3578,10 @@ def to_dict(self, **kwargs):  # pylint: disable=unused-argument
         source = self.source
 
         if callable(source):
-            source = to_hex_encode(source)
+            if kwargs.get("pickle_callables", True):
+                source = to_hex_encode(source)
+            else:
+                source = source.__name__
 
         return {
             "source": source,

rocketpy/rocket/parachute.py

@@ -252,10 +252,14 @@ def all_info(self):
         # self.plots.all() # Parachutes still doesn't have plots
 
     def to_dict(self, **kwargs):
+        pickle_callables = kwargs.get("pickle_callables", True)
         trigger = self.trigger
 
         if callable(self.trigger) and not isinstance(self.trigger, Function):
-            trigger = to_hex_encode(trigger)
+            if pickle_callables:
+                trigger = to_hex_encode(trigger)
+            else:
+                trigger = trigger.__name__
 
         data = {
             "name": self.name,
@@ -268,7 +272,11 @@ def to_dict(self, **kwargs):
 
         if kwargs.get("include_outputs", False):
             data["noise_signal"] = self.noise_signal
-            data["noise_function"] = to_hex_encode(self.noise_function)
+            data["noise_function"] = (
+                to_hex_encode(self.noise_function)
+                if pickle_callables
+                else self.noise_function.__name__
+            )
             data["noisy_pressure_signal"] = self.noisy_pressure_signal
             data["clean_pressure_signal"] = self.clean_pressure_signal