Skip to content

refactor: Specify version when singer_sdk.typing.to_jsonschema_type and singer_sdk.typing.to_sql_type will be removed - #3784

Merged
edgarrmondragon merged 1 commit into
mainfrom
fix/deprecate-to-sql-type
Sep 15, 2026
Merged

edgarrmondragon merged 1 commit into
mainfrom
fix/deprecate-to-sql-type

Conversation

@edgarrmondragon

@edgarrmondragon edgarrmondragon commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

SSIA

Summary by Sourcery

Specify the v0.56 removal timeline for the legacy SQL/JSON Schema conversion helpers and update their deprecation handling.

Enhancements:

  • Set a specific v0.56 removal timeline for the legacy SQL/JSON Schema conversion helpers and promote their replacements as the supported API.

Documentation:

  • Move the legacy SQL/JSON Schema mapping helpers into the versioned deprecation documentation.

Tests:

  • Update typing tests to expect standard deprecation warnings for the legacy conversion helpers.

… and `singer_sdk.typing.to_sql_type` will be removed

Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>
@edgarrmondragon
edgarrmondragon requested review from a team as code owners September 15, 2026 20:25
@edgarrmondragon edgarrmondragon added this to the v0.55 milestone Sep 15, 2026
@edgarrmondragon edgarrmondragon self-assigned this Sep 15, 2026
@sourcery-ai

sourcery-ai Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The PR clarifies that to_jsonschema_type and to_sql_type will be removed in v0.56, emits standard deprecation warnings with explicit removal messaging, and updates coverage to validate the new warning behavior without changing conversion results.

File-Level Changes

Change Details Files
Moves the legacy SQL/JSON Schema conversion helpers into the concrete v0.56 deprecation window and upgrades their warning category.
  • Documents removal in the v0.56 section and retains migration guidance to the replacement mapper classes.
  • Changes both helper decorators from pending-deprecation to standard deprecation warnings.
  • Updates tests to assert the new warning category while preserving conversion behavior checks.
docs/deprecation.md
singer_sdk/typing.py
tests/sql/test_typing.py

Possibly linked issues

  • #unknown: PR moves these functions into documented deprecations and specifies removal in v0.56, directly addressing the issue.

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.47%. Comparing base (1dc29ba) to head (abc1aeb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3784   +/-   ##
=======================================
  Coverage   94.47%   94.47%           
=======================================
  Files          74       74           
  Lines        6298     6298           
  Branches      771      771           
=======================================
  Hits         5950     5950           
  Misses        260      260           
  Partials       88       88           
Flag Coverage Δ
core 83.08% <100.00%> (ø)
end-to-end 76.21% <100.00%> (ø)
optional-components 44.98% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed

codspeed Bot commented Sep 15, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 14 untouched benchmarks


Comparing fix/deprecate-to-sql-type (abc1aeb) with main (f999691)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (1dc29ba) during the generation of this report, so f999691 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 Meltano SDK | 🛠️ Build #34578187 | 📁 Comparing abc1aeb against latest (1dc29ba)

  🔍 Preview build  

1 file changed
± deprecation.html

@edgarrmondragon
edgarrmondragon added this pull request to the merge queue Sep 15, 2026
Merged via the queue into main with commit ccfcf37 Sep 15, 2026
40 checks passed
@edgarrmondragon
edgarrmondragon deleted the fix/deprecate-to-sql-type branch September 15, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant