mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-01 22:04:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge the old dumbdbm documetation into the new docs that have been added.

Browse Source 
Make some module references hyperlinks.
This commit is contained in:
Fred Drake 2003-07-21 15:30:15 +00:00
parent 6a627250d2
commit 6c4970995a
2 changed files with 28 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Doc/lib/libanydbm.tex
View File

@ -57,40 +57,3 @@ strings.
\seemodule{whichdb}{Utility module used to determine the type of an \seemodule{whichdb}{Utility module used to determine the type of an
existing database.} existing database.}
\end{seealso} \end{seealso}
\section{\module{dumbdbm} ---
Portable DBM implementation}
\declaremodule{standard}{dumbdbm}
\modulesynopsis{Portable implementation of the simple DBM interface.}
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 \var{flag} argument, used to control how the database is
opened in the other DBM implementations, is ignored in
\module{dumbdbm}; the database is always opened for update, and will
be created if it does not exist.
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).
\versionchanged[The \var{mode} argument was ignored in earlier
versions]{2.2}
\end{funcdesc}
\begin{excdesc}{error}
Raised for errors not reported as \exception{KeyError} errors.
\end{excdesc}
\begin{seealso}
\seemodule{anydbm}{Generic interface to \code{dbm}-style databases.}
\seemodule{whichdb}{Utility module used to determine the type of an
existing database.}
\end{seealso}

50
Doc/lib/libdumbdbm.tex
View File

@ -1,19 +1,21 @@
\section{\module{dumbdbm} --- \section{\module{dumbdbm} ---
Simple ``database'' interface written in Python} Portable DBM implementation}
\declaremodule{builtin}{dumbdbm} \declaremodule{standard}{dumbdbm}
\modulesynopsis{A dbm-style module available on all platforms.} \modulesynopsis{Portable implementation of the simple DBM interface.}
\index{databases} \index{databases}
\note{The \module{dumbdbm} module is intended as a last resort fallback for \begin{notice}
the \module{anydbm} module when no other more robust module is available. The \module{dumbdbm} module is intended as a last resort fallback for
the \refmodule{anydbm} module when no more robust module is available.
The \module{dumbdbm} module is not written for speed and is not nearly as The \module{dumbdbm} module is not written for speed and is not nearly as
heavily used as the other database modules.} heavily used as the other database modules.
\end{notice}
The \module{dumbdbm} module provides a persisten dictionary-like interface The \module{dumbdbm} module provides a persistent dictionary-like interface
which is written entirely in Python. Unlike other modules such as which is written entirely in Python. Unlike other modules such as
{}\module{gdbm} and \module{bsddb}, no external library is required. As \refmodule{gdbm} and \refmodule{bsddb}, no external library is required. As
with other persistent mappings, the keys and values must always be strings. with other persistent mappings, the keys and values must always be strings.
The module defines the following: The module defines the following:
@ -24,19 +26,32 @@ is raised for general mapping errors like specifying an incorrect key.
\end{excdesc} \end{excdesc}
\begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}} \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
Open a dumbdbm database and return a dumbdbm object. The \var{filename} Open a dumbdbm database and return a dumbdbm object. The \var{filename}
argument is the basename of the database file (without any specific argument is the basename of the database file (without any specific
extensions). When a dumbdbm database is created, files with \code{.dat} and extensions). When a dumbdbm database is created, files with \file{.dat} and
\code{.dir} extensions are created. \file{.dir} extensions are created.
The optional \var{flag} argument is currently ignored. The optional \var{flag} argument is currently ignored; the database is
always opened for update, and will be created if it does not exist.
The optional \var{mode} argument is the \UNIX{} mode of the file, used 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 only when the database has to be created. It defaults to octal
\code{0666}. \code{0666} (and will be modified by the prevailing umask).
\versionchanged[The \var{mode} argument was ignored in earlier
versions]{2.2}
\end{funcdesc} \end{funcdesc}
\begin{seealso}
\seemodule{anydbm}{Generic interface to \code{dbm}-style databases.}
\seemodule{dbm}{Similar interface to the DBM/NDBM library.}
\seemodule{gdbm}{Similar interface to the GNU GDBM library.}
\seemodule{shelve}{Persistence module which stores non-string data.}
\seemodule{whichdb}{Utility module used to determine the type of an
existing database.}
\end{seealso}
\subsection{Dumbdbm Objects \label{dumbdbm-objects}} \subsection{Dumbdbm Objects \label{dumbdbm-objects}}
In addition to the methods provided by the \class{UserDict.DictMixin} class, In addition to the methods provided by the \class{UserDict.DictMixin} class,
@ -46,12 +61,3 @@ In addition to the methods provided by the \class{UserDict.DictMixin} class,
Synchronize the on-disk directory and data files. This method is called by Synchronize the on-disk directory and data files. This method is called by
the \method{sync} method of \class{Shelve} objects. the \method{sync} method of \class{Shelve} objects.
\end{methoddesc} \end{methoddesc}
\begin{seealso}
\seemodule{anydbm}{Generic interface to \code{dbm}-style databases.}
\seemodule{dbm}{Similar interface to the DBM/NDBM library.}
\seemodule{gdbm}{Similar interface to the GNU GDBM library.}
\seemodule{shelve}{Persistence module which stores non-string data.}
\seemodule{whichdb}{Utility module used to determine the type of an
existing database.}
\end{seealso}