Skip to content

fix(templates): Update SQL tap and target templates to use Mapping instead of dict to annotate the read-only config object#3653

Merged
edgarrmondragon merged 1 commit into
mainfrom
fix/templates/sql-templates-mapping-config
May 27, 2026
Merged

fix(templates): Update SQL tap and target templates to use Mapping instead of dict to annotate the read-only config object#3653
edgarrmondragon merged 1 commit into
mainfrom
fix/templates/sql-templates-mapping-config

Conversation

@edgarrmondragon
Copy link
Copy Markdown
Collaborator

@edgarrmondragon edgarrmondragon commented May 27, 2026

SSIA

Summary by Sourcery

Enhancements:

  • Relax type annotations in SQL tap and target templates to use Mapping for configuration objects, aligning with their read-only usage.

@edgarrmondragon edgarrmondragon self-assigned this May 27, 2026
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 27, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates tap and target SQL cookiecutter templates so that the read-only configuration argument to get_sqlalchemy_url is typed as Mapping instead of dict, and imports Mapping in TYPE_CHECKING blocks accordingly.

File-Level Changes

Change Details Files
Broaden the type annotation for the SQL connector config parameter from dict to Mapping in tap template.
  • Extend TYPE_CHECKING imports to include Mapping from collections.abc.
  • Change get_sqlalchemy_url method signature to accept config: Mapping instead of config: dict in the tap SQL client template.
cookiecutter/tap-template/{{cookiecutter.tap_id}}/{{cookiecutter.library_name}}/sql-client.py
Broaden the type annotation for the SQL connector config parameter from dict to Mapping in target template.
  • Extend TYPE_CHECKING imports to include Mapping from collections.abc.
  • Change get_sqlalchemy_url method signature to accept config: Mapping instead of config: dict in the target SQL sinks template.
cookiecutter/target-template/{{cookiecutter.target_id}}/{{cookiecutter.library_name}}/sinks_sql.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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>
@edgarrmondragon edgarrmondragon force-pushed the fix/templates/sql-templates-mapping-config branch from a3cf3c9 to 6ddf056 Compare May 27, 2026 22:02
@edgarrmondragon edgarrmondragon added this pull request to the merge queue May 27, 2026
Merged via the queue into main with commit 002c288 May 27, 2026
13 checks passed
@edgarrmondragon edgarrmondragon deleted the fix/templates/sql-templates-mapping-config branch May 27, 2026 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant