Skip to content

Update the dbm documentation #137919

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
merged 3 commits into from
Aug 19, 2025
Merged

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Aug 18, 2025

Unify documentation for all backends, enumerate all not implemented mapping methods, document particularities of implemented mapping methods.


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

Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
Copy link
Member Author

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reordered methods because they order was inconsistent between classes.

I am not sure whether it is worth to document clear() methods for gdbm and ndbm (they are the part of the mutable mapping protocol) or just add the versionchanged` directives.

We may add other not yet implemented methods (pop, popitem, values, update) in future, as some mapping methods were added in the past.

Copy link

@auvipy auvipy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@serhiy-storchaka serhiy-storchaka merged commit 8700404 into python:main Aug 19, 2025
31 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 19, 2025
@miss-islington-app
Copy link

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka deleted the docs-dbm branch August 19, 2025 15:05
@miss-islington-app
Copy link

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 8700404f8688d6a56279dce47a5a5802ec53ed06 3.14

@miss-islington-app
Copy link

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 8700404f8688d6a56279dce47a5a5802ec53ed06 3.13

serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Aug 19, 2025
Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
(cherry picked from commit 8700404)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Aug 19, 2025
Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
(cherry picked from commit 8700404)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Aug 19, 2025

GH-137963 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Aug 19, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 19, 2025

GH-137962 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Aug 19, 2025
serhiy-storchaka added a commit that referenced this pull request Aug 19, 2025
Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
(cherry picked from commit 8700404)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants