diff options
author | Raymond Hettinger <python@rcn.com> | 2002-05-29 16:18:42 +0000 |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2002-05-29 16:18:42 +0000 |
commit | 07a5746db37a13aa9d051c2ee266adadd2016764 (patch) | |
tree | dbbfd1151983eece60a95b38bfe15d3c0a2ccef0 /Lib/dumbdbm.py | |
parent | a4dac73b912970df999a7048d3b81b8f969a4b92 (diff) | |
download | cpython-07a5746db37a13aa9d051c2ee266adadd2016764.tar.gz |
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.py | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Lib/dumbdbm.py b/Lib/dumbdbm.py index 3fb6e1dc22..c2b79523b4 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) |