snowflakedb / snowflakedb/snowflake-connector-python
SNOW-2043406: Type Annotations for `snowflake.connector.connect`
@sfc-gh-dszmolka is already working on this.
Since Apr 16, 2025.
- Dominant language
- Python
- Stars
- 730
- Forks
- 574
- Avg merge
- 5h 45m
- Merged PRs (30d)
- 16
Description
What is the current behavior?
snowflake.connect lacks any type annotations, despite usage of **kwargs it's possible to share annotations between SnowflakeConnection and snowflake.connect through usage of Unpack.
What is the desired behavior?
That snowflake.connect is properly annotated making type-checkers such as MyPy and Pyright raise type-checking warnings when incorrect arguments are parsed in.
How would this improve snowflake-connector-python?
Users relying on type-checkers or Pylance would get linting errors for invalid arguments without having to execute code. Additionally, by having py.typed the package indicates it's properly typed however in this case proper annotations are missing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.