gh-99631: Add custom loads and dumps support for the shelve module by furkanonder · Pull Request #118065 · python/cpython

furkanonder · 2024-04-18T19:52:53Z

Issue: Custom unpickler and pickler for the shelve module #99631

📚 Documentation preview 📚: https://cpython-previews--118065.org.readthedocs.build/

…BsdDbShelf

Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>

…ssue-99631-2

encukou

BsdDbShelf still uses pickle.Unpickler directly to walk the keys.

bedevere-app · 2024-04-23T14:57:49Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-authored-by: Petr Viktorin <encukou@gmail.com>

…DbShelf

…ssue-99631-2

furkanonder · 2024-07-14T02:26:23Z

@@ -160,18 +181,20 @@ Restrictions
 modules. The *dict* object passed to the constructor must support those
 methods. This is generally accomplished by calling one of
 :func:`!bsddb.hashopen`, :func:`!bsddb.btopen` or :func:`!bsddb.rnopen`. The


By the way, we also need to update this sentence (from bsddb to berkeleydb). bsddb is deprecated according to https://www.jcea.es/programacion/pybsddb.htm.

It looks like the change would be bigger: it’s a new module (although the docs are not very clear) with maybe a new API.
Updating or deprecating this should be discussed in its own ticket 🙂

Yes, I agree on it. It would be better to open a new ticket to discuss this issue.

... or consider instead opening topic on Discourse; this may need a larger audience than what you'd get on the bug tracker.

picnixz

