Merge pull request #2 from michellab/bugfix_avoid_reading_incomplete_pkl

Avoid pickling simulation runners before complete initialisation

a3fe/run/_simulation_runner.py

@@ -55,6 +55,7 @@ def __init__(
         dg_multiplier: int = 1,
         ensemble_size: int = 5,
         update_paths: bool = True,
+        dump: bool = True,
     ) -> None:
         """
         base_dir : str, Optional, default: None
@@ -80,6 +81,8 @@ def __init__(
         update_paths: bool, Optional, default: True
             If True, if the simulation runner is loaded by unpickling, then
             update_paths() is called.
+        dump: bool, Optional, default: True
+            If True, the state of the simulation runner is saved to a pickle file.
         """
         # Set up the directories (which may be overwritten if the
         # simulation runner is subsequently loaded from a pickle file)
@@ -140,7 +143,8 @@ def __init__(
             self._set_up_logging()
 
             # Save state
-            self._dump()
+            if dump:
+                self._dump()
 
     def _set_up_logging(self, null: bool = False) -> None:
         """

a3fe/run/calculation.py

@@ -93,6 +93,7 @@ def __init__(
             stream_log_level=stream_log_level,
             ensemble_size=ensemble_size,
             update_paths=update_paths,
+            dump=False,
         )
 
         if not self.loaded_from_pickle:

a3fe/run/lambda_window.py

@@ -122,6 +122,7 @@ def __init__(
             stream_log_level=stream_log_level,
             ensemble_size=ensemble_size,
             update_paths=update_paths,
+            dump=False,
         )
 
         if not self.loaded_from_pickle:

a3fe/run/leg.py

@@ -119,6 +119,7 @@ def __init__(
             stream_log_level=stream_log_level,
             ensemble_size=ensemble_size,
             update_paths=update_paths,
+            dump=False,
         )
 
         if not self.loaded_from_pickle:

a3fe/run/simulation.py

@@ -103,6 +103,7 @@ def __init__(
             output_dir=output_dir,
             stream_log_level=stream_log_level,
             update_paths=update_paths,
+            dump=False,
         )
 
         if not self.loaded_from_pickle:

a3fe/run/stage.py

@@ -146,6 +146,7 @@ def __init__(
             stream_log_level=stream_log_level,
             ensemble_size=ensemble_size,
             update_paths=update_paths,
+            dump=False,
         )
 
         if not self.loaded_from_pickle:

docs/CHANGELOG.rst

@@ -2,6 +2,10 @@
 Change Log
 ===============
 
+v0.1.1
+
+- Ensured that ``simulation_runner`` objects only get pickled once they've been fully initialised. This avoids issues where an error occurs during initialisation and the object is pickled in an incomplete state. Addresses https://github.com/michellab/a3fe/issues/1.
+
 v0.1.0
 ====================