[New-bugs-announce] [issue5957] Possible mistake regarding writeback in documentation of shelve.open()

Mitchell Model report at bugs.python.org
Thu May 7 20:00:41 CEST 2009

New submission from Mitchell Model <mlm at acm.org>:

The documentation of shelve.open() states (paragraph 3) that "By
default, mutations to persistent-dictionary mutable entries are not
automatically written back." It then goes on to describe what happens if
the writeback parameter is True, which involves caching the entire
dictionary of objects in memory and writing the whole thing back on close.

But what happens if writeback is False, the default? The statement that
the mutable entires are not automatically written back leaves open the
question of how to write them back. shelf.sync() is documented as being
used only when writeback is true. Also, for a user unfamiliar with the
nuances of persistence the sentence quoted above is somewhat mysterious
-- "persistent-dictionary mutable entries"? "written back"?

assignee: georg.brandl
components: Documentation
messages: 87381
nosy: MLModel, georg.brandl
severity: normal
status: open
title: Possible mistake regarding writeback in documentation of shelve.open()
versions: Python 3.0, Python 3.1

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list