refactor: Issue deprecation warnings for IO-functions#368
Open
Oliver Borchert (borchero) wants to merge 2 commits into
Open
refactor: Issue deprecation warnings for IO-functions#368Oliver Borchert (borchero) wants to merge 2 commits into
Oliver Borchert (borchero) wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements the deprecation-warning layer needed for the planned I/O API reduction (Issue #367), by introducing a centralized warning helper/decorator and wiring it into Schema/Collection I/O entry points, plus adding documentation and tests to codify the new behavior.
Changes:
- Add
issue_deprecation_warning()and adeprecateddecorator abstraction to consistently emitDeprecationWarnings that point at user call sites. - Mark Schema I/O methods and Collection Delta I/O methods as deprecated, and emit a deprecation warning when reading parquet collections with
validation != "skip". - Add dedicated deprecation tests and adjust pytest warning filters so existing tests aren’t broken by the new warnings.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
dataframely/_deprecation.py |
Introduces issue_deprecation_warning and a cross-version deprecated decorator implementation. |
dataframely/schema.py |
Applies deprecation decorators (and docstring notes) to Schema parquet/delta I/O methods. |
dataframely/collection/collection.py |
Emits deprecation warnings for implicit validation on parquet reads/scans; deprecates delta I/O methods. |
tests/test_deprecation.py |
Adds/updates tests to assert the new deprecation warnings and stacklevel behavior. |
pyproject.toml |
Adds warning filters to ignore the new I/O deprecations outside dedicated warning-assertion tests. |
docs/guides/migration/index.md |
Updates migration guidance from FutureWarnings to DeprecationWarnings. |
docs/guides/features/serialization.md |
Adds a prominent warning block documenting the I/O deprecations and migration guidance. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #368 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 56 56
Lines 3489 3506 +17
=========================================
+ Hits 3489 3506 +17 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Motivation
Contributes to #367.