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

diff --git a/src/pyutils/typez/persistent.py b/src/pyutils/typez/persistent.py
index 75d764a..f577bd8 100644
--- a/src/pyutils/typez/persistent.py
+++ b/src/pyutils/typez/persistent.py
@@ -141,7 +141,7 @@ class PicklingFileBasedPersistent(FileBasedPersistent):
 
     Example usage::
 
-        import persistent
+        from pyutils.typez import persistent
 
         @persistent.persistent_autoloaded_singleton()
         class MyClass(persistent.PicklingFileBasedPersistent):
@@ -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)
@@ -221,7 +229,7 @@ class JsonFileBasedPersistent(FileBasedPersistent):
 
     Example usage::
 
-        import persistent
+        from pyutils.typez import persistent
 
         @persistent.persistent_autoloaded_singleton()
         class MyClass(persistent.JsonFileBasedPersistent):
@@ -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)