shelve
index
/usr/lib/python2.1/shelve.py

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):
 
        import shelve
        d = shelve.open(filename) # open, with (g)dbm filename -- no suffix
 
        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!)
 
        d.close()       # close it
 
Dependent on the implementation, closing a persistent dictionary may
or may not be necessary to flush changes to disk.

 
Classes
            
Shelf
BsdDbShelf
DbfilenameShelf

 
class BsdDbShelf(Shelf)
      Shelf implementation using the "BSD" db interface.
 
This adds methods first(), next(), previous(), last() and
set_location() that have no counterpart in [g]dbm databases.
 
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.
 
See the module's __doc__ string for an overview of the interface.
 
  
__del__(self) from Shelf
__delitem__(self, key) from Shelf
__getitem__(self, key) from Shelf
__init__(self, dict)
__len__(self) from Shelf
__setitem__(self, key, value) from Shelf
close(self) from Shelf
first(self)
get(self, key, default=None) from Shelf
has_key(self, key) from Shelf
keys(self) from Shelf
last(self)
next(self)
previous(self)
set_location(self, key)
sync(self) from Shelf

 
class DbfilenameShelf(Shelf)
      Shelf implementation using the "anydbm" generic dbm interface.
 
This is initialized with the filename for the dbm database.
See the module's __doc__ string for an overview of the interface.
 
  
__del__(self) from Shelf
__delitem__(self, key) from Shelf
__getitem__(self, key) from Shelf
__init__(self, filename, flag='c')
__len__(self) from Shelf
__setitem__(self, key, value) from Shelf
close(self) from Shelf
get(self, key, default=None) from Shelf
has_key(self, key) from Shelf
keys(self) from Shelf
sync(self) from Shelf

 
class Shelf
      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.
 
  
__del__(self)
__delitem__(self, key)
__getitem__(self, key)
__init__(self, dict)
__len__(self)
__setitem__(self, key, value)
close(self)
get(self, key, default=None)
has_key(self, key)
keys(self)
sync(self)

 
Functions
            
Pickler(...)
Pickler(file, [binary]) -- Create a pickler
 
If the optional argument, binary, is provided and is true, then
pickles will be written in binary format, which is more space and
computationally efficient.
StringIO(...)
StringIO([s]) -- Return a StringIO-like stream for reading or writing
Unpickler(...)
Unpickler(file) -- Create an unpickler
open(filename, flag='c')
Open a persistent dictionary for reading and writing.
 
Argument is the filename for the dbm database.
See the module's __doc__ string for an overview of the interface.

 
Data
             __all__ = ['Shelf', 'BsdDbShelf', 'DbfilenameShelf', 'open']
__file__ = '/usr/lib/python2.1/shelve.pyc'
__name__ = 'shelve'