diff options
| -rw-r--r-- | Doc/lib/libanydbm.tex | 37 | ||||
| -rw-r--r-- | Doc/lib/libdumbdbm.tex | 50 |
2 files changed, 28 insertions, 59 deletions
diff --git a/Doc/lib/libanydbm.tex b/Doc/lib/libanydbm.tex index eef4d03..17228dd 100644 --- a/Doc/lib/libanydbm.tex +++ b/Doc/lib/libanydbm.tex @@ -57,40 +57,3 @@ strings. \seemodule{whichdb}{Utility module used to determine the type of an existing database.} \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} diff --git a/Doc/lib/libdumbdbm.tex b/Doc/lib/libdumbdbm.tex index 2573011..4495774 100644 --- a/Doc/lib/libdumbdbm.tex +++ b/Doc/lib/libdumbdbm.tex @@ -1,19 +1,21 @@ \section{\module{dumbdbm} --- - Simple ``database'' interface written in Python} + Portable DBM implementation} -\declaremodule{builtin}{dumbdbm} -\modulesynopsis{A dbm-style module available on all platforms.} +\declaremodule{standard}{dumbdbm} +\modulesynopsis{Portable implementation of the simple DBM interface.} \index{databases} -\note{The \module{dumbdbm} module is intended as a last resort fallback for -the \module{anydbm} module when no other more robust module is available. +\begin{notice} +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 -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 -{}\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. The module defines the following: @@ -24,28 +26,21 @@ is raised for general mapping errors like specifying an incorrect key. \end{excdesc} \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}} - Open a dumbdbm database and return a dumbdbm object. The \var{filename} argument is the basename of the database file (without any specific -extensions). When a dumbdbm database is created, files with \code{.dat} and -\code{.dir} extensions are created. +extensions). When a dumbdbm database is created, files with \file{.dat} and +\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 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} -\subsection{Dumbdbm Objects \label{dumbdbm-objects}} - -In addition to the methods provided by the \class{UserDict.DictMixin} class, -\class{dumbdbm} objects provide the following methods. - -\begin{methoddesc}{sync}{} -Synchronize the on-disk directory and data files. This method is called by -the \method{sync} method of \class{Shelve} objects. -\end{methoddesc} \begin{seealso} \seemodule{anydbm}{Generic interface to \code{dbm}-style databases.} @@ -55,3 +50,14 @@ the \method{sync} method of \class{Shelve} objects. \seemodule{whichdb}{Utility module used to determine the type of an existing database.} \end{seealso} + + +\subsection{Dumbdbm Objects \label{dumbdbm-objects}} + +In addition to the methods provided by the \class{UserDict.DictMixin} class, +\class{dumbdbm} objects provide the following methods. + +\begin{methoddesc}{sync}{} +Synchronize the on-disk directory and data files. This method is called by +the \method{sync} method of \class{Shelve} objects. +\end{methoddesc} |