frogml 1.2.50__py3-none-any.whl → 2.0.0__py3-none-any.whl

frogml/core/clients/batch_job_management/executions_config.py

@@ -1,5 +1,6 @@
 from collections import defaultdict
 from dataclasses import dataclass, field
+from http import HTTPStatus
 from typing import Dict, List, Tuple, Union
 
 from frogml._proto.qwak.batch_job.v1.batch_job_resources_pb2 import (
@@ -127,11 +128,15 @@ class ExecutionConfig(YamlConfigMixin, FrogmlConfigBase):
 
         if not self.execution.source_bucket:
             raise FrogmlException(
-                "Must supply either --bucket or --source-bucket parameter"
+                error_message="Must supply either --bucket or --source-bucket parameter",
+                status_code=HTTPStatus.BAD_REQUEST,
+                operation="Validate Batch Execution Config",
             )
         if not self.execution.destination_bucket:
             raise FrogmlException(
-                "Must supply either --bucket or --destination-bucket parameter"
+                error_message="Must supply either --bucket or --destination-bucket parameter",
+                status_code=HTTPStatus.BAD_REQUEST,
+                operation="Validate Batch Execution Config",
             )
 
     @property
@@ -195,7 +200,9 @@ def dictify_params(parameters: Union[Dict[str, str], List[str], Tuple[str]]):
         for param in parameters:
             if "=" not in param:
                 raise FrogmlException(
-                    f'The parameter definition passed {param} is invalid. Format is "KEY=VALUE"'
+                    error_message=f'The parameter definition passed {param} is invalid. Format is "KEY=VALUE"',
+                    status_code=HTTPStatus.BAD_REQUEST,
+                    operation="Parse Batch Parameters",
                 )
             split_param = param.split("=")
             result[split_param[0]] = split_param[1]

frogml/core/clients/build_orchestrator/build_model_request_getter.py

@@ -1,5 +1,6 @@
 import json
 import re
+from http import HTTPStatus
 from typing import List, Optional, TYPE_CHECKING
 
 import yaml
@@ -23,6 +24,7 @@ from frogml._proto.qwak.user_application.common.v0.resources_pb2 import (
 )
 from frogml.core.exceptions import FrogmlException
 
+BUILD_MODEL_OPERATION = "Build Model"
 
 if TYPE_CHECKING:
     from frogml.core.inner.build_config.build_config_v1 import BuildConfigV1
@@ -139,4 +141,8 @@ def _purchase_option_to_enum(purchase_option: Optional[str]) -> PurchaseOption:
     elif purchase_option == "spot":
         return PurchaseOption.SPOT_PURCHASE_OPTION
     else:
-        raise FrogmlException("Purchase option must be either 'ondemand' or 'spot'")
+        raise FrogmlException(
+            error_message="Purchase option must be either 'ondemand' or 'spot'",
+            status_code=HTTPStatus.BAD_REQUEST,
+            operation=BUILD_MODEL_OPERATION,
+        )

frogml/core/clients/build_orchestrator/client.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
 from enum import IntEnum
+from http import HTTPStatus
 from typing import Dict, List, Optional, TYPE_CHECKING
 
 import grpc
@@ -40,7 +41,11 @@ from frogml._proto.qwak.build_settings.build_settings_api_pb2 import (
 from frogml._proto.qwak.build_settings.build_settings_api_pb2_grpc import (
     BuildSettingsApiStub,
 )
-from frogml._proto.qwak.builds.build_pb2 import BaseDockerImageType, DataTableDefinition
+from frogml._proto.qwak.builds.build_pb2 import (
+    BaseDockerImageType,
+    DataTableDefinition,
+    RemoteBuildSpec,
+)
 from frogml._proto.qwak.builds.build_url_pb2 import (
     BuildVersioningTagsType,
     BuildVersioningUrlParams,
@@ -63,6 +68,7 @@ from frogml._proto.qwak.builds.builds_orchestrator_service_pb2_grpc import (
     BuildsOrchestratorServiceStub,
 )
 from frogml.core.clients.build_orchestrator.build_model_request_getter import (
+    BUILD_MODEL_OPERATION,
     _get_build_model_spec,
 )
 from frogml.core.exceptions import FrogmlException
@@ -73,6 +79,8 @@ from frogml.core.inner.tool.grpc.grpc_try_wrapping import grpc_try_catch_wrapper
 if TYPE_CHECKING:
     from frogml.core.inner.build_config.build_config_v1 import BuildConfigV1
 
+_GET_BUILD_VERSIONING_DOWNLOAD_URL_OPERATION = "Get Build Versioning Download URL"
+
 
 @dataclass
 class FrameworkModelDataClass:
@@ -124,14 +132,20 @@ class BuildOrchestratorClient:
         self._builds_orchestrator_stub = BuildsOrchestratorServiceStub(grpc_channel)
         self._build_settings_stub = BuildSettingsApiStub(grpc_channel)
 
-    @grpc_try_catch_wrapper("Failed to update build status")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to update build status for build '{build_id}'",
+        operation="Update Build Status",
+    )
     def update_build_status(
         self, build_id: str, build_status: BuildStatus
     ) -> UpdateBuildStatusResponse:
         request = UpdateBuildStatusRequest(buildId=build_id, build_status=build_status)
         return self._builds_orchestrator_stub_build_api.UpdateBuildStatus(request)
 
-    @grpc_try_catch_wrapper("Failed to register model schema")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to register model schema",
+        operation="Register Build Model Schema",
+    )
     def register_model_schema(
         self, build_id: str, model_schema: ModelSchema
     ) -> RegisterModelSchemaResponse:
@@ -140,7 +154,10 @@ class BuildOrchestratorClient:
         )
         return self._builds_orchestrator_stub_build_api.RegisterModelSchema(request)
 
