craft-ai-sdk 0.50.1rc1__py3-none-any.whl → 0.51.0__py3-none-any.whl

craft_ai_sdk/__init__.py

@@ -14,4 +14,4 @@ from .io import (  # noqa: F401
 )
 
 
-__version__ = "0.50.1rc1"
+__version__ = "0.51.0"

craft_ai_sdk/core/pipeline_metrics.py

@@ -1,29 +1,8 @@
-import os
 import warnings
 
-from ..utils import log_func_result, remove_none_values
+from ..utils import log_func_result, remove_none_values, get_execution_id
 from ..sdk import BaseCraftAiSdk
 
-_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")
-
 
 @log_func_result("Pipeline metrics definition", get_execution_id)
 def record_metric_value(sdk: BaseCraftAiSdk, name, value):

craft_ai_sdk/core/pipelines.py

@@ -10,6 +10,7 @@ from ..utils import (
     multipartify,
     handle_data_store_response,
     remove_keys_from_dict,
+    _datetime_to_timestamp_in_ms,
 )
 from .steps import (
     _add_inputs_outputs_in_message,
@@ -219,7 +220,7 @@ def create_pipeline(
         outputs,
         pipeline_name=pipeline_name,
     )
-    files = _prepare_create_step_files(container_config, data, function_path)
+    files = _prepare_create_step_files(sdk, container_config, data, function_path)
 
     log_action(
         sdk,
@@ -414,3 +415,47 @@ def download_pipeline_local_folder(sdk: BaseCraftAiSdk, pipeline_name, folder):
             f.write(object_content)
     else:
         raise ValueError("'folder' must be a string")
+
+
+@log_func_result("Pipeline logs")
+def get_pipeline_logs(
+    sdk: BaseCraftAiSdk,
+    pipeline_name,
+    from_datetime=None,
+    to_datetime=None,
+    limit=None,
+):
+    """Get the logs of a pipeline.
+
+    Args:
+        pipeline_name (:obj:`str`): Name of the pipeline.
+        from_datetime (:obj:`datetime.time`, optional): Datetime from which the logs
+            are collected.
+        to_datetime (:obj:`datetime.time`, optional): Datetime until which the logs
+            are collected.
+        limit (:obj:`int`, optional): Maximum number of logs that are collected.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of collected logs represented as dict with
+        the following keys:
+
+        * ``"timestamp"`` (:obj:`str`): Timestamp of the log.
+        * ``"message"`` (:obj:`str`): Log message.
+    """
+    url = f"{sdk.base_environment_api_url}/pipelines/{pipeline_name}/logs"
+
+    data = {}
+    if from_datetime is not None:
+        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+    if to_datetime is not None:
+        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+    if limit is not None:
+        data["limit"] = limit
+
+    log_action(
+        sdk,
+        "Please wait while logs are being fetched. This may take a while...",
+    )
+    logs = sdk._post(url, json=data)
+
+    return logs

craft_ai_sdk/core/steps.py

@@ -14,6 +14,7 @@ from ..utils import (
     multipartify,
     remove_none_values,
     handle_data_store_response,
+    _datetime_to_timestamp_in_ms,
 )
 from ..constants import CREATION_REQUESTS_RETRY_INTERVAL
 
@@ -73,17 +74,30 @@ def _prepare_create_step_data(
     return data
 
 
-def _prepare_create_step_files(container_config, data, function_path):
-    files = {}
-    if container_config.get("local_folder") is not None:
-        included = list(data.get("container_config", {}).get("included_folders", ["/"]))
-        included.append(data.get("container_config", {}).get("requirements_path"))
-        included.append(function_path)
-        tar_data = _compress_folder_to_memory(
-            container_config["local_folder"], include=list(filter(None, included))
-        )
-        files["step_file"] = tar_data
-    return files
+def _prepare_create_step_files(sdk, container_config, data, function_path):
+    if "local_folder" not in container_config:
+        return {}
+
+    url = f"{sdk.base_environment_api_url}/project-information"
+    project_information = sdk._get(url)
+
+    included = [
+        *(
+            data.get("container_config", {}).get(
+                "included_folders", project_information.get("included_folders")
+            )
+            or []
+        ),
+        data.get("container_config", {}).get(
+            "requirements_path", project_information.get("requirements_path")
+        ),
+        function_path,
+    ]
+
+    tar_data = _compress_folder_to_memory(
+        container_config["local_folder"], include=list(filter(None, included))
+    )
+    return {"step_file": tar_data}
 
 
 def _add_inputs_outputs_in_message(message, inputs, outputs):
@@ -286,7 +300,7 @@ def create_step(
         outputs,
         step_name=step_name,
     )
-    files = _prepare_create_step_files(container_config, data, function_path)
+    files = _prepare_create_step_files(sdk, container_config, data, function_path)
 
     log_action(
         sdk,
@@ -403,15 +417,6 @@ def list_steps(sdk: BaseCraftAiSdk):
         * ``"step_name"`` (:obj:`str`): Name of the step.
         * ``"status"`` (:obj:`str`): either ``"creation_pending"`` or ``"ready"``.
         * ``"created_at"`` (:obj:`str`): The creation date in ISO format.
-        * ``"updated_at"`` (:obj:`str`): The last update date in ISO format.
-        * ``"repository_branch"`` (:obj:`str`): The branch of the
-          repository where the step was built.
-        * ``"repository_url"`` (:obj:`str`): The url of the repository
-          where the step was built.
-        * ``"commit_id"`` (:obj:`str`): The commit id on which the step was
-          built.
-        * ``"origin"`` (:obj:`str`): The origin of the step, can be
-          ``"git_repository"`` or ``"local"``.
     """
     url = f"{sdk.base_environment_api_url}/steps"
 
@@ -474,3 +479,47 @@ def download_step_local_folder(sdk: BaseCraftAiSdk, step_name, folder):
             f.write(object_content)
     else:
         raise ValueError("'folder' must be a string")
+
+
+@log_func_result("Step logs")
+def get_step_logs(
+    sdk: BaseCraftAiSdk,
+    step_name,
+    from_datetime=None,
+    to_datetime=None,
+    limit=None,
+):
+    """Get the logs of a step.
+
+    Args:
+        step_name (:obj:`str`): Name of the step.
+        from_datetime (:obj:`datetime.time`, optional): Datetime from which the logs
+            are collected.
+        to_datetime (:obj:`datetime.time`, optional): Datetime until which the logs
+            are collected.
+        limit (:obj:`int`, optional): Maximum number of logs that are collected.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of collected logs represented as dict with
+        the following keys:
+
+        * ``"timestamp"`` (:obj:`str`): Timestamp of the log.
+        * ``"message"`` (:obj:`str`): Log message.
+    """
+    url = f"{sdk.base_environment_api_url}/steps/{step_name}/logs"
+
+    data = {}
+    if from_datetime is not None:
+        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+    if to_datetime is not None:
+        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+    if limit is not None:
+        data["limit"] = limit
+
+    log_action(
+        sdk,
+        "Please wait while logs are being fetched. This may take a while...",
+    )
+    logs = sdk._post(url, json=data)
+
+    return logs

craft_ai_sdk/sdk.py

@@ -59,6 +59,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         list_steps,
         delete_step,
         download_step_local_folder,
+        get_step_logs,
     )
     from .core.pipelines import (
         create_pipeline,
@@ -66,6 +67,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         list_pipelines,
         delete_pipeline,
         download_pipeline_local_folder,
+        get_pipeline_logs,
     )
     from .core.pipeline_executions import (
         run_pipeline,
@@ -128,7 +130,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.50.1rc1"  # Would be better to share it somewhere
+    _version = "0.51.0"  # Would be better to share it somewhere
 
     def __init__(
         self,

craft_ai_sdk/utils.py

@@ -8,9 +8,30 @@ 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
@@ -64,8 +85,19 @@ def _parse_json_response(response):
 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_content.get("message", "The server returned an error"),
+            message=error_message,
             status_code=response.status_code,
             name=error_content.get("name"),
             request_id=error_content.get("request_id"),

{craft_ai_sdk-0.50.1rc1.dist-info → craft_ai_sdk-0.51.0.dist-info}/METADATA

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

craft_ai_sdk-0.51.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+craft_ai_sdk/__init__.py,sha256=qg_JDJYK4OgWeyWNOpo9HXcld5y9QJ-iN1LF26Y9590,404
+craft_ai_sdk/constants.py,sha256=KHRaIHA9tHxjwluo7zBF2UZpePQaDI57SrBs4Ob1g7Q,607
+craft_ai_sdk/core/data_store.py,sha256=kI0nUIXfkz-9ENVEeFW70_PGhBNB_S-nntJJkKhGRoQ,8464
+craft_ai_sdk/core/deployments.py,sha256=p717fy73OoynUuDKO6XYLfLu5stBHH73xQw6HLm8jUY,25804
+craft_ai_sdk/core/endpoints.py,sha256=ElVcjnrjWD4_Wo5fOwRh1apUuL5IB7DM-FMH-1poP9w,4563
+craft_ai_sdk/core/environment_variables.py,sha256=wy0U7y0C7tRXOXOiWGz0vX5ajHSmOb_7J1fXlSahGpI,2045
+craft_ai_sdk/core/pipeline_executions.py,sha256=7RRKQUxXUCI871mmFCO4N4RG0RvX5MZ3Fss3doCb8mQ,18314
+craft_ai_sdk/core/pipeline_metrics.py,sha256=Tt5p6guHAf7nhq1wvJG3t7WqsYKqrNQ7sZcFKqXYmdM,6465
+craft_ai_sdk/core/pipelines.py,sha256=-eU_vKoxFQiDXWZgvetI577ZOeJWR5jpVgqMBohDNUw,19756
+craft_ai_sdk/core/resource_metrics.py,sha256=yaco_AZ4Wu5sxLRKsA3qt2R3-PMs2e32EGO0gsHtq2Y,2336
+craft_ai_sdk/core/steps.py,sha256=pvC2bEPF-9XGugdYAQ2LhdlnKZvC3giRm9ZrX3ZDMLs,21406
+craft_ai_sdk/core/users.py,sha256=Qi3xg7Vzk_0MepccNIZbFzjI0bBqouqkFStTuejUY6s,509
+craft_ai_sdk/exceptions.py,sha256=IC-JfZmmmaTsbMCgirOEByRmWnatQLjKe8BErRkuwM0,1075
+craft_ai_sdk/io.py,sha256=y9lg5unGIwQICAPuKUdUPDAJCsxe2lbseIlmiWka2Ec,11865
+craft_ai_sdk/sdk.py,sha256=W9oOeCKCvcZgttFNlEwAJElh2d4OQp3SViQmuaCyy7U,10068
+craft_ai_sdk/utils.py,sha256=zo4fdexMeRspFHG-abmH858-eKzqZzSJ5tdxNBPzgpU,10551
+craft_ai_sdk/warnings.py,sha256=xJXbUR66SVbG_ZO7rxpAZ2hkGxdUtM5JAx6JoWg77Qs,6678
+documentation.pdf,sha256=39aslpaNhNb9p-PvaMS5Oxo1VWZw7VCbfRZbp_eXDBc,327435
+craft_ai_sdk-0.51.0.dist-info/LICENSE,sha256=_2oYRJic9lZK05LceuJ9aZZw5mPHYc1WQhJiVS-oGFU,10754
+craft_ai_sdk-0.51.0.dist-info/METADATA,sha256=RXUNVJKV0yeVqwbZDEJgj4fehCH4LPm1tvhwYmIPuMg,1563
+craft_ai_sdk-0.51.0.dist-info/entry_points.txt,sha256=eV9YD0zCAb88_wNMDV99sRxVKVC-WOQF3b1Pepaytcg,385
+craft_ai_sdk-0.51.0.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+craft_ai_sdk-0.51.0.dist-info/RECORD,,

craft_ai_sdk-0.50.1rc1.dist-info/RECORD

@@ -1,23 +0,0 @@
-craft_ai_sdk/__init__.py,sha256=9Wu68jkKuIHXm1GZuZ1EL29KpE_oOyKr0kShd0YqLwU,407
-craft_ai_sdk/constants.py,sha256=KHRaIHA9tHxjwluo7zBF2UZpePQaDI57SrBs4Ob1g7Q,607
-craft_ai_sdk/core/data_store.py,sha256=kI0nUIXfkz-9ENVEeFW70_PGhBNB_S-nntJJkKhGRoQ,8464
-craft_ai_sdk/core/deployments.py,sha256=p717fy73OoynUuDKO6XYLfLu5stBHH73xQw6HLm8jUY,25804
-craft_ai_sdk/core/endpoints.py,sha256=ElVcjnrjWD4_Wo5fOwRh1apUuL5IB7DM-FMH-1poP9w,4563
-craft_ai_sdk/core/environment_variables.py,sha256=wy0U7y0C7tRXOXOiWGz0vX5ajHSmOb_7J1fXlSahGpI,2045
-craft_ai_sdk/core/pipeline_executions.py,sha256=7RRKQUxXUCI871mmFCO4N4RG0RvX5MZ3Fss3doCb8mQ,18314
-craft_ai_sdk/core/pipeline_metrics.py,sha256=fTkiabCD5wATWCMNI_S_MFSlQm55aI7qPh_3Vg6SUIs,7032
-craft_ai_sdk/core/pipelines.py,sha256=7QwnLDVfMMYqYKHzsJhYHXbhBYEgwYDk_ZLdD-uzzKs,18383
-craft_ai_sdk/core/resource_metrics.py,sha256=yaco_AZ4Wu5sxLRKsA3qt2R3-PMs2e32EGO0gsHtq2Y,2336
-craft_ai_sdk/core/steps.py,sha256=e_-Kb88raOWRKXLbRzTaJVgVOs4LXA2ziXC6z-PYtlg,20343
-craft_ai_sdk/core/users.py,sha256=Qi3xg7Vzk_0MepccNIZbFzjI0bBqouqkFStTuejUY6s,509
-craft_ai_sdk/exceptions.py,sha256=IC-JfZmmmaTsbMCgirOEByRmWnatQLjKe8BErRkuwM0,1075
-craft_ai_sdk/io.py,sha256=y9lg5unGIwQICAPuKUdUPDAJCsxe2lbseIlmiWka2Ec,11865
-craft_ai_sdk/sdk.py,sha256=4x4S6jwfMfllnyvxNCtdcBWqYrT-4F_gL2tiQpeSPmE,10021
-craft_ai_sdk/utils.py,sha256=3BTHNv3OgxtfiJnmf8U_pne-Bky4vtX33CvN_GD_NKM,9460
-craft_ai_sdk/warnings.py,sha256=xJXbUR66SVbG_ZO7rxpAZ2hkGxdUtM5JAx6JoWg77Qs,6678
-documentation.pdf,sha256=U2K_3cfkwKsSBI225v5_7yI-Avuv18p17oZYUhS7Xk0,327165
-craft_ai_sdk-0.50.1rc1.dist-info/LICENSE,sha256=_2oYRJic9lZK05LceuJ9aZZw5mPHYc1WQhJiVS-oGFU,10754
-craft_ai_sdk-0.50.1rc1.dist-info/METADATA,sha256=EYOoFbGLFDcnEfz49RNrY8GChiO2Y_i9gqJEV4oulY0,1566
-craft_ai_sdk-0.50.1rc1.dist-info/entry_points.txt,sha256=eV9YD0zCAb88_wNMDV99sRxVKVC-WOQF3b1Pepaytcg,385
-craft_ai_sdk-0.50.1rc1.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-craft_ai_sdk-0.50.1rc1.dist-info/RECORD,,