craft-ai-sdk 0.60.0__tar.gz → 0.61.0__tar.gz

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-ai-sdk
-Version: 0.60.0
+Version: 0.61.0
 Summary: Craft AI MLOps platform SDK
 Home-page: https://www.craft.ai/
 License: Apache-2.0

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/__init__.py

@@ -1,17 +1,16 @@
-from craft_ai_sdk.utils import CREATION_PARAMETER_VALUE  # noqa: F401
-from .sdk import CraftAiSdk  # noqa: F401
-from .exceptions import SdkException  # noqa: F401
 from .constants import (  # noqa: F401
+    CREATION_PARAMETER_VALUE,
     DEPLOYMENT_EXECUTION_RULES,
     DEPLOYMENT_MODES,
 )
+from .exceptions import SdkException  # noqa: F401
 from .io import (  # noqa: F401
     INPUT_OUTPUT_TYPES,
     Input,
-    Output,
     InputSource,
+    Output,
     OutputDestination,
 )
+from .sdk import CraftAiSdk  # noqa: F401
 
-
-__version__ = "0.60.0"
+__version__ = "0.61.0"

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/constants.py

@@ -1,4 +1,4 @@
-from enum import auto
+from enum import Enum, auto
 
 from strenum import LowercaseStrEnum
 
@@ -29,3 +29,13 @@ class DEPLOYMENT_STATUS(LowercaseStrEnum):
 
 
 CREATION_REQUESTS_RETRY_INTERVAL = 10
+
+
+class CREATION_PARAMETER_VALUE(Enum):
+    """Enumeration for creation parameters special values."""
+
+    #: Special value to indicate that the parameter should be set to the
+    #: project information value.
+    FALLBACK_PROJECT = "FALLBACK_PROJECT"
+    #: Special value to indicate that the parameter should be set to `None`.
+    NULL = "NULL"

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/data_store.py

@@ -1,14 +1,12 @@
 import io
-import requests
 import urllib.parse
+
+import requests
+
 from ..sdk import BaseCraftAiSdk
-from ..utils import (
-    chunk_buffer,
-    convert_size,
-    handle_data_store_response,
-    log_action,
-    log_func_result,
-)
+from ..shared.logger import log_action, log_func_result
+from ..shared.request_response_handler import handle_data_store_response
+from ..utils import chunk_buffer, convert_size
 
 
 def get_data_store_object_information(sdk: BaseCraftAiSdk, object_path_in_datastore):

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/deployments.py

@@ -1,18 +1,10 @@
-from ..constants import (
-    DEPLOYMENT_EXECUTION_RULES,
-    DEPLOYMENT_MODES,
-    DEPLOYMENT_STATUS,
-)
-from ..io import (
-    _validate_inputs_mapping,
-    _validate_outputs_mapping,
-)
-from ..sdk import BaseCraftAiSdk
+from ..constants import DEPLOYMENT_EXECUTION_RULES, DEPLOYMENT_MODES, DEPLOYMENT_STATUS
 from ..exceptions import SdkException
+from ..io import _validate_inputs_mapping, _validate_outputs_mapping
+from ..sdk import BaseCraftAiSdk
+from ..shared.logger import log_action, log_func_result
 from ..utils import (
-    _datetime_to_timestamp_in_ms,
-    log_func_result,
-    log_action,
+    datetime_to_timestamp_in_ms,
     remove_keys_from_dict,
     remove_none_values,
 )
