The gist, as i recall, is that you’re supposed to maintain a .pyi file in the rust project folder that gets automatically added in by maturin when building. I’m no regex wizard, but i was able to whip together a small script that generates simple function and class stubs that also have the rust docstring. Iirc they’re planning on adding some official support for generating type hints, but i have no idea how far along it is or where it is on the priority list
That’s a bummer. I guess what I though was PyO3 type hints was actually just PyCharm guessing at the types.
I tried creating a .pyi file and it seems to be a pretty big improvement over no type hints, but I don’t know how to add type hints for modules added with PyModule::add_module and adding the .pyi file seems to make the type checker not know about my other modules.
Would you mind sharing the script for auto generating type hints? Keeping them in sync manually would be pretty annoying.
Here’s the script. It’s nothing fancy, and iirc it only works for top level functions/classes. That means you still have to take care of attributes and methods which is a little annoying, but for simple stuff it should save a bit of time.
How is the quality of the generated bindings?
I have previously used PyO3 for Python bindings and it doesn’t seem to correctly generate type hints.
Pyo3 doesnt generate type hints at all iirc. There’s some more info here
The gist, as i recall, is that you’re supposed to maintain a .pyi file in the rust project folder that gets automatically added in by maturin when building. I’m no regex wizard, but i was able to whip together a small script that generates simple function and class stubs that also have the rust docstring. Iirc they’re planning on adding some official support for generating type hints, but i have no idea how far along it is or where it is on the priority list
That’s a bummer. I guess what I though was PyO3 type hints was actually just PyCharm guessing at the types.
I tried creating a
.pyifile and it seems to be a pretty big improvement over no type hints, but I don’t know how to add type hints for modules added withPyModule::add_moduleand adding the.pyifile seems to make the type checker not know about my other modules.Would you mind sharing the script for auto generating type hints? Keeping them in sync manually would be pretty annoying.
Here’s the script. It’s nothing fancy, and iirc it only works for top level functions/classes. That means you still have to take care of attributes and methods which is a little annoying, but for simple stuff it should save a bit of time.