Skip to content

Add shortcut dict::get and optimize item access for dict #2779

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.

Sign up for GitHub

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
lqf96 wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add shortcut dict::get and optimize item access for dict #2779

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a9b35d
Add `dict::get` that mirrors `dict.get` in Python
lqf96 Jan 9, 2021
e0aa141
Use default value for default_
lqf96 Jan 9, 2021
5f0aead
dict_accessor for optimized operator [] of dict
lqf96 Jan 11, 2021
6b2d1ba
Unify code for Python 2 and 3
lqf96 Jan 11, 2021
fcecfae
Do not inc_ref for key
lqf96 Jan 11, 2021
68684d6
Merge branch 'master' of https://github.com/pybind/pybind11 into dict…
Skylion007 Sep 13, 2021
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
19 changes: 19 additions & 0 deletions include/pybind11/pytypes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1292,6 +1292,25 @@ class dict : public object {
return PyDict_Contains(m_ptr, detail::object_or_cast(std::forward<T>(key)).ptr()) == 1;
}

object get(handle key, handle default_) const {
if (PyObject *result = PyDict_GetItem(m_ptr, key.ptr())) {
return reinterpret_borrow<object>(result);
} else {
return reinterpret_borrow<object>(default_);
}
}

object get(const char *key, handle default_) const {
if (PyObject *result = PyDict_GetItemString(m_ptr, key)) {
return reinterpret_borrow<object>(result);
} else {
return reinterpret_borrow<object>(default_);
}
}

object get(handle key) const { return get(key, none()); }
object get(const char *key) const { return get(key, none()); }

private:
/// Call the `dict` Python type -- always returns a new reference
static PyObject *raw_dict(PyObject *op) {
Expand Down
12 changes: 12 additions & 0 deletions tests/test_pytypes.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@ TEST_SUBMODULE(pytypes, m) {
m.def("dict_contains", [](py::dict dict, const char* val) {
return dict.contains(val);
});
m.def("dict_get", [](py::dict dict, py::object key, py::object default_) {
return dict.get(key, default_);
});
m.def("dict_get", [](py::dict dict, const char* key, py::object default_) {
return dict.get(key, default_);
});
m.def("dict_get", [](py::dict dict, py::object key) {
return dict.get(key);
});
m.def("dict_get", [](py::dict dict, const char* key) {
return dict.get(key);
});

// test_str
m.def("str_from_string", []() { return py::str(std::string("baz")); });
Expand Down
10 changes: 10 additions & 0 deletions tests/test_pytypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ def test_dict(capture, doc):
assert m.dict_contains({42: None}, 42)
assert m.dict_contains({"foo": None}, "foo")

d2 = {True: 42, 3: "abc", "abc": 3}
assert m.dict_get(d2, True) == 42
assert m.dict_get(d2, False) is None
assert m.dict_get(d2, 3, "def") == "abc"
assert m.dict_get(d2, 5, "def") == "def"
assert m.dict_get(d2, "abc") == 3
assert m.dict_get(d2, "def") is None
assert m.dict_get(d2, "abc", 5) == 3
assert m.dict_get(d2, "def", 5) == 5

assert doc(m.get_dict) == "get_dict() -> dict"
assert doc(m.print_dict) == "print_dict(arg0: dict) -> None"

Expand Down