Fix apply_configs decorator causing function signature to be lost #1858
Conversation
This file contains 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
LeonLuttenberger
requested review from
malachi-constant,
jaidisido,
cnfait and
kukushking
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
malachi-constant
approved these changes
Dec 13, 2022
jaidisido
reviewed
Dec 13, 2022
| @@ -643,7 +649,7 @@ def describe_table( | |||
| @apply_configs | |||
| def create_ctas_table( # pylint: disable=too-many-locals | |||
| sql: str, | |||
| database: str, | |||
| database: Optional[str] = None, | |||
There was a problem hiding this comment.
Nitpick - could you fix it in the docs below too?
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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.
Feature or Bugfix
Detail
The definition for
apply_configsso far has beenCallable[..., Any] -> Callable[..., Any]. This means that IntelliSense as well as MyPy were not able to do check the types whenever a function decorated withapply_configswas called. Functions such aswr.s3.to_parquetwere therefore treated as having a signature ofCallable[..., Any] -> Callable[..., Any].By changing the definition of
apply_configsto make use of generic types, MyPy was able to find errors related to inconsistent type usages (e.g.Optional[str]being passed asstr). As such, I've had to fix all these type errors as part of this PR.Furthermore, since making this change, the auto-complete in Visual Studio Code is now able to pick up types for functions such as
wr.s3.to_parquetagain.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.