Skip to content

gh-137829: Fix shelve tests for backend compatibility #137879

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
48 changes: 40 additions & 8 deletions Lib/test/test_shelve.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,8 @@ def test_custom_serializer_and_deserializer(self):
def serializer(obj, protocol):
if isinstance(obj, (bytes, bytearray, str)):
if protocol == 5:
if isinstance(obj, bytearray):
return bytes(obj)
return obj
return type(obj).__name__
elif isinstance(obj, array.array):
Expand Down Expand Up @@ -222,22 +224,25 @@ def deserializer(data):
s["array_data"], array_data.tobytes().decode()
)

def test_custom_incomplete_serializer_and_deserializer(self):
dbm_sqlite3 = import_helper.import_module("dbm.sqlite3")
def test_custom_incomplete_serializer(self):
os.mkdir(self.dirname)
self.addCleanup(os_helper.rmtree, self.dirname)

with self.assertRaises(dbm_sqlite3.error):
def serializer(obj, protocol=None):
pass
def serializer(obj, protocol=None):
pass

def deserializer(data):
return data.decode("utf-8")
def deserializer(data):
return data.decode("utf-8")

with self.assertRaises((TypeError, dbm.error)):
with shelve.open(self.fn, serializer=serializer,
deserializer=deserializer) as s:
s["foo"] = "bar"

def test_custom_incomplete_deserializer(self):
os.mkdir(self.dirname)
self.addCleanup(os_helper.rmtree, self.dirname)

def serializer(obj, protocol=None):
return type(obj).__name__.encode("utf-8")

Expand Down Expand Up @@ -352,7 +357,7 @@ def type_name_len(obj):
self.assertEqual(s["bytearray_data"], "bytearray")
self.assertEqual(s["array_data"], "array")

def test_custom_incomplete_serializer_and_deserializer_bsd_db_shelf(self):
def test_custom_incomplete_deserializer_bsd_db_shelf(self):
berkeleydb = import_helper.import_module("berkeleydb")
os.mkdir(self.dirname)
self.addCleanup(os_helper.rmtree, self.dirname)
Expand All @@ -370,6 +375,11 @@ def deserializer(data):
self.assertIsNone(s["foo"])
self.assertNotEqual(s["foo"], "bar")

def test_custom_incomplete_serializer_bsd_db_shelf(self):
berkeleydb = import_helper.import_module("berkeleydb")
os.mkdir(self.dirname)
self.addCleanup(os_helper.rmtree, self.dirname)

def serializer(obj, protocol=None):
pass

Expand Down Expand Up @@ -399,6 +409,28 @@ def deserializer(data):
self.assertRaises(shelve.ShelveError, shelve.Shelf, {}, **kwargs)
self.assertRaises(shelve.ShelveError, shelve.BsdDbShelf, {}, **kwargs)

def test_custom_serializer_returns_wrong_type_for_key(self):
os.mkdir(self.dirname)
self.addCleanup(os_helper.rmtree, self.dirname)

def serializer(obj, protocol):
# Return None instead of bytes, which is wrong for dbm keys
return None

def deserializer(data):
return data.decode("utf-8") if data else ""

for proto in range(pickle.HIGHEST_PROTOCOL + 1):
with self.subTest(proto=proto), shelve.open(
self.fn,
protocol=proto,
serializer=serializer,
deserializer=deserializer
) as s:
# Serializer returns None for the value, but dbm expects bytes
with self.assertRaises((TypeError, dbm.error)):
s["foo"] = "bar"


class TestShelveBase:
type2test = shelve.Shelf
Expand Down
Loading