Improve typing when using 'get' on an API response#1283
Merged
seratch merged 1 commit intoslackapi:mainfrom Oct 27, 2022
eddyg:improve-type-handling-for-response-get
Merged
Improve typing when using 'get' on an API response#1283seratch merged 1 commit intoslackapi:mainfrom eddyg:improve-type-handling-for-response-get
seratch merged 1 commit intoslackapi:mainfrom
eddyg:improve-type-handling-for-response-get
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1283 +/- ##
=======================================
Coverage 85.62% 85.62%
=======================================
Files 84 84
Lines 7827 7827
=======================================
Hits 6702 6702
Misses 1125 1125 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
seratch
reviewed
Oct 25, 2022
seratch
reviewed
Oct 25, 2022
Contributor
|
@eddyg Thanks for improving this! |
Contributor
Author
|
@seratch Thank you for your time in reviewing my changes and pushing me to investigate an even better solution than I came up with originally. |
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
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.
Summary
This is a
simplesomewhat complicated change that improves type handling when calling.get()on API responses.For example, this line:
currently generates this warning in Pyright:
This
simpletyping change alleviates this issue.This is the first use of
TypeVarin slack_sdk that I see... are there compatibility issues with older Python versions, perhaps? Opening this PR so this fix can at least be considered.Category (place an
xin each of the[ ])/docs-src(Documents, have you run./scripts/docs.sh?)/docs-src-v2(Documents, have you run./scripts/docs-v2.sh?)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements (place an
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.