https://github.com/python/cpython/commit/61f8f58f812dab2c201a9c64ebe69e3271a6663c
commit: 61f8f58f812dab2c201a9c64ebe69e3271a6663c
branch: 3.12
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: erlend-aasland <erlend.aasl...@protonmail.com>
date: 2024-01-26T15:18:10Z
summary:
[3.12] Docs: mark up dbm.open() with param list (GH-114601) (#114604)
Also consolidate following paragraphs regarding database objects.
(cherry picked from commit 0bd8297a2208125f76807cdf01f72abe5c94136b)
Co-authored-by: Erlend E. Aasland <erl...@python.org>
files:
M Doc/library/dbm.rst
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst
index fc2dcd5c6cc0e1..e35cd1144be200 100644
--- a/Doc/library/dbm.rst
+++ b/Doc/library/dbm.rst
@@ -58,41 +58,33 @@ the Oracle Berkeley DB.
.. function:: open(file, flag='r', mode=0o666)
- Open the database file *file* and return a corresponding object.
+ Open a database and return the corresponding database object.
- If the database file already exists, the :func:`whichdb` function is used to
- determine its type and the appropriate module is used; if it does not exist,
- the first module listed above that can be imported is used.
+ :param file:
+ The database file to open.
- The optional *flag* argument can be:
+ If the database file already exists, the :func:`whichdb` function is
used to
+ determine its type and the appropriate module is used; if it does not
exist,
+ the first submodule listed above that can be imported is used.
+ :type file: :term:`path-like object`
- .. csv-table::
- :header: "Value", "Meaning"
+ :param str flag:
+ * ``'r'`` (default), |flag_r|
+ * ``'w'``, |flag_w|
+ * ``'c'``, |flag_c|
+ * ``'n'``, |flag_n|
- ``'r'`` (default), |flag_r|
- ``'w'``, |flag_w|
- ``'c'``, |flag_c|
- ``'n'``, |flag_n|
-
- The optional *mode* argument is the Unix mode of the file, used only when
the
- database has to be created. It defaults to octal ``0o666`` (and will be
- modified by the prevailing umask).
+ :param int mode:
+ The Unix file access mode of the file (default: octal ``0o666``),
+ used only when the database has to be created.
.. versionchanged:: 3.11
*file* accepts a :term:`path-like object`.
-
-The object returned by :func:`open` supports the same basic functionality as a
+The object returned by :func:`~dbm.open` supports the same basic functionality
as a
:class:`dict`; keys and their corresponding values can be stored, retrieved,
and
deleted, and the :keyword:`in` operator and the :meth:`!keys` method are
-available, as well as :meth:`!get` and :meth:`!setdefault`.
-
-.. versionchanged:: 3.2
- :meth:`!get` and :meth:`!setdefault` are now available in all database
modules.
-
-.. versionchanged:: 3.8
- Deleting a key from a read-only database raises database module specific
error
- instead of :exc:`KeyError`.
+available, as well as :meth:`!get` and :meth:`!setdefault` methods.
Key and values are always stored as :class:`bytes`. This means that when
strings are used they are implicitly converted to the default encoding before
@@ -101,9 +93,17 @@ being stored.
These objects also support being used in a :keyword:`with` statement, which
will automatically close them when done.
+.. versionchanged:: 3.2
+ :meth:`!get` and :meth:`!setdefault` methods are now available for all
+ :mod:`dbm` backends.
+
.. versionchanged:: 3.4
Added native support for the context management protocol to the objects
- returned by :func:`.open`.
+ returned by :func:`~dbm.open`.
+
+.. versionchanged:: 3.8
+ Deleting a key from a read-only database raises a database module specific
exception
+ instead of :exc:`KeyError`.
The following example records some hostnames and a corresponding title, and
then prints out the contents of the database::
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
