Add active state count, override default state name

CHANGELOG

@@ -1,3 +1,17 @@
+- 0.2.10
+	* Add count active states method
+	* Enable complete replace of NEW state on state instantiation
+- 0.2.9
+	* Enable access to is_pure method
+	* Numeric option for elements return value
+- 0.2.8
+	* Remove sync on persist set
+- 0.2.7
+	* Handle missing files in fs readdir list
+- 0.2.6
+	* Ensure atomic state lock in fs
+- 0.2.5
+	* Correct handling of persistent sync when no not-state filter has been set
 - 0.2.4
 	* Add optional concurrency lock for persistence store, implemented for file store
 - 0.2.3

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = shep
-version = 0.2.4
+version = 0.2.10
 description = Multi-state key stores using bit masks
 author = Louis Holbrook
 author_email = dev@holbrook.no

shep/persist.py

@@ -20,8 +20,8 @@ class PersistedState(State):
     :type logger: object
     """
 
-    def __init__(self, factory, bits, logger=None, verifier=None, check_alias=True, event_callback=None):
-        super(PersistedState, self).__init__(bits, logger=logger, verifier=verifier, check_alias=check_alias, event_callback=event_callback)
+    def __init__(self, factory, bits, logger=None, verifier=None, check_alias=True, event_callback=None, default_state=None):
+        super(PersistedState, self).__init__(bits, logger=logger, verifier=verifier, check_alias=check_alias, event_callback=event_callback, default_state=default_state)
         self.__store_factory = factory
         self.__stores = {}
 
@@ -69,7 +69,7 @@ class PersistedState(State):
             super(PersistedState, self).unset(key, or_state, allow_base=True)
             raise e
        
-        self.sync(to_state)
+        #self.sync(to_state)
 
         return to_state
 
@@ -144,7 +144,7 @@ class PersistedState(State):
         return to_state
 
 
-    def sync(self, state=None):
+    def sync(self, state=None, not_state=None):
         """Reload resources for a single state in memory from the persisted state store.
 
         :param state: State to load
@@ -153,11 +153,19 @@ class PersistedState(State):
         # :todo: if sync state is none, sync all
         """
 
-        states = []
+        states_numeric = []
         if state == None:
-            states = list(self.all())
+            states_numeric = list(self.all(numeric=True))
         else:
-            states = [self.name(state)]
+            states_numeric = [state]
+       
+        states = []
+        for state in states_numeric:
+            if not_state != None:
+                if state & not_state == 0:
+                    states.append(self.name(state))
+            else:
+                states.append(self.name(state))
 
         ks = []
         for k in states:

shep/state.py

@@ -30,16 +30,22 @@ class State:
 
     base_state_name = 'NEW'
 
-    def __init__(self, bits, logger=None, verifier=None, check_alias=True, event_callback=None):
+    def __init__(self, bits, logger=None, verifier=None, check_alias=True, event_callback=None, default_state=None):
         self.__initial_bits = bits
         self.__bits = bits
         self.__limit = (1 << bits) - 1
         self.__c = 0
-        setattr(self, self.base_state_name, 0)
 
-        self.__reverse = {0: getattr(self, self.base_state_name)}
-        self.__keys = {getattr(self, self.base_state_name): []}
+        if default_state == None:
+            default_state = self.base_state_name
+
+        setattr(self, default_state, 0)
+
+        self.__reverse = {0: getattr(self, default_state)}
+        self.__keys = {getattr(self, default_state): []}
         self.__keys_reverse = {}
+        if default_state != self.base_state_name:
+            self.__keys_reverse[default_state] = 0
         self.__contents = {}
         self.modified_last = {}
         self.verifier = verifier
@@ -53,7 +59,7 @@ class State:
 
 
     # return true if v is a single-bit state
-    def __is_pure(self, v):
+    def is_pure(self, v):
         if v == 0:
             return True
         c = 1
@@ -139,7 +145,7 @@ class State:
     def __add_state_list(self, state, item):
         if self.__keys.get(state) == None:
             self.__keys[state] = []
-        if not self.__is_pure(state) or state == 0:
+        if not self.is_pure(state) or state == 0:
             self.__keys[state].append(item)
         c = 1
         for i in range(self.__bits):
@@ -196,7 +202,7 @@ class State:
         for a in args:
             a = self.__check_value_cursor(a)
             v = self.__check_limit(v | a, pure=False)
-        if self.__is_pure(v):
+        if self.is_pure(v):
             raise ValueError('use add to add pure values')
         return self.__set(k, v)
 
@@ -217,36 +223,49 @@ class State:
         return self.__alias(k, *args)    
 
 
-    def all(self, pure=False):
-        """Return list of all unique atomic and alias states.
+    def all(self, pure=False, numeric=False):
+        """Return list of all unique atomic and alias state strings.
         
         :rtype: list of ints
         :return: states
         """
         l = []
         for k in dir(self):
+            state = None
             if k[0] == '_':
                 continue
             if k.upper() != k:
                 continue
             if pure:
                 state = self.from_name(k)
-                if not self.__is_pure(state):
+                if not self.is_pure(state):
                     continue
-            l.append(k)
+            if numeric:
+                if state == None:
+                    state = self.from_name(k)
+                l.append(state)
+            else:
+                l.append(k)
         l.sort()
         return l
 
 
