Skip to content

feat: add deprecation warnings for .blob accessor and read_gbq_object_table - #2408

Merged
shuoweil merged 3 commits into
mainfrom
shuowei-deprecate-warning-blob
Jan 27, 2026
Merged

feat: add deprecation warnings for .blob accessor and read_gbq_object_table#2408
shuoweil merged 3 commits into
mainfrom
shuowei-deprecate-warning-blob

Conversation

@shuoweil

@shuoweilshuoweil commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

This PR introduces ApiDeprecationWarning (which inherits from FutureWarning) to the following APIs to notify users of their
upcoming removal in a future release:

  • Series.blob accessor: Added a warning to the property getter in bigframes/series.py.
  • read_gbq_object_table: Added a warning to the implementation in bigframes/session/Session. This will also trigger when called via bigframes.pandas.read_gbq_object_table.

Fixes #<478952368> 🦕

@shuoweilshuoweil self-assigned this Jan 26, 2026
@shuoweil
shuoweil requested review from a teamJanuary 26, 2026 23:56
@product-auto-labelproduct-auto-labelBot added size: s Pull request size is small. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Jan 26, 2026
@shuoweilshuoweil added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 27, 2026
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 27, 2026
Comment threadbigframes/session/__init__.py Outdated
Result BigFrames DataFrame.
"""
warnings.warn(
"read_gbq_object_table is deprecated and will be removed in a future release.",

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.

use read_gbq with "ref" column instead.

b/478950476

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done. Updated the warning message to suggest using read_gbq with the 'ref' column.

Comment threadbigframes/series.py Outdated
Accessor for Blob operations.
"""
warnings.warn(
"The blob accessor is deprecated and will be removed in a future release.",

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.

Use bigframes.bigquery.obj functions instead.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Done. Updated the warning message to point to bigframes.bigquery.obj functions.

@shuoweil
shuoweil enabled auto-merge (squash) January 27, 2026 22:54
@shuoweil
shuoweil merged commit 7261a4e into mainJan 27, 2026
20 of 26 checks passed
@shuoweil
shuoweil deleted the shuowei-deprecate-warning-blob branch January 27, 2026 23:27
shuoweil added a commit that referenced this pull request Feb 3, 2026
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.
Librarian Version: v0.7.0
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:e7cc6823efb073a8a26e7cefdd869f12ec228abfbd2a44aa9a7eacc284023677
<details><summary>bigframes: 2.34.0</summary>
##
[2.34.0](v2.33.0...v2.34.0)
(2026-02-02)
### Features
* add `bigframes.pandas.options.experiments.sql_compiler` for switching
the backend compiler (#2417)
([7eba6ee](7eba6ee))
* add bigquery.ml.generate_embedding function (#2422)
([35f3f5e](35f3f5e))
* add bigquery.create_external_table method (#2415)
([76db295](76db295))
* add deprecation warnings for .blob accessor and read_gbq_object_table
(#2408)
([7261a4e](7261a4e))
* add bigquery.ml.generate_text function (#2403)
([5ac6810](5ac6810))
### Bug Fixes
* broken job url (#2411)
([fcb5bc1](fcb5bc1))
shuoweil added a commit that referenced this pull request Feb 4, 2026
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.
Librarian Version: v0.7.0
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:e7cc6823efb073a8a26e7cefdd869f12ec228abfbd2a44aa9a7eacc284023677
<details><summary>bigframes: 2.34.0</summary>
##
[2.34.0](v2.33.0...v2.34.0)
(2026-02-02)
### Features
* add `bigframes.pandas.options.experiments.sql_compiler` for switching
the backend compiler (#2417)
([7eba6ee](7eba6ee))
* add bigquery.ml.generate_embedding function (#2422)
([35f3f5e](35f3f5e))
* add bigquery.create_external_table method (#2415)
([76db295](76db295))
* add deprecation warnings for .blob accessor and read_gbq_object_table
(#2408)
([7261a4e](7261a4e))
* add bigquery.ml.generate_text function (#2403)
([5ac6810](5ac6810))
### Bug Fixes
* broken job url (#2411)
([fcb5bc1](fcb5bc1))
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigqueryIssues related to the googleapis/python-bigquery-dataframes API.size: sPull request size is small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@shuoweil@GarrettWu@yoshi-kokoro