MNT: change pickle encoding name to allow_pickle and test it.

Author: phmbressan

rocketpy/_encoders.py

@@ -36,7 +36,7 @@ def __init__(self, *args, **kwargs):
             - 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
+            - allow_pickle: 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
@@ -47,7 +47,7 @@ def __init__(self, *args, **kwargs):
         self.include_outputs = kwargs.pop("include_outputs", 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)
+        self.allow_pickle = kwargs.pop("allow_pickle", True)
         super().__init__(*args, **kwargs)
 
     def default(self, o):
@@ -66,15 +66,15 @@ def default(self, o):
                 encoding = o.to_dict(
                     include_outputs=self.include_outputs,
                     discretize=self.discretize,
-                    pickle_callables=self.pickle_callables,
+                    allow_pickle=self.allow_pickle,
                 )
                 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,
-                pickle_callables=self.pickle_callables,
+                allow_pickle=self.allow_pickle,
             )
             encoding = remove_circular_references(encoding)
 

rocketpy/mathutils/function.py

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

rocketpy/rocket/parachute.py

@@ -252,11 +252,11 @@ 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)
+        allow_pickle = kwargs.get("allow_pickle", True)
         trigger = self.trigger
 
         if callable(self.trigger) and not isinstance(self.trigger, Function):
-            if pickle_callables:
+            if allow_pickle:
                 trigger = to_hex_encode(trigger)
             else:
                 trigger = trigger.__name__
@@ -274,7 +274,7 @@ def to_dict(self, **kwargs):
             data["noise_signal"] = self.noise_signal
             data["noise_function"] = (
                 to_hex_encode(self.noise_function)
-                if pickle_callables
+                if allow_pickle
                 else self.noise_function.__name__
             )
             data["noisy_pressure_signal"] = self.noisy_pressure_signal

tests/integration/test_encoding.py

@@ -6,6 +6,8 @@
 
 from rocketpy._encoders import RocketPyDecoder, RocketPyEncoder
 
+from rocketpy.tools import from_hex_decode
+
 
 @pytest.mark.parametrize(
     ["flight_name", "include_outputs"],
@@ -232,7 +234,7 @@ def test_rocket_encoder(rocket_name, request):
 
 @pytest.mark.parametrize("rocket_name", ["calisto_robust"])
 def test_encoder_discretize(rocket_name, request):
-    """Test encoding the total mass of``rocketpy.Rocket`` with
+    """Test encoding the total mass of ``rocketpy.Rocket`` with
     discretized encoding.
 
     Parameters
@@ -261,3 +263,22 @@ def test_encoder_discretize(rocket_name, request):
         atol=1e-1,
     )
     assert isinstance(mass_loaded.source, np.ndarray)
+
+
+@pytest.mark.parametrize("parachute_name", ["calisto_main_chute"])
+def test_encoder_no_pickle(parachute_name, request):
+    """Test encoding of a ``rocketpy.Parachute`` disallowing
+    pickle usage.
+    """
+    parachute_to_encode = request.getfixturevalue(parachute_name)
+
+    json_encoded = json.dumps(
+        parachute_to_encode,
+        cls=RocketPyEncoder,
+        allow_pickle=False,
+    )
+
+    trigger_loaded = json.loads(json_encoded)["trigger"]
+
+    with pytest.raises(ValueError, match=r"non-hexadecimal number found"):
+        from_hex_decode(trigger_loaded)