-    @grpc_try_catch_wrapper("Failed to register experiment tracking values")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to register experiment tracking values",
+        operation="Register Build Experiment Tracking",
+    )
     def register_experiment_tracking(
         self,
         build_id: str,
@@ -160,7 +177,10 @@ class BuildOrchestratorClient:
             request
         )
 
-    @grpc_try_catch_wrapper("Failed to save framework models")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to save framework models",
+        operation="Save Build Framework Models",
+    )
     def save_framework_models(
         self, build_id: str, frameworks_model_data_class: List[FrameworkModelDataClass]
     ) -> SaveFrameworkModelsResponse:
@@ -190,7 +210,10 @@ class BuildOrchestratorClient:
 
         return self._builds_orchestrator_stub_build_api.SaveFrameworkModels(request)
 
-    @grpc_try_catch_wrapper("Failed to save framework models")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to save framework models",
+        operation="Save Build Framework Models",
+    )
     def save_used_framework_models(
         self, build_id: str, models: List[HuggingFaceModel]
     ) -> SaveFrameworkModelsResponse:
@@ -215,7 +238,9 @@ class BuildOrchestratorClient:
 
         return self._builds_orchestrator_stub_build_api.SaveFrameworkModels(request)
 
-    @grpc_try_catch_wrapper("Failed to register tags")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to register tags", operation="Register Build Tags"
+    )
     def register_tags(
         self,
         build_id: str,
@@ -224,18 +249,26 @@ class BuildOrchestratorClient:
         request = RegisterTagsRequest(build_id=build_id, tags=tags)
         return self._builds_orchestrator_stub_build_api.RegisterTags(request)
 
-    @grpc_try_catch_wrapper("Failed to list builds")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to list builds", operation="List Builds"
+    )
     def list_builds(
-        self, model_uuid: str = "", build_filter: BuildFilter = None, **kwargs
+        self, model_uuid: str = "", build_filter: Optional[BuildFilter] = None, **kwargs
     ) -> ListBuildsResponse:
         _model_uuid = model_uuid if model_uuid else kwargs.get("branch_id")
         if not _model_uuid:
