summaryrefslogtreecommitdiffstats
path: root/Lib/dumbdbm.py
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2002-05-29 16:18:42 (GMT)
committerRaymond Hettinger <python@rcn.com>2002-05-29 16:18:42 (GMT)
commitaef22fb9cdf31fb7f0afc28ad049f08a89e23761 (patch)
treecf1771f344aef5d404a83b7e3b9a5086ac80ca43 /Lib/dumbdbm.py
parentd68f5171ebb2f3404548c846523e9e43308a4130 (diff)
downloadcpython-aef22fb9cdf31fb7f0afc28ad049f08a89e23761.zip
cpython-aef22fb9cdf31fb7f0afc28ad049f08a89e23761.tar.gz
cpython-aef22fb9cdf31fb7f0afc28ad049f08a89e23761.tar.bz2
Patch 560023 adding docstrings. 2.2 Candidate (after verifying modules were not updated after 2.2).
Diffstat (limited to 'Lib/dumbdbm.py')
-rw-r--r--Lib/dumbdbm.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/Lib/dumbdbm.py b/Lib/dumbdbm.py
index 3fb6e1d..c2b7952 100644
--- a/Lib/dumbdbm.py
+++ b/Lib/dumbdbm.py
@@ -154,5 +154,17 @@ class _Database:
def open(file, flag=None, mode=0666):
+ """Open the database file, filename, and return corresponding object.
+
+ The flag argument, used to control how the database is opened in the
+ other DBM implementations, is ignored in the dumbdbm module; the
+ database is always opened for update, and will be created if it does
+ not exist.
+
+ The optional 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).
+
+ """
# flag, mode arguments are currently ignored
return _Database(file, mode)