.. _fbf.lib.persiststate:

persiststate
~~~~~~~~~~~~

.. automodule:: fbf.lib.persiststate
        :show-inheritance:
        :members:
        :undoc-members:

CODE
----

    ::

        # fbf/persiststate.py
        #
        #
        
        """ persistent state classes. """
        
.. _fbf.lib.persiststate_fbf_imports:

fbf imports
--------------

    ::

        
        from fbf.utils.name import stripname
        from fbf.utils.trace import calledfrom
        from .persist import Persist
        from fbf.lib.datadir import getdatadir
        
.. _fbf.lib.persiststate_basic_imports:

basic imports
----------------

    ::

        
        import types
        import os
        import sys
        import logging
        
.. _fbf.lib.persiststate_PersistState_classes:

PersistState classes
-----------------------

    ::

        
        class PersistState(Persist):
        
            """ base persitent state class. """
        
            def __init__(self, filename):
                Persist.__init__(self, filename)
                self.types = dict((i, type(j)) for i, j in self.data.items())
        
            def __getitem__(self, key):
                """ get state item. """
                return self.data[key]
        
            def __setitem__(self, key, value):
                """ set state item. """
                self.data[key] = value
        
            def define(self, key, value):
                """ define a state item. """
                if key not in self.data or type(value) != self.types[key]:
                    if type(value) == bytes: value = str(value)
                    if type(value) == int: value = int(value)
                    self.data[key] = value
        
        class PlugState(PersistState):
        
            """ state for plugins. """
        
            def __init__(self, *args, **kwargs):
                self.plugname = calledfrom(sys._getframe())
                logging.debug('persiststate - initialising %s' % self.plugname)
                PersistState.__init__(self, getdatadir() + os.sep + 'state' + os.sep + 'plugs' + os.sep + self.plugname + os.sep + 'state')
        
        class ObjectState(PersistState):
        
            """ state for usage in constructors. """
        
            def __init__(self, *args, **kwargs):
                PersistState.__init__(self, getdatadir() + os.sep + 'state' + os.sep + calledfrom(sys._getframe(1))+'.state')
        
        class UserState(PersistState):
        
            """ state for users. """
        
            def __init__(self, username, filename="state", *args, **kwargs):
                assert username
                username = stripname(username)
                ddir = getdatadir() + os.sep + 'state' + os.sep + 'users' + os.sep + username
                PersistState.__init__(self,  ddir + os.sep + filename)