fix(templates): Update SQL tap and target templates to use Mapping instead of dict to annotate the read-only config object#3653
Merged
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates tap and target SQL cookiecutter templates so that the read-only configuration argument to File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Because
Mappingis only imported underTYPE_CHECKING, using it directly in the runtime type annotation forconfigwill raise aNameErrorunlessfrom __future__ import annotationsis enabled in these templates; either add that future import or importMappingunconditionally. - If the config structure is known, consider typing the argument as
Mapping[str, Any](or a more specific key/value type) instead of a bareMappingto make the interface clearer to downstream users.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Because `Mapping` is only imported under `TYPE_CHECKING`, using it directly in the runtime type annotation for `config` will raise a `NameError` unless `from __future__ import annotations` is enabled in these templates; either add that future import or import `Mapping` unconditionally.
- If the config structure is known, consider typing the argument as `Mapping[str, Any]` (or a more specific key/value type) instead of a bare `Mapping` to make the interface clearer to downstream users.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
…instead of `dict` to annotate the read-only config object Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>
a3cf3c9 to
6ddf056
Compare
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.
SSIA
Summary by Sourcery
Enhancements: