feat: Add BigFrames.bigquery.st_regionstats method by tswast · Pull Request #2200 · googleapis/python-bigquery-dataframes

tswast · 2025-10-27T21:13:10Z

This commit adds the BigFrames.bigquery.st_regionstats method, which allows users to compute statistics for a raster band within a given geography.

The implementation includes:

A new StRegionStatsOp in bigframes/operations/geo_ops.py.
Compiler implementations for both the SQLGlot and Ibis backends.
A unit test with a SQL snapshot.
A code sample in samples/snippets/wildfire_risk.py that demonstrates the use of the new function.

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

This commit adds the `BigFrames.bigquery.st_regionstats` method, which allows users to compute statistics for a raster band within a given geography. The implementation includes: - A new `StRegionStatsOp` in `bigframes/operations/geo_ops.py`. - Compiler implementations for both the SQLGlot and Ibis backends. - A unit test with a SQL snapshot. - A code sample in `samples/snippets/wildfire_risk.py` that demonstrates the use of the new function.

tswast · 2025-10-27T21:14:20Z

bigframes/bigquery/_operations/geo.py

+    raster: bigframes.series.Series,
+    band: str,
+    *,
+    options: Mapping[str, Union[str, int, float]] = {},


Missing "include".

Also, "options" might not work if it is keyword-only.

Also, don't use mutable values as the default.

bigframes/core/compile/ibis_compiler/scalar_op_compiler.py

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast · 2025-10-27T21:15:46Z

bigframes/core/compile/ibis_compiler/scalar_op_compiler.py