-            raise FrogmlException("missing argument model uuid or branch id.")
+            raise FrogmlException(
+                error_message="Missing argument model uuid or branch id",
+                status_code=HTTPStatus.BAD_REQUEST,
+                operation="List Builds",
+            )
 
         request = ListBuildsRequest(model_uuid=_model_uuid, filter=build_filter)
         return self._builds_orchestrator_stub_build_api.ListBuilds(request)
 
-    @grpc_try_catch_wrapper("Failed to get build")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to get build '{build_id}'", operation="Get Build"
+    )
     def get_build(self, build_id: str) -> GetBuildResponse:
         request = GetBuildRequest(build_id=build_id)
         return self._builds_orchestrator_stub_build_api.GetBuild(request)
@@ -250,10 +283,14 @@ class BuildOrchestratorClient:
             if e.code() == grpc.StatusCode.NOT_FOUND:
                 return False
             raise FrogmlException(
-                f"Failed to check if build {build_id} is exists, error is {e.details()}"
+                error_message=f"Failed to check if build {build_id} exists: {e.details()}",
+                operation="Check Build Exists",
             )
 
-    @grpc_try_catch_wrapper("Failed to get build versioning upload urls {url_infos}")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to get build versioning upload urls {url_infos}",
+        operation="Get Build Versioning Upload URLs",
+    )
     def get_build_versioning_upload_urls(
         self, url_infos: list[UrlInfo]
     ) -> GetBuildVersioningUploadUrlsResponse:
@@ -271,7 +308,10 @@ class BuildOrchestratorClient:
             GetBuildVersioningUploadUrlsRequest(params=params)
         )
 
-    @grpc_try_catch_wrapper("Failed to get build versioning upload url")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to get build versioning upload url",
+        operation="Get Build Versioning Upload URL",
+    )
     def get_build_versioning_upload_url(
         self,
         build_id: str,
@@ -329,25 +369,26 @@ class BuildOrchestratorClient:
             )
         except grpc.RpcError as e:
             if e.code() == grpc.StatusCode.NOT_FOUND:
-                print(
-                    "The specified file cannot be found. Please verify the file name before trying again"
-                )
                 raise FrogmlException(
-                    "The specified file cannot be found. Please verify the file name before trying again"
+                    error_message="The specified file cannot be found. Please verify the file name before trying again",
+                    status_code=HTTPStatus.NOT_FOUND,
+                    operation=_GET_BUILD_VERSIONING_DOWNLOAD_URL_OPERATION,
                 )
             else:
-                print(f"Failed to get build versioning download url. Error is {e}")
                 raise FrogmlException(
-                    f"The specified file cannot be loaded. Error is {e}"
+                    error_message=f"The specified file cannot be loaded: {e.details()}",
+                    operation=_GET_BUILD_VERSIONING_DOWNLOAD_URL_OPERATION,
                 )
 
         except Exception as e:
-            print(f"Failed to get build versioning download url. Error is {e}")
             raise FrogmlException(
-                f"Failed to get build versioning download url. Error is {e}"
+                error_message=f"Failed to get build versioning download url: {e}",
+                operation=_GET_BUILD_VERSIONING_DOWNLOAD_URL_OPERATION,
             )
 
-    @grpc_try_catch_wrapper("Failed to get build settings")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to get build settings", operation="Get Build Settings"
+    )
     def get_build_settings(self, environment_id: str) -> GetBuildSettingsResponse:
         """Get BuildSettings
 
@@ -363,7 +404,10 @@ class BuildOrchestratorClient:
             )
         )
 
-    @grpc_try_catch_wrapper("Failed to define a table for the data")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to define a table for the data",
+        operation="Define Build Data Table",
+    )
     def define_build_data_table(
         self, build_id: str, model_id: str, tag: str, table: DataTableDefinition
     ) -> CreateDataTableResponse:
@@ -387,7 +431,10 @@ class BuildOrchestratorClient:
             )
         )
 
-    @grpc_try_catch_wrapper("Failed to log build phase status")
+    @grpc_try_catch_wrapper(
+        error_message="Failed to log build phase status",
+        operation="Log Build Phase Status",
+    )
     def log_phase_status(
         self,
         build_id: str,
@@ -441,34 +488,34 @@ class BuildOrchestratorClient:
         """
         build_steps = build_steps if build_steps else []
 
