Skip to content

Commit

Permalink
feat(types): add support for Typing.Callable Special Case (#5202)
Browse files Browse the repository at this point in the history
* Add special case

* linty
  • Loading branch information
InvincibleRMC authored Jun 26, 2024
1 parent 2e35470 commit 4bd538a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions include/pybind11/typing.h
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@ struct handle_type_name<typing::Callable<Return(Args...)>> {
+ const_name("], ") + make_caster<retval_type>::name + const_name("]");
};

template <typename Return>
struct handle_type_name<typing::Callable<Return(ellipsis)>> {
// PEP 484 specifies this syntax for defining only return types of callables
using retval_type = conditional_t<std::is_same<Return, void>::value, void_type, Return>;
static constexpr auto name
= const_name("Callable[..., ") + make_caster<retval_type>::name + const_name("]");
};

template <typename T>
struct handle_type_name<typing::Type<T>> {
static constexpr auto name = const_name("type[") + make_caster<T>::name + const_name("]");
Expand Down
1 change: 1 addition & 0 deletions tests/test_pytypes.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -865,6 +865,7 @@ TEST_SUBMODULE(pytypes, m) {
m.def("annotate_fn",
[](const py::typing::Callable<int(py::typing::List<py::str>, py::str)> &) {});

m.def("annotate_fn_only_return", [](const py::typing::Callable<int(py::ellipsis)> &) {});
m.def("annotate_type", [](const py::typing::Type<int> &t) -> py::type { return t; });

m.def("annotate_union",
Expand Down
7 changes: 7 additions & 0 deletions tests/test_pytypes.py
Original file line number Diff line number Diff line change
Expand Up @@ -959,6 +959,13 @@ def test_fn_annotations(doc):
)


def test_fn_return_only(doc):
assert (
doc(m.annotate_fn_only_return)
== "annotate_fn_only_return(arg0: Callable[..., int]) -> None"
)


def test_type_annotation(doc):
assert doc(m.annotate_type) == "annotate_type(arg0: type[int]) -> type"

Expand Down

0 comments on commit 4bd538a

Please sign in to comment.