Some few nitpicks that I thought of. Some should be addressed (3.15 -> next + self.subTest(proto=5)`, while others are purely cosmetics.

I'll let a core dev check other stuff (

This core dev is now me.

modified: Doc/library/shelve.rst

…t_missing_custom_serializer

…e wrapping

picnixz

Almost done!

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

picnixz · 2025-07-12T12:27:58Z

Oof, I forgot to merge main. Well, I don't think something for shelve changed in between and there were no conflicts, so it should be fine. Thanks for waiting!

…e` module (python#118065) Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

furkanonder · 2025-07-13T17:30:17Z

Oof, I forgot to merge main. Well, I don't think something for shelve changed in between and there were no conflicts, so it should be fine. Thanks for waiting!

Thanks for the merge!

…e` module (python#118065) Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

furkanonder added 3 commits April 18, 2024 22:23

Use custom loads & dumps instead of custom pickler & unpickler for Shelf
e269c09

Allow custom loads & dumps instead of custom pickler & unpickler for …
3465149
…BsdDbShelf

Update documentation for serializer and deserializred functions
44b9fa1

bedevere-appBot mentioned this pull request Apr 18, 2024
Custom unpickler and pickler for the shelve module #99631
Closed

bedevere-appBot added the awaiting review label Apr 18, 2024

furkanonder mentioned this pull request Apr 18, 2024
gh-99631: Add custom loads and dumps support for the shelve module #99632
Closed

merwok reviewed Apr 18, 2024
View reviewed changes

Comment threadLib/shelve.py

merwok reviewed Apr 18, 2024
View reviewed changes

Comment threadDoc/library/shelve.rst Outdated

eendebakpt reviewed Apr 20, 2024
View reviewed changes

Comment threadDoc/library/shelve.rst Outdated
Comment threadDoc/library/shelve.rst Outdated
Comment threadDoc/library/shelve.rst Outdated
Comment threadLib/shelve.py Outdated

furkanonderand others added 10 commits April 21, 2024 00:11

Update Doc/library/shelve.rst
f2eed32
Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>

Update Doc/library/shelve.rst
b3e5723
Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>

Update documentation for serializer and deserializer functions
53d5557

Merge branch 'main' into issue-99631-2
d496eab

Fix lines according to PEP-8
1e295ba

Merge branch 'issue-99631-2' of github.com:furkanonder/cpython into i…
2011baa
…ssue-99631-2

Fix doc according to line 80
3cbabe9

Merge branch 'main' into issue-99631-2
67b7340

Fix inline emphasis issue in docs
c6b43e2

Merge branch 'issue-99631-2' of github.com:furkanonder/cpython into i…
52a90f7
…ssue-99631-2

encukou requested changes Apr 23, 2024
View reviewed changes

Comment threadDoc/library/shelve.rst Outdated
Comment threadDoc/library/shelve.rst Outdated
Comment threadLib/shelve.py Outdated

bedevere-appBot added awaiting changes and removed awaiting review labels Apr 23, 2024

furkanonderand others added 6 commits July 14, 2024 01:31

Update the definition of the open function.
4f79cf6
Co-authored-by: Petr Viktorin <encukou@gmail.com>

Pass the serializer and serializer arguments of Shelf.__init__ of Bsd…
798fdb2
…DbShelf

Add unittests for BsdDbShelf
bb1150d

Merge branch 'issue-99631-2' of github.com:furkanonder/cpython into i…
98d841b
…ssue-99631-2

Update BsdDbShelf's set_location, last and first functions
1159bb6

Update BsdDbShelf's next and previous functions
4b4f1b6

furkanonder commented Jul 14, 2024
View reviewed changes

change the test order
b3770ae

furkanonder added awaiting review and removed 3.14 bugs and security fixes awaiting changes labels Sep 13, 2024

furkanonder added 3 commits April 19, 2025 21:05

Merge branch 'main' into issue-99631-2
588623a

Update shelve module version references from 3.14 to 3.15
4d9599b

Merge branch 'main' into issue-99631-2
9b204b7

picnixz reviewed May 30, 2025
View reviewed changes

furkanonder added 7 commits May 30, 2025 18:25

Change shelve module version references from 3.15 to next
8b06918
modified: Doc/library/shelve.rst

Change shelve module version references from 3.15 to next
b0f0bbc

refactor nested context managers for better readability
d1bb227

simplify assertRaises calls in test_missing_custom_deserializer & tes…
791743b
…t_missing_custom_serializer

refactor nested context managers for better readability
6b4be8b

Add type_name_len helper and use shorter variable names to reduce lin…
34a32b9
…e wrapping

Merge branch 'main' into issue-99631-2
bf6f3aa

furkanonder requested a review from picnixz May 30, 2025 16:04

picnixz reviewed Jun 2, 2025
View reviewed changes

Comment threadDoc/library/shelve.rst Outdated
Comment threadDoc/library/shelve.rst Outdated
Comment threadLib/test/test_shelve.py Outdated
Comment threadLib/test/test_shelve.py Outdated

furkanonderand others added 5 commits June 2, 2025 20:05

Improve the description of the open function
4b000cd
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Update the description of ShelveError
2dcda2a
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Simplify conditional branches in serializer and deserializer functions
00bfb01

Merge branch 'main' into issue-99631-2
23ea842

Merge branch 'main' into issue-99631-2
4df9b58

picnixz merged commit dda70fa into python:mainJul 12, 2025

bedevere-appBot removed the awaiting review label Jul 12, 2025

Uh oh!

Uh oh!

Conversation

furkanonder commented Apr 18, 2024• edited by github-actions BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

encukou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-appBot commented Apr 23, 2024

Uh oh!

furkanonderJul 14, 2024

Choose a reason for hiding this comment

Uh oh!

merwokJul 14, 2024

Choose a reason for hiding this comment

Uh oh!

furkanonderJul 16, 2024

Choose a reason for hiding this comment

Uh oh!

erlend-aaslandJul 17, 2024

Choose a reason for hiding this comment

Uh oh!

picnixz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

picnixz commented Jul 12, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

furkanonder commented Jul 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

furkanonder commented Apr 18, 2024•
edited by github-actions Bot
Loading

picnixz left a comment •
edited
Loading

picnixz commented Jul 12, 2025•
edited
Loading