refactor: rename the bigframes function classes (#1323)

* refactor: rename the bigframes function classes

* resolve comments

* quick fix

* fix naming convention

Author: jialuoo

bigframes/functions/_function_client.py

@@ -54,10 +54,12 @@
 )
 
 
-class RemoteFunctionClient:
+class FunctionClient:
     # Wait time (in seconds) for an IAM binding to take effect after creation
     _iam_wait_seconds = 120
 
+    # TODO(b/392707725): Convert all necessary parameters for cloud function
+    # deployment into method parameters.
     def __init__(
         self,
         gcp_project_id,

bigframes/functions/_function_session.py

@@ -55,18 +55,18 @@
 from . import _function_client, _utils
 
 
-class RemoteFunctionSession:
-    """Session to manage remote functions."""
+class FunctionSession:
+    """Session to manage bigframes functions."""
 
     def __init__(self):
-        # Session level mapping of remote function artifacts
+        # Session level mapping of function artifacts
         self._temp_artifacts: Dict[str, str] = dict()
 
         # Lock to synchronize the update of the session artifacts
         self._artifacts_lock = threading.Lock()
 
     def _update_temp_artifacts(self, bqrf_routine: str, gcf_path: str):
-        """Update remote function artifacts in the current session."""
+        """Update function artifacts in the current session."""
         with self._artifacts_lock:
             self._temp_artifacts[bqrf_routine] = gcf_path
 
@@ -76,11 +76,11 @@ def clean_up(
         gcfclient: functions_v2.FunctionServiceClient,
         session_id: str,
     ):
-        """Delete remote function artifacts in the current session."""
+        """Delete function artifacts in the current session."""
         with self._artifacts_lock:
             for bqrf_routine, gcf_path in self._temp_artifacts.items():
-                # Let's accept the possibility that the remote function may have
-                # been deleted directly by the user
+                # Let's accept the possibility that the function may have been
+                # deleted directly by the user
                 bqclient.delete_routine(bqrf_routine, not_found_ok=True)
 
                 # Let's accept the possibility that the cloud function may have
@@ -467,7 +467,7 @@ def wrapper(func):
                 signature, input_types, output_type  # type: ignore
             )
 
-            remote_function_client = _function_client.RemoteFunctionClient(
+            remote_function_client = _function_client.FunctionClient(
                 dataset_ref.project,
                 cloud_function_region,
                 cloud_functions_client,

bigframes/functions/_utils.py

@@ -30,8 +30,8 @@
 import bigframes.core.compile.ibis_types
 import bigframes.dtypes
 
-# Naming convention for the remote function artifacts
-_BIGFRAMES_REMOTE_FUNCTION_PREFIX = "bigframes"
+# Naming convention for the function artifacts
+_BIGFRAMES_FUNCTION_PREFIX = "bigframes"
 _BQ_FUNCTION_NAME_SEPERATOR = "_"
 _GCF_FUNCTION_NAME_SEPERATOR = "-"
 
@@ -66,10 +66,10 @@ def _get_updated_package_requirements(
 ):
     requirements = [f"cloudpickle=={cloudpickle.__version__}"]
     if is_row_processor:
-        # bigframes remote function will send an entire row of data as json,
-        # which would be converted to a pandas series and processed
-        # Ensure numpy versions match to avoid unpickling problems. See
-        # internal issue b/347934471.
+        # bigframes function will send an entire row of data as json, which
+        # would be converted to a pandas series and processed Ensure numpy
+        # versions match to avoid unpickling problems. See internal issue
+        # b/347934471.
         requirements.append(f"numpy=={numpy.__version__}")
         requirements.append(f"pandas=={pandas.__version__}")
         requirements.append(f"pyarrow=={pyarrow.__version__}")
@@ -94,14 +94,14 @@ def _clean_up_by_session_id(
     point in time.
     """
 
-    # First clean up the BQ remote functions and then the underlying
-    # cloud functions, so that at no point we are left with a remote function
-    # that is pointing to a cloud function that does not exist
+    # First clean up the BQ remote functions and then the underlying cloud
+    # functions, so that at no point we are left with a remote function that is
+    # pointing to a cloud function that does not exist
 
     endpoints_to_be_deleted: Set[str] = set()
     match_prefix = "".join(
         [
-            _BIGFRAMES_REMOTE_FUNCTION_PREFIX,
+            _BIGFRAMES_FUNCTION_PREFIX,
             _BQ_FUNCTION_NAME_SEPERATOR,
             session_id,
             _BQ_FUNCTION_NAME_SEPERATOR,
@@ -176,7 +176,7 @@ def routine_ref_to_string_for_query(routine_ref: bigquery.RoutineReference) -> s
 
 def get_cloud_function_name(function_hash, session_id=None, uniq_suffix=None):
     "Get a name for the cloud function for the given user defined function."
-    parts = [_BIGFRAMES_REMOTE_FUNCTION_PREFIX]
+    parts = [_BIGFRAMES_FUNCTION_PREFIX]
     if session_id:
         parts.append(session_id)
     parts.append(function_hash)
@@ -186,8 +186,8 @@ def get_cloud_function_name(function_hash, session_id=None, uniq_suffix=None):
 
 
 def get_remote_function_name(function_hash, session_id, uniq_suffix=None):
-    "Get a name for the BQ remote function for the given user defined function."
-    parts = [_BIGFRAMES_REMOTE_FUNCTION_PREFIX, session_id, function_hash]
+    "Get a name for the remote function for the given user defined function."
+    parts = [_BIGFRAMES_FUNCTION_PREFIX, session_id, function_hash]
     if uniq_suffix:
         parts.append(uniq_suffix)
     return _BQ_FUNCTION_NAME_SEPERATOR.join(parts)

bigframes/functions/function.py

@@ -120,11 +120,11 @@ def get_routine_reference(
 
 
 def remote_function(*args, **kwargs):
-    remote_function_session = bff_session.RemoteFunctionSession()
+    remote_function_session = bff_session.FunctionSession()
     return remote_function_session.remote_function(*args, **kwargs)
 
 
-remote_function.__doc__ = bff_session.RemoteFunctionSession.remote_function.__doc__
+remote_function.__doc__ = bff_session.FunctionSession.remote_function.__doc__
 
 
 def read_gbq_function(
@@ -174,7 +174,7 @@ def read_gbq_function(
     # The name "args" conflicts with the Ibis operator, so we use
     # non-standard names for the arguments here.
     def func(*bigframes_args, **bigframes_kwargs):
-        f"""Remote function {str(routine_ref)}."""
+        f"""Bigframes function {str(routine_ref)}."""
         nonlocal node  # type: ignore
 
         expr = node(*bigframes_args, **bigframes_kwargs)  # type: ignore

bigframes/session/__init__.py

@@ -245,7 +245,7 @@ def __init__(
         )
 
         self._metrics = bigframes.session.metrics.ExecutionMetrics()
-        self._function_session = bff_session.RemoteFunctionSession()
+        self._function_session = bff_session.FunctionSession()
         self._temp_storage_manager = (
             bigframes.session.temp_storage.TemporaryGbqStorageManager(
                 self._clients_provider.bqclient,