gmicloud 0.1.6__py3-none-any.whl → 0.1.9__py3-none-any.whl

gmicloud/__init__.py

@@ -15,7 +15,7 @@ from ._internal._models import (
     OneOffScheduling,
     DailyScheduling,
     DailyTrigger,
-    ArtifactTemplate,
+    Template,
 )
 from ._internal._enums import (
     BuildStatus,
@@ -39,7 +39,7 @@ __all__ = [
     "OneOffScheduling",
     "DailyScheduling",
     "DailyTrigger",
-    "ArtifactTemplate",
+    "Template",
     "BuildStatus",
     "TaskEndpointStatus",
 ]

gmicloud/_internal/_client/_artifact_client.py

@@ -1,7 +1,7 @@
 from typing import List
 import logging
 from requests.exceptions import RequestException
-
+import json
 from ._http_client import HTTPClient
 from ._iam_client import IAMClient
 from ._decorator import handle_refresh_token
@@ -120,6 +120,39 @@ class ArtifactClient:
             logger.error(f"Failed to rebuild artifact {artifact_id}: {e}")
             return None
 
+    @handle_refresh_token
+    def add_env_parameters_to_artifact(self, artifact_id: str, env_parameters: dict[str, str]) -> None:
+        """
+        Updates an artifact by its ID.
+
+        :param artifact_id: The ID of the artifact to update.
+        :param request: The request object containing the updated artifact details.
+        """
+        try:
+            old_artifact = self.get_artifact(artifact_id)
+            if not old_artifact:
+                logger.error(f"Artifact {artifact_id} not found")
+                return
+            request = UpdateArtifactRequestBody(
+                artifact_description=old_artifact.artifact_metadata.artifact_description,
+                artifact_name=old_artifact.artifact_metadata.artifact_name,
+                artifact_tags=old_artifact.artifact_metadata.artifact_tags,
+                env_parameters=old_artifact.artifact_parameters.env_parameters,
+                model_parameters=old_artifact.artifact_parameters.model_parameters
+            )
+            new_env_parameters = [EnvParameter(key=k, value=v) for k, v in env_parameters.items()]
+            if not request.env_parameters:
+                request.env_parameters = []
+            request.env_parameters.extend(new_env_parameters)
+            response = self.client.put(
+                f"/update_artifact?artifact_id={artifact_id}",
+                self.iam_client.get_custom_headers(),
+                request.model_dump()
+            )
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to add env parameters to artifact {artifact_id}: {e}")
+            return 
+
     @handle_refresh_token
     def delete_artifact(self, artifact_id: str) -> Optional[DeleteArtifactResponse]:
         """
@@ -140,7 +173,7 @@ class ArtifactClient:
             return None
 
     @handle_refresh_token
-    def get_bigfile_upload_url(self, request: GetBigFileUploadUrlRequest) -> Optional[GetBigFileUploadUrlResponse]:
+    def get_bigfile_upload_url(self, request: ResumableUploadLinkRequest) -> Optional[ResumableUploadLinkResponse]:
         """
         Generates a pre-signed URL for uploading a large file.
 
@@ -156,7 +189,7 @@ class ArtifactClient:
                 logger.error("Empty response from /get_bigfile_upload_url")
                 return None
 
-            return GetBigFileUploadUrlResponse.model_validate(response)
+            return ResumableUploadLinkResponse.model_validate(response)
 
         except (RequestException, ValueError) as e:
             logger.error(f"Failed to generate upload URL: {e}")
@@ -186,12 +219,12 @@ class ArtifactClient:
             return None
 
     @handle_refresh_token
-    def get_public_templates(self) -> List[ArtifactTemplate]:
+    def get_public_templates(self) -> List[Template]:
         """
         Fetches all artifact templates.
 
-        :return: A list of ArtifactTemplate objects.
-        :rtype: List[ArtifactTemplate]
+        :return: A list of Template objects.
+        :rtype: List[Template]
         """
         try:
             response = self.client.get("/get_public_templates", self.iam_client.get_custom_headers())
@@ -201,7 +234,7 @@ class ArtifactClient:
                 return []
 
             try:
-                result = GetPublicTemplatesResponse.model_validate(response)
+                result = GetTemplatesResponse.model_validate(response)
                 return result.artifact_templates
             except ValueError as ve:
                 logger.error(f"Failed to validate response data: {ve}")

gmicloud/_internal/_client/_auth_config.py

@@ -0,0 +1,78 @@
+import os
+import jwt
+import time
+import json
+import logging
+import threading
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+CONFIG_FILE_NAME = ".gmicloud.config.json"
+
+# create the thread lock object56
+lock = threading.Lock()
+
+def _read_config_file()->dict|None:
+    """Read the config file."""
+    base_dir = Path.home()
+    config_file_path =os.path.join(base_dir,CONFIG_FILE_NAME)
+    if not os.path.exists(config_file_path):
+        return None
+    with lock:
+        # open the config file, read mode with lock
+        with open(config_file_path,"r") as fr:
+            return json.loads(fr.read())
+
+
+def _write_config_file(config_file_path:str,config_dic:dict)->None:
+    """Write the config file."""
+    with lock:
+        # open the config file, write mode with lock
+        with open(config_file_path,"w") as fw:
+            # transform the config dictionary to JSON format and write it to the file
+            fw.write(json.dumps(config_dic))
+
+
+def write_user_refresh_token_to_system_config(email:str,refresh_token:str)->bool:
+    """Write the user refresh token to the system config file."""
+    base_dir = Path.home()
+    config_file_path = os.path.join(base_dir,CONFIG_FILE_NAME)
+    try:
+        # check the config file is exists. if not, create it, if yes, update the refresh token
+        if not os.path.exists(config_file_path):
+            config_dic = { email : {"refresh_token": refresh_token} }
+            _write_config_file(config_file_path,config_dic)
+        else:
+            config_dic = _read_config_file()
+            if not config_dic.get(email):
+                config_dic[email] = dict()
+            config_dic[email] = {"refresh_token": refresh_token}
+            _write_config_file(config_file_path,config_dic)
+    except Exception as e:
+        logger.error("write file wrong :", e)
+        return False
+    return True
+
+
+def get_user_refresh_token_from_system_config(email:str)->str|None:
+    """Get the user refresh token from the system config file."""
+    config_dic = _read_config_file()
+    if not config_dic or not config_dic.get(email):
+        return None
+    return config_dic[email]["refresh_token"]
+
+
+def _parese_refresh_token(refresh_token:str)->dict:
+    """Parse the refresh token."""
+    return jwt.decode(refresh_token, options={"verify_signature": False})
+
+
+def is_refresh_token_expired(refresh_token:str)->bool:
+    """Check the refresh token is expired. if expired, return True, else return False."""
+    try:
+        refresh_token_time = _parese_refresh_token(refresh_token)['exp']
+    except Exception as e:
+        logger.error("parse refresh token wrong :", e)
+        return True
+    return refresh_token_time < time.time()

gmicloud/_internal/_client/_file_upload_client.py

@@ -1,8 +1,10 @@
 import os
 import requests
+import logging
 
 from .._exceptions import UploadFileError
 
+logger = logging.getLogger()
 
 class FileUploadClient:
     CHUNK_SIZE = 10 * 1024 * 1024  # 10MB Default Chunk Size
@@ -45,13 +47,13 @@ class FileUploadClient:
         """
         try:
             file_size = os.path.getsize(file_path)
-            print(f"File Size: {file_size} bytes")
+            logger.info(f"File {file_path} size: {file_size} bytes")
 
             start_byte = 0
             uploaded_range = FileUploadClient._check_file_status(upload_url, file_size)
             if uploaded_range:
                 start_byte = int(uploaded_range.split("-")[1]) + 1
-                print(f"Resuming upload from {start_byte} bytes")
+                logger.info(f"Resuming uploading {file_path} from {start_byte} bytes")
 
             with open(file_path, "rb") as file:
                 while start_byte < file_size:
@@ -74,14 +76,15 @@ class FileUploadClient:
                     # Ensure upload is successful for this chunk
                     if resp.status_code not in (200, 201, 308):
                         raise UploadFileError(
-                            f"Failed to upload file, code:{resp.status_code} ,message: {resp.text}")
+                            f"Failed to upload file {file_path}, code:{resp.status_code} ,message: {resp.text}")
 
                     start_byte = end_byte + 1
-                    print(f"Uploaded {end_byte + 1}/{file_size} bytes")
+                    percentage = (start_byte / file_size) * 100
+                    logger.info(f"File {file_path} uploaded {end_byte + 1:,}/{file_size:,} bytes ({percentage:.2f}%)")
 
-                print("Upload completed successfully.")
+                logger.info(f"File {file_path} uploaded successfully.")
         except Exception as e:
-            raise UploadFileError(f"Failed to upload file: {str(e)}")
+            raise UploadFileError(f"Failed to upload file {file_path}, got error: {str(e)}")
 
     @staticmethod
     def _check_file_status(upload_url: str, file_size: int) -> str:
@@ -104,7 +107,7 @@ class FileUploadClient:
             if resp.status_code == 308:
                 range_header = resp.headers.get("Range")
                 if range_header:
-                    print(f"Server reports partial upload range: {range_header}")
+                    logger.info(f"Server reports partial upload range: {range_header}")
                 return range_header
 
             if resp.status_code in (200, 201):

gmicloud/_internal/_client/_iam_client.py

@@ -6,7 +6,11 @@ from ._http_client import HTTPClient
 from .._config import IAM_SERVICE_BASE_URL
 from .._models import *
 from .._constants import CLIENT_ID_HEADER, AUTHORIZATION_HEADER
-
+from ._auth_config import (
+    get_user_refresh_token_from_system_config,
+    write_user_refresh_token_to_system_config,
+    is_refresh_token_expired
+)
 logger = logging.getLogger(__name__)
 
 
@@ -38,42 +42,50 @@ class IAMClient:
         Returns True if login is successful, otherwise False.
         """
         try:
-            custom_headers = {CLIENT_ID_HEADER: self._client_id}
-            req = AuthTokenRequest(email=self._email, password=self._password)
-            auth_tokens_result = self.client.post("/me/auth-tokens", custom_headers, req.model_dump())
-
-            if not auth_tokens_result:
-                logger.error("Login failed: Received empty response from auth-tokens endpoint")
-                return False
-
-            auth_tokens_resp = AuthTokenResponse.model_validate(auth_tokens_result)
-
-            # Handle 2FA
-            if auth_tokens_resp.is2FARequired:
-                for attempt in range(3):
-                    code = input(f"Attempt {attempt + 1}/3: Please enter the 2FA code: ")
-                    create_session_req = CreateSessionRequest(
-                        type="native", authToken=auth_tokens_resp.authToken, otpCode=code
-                    )
-                    try:
-                        session_result = self.client.post("/me/sessions", custom_headers,
-                                                          create_session_req.model_dump())
-                        if session_result:
-                            break
-                    except RequestException:
-                        logger.warning("Invalid 2FA code, please try again.")
-                        if attempt == 2:
-                            logger.error("Failed to create session after 3 incorrect 2FA attempts.")
-                            return False
+            # Check config refresh token is available and is not expired, if yes ,refresh it
+            temp_refresh_token = get_user_refresh_token_from_system_config(self._email)
+            if temp_refresh_token and not is_refresh_token_expired(temp_refresh_token):
+                self._refresh_token = temp_refresh_token
+                self.refresh_token()
             else:
-                create_session_req = CreateSessionRequest(type="native", authToken=auth_tokens_resp.authToken,
-                                                          otpCode=None)
-                session_result = self.client.post("/me/sessions", custom_headers, create_session_req.model_dump())
-
-            create_session_resp = CreateSessionResponse.model_validate(session_result)
-
-            self._access_token = create_session_resp.accessToken
-            self._refresh_token = create_session_resp.refreshToken
+                custom_headers = {CLIENT_ID_HEADER: self._client_id}
+                req = AuthTokenRequest(email=self._email, password=self._password)
+                auth_tokens_result = self.client.post("/me/auth-tokens", custom_headers, req.model_dump())
+
+                if not auth_tokens_result:
+                    logger.error("Login failed: Received empty response from auth-tokens endpoint")
+                    return False
+
+                auth_tokens_resp = AuthTokenResponse.model_validate(auth_tokens_result)
+
+                # Handle 2FA
+                if auth_tokens_resp.is2FARequired:
+                    for attempt in range(3):
+                        code = input(f"Attempt {attempt + 1}/3: Please enter the 2FA code: ")
+                        create_session_req = CreateSessionRequest(
+                            type="native", authToken=auth_tokens_resp.authToken, otpCode=code
+                        )
+                        try:
+                            session_result = self.client.post("/me/sessions", custom_headers,
+                                                            create_session_req.model_dump())
+                            if session_result:
+                                break
+                        except RequestException:
+                            logger.warning("Invalid 2FA code, please try again.")
+                            if attempt == 2:
+                                logger.error("Failed to create session after 3 incorrect 2FA attempts.")
+                                return False
+                else:
+                    create_session_req = CreateSessionRequest(type="native", authToken=auth_tokens_resp.authToken,
+                                                            otpCode=None)
+                    session_result = self.client.post("/me/sessions", custom_headers, create_session_req.model_dump())
+
+                create_session_resp = CreateSessionResponse.model_validate(session_result)
+
+                self._access_token = create_session_resp.accessToken
+                self._refresh_token = create_session_resp.refreshToken
+                # first login write refresh token to system config
+                write_user_refresh_token_to_system_config(self._email,self._refresh_token)
             self._user_id = self.parse_user_id()
 
             # Fetch profile to get organization ID
@@ -96,7 +108,12 @@ class IAMClient:
         """
         try:
             custom_headers = {CLIENT_ID_HEADER: self._client_id}
-            result = self.client.patch("/me/sessions", custom_headers, {"refreshToken": self._refresh_token})
+            try:
+                result = self.client.patch("/me/sessions", custom_headers, {"refreshToken": self._refresh_token})
+            except Exception as err:
+                logger.error(f"{str(err)}, please re-login.")
+                write_user_refresh_token_to_system_config(self._email,"")
+                return False
 
             if not result:
                 logger.error("Failed to refresh token: Empty response received")
@@ -105,7 +122,9 @@ class IAMClient:
             resp = CreateSessionResponse.model_validate(result)
             self._access_token = resp.accessToken
             self._refresh_token = resp.refreshToken
-
+            # the _refresh_token will be updated when call this function
+            # so write it to system config file for update the _refresh_token expired time
+            write_user_refresh_token_to_system_config(self._email,self._refresh_token)
             return True
         except (RequestException, ValueError) as e:
             logger.error(f"Token refresh failed: {e}")

gmicloud/_internal/_client/_video_client.py

@@ -0,0 +1,111 @@
+
+import logging
+from requests.exceptions import RequestException
+
+from ._http_client import HTTPClient
+from ._decorator import handle_refresh_token
+from ._iam_client import IAMClient
+from .._config import IAM_SERVICE_BASE_URL
+from .._models import *
+
+
+logger = logging.getLogger(__name__)
+
+
+class VideoClient:
+    """
+    A client for interacting with the video service API.
+
+    This client provides methods to retrieve, create, update, and stop video tasks
+    through HTTP calls to the video service.
+    """
+
+    def __init__(self, iam_client: IAMClient):
+        """
+        Initializes the VideoClient with the given base URL for the video service.
+        """
+        self.client = HTTPClient(IAM_SERVICE_BASE_URL+ "/ie/requestqueue")
+        self.iam_client = iam_client
+
+
+    @handle_refresh_token
+    def get_request_detail(self, request_id: str) -> GetRequestResponse:
+        """
+        Retrieves detailed information about a specific request by its ID. This endpoint requires authentication with a bearer token and only returns requests belonging to the authenticated organization.
+
+        :param request_id: The ID of the request to be retrieved.
+        :return: Details of the GetRequestResponse successfully retrieved
+        """
+        try:
+            response = self.client.get(f"/requests/{request_id}", self.iam_client.get_custom_headers())
+            return GetRequestResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to retrieve request details for {request_id}: {e}")
+            return None
+
+
+    @handle_refresh_token
+    def get_requests(self, model_id: str) -> List[GetRequestResponse]:
+        """
+        Retrieves a list of requests submitted by the authenticated user for a specific model. This endpoint requires authentication with a bearer token and filters results by the authenticated organization.
+
+        :param model_id: The ID of the model to be retrieved.
+        :return: List of GetRequestResponse successfully retrieved
+        """
+        try:
+            response = self.client.get("/requests", self.iam_client.get_custom_headers(), {"model_id": model_id})
+            requests = response.get('requests', []) if response else []
+            return [GetRequestResponse.model_validate(req) for req in requests] if requests else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to retrieve requests for model {model_id}: {e}")
+            return None
+
+
+    @handle_refresh_token
+    def create_request(self, request: SubmitRequestRequest) -> SubmitRequestResponse:
+        """
+        Submits a new asynchronous request to process a specified model with provided parameters. This endpoint requires authentication with a bearer token.
+
+        :param request: The request data to be created by SubmitRequestRequest model.
+        :return: The created request data as SubmitRequestResponse model.
+        """
+        try:
+            response = self.client.post("/requests", self.iam_client.get_custom_headers(), request.model_dump())
+            return SubmitRequestResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to create request: {e}")
+            return None
+
+
+    @handle_refresh_token
+    def get_model_detail(self, model_id: str) -> GetModelResponse:
+        """
+        Retrieves detailed information about a specific model by its ID.
+
+        :param model_id: The ID of the model to be retrieved.
+        :return: Details of the GetModelResponse model successfully retrieved.
+        """
+        try:
+            response = self.client.get(f"/models/{model_id}", self.iam_client.get_custom_headers())
+            return GetModelResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to retrieve model details for {model_id}: {e}")
+            return None    
+    
+
+    @handle_refresh_token
+    def get_models(self) -> List[GetModelResponse]:
+        """
+        Retrieves a list of available models from the video service.
+
+        :return: A list of GetModelResponse model successfully retrieved.
+        """
+        try:
+            response = self.client.get("/models", self.iam_client.get_custom_headers())
+            models = response.get('models', []) if response else []
+            return [GetModelResponse.model_validate(model) for model in models] if models else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to retrieve models: {e}")
+            return None
+    
+

gmicloud/_internal/_config.py

@@ -1,3 +1,9 @@
-ARTIFACT_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1/ie/artifact"
-TASK_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1/ie/task"
-IAM_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1"
+# Dev environment
+# ARTIFACT_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1/ie/artifact"
+# TASK_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1/ie/task"
+# IAM_SERVICE_BASE_URL = "https://ce-tot.gmicloud-dev.com/api/v1"
+
+# Prod environment
+ARTIFACT_SERVICE_BASE_URL = "https://inference-engine.gmicloud.ai/api/v1/ie/artifact"
+TASK_SERVICE_BASE_URL = "https://inference-engine.gmicloud.ai/api/v1/ie/task"
+IAM_SERVICE_BASE_URL = "https://inference-engine.gmicloud.ai/api/v1"

gmicloud/_internal/_enums.py

@@ -24,6 +24,7 @@ class TaskEndpointStatus(str, Enum):
     UNREADY = "unready"
     NEW = "new"
 
+
 class TaskStatus(str, Enum):
     IDLE = "idle"
     STARTING = "starting"
@@ -32,7 +33,24 @@ class TaskStatus(str, Enum):
     NEEDSTOP = "needstop"
     ARCHIVED = "archived"
 
+
 class ModelParameterType(str, Enum):
     NUMERIC = "numeric"
     TEXT = "text"
-    BOOLEAN = "boolean"
+    BOOLEAN = "boolean"
+
+
+class RequestStatus(Enum):
+    CREATED = "created"
+    QUEUED = "queued"
+    DISPATCHED = "dispatched"
+    PROCESSING = "processing"
+    SUCCESS = "success"
+    FAILED = "failed"
+    CANCELLED = "cancelled"
+
+
+class HostType(Enum):
+    DEFAULT = ""
+    INTERNAL = "internal"
+    EXTERNAL = "external"