Skip to content
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

Jump to bottom

fix(types): create handle_type_name specialization to type-hint variable length tuples #5051

Merged
merged 2 commits into from Mar 21, 2024
Merged

fix(types): create handle_type_name specialization to type-hint variable length tuples #5051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72732ee
Create handle_type_name specialization to handle variable length tuples
watsonjj Mar 8, 2024
03c701c
style: pre-commit fixes
pre-commit-ci[bot] Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions include/pybind11/typing.h
View file
Open in desktop
Expand Up @@ -79,6 +79,13 @@ struct handle_type_name<typing::Tuple<>> {
static constexpr auto name = const_name("tuple[()]");
};

template <typename T>
struct handle_type_name<typing::Tuple<T, ellipsis>> {
// PEP 484 specifies this syntax for a variable-length tuple
static constexpr auto name
= const_name("tuple[") + make_caster<T>::name + const_name(", ...]");
};

template <typename K, typename V>
struct handle_type_name<typing::Dict<K, V>> {
static constexpr auto name = const_name("dict[") + make_caster<K>::name + const_name(", ")
Expand Down
2 changes: 2 additions & 0 deletions tests/test_pytypes.cpp
View file
Open in desktop
Expand Up @@ -825,6 +825,8 @@ TEST_SUBMODULE(pytypes, m) {

m.def("annotate_tuple_float_str", [](const py::typing::Tuple<py::float_, py::str> &) {});
m.def("annotate_tuple_empty", [](const py::typing::Tuple<> &) {});
m.def("annotate_tuple_variable_length",
[](const py::typing::Tuple<py::float_, py::ellipsis> &) {});
m.def("annotate_dict_str_int", [](const py::typing::Dict<py::str, int> &) {});
m.def("annotate_list_int", [](const py::typing::List<int> &) {});
m.def("annotate_set_str", [](const py::typing::Set<std::string> &) {});
Expand Down
7 changes: 7 additions & 0 deletions tests/test_pytypes.py
View file
Open in desktop
Expand Up @@ -911,6 +911,13 @@ def test_tuple_empty_annotations(doc):
)


def test_tuple_variable_length_annotations(doc):
assert (
doc(m.annotate_tuple_variable_length)
== "annotate_tuple_variable_length(arg0: tuple[float, ...]) -> None"
)


def test_dict_annotations(doc):
assert (
doc(m.annotate_dict_str_int)
Expand Down