Skip to content

gh-122996: Clarify encoding behavior in dbm module documentation #138030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −2
Open

gh-122996: Clarify encoding behavior in dbm module documentation #138030

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions Doc/library/dbm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,13 @@ The :meth:`!keys` method returns a list instead of a view object.
The :meth:`!setdefault` method requires two arguments.

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
being stored.
strings are used they are implicitly converted to bytes before being stored.
The specific encoding used for this conversion is backend-dependent and may
vary between different dbm implementations and systems. The encoding choice
is determined by the underlying database implementation. For consistent
behavior across different backends and to maintain control over the encoding
process, it is strongly recommended to explicitly convert strings to bytes
using a specific encoding before storing them.

These objects also support being used in a :keyword:`with` statement, which
will automatically close them when done.
Expand Down
Loading