From aef22fb9cdf31fb7f0afc28ad049f08a89e23761 Mon Sep 17 00:00:00 2001 From: Raymond Hettinger Date: Wed, 29 May 2002 16:18:42 +0000 Subject: Patch 560023 adding docstrings. 2.2 Candidate (after verifying modules were not updated after 2.2). --- Lib/dumbdbm.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'Lib/dumbdbm.py') 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) -- cgit v1.2.1