JezK
Edit File: shelve.pyc
� �sjc @ s d Z y d d l m Z m Z Wn' e k rI d d l m Z m Z n Xy d d l m Z Wn! e k r� d d l m Z n Xd d l Z d d d d g Z d e j f d � � YZ d e j f d � � YZ d e f d � � YZ d e f d � � YZ d d e d � Z d S( s� 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 a COPY of the data at key (raise # KeyError if no such key) -- NOTE that this # access returns a *copy* of the entry! del d[key] # delete data stored at key (raises KeyError # if no such key) flag = d.has_key(key) # true if the key exists; same as "key in d" 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. Normally, d[key] returns a COPY of the entry. This needs care when mutable entries are mutated: for example, if d[key] is a list, d[key].append(anitem) does NOT modify the entry d[key] itself, as stored in the persistent mapping -- it only modifies the copy, which is then immediately discarded, so that the append has NO effect whatsoever. To append an item to d[key] in a way that will affect the persistent mapping, use: data = d[key] data.append(anitem) d[key] = data To avoid the problem with mutable entries, you may pass the keyword argument writeback=True in the call to shelve.open. When you use: d = shelve.open(filename, writeback=True) then d keeps a cache of all entries you access, and writes them all back to the persistent mapping when you call d.close(). This ensures that such usage as d[key].append(anitem) works as intended. However, using keyword argument writeback=True may consume vast amount of memory for the cache, and it may make d.close() very slow, if you access many of d's entries after opening it in this way: d has no way to check which of the entries you access are mutable and/or which ones you actually mutate, so it must cache, and write back at close, all of the entries that you access. You can call d.sync() to write back all the entries in the cache, and empty the cache (d.sync() also synchronizes the persistent dictionary on disk, if feasible). i����( t Picklert Unpickler( t StringIONt Shelft BsdDbShelft DbfilenameShelft opent _ClosedDictc B s2 e Z d Z d � Z e Z Z Z Z d � Z RS( s> Marker for a closed dict. Access attempts raise a ValueError.c G s t d � � d S( Ns! invalid operation on closed shelf( t ValueError( t selft args( ( s /usr/lib64/python2.7/shelve.pyt closedN s c C s d S( Ns <Closed Dictionary>( ( R ( ( s /usr/lib64/python2.7/shelve.pyt __repr__R s ( t __name__t __module__t __doc__R t __getitem__t __setitem__t __delitem__t keysR ( ( ( s /usr/lib64/python2.7/shelve.pyR K s c B s� e Z d Z d e d � Z d � Z d � Z d � Z d � Z d d � Z d � Z d � Z d � Z d � Z d � Z d � Z RS( s� 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. c C s= | | _ | d k r d } n | | _ | | _ i | _ d S( Ni ( t dictt Nonet _protocolt writebackt cache( R R t protocolR ( ( s /usr/lib64/python2.7/shelve.pyt __init__\ s c C s | j j � S( N( R R ( R ( ( s /usr/lib64/python2.7/shelve.pyR d s c C s t | j � S( N( t lenR ( R ( ( s /usr/lib64/python2.7/shelve.pyt __len__g s c C s | | j k S( N( R ( R t key( ( s /usr/lib64/python2.7/shelve.pyt has_keyj s c C s | | j k S( N( R ( R R ( ( s /usr/lib64/python2.7/shelve.pyt __contains__m s c C s | | j k r | | S| S( N( R ( R R t default( ( s /usr/lib64/python2.7/shelve.pyt getp s c C sg y | j | } WnO t k rb t | j | � } t | � j � } | j rc | | j | <qc n X| S( N( R t KeyErrorR R R t loadR ( R R t valuet f( ( s /usr/lib64/python2.7/shelve.pyR u s c C sX | j r | | j | <n t � } t | | j � } | j | � | j � | j | <d S( N( R R R R R t dumpt getvalueR ( R R R$ R% t p( ( s /usr/lib64/python2.7/shelve.pyR s c C s0 | j | =y | j | =Wn t k r+ n Xd S( N( R R R" ( R R ( ( s /usr/lib64/python2.7/shelve.pyR � s c C sf | j � y | j j � Wn t k r. n Xy t � | _ Wn t t f k ra d | _ n Xd S( N( t syncR t closet AttributeErrorR t NameErrort TypeErrorR ( R ( ( s /usr/lib64/python2.7/shelve.pyR* � s c C s! t | d � s d S| j � d S( NR ( t hasattrR* ( R ( ( s /usr/lib64/python2.7/shelve.pyt __del__� s c C s� | j rZ | j rZ t | _ x' | j j � D] \ } } | | | <q+ Wt | _ i | _ n t | j d � r| | j j � n d S( NR) ( R R t Falset iteritemst TrueR. R R) ( R R t entry( ( s /usr/lib64/python2.7/shelve.pyR) � s N( R R R R R0 R R R R R R! R R R R* R/ R) ( ( ( s /usr/lib64/python2.7/shelve.pyR U s c B sJ e Z d Z d e d � Z d � Z d � Z d � Z d � Z d � Z RS( s� 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. c C s t j | | | | � d S( N( R R ( R R R R ( ( s /usr/lib64/python2.7/shelve.pyR � s c C s: | j j | � \ } } t | � } | t | � j � f S( N( R t set_locationR R R# ( R R R$ R% ( ( s /usr/lib64/python2.7/shelve.pyR4 � s c C s7 | j j � \ } } t | � } | t | � j � f S( N( R t nextR R R# ( R R R$ R% ( ( s /usr/lib64/python2.7/shelve.pyR5 � s c C s7 | j j � \ } } t | � } | t | � j � f S( N( R t previousR R R# ( R R R$ R% ( ( s /usr/lib64/python2.7/shelve.pyR6 � s c C s7 | j j � \ } } t | � } | t | � j � f S( N( R t firstR R R# ( R R R$ R% ( ( s /usr/lib64/python2.7/shelve.pyR7 � s c C s7 | j j � \ } } t | � } | t | � j � f S( N( R t lastR R R# ( R R R$ R% ( ( s /usr/lib64/python2.7/shelve.pyR8 � s N( R R R R R0 R R4 R5 R6 R7 R8 ( ( ( s /usr/lib64/python2.7/shelve.pyR � s c B s e Z d Z d d e d � Z RS( s� 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. t cc C s2 d d l } t j | | j | | � | | � d S( Ni����( t anydbmR R R ( R t filenamet flagR R R: ( ( s /usr/lib64/python2.7/shelve.pyR � s N( R R R R R0 R ( ( ( s /usr/lib64/python2.7/shelve.pyR � s R9 c C s t | | | | � S( s Open a persistent dictionary for reading and writing. The filename parameter is the base filename for the underlying database. As a side-effect, an extension may be added to the filename and more than one file may be created. The optional flag parameter has the same interpretation as the flag parameter of anydbm.open(). The optional protocol parameter specifies the version of the pickle protocol (0, 1, or 2). See the module's __doc__ string for an overview of the interface. ( R ( R; R< R R ( ( s /usr/lib64/python2.7/shelve.pyR � s ( R t cPickleR R t ImportErrort picklet cStringIOR t UserDictt __all__t DictMixinR R R R R R0 R ( ( ( s /usr/lib64/python2.7/shelve.pyt <module>9 s W*