-
Notifications
You must be signed in to change notification settings - Fork 2.2k
fix(types): provide better type hints for a variety of generic types #4259
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.
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
Changes from all commits
88824b5
33f9bac
5f8b132
1685758
ccaeb52
f9d8694
072049a
8e6b00f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
/* | ||
pybind11/typing.h: Convenience wrapper classes for basic Python types | ||
with more explicit annotations. | ||
|
||
Copyright (c) 2023 Dustin Spicuzza <[email protected]> | ||
|
||
All rights reserved. Use of this source code is governed by a | ||
BSD-style license that can be found in the LICENSE file. | ||
*/ | ||
|
||
#pragma once | ||
|
||
#include "detail/common.h" | ||
#include "cast.h" | ||
#include "pytypes.h" | ||
|
||
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) | ||
PYBIND11_NAMESPACE_BEGIN(typing) | ||
|
||
/* | ||
The following types can be used to direct pybind11-generated docstrings | ||
to have have more explicit types (e.g., `list[str]` instead of `list`). | ||
Just use these in place of existing types. | ||
|
||
There is no additional enforcement of types at runtime. | ||
*/ | ||
|
||
template <typename... Types> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this feature will be clearer as such by having the types below in a I'm not sure about (e.g.) |
||
class Tuple : public tuple { | ||
using tuple::tuple; | ||
}; | ||
|
||
template <typename K, typename V> | ||
class Dict : public dict { | ||
using dict::dict; | ||
}; | ||
|
||
template <typename T> | ||
class List : public list { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could this be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update: I just ran this by a typing expert on my team, from that I learned:
Is that too tricky to implement for this PR? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, the equivalent for |
||
using list::list; | ||
}; | ||
|
||
template <typename T> | ||
class Set : public set { | ||
using set::set; | ||
}; | ||
|
||
template <typename Signature> | ||
class Callable; | ||
|
||
template <typename Return, typename... Args> | ||
class Callable<Return(Args...)> : public function { | ||
using function::function; | ||
}; | ||
|
||
PYBIND11_NAMESPACE_END(typing) | ||
|
||
PYBIND11_NAMESPACE_BEGIN(detail) | ||
|
||
template <typename... Types> | ||
struct handle_type_name<typing::Tuple<Types...>> { | ||
static constexpr auto name | ||
= const_name("tuple[") + concat(make_caster<Types>::name...) + const_name("]"); | ||
}; | ||
|
||
template <> | ||
struct handle_type_name<typing::Tuple<>> { | ||
// PEP 484 specifies this syntax for an empty tuple | ||
static constexpr auto name = const_name("tuple[()]"); | ||
}; | ||
|
||
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(", ") | ||
+ make_caster<V>::name + const_name("]"); | ||
}; | ||
|
||
template <typename T> | ||
struct handle_type_name<typing::List<T>> { | ||
static constexpr auto name = const_name("list[") + make_caster<T>::name + const_name("]"); | ||
}; | ||
|
||
template <typename T> | ||
struct handle_type_name<typing::Set<T>> { | ||
static constexpr auto name = const_name("set[") + make_caster<T>::name + const_name("]"); | ||
}; | ||
|
||
template <typename Return, typename... Args> | ||
struct handle_type_name<typing::Callable<Return(Args...)>> { | ||
using retval_type = conditional_t<std::is_same<Return, void>::value, void_type, Return>; | ||
static constexpr auto name = const_name("Callable[[") + concat(make_caster<Args>::name...) | ||
+ const_name("], ") + make_caster<retval_type>::name | ||
+ const_name("]"); | ||
}; | ||
|
||
PYBIND11_NAMESPACE_END(detail) | ||
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
Uh oh!
There was an error while loading. Please reload this page.