diff --git a/include/pybind11/cast.h b/include/pybind11/cast.h index f6a7e83be8..2ae25c2ebf 100644 --- a/include/pybind11/cast.h +++ b/include/pybind11/cast.h @@ -1012,10 +1012,18 @@ template <> struct handle_type_name { static constexpr auto name = const_name("*args"); }; +template +struct handle_type_name> { + static constexpr auto name = const_name("*args: ") + make_caster::name; +}; template <> struct handle_type_name { static constexpr auto name = const_name("**kwargs"); }; +template +struct handle_type_name> { + static constexpr auto name = const_name("**kwargs: ") + make_caster::name; +}; template <> struct handle_type_name { static constexpr auto name = const_name(); diff --git a/include/pybind11/pytypes.h b/include/pybind11/pytypes.h index 027e36098b..60d51fdcff 100644 --- a/include/pybind11/pytypes.h +++ b/include/pybind11/pytypes.h @@ -2226,6 +2226,18 @@ class kwargs : public dict { PYBIND11_OBJECT_DEFAULT(kwargs, dict, PyDict_Check) }; +// Subclasses of args and kwargs to support type hinting +// as defined in PEP 484. See #5357 for more info. +template +class Args : public args { + using args::args; +}; + +template +class KWArgs : public kwargs { + using kwargs::kwargs; +}; + class anyset : public object { public: PYBIND11_OBJECT(anyset, object, PyAnySet_Check) diff --git a/tests/test_kwargs_and_defaults.cpp b/tests/test_kwargs_and_defaults.cpp index 09036ccd51..831947f160 100644 --- a/tests/test_kwargs_and_defaults.cpp +++ b/tests/test_kwargs_and_defaults.cpp @@ -14,26 +14,6 @@ #include -// Classes needed for subclass test. -class ArgsSubclass : public py::args { - using py::args::args; -}; -class KWArgsSubclass : public py::kwargs { - using py::kwargs::kwargs; -}; -namespace pybind11 { -namespace detail { -template <> -struct handle_type_name { - static constexpr auto name = const_name("*Args"); -}; -template <> -struct handle_type_name { - static constexpr auto name = const_name("**KWArgs"); -}; -} // namespace detail -} // namespace pybind11 - TEST_SUBMODULE(kwargs_and_defaults, m) { auto kw_func = [](int x, int y) { return "x=" + std::to_string(x) + ", y=" + std::to_string(y); }; @@ -345,7 +325,7 @@ TEST_SUBMODULE(kwargs_and_defaults, m) { // Test support for args and kwargs subclasses m.def("args_kwargs_subclass_function", - [](const ArgsSubclass &args, const KWArgsSubclass &kwargs) { + [](const py::Args &args, const py::KWArgs &kwargs) { return py::make_tuple(args, kwargs); }); } diff --git a/tests/test_kwargs_and_defaults.py b/tests/test_kwargs_and_defaults.py index e3e9a0a0d1..e558d8ad2a 100644 --- a/tests/test_kwargs_and_defaults.py +++ b/tests/test_kwargs_and_defaults.py @@ -20,7 +20,7 @@ def test_function_signatures(doc): ) assert ( doc(m.args_kwargs_subclass_function) - == "args_kwargs_subclass_function(*Args, **KWArgs) -> tuple" + == "args_kwargs_subclass_function(*args: str, **kwargs: str) -> tuple" ) assert ( doc(m.KWClass.foo0)