shelve.py 4.85 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
"""Manage shelves of pickled objects.

A "shelf" is a persistent, dictionary-like object.  The difference
with dbm databases is that the values (not the keys!) in a shelf can
be essentially arbitrary Python objects -- anything that the "pickle"
module can handle.  This includes most class instances, recursive data
types, and objects containing lots of shared sub-objects.  The keys
are ordinary strings.

To summarize the interface (key is a string, data is an arbitrary
object):

13 14
        import shelve
        d = shelve.open(filename) # open, with (g)dbm filename -- no suffix
15

16 17 18 19 20 21 22 23
        d[key] = data   # store data at key (overwrites old data if
                        # using an existing key)
        data = d[key]   # retrieve data at key (raise KeyError if no
                        # such key)
        del d[key]      # delete data stored at key (raises KeyError
                        # if no such key)
        flag = d.has_key(key)   # true if the key exists
        list = d.keys() # a list of all existing keys (slow!)
24

25
        d.close()       # close it
26 27 28 29

Dependent on the implementation, closing a persistent dictionary may
or may not be necessary to flush changes to disk.
"""
30

31 32 33
# Try using cPickle and cStringIO if available.

try:
34
        from cPickle import Pickler, Unpickler
35
except ImportError:
36
        from pickle import Pickler, Unpickler
37 38

try:
39
        from cStringIO import StringIO
40
except ImportError:
41
        from StringIO import StringIO
42

43

44
class Shelf:
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
        """Base class for shelf implementations.

        This is initialized with a dictionary-like object.
        See the module's __doc__ string for an overview of the interface.
        """

        def __init__(self, dict):
                self.dict = dict
        
        def keys(self):
                return self.dict.keys()
        
        def __len__(self):
                return len(self.dict)
        
        def has_key(self, key):
                return self.dict.has_key(key)

        def get(self, key, default=None):
                if self.dict.has_key(key):
                        return self[key]
                return default
        
        def __getitem__(self, key):
                f = StringIO(self.dict[key])
                return Unpickler(f).load()
        
        def __setitem__(self, key, value):
                f = StringIO()
                p = Pickler(f)
                p.dump(value)
                self.dict[key] = f.getvalue()
        
        def __delitem__(self, key):
                del self.dict[key]
        
        def close(self):
                try:
                        self.dict.close()
                except:
                        pass
                self.dict = 0

        def __del__(self):
                self.close()

        def sync(self):
                if hasattr(self.dict, 'sync'):
                        self.dict.sync()
            
95

96
class BsdDbShelf(Shelf):
97
        """Shelf implementation using the "BSD" db interface.
98

99 100
        This adds methods first(), next(), previous(), last() and
        set_location() that have no counterpart in [g]dbm databases.
101

102 103 104
        The actual database must be opened using one of the "bsddb"
        modules "open" routines (i.e. bsddb.hashopen, bsddb.btopen or
        bsddb.rnopen) and passed to the constructor.
105

106 107
        See the module's __doc__ string for an overview of the interface.
        """
108

109 110
        def __init__(self, dict):
            Shelf.__init__(self, dict)
111

112 113 114 115
        def set_location(self, key):
             (key, value) = self.dict.set_location(key)
             f = StringIO(value)
             return (key, Unpickler(f).load())
116

117 118 119 120
        def next(self):
             (key, value) = self.dict.next()
             f = StringIO(value)
             return (key, Unpickler(f).load())
121

122 123 124 125
        def previous(self):
             (key, value) = self.dict.previous()
             f = StringIO(value)
             return (key, Unpickler(f).load())
126

127 128 129 130
        def first(self):
             (key, value) = self.dict.first()
             f = StringIO(value)
             return (key, Unpickler(f).load())
131

132 133 134 135
        def last(self):
             (key, value) = self.dict.last()
             f = StringIO(value)
             return (key, Unpickler(f).load())
136 137 138


class DbfilenameShelf(Shelf):
139
        """Shelf implementation using the "anydbm" generic dbm interface.
140

141 142 143 144 145 146 147
        This is initialized with the filename for the dbm database.
        See the module's __doc__ string for an overview of the interface.
        """
        
        def __init__(self, filename, flag='c'):
                import anydbm
                Shelf.__init__(self, anydbm.open(filename, flag))
148

149

150
def open(filename, flag='c'):
151
        """Open a persistent dictionary for reading and writing.
152

153 154 155 156 157
        Argument is the filename for the dbm database.
        See the module's __doc__ string for an overview of the interface.
        """
        
        return DbfilenameShelf(filename, flag)