shelve.rst 8.19 KB
Newer Older
1 2 3 4 5 6
:mod:`shelve` --- Python object persistence
===========================================

.. module:: shelve
   :synopsis: Python object persistence.

7
**Source code:** :source:`Lib/shelve.py`
8 9 10

.. index:: module: pickle

11 12
--------------

13 14 15 16 17 18 19
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 :mod:`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.


20
.. function:: open(filename, flag='c', protocol=None, writeback=False)
21 22 23 24 25

   Open a persistent dictionary.  The filename specified 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.  By default, the underlying
   database file is opened for reading and writing.  The optional *flag* parameter
26
   has the same interpretation as the *flag* parameter of :func:`dbm.open`.
27

28
   By default, version 3 pickles are used to serialize values.  The version of the
29 30
   pickle protocol can be specified with the *protocol* parameter.

31 32
   Because of Python semantics, a shelf cannot know when a mutable
   persistent-dictionary entry is modified.  By default modified objects are
33
   written *only* when assigned to the shelf (see :ref:`shelve-example`).  If the
34
   optional *writeback* parameter is set to ``True``, all entries accessed are also
35 36 37 38 39 40 41
   cached in memory, and written back on :meth:`~Shelf.sync` and
   :meth:`~Shelf.close`; this can make it handier to mutate mutable entries in
   the persistent dictionary, but, if many entries are accessed, it can consume
   vast amounts of memory for the cache, and it can make the close operation
   very slow since all accessed entries are written back (there is no way to
   determine which accessed entries are mutable, nor which ones were actually
   mutated).
Benjamin Peterson's avatar
Benjamin Peterson committed
42 43 44 45

   .. note::

      Do not rely on the shelf being closed automatically; always call
46 47 48 49 50
      :meth:`~Shelf.close` explicitly when you don't need it any more, or
      use :func:`shelve.open` as a context manager::

          with shelve.open('spam') as db:
              db['eggs'] = 'eggs'
Benjamin Peterson's avatar
Benjamin Peterson committed
51

52 53 54 55 56
.. warning::

   Because the :mod:`shelve` module is backed by :mod:`pickle`, it is insecure
   to load a shelf from an untrusted source.  Like with pickle, loading a shelf
   can execute arbitrary code.
57

Benjamin Peterson's avatar
Benjamin Peterson committed
58
Shelf objects support all methods supported by dictionaries.  This eases the
59 60
transition from dictionary based scripts to those requiring persistent storage.

Benjamin Peterson's avatar
Benjamin Peterson committed
61
Two additional methods are supported:
62 63 64

.. method:: Shelf.sync()

Benjamin Peterson's avatar
Benjamin Peterson committed
65 66 67 68 69 70 71 72 73 74
   Write back all entries in the cache if the shelf was opened with *writeback*
   set to :const:`True`.  Also empty the cache and synchronize the persistent
   dictionary on disk, if feasible.  This is called automatically when the shelf
   is closed with :meth:`close`.

.. method:: Shelf.close()

   Synchronize and close the persistent *dict* object.  Operations on a closed
   shelf will fail with a :exc:`ValueError`.

75

Raymond Hettinger's avatar
Raymond Hettinger committed
76 77
.. seealso::

78
   `Persistent dictionary recipe <https://code.activestate.com/recipes/576642/>`_
Raymond Hettinger's avatar
Raymond Hettinger committed
79 80 81
   with widely supported storage formats and having the speed of native
   dictionaries.

82 83 84 85 86

Restrictions
------------

  .. index::
87 88
     module: dbm.ndbm
     module: dbm.gnu
89

90 91 92 93
* The choice of which database package will be used (such as :mod:`dbm.ndbm` or
  :mod:`dbm.gnu`) depends on which interface is available.  Therefore it is not
  safe to open the database directly using :mod:`dbm`.  The database is also
  (unfortunately) subject to the limitations of :mod:`dbm`, if it is used ---
94
  this means that (the pickled representation of) the objects stored in the
95 96
  database should be fairly small, and in rare cases key collisions may cause
  the database to refuse updates.
97 98 99 100 101 102 103 104 105

