- Notifications
You must be signed in to change notification settings - Fork674
feat: indicate that we are a typed package#1421
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
By adding the file: py.typedit indicates that python-gitlab is a typed package and containstype-hints.https://www.python.org/dev/peps/pep-0561/
codecov-commenter commentedApr 28, 2021
Codecov Report
@@ Coverage Diff @@## master #1421 +/- ##======================================= Coverage 80.24% 80.24% ======================================= Files 73 73 Lines 4064 4064 ======================================= Hits 3261 3261 Misses 803 803
Flags with carried forward coverage won't be shown.Click here to find out more. Continue to review full report at Codecov.
|
nejch left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
question: does this mean we should probably do in.mypy.ini:
[mypy]files = gitlab/**/*.py
So that we check this recursively with mypy aspy.typed applies recursively, just in case.
Currently, this fails because of unit tests, but I've long thought we should unit and functional tests together, outside the source dir. (e.g.tools/functional ->tests/functional,gitlab/tests ->tests/unit)
JohnVillalovos commentedApr 28, 2021 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
I would like to wait on saying we mypy check everything. As I don't think we are ready. This PR in my mind is just saying we do have type-hints so someone can use them. Also Do we have type-hints for everything? No, but progress is being made and the type-hints we have are useful already and can be used by users of this library to help type-hint their code. |
nejch commentedApr 28, 2021
Ok makes sense :) Thanks! |
By adding the file: py.typed
it indicates that python-gitlab is a typed package and contains
type-hints.
https://www.python.org/dev/peps/pep-0561/