Skip to content
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

Document: Why create the stub file in Rust side not in Python side? #65

Open
termoshtt opened this issue Aug 24, 2024 · 1 comment
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@termoshtt
Copy link
Collaborator

The difference from https://github.com/MusicalNinjas/pyo3-stubgen or similar approach should be explained in README.

@termoshtt termoshtt self-assigned this Aug 24, 2024
@termoshtt termoshtt added the documentation Improvements or additions to documentation label Aug 24, 2024
@JacobHayes
Copy link

JacobHayes commented Aug 26, 2024

I wonder if it has to do with this note from the pyo3-stubgen's (the other repo) README:

You will need to manually add the typing information to the generated files as this is not included in any of the function attributes available and is just as dependent upon the semantics of your functions as on the technical implementation.

I think the __text_signature__ in the generated extension module doesn't contain enough information, so pyo3-stub-gen (this repo) needs to see the source before compiling to the extension.

edit: ah haha, didn't see you were a maintainer so guessing you know the answer and this is just a placeholder to document it. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants