Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-34204: Use pickle.DEFAULT_PROTOCOL in shelve #19639

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.

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 15 additions & 5 deletions Doc/library/shelve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ lots of shared sub-objects. The keys are ordinary strings.
database file is opened for reading and writing. The optional *flag* parameter
has the same interpretation as the *flag* parameter of :func:`dbm.open`.

By default, version 3 pickles are used to serialize values. The version of the
pickle protocol can be specified with the *protocol* parameter.
By default, pickles created with :data:`pickle.DEFAULT_PROTOCOL` are used
to serialize values. The version of the pickle protocol can be specified
with the *protocol* parameter.

Because of Python semantics, a shelf cannot know when a mutable
persistent-dictionary entry is modified. By default modified objects are
Expand All @@ -40,6 +41,10 @@ lots of shared sub-objects. The keys are ordinary strings.
determine which accessed entries are mutable, nor which ones were actually
mutated).

.. versionchanged:: 3.10
:data:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
protocol.

.. note::

Do not rely on the shelf being closed automatically; always call
Expand Down Expand Up @@ -108,9 +113,10 @@ Restrictions
A subclass of :class:`collections.abc.MutableMapping` which stores pickled
values in the *dict* object.

By default, version 3 pickles are used to serialize values. The version of the
pickle protocol can be specified with the *protocol* parameter. See the
:mod:`pickle` documentation for a discussion of the pickle protocols.
By default, pickles created with :data:`pickle.DEFAULT_PROTOCOL` are used
to serialize values. The version of the pickle protocol can be specified
with the *protocol* parameter. See the :mod:`pickle` documentation for a
discussion of the pickle protocols.

If the *writeback* parameter is ``True``, the object will hold a cache of all
entries accessed and write them back to the *dict* at sync and close times.
Expand All @@ -130,6 +136,10 @@ Restrictions
.. versionchanged:: 3.4
Added context manager support.

.. versionchanged:: 3.10
:data:`pickle.DEFAULT_PROTOCOL` is now used as the default pickle
protocol.


.. class:: BsdDbShelf(dict, protocol=None, writeback=False, keyencoding='utf-8')

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,13 @@ py_compile
Added ``--quiet`` option to command-line interface of :mod:`py_compile`.
(Contributed by Gregory Schevchenko in :issue:`38731`.)

shelve
------

The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
instead of :mod:`pickle` protocol ``3`` when creating shelves.
(Contributed by Zackery Spytz in :issue:`34204`.)

sys
---

Expand Down
4 changes: 2 additions & 2 deletions Lib/shelve.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
the persistent dictionary on disk, if feasible).
"""

from pickle import Pickler, Unpickler
from pickle import DEFAULT_PROTOCOL, Pickler, Unpickler
from io import BytesIO

import collections.abc
Expand Down Expand Up @@ -85,7 +85,7 @@ def __init__(self, dict, protocol=None, writeback=False,
keyencoding="utf-8"):
self.dict = dict
if protocol is None:
protocol = 3
protocol = DEFAULT_PROTOCOL
self._protocol = protocol
self.writeback = writeback
self.cache = {}
Expand Down
4 changes: 3 additions & 1 deletion Lib/test/test_shelve.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import unittest
import shelve
import glob
import pickle

from test import support
from test.support import os_helper
from collections.abc import MutableMapping
Expand Down Expand Up @@ -160,7 +162,7 @@ def test_with(self):

def test_default_protocol(self):
with shelve.Shelf({}) as s:
self.assertEqual(s._protocol, 3)
self.assertEqual(s._protocol, pickle.DEFAULT_PROTOCOL)

from test import mapping_tests

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
instead of :mod:`pickle` protocol ``3``.