chore: Add an ExperimentOptions class to control experiments (#1039)

Author: sycai

bigframes/_config/__init__.py

@@ -29,6 +29,7 @@
 import bigframes._config.bigquery_options as bigquery_options
 import bigframes._config.compute_options as compute_options
 import bigframes._config.display_options as display_options
+import bigframes._config.experiment_options as experiment_options
 import bigframes._config.sampling_options as sampling_options
 
 
@@ -46,6 +47,9 @@ class ThreadLocalConfig(threading.local):
     compute_options: compute_options.ComputeOptions = field(
         default_factory=compute_options.ComputeOptions
     )
+    experiment_options: experiment_options.ExperimentOptions = field(
+        default_factory=experiment_options.ExperimentOptions
+    )
 
 
 class Options:
@@ -122,6 +126,16 @@ def compute(self) -> compute_options.ComputeOptions:
         """
         return self._local.compute_options
 
+    @property
+    def experiments(self) -> experiment_options.ExperimentOptions:
+        """Options controlling experiments
+
+        Returns:
+            bigframes._config.experiment_options.ExperimentOptions:
+               Thread-local options for controlling experiments
+        """
+        return self._local.experiment_options
+
     @property
     def is_bigquery_thread_local(self) -> bool:
         """Indicator that we're using a thread-local session.

bigframes/_config/experiment_options.py

@@ -0,0 +1,36 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import warnings
+
+
+class ExperimentOptions:
+    """
+    Encapsulates the configration for experiments
+    """
+
+    def __init__(self):
+        self._semantic_operators = False
+
+    @property
+    def semantic_operators(self) -> bool:
+        return self._semantic_operators
+
+    @semantic_operators.setter
+    def semantic_operators(self, value: bool):
+        if value is True:
+            warnings.warn(
+                "Semantic operators are still under experiments, and are subject to change in the future."
+            )
+        self._semantic_operators = value

tests/unit/_config/test_experiment_options.py

@@ -0,0 +1,32 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pytest
+
+import bigframes._config.experiment_options as experiment_options
+
+
+def test_semantic_operators_default_false():
+    options = experiment_options.ExperimentOptions()
+
+    assert options.semantic_operators is False
+
+
+def test_semantic_operators_set_true_shows_warning():
+    options = experiment_options.ExperimentOptions()
+
+    with pytest.warns(UserWarning):
+        options.semantic_operators = True
+
+    assert options.semantic_operators is True