-        try:
-            build_spec = _get_build_model_spec(
-                build_conf,
-                verbose,
-                git_commit_id,
-                resolved_model_url,
-                build_code_path,
-                build_v1_flag,
-                build_config_url,
-                frogml_cli_wheel_url,
-                frogml_cli_version_url,
-                build_steps,
-                cli_version,
-            )
-            self._builds_orchestrator_stub.BuildModel(
-                BuildModelRequest(build_spec=build_spec)
-            )
-        except grpc.RpcError as e:
-            message = (
-                f"Failed to build model, status [{e.code()}] details [{e.details()}]"
-            )
-            raise FrogmlException(message)
+        build_spec = _get_build_model_spec(
+            build_conf,
+            verbose,
+            git_commit_id,
+            resolved_model_url,
+            build_code_path,
+            build_v1_flag,
+            build_config_url,
+            frogml_cli_wheel_url,
+            frogml_cli_version_url,
+            build_steps,
+            cli_version,
+        )
 
-        except Exception as e:
-            message = f"Failed to build model, details [{e}]"
-            raise FrogmlException(message)
+        self._build_model_request(build_spec)
+
+    @grpc_try_catch_wrapper(
+        error_message="Failed to build model", operation=BUILD_MODEL_OPERATION
+    )
+    def _build_model_request(self, build_spec: RemoteBuildSpec) -> None:
+        self._builds_orchestrator_stub.BuildModel(
+            BuildModelRequest(build_spec=build_spec)
+        )
 
-    def cancel_build_model(self, build_id: str):
+    @grpc_try_catch_wrapper(
+        error_message="Failed to cancel build '{build_id}'", operation="Cancel Build"
+    )
+    def cancel_build_model(self, build_id: str) -> None:
         """cancel remote build process
 
         Args:
@@ -477,15 +524,14 @@ class BuildOrchestratorClient:
         Raises:
             FrogmlException: In case of failing to connect the service
         """
-        try:
-            self._builds_orchestrator_stub.CancelBuildModel(
-                CancelBuildModelRequest(build_id=build_id)
-            )
-        except grpc.RpcError as e:
-            raise FrogmlException(
-                f"Failed to cancel build, status [{e.code()}] details [{e.details()}]"
-            )
+        self._builds_orchestrator_stub.CancelBuildModel(
+            CancelBuildModelRequest(build_id=build_id)
+        )
 
+    @grpc_try_catch_wrapper(
+        error_message="Failed to retrieve base docker image name",
+        operation="Get Build Base Docker Image Name",
+    )
     def fetch_base_docker_image_name(
         self, image_type: BaseDockerImageType
     ) -> GetBaseDockerImageNameResponse:
@@ -497,11 +543,6 @@ class BuildOrchestratorClient:
         Raises:
             FrogmlException: In case of failing to connect the service
         """
-        try:
-            return self._builds_orchestrator_stub.GetBaseDockerImageName(
-                GetBaseDockerImageNameRequest(base_docker_image_type=image_type)
-            )
-        except grpc.RpcError as e:
-            raise FrogmlException(
-                f"Failed to retrieve base docker image name, status [{e.code()}] details [{e.details()}]"
-            )
+        return self._builds_orchestrator_stub.GetBaseDockerImageName(
+            GetBaseDockerImageNameRequest(base_docker_image_type=image_type)
+        )

frogml/core/clients/build_orchestrator/internal_client.py

@@ -1,8 +1,9 @@
+from http import HTTPStatus
 from typing import List, Optional
 
-import grpc
 from dependency_injector.wiring import Provide
 
+from frogml import __version__ as frogml_version
 from frogml._proto.qwak.builds.build_pb2 import BuildInitiator, RemoteBuildSpec
 from frogml._proto.qwak.builds.internal_builds_orchestrator_service_pb2 import (
     BuildInitDetails,
@@ -12,12 +13,13 @@ from frogml._proto.qwak.builds.internal_builds_orchestrator_service_pb2_grpc imp
     InternalBuildsOrchestratorServiceStub,
 )
 from frogml.core.clients.build_orchestrator.build_model_request_getter import (
+    BUILD_MODEL_OPERATION,
     _get_build_model_spec,
 )
 from frogml.core.exceptions import FrogmlException
-from frogml.core.inner.di_configuration import FrogmlContainer
-from frogml import __version__ as frogml_version
 from frogml.core.inner.const import FrogMLConstants
+from frogml.core.inner.di_configuration import FrogmlContainer
+from frogml.core.inner.tool.grpc.grpc_try_wrapping import grpc_try_catch_wrapper
 
 
 class InternalBuildOrchestratorClient:
@@ -48,9 +50,9 @@ class InternalBuildOrchestratorClient:
         frogml_cli_wheel_url: str = "",
         frogml_cli_version_url: str = "",
         build_steps: Optional[List[str]] = None,
-        build_initiator: BuildInitiator = None,
+        build_initiator: Optional[BuildInitiator] = None,
         cli_version: str = "",
-    ):
+    ) -> None:
         """Initiate remote build
 
         Args:
