Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-22 05:05:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(types): adds support for Never and NoReturn from python Typing (#5193)

Browse Source 
* Adds support for Never and NoReturn

* lint
This commit is contained in:
Michael Carlstrom 2024-06-25 21:10:25 -04:00 committed by GitHub
parent 183059f9a4
commit 26281c7986
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/pybind11/typing.h
View File

@ -80,6 +80,13 @@ class Optional : public object {
using object::object;
};
class NoReturn : public none {
using none::none;
};
class Never : public none {
using none::none;
};
#if defined(__cpp_nontype_template_parameter_class)
template <size_t N>
struct StringLiteral {
@ -176,6 +183,15 @@ struct handle_type_name<typing::Optional<T>> {
static constexpr auto name = const_name("Optional[") + make_caster<T>::name + const_name("]");
};
template <>
struct handle_type_name<typing::NoReturn> {
static constexpr auto name = const_name("NoReturn");
};
template <>
struct handle_type_name<typing::Never> {
static constexpr auto name = const_name("Never");
};
#if defined(__cpp_nontype_template_parameter_class)
template <typing::StringLiteral... Literals>
struct handle_type_name<typing::Literal<Literals...>> {

3
tests/test_pytypes.cpp
View File

@ -891,6 +891,9 @@ TEST_SUBMODULE(pytypes, m) {
list.append(py::none());
return list;
});
m.def("annotate_no_return", []() -> py::typing::NoReturn { throw 0; });
m.def("annotate_never", []() -> py::typing::Never { throw 0; });
m.def("annotate_optional_to_object",
[](py::typing::Optional<int> &o) -> py::object { return o; });

8
tests/test_pytypes.py
View File

@ -991,6 +991,14 @@ def test_optional_annotations(doc):
)
def test_no_return_annotation(doc):
assert doc(m.annotate_no_return) == "annotate_no_return() -> NoReturn"
def test_never_annotation(doc):
assert doc(m.annotate_never) == "annotate_never() -> Never"
def test_optional_object_annotations(doc):
assert (
doc(m.annotate_optional_to_object)