+    if op.options:
+        args.append(bigframes_vendored.ibis.literal(op.options, type="json"))
+    return bigframes_vendored.ibis.remote_function(
+        "st_regionstats", args, output_type="struct<min: float, max: float, sum: float, count: int, mean: float>"  # type: ignore


Per https://cloud.google.com/bigquery/docs/reference/standard-sql/geography_functions#st_regionstats it should also include area.

tswast · 2025-10-27T21:16:33Z

samples/snippets/wildfire_risk.py

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import bigframes.bigquery as bbq


Should put this inside a test file so we actually run it.

tswast · 2025-10-27T21:17:33Z

samples/snippets/wildfire_risk.py

Inspired by the SQL at https://cloud.google.com/blog/products/data-analytics/a-closer-look-at-earth-engine-in-bigquery

tswast · 2025-10-27T21:18:10Z

tests/unit/core/compile/sqlglot/test_geo_compiler.py

+pytest.importorskip("pytest_snapshot")
+
+
+class TestGeoCompiler:


Should use pytest style not unittest style.

This commit adds the `BigFrames.bigquery.st_regionstats` method, which allows users to compute statistics for a raster band within a given geography. The implementation includes: - A new `StRegionStatsOp` in `bigframes/operations/geo_ops.py`. - Compiler implementations for both the SQLGlot and Ibis backends. - A unit test with a SQL snapshot. - A system test that demonstrates the use of the new function. This commit also addresses feedback from the code review, including: - Adding `area` to the output struct of `st_regionstats`. - Making the `options` parameter a positional argument. - Adding comments to explain the use of `pass_op`. - Converting the unit test to a pytest-style function. - Moving the sample code to a system test.

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…ython-bigquery-dataframes into feat-st-regionstats

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…ython-bigquery-dataframes into feat-st-regionstats

This commit introduces the `st_regionstats` method in `bigframes.bigquery`, allowing users to compute statistics for a raster band within a given geography. Key changes: - Added `StRegionStatsOp` in `bigframes/operations/geo_ops.py`. - Implemented compilation logic for the operation in both Ibis and SQLGlot compilers. - Exposed the `st_regionstats` function in `bigframes/bigquery/_operations/geo.py` and the public API. - Added a new `_apply_ternary_op` method to `bigframes.series.Series`. - Included a unit test with a snapshot to verify the generated SQL. - Added a system test that demonstrates the functionality by converting a complex wildfire risk analysis query from SQL to BigFrames. - Refactored compiler registries to support `pass_op=True` for ternary operations, enabling access to operator parameters during compilation.

review-notebook-app · 2025-10-28T14:50:05Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…ython-bigquery-dataframes into feat-st-regionstats

tswast · 2025-10-28T14:58:21Z

bigframes/bigquery/_operations/ai.py

Bad merge. Revert these changes.

tswast · 2025-10-28T14:59:51Z

bigframes/display/anywidget.py

Needs to be reverted too.

This commit introduces the `st_regionstats` method in `bigframes.bigquery`, allowing users to compute statistics for a raster band within a given geography. Key changes: - Added `StRegionStatsOp` in `bigframes/operations/geo_ops.py`. - Implemented compilation logic for the operation in both Ibis and SQLGlot compilers. - Exposed the `st_regionstats` function in `bigframes/bigquery/_operations/geo.py` and the public API. - Added a new `_apply_ternary_op` method to `bigframes.series.Series`. - Included a unit test with a snapshot to verify the generated SQL. - Added a system test that demonstrates the functionality by converting a complex wildfire risk analysis query from SQL to BigFrames. - Refactored compiler registries to support `pass_op=True` for ternary operations, enabling access to operator parameters during compilation.

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

snippet-bot · 2025-10-29T20:55:42Z

Here is the summary of changes.

You are about to add 1 region tag.

samples/snippets/st_regionstats_test.py:19, tag bigquery_dataframes_st_regionstats

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast · 2025-10-30T14:28:49Z

samples/snippets/st_regionstats_test.py

+    # TODO: Add st_simplify when it is available in BigFrames.
+    # https://github.com/googleapis/python-bigquery-dataframes/issues/1497
+    # countries["simplified_geometry"] = bq.st_simplify(countries["geometry"], 10000)


I'd like to add st_simplify first so that this sample can work without any todos for us.

tswast · 2025-10-30T14:29:03Z

samples/snippets/st_regionstats_test.py

+    # [START bigquery_dataframes_st_regionstats]
+    from typing import cast
+
+    import bigframes.bigquery as bq


Let's use bbq instead of bq.

tswast · 2025-11-04T18:13:01Z

Closing in favor of #2228

tswast requested review from a team as code owners October 27, 2025 21:13

tswast requested review from glasnt and jialuoo October 27, 2025 21:13

product-auto-label bot added the size: l Pull request size is large. label Oct 27, 2025

blunderbuss-gcf bot assigned jialuoo Oct 27, 2025

product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. label Oct 27, 2025

tswast commented Oct 27, 2025

View reviewed changes

bigframes/core/compile/ibis_compiler/scalar_op_compiler.py Show resolved Hide resolved

🦉 Updates from OwlBot post-processor

ab46078

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast commented Oct 27, 2025

View reviewed changes

google-labs-jules bot and others added 7 commits October 27, 2025 21:54

Merge branch 'main' into feat-st-regionstats

8b681c0

🦉 Updates from OwlBot post-processor

21243e4

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge branch 'feat-st-regionstats' of https://github.com/googleapis/p…

459c5b2

…ython-bigquery-dataframes into feat-st-regionstats

🦉 Updates from OwlBot post-processor

350d241

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge branch 'feat-st-regionstats' of https://github.com/googleapis/p…

b4db49c

…ython-bigquery-dataframes into feat-st-regionstats

product-auto-label bot added size: xl Pull request size is extra large. and removed size: l Pull request size is large. labels Oct 28, 2025

tswast and others added 4 commits October 28, 2025 09:50

Merge branch 'main' into feat-st-regionstats

9775fb6

🦉 Updates from OwlBot post-processor

bcd4047

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

🦉 Updates from OwlBot post-processor

01edd21

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge branch 'feat-st-regionstats' of https://github.com/googleapis/p…

bf00055

…ython-bigquery-dataframes into feat-st-regionstats

tswast commented Oct 28, 2025

View reviewed changes

bigframes/bigquery/_operations/ai.py

Copy link

Collaborator Author

tswast Oct 28, 2025

Choose a reason for hiding this comment

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

Bad merge. Revert these changes.

tswast commented Oct 28, 2025

View reviewed changes

bigframes/display/anywidget.py

Copy link

Collaborator Author

tswast Oct 28, 2025

Choose a reason for hiding this comment

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

Needs to be reverted too.

product-auto-label bot added size: l Pull request size is large. and removed size: xl Pull request size is extra large. labels Oct 28, 2025

gcf-owl-bot bot and others added 9 commits October 28, 2025 15:32

🦉 Updates from OwlBot post-processor

13a67bd

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge remote-tracking branch 'origin/main' into feat-st-regionstats

6a4b1c9

add arguments to st_regionstats and make it into a unary op

745211e

move to geo_ops

4252e90

fix the sqlgot compiler

b44d520

fix sqlgot compiler

18a6c76

attempt at ibis compiler

1b007b9

use JSON literals for options parameter

2483e80

fix sample

c8eb266

tswast and others added 3 commits October 29, 2025 20:56

Merge remote-tracking branch 'origin/main' into feat-st-regionstats

6d436ff

Merge branch 'main' into feat-st-regionstats

ad021b7

🦉 Updates from OwlBot post-processor

7a57ddd

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast commented Oct 30, 2025

View reviewed changes

tswast mentioned this pull request Oct 30, 2025

feat: add bigframes.bigquery.st_simplify #2210

Merged

tswast closed this Nov 4, 2025

		pytest.importorskip("pytest_snapshot")


		class TestGeoCompiler:

Conversation

tswast commented Oct 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

review-notebook-app bot commented Oct 28, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snippet-bot bot commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tswast commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

snippet-bot bot commented Oct 29, 2025 •

edited

Loading