Draft: Add pyi stubs for type hinting #709
Closed
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
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.
Which issue does this PR close?
This PR does not close an issue, but it aims to address part of the discussion in #440 . This takes the excellent work in https://github.com/3ok/datafusion-stubs and imports two of the stubs they have written, context and dataframe. By adding these stubs we get much better user documentation for SessionConfig, SessionContext, and DataFrame. You can see the hover text for an IDE below.
Rationale for this change
Getting into DataFusion as a new user can be difficult when using the python interface because we do not have good type hinting from function calls. This PR adds these features for a couple of the major uses.
What changes are included in this PR?
This PR adds two pyi files and updates the associated init.py file to include them.
Are there any user-facing changes?
Users can now get useful hover text in IDEs. There are no API changes.