{{ message }}
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new docstrings use an invalid Sphinx .. deprecated:: directive form (missing required version) and the new warning behavior lacks accompanying tests to prevent regressions.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR deprecates the legacy Table client scan query APIs by emitting DeprecationWarning at runtime and documenting the deprecation, steering users toward QueryService (QuerySessionPool) while keeping existing functionality intact.
Changes:
- Added
DeprecationWarningemission forTableClient.scan_query,TableClient.async_scan_query, andydb.aio.TableClient.scan_query. - Introduced a shared deprecation message constant used across sync/async implementations.
- Added a top-of-file
CHANGELOG.mdentry describing the deprecation.
File summaries
Review details
Suppressed comments (2)
ydb/table.py:1225
- Same issue here:
.. deprecated::without a version argument is invalid in Sphinx and may break autodoc builds. Prefer a plain-text deprecation note (or add an explicit version).
"""
.. deprecated::
Use QueryService (:class:`ydb.QuerySessionPool`) instead.
"""
ydb/table.py:1291
- Same Sphinx directive issue:
.. deprecated::without a version argument is invalid and can fail doc generation. Replace with plain text or include a version.
"""
.. deprecated::
Use QueryService (:class:`ydb.QuerySessionPool`) instead.
"""
- Files reviewed: 3/3 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
TableClient.scan_query,TableClient.async_scan_queryand the asyncscan_querynow raiseDeprecationWarningand point to QueryService (ydb.QuerySessionPool).No behaviour change beyond the warning — the methods still work.