feat: add support for multiple client versions, change aiplatform fro…

…m compat.V1BETA1 to compat.V1 (#290)

* resolving rebase conflict, review feedback

* change compat.DEFAULT_VERSION to compat.V1; change tests services and types to V1 for general; add fixtures to support V1BETA1 tests for explanation

* chore(deps): update dependency google-cloud-aiplatform to v0.6.0 (#270)

* fix: add v1 conversion value rule

Co-authored-by: WhiteSource Renovate <[email protected]>
Co-authored-by: Sasha Sobran <[email protected]>

google/cloud/aiplatform/base.py

@@ -20,13 +20,13 @@
 import functools
 import inspect
 import threading
-from typing import Any, Callable, Dict, Optional, Sequence, Union
+from typing import Any, Callable, Dict, Optional, Sequence, Type, Union
 
 import proto
 
 from google.auth import credentials as auth_credentials
-from google.cloud.aiplatform import utils
 from google.cloud.aiplatform import initializer
+from google.cloud.aiplatform import utils
 
 
 class FutureManager(metaclass=abc.ABCMeta):
@@ -232,8 +232,8 @@ class AiPlatformResourceNoun(metaclass=abc.ABCMeta):
     @property
     @classmethod
     @abc.abstractmethod
-    def client_class(cls) -> utils.AiPlatformServiceClient:
-        """Client class required to interact with resource."""
+    def client_class(cls) -> Type[utils.AiPlatformServiceClientWithOverride]:
+        """Client class required to interact with resource with optional overrides."""
         pass
 
     @property
@@ -287,7 +287,7 @@ def _instantiate_client(
         cls,
         location: Optional[str] = None,
         credentials: Optional[auth_credentials.Credentials] = None,
-    ) -> utils.AiPlatformServiceClient:
+    ) -> utils.AiPlatformServiceClientWithOverride:
         """Helper method to instantiate service client for resource noun.
 
         Args:
@@ -296,8 +296,8 @@ def _instantiate_client(
                 Optional custom credentials to use when accessing interacting with
                 resource noun.
         Returns:
-            client (utils.AiPlatformServiceClient):
-                Initialized service client for this service noun.
+            client (utils.AiPlatformServiceClientWithOverride):
+                Initialized service client for this service noun with optional overrides.
         """
         return initializer.global_config.create_client(
             client_class=cls.client_class,

google/cloud/aiplatform/compat/__init__.py

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2021 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.
+#
+
+from google.cloud.aiplatform.compat import services
+from google.cloud.aiplatform.compat import types
+
+V1BETA1 = "v1beta1"
+V1 = "v1"
+
+DEFAULT_VERSION = V1
+
+if DEFAULT_VERSION == V1BETA1:
+
+    services.dataset_service_client = services.dataset_service_client_v1beta1
+    services.endpoint_service_client = services.endpoint_service_client_v1beta1
+    services.job_service_client = services.job_service_client_v1beta1
+    services.model_service_client = services.model_service_client_v1beta1
+    services.pipeline_service_client = services.pipeline_service_client_v1beta1
+    services.prediction_service_client = services.prediction_service_client_v1beta1
+    services.specialist_pool_service_client = (
+        services.specialist_pool_service_client_v1beta1
+    )
+
+    types.accelerator_type = types.accelerator_type_v1beta1
+    types.annotation = types.annotation_v1beta1
+    types.annotation_spec = types.annotation_spec_v1beta1
+    types.batch_prediction_job = types.batch_prediction_job_v1beta1
+    types.completion_stats = types.completion_stats_v1beta1
+    types.custom_job = types.custom_job_v1beta1
+    types.data_item = types.data_item_v1beta1
+    types.data_labeling_job = types.data_labeling_job_v1beta1
+    types.dataset = types.dataset_v1beta1
+    types.dataset_service = types.dataset_service_v1beta1
+    types.deployed_model_ref = types.deployed_model_ref_v1beta1
+    types.encryption_spec = types.encryption_spec_v1beta1
+    types.endpoint = types.endpoint_v1beta1
+    types.endpoint_service = types.endpoint_service_v1beta1
+    types.env_var = types.env_var_v1beta1
+    types.explanation = types.explanation_v1beta1
+    types.explanation_metadata = types.explanation_metadata_v1beta1
+    types.hyperparameter_tuning_job = types.hyperparameter_tuning_job_v1beta1
+    types.io = types.io_v1beta1
+    types.job_service = types.job_service_v1beta1
+    types.job_state = types.job_state_v1beta1
+    types.machine_resources = types.machine_resources_v1beta1
+    types.manual_batch_tuning_parameters = types.manual_batch_tuning_parameters_v1beta1
+    types.model = types.model_v1beta1
+    types.model_evaluation = types.model_evaluation_v1beta1
+    types.model_evaluation_slice = types.model_evaluation_slice_v1beta1
+    types.model_service = types.model_service_v1beta1
+    types.operation = types.operation_v1beta1
+    types.pipeline_service = types.pipeline_service_v1beta1
+    types.pipeline_state = types.pipeline_state_v1beta1
+    types.prediction_service = types.prediction_service_v1beta1
+    types.specialist_pool = types.specialist_pool_v1beta1
+    types.specialist_pool_service = types.specialist_pool_service_v1beta1
+    types.training_pipeline = types.training_pipeline_v1beta1
+
+if DEFAULT_VERSION == V1:
+
+    services.dataset_service_client = services.dataset_service_client_v1
+    services.endpoint_service_client = services.endpoint_service_client_v1
+    services.job_service_client = services.job_service_client_v1
+    services.model_service_client = services.model_service_client_v1
+    services.pipeline_service_client = services.pipeline_service_client_v1
+    services.prediction_service_client = services.prediction_service_client_v1
+    services.specialist_pool_service_client = services.specialist_pool_service_client_v1
+
+    types.accelerator_type = types.accelerator_type_v1
+    types.annotation = types.annotation_v1
+    types.annotation_spec = types.annotation_spec_v1
+    types.batch_prediction_job = types.batch_prediction_job_v1
+    types.completion_stats = types.completion_stats_v1
+    types.custom_job = types.custom_job_v1
+    types.data_item = types.data_item_v1
+    types.data_labeling_job = types.data_labeling_job_v1
+    types.dataset = types.dataset_v1
+    types.dataset_service = types.dataset_service_v1
+    types.deployed_model_ref = types.deployed_model_ref_v1
+    types.encryption_spec = types.encryption_spec_v1
+    types.endpoint = types.endpoint_v1
+    types.endpoint_service = types.endpoint_service_v1
+    types.env_var = types.env_var_v1
+    types.hyperparameter_tuning_job = types.hyperparameter_tuning_job_v1
+    types.io = types.io_v1
+    types.job_service = types.job_service_v1
+    types.job_state = types.job_state_v1
+    types.machine_resources = types.machine_resources_v1
+    types.manual_batch_tuning_parameters = types.manual_batch_tuning_parameters_v1
+    types.model = types.model_v1
+    types.model_evaluation = types.model_evaluation_v1
+    types.model_evaluation_slice = types.model_evaluation_slice_v1
+    types.model_service = types.model_service_v1
+    types.operation = types.operation_v1
+    types.pipeline_service = types.pipeline_service_v1
+    types.pipeline_state = types.pipeline_state_v1
+    types.prediction_service = types.prediction_service_v1
+    types.specialist_pool = types.specialist_pool_v1
+    types.specialist_pool_service = types.specialist_pool_service_v1
+    types.training_pipeline = types.training_pipeline_v1
+
+__all__ = (
+    DEFAULT_VERSION,
+    V1BETA1,
+    V1,
+    services,
+    types,
+)

google/cloud/aiplatform/compat/services/__init__.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2021 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.
+#
+
+from google.cloud.aiplatform_v1beta1.services.dataset_service import (
+    client as dataset_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.endpoint_service import (
+    client as endpoint_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.job_service import (
+    client as job_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.model_service import (
+    client as model_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.pipeline_service import (
+    client as pipeline_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.prediction_service import (
+    client as prediction_service_client_v1beta1,
+)
+from google.cloud.aiplatform_v1beta1.services.specialist_pool_service import (
+    client as specialist_pool_service_client_v1beta1,
+)
+
+from google.cloud.aiplatform_v1.services.dataset_service import (
+    client as dataset_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.endpoint_service import (
+    client as endpoint_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.job_service import (
+    client as job_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.model_service import (
+    client as model_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.pipeline_service import (
+    client as pipeline_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.prediction_service import (
+    client as prediction_service_client_v1,
+)
+from google.cloud.aiplatform_v1.services.specialist_pool_service import (
+    client as specialist_pool_service_client_v1,
+)
+
+__all__ = (
+    # v1
+    dataset_service_client_v1,
+    endpoint_service_client_v1,
+    job_service_client_v1,
+    model_service_client_v1,
+    pipeline_service_client_v1,
+    prediction_service_client_v1,
+    specialist_pool_service_client_v1,
+    # v1beta1
+    dataset_service_client_v1beta1,
+    endpoint_service_client_v1beta1,
+    job_service_client_v1beta1,
+    model_service_client_v1beta1,
+    pipeline_service_client_v1beta1,
+    prediction_service_client_v1beta1,
+    specialist_pool_service_client_v1beta1,
+)