shep

commit dbb2280a034bea0954e95945bee4820e5b873c85
parent 1349741a48fd3a77f8558990ff4c2f897f503b35
Author: lash <dev@holbrook.no>
Date:   Wed,  9 Feb 2022 16:02:57 +0000

WIP docstrings for shep/state.py

Diffstat:
M
shep/persist.py
 | 
11
+++++++++++
M
shep/state.py
 | 
28
++++++++++++++++++++++++++++

2 files changed, 39 insertions(+), 0 deletions(-)
diff --git a/shep/persist.py b/shep/persist.py
@@ -95,6 +95,17 @@ class PersistedState(State):
         return super(PersistedState, self).list(state)
 
 
+    # Return a file path or URL pointing to the persisted state.
+    #
+    # If the key is omitted, the URL to the state item's container must be returned, and None if no such container exists.
+    # 
+    # :param state: State to locate
+    # :type state: int
+    # :param key: Content key to locate
+    # :type key: str
+    # :rtype: str
+    # :returns: Locator pointng to persisted state
+    # :todo: rename to "location"
     def path(self, state, key=None):
         k = self.name(state)
         self.__ensure_store(k)
diff --git a/shep/state.py b/shep/state.py
@@ -419,10 +419,23 @@ class State:
         pass
 
 
+    # In the memory-only class no persisted state is used, and this will return None.
+    # 
+    # See shep.persist.PersistedState.path for more information.
     def path(self, state, key=None):
         return None
 
 
+    # Return the next pure state.
+    # 
+    # Will return the same result as the method next, but without advancing to the new state.
+    #
+    # :param key: Content key to inspect state for
+    # :type key: str
+    # :raises StateItemNotFound: Unknown content key
+    # :raises StateInvalid: Attempt to advance from an alias state, OR beyond the last known pure state.
+    # :rtype: int
+    # :returns: Next state
     def peek(self, key):
         state = self.__keys_reverse.get(key)
         if state == None:
@@ -440,12 +453,27 @@ class State:
         return state
 
 
+    # Advance to the next pure state.
+    #
+    # :param key: Content key to inspect state for
+    # :type key: str
+    # :raises StateItemNotFound: Unknown content key
+    # :raises StateInvalid: Attempt to advance from an alias state, OR beyond the last known pure state.
+    # :rtype: int
+    # :returns: Next state
     def next(self, key):
         from_state = self.state(key)
         new_state = self.peek(key)
         return self.__move(key, from_state, new_state)
 
 
+    # Replace contents associated by content key.
+    # 
+    # :param key: Content key to replace for
+    # :type key: str
+    # :param contents: New contents
+    # :type contents: any
+    # :raises KeyError: Unknown content key
     def replace(self, key, contents):
         self.state(key)
         self.__contents[key] = contents