Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(46)

Side by Side Diff: Doc/library/shelve.rst

Issue 18758: Fix internal references in the documentation
Patch Set: Created 6 years, 5 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « Doc/library/pyexpat.rst ('k') | Doc/library/smtpd.rst » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 :mod:`shelve` --- Python object persistence 1 :mod:`shelve` --- Python object persistence
2 =========================================== 2 ===========================================
3 3
4 .. module:: shelve 4 .. module:: shelve
5 :synopsis: Python object persistence. 5 :synopsis: Python object persistence.
6 6
7 7
8 .. index:: module: pickle 8 .. index:: module: pickle
9 9
10 **Source code:** :source:`Lib/shelve.py` 10 **Source code:** :source:`Lib/shelve.py`
(...skipping 88 matching lines...) Expand 10 before | Expand all | Expand 10 after
99 * The :mod:`shelve` module does not support *concurrent* read/write access to 99 * The :mod:`shelve` module does not support *concurrent* read/write access to
100 shelved objects. (Multiple simultaneous read accesses are safe.) When a 100 shelved objects. (Multiple simultaneous read accesses are safe.) When a
101 program has a shelf open for writing, no other program should have it open for 101 program has a shelf open for writing, no other program should have it open for
102 reading or writing. Unix file locking can be used to solve this, but this 102 reading or writing. Unix file locking can be used to solve this, but this
103 differs across Unix versions and requires knowledge about the database 103 differs across Unix versions and requires knowledge about the database
104 implementation used. 104 implementation used.
105 105
106 106
107 .. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8') 107 .. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
108 108
109 A subclass of :class:`collections.MutableMapping` which stores pickled values 109 A subclass of :class:`collections.abc.MutableMapping` which stores pickled va lues
110 in the *dict* object. 110 in the *dict* object.
111 111
112 By default, version 0 pickles are used to serialize values. The version of t he 112 By default, version 0 pickles are used to serialize values. The version of t he
113 pickle protocol can be specified with the *protocol* parameter. See the 113 pickle protocol can be specified with the *protocol* parameter. See the
114 :mod:`pickle` documentation for a discussion of the pickle protocols. 114 :mod:`pickle` documentation for a discussion of the pickle protocols.
115 115
116 If the *writeback* parameter is ``True``, the object will hold a cache of all 116 If the *writeback* parameter is ``True``, the object will hold a cache of all
117 entries accessed and write them back to the *dict* at sync and close times. 117 entries accessed and write them back to the *dict* at sync and close times.
118 This allows natural operations on mutable entries, but can consume much more 118 This allows natural operations on mutable entries, but can consume much more
119 memory and make sync and close take a long time. 119 memory and make sync and close take a long time.
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after
193 193
194 194
195 .. seealso:: 195 .. seealso::
196 196
197 Module :mod:`dbm` 197 Module :mod:`dbm`
198 Generic interface to ``dbm``-style databases. 198 Generic interface to ``dbm``-style databases.
199 199
200 Module :mod:`pickle` 200 Module :mod:`pickle`
201 Object serialization used by :mod:`shelve`. 201 Object serialization used by :mod:`shelve`.
202 202
OLDNEW
« no previous file with comments | « Doc/library/pyexpat.rst ('k') | Doc/library/smtpd.rst » ('j') | no next file with comments »

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+