mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-09 06:01:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Separate sections on anydbm and dumbdbm.

Browse source 
This is the last separation; each module now gets its own section.  This will
be useful in performing conversions.
This commit is contained in:
Fred Drake 1998-04-07 22:08:02 +00:00
parent 8e729ec31a
commit 2764dd33cf
2 changed files with 78 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

54
Doc/lib/libanydbm.tex
View file

@ -1,19 +1,15 @@
\section{Standard Modules \module{anydbm} and \module{dumbdbm}} \section{Standard Module \module{anydbm}}
\label{module-anydbm} \label{module-anydbm}
\label{module-dumbdbm}
\stmodindex{anydbm} \stmodindex{anydbm}
\stmodindex{dumbdbm}
\module{anydbm} is a generic interface to variants of the DBM \module{anydbm} is a generic interface to variants of the DBM
database--DBM, GDBM, or dbhash. If none of these modules is database --- \module{dbhash}\refbimodindex{dbhash},
installed, the slow-but-simple implementation in module \module{dumbdbm} \module{gdbm}\refbimodindex{gdbm}, or \module{dbm}\refbimodindex{dbm}.
will be used. Both modules provide the same interface: If none of these modules is installed, the slow-but-simple
implementation in module \module{dumbdbm}\refstmodindex{dumbdbm} will
be used.
% not the best solution, but it's what you get for documenting both \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
% at the same time.
\setindexsubitem{(in modules anydbm, dumbdbm)}
\begin{funcdesc}{open}{filename\optional{, flag, mode}}
Open the database file \var{filename} and return a corresponding object. Open the database file \var{filename} and return a corresponding object.
The optional \var{flag} argument can be The optional \var{flag} argument can be
\code{'r'} to open an existing database for reading only, \code{'r'} to open an existing database for reading only,
@ -27,13 +23,41 @@ only when the database has to be created. It defaults to octal
\code{0666} (and will be modified by the prevailing umask). \code{0666} (and will be modified by the prevailing umask).
\end{funcdesc} \end{funcdesc}
\begin{excdesc}{error}
An alternate name for the \exception{error} exception defined by the
underlying database implementation.
\end{excdesc}
The object returned by \function{open()} supports most of the same The object returned by \function{open()} supports most of the same
functionality as dictionaries; keys and their corresponding values can functionality as dictionaries; keys and their corresponding values can
be stored, retrieved, and deleted, and the \method{has_key()} and be stored, retrieved, and deleted, and the \method{has_key()} and
\method{keys()} methods are available. Keys and values must always be \method{keys()} methods are available. Keys and values must always be
strings. strings.
Both modules also export the exception \exception{error}, which is
raised for various problems. The \exception{anydbm.error} exception
is simply a different name for the \exception{error} exception of the \section{Standard Module \module{dumbdbm}}
underlying implementation module used. \label{module-dumbdbm}
\stmodindex{dumbdbm}
A simple and slow database implemented entirely in Python. This
should only be used when no other DBM-style database is available.
\begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
Open the database file \var{filename} and return a corresponding object.
The optional \var{flag} argument can be
\code{'r'} to open an existing database for reading only,
\code{'w'} to open an existing database for reading and writing,
\code{'c'} to create the database if it doesn't exist, or
\code{'n'}, which will always create a new empty database. If not
specified, the default value is \code{'r'}.
The optional \var{mode} argument is the \UNIX{} mode of the file, used
only when the database has to be created. It defaults to octal
\code{0666} (and will be modified by the prevailing umask).
\end{funcdesc}
\begin{excdesc}{error}
Raised for errors not reported as \exception{KeyError} errors.
\end{excdesc}

54
Doc/libanydbm.tex
View file

@ -1,19 +1,15 @@
\section{Standard Modules \module{anydbm} and \module{dumbdbm}} \section{Standard Module \module{anydbm}}
\label{module-anydbm} \label{module-anydbm}
\label{module-dumbdbm}
\stmodindex{anydbm} \stmodindex{anydbm}
\stmodindex{dumbdbm}
\module{anydbm} is a generic interface to variants of the DBM \module{anydbm} is a generic interface to variants of the DBM
database--DBM, GDBM, or dbhash. If none of these modules is database --- \module{dbhash}\refbimodindex{dbhash},
installed, the slow-but-simple implementation in module \module{dumbdbm} \module{gdbm}\refbimodindex{gdbm}, or \module{dbm}\refbimodindex{dbm}.
will be used. Both modules provide the same interface: If none of these modules is installed, the slow-but-simple
implementation in module \module{dumbdbm}\refstmodindex{dumbdbm} will
be used.
% not the best solution, but it's what you get for documenting both \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
% at the same time.
\setindexsubitem{(in modules anydbm, dumbdbm)}
\begin{funcdesc}{open}{filename\optional{, flag, mode}}
Open the database file \var{filename} and return a corresponding object. Open the database file \var{filename} and return a corresponding object.
The optional \var{flag} argument can be The optional \var{flag} argument can be
\code{'r'} to open an existing database for reading only, \code{'r'} to open an existing database for reading only,
@ -27,13 +23,41 @@ only when the database has to be created. It defaults to octal
\code{0666} (and will be modified by the prevailing umask). \code{0666} (and will be modified by the prevailing umask).
\end{funcdesc} \end{funcdesc}
\begin{excdesc}{error}
An alternate name for the \exception{error} exception defined by the
underlying database implementation.
\end{excdesc}
The object returned by \function{open()} supports most of the same The object returned by \function{open()} supports most of the same
functionality as dictionaries; keys and their corresponding values can functionality as dictionaries; keys and their corresponding values can
be stored, retrieved, and deleted, and the \method{has_key()} and be stored, retrieved, and deleted, and the \method{has_key()} and
\method{keys()} methods are available. Keys and values must always be \method{keys()} methods are available. Keys and values must always be
strings. strings.
Both modules also export the exception \exception{error}, which is
raised for various problems. The \exception{anydbm.error} exception
is simply a different name for the \exception{error} exception of the \section{Standard Module \module{dumbdbm}}
underlying implementation module used. \label{module-dumbdbm}
\stmodindex{dumbdbm}
A simple and slow database implemented entirely in Python. This
should only be used when no other DBM-style database is available.
\begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
Open the database file \var{filename} and return a corresponding object.
The optional \var{flag} argument can be
\code{'r'} to open an existing database for reading only,
\code{'w'} to open an existing database for reading and writing,
\code{'c'} to create the database if it doesn't exist, or
\code{'n'}, which will always create a new empty database. If not
specified, the default value is \code{'r'}.
The optional \var{mode} argument is the \UNIX{} mode of the file, used
only when the database has to be created. It defaults to octal
\code{0666} (and will be modified by the prevailing umask).
\end{funcdesc}
\begin{excdesc}{error}
Raised for errors not reported as \exception{KeyError} errors.
\end{excdesc}