Skip to content

feat: add dict::get - #6265

Merged
rwgk merged 1 commit into
pybind:masterfrom
henryiii:henryiii/feat/dict-get
Nov 21, 2026
Merged

rwgk merged 1 commit into
pybind:masterfrom
henryiii:henryiii/feat/dict-get

Conversation

@henryiii

@henryiii henryiii commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

🤖 AI text below 🤖

Description

Adds py::dict::get(key, default), equivalent to Python's dict.get. The default is optional and is None if omitted. Keys and defaults go through object_or_cast, the same as dict::contains.

The lookup is done once, with no KeyError (this is the benefit to adding this as new API, rather than the current workaround). A new detail::dict_getitemref helper uses PyDict_GetItemRef on Python 3.13+ (a strong reference, safe on free-threaded builds) and PyDict_GetItemWithError on older versions. Errors from __hash__ or __eq__ propagate.

Supersedes #1513 and the dict::get part of, and close #2779.

Why close #2779?

🤖 AI text below 🤖

The only other part of #2779 is the dict_accessor specialization of dict::operator[], and I recommend that you do not take it.

  • It changes behavior for dict subclasses. py::dict accepts any PyDict_Check object. Today d[key] uses PyObject_GetItem / PyObject_SetItem, which call __missing__ and overridden __getitem__ / __setitem__. The PyDict_GetItemWithError / PyDict_SetItem calls in Add shortcut dict::get and optimize item access for dict #2779 skip these, so d["x"] on a defaultdict would raise KeyError.
  • The speed gain is small. For an exact dict, PyObject_GetItem goes through one slot call to dict_subscript, which does the same hash lookup. rwgk raised the same objection in the thread.
  • It is not safe on free-threaded builds as written. It returns a borrowed reference. It would need PyDict_GetItemRef, the function that feat: add dict::get #6265 already wraps in dict_getitemref.
  • It changes the return type of dict::operator[]. The type goes from item_accessor to dict_accessor. This breaks code that names the type, and it removes the deprecated operator bool, which is enabled only for generic_item.

The rest of #2779 is obsolete or already on master: the Python 2 macro and the dict_contains tests.

setdefault was discussed in the thread but is not in the diff. It has the same subclass problem as operator[] if it uses PyDict_SetDefault, and d.attr("setdefault")(k, v) already works.

Suggested changelog entry:

  • Added py::dict::get(key, default), equivalent to Python's dict.get.

Mirror Python's dict.get(key, default=None) with a single lookup.

Assisted-by: ClaudeCode:claude-fable-5-2
@rwgk
rwgk merged commit 96e4f32 into pybind:master Nov 21, 2026
101 of 102 checks passed
@rwgk
rwgk deleted the henryiii/feat/dict-get branch November 21, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants