feat: warn when the BigFrames version is more than a year old (#1455)

sycai · gcf-owl-bot[bot] · web-flow · commit 651d7c8ce2cc · 2025-03-12T15:38:00.000-05:00
* feat: warn when the version is beyond support period * move release date check to session init * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/bigframes/bigframes/exceptions.py b/packages/bigframes/bigframes/exceptions.py
@@ -91,6 +91,10 @@ class BadIndexerKeyWarning(Warning):
     """The indexer key is not used correctly."""
 
 
+class ObsoleteVersionWarning(Warning):
+    """The BigFrames version is too old."""
+
+
 class ColorFormatter:
     WARNING = "\033[93m"
     ENDC = "\033[0m"
diff --git a/packages/bigframes/bigframes/session/__init__.py b/packages/bigframes/bigframes/session/__init__.py
@@ -16,6 +16,7 @@
 
 from __future__ import annotations
 
+import datetime
 import logging
 import os
 import secrets
@@ -54,6 +55,8 @@
 )
 import pyarrow as pa
 
+from bigframes import exceptions as bfe
+from bigframes import version
 import bigframes._config.bigquery_options as bigquery_options
 import bigframes.clients
 import bigframes.core.blocks as blocks
@@ -65,8 +68,6 @@
 # to register new and replacement ops with the Ibis BigQuery backend.
 import bigframes.dataframe
 import bigframes.dtypes
-import bigframes.exceptions
-import bigframes.exceptions as bfe
 import bigframes.functions._function_session as bff_session
 import bigframes.functions.function as bff
 import bigframes.session._io.bigquery as bf_io_bigquery
@@ -77,7 +78,6 @@
 import bigframes.session.planner
 import bigframes.session.temp_storage
 import bigframes.session.validation
-import bigframes.version
 
 # Avoid circular imports.
 if typing.TYPE_CHECKING:
@@ -147,6 +147,8 @@ def __init__(
         context: Optional[bigquery_options.BigQueryOptions] = None,
         clients_provider: Optional[bigframes.session.clients.ClientsProvider] = None,
     ):
+        _warn_if_bf_version_is_obsolete()
+
         if context is None:
             context = bigquery_options.BigQueryOptions()
 
@@ -1813,3 +1815,11 @@ def read_gbq_object_table(
 
 def connect(context: Optional[bigquery_options.BigQueryOptions] = None) -> Session:
     return Session(context)
+
+
+def _warn_if_bf_version_is_obsolete():
+    today = datetime.datetime.today()
+    release_date = datetime.datetime.strptime(version.__release_date__, "%Y-%m-%d")
+    if today - release_date > datetime.timedelta(days=365):
+        msg = f"Your BigFrames version {version.__version__} is more than 1 year old. Please update to the lastest version."
+        warnings.warn(msg, bfe.ObsoleteVersionWarning)
diff --git a/packages/bigframes/tests/unit/session/test_session.py b/packages/bigframes/tests/unit/session/test_session.py
@@ -25,10 +25,10 @@
 import pytest
 
 import bigframes
+from bigframes import version
 import bigframes.enums
 import bigframes.exceptions
-
-from .. import resources
+from tests.unit import resources
 
 TABLE_REFERENCE = {
     "projectId": "my-project",
@@ -443,3 +443,18 @@ def test_session_init_fails_with_no_project():
                 credentials=mock.Mock(spec=google.auth.credentials.Credentials)
             )
         )
+
+
+def test_session_init_warns_if_bf_version_is_too_old(monkeypatch):
+    release_date = datetime.datetime.strptime(version.__release_date__, "%Y-%m-%d")
+    current_date = release_date + datetime.timedelta(days=366)
+
+    class FakeDatetime(datetime.datetime):
+        @classmethod
+        def today(cls):
+            return current_date
+
+    monkeypatch.setattr(datetime, "datetime", FakeDatetime)
+
+    with pytest.warns(bigframes.exceptions.ObsoleteVersionWarning):
+        resources.create_bigquery_session()
