Improve auto-generated documentation and type stubs#1413
Open
KurtBoehm wants to merge 3 commits into
Open
Conversation
- Use `bytes` and `str | Path` where appropriate. - Extend the type stub generation to generate the full enum definitions and define `Operation` and `Introspect`. - Extend the type stub with more operations (all apart from nifti-based ones).
Member
|
This is very cool @KurtBoehm! I'll try to review this week. Yes, nifti is surprisingly difficult to build :( I leave it out of the flatpak and win builds as well, it's just too annoying. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR introduces several improvements to the typing in the documentation and the type stubs:
bytesas the type of buffers (which is actually what functions such aspngsave_bufferreturn) andstr | Pathfor file names (which were typed as juststruntil now, but the helper function converting strings to bytes already handlespathlib.Path).OperationandIntrospect.The only remaining limitation of the
Imagetype stubs is the lack of nifti operations, as I was not able to install libniftiio on Arch Linux in a way that libvips recognized during compilation (and I did not really want to spend more time on installing it).