Add docstring to dbm.open

This commit is contained in:
Éric Araujo 2011-04-20 18:52:55 +02:00
parent dcb22a3936
commit f8e1b60799
1 changed files with 12 additions and 10 deletions

View File

@ -24,16 +24,8 @@ It has the following interface (key and data are strings):
list = d.keys() # return a list of all existing keys (slow!) list = d.keys() # return a list of all existing keys (slow!)
Future versions may change the order in which implementations are Future versions may change the order in which implementations are
tested for existence, add interfaces to other dbm-like tested for existence, and add interfaces to other dbm-like
implementations. implementations.
The open function has an optional second argument. This can be 'r',
for read-only access, 'w', for read-write access of an existing
database, 'c' for read-write access to a new or existing database, and
'n' for read-write access to a new database. The default is 'r'.
Note: 'r' and 'w' fail if the database doesn't exist; 'c' creates it
only if it doesn't exist; and 'n' always creates a new database.
""" """
__all__ = ['open', 'whichdb', 'error', 'error'] __all__ = ['open', 'whichdb', 'error', 'error']
@ -54,7 +46,17 @@ _modules = {}
error = (error, IOError) error = (error, IOError)
def open(file, flag = 'r', mode = 0o666): def open(file, flag='r', mode=0o666):
"""Open or create database at path given by *file*.
Optional argument *flag* can be 'r' (default) for read-only access, 'w'
for read-write access of an existing database, 'c' for read-write access
to a new or existing database, and 'n' for read-write access to a new
database.
Note: 'r' and 'w' fail if the database doesn't exist; 'c' creates it
only if it doesn't exist; and 'n' always creates a new database.
"""
global _defaultmod global _defaultmod
if _defaultmod is None: if _defaultmod is None:
for name in _names: for name in _names: