Correct typing of create_client(host, username) #482
Merged
Conversation
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
The parameters `host` and `username` of `create_client` actually do accept None values, as demonstrated by their default values being `None` and the docstring explaining default behavior when not-set. Correcting these types (by marking as Optional) allows users using `dsn` or default behavior to not see type-checking errors.
genzgd
approved these changes
Mar 21, 2025
|
Thanks for the cleanup |
jovezhong
pushed a commit
to timeplus-io/timeplus-connect
that referenced
this pull request
Apr 25, 2025
The parameters `host` and `username` of `create_client` actually do accept None values, as demonstrated by their default values being `None` and the docstring explaining default behavior when not-set. Correcting these types (by marking as Optional) allows users using `dsn` or default behavior to not see type-checking errors.
jovezhong
added a commit
to timeplus-io/timeplus-connect
that referenced
this pull request
Apr 28, 2025
* Gg/update test jwt (ClickHouse#458) * update test jwt, ensure query params are final * tweak test job * Assume CI "secret" is full JWT * Fix lint * Fix memory leak in AsyncClient (ClickHouse#457) * Fix memory leak in AsyncClient * Graceful shutdown * fix test * fix tests * fix tests * Fix lint (ClickHouse#459) * Exclude 3.8 Aarch64 builds (ClickHouse#460) * Fix lint * Exclude pypy 38 build * Exclude all Python 3.8 builds * Update changelog re Python 3.8 aarch64 wheels * Gg/update test matrix (ClickHouse#464) * Update some tests * Fix lint * Skip JSON buggy test * Fix CI tests with default user (ClickHouse#465) * Replace removal of ; in the loop line with rstrip (ClickHouse#472) * Docker test fixes (ClickHouse#473) * Don't prevent settings that don't change the value * Add docker related config file * Fix typo * Update README.md doc link (ClickHouse#476) * Gg/update test jwt (ClickHouse#458) * update test jwt, ensure query params are final * tweak test job * Assume CI "secret" is full JWT * Fix lint * Fix memory leak in AsyncClient (ClickHouse#457) * Fix memory leak in AsyncClient * Graceful shutdown * fix test * fix tests * fix tests * Fix lint (ClickHouse#459) * Correct typing of create_client(host, username) (ClickHouse#482) The parameters `host` and `username` of `create_client` actually do accept None values, as demonstrated by their default values being `None` and the docstring explaining default behavior when not-set. Correcting these types (by marking as Optional) allows users using `dsn` or default behavior to not see type-checking errors. * Release 0 8 16 (ClickHouse#485) * Check for optional libraries in client methods * Log unexpected http next chunk unexpected * Log unexpected http next chunk unexpected * Updates for 0.8.16 release * Exclude 3.8 Aarch64 builds (ClickHouse#460) * Fix lint * Exclude pypy 38 build * Exclude all Python 3.8 builds * Update changelog re Python 3.8 aarch64 wheels * Gg/update test matrix (ClickHouse#464) * Update some tests * Fix lint * Skip JSON buggy test * Updates for 0.8.17 release (ClickHouse#488) * Updates for 0.8.17 release * Update test matrix * Try to punt on SSL issues * Update TLS test certificates * Fix CI tests with default user (ClickHouse#465) * Add param extra_http_headers to query/command methods (ClickHouse#489) * Add param extra_http_headers to query/command methods * add test, fix dict copy --------- Co-authored-by: Geoff Genz <[email protected]> * Change http_headers to transport settings, add transport settings to async client and insert methods (ClickHouse#490) * wrap sql with text() (ClickHouse#491) * Replace removal of ; in the loop line with rstrip (ClickHouse#472) * Docker test fixes (ClickHouse#473) * Don't prevent settings that don't change the value * Add docker related config file * Fix typo * Update test_dynamic.py for variant and json data types * Update httpclient.py update comments * Update dialect.py * Update client.py * Update test_jwt_auth.py * bring back dbapi, otherwise test fails * diable test_transport_settings in test_client.py * fix the JSON->json data type name issue --------- Co-authored-by: Geoff Genz <[email protected]> Co-authored-by: pufit <[email protected]> Co-authored-by: Sviatoslav Bobryshev <[email protected]> Co-authored-by: Avery Fischer (biggerfisch) <[email protected]> Co-authored-by: Paweł Szczur <[email protected]> Co-authored-by: lakako <[email protected]>
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
The parameters
hostandusernameofcreate_clientactually do accept None values, as demonstrated by their default values beingNoneand the docstring explaining default behavior when not-set.Correcting these types (by marking as Optional) allows users using
dsnor default behavior to not see type-checking errors.Checklist
Delete items not relevant to your PR: