Skip to content

refactor: Issue deprecation warnings for IO-functions#368

Open
Oliver Borchert (borchero) wants to merge 2 commits into
mainfrom
io-deprection
Open

refactor: Issue deprecation warnings for IO-functions#368
Oliver Borchert (borchero) wants to merge 2 commits into
mainfrom
io-deprection

Conversation

@borchero

Copy link
Copy Markdown
Member

Motivation

Contributes to #367.

Copilot AI 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.

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 a deprecated decorator abstraction to consistently emit DeprecationWarnings 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.

Comment thread dataframely/schema.py Outdated
Comment thread dataframely/collection/collection.py Outdated
Comment thread tests/test_deprecation.py
@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (fd0386b) to head (5a4f19d).

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants