mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Fixed index references to modules.

Browse source 
Placed references closer to usage.
This commit is contained in:
Fred Drake 1997-12-15 21:59:33 +00:00
parent 54820dc8e4
commit 9ab2b2ec5b
2 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/lib/libshelve.tex
View file

@ -1,9 +1,6 @@
\section{Standard Module \sectcode{shelve}} \section{Standard Module \sectcode{shelve}}
\label{module-shelve} \label{module-shelve}
\stmodindex{shelve} \stmodindex{shelve}
\stmodindex{pickle}
\bimodindex{dbm}
\bimodindex{gdbm}
A ``shelf'' is a persistent, dictionary-like object. The difference A ``shelf'' is a persistent, dictionary-like object. The difference
with ``dbm'' databases is that the values (not the keys!) in a shelf with ``dbm'' databases is that the values (not the keys!) in a shelf
@ -11,6 +8,7 @@ can be essentially arbitrary Python objects --- anything that the
\code{pickle} module can handle. This includes most class instances, \code{pickle} module can handle. This includes most class instances,
recursive data types, and objects containing lots of shared recursive data types, and objects containing lots of shared
sub-objects. The keys are ordinary strings. sub-objects. The keys are ordinary strings.
\refstmodindex{pickle}
To summarize the interface (\code{key} is a string, \code{data} is an To summarize the interface (\code{key} is a string, \code{data} is an
arbitrary object): arbitrary object):
@ -37,20 +35,23 @@ Restrictions:
\begin{itemize} \begin{itemize}
\item \item
The choice of which database package will be used (e.g. dbm or gdbm) The choice of which database package will be used (e.g. \code{dbm} or
\code{gdbm})
depends on which interface is available. Therefore it isn't safe to depends on which interface is available. Therefore it isn't safe to
open the database directly using dbm. The database is also open the database directly using \code{dbm}. The database is also
(unfortunately) subject to the limitations of dbm, if it is used --- (unfortunately) subject to the limitations of \code{dbm}, if it is used ---
this means that (the pickled representation of) the objects stored in this means that (the pickled representation of) the objects stored in
the database should be fairly small, and in rare cases key collisions the database should be fairly small, and in rare cases key collisions
may cause the database to refuse updates. may cause the database to refuse updates.
\refbimodindex{dbm}
\refbimodindex{gdbm}
\item \item
Dependent on the implementation, closing a persistent dictionary may Dependent on the implementation, closing a persistent dictionary may
or may not be necessary to flush changes to disk. or may not be necessary to flush changes to disk.
\item \item
The \code{shelve} module does not support {\em concurrent} read/write The \code{shelve} module does not support \emph{concurrent} read/write
access to shelved objects. (Multiple simultaneous read accesses are access to shelved objects. (Multiple simultaneous read accesses are
safe.) When a program has a shelf open for writing, no other program 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 should have it open for reading or writing. \UNIX{} file locking can

15
Doc/libshelve.tex
View file

@ -1,9 +1,6 @@
\section{Standard Module \sectcode{shelve}} \section{Standard Module \sectcode{shelve}}
\label{module-shelve} \label{module-shelve}
\stmodindex{shelve} \stmodindex{shelve}
\stmodindex{pickle}
\bimodindex{dbm}
\bimodindex{gdbm}
A ``shelf'' is a persistent, dictionary-like object. The difference A ``shelf'' is a persistent, dictionary-like object. The difference
with ``dbm'' databases is that the values (not the keys!) in a shelf with ``dbm'' databases is that the values (not the keys!) in a shelf
@ -11,6 +8,7 @@ can be essentially arbitrary Python objects --- anything that the
\code{pickle} module can handle. This includes most class instances, \code{pickle} module can handle. This includes most class instances,
recursive data types, and objects containing lots of shared recursive data types, and objects containing lots of shared
sub-objects. The keys are ordinary strings. sub-objects. The keys are ordinary strings.
\refstmodindex{pickle}
To summarize the interface (\code{key} is a string, \code{data} is an To summarize the interface (\code{key} is a string, \code{data} is an
arbitrary object): arbitrary object):
@ -37,20 +35,23 @@ Restrictions:
\begin{itemize} \begin{itemize}
\item \item
The choice of which database package will be used (e.g. dbm or gdbm) The choice of which database package will be used (e.g. \code{dbm} or
\code{gdbm})
depends on which interface is available. Therefore it isn't safe to depends on which interface is available. Therefore it isn't safe to
open the database directly using dbm. The database is also open the database directly using \code{dbm}. The database is also
(unfortunately) subject to the limitations of dbm, if it is used --- (unfortunately) subject to the limitations of \code{dbm}, if it is used ---
this means that (the pickled representation of) the objects stored in this means that (the pickled representation of) the objects stored in
the database should be fairly small, and in rare cases key collisions the database should be fairly small, and in rare cases key collisions
may cause the database to refuse updates. may cause the database to refuse updates.
\refbimodindex{dbm}
\refbimodindex{gdbm}
\item \item
Dependent on the implementation, closing a persistent dictionary may Dependent on the implementation, closing a persistent dictionary may
or may not be necessary to flush changes to disk. or may not be necessary to flush changes to disk.
\item \item
The \code{shelve} module does not support {\em concurrent} read/write The \code{shelve} module does not support \emph{concurrent} read/write
access to shelved objects. (Multiple simultaneous read accesses are access to shelved objects. (Multiple simultaneous read accesses are
safe.) When a program has a shelf open for writing, no other program 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 should have it open for reading or writing. \UNIX{} file locking can