-    def elements(self, v):
+    def elements(self, v, numeric=False, as_string=True):
         r = []
         if v == None or v == 0:
             return self.base_state_name
         c = 1
         for i in range(self.__bits):
             if v & c > 0:
-                r.append(self.name(c))
+                if numeric:
+                    r.append(c)
+                else:
+                    r.append(self.name(c))
             c <<= 1
+
+        if numeric or not as_string:
+            return r
+
         return '_' + '.'.join(r)
 
 
@@ -427,7 +446,7 @@ class State:
         :rtype: int
         :returns: Resulting state
         """
-        if not self.__is_pure(or_state):
+        if not self.is_pure(or_state):
             raise ValueError('can only apply using single bit states')
 
         current_state = self.__keys_reverse.get(key)
@@ -457,7 +476,7 @@ class State:
         :rtype: int
         :returns: Resulting state
         """
-        if not self.__is_pure(not_state):
+        if not self.is_pure(not_state):
             raise ValueError('can only apply using single bit states')
 
         current_state = self.__keys_reverse.get(key)
@@ -573,7 +592,7 @@ class State:
         state = self.__keys_reverse.get(key)
         if state == None:
             raise StateItemNotFound(key)
-        if not self.__is_pure(state):
+        if not self.is_pure(state):
             raise StateInvalid('cannot run next on an alias state')
        
         if state == 0:
@@ -628,3 +647,27 @@ class State:
         statemask = ~statemask
         statemask &= self.__limit
         return statemask
+
+
+    def purge(self, key):
+        state = self.state(key)
+        state_name = self.name(state)
+
+        v = self.__keys.get(state)
+        v.remove(key) 
+
+        del self.__keys_reverse[key]
+
+        try:
+            del self.__contents[key]
+        except KeyError:
+            pass
+
+        try:
+            del self.modified_last[key]
+        except KeyError:
+            pass
+
+
+    def count(self):
+        return self.__c

shep/store/file.py

@@ -28,22 +28,17 @@ class SimpleFileStore:
             os.makedirs(lock_path, exist_ok=True)
 
 
-    def __is_locked(self, k):
-        if self.__lock_path == None:
-            return False
-        for v in os.listdir(self.__lock_path):
-            if k == v:
-                return True
-        return False
-       
-
     def __lock(self, k):
         if self.__lock_path == None:
             return
-        if self.__is_locked(k):
-            raise StateLockedKey(k)
         fp = os.path.join(self.__lock_path, k)
-        f = open(fp, 'w')
+        f = None
+        try:
+            f = open(fp, 'x')
+        except FileExistsError:
+            pass
+        if f == None:
+            raise StateLockedKey(k)
         f.close()
 
 
@@ -120,7 +115,11 @@ class SimpleFileStore:
         files = []
         for p in os.listdir(self.__path):
             fp = os.path.join(self.__path, p)
-            f = open(fp, self.__m[0])
+            f = None
+            try:
+                f = open(fp, self.__m[0])
+            except FileNotFoundError:
+                continue
             r = f.read()
             f.close()
             if len(r) == 0:

tests/test_state.py

@@ -7,6 +7,7 @@ from shep import State
 from shep.error import (
         StateExists,
         StateInvalid,
+        StateItemNotFound,
         )
 
 logging.basicConfig(level=logging.DEBUG)
@@ -250,5 +251,76 @@ class TestState(unittest.TestCase):
         self.assertEqual(mask, states.ALL)
 
 
+    def test_remove(self):
+        states = State(1)
+        states.add('foo')
+
+        states.put('xyzzy', contents='plugh')
+        v = states.get('xyzzy')
+        self.assertEqual(v, 'plugh')
+
+        states.next('xyzzy')
+
+        v = states.state('xyzzy')
+        self.assertEqual(states.FOO, v)
+
+        states.purge('xyzzy')
+       
+        with self.assertRaises(StateItemNotFound):
+            states.state('xyzzy')
+
+
+    def test_elements(self):
+        states = State(2)
+        states.add('foo')
+        states.add('bar')
+        states.alias('baz', states.FOO, states.BAR)
+
+        v = states.elements(states.BAZ)
+        self.assertIn('FOO', v)
+        self.assertIn('BAR', v)
+        self.assertIsInstance(v, str)
+
+        v = states.elements(states.BAZ, numeric=True)
+        self.assertIn(states.FOO, v)
+        self.assertIn(states.BAR, v)
+
+        v = states.elements(states.BAZ, as_string=False)
+        self.assertIn('FOO', v)
+        self.assertIn('BAR', v)
+        self.assertNotIsInstance(v, str)
+        self.assertIsInstance(v, list)
+
+
+    def test_count(self):
+        states = State(3)
+        states.add('foo')
+        states.add('bar')
+        self.assertEqual(states.count(), 2)
+        states.add('baz')
+        self.assertEqual(states.count(), 3)
+
+
+    def test_pure(self):
+        states = State(2)
+        states.add('foo')
+        states.add('bar')
+        states.alias('baz', states.FOO, states.BAR)
+
+        v = states.is_pure(states.BAZ)
+        self.assertFalse(v)
+
+        v = states.is_pure(states.FOO)
+        self.assertTrue(v)
+
+
+    def test_default(self):
+        states = State(2, default_state='FOO')
+        with self.assertRaises(StateItemNotFound):
+            states.state('NEW')
+        getattr(states, 'FOO')
+        states.state('FOO')
+
+
 if __name__ == '__main__':
     unittest.main()