mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-25 04:34:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Inline the advisory text on how to use the shelve module.

Browse source
This commit is contained in:
Raymond Hettinger 2011-11-04 13:07:52 -07:00
parent ce7554f0a1
commit 23ca12a981
1 changed files with 5 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/shelve.rst
View file

@ -44,17 +44,12 @@ lots of shared sub-objects. The keys are ordinary strings.
determine which accessed entries are mutable, nor which ones were actually
mutated).
.. note::
Like file objects, shelve objects should closed explicitly to assure
that the peristent data is flushed to disk.
Do not rely on the shelf being closed automatically; always call
:meth:`close` explicitly when you don't need it any more, or use a
:keyword:`with` statement with :func:`contextlib.closing`.
.. 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.
Since the :mod:`shelve` module stores objects using :mod:`pickle`, the same
security precautions apply. Accordingly, you should avoid loading a shelf
from an untrusted source.
Shelf objects support all methods supported by dictionaries. This eases the
transition from dictionary based scripts to those requiring persistent storage.