adds helper file and refactors init and properties and setters

Author: chalmerlowe

google/cloud/bigquery_v2/services/centralized_service/_helpers.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# Copyright 2025 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.
+#
+
+
+def _drop_self_key(kwargs):
+    "Drops 'self' key from a given kwargs dict."
+
+    if not isinstance(kwargs, dict):
+        raise TypeError("kwargs must be a dict.")
+    kwargs.pop("self", None)  # Essentially a no-op if 'self' key does not exist
+    return kwargs

google/cloud/bigquery_v2/services/centralized_service/client.py

@@ -22,6 +22,8 @@
     Union,
 )
 
+from google.cloud.bigquery_v2.services.centralized_service import _helpers
+
 # Import service client modules
 from google.cloud.bigquery_v2.services import (
     dataset_service,
@@ -55,15 +57,6 @@
 DEFAULT_METADATA: Sequence[Tuple[str, Union[str, bytes]]] = ()
 
 
-def _drop_self_key(kwargs):
-    "Drops 'self' key from a given kwargs dict."
-
-    if not isinstance(kwargs, dict):
-        raise TypeError("kwargs must be a dict.")
-    kwargs.pop("self", None)  # Essentially a no-op if 'self' key does not exist
-    return kwargs
-
-
 # Create Centralized Client
 class BigQueryClient:
     def __init__(
@@ -72,19 +65,86 @@ def __init__(
         credentials: Optional[auth_credentials.Credentials] = None,
         client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None,
     ):
-        # A dictionary mapping service names to their client classes.
-        service_clients_config = {
-            "dataset": dataset_service.DatasetServiceClient,
-            "job": job_service.JobServiceClient,
-            "model": model_service.ModelServiceClient,
-        }
-
-        # Dynamically initialize service clients.
-        for service_name, client_class in service_clients_config.items():
-            client_instance = client_class(
-                credentials=credentials, client_options=client_options
+        self._clients = {}
+        self._credentials = credentials
+        self._client_options = client_options
+
+    @property
+    def dataset_service_client(self):
+        if "dataset" not in self._clients:
+            from google.cloud.bigquery_v2.services import dataset_service
+            self._clients["dataset"] = dataset_service.DatasetServiceClient(
+                credentials=self._credentials, client_options=self._client_options
             )
-            setattr(self, f"{service_name}_service_client", client_instance)
+        return self._clients["dataset"]
+
+    @dataset_service_client.setter
+    def dataset_service_client(self, value):
+        # Check for the methods that this class most commonly uses (duck typing)
+        required_methods = [
+            "get_dataset",
+            "insert_dataset",
+            "patch_dataset",
+            "update_dataset",
+            "delete_dataset",
+            "list_datasets",
+            "undelete_dataset",
+        ]
+        for method in required_methods:
+            if not hasattr(value, method) or not callable(getattr(value, method)):
+                raise AttributeError(
+                    f"Object assigned to dataset_service_client is missing a callable '{method}' method."
+                )
+        self._clients["dataset"] = value
+
+    @property
+    def job_service_client(self):
+        if "job" not in self._clients:
+            from google.cloud.bigquery_v2.services import job_service
+            self._clients["job"] = job_service.JobServiceClient(
+                credentials=self._credentials, client_options=self._client_options
+            )
+        return self._clients["job"]
+
+    @job_service_client.setter
+    def job_service_client(self, value):
+        required_methods = [
+            "get_job",
+            "insert_job",
+            "cancel_job",
+            "delete_job",
+            "list_jobs",
+        ]
+        for method in required_methods:
+            if not hasattr(value, method) or not callable(getattr(value, method)):
+                raise AttributeError(
+                    f"Object assigned to job_service_client is missing a callable '{method}' method."
+                )
+        self._clients["job"] = value
+
+    @property
+    def model_service_client(self):
+        if "model" not in self._clients:
+            from google.cloud.bigquery_v2.services import model_service
+            self._clients["model"] = model_service.ModelServiceClient(
+                credentials=self._credentials, client_options=self._client_options
+            )
+        return self._clients["model"]
+
+    @model_service_client.setter
+    def model_service_client(self, value):
+        required_methods = [
+            "get_model",
+            "delete_model",
+            "patch_model",
+            "list_models",
+        ]
+        for method in required_methods:
+            if not hasattr(value, method) or not callable(getattr(value, method)):
+                raise AttributeError(
+                    f"Object assigned to model_service_client is missing a callable '{method}' method."
+                )
+        self._clients["model"] = value
 
     def get_dataset(
         self,
@@ -97,9 +157,23 @@ def get_dataset(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         return self.dataset_service_client.get_dataset(**kwargs)
 
+    def list_datasets(
+        self,
+        request: Optional[Union[dataset.ListDatasetsRequest, dict]] = None,
+        *,
+        retry: OptionalRetry = DEFAULT_RETRY,
+        timeout: Union[float, object] = DEFAULT_TIMEOUT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = DEFAULT_METADATA,
+    ):
+        """
+        TODO: Docstring is purposefully blank. microgenerator will add automatically.
+        """
+        kwargs = _helpers._drop_self_key(locals())
+        return self.dataset_service_client.list_datasets(**kwargs)
+
     def list_jobs(
         self,
         request: Optional[Union[job.ListJobsRequest, dict]] = None,
@@ -111,7 +185,7 @@ def list_jobs(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         return self.job_service_client.list_jobs(**kwargs)
 
     def get_model(
@@ -125,7 +199,7 @@ def get_model(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         return self.model_service_client.get_model(**kwargs)
 
     def delete_model(
@@ -139,7 +213,7 @@ def delete_model(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         # The underlying GAPIC client returns None on success.
         return self.model_service_client.delete_model(**kwargs)
 
@@ -154,7 +228,7 @@ def patch_model(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         return self.model_service_client.patch_model(**kwargs)
 
     def list_models(
@@ -168,5 +242,5 @@ def list_models(
         """
         TODO: Docstring is purposefully blank. microgenerator will add automatically.
         """
-        kwargs = _drop_self_key(locals())
+        kwargs = _helpers._drop_self_key(locals())
         return self.model_service_client.list_models(**kwargs)

tests/unit/gapic/bigquery_v2/test_centralized_service.py

@@ -172,15 +172,21 @@ def test_client_initialization_arguments(
         )
 
         # Assert
-        # The BigQueryClient should have been initialized, and the underlying
-        # service clients should have been instantiated with the provided arguments.
-        # Note: We are asserting on the mock objects provided by the fixtures.
+        # The BigQueryClient should have been initialized. Accessing the
+        # service client properties should instantiate them with the correct arguments.
+
+        # Access the property to trigger instantiation
+        _ = client.dataset_service_client
         mock_dataset_service_client.assert_called_once_with(
             credentials=credentials, client_options=client_options
         )
+
+        _ = client.job_service_client
         mock_job_service_client.assert_called_once_with(
             credentials=credentials, client_options=client_options
         )
+
+        _ = client.model_service_client
         mock_model_service_client.assert_called_once_with(
             credentials=credentials, client_options=client_options
         )