* The :mod:`shelve` module does not support *concurrent* read/write access to
  shelved objects.  (Multiple simultaneous read accesses are safe.)  When a
  program has a shelf open for writing, no other program should have it open for
  reading or writing.  Unix file locking can be used to solve this, but this
  differs across Unix versions and requires knowledge about the database
  implementation used.


106
.. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
107

108 109
   A subclass of :class:`collections.abc.MutableMapping` which stores pickled
   values in the *dict* object.
110

111
   By default, version 3 pickles are used to serialize values.  The version of the
112 113 114 115 116 117 118 119
   pickle protocol can be specified with the *protocol* parameter. See the
   :mod:`pickle` documentation for a discussion of the pickle protocols.

   If the *writeback* parameter is ``True``, the object will hold a cache of all
   entries accessed and write them back to the *dict* at sync and close times.
   This allows natural operations on mutable entries, but can consume much more
   memory and make sync and close take a long time.

120 121
   The *keyencoding* parameter is the encoding used to encode keys before they
   are used with the underlying dict.
122

123 124
   A :class:`Shelf` object can also be used as a context manager, in which
   case it will be automatically closed when the :keyword:`with` block ends.
125 126 127

   .. versionchanged:: 3.2
      Added the *keyencoding* parameter; previously, keys were always encoded in
128 129
      UTF-8.

130 131 132
   .. versionchanged:: 3.4
      Added context manager support.

133 134

.. class:: BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
135

136
   A subclass of :class:`Shelf` which exposes :meth:`first`, :meth:`!next`,
137 138
   :meth:`previous`, :meth:`last` and :meth:`set_location` which are available
   in the third-party :mod:`bsddb` module from `pybsddb
139
   <https://www.jcea.es/programacion/pybsddb.htm>`_ but not in other database
140 141 142
   modules.  The *dict* object passed to the constructor must support those
   methods.  This is generally accomplished by calling one of
   :func:`bsddb.hashopen`, :func:`bsddb.btopen` or :func:`bsddb.rnopen`.  The
143 144
   optional *protocol*, *writeback*, and *keyencoding* parameters have the same
   interpretation as for the :class:`Shelf` class.
145 146


147
.. class:: DbfilenameShelf(filename, flag='c', protocol=None, writeback=False)
148 149

   A subclass of :class:`Shelf` which accepts a *filename* instead of a dict-like
150
   object.  The underlying file will be opened using :func:`dbm.open`.  By
151
   default, the file will be created and opened for both read and write.  The
152
   optional *flag* parameter has the same interpretation as for the :func:`.open`
153 154 155 156
   function.  The optional *protocol* and *writeback* parameters have the same
   interpretation as for the :class:`Shelf` class.


157 158
.. _shelve-example:

159 160 161 162 163 164 165 166
Example
-------

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

   import shelve

167 168 169 170 171 172 173 174 175 176 177 178
   d = shelve.open(filename)  # open -- file may get suffix added by low-level
                              # library

   d[key] = data              # store data at key (overwrites old data if
                              # using an existing key)
   data = d[key]              # retrieve a COPY of data at key (raise KeyError
                              # if no such key)
   del d[key]                 # delete data stored at key (raises KeyError
                              # if no such key)

   flag = key in d            # true if the key exists
   klist = list(d.keys())     # a list of all existing keys (slow!)
179 180

   # as d was opened WITHOUT writeback=True, beware:
181 182
   d['xx'] = [0, 1, 2]        # this works as expected, but...
   d['xx'].append(3)          # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]!
183 184

   # having opened d without writeback=True, you need to code carefully:
185 186 187
   temp = d['xx']             # extracts the copy
   temp.append(5)             # mutates the copy
   d['xx'] = temp             # stores the copy right back, to persist it
188 189 190 191 192

   # or, d=shelve.open(filename,writeback=True) would let you just code
   # d['xx'].append(5) and have it work as expected, BUT it would also
   # consume more memory and make the d.close() operation slower.

193
   d.close()                  # close it
194 195 196 197


.. seealso::

198 199
   Module :mod:`dbm`
      Generic interface to ``dbm``-style databases.
200 201 202 203

   Module :mod:`pickle`
      Object serialization used by :mod:`shelve`.