diff options
| author | R. David Murray <rdmurray@bitdance.com> | 2010-02-11 02:42:19 (GMT) |
|---|---|---|
| committer | R. David Murray <rdmurray@bitdance.com> | 2010-02-11 02:42:19 (GMT) |
| commit | ddb3ed003ecfd5c8d0ddc4880e0c92ac36519d93 (patch) | |
| tree | 40d4d57b5825309290913dceaff01a8c8d702027 /Doc | |
| parent | f8b60b20a576c4d740b3f69fc1cd23f629629517 (diff) | |
| download | cpython-ddb3ed003ecfd5c8d0ddc4880e0c92ac36519d93.zip cpython-ddb3ed003ecfd5c8d0ddc4880e0c92ac36519d93.tar.gz cpython-ddb3ed003ecfd5c8d0ddc4880e0c92ac36519d93.tar.bz2 | |
Merged revisions 78141-78142 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r78141 | r.david.murray | 2010-02-10 20:38:42 -0500 (Wed, 10 Feb 2010) | 6 lines
Issue 5754: tweak shelve doc wording to make it clearer that even when
writeback=True values are written to the backing store when assigned to
the shelf. Add test to confirm that this happens. Doc patch and added
test by Robert Lehmann. I also fixed the cross references to the sync
and close methods.
........
r78142 | r.david.murray | 2010-02-10 20:56:42 -0500 (Wed, 10 Feb 2010) | 3 lines
Improve issue 7835 fix per MAL to handle the case that the
module dictionary has also been cleared.
........
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/shelve.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index 659811a..0252597 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -27,14 +27,15 @@ lots of shared sub-objects. The keys are ordinary strings. Because of Python semantics, a shelf cannot know when a mutable persistent-dictionary entry is modified. By default modified objects are - written only when assigned to the shelf (see :ref:`shelve-example`). If the - optional *writeback* parameter is set to *True*, all entries accessed are - cached in memory, and written back on :meth:`sync` and :meth:`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). + written *only* when assigned to the shelf (see :ref:`shelve-example`). If the + optional *writeback* parameter is set to *True*, all entries accessed are also + 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). .. note:: |