@@ -660,9 +652,9 @@ def get_deployment_logs(
     url = f"{sdk.base_environment_api_url}/deployments/{deployment_name}/logs"
     data = {}
     if from_datetime is not None:
-        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+        data["from"] = datetime_to_timestamp_in_ms(from_datetime)
     if to_datetime is not None:
-        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+        data["to"] = datetime_to_timestamp_in_ms(to_datetime)
     if limit is not None:
         data["limit"] = limit
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/endpoints.py

@@ -1,9 +1,11 @@
 import io
-import requests
 from urllib.parse import urlencode
 
-from ..utils import log_func_result, handle_http_response
+import requests
+
 from ..sdk import BaseCraftAiSdk
+from ..shared.logger import log_func_result
+from ..shared.request_response_handler import handle_http_response
 from .deployments import get_deployment
 
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/environment_variables.py

@@ -1,5 +1,5 @@
 from ..sdk import BaseCraftAiSdk
-from ..utils import log_func_result
+from ..shared.logger import log_func_result
 
 
 @log_func_result("Environment variable definition")

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/pipeline_executions.py

@@ -1,23 +1,19 @@
-import json
 import io
-
+import json
 
 from ..exceptions import SdkException
 from ..io import (
     INPUT_OUTPUT_TYPES,
-    _format_execution_output,
     _format_execution_input,
+    _format_execution_output,
     _validate_inputs_mapping,
     _validate_outputs_mapping,
 )
 from ..sdk import BaseCraftAiSdk
-from ..utils import (
-    _datetime_to_timestamp_in_ms,
-    log_func_result,
-    log_action,
-    use_authentication,
-    handle_http_response,
-)
+from ..shared.authentication import use_authentication
+from ..shared.logger import log_action, log_func_result
+from ..shared.request_response_handler import handle_http_response
+from ..utils import datetime_to_timestamp_in_ms
 
 
 @log_func_result("Pipeline execution startup")
@@ -441,9 +437,9 @@ def get_pipeline_execution_logs(
 
     data = {}
     if from_datetime is not None:
-        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+        data["from"] = datetime_to_timestamp_in_ms(from_datetime)
     if to_datetime is not None:
-        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+        data["to"] = datetime_to_timestamp_in_ms(to_datetime)
     if limit is not None:
         data["limit"] = limit
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/pipeline_metrics.py

@@ -1,7 +1,9 @@
 import warnings
 
-from ..utils import log_func_result, remove_none_values, get_execution_id
 from ..sdk import BaseCraftAiSdk
+from ..shared.execution_context import get_execution_id
+from ..shared.logger import log_func_result
+from ..utils import remove_none_values
 
 
 @log_func_result("Pipeline metrics definition", get_execution_id)

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/pipelines.py

@@ -1,21 +1,17 @@
-import warnings
 import os
+import warnings
+
 import requests
 
 from ..sdk import BaseCraftAiSdk
-from ..utils import (
-    log_action,
-    log_func_result,
-    multipartify,
-    handle_data_store_response,
-    remove_keys_from_dict,
-    _datetime_to_timestamp_in_ms,
-    _wait_create_until_ready,
-)
+from ..shared.helpers import wait_create_until_ready
+from ..shared.logger import log_action, log_func_result
+from ..shared.request_response_handler import handle_data_store_response
+from ..utils import datetime_to_timestamp_in_ms, multipartify, remove_keys_from_dict
 from .steps import (
-    _validate_create_step_parameters,
     _prepare_create_step_data,
     _prepare_create_step_files,
+    _validate_create_step_parameters,
 )
 
 
@@ -313,7 +309,7 @@ def get_pipeline(
     """
     base_url = f"{sdk.base_environment_api_url}/pipelines/{pipeline_name}"
     if wait_for_completion:
-        pipeline = _wait_create_until_ready(
+        pipeline = wait_create_until_ready(
             sdk,
             pipeline_name,
             lambda sdk, _: sdk._get(
@@ -452,9 +448,9 @@ def get_pipeline_logs(
 
     data = {}
     if from_datetime is not None:
-        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+        data["from"] = datetime_to_timestamp_in_ms(from_datetime)
     if to_datetime is not None:
-        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+        data["to"] = datetime_to_timestamp_in_ms(to_datetime)
     if limit is not None:
         data["limit"] = limit
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/resource_metrics.py

@@ -1,5 +1,5 @@
 from ..sdk import BaseCraftAiSdk
-from ..utils import _datetime_to_timestamp_in_ms
+from ..utils import datetime_to_timestamp_in_ms
 
 
 def get_resource_metrics(sdk: BaseCraftAiSdk, start_date, end_date, csv=False):
@@ -48,8 +48,8 @@ def get_resource_metrics(sdk: BaseCraftAiSdk, start_date, end_date, csv=False):
 
     url = (
         f"{sdk.base_environment_api_url}/resource-metrics"
-        f"?start={_datetime_to_timestamp_in_ms(start_date)}"
-        f"&end={_datetime_to_timestamp_in_ms(end_date)}"
+        f"?start={datetime_to_timestamp_in_ms(start_date)}"
+        f"&end={datetime_to_timestamp_in_ms(end_date)}"
         f"&download={csv}"
     )
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/core/steps.py

@@ -1,20 +1,16 @@
-import tarfile
 import io
 import os
+import tarfile
+
 import requests
 
-from ..sdk import BaseCraftAiSdk
+from ..constants import CREATION_PARAMETER_VALUE
 from ..io import Input, Output
-from ..utils import (
-    log_func_result,
-    log_action,
-    map_container_config_step_parameter,
-    multipartify,
-    remove_none_values,
-    handle_data_store_response,
-    _datetime_to_timestamp_in_ms,
-    _wait_create_until_ready,
-)
+from ..sdk import BaseCraftAiSdk
+from ..shared.helpers import wait_create_until_ready
+from ..shared.logger import log_action, log_func_result
+from ..shared.request_response_handler import handle_data_store_response
+from ..utils import datetime_to_timestamp_in_ms, multipartify, remove_none_values
 
 
 def _compress_folder_to_memory(local_folder, include):
@@ -41,6 +37,25 @@ def _validate_create_step_parameters(inputs, outputs, timeout_s):
             raise ValueError("'outputs' must be a list of instances of Output.")
 
 
+def _map_container_config_step_parameter(container_config):
+    """
+    Maps container config with :obj:`CREATION_PARAMETER_VALUE` enum values to final
+    container config. `None` is considered to be equivalent to
+    :obj:`CREATION_PARAMETER_VALUE.FALLBACK_PROJECT`, and should not be projected to
+    output
+    """
+    ret = {}
+    for key in container_config:
+        if key == "local_folder":
+            continue
+        val = container_config[key]
+        if val is CREATION_PARAMETER_VALUE.NULL:
+            ret[key] = None
+        elif val is not CREATION_PARAMETER_VALUE.FALLBACK_PROJECT and val is not None:
+            ret[key] = val
+    return ret
+
+
 def _prepare_create_step_data(
     function_path,
     function_name,
@@ -59,7 +74,7 @@ def _prepare_create_step_data(
             "function_path": function_path,
             "function_name": function_name,
             "description": description,
-            "container_config": map_container_config_step_parameter(container_config),
+            "container_config": _map_container_config_step_parameter(container_config),
         }
     )
 
@@ -361,7 +376,7 @@ def get_step(sdk: BaseCraftAiSdk, step_name, wait_for_completion=False, timeout_
     base_url = f"{sdk.base_environment_api_url}/steps/{step_name}"
 
     if wait_for_completion:
-        step = _wait_create_until_ready(
+        step = wait_create_until_ready(
             sdk,
             step_name,
             lambda sdk, _: sdk._get(
@@ -479,9 +494,9 @@ def get_step_logs(
 
     data = {}
     if from_datetime is not None:
-        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+        data["from"] = datetime_to_timestamp_in_ms(from_datetime)
     if to_datetime is not None:
-        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+        data["to"] = datetime_to_timestamp_in_ms(to_datetime)
     if limit is not None:
         data["limit"] = limit
 

craft_ai_sdk-0.61.0/craft_ai_sdk/core/vector_database.py

@@ -0,0 +1,21 @@
+from craft_ai_sdk.shared.environments import get_environment_id
+
+from ..sdk import BaseCraftAiSdk
+
+
+def get_vector_database_credentials(sdk: BaseCraftAiSdk):
+    """Get the credentials of the vector database.
+
+    Returns:
+        :obj:`dict`: The vector database credentials, with the following keys:
+            * ``"vector_database_url"`` (:obj:`str`): URL of the vector database.
+            * ``"vector_database_token"`` (:obj:`str`): Token to connect to the vector
+              database.
+    """
+    environment_id = get_environment_id(sdk)
+
+    vector_database_url = (
+        f"{sdk.base_control_api_url}/environments/{environment_id}/vector-database"
+    )
+
+    return sdk._get(vector_database_url)

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/io.py

@@ -1,6 +1,7 @@
 import warnings
 
 from strenum import LowercaseStrEnum
+
 from craft_ai_sdk.utils import remove_none_values
 
 

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/craft_ai_sdk/sdk.py

@@ -8,7 +8,8 @@ from datetime import timedelta
 import jwt
 import requests
 
-from .utils import handle_http_request, use_authentication
+from .shared.authentication import use_authentication
+from .shared.request_response_handler import handle_http_request
 
 warnings.simplefilter("always", DeprecationWarning)
 
@@ -20,6 +21,7 @@ class BaseCraftAiSdk(ABC):
     base_control_api_url: str
     _MULTIPART_THRESHOLD: int
     _MULTIPART_PART_SIZE: int
+    _version: str
 
     @abstractmethod
     def _get(self, url, params=None, **kwargs):
@@ -114,6 +116,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         list_steps,
     )
     from .core.users import get_user
+    from .core.vector_database import get_vector_database_credentials
 
     # Size (in bytes) from which datastore upload will switch to multipart
     # AWS: minimum part size is 5MiB
@@ -129,7 +132,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         os.environ.get("CRAFT_AI__MULTIPART_PART_SIZE__B", str(38 * 256 * 1024))
     )
     _access_token_margin = timedelta(seconds=30)
-    _version = "0.60.0"  # Would be better to share it somewhere
+    _version = "0.61.0"  # Would be better to share it somewhere
 
     def __init__(
         self,

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/authentication.py

@@ -0,0 +1,24 @@
+import functools
+from datetime import datetime
+
+
+def use_authentication(action_func):
+    @functools.wraps(action_func)
+    def wrapper(sdk, *args, headers=None, **kwargs):
+        actual_headers = None
+        if (
+            sdk._access_token_data is None
+            or sdk._access_token_data["exp"]
+            < (datetime.now() + sdk._access_token_margin).timestamp()
+        ):
+            sdk._refresh_access_token()
+        actual_headers = {"Authorization": f"Bearer {sdk._access_token}"}
+        if headers is not None:
+            actual_headers.update(headers)
+
+        response = action_func(sdk, *args, headers=actual_headers, **kwargs)
+        if response.status_code == 401:
+            sdk._clear_access_token()
+        return response
+
+    return wrapper

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/environments.py

@@ -0,0 +1,16 @@
+import requests
+
+from craft_ai_sdk.sdk import BaseCraftAiSdk
+from craft_ai_sdk.shared.request_response_handler import handle_http_response
+
+
+def get_environment_id(sdk: BaseCraftAiSdk):
+    health_url = f"{sdk.base_environment_api_url}/health"
+    health_result = requests.get(
+        health_url,
+        headers={
+            "craft-ai-client": f"craft-ai-sdk@{sdk._version}",
+        },
+    )
+    handle_http_response(health_result)
+    return health_result.json().get("environment_id", "")

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/execution_context.py

@@ -0,0 +1,21 @@
+import os
+
+_execution_context = None
+
+
+def get_execution_id():
+    global _execution_context
+    if _execution_context is None:
+        try:
+            # File injected in steps
+            import __craft_internal_execution_context  # type: ignore
+
+            _execution_context = __craft_internal_execution_context
+        except ImportError:
+            _execution_context = False
+    if _execution_context:
+        try:
+            return _execution_context.current_execution_id.get()
+        except LookupError:
+            pass
+    return os.environ.get("CRAFT_AI_EXECUTION_ID")

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/helpers.py

@@ -0,0 +1,27 @@
+from craft_ai_sdk.exceptions import SdkException
+
+
+def wait_create_until_ready(sdk, name, get_func, timeout_s, start_time, get_log_func):
+    elapsed_time = sdk._get_time() - start_time
+    status = "creation_pending"
+    while status == "creation_pending" and (
+        timeout_s is None or elapsed_time < timeout_s
+    ):
+        created_obj = get_func(sdk, name)
+        status = created_obj.get("creation_info", {}).get("status", None)
+        elapsed_time = sdk._get_time() - start_time
+
+    if status == "creation_failed":
+        raise SdkException(
+            f'The creation of "{name}" has failed. You can check the logs with '
+            f'the "{get_log_func.__name__}" function.',
+            name="CreationFailed",
+        )
+    if status != "ready":
+        raise SdkException(
+            f'The creation of "{name}" was not ready in time. It is still being '
+            "created but this function stopped trying. Please check its status with "
+            f'"{get_func.__name__}".',
+            name="TimeoutException",
+        )
+    return created_obj

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/logger.py

@@ -0,0 +1,39 @@
+import functools
+import sys
+from typing import Callable, Union
+
+from craft_ai_sdk.exceptions import SdkException
+
+
+def log_action(sdk, message: str, should_log: Union[bool, Callable[[], bool]] = True):
+    if sdk.verbose_log and (should_log() if callable(should_log) else should_log):
+        print(message, file=sys.stderr)
+
+
+def log_func_result(message: str, should_log: Union[bool, Callable[[], bool]] = True):
+    def decorator_log_func_result(action_func):
+        @functools.wraps(action_func)
+        def wrapper_log_func_result(*args, **kwargs):
+            sdk = args[0]
+            try:
+                res = action_func(*args, **kwargs)
+                log_action(sdk, "{:s} succeeded".format(message), should_log)
+                return res
+            except SdkException as error:
+                log_action(
+                    sdk,
+                    "{:s} failed ! {}".format(message, error),
+                    should_log,
+                )
+                raise error
+            except Exception as error:
+                log_action(
+                    sdk,
+                    "{:s} failed for unexpected reason ! {}".format(message, error),
+                    should_log,
+                )
+                raise error
+
+        return wrapper_log_func_result
+
+    return decorator_log_func_result

craft_ai_sdk-0.61.0/craft_ai_sdk/shared/request_response_handler.py

@@ -0,0 +1,113 @@
+import xml.etree.ElementTree as ET
+from json import JSONDecodeError
+
+from requests import RequestException, Response
+
+from craft_ai_sdk.exceptions import SdkException
+from craft_ai_sdk.shared.execution_context import get_execution_id
+
+
+def handle_data_store_response(response):
+    """Return the content of a response received from the datastore
+    or parse the send error and raise it.
+
+    Args:
+        response (requests.Response): A response from the data store.
+
+    Raises:
+        SdkException: When the response contains an error.
+
+    Returns:
+        :obj:`str`: Content of the response.
+    """
+    if 200 <= response.status_code < 300:
+        return response.content
+
+    try:
+        # Parse XML error returned by the data store before raising it
+        xml_error_node = ET.fromstring(response.text)
+        error_infos = {node.tag: node.text for node in xml_error_node}
+        error_code = error_infos.pop("Code")
+        error_message = error_infos.pop("Message")
+        raise SdkException(
+            message=error_message,
+            status_code=response.status_code,
+            name=error_code,
+            additional_data=error_infos,
+        )
+    except ET.ParseError:
+        raise SdkException(
+            "Unable to decode response from the data store: "
+            f"Content being:\n'{response.text}'",
+            status_code=response.status_code,
+        )
+
+
+def _parse_json_response(response):
+    if response.status_code == 204 or response.text == "OK":
+        return
+    try:
+        response_json = response.json()
+    except JSONDecodeError:
+        raise SdkException(
+            f"Unable to decode response data into json. Data being:\n'{response.text}'",
+            status_code=response.status_code,
+        ) from None
+    return response_json
+
+
+def _raise_craft_ai_error_from_response(response: Response):
+    try:
+        error_content = response.json()
+        error_message = error_content.get("message", "The server returned an error")
+
+        # Permission denied inside a running execution
+        if response.status_code == 403 and get_execution_id() is not None:
+            error_message = (
+                "Insufficient permissions. This is probably because "
+                "you called an SDK function that is not permitted from "
+                "inside a running deployment or execution, even if it "
+                "works from your computer. Original error: " + error_message
+            )
+
+        raise SdkException(
+            message=error_message,
+            status_code=response.status_code,
+            name=error_content.get("name"),
+            request_id=error_content.get("request_id"),
+            additional_data=error_content.get("additional_data"),
+        )
+    except JSONDecodeError:
+        raise SdkException(
+            "The server returned an invalid response content. "
+            f"Content being:\n'{response.text}'",
+            status_code=response.status_code,
+        ) from None
+
+
+def handle_http_response(response: Response):
+    if 200 <= response.status_code < 400:
+        if "application/octet-stream" in response.headers.get(
+            "content-type", ""
+        ) or "text/csv" in response.headers.get("content-type", ""):
+            return response.content
+        return _parse_json_response(response)
+    _raise_craft_ai_error_from_response(response)
+
+
+def handle_http_request(request_func):
+    def wrapper(*args, **kwargs):
+        get_response = kwargs.pop("get_response", False)
+        try:
+            response = request_func(*args, **kwargs)
+        except RequestException as error:
+            raise SdkException(
+                "Unable to perform the request", name="RequestError"
+            ) from error
+
+        content = handle_http_response(response)
+        if get_response:
+            return content, response
+        return content
+
+    return wrapper

craft_ai_sdk-0.61.0/craft_ai_sdk/utils/__init__.py

@@ -0,0 +1,14 @@
+from .datetime_utils import datetime_to_timestamp_in_ms, parse_isodate
+from .dict_utils import remove_keys_from_dict, remove_none_values
+from .file_utils import chunk_buffer, convert_size, merge_paths, multipartify
+
+__all__ = [
+    "datetime_to_timestamp_in_ms",
+    "parse_isodate",
+    "remove_keys_from_dict",
+    "remove_none_values",
+    "merge_paths",
+    "multipartify",
+    "chunk_buffer",
+    "convert_size",
+]

craft_ai_sdk-0.61.0/craft_ai_sdk/utils/datetime_utils.py

@@ -0,0 +1,24 @@
+import re
+from datetime import datetime
+
+
+def datetime_to_timestamp_in_ms(dt):
+    if not isinstance(dt, datetime):
+        raise ValueError("Parameter must be a datetime.datetime object.")
+    return int(1_000 * dt.timestamp())
+
+
+def parse_isodate(date_string):
+    """_summary_
+
+    Args:
+        date_string (str): date in ISO 8601 format potentially ending with
+            "Z" specific character.
+
+    Returns:
+        :obj:`datetime.datetime`: A `datetime` corresponding to `date_string`.
+    """
+    if date_string[-1] == "Z":
+        date_string = date_string.rstrip("Z")
+
+    return datetime.fromisoformat(re.sub(r"\.\d+", "", date_string))

craft_ai_sdk-0.61.0/craft_ai_sdk/utils/dict_utils.py

@@ -0,0 +1,24 @@
+from typing import Union
+
+
+def remove_none_values(obj):
+    return {key: value for key, value in obj.items() if value is not None}
+
+
+def remove_keys_from_dict(dictionnary: dict, paths_to_remove: Union[set, None] = None):
+    if dictionnary is None:
+        return None
+
+    paths_to_remove = paths_to_remove or set()
+    returned_dictionnary = dictionnary.copy()
+
+    for path in paths_to_remove:
+        key, _, subpath = path.partition(".")
+        if subpath == "":
+            returned_dictionnary.pop(key, None)
+        elif isinstance(returned_dictionnary.get(key), dict):
+            returned_dictionnary[key] = remove_keys_from_dict(
+                returned_dictionnary[key], {subpath}
+            )
+
+    return returned_dictionnary

craft_ai_sdk-0.61.0/craft_ai_sdk/utils/file_utils.py

@@ -0,0 +1,69 @@
+from io import BytesIO, IOBase, StringIO
+from typing import Iterable, Union
+
+
+def merge_paths(prefix, path):
+    components = (value for value in path.split("/") if value != "")
+    return prefix + "/".join(components)
+
+
+# From https://stackoverflow.com/a/58767245/4839162
+def chunk_buffer(buffer: IOBase, size: int) -> Iterable[Union[BytesIO, StringIO]]:
+    size_int = int(size)
+    b = buffer.read(size_int)
+    next_data = None
+    while b:
+        chunk = StringIO() if isinstance(b, str) else BytesIO()
+        previous_data = next_data
+        if previous_data:
+            chunk.write(next_data)
+        chunk.write(b)
+        chunk.seek(0)
+
+        next_data = buffer.read(1)
+
+        data = {
+            "chunk": chunk,
+            "len": len(b) + (len(previous_data) if previous_data else 0),
+            "lastChunk": len(next_data) == 0,
+        }
+        yield data
+        chunk.close()
+        b = buffer.read(size_int - 1)
+
+
+def convert_size(size_in_bytes):
+    """
+    Convert a size in bytes to a human readable string.
+    """
+    units = ["B", "KB", "MB", "GB", "TB"]
+    for unit in units:
+        if size_in_bytes < 1024.0:
+            break
+        size_in_bytes /= 1024.0
+    return "{:.2f} {}".format(size_in_bytes, unit)
+
+
+# Adapted from
+# https://gist.github.com/kazqvaizer/4cebebe5db654a414132809f9f88067b#file-multipartify-py-L13-L33
+def multipartify(data, parent_key=None) -> dict:
+    def formatter(v):
+        return (None, v if v is not None else "")
+
+    if type(data) is not dict:
+        return {parent_key: formatter(data)}
+
+    converted = []
+
+    for key, value in data.items():
+        current_key = key if parent_key is None else f"{parent_key}[{key}]"
+        if type(value) is dict:
+            converted.extend(multipartify(value, current_key).items())
+        elif type(value) is list:
+            for ind, list_value in enumerate(value):
+                iter_key = f"{current_key}[{ind}]"
+                converted.extend(multipartify(list_value, iter_key).items())
+        else:
+            converted.append((current_key, formatter(value)))
+
+    return dict(converted)

{craft_ai_sdk-0.60.0 → craft_ai_sdk-0.61.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "craft-ai-sdk"
-version = "0.60.0"
+version = "0.61.0"
 description = "Craft AI MLOps platform SDK"
 license = "Apache-2.0"
 authors = ["Craft AI <contact@craft.ai>"]

craft_ai_sdk-0.60.0/craft_ai_sdk/utils.py

@@ -1,362 +0,0 @@
-from datetime import datetime
-from enum import Enum
-import functools
-from io import BytesIO, IOBase, StringIO
-import re
-import sys
-from typing import Callable, Iterable, Union
-import xml.etree.ElementTree as ET
-from requests import RequestException, Response
-from json import JSONDecodeError
-import os
-
-from .exceptions import SdkException
-
-_execution_context = None
-
-
-def get_execution_id():
-    global _execution_context
-    if _execution_context is None:
-        try:
-            # File injected in steps
-            import __craft_internal_execution_context  # type: ignore
-
-            _execution_context = __craft_internal_execution_context
-        except ImportError:
-            _execution_context = False
-    if _execution_context:
-        try:
-            return _execution_context.current_execution_id.get()
-        except LookupError:
-            pass
-    return os.environ.get("CRAFT_AI_EXECUTION_ID")
-
-
-def handle_data_store_response(response):
-    """Return the content of a response received from the datastore
-    or parse the send error and raise it.
-
-    Args:
-        response (requests.Response): A response from the data store.
-
-    Raises:
-        SdkException: When the response contains an error.
-
-    Returns:
-        :obj:`str`: Content of the response.
-    """
-    if 200 <= response.status_code < 300:
-        return response.content
-
-    try:
-        # Parse XML error returned by the data store before raising it
-        xml_error_node = ET.fromstring(response.text)
-        error_infos = {node.tag: node.text for node in xml_error_node}
-        error_code = error_infos.pop("Code")
-        error_message = error_infos.pop("Message")
-        raise SdkException(
-            message=error_message,
-            status_code=response.status_code,
-            name=error_code,
-            additional_data=error_infos,
-        )
-    except ET.ParseError:
-        raise SdkException(
-            "Unable to decode response from the data store: "
-            f"Content being:\n'{response.text}'",
-            status_code=response.status_code,
-        )
-
-
-def _parse_json_response(response):
-    if response.status_code == 204 or response.text == "OK":
-        return
-    try:
-        response_json = response.json()
-    except JSONDecodeError:
-        raise SdkException(
-            f"Unable to decode response data into json. Data being:\n'{response.text}'",
-            status_code=response.status_code,
-        ) from None
-    return response_json
-
-
-def _raise_craft_ai_error_from_response(response: Response):
-    try:
-        error_content = response.json()
-        error_message = error_content.get("message", "The server returned an error")
-
-        # Permission denied inside a running execution
-        if response.status_code == 403 and get_execution_id() is not None:
-            error_message = (
-                "Insufficient permissions. This is probably because "
-                "you called an SDK function that is not permitted from "
-                "inside a running deployment or execution, even if it "
-                "works from your computer. Original error: " + error_message
-            )
-
-        raise SdkException(
-            message=error_message,
-            status_code=response.status_code,
-            name=error_content.get("name"),
-            request_id=error_content.get("request_id"),
-            additional_data=error_content.get("additional_data"),
-        )
-    except JSONDecodeError:
-        raise SdkException(
-            "The server returned an invalid response content. "
-            f"Content being:\n'{response.text}'",
-            status_code=response.status_code,
-        ) from None
-
-
-def handle_http_response(response: Response):
-    if 200 <= response.status_code < 400:
-        if "application/octet-stream" in response.headers.get(
-            "content-type", ""
-        ) or "text/csv" in response.headers.get("content-type", ""):
-            return response.content
-        return _parse_json_response(response)
-    _raise_craft_ai_error_from_response(response)
-
-
-def handle_http_request(request_func):
-    def wrapper(*args, **kwargs):
-        get_response = kwargs.pop("get_response", False)
-        try:
-            response = request_func(*args, **kwargs)
-        except RequestException as error:
-            raise SdkException(
-                "Unable to perform the request", name="RequestError"
-            ) from error
-
-        content = handle_http_response(response)
-        if get_response:
-            return content, response
-        return content
-
-    return wrapper
-
-
-def log_action(sdk, message: str, should_log: Union[bool, Callable[[], bool]] = True):
-    if sdk.verbose_log and (should_log() if callable(should_log) else should_log):
-        print(message, file=sys.stderr)
-
-
-def log_func_result(message: str, should_log: Union[bool, Callable[[], bool]] = True):
-    def decorator_log_func_result(action_func):
-        @functools.wraps(action_func)
-        def wrapper_log_func_result(*args, **kwargs):
-            sdk = args[0]
-            try:
-                res = action_func(*args, **kwargs)
-                log_action(sdk, "{:s} succeeded".format(message), should_log)
-                return res
-            except SdkException as error:
-                log_action(
-                    sdk,
-                    "{:s} failed ! {}".format(message, error),
-                    should_log,
-                )
-                raise error
-            except Exception as error:
-                log_action(
-                    sdk,
-                    "{:s} failed for unexpected reason ! {}".format(message, error),
-                    should_log,
-                )
-                raise error
-
-        return wrapper_log_func_result
-
-    return decorator_log_func_result
-
-
-def _datetime_to_timestamp_in_ms(dt):
-    if not isinstance(dt, datetime):
-        raise ValueError("Parameter must be a datetime.datetime object.")
-    return int(1_000 * dt.timestamp())
-
-
-def parse_isodate(date_string):
-    """_summary_
-
-    Args:
-        date_string (str): date in ISO 8601 format potentially ending with
-            "Z" specific character.
-
-    Returns:
-        :obj:`datetime.datetime`: A `datetime` corresponding to `date_string`.
-    """
-    if date_string[-1] == "Z":
-        date_string = date_string.rstrip("Z")
-
-    return datetime.fromisoformat(re.sub(r"\.\d+", "", date_string))
-
-
-def use_authentication(action_func):
-    @functools.wraps(action_func)
-    def wrapper(sdk, *args, headers=None, **kwargs):
-        actual_headers = None
-        if (
-            sdk._access_token_data is None
-            or sdk._access_token_data["exp"]
-            < (datetime.now() + sdk._access_token_margin).timestamp()
-        ):
-            sdk._refresh_access_token()
-        actual_headers = {"Authorization": f"Bearer {sdk._access_token}"}
-        if headers is not None:
-            actual_headers.update(headers)
-
-        response = action_func(sdk, *args, headers=actual_headers, **kwargs)
-        if response.status_code == 401:
-            sdk._clear_access_token()
-        return response
-
-    return wrapper
-
-
-def remove_none_values(obj):
-    return {key: value for key, value in obj.items() if value is not None}
-
-
-def remove_keys_from_dict(dictionnary: dict, paths_to_remove: set = None):
-    if dictionnary is None:
-        return None
-
-    paths_to_remove = paths_to_remove or set()
-    returned_dictionnary = dictionnary.copy()
-
-    for path in paths_to_remove:
-        key, _, subpath = path.partition(".")
-        if subpath == "":
-            returned_dictionnary.pop(key, None)
-        elif isinstance(returned_dictionnary.get(key), dict):
-            returned_dictionnary[key] = remove_keys_from_dict(
-                returned_dictionnary[key], {subpath}
-            )
-
-    return returned_dictionnary
-
-
-def merge_paths(prefix, path):
-    components = (value for value in path.split("/") if value != "")
-    return prefix + "/".join(components)
-
-
-class CREATION_PARAMETER_VALUE(Enum):
-    """Enumeration for creation parameters special values."""
-
-    #: Special value to indicate that the parameter should be set to the
-    #: project information value.
-    FALLBACK_PROJECT = "FALLBACK_PROJECT"
-    #: Special value to indicate that the parameter should be set to `None`.
-    NULL = "NULL"
-
-
-def map_container_config_step_parameter(container_config):
-    """
-    Maps container config with :obj:`CREATION_PARAMETER_VALUE` enum values to final
-    container config. `None` is considered to be equivalent to
-    :obj:`CREATION_PARAMETER_VALUE.FALLBACK_PROJECT`, and should not be projected to
-    output
-    """
-    ret = {}
-    for key in container_config:
-        if key == "local_folder":
-            continue
-        val = container_config[key]
-        if val is CREATION_PARAMETER_VALUE.NULL:
-            ret[key] = None
-        elif val is not CREATION_PARAMETER_VALUE.FALLBACK_PROJECT and val is not None:
-            ret[key] = val
-    return ret
-
-
-# From https://stackoverflow.com/a/58767245/4839162
-def chunk_buffer(buffer: IOBase, size: int) -> Iterable[Union[BytesIO, StringIO]]:
-    size_int = int(size)
-    b = buffer.read(size_int)
-    next_data = None
-    while b:
-        chunk = StringIO() if isinstance(b, str) else BytesIO()
-        previous_data = next_data
-        if previous_data:
-            chunk.write(next_data)
-        chunk.write(b)
-        chunk.seek(0)
-
-        next_data = buffer.read(1)
-
-        data = {
-            "chunk": chunk,
-            "len": len(b) + (len(previous_data) if previous_data else 0),
-            "lastChunk": len(next_data) == 0,
-        }
-        yield data
-        chunk.close()
-        b = buffer.read(size_int - 1)
-
-
-def convert_size(size_in_bytes):
-    """
-    Convert a size in bytes to a human readable string.
-    """
-    units = ["B", "KB", "MB", "GB", "TB"]
-    for unit in units:
-        if size_in_bytes < 1024.0:
-            break
-        size_in_bytes /= 1024.0
-    return "{:.2f} {}".format(size_in_bytes, unit)
-
-
-# Adapted from
-# https://gist.github.com/kazqvaizer/4cebebe5db654a414132809f9f88067b#file-multipartify-py-L13-L33
-def multipartify(data, parent_key=None) -> dict:
-    def formatter(v):
-        return (None, v if v is not None else "")
-
-    if type(data) is not dict:
-        return {parent_key: formatter(data)}
-
-    converted = []
-
-    for key, value in data.items():
-        current_key = key if parent_key is None else f"{parent_key}[{key}]"
-        if type(value) is dict:
-            converted.extend(multipartify(value, current_key).items())
-        elif type(value) is list:
-            for ind, list_value in enumerate(value):
-                iter_key = f"{current_key}[{ind}]"
-                converted.extend(multipartify(list_value, iter_key).items())
-        else:
-            converted.append((current_key, formatter(value)))
-
-    return dict(converted)
-
-
-def _wait_create_until_ready(sdk, name, get_func, timeout_s, start_time, get_log_func):
-    elapsed_time = sdk._get_time() - start_time
-    status = "creation_pending"
-    while status == "creation_pending" and (
-        timeout_s is None or elapsed_time < timeout_s
-    ):
-        created_obj = get_func(sdk, name)
-        status = created_obj.get("creation_info", {}).get("status", None)
-        elapsed_time = sdk._get_time() - start_time
-
-    if status == "creation_failed":
-        raise SdkException(
-            f'The creation of "{name}" has failed. You can check the logs with '
-            f'the "{get_log_func.__name__}" function.',
-            name="CreationFailed",
-        )
-    if status != "ready":
-        raise SdkException(
-            f'The creation of "{name}" was not ready in time. It is still being '
-            "created but this function stopped trying. Please check its status with "
-            f'"{get_func.__name__}".',
-            name="TimeoutException",
-        )
-    return created_obj

{craft_ai_sdk-0.60.0/craft_ai_sdk → craft_ai_sdk-0.61.0/craft_ai_sdk/shared}/warnings.py

@@ -1,6 +1,6 @@
-from enum import Enum
-import warnings
 import functools
+import warnings
+from enum import Enum
 
 WARNING_PREFIX = "\n\n    Warning:\n            "