Re-export __all__ in __init__.py for pure Rust project
#886
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
This is useful for Python documentation generators which inspect `__all__`. For example, pdoc then correctly displays `module_name` instead of `module_name.module_name`
✅ Deploy Preview for maturin-guide ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
mhils
force-pushed
the
reexport-all
branch
2 times, most recently
from
5173a30 to
72d8fad
Compare
messense
reviewed
Apr 29, 2022
Co-authored-by: messense <messense@icloud.com>
messense
approved these changes
Apr 29, 2022
There was a problem hiding this comment.
Looks good to me, could you please add a changelog entry, thanks!
|
Done, thank you for the super quick review! 🍰 |
|
Released in v0.12.15, should be out soon: https://github.com/PyO3/maturin/actions/runs/2285132178 |
|
Awesome, thanks! 🍰 😃 |
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.
maturin already re-exports
__doc__, but__all__is also useful to be reexported. There are a bunch of Python documentation generators which make use of this. In our case (I work on pdoc), re-exporting__all__means we correctly detect that it'smy_projectand notmy_project.my_project. 😃On that note, thank you folks for the fantastic work you are doing with PyO3/maturin! 🍰
We're working on some Rust extensions for @mitmproxy and PyO3 has just been super wonderful. ❤️