GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-141004: Document `PyODict*` APIs by ZeroIntensity · Pull Request #141136 · python/cpython

Conversation

@ZeroIntensity

@ZeroIntensity ZeroIntensity commented Nov 6, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • Issue: Document the entire C API #141004

📚 Documentation preview 📚: https://cpython-previews--141136.org.readthedocs.build/en/141136/c-api/dict.html#ordered-dictionaries

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
ZeroIntensity added 2 commits November 6, 2025 08:04
@ZeroIntensity
Document PyODict
f3950f2
@ZeroIntensity
Document the iterator type.
154beaa
@bedevere-app bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Nov 6, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Nov 6, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Nov 6, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Nov 6, 2025
Document the entire C API #141004
Closed
StanFromIreland
StanFromIreland reviewed Nov 12, 2025
View reviewed changes
Comment thread Doc/c-api/dict.rst Outdated
Comment on lines +461 to +462
Return true if *od* is a dict object, but not an instance of a subtype of
the :class:`~collections.OrderedDict` type. This function always succeeds.

@StanFromIreland StanFromIreland Nov 12, 2025

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Suggested change
Return true if *od* is a dict object, but not an instance of a subtype of
the :class:`~collections.OrderedDict` type. This function always succeeds.
Return true if *od* is an ordered dictionary object, but not
an instance of a subtype of the :class:`~collections.OrderedDict` type.
This function always succeeds. 
- a dict object
+ an ordered dictionary object

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@ZeroIntensity ZeroIntensity Nov 13, 2025

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Applied this one locally because I didn't want to deal with conflicts.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/dict.rst Outdated
Comment on lines +448 to +449
Since Python 3.7, dictionaries are ordered by default, so there is usually
little need for this object.

@StanFromIreland StanFromIreland Nov 12, 2025

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I suggest moving this to the introductory paragraph.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@ZeroIntensity ZeroIntensity Nov 13, 2025

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Done.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/dict.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@ZeroIntensity

ZeroIntensity commented Nov 12, 2025

Copy link
Copy Markdown
Member Author

I'd like to finish #141009 before doing this one.
StanFromIreland reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@ZeroIntensity ZeroIntensity mentioned this pull request Nov 12, 2025
gh-141004: Document C APIs for dictionary keys, values, and items #141009
Merged
ZeroIntensity added 5 commits November 13, 2025 17:49
@ZeroIntensity
Merge branch 'main' of https://github.com/python/cpython into documen…
3a9351f 
…t-pyodict
@ZeroIntensity
Move obsoleteness note to introductory paragraph.
fb2555e
@ZeroIntensity
Add docs for PyDict_Size().
c4bd239
@ZeroIntensity
Remove leading ! in Sphinx refs.
b69ecac 
These are documented now so we can link to them.
@ZeroIntensity
Fix PyODict_CheckExact() description.
fcaf638
StanFromIreland
StanFromIreland approved these changes Nov 17, 2025
View reviewed changes

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@ZeroIntensity ZeroIntensity added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes labels Nov 17, 2025
@ZeroIntensity
ZeroIntensity merged commit b362632 into python:main Nov 17, 2025
30 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 17, 2025
@ZeroIntensity
ZeroIntensity deleted the document-pyodict branch November 17, 2025 19:40
@miss-islington-app

miss-islington-app Bot commented Nov 17, 2025

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting core review label Nov 17, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 17, 2025
@ZeroIntensity @miss-islington
pythongh-141004: Document PyODict* APIs (pythonGH-141136)
696b56f 
(cherry picked from commit b362632)

Co-authored-by: Peter Bierma <[email protected]>
@bedevere-app

bedevere-app Bot commented Nov 17, 2025

Copy link
Copy Markdown

GH-141677 is a backport of this pull request to the 3.14 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 17, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 17, 2025
@ZeroIntensity @miss-islington
pythongh-141004: Document PyODict* APIs (pythonGH-141136)
b94e32e 
(cherry picked from commit b362632)

Co-authored-by: Peter Bierma <[email protected]>
@bedevere-app

bedevere-app Bot commented Nov 17, 2025

Copy link
Copy Markdown

GH-141678 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label Nov 17, 2025
ZeroIntensity added a commit that referenced this pull request Nov 17, 2025
@miss-islington @ZeroIntensity
[3.14] gh-141004: Document PyODict* APIs (GH-141136) (GH-141677)
aa887aa 
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b362632)

Co-authored-by: Peter Bierma <[email protected]>
ZeroIntensity added a commit that referenced this pull request Nov 17, 2025
@miss-islington @ZeroIntensity
[3.13] gh-141004: Document PyODict* APIs (GH-141136) (GH-141678)
d4e4924 
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b362632)

Co-authored-by: Peter Bierma <[email protected]>
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
@ZeroIntensity @StanFromIreland
pythongh-141004: Document PyODict* APIs (pythonGH-141136)
f9d9a13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@ZeroIntensity @StanFromIreland
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.