Fix module type hint #5469
Open
Fix module type hint #5469
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"module" is not a valid python value. The correct type hint for a module object is "types.ModuleType" which has existed since at least Python 2.6
rwgk
reviewed
Dec 21, 2024
| @@ -1322,7 +1322,7 @@ PYBIND11_NAMESPACE_BEGIN(detail) | |||
|
|
|||
| template <> | |||
| struct handle_type_name<module_> { | |||
| static constexpr auto name = const_name("module"); | |||
| static constexpr auto name = const_name("types.ModuleType"); | |||
There was a problem hiding this comment.
Could you please add a test? I think it's really simple:
Add in tests/test_modules.py:
def test_module_handle_type_name():
assert m.def_submodule.__doc__ == "TODO"
or possibly
def test_module_handle_type_name(doc):
assert doc(m.def_submodule) == "TODO"
I'd try the __doc__ version first because it's stricter.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
"module" is not a valid python value.
The correct type hint for a module object is "types.ModuleType" which has existed since at least Python 2.6
Suggested changelog entry: