Commit 0bf84751 authored by Guido van Rossum's avatar Guido van Rossum

documented default flag, mode; changed gdbm into a pointer to dbm

parent f10570b9
\section{Built-in Module \sectcode{dbm}} \section{Built-in Module \sectcode{dbm}}
\bimodindex{dbm} \bimodindex{dbm}
Dbm provides python programs with an interface to the unix \code{ndbm} The \code{dbm} module provides an interface to the {\UNIX}
database library. Dbm objects are of the mapping type, so they can be \code{(n)dbm} library. Dbm objects behave like mappings
handled just like objects of the built-in \dfn{dictionary} type, (dictionaries), except that keys and values are always strings.
except that keys and values are always strings, and printing a dbm Printing a dbm object doesn't print the keys and values, and the
object doesn't print the keys and values. \code{items()} and \code{values()} methods are not supported.
See also the \code{gdbm} module, which provides a similar interface
using the GNU GDBM library.
\bimodindex{gdbm}
The module defines the following constant and functions: The module defines the following constant and functions:
...@@ -15,11 +19,18 @@ Raised on dbm-specific errors, such as I/O errors. \code{KeyError} is ...@@ -15,11 +19,18 @@ Raised on dbm-specific errors, such as I/O errors. \code{KeyError} is
raised for general mapping errors like specifying an incorrect key. raised for general mapping errors like specifying an incorrect key.
\end{excdesc} \end{excdesc}
\begin{funcdesc}{open}{filename\, rwmode\, filemode} \begin{funcdesc}{open}{filename\, \optional{flag\, \optional{mode}}}
Open a dbm database and return a mapping object. \var{filename} is Open a dbm database and return a dbm object. The \var{filename}
the name of the database file (without the \file{.dir} or \file{.pag} argument is the name of the database file (without the \file{.dir} or
extensions), \var{rwmode} is \code{'r'}, \code{'w'} or \code{'rw'} to \file{.pag} extensions).
open the database fore reading, writing or both respectively,
and \var{filemode} is the \UNIX{} mode of the file, used only The optional \var{flag} argument can be
when the database has to be created (but to be supplied at all times). \code{'r'} (to open an existing database for reading only --- default),
\code{'w'} (to open an existing database for reading and writing),
\code{'c'} (which creates the database if it doesn't exist), or
\code{'n'} (which always creates a new empty database).
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}.
\end{funcdesc} \end{funcdesc}
\section{Built-in Module \sectcode{gdbm}} \section{Built-in Module \sectcode{gdbm}}
\bimodindex{gdbm} \bimodindex{gdbm}
Gdbm provides python programs with an interface to the GNU \code{gdbm} This module is nearly identical to the \code{dbm} module, but uses
database library. Gdbm objects are of the mapping type, so they can be GDBM instead. Its interface is identical, and not repeated here.
handled just like objects of the built-in \dfn{dictionary} type,
except that keys and values are always strings, and printing a gdbm
object doesn't print the keys and values.
The module is based on the Dbm module, modified to use GDBM instead. Warning: the file formats created by gdbm and dbm are incompatible.
\bimodindex{dbm}
The module defines the following constant and functions:
\renewcommand{\indexsubitem}{(in module gdbm)}
\begin{excdesc}{error}
Raised on gdbm-specific errors, such as I/O errors. \code{KeyError} is
raised for general mapping errors like specifying an incorrect key.
\end{excdesc}
\begin{funcdesc}{open}{filename\, rwmode\, filemode}
Open a gdbm database and return a mapping object. \var{filename} is
the name of the database file, \var{rwmode} is \code{'r'}, \code{'w'},
\code{'c'}, or \code{'n'} for reader, writer (this also gives read
access), create (writer, but create the database if it doesn't already
exist) and newdb (which will always create a new database). Only one
writer may open a gdbm file and many readers may open the file. Readers
and writers cannot open the gdbm file at the same time. Note that the
\code{GDBM_FAST} mode of opening the database is not supported.
\var{filemode} is the \UNIX\ mode of the file, used only when a
database is created (but to be supplied at all times).
\end{funcdesc}
\section{Built-in Module \sectcode{dbm}} \section{Built-in Module \sectcode{dbm}}
\bimodindex{dbm} \bimodindex{dbm}
Dbm provides python programs with an interface to the unix \code{ndbm} The \code{dbm} module provides an interface to the {\UNIX}
database library. Dbm objects are of the mapping type, so they can be \code{(n)dbm} library. Dbm objects behave like mappings
handled just like objects of the built-in \dfn{dictionary} type, (dictionaries), except that keys and values are always strings.
except that keys and values are always strings, and printing a dbm Printing a dbm object doesn't print the keys and values, and the
object doesn't print the keys and values. \code{items()} and \code{values()} methods are not supported.
See also the \code{gdbm} module, which provides a similar interface
using the GNU GDBM library.
\bimodindex{gdbm}
The module defines the following constant and functions: The module defines the following constant and functions:
...@@ -15,11 +19,18 @@ Raised on dbm-specific errors, such as I/O errors. \code{KeyError} is ...@@ -15,11 +19,18 @@ Raised on dbm-specific errors, such as I/O errors. \code{KeyError} is
raised for general mapping errors like specifying an incorrect key. raised for general mapping errors like specifying an incorrect key.
\end{excdesc} \end{excdesc}
\begin{funcdesc}{open}{filename\, rwmode\, filemode} \begin{funcdesc}{open}{filename\, \optional{flag\, \optional{mode}}}
Open a dbm database and return a mapping object. \var{filename} is Open a dbm database and return a dbm object. The \var{filename}
the name of the database file (without the \file{.dir} or \file{.pag} argument is the name of the database file (without the \file{.dir} or
extensions), \var{rwmode} is \code{'r'}, \code{'w'} or \code{'rw'} to \file{.pag} extensions).
open the database fore reading, writing or both respectively,
and \var{filemode} is the \UNIX{} mode of the file, used only The optional \var{flag} argument can be
when the database has to be created (but to be supplied at all times). \code{'r'} (to open an existing database for reading only --- default),
\code{'w'} (to open an existing database for reading and writing),
\code{'c'} (which creates the database if it doesn't exist), or
\code{'n'} (which always creates a new empty database).
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}.
\end{funcdesc} \end{funcdesc}
\section{Built-in Module \sectcode{gdbm}} \section{Built-in Module \sectcode{gdbm}}
\bimodindex{gdbm} \bimodindex{gdbm}
Gdbm provides python programs with an interface to the GNU \code{gdbm} This module is nearly identical to the \code{dbm} module, but uses
database library. Gdbm objects are of the mapping type, so they can be GDBM instead. Its interface is identical, and not repeated here.
handled just like objects of the built-in \dfn{dictionary} type,
except that keys and values are always strings, and printing a gdbm
object doesn't print the keys and values.
The module is based on the Dbm module, modified to use GDBM instead. Warning: the file formats created by gdbm and dbm are incompatible.
\bimodindex{dbm}
The module defines the following constant and functions:
\renewcommand{\indexsubitem}{(in module gdbm)}
\begin{excdesc}{error}
Raised on gdbm-specific errors, such as I/O errors. \code{KeyError} is
raised for general mapping errors like specifying an incorrect key.
\end{excdesc}
\begin{funcdesc}{open}{filename\, rwmode\, filemode}
Open a gdbm database and return a mapping object. \var{filename} is
the name of the database file, \var{rwmode} is \code{'r'}, \code{'w'},
\code{'c'}, or \code{'n'} for reader, writer (this also gives read
access), create (writer, but create the database if it doesn't already
exist) and newdb (which will always create a new database). Only one
writer may open a gdbm file and many readers may open the file. Readers
and writers cannot open the gdbm file at the same time. Note that the
\code{GDBM_FAST} mode of opening the database is not supported.
\var{filemode} is the \UNIX\ mode of the file, used only when a
database is created (but to be supplied at all times).
\end{funcdesc}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment