Add type annotations to snowflake.connector.connect#2366
Open
coder-aditi wants to merge 3 commits intosnowflakedb:mainfrom
Open
Add type annotations to snowflake.connector.connect#2366coder-aditi wants to merge 3 commits intosnowflakedb:mainfrom
coder-aditi wants to merge 3 commits intosnowflakedb:mainfrom
Conversation
|
I have read the CLA Document and I hereby sign the CLA 1 out of 2 committers have signed the CLA. |
Author
|
I have read the CLA Document and I hereby sign the CLA |
Author
|
recheck |
c0e9521 to
0a6df41
Compare
Author
|
Hi @sfc-gh-mmishchenko , @sfc-gh-mkubik please let me know if any modifications required. Thank you. |
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.
Please answer these questions before submitting your pull requests. Thanks!
What GitHub issue is this PR addressing? Make sure that there is an accompanying issue to your PR.
Fixes SNOW-2043406: Type Annotations for
snowflake.connector.connect#2270Fill out the following pre-review checklist:
Please describe how your code solves the related issue.
The "snowflake.connector.connect" function did not have type annotations, even though the "SnowflakeConnection" constructor it wraps does. This made it hard for tools like MyPy or Pyright to check arguments during development.
This PR uses ParamSpec and Unpack from the typing module to match the constructor's signature in the connect function. It now allows static type checking of arguments, giving developers immediate feedback if they use incorrect parameters.
A test was added to ensure that type checkers properly identify invalid types.
N/A