(original) (raw)

changeset: 91400:90dd9eec1230 parent: 91396:74cd8abcc302 parent: 91399:88fb216b99fb user: Jesus Cea jcea@jcea.es date: Wed Jun 25 13:06:32 2014 +0200 files: Doc/library/dbm.rst description: MERGE: Closes #20872: dbm/gdbm/ndbm close methods are not documented diff -r 74cd8abcc302 -r 90dd9eec1230 Doc/library/dbm.rst --- a/Doc/library/dbm.rst Wed Jun 25 02:58:53 2014 -0700 +++ b/Doc/library/dbm.rst Wed Jun 25 13:06:32 2014 +0200 @@ -222,6 +222,9 @@ When the database has been opened in fast mode, this method forces any unwritten data to be written to the disk. + .. method:: gdbm.close() + + Close the ``gdbm`` database. :mod:`dbm.ndbm` --- Interface based on ndbm ------------------------------------------- @@ -253,7 +256,7 @@ .. function:: open(filename[, flag[, mode]]) - Open a dbm database and return a ``dbm`` object. The *filename* argument is the + Open a dbm database and return a ``ndbm`` object. The *filename* argument is the name of the database file (without the :file:`.dir` or :file:`.pag` extensions). The optional *flag* argument must be one of these values: @@ -278,6 +281,12 @@ database has to be created. It defaults to octal ``0o666`` (and will be modified by the prevailing umask). + In addition to the dictionary-like methods, ``ndbm`` objects + provide the following method: + + .. method:: ndbm.close() + + Close the ``ndbm`` database. :mod:`dbm.dumb` --- Portable DBM implementation @@ -330,9 +339,14 @@ In addition to the methods provided by the :class:`collections.abc.MutableMapping` class, :class:`dumbdbm` objects - provide the following method: + provide the following methods: .. method:: dumbdbm.sync() Synchronize the on-disk directory and data files. This method is called by the :meth:`Shelve.sync` method. + + .. method:: dumbdbm.close() + + Close the ``dumbdbm`` database. + /jcea@jcea.es