Add Python type annotation#284
Merged
jborean93 merged 1 commit intopythongssapi:mainpythongssapi/python-gssapi:mainfrom Feb 15, 2022
Merged
Add Python type annotation#284jborean93 merged 1 commit intopythongssapi:mainpythongssapi/python-gssapi:mainfrom
jborean93 merged 1 commit intopythongssapi:mainpythongssapi/python-gssapi:mainfrom
Conversation
fbd623c to
2cc6416
Compare
2cc6416 to
84c421c
Compare
Signed-off-by: Jordan Borean <jborean93@gmail.com>
84c421c to
02924a1
Compare
Contributor
|
LGTM |
simo5
approved these changes
Feb 15, 2022
Contributor
simo5
left a comment
There was a problem hiding this comment.
I think this is a mess of a change, but also very beneficial, I'll steal this stuff.
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.
Adds type annotations to the library for better type analysis and IDE integration with this library. Currently the
gssapi.rawcontents have been annotated with.pyifiles. Using a separate file is quite useful for C extensions as an IDE can easily inspect what functions are meant to be available, their types, and doc strings without having the extension actually compiled and installed. Because of this all the docstrings have been moved out of the Cython pyx files into their respective pyi files. The Sphinx doc generator has also been updated to support this.The next step is to annotate the high level- donegssapipackage and enable some mypy tests for CI to ensure this library is valid.Signed-off-by: Jordan Borean jborean93@gmail.com