hpcflow-new2 0.2.0a178__py3-none-any.whl → 0.2.0a180__py3-none-any.whl

hpcflow/sdk/persistence/json.py

@@ -1,3 +1,7 @@
+"""
+Persistence model based on writing JSON documents.
+"""
+
 from __future__ import annotations
 from contextlib import contextmanager
 import copy
@@ -30,6 +34,10 @@ from hpcflow.sdk.persistence.base import update_param_source_dict
 
 
 class JSONPersistentStore(PersistentStore):
+    """
+    A store that writes JSON files for all its state serialization.
+    """
+
     _name = "json"
     _features = PersistentStoreFeatures(
         create=True,
@@ -90,6 +98,9 @@ class JSONPersistentStore(PersistentStore):
             yield md
 
     def remove_replaced_dir(self) -> None:
+        """
+        Remove the directory containing replaced workflow details.
+        """
         with self.using_resource("metadata", "update") as md:
             if "replaced_workflow" in md:
                 self.remove_path(md["replaced_workflow"], self.fs)
@@ -97,6 +108,9 @@ class JSONPersistentStore(PersistentStore):
                 md["replaced_workflow"] = None
 
     def reinstate_replaced_dir(self) -> None:
+        """
+        Reinstate the directory containing replaced workflow details.
+        """
         with self.using_resource("metadata", "read") as md:
             if "replaced_workflow" in md:
                 self.logger.debug(
@@ -128,6 +142,9 @@ class JSONPersistentStore(PersistentStore):
         ts_fmt: str,
         ts_name_fmt: str,
     ) -> None:
+        """
+        Write an empty persistent workflow.
+        """
         fs.mkdir(wk_path)
         submissions = []
         parameters = {
@@ -526,17 +543,29 @@ class JSONPersistentStore(PersistentStore):
             return list(int(i) for i in params["data"].keys())
 
     def get_ts_fmt(self):
+        """
+        Get the format for timestamps.
+        """
         with self.using_resource("metadata", action="read") as md:
             return md["ts_fmt"]
 
     def get_ts_name_fmt(self):
+        """
+        Get the format for timestamps to use in names.
+        """
         with self.using_resource("metadata", action="read") as md:
             return md["ts_name_fmt"]
 
     def get_creation_info(self):
+        """
+        Get information about the creation of the workflow.
+        """
         with self.using_resource("metadata", action="read") as md:
             return copy.deepcopy(md["creation_info"])
 
     def get_name(self):
+        """
+        Get the name of the workflow.
+        """
         with self.using_resource("metadata", action="read") as md:
             return md["name"]