diff options
Diffstat (limited to 'Doc/library/whichdb.rst')
-rw-r--r-- | Doc/library/whichdb.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/library/whichdb.rst b/Doc/library/whichdb.rst new file mode 100644 index 0000000..5c69818 --- /dev/null +++ b/Doc/library/whichdb.rst @@ -0,0 +1,20 @@ + +:mod:`whichdb` --- Guess which DBM module created a database +============================================================ + +.. module:: whichdb + :synopsis: Guess which DBM-style module created a given database. + + +The single function in this module attempts to guess which of the several simple +database modules available--\ :mod:`dbm`, :mod:`gdbm`, or :mod:`dbhash`\ +--should be used to open a given file. + + +.. function:: whichdb(filename) + + Returns one of the following values: ``None`` if the file can't be opened + because it's unreadable or doesn't exist; the empty string (``''``) if the + file's format can't be guessed; or a string containing the required module name, + such as ``'dbm'`` or ``'gdbm'``. + |