Basic type-hinting for the pyo3 wrapper. #788
Conversation
| @@ -101,28 +102,6 @@ impl PyDevice { | |||
| } | |||
| } | |||
|
|
|||
| impl<'source> FromPyObject<'source> for PyDevice { | |||
There was a problem hiding this comment.
The goal here was to be able to specify the device as a string. Could we maintain this functionality?
| @@ -0,0 +1,111 @@ | |||
| from typing import Any, List, Tuple, Union | |||
There was a problem hiding this comment.
Did you have to type all this manually? I'm a bit worried that this will be hard to maintain when making changes to the bindings, I imagine that there is no way to generate these automatically instead at the moment? (I would have thought that it's not that hard actually as it's easy to introspect module elements and documentations in python)
There was a problem hiding this comment.
Yeah i created those manually and you are absolutely right, this will be a nightmare to maintain. I looked into generating them automatically (or at least from the text_signature), but PyO3 doesn't seam to support this currently. See:
- Python Interface (.pyi) generation and runtime inspection PyO3/pyo3#2454
- [Feature Request] add support for type annotation hints in
#[text_signature]macro. PyO3/pyo3#1112
This seams to be blocked by CPython directly: python/cpython#101872
I'm think we should close this PR as there will probably be a lot of changes in candles implementation. This is kind of unfortunate as using the python bindings without type-hints can be a bit tedious. Do you have any suggestions?
There was a problem hiding this comment.
Up to you, as you're planning on making changes to the pyo3 bits as long as you keep this file in mind, I'm happy with merging it - especially if you think it makes you more productive when trying out the python bindings.
There was a problem hiding this comment.
Yeah i don't think creating them manually is sustainable in the long run. I probably look into how tokenizers solves this with their stub.py file.
This PR adds some very basic type-hints for the PyO3 wrapper. This should improve the development experience as the python language server can now infer the types and support the user a bit.
BasicTypehinting.mp4
Currently only a few functions (mainly everything used in the
test.py) got added to the stub file. If we want to add more type-hints i could add them later.