@@ -80,42 +82,44 @@ class InternalBuildOrchestratorClient:
                 )
 
         if not self._internal_builds_orchestrator_stub:
-            raise FrogmlException("Internal GRPC channel is not available.")
+            raise FrogmlException(
+                error_message="Internal gRPC channel is not available",
+                status_code=HTTPStatus.SERVICE_UNAVAILABLE,
+                operation=BUILD_MODEL_OPERATION,
+            )
 
         build_steps = build_steps if build_steps else []
 
-        try:
-            if not cli_version:
-                cli_version = f"{FrogMLConstants.FROGML_CLI}/{frogml_version}"
-            elif not cli_version.startswith(FrogMLConstants.FROGML_CLI):
-                cli_version = f"{FrogMLConstants.FROGML_CLI}/{cli_version}"
+        if not cli_version:
+            cli_version = f"{FrogMLConstants.FROGML_CLI}/{frogml_version}"
+        elif not cli_version.startswith(FrogMLConstants.FROGML_CLI):
+            cli_version = f"{FrogMLConstants.FROGML_CLI}/{cli_version.lstrip('/')}"
 
-            build_spec: RemoteBuildSpec = _get_build_model_spec(
-                build_conf,
-                verbose,
-                git_commit_id,
-                resolved_model_url,
-                build_code_path,
-                build_v1_flag,
-                build_config_url,
-                frogml_cli_wheel_url,
-                frogml_cli_version_url,
-                build_steps,
-                cli_version,
-            )
-            self._internal_builds_orchestrator_stub.BuildModel(
-                InternalBuildModelRequest(
-                    build_init_details=BuildInitDetails(
-                        build_spec=build_spec, initiator=build_initiator
-                    )
+        build_spec: RemoteBuildSpec = _get_build_model_spec(
+            build_conf,
+            verbose,
+            git_commit_id,
+            resolved_model_url,
+            build_code_path,
+            build_v1_flag,
+            build_config_url,
+            frogml_cli_wheel_url,
+            frogml_cli_version_url,
+            build_steps,
+            cli_version,
+        )
+        self._build_model_request(build_spec, build_initiator)
+
+    @grpc_try_catch_wrapper(
+        error_message="Failed to build model", operation=BUILD_MODEL_OPERATION
+    )
+    def _build_model_request(
+        self, build_spec: RemoteBuildSpec, build_initiator: Optional[BuildInitiator]
+    ) -> None:
+        self._internal_builds_orchestrator_stub.BuildModel(
+            InternalBuildModelRequest(
+                build_init_details=BuildInitDetails(
+                    build_spec=build_spec, initiator=build_initiator
                 )
             )
-        except grpc.RpcError as e:
-            message = (
-                f"Failed to build model, status [{e.code()}] details [{e.details()}]"
-            )
-            raise FrogmlException(message)
-
-        except Exception as e:
-            message = f"Failed to build model, details [{e}]"
-            raise FrogmlException(message)
+        )