summaryrefslogtreecommitdiffstats
path: root/Lib/anydbm.py
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-05-01 00:02:30 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-05-01 00:02:30 (GMT)
commitd6dcf8263ab7ffcbcd9a53234de60457c2c4c0d6 (patch)
treef18273e4282f354ab870736c934799942b2f3685 /Lib/anydbm.py
parent015014ff63e13bbb838ee6cc03336d9615ad8285 (diff)
downloadcpython-d6dcf8263ab7ffcbcd9a53234de60457c2c4c0d6.zip
cpython-d6dcf8263ab7ffcbcd9a53234de60457c2c4c0d6.tar.gz
cpython-d6dcf8263ab7ffcbcd9a53234de60457c2c4c0d6.tar.bz2
Add docstring to anydbm.open
Diffstat (limited to 'Lib/anydbm.py')
-rw-r--r--Lib/anydbm.py24
1 files changed, 13 insertions, 11 deletions
diff --git a/Lib/anydbm.py b/Lib/anydbm.py
index 8b01ef3..ba7e905 100644
--- a/Lib/anydbm.py
+++ b/Lib/anydbm.py
@@ -29,17 +29,8 @@ It has the following interface (key and data are strings):
list = d.keys() # return a list of all existing keys (slow!)
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.
-
-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.
-
"""
class error(Exception):
@@ -63,7 +54,18 @@ if not _defaultmod:
error = tuple(_errors)
-def open(file, flag = 'r', mode = 0666):
+def open(file, flag='r', mode=0666):
+ """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.
+ """
+
# guess the type of an existing database
from whichdb import whichdb
result=whichdb(file)