X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=src%2Fpyutils%2Ftypez%2Fpersistent.py;h=f577bd8cc14a8d00afe7dc917f9eda913635e0d4;hb=HEAD;hp=47762601ac6fde047c75095628c9c6878414e34a;hpb=d7ddad43f15846bf603f8ba2ef76b3f72556301f;p=pyutils.git

diff --git a/src/pyutils/typez/persistent.py b/src/pyutils/typez/persistent.py
index 4776260..f577bd8 100644
--- a/src/pyutils/typez/persistent.py
+++ b/src/pyutils/typez/persistent.py
@@ -184,6 +184,10 @@ class PicklingFileBasedPersistent(FileBasedPersistent):
     def load(
         cls: type[PicklingFileBasedPersistent],
     ) -> Optional[PicklingFileBasedPersistent]:
+        """
+        Raises:
+            Exception: failure to load from file.
+        """
         filename = cls.get_filename()
         if cls.should_we_load_data(filename):
             logger.debug("Attempting to load state from %s", filename)
@@ -202,6 +206,10 @@ class PicklingFileBasedPersistent(FileBasedPersistent):
 
     @overrides
     def save(self) -> bool:
+        """
+        Raises:
+            Exception: failure to save to file.
+        """
         filename = self.get_filename()
         if self.should_we_save_data(filename):
             logger.debug("Trying to save state in %s", filename)
@@ -266,6 +274,10 @@ class JsonFileBasedPersistent(FileBasedPersistent):
     @classmethod
     @overrides
     def load(cls: type[JsonFileBasedPersistent]) -> Optional[JsonFileBasedPersistent]:
+        """
+        Raises:
+            Exception: failure to load from file.
+        """
         filename = cls.get_filename()
         if cls.should_we_load_data(filename):
             logger.debug("Trying to load state from %s", filename)
@@ -295,6 +307,10 @@ class JsonFileBasedPersistent(FileBasedPersistent):
 
     @overrides
     def save(self) -> bool:
+        """
+        Raises:
+            Exception: failure to save to file.
+        """
         filename = self.get_filename()
         if self.should_we_save_data(filename):
             logger.debug("Trying to save state in %s", filename)