From 51a6c9055c37b176d0bad18854f37a22b3de7305 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Fri, 9 May 1997 02:23:45 +0000 Subject: Added docs for dumbdbm (AMK), and misc small fixes. --- Doc/lib/libanydbm.tex | 18 +++++++++++------- Doc/libanydbm.tex | 18 +++++++++++------- 2 files changed, 22 insertions(+), 14 deletions(-) diff --git a/Doc/lib/libanydbm.tex b/Doc/lib/libanydbm.tex index c465d39..a7d6798 100644 --- a/Doc/lib/libanydbm.tex +++ b/Doc/lib/libanydbm.tex @@ -1,11 +1,11 @@ -\section{Standard Module \sectcode{anydbm}} +\section{Standard Modules \sectcode{anydbm} and \sectcode{dumbdbm}} \stmodindex{anydbm} \stmodindex{dumbdbm} \code{anydbm} is a generic interface to variants of the DBM database--DBM, GDBM, or dbhash. If none of these modules is -installed, the slow-but-simple implementation in \file{dumbdbm.py} -will be used. +installed, the slow-but-simple implementation in module \code{dumbdbm} +will be used. Both modules provide the same interface: \begin{funcdesc}{open}{filename\optional{\, flag\, mode}} Open the database file \var{filename} and return a corresponding object. @@ -18,12 +18,16 @@ 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}. +\code{0666} (and will be modified by the prevailing umask). \end{funcdesc} -THe object returned by \code{open()} supports most of the same +The object returned by \code{open()} supports most of the same functionality as dictionaries; keys and their corresponding values can be stored, retrieved, and deleted, and the \code{has_key()} and -\code{keys()} methods are available. Keys and values must always be strings. - +\code{keys()} methods are available. Keys and values must always be +strings. +Both modules also export the exception \code{error}, which is raised +for various problems. The \code{anydbm.error} exception is simply a +different name for the \code{error} exception of the underlying +implementation module used. diff --git a/Doc/libanydbm.tex b/Doc/libanydbm.tex index c465d39..a7d6798 100644 --- a/Doc/libanydbm.tex +++ b/Doc/libanydbm.tex @@ -1,11 +1,11 @@ -\section{Standard Module \sectcode{anydbm}} +\section{Standard Modules \sectcode{anydbm} and \sectcode{dumbdbm}} \stmodindex{anydbm} \stmodindex{dumbdbm} \code{anydbm} is a generic interface to variants of the DBM database--DBM, GDBM, or dbhash. If none of these modules is -installed, the slow-but-simple implementation in \file{dumbdbm.py} -will be used. +installed, the slow-but-simple implementation in module \code{dumbdbm} +will be used. Both modules provide the same interface: \begin{funcdesc}{open}{filename\optional{\, flag\, mode}} Open the database file \var{filename} and return a corresponding object. @@ -18,12 +18,16 @@ 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}. +\code{0666} (and will be modified by the prevailing umask). \end{funcdesc} -THe object returned by \code{open()} supports most of the same +The object returned by \code{open()} supports most of the same functionality as dictionaries; keys and their corresponding values can be stored, retrieved, and deleted, and the \code{has_key()} and -\code{keys()} methods are available. Keys and values must always be strings. - +\code{keys()} methods are available. Keys and values must always be +strings. +Both modules also export the exception \code{error}, which is raised +for various problems. The \code{anydbm.error} exception is simply a +different name for the \code{error} exception of the underlying +implementation module used. -- cgit v0.12