Stub pyi file autogen using pyo3-stub-gen #237
Draft
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
unkcpz
commented
Jan 22, 2025
| @@ -48,3 +48,8 @@ serde_json.workspace = true | |||
| ctrlc.workspace = true | |||
|
|
|||
| argmin_testfunctions.workspace = true | |||
| pyo3-stub-gen = { path = "../../pyo3-stub-gen/pyo3-stub-gen", features = ["numpy"] } | |||
There was a problem hiding this comment.
Change in Jij-Inc/pyo3-stub-gen#142 required.
| @@ -21,7 +21,8 @@ build-backend = "maturin" | |||
| requires = ["maturin>=1.0, <2.0"] | |||
|
|
|||
| [tool.maturin] | |||
| python-source = "./" | |||
| python-source = "egobox" | |||
There was a problem hiding this comment.
this will make pyo3-stub-gen to put egobox.pyi inside python/egobox, I hope it is corrected?
Sure, I think that is a feasible plan. I'll move the auto-gen part into another PR and keep this one with only the |
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.
derived from #235, I think this way is a bit more elegant and can avoid duplicating the docstring.
It require extra proc-macros to be added (unavoidable because
pyo3-stub-gennot part of PyO3).Since in egobox, it use the
PyReadonlyArraywhich not cover by pyo3-stub-gen, the conversion would fail. I open a PR with the change of Jij-Inc/pyo3-stub-gen#142 to support it.@relf what do you think? I just did without change any docstring in Rust side, but if the auto stub gen framework is there, the change can only happened for the rust docstring, then out the scope of this PR.
EDIT: this one should wait until Jij-Inc/pyo3-stub-gen#142 adapted and back port to with 0.6.x