superb-ai-onprem 0.3.1__tar.gz → 0.3.2__tar.gz

{superb_ai_onprem-0.3.1/superb_ai_onprem.egg-info → superb_ai_onprem-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: superb-ai-onprem
-Version: 0.3.1
+Version: 0.3.2
 Summary: Python SDK for Superb AI On-premise
 Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
 Author: Superb AI

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.2'
+__version_tuple__ = version_tuple = (0, 3, 2)

superb_ai_onprem-0.3.2/spb_onprem/activities/__init__.py

@@ -0,0 +1,8 @@
+from .service import ActivityService
+from .entities import ActivityHistory, ActivityStatus
+
+__all__ = (
+    "ActivityService",
+    "ActivityHistory", 
+    "ActivityStatus",
+)

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/activities/entities/activity_history.py

@@ -20,8 +20,8 @@ class ActivityHistory(CustomBaseModel):
     activity_id: Optional[str] = Field(None, alias="jobId")
     status: Optional[ActivityStatus] = Field(None, alias="status")
     
-    parameters: Optional[Any] = Field(None, alias="parameters")
-    progress: Optional[Any] = Field(None, alias="progress")
+    parameters: Optional[dict] = Field(None, alias="parameters")
+    progress: Optional[dict] = Field(None, alias="progress")
     
     meta: Optional[dict] = Field(None, alias="meta")
     

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/activities/params/__init__.py

@@ -9,6 +9,7 @@ from .update_activity import update_activity_params
 from .delete_activity import delete_activity_params
 from .start_activity import start_activity_params
 from .update_activity_history import update_activity_history_params
+from .get_activity_history import get_activity_history_params
 
 __all__ = (
     "ActivitiesFilter",
@@ -20,4 +21,5 @@ __all__ = (
     "delete_activity_params",
     "start_activity_params",
     "update_activity_history_params",
+    "get_activity_history_params",
 )

superb_ai_onprem-0.3.2/spb_onprem/activities/params/get_activity_history.py

@@ -0,0 +1,20 @@
+from typing import Dict, Any
+
+
+def get_activity_history_params(
+    dataset_id: str,
+    activity_history_id: str,
+) -> Dict[str, Any]:
+    """Get parameters for getting activity history.
+    
+    Args:
+        dataset_id (str): The ID of the dataset
+        activity_history_id (str): The ID of the job
+        
+    Returns:
+        Dict[str, Any]: The parameters for the query
+    """
+    return {
+        "dataset_id": dataset_id,
+        "job_history_id": activity_history_id,
+    }

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/activities/params/update_activity.py

@@ -6,6 +6,10 @@ from spb_onprem.activities.entities import ActivitySchema
 
 def update_activity_params(
     activity_id: str,
+    dataset_id: Union[
+        str,
+        UndefinedType
+    ] = Undefined,
     activity_type: Union[
         str,
         UndefinedType
@@ -61,6 +65,8 @@ def update_activity_params(
         "id": activity_id
     }
 
+    if dataset_id is not Undefined:
+        params["datasetId"] = dataset_id
     if activity_type is not Undefined:
         params["type"] = activity_type
     if name is not Undefined:

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/activities/queries.py

@@ -8,6 +8,7 @@ from spb_onprem.activities.params import (
 
     start_activity_params,
     update_activity_history_params,
+    get_activity_history_params,
 )
 
 class Schemas:
@@ -103,6 +104,21 @@ class Queries:
         "variables": get_activity_params,
     }
 
+    GET_ACTIVITY_HISTORY = {
+        "name": "jobHistory",
+        "query": f'''
+            query jobHistory(
+                $dataset_id: ID,
+                $job_history_id: ID!
+            ) {{
+                jobHistory(datasetId: $dataset_id, id: $job_history_id) {{
+                    {Schemas.ACTIVITY_HISTORY}
+                }}
+            }}
+        ''',
+        "variables": get_activity_history_params,
+    }
+
     CREATE_ACTIVITY = {
         "name": "createJob",
         "query": f'''

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/spb_onprem/activities/service.py

@@ -127,6 +127,29 @@ class ActivityService(BaseService):
         )
         return Activity.model_validate(response)
 
+    def get_activity_history(
+        self,
+        dataset_id: str,
+        activity_history_id: str,
+    ) -> ActivityHistory:
+        """Get an activity history.
+        
+        Args:
+            dataset_id (str): The ID of the dataset to get the activity history for.
+            activity_history_id (str): The ID of the job to get the activity history for.
+        
+        Returns:
+            ActivityHistory: The activity history object.
+        """
+        response = self.request_gql(
+            Queries.GET_ACTIVITY_HISTORY,
+            Queries.GET_ACTIVITY_HISTORY["variables"](
+                dataset_id=dataset_id,
+                activity_history_id=activity_history_id,
+            )
+        )
+        return ActivityHistory.model_validate(response)
+
     def update_activity(
         self,
         activity_id: str,
@@ -236,12 +259,12 @@ class ActivityService(BaseService):
         """Start an activity.
         
         Args:
+            dataset_id (str): The ID of the dataset to start the activity for.
             activity_id (Optional[str]): The ID of the activity to start.
-            dataset_id (Optional[str]): The ID of the dataset to start the activity for.
             activity_type (Optional[str]): The type of the activity to start.
-            parameters (Optional[dict]): The parameters to start the activity with.
-            progress (Optional[dict]): The progress to start the activity with.
-            meta (Optional[dict]): The meta to start the activity with.
+            parameters (Optional[dict]): The parameters for the activity.
+            progress (Optional[dict]): The progress for the activity.
+            meta (Optional[dict]): The meta for the activity.
         
         Returns:
             ActivityHistory: The activity history object.
@@ -258,7 +281,7 @@ class ActivityService(BaseService):
             )
         )
         return ActivityHistory.model_validate(response)
-    
+
     def update_activity_history_status(
         self,
         activity_history_id: str,
@@ -272,8 +295,11 @@ class ActivityService(BaseService):
         
         Args:
             activity_history_id (str): The ID of the activity history to update.
-            status (ActivityStatus): The status to update the activity to.
-            meta (Optional[dict]): The meta to update the activity with.
+            status (ActivityStatus): The new status for the activity history.
+            meta (Optional[dict]): The meta for the activity history.
+        
+        Returns:
+            ActivityHistory: The updated activity history object.
         """
         response = self.request_gql(
             Queries.UPDATE_ACTIVITY_HISTORY,
@@ -301,8 +327,11 @@ class ActivityService(BaseService):
         
         Args:
             activity_history_id (str): The ID of the activity history to update.
-            progress (Optional[dict]): The progress to update the activity with.
-            meta (Optional[dict]): The meta to update the activity with.
+            progress (Optional[dict]): The new progress for the activity history.
+            meta (Optional[dict]): The meta for the activity history.
+        
+        Returns:
+            ActivityHistory: The updated activity history object.
         """
         response = self.request_gql(
             Queries.UPDATE_ACTIVITY_HISTORY,

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2/superb_ai_onprem.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: superb-ai-onprem
-Version: 0.3.1
+Version: 0.3.2
 Summary: Python SDK for Superb AI On-premise
 Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
 Author: Superb AI

{superb_ai_onprem-0.3.1 → superb_ai_onprem-0.3.2}/superb_ai_onprem.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ spb_onprem/activities/params/activities.py
 spb_onprem/activities/params/activity.py
 spb_onprem/activities/params/create_activity.py
 spb_onprem/activities/params/delete_activity.py
+spb_onprem/activities/params/get_activity_history.py
 spb_onprem/activities/params/start_activity.py
 spb_onprem/activities/params/update_activity.py
 spb_onprem/activities/params/update_activity_history.py
@@ -109,6 +110,7 @@ superb_ai_onprem.egg-info/top_level.txt
 tests/__init__.py
 tests/activities/__init__.py
 tests/activities/real_test.py
+tests/activities/test_get_activity_history.py
 tests/activities/test_params.py
 tests/activities/test_service.py
 tests/exports/__init__.py

superb_ai_onprem-0.3.2/tests/activities/test_get_activity_history.py

@@ -0,0 +1,138 @@
+import pytest
+from unittest.mock import MagicMock
+
+from spb_onprem.activities.service import ActivityService
+from spb_onprem.activities.entities import ActivityHistory, ActivityStatus
+
+
+@pytest.fixture
+def activity_service():
+    return ActivityService()
+
+
+class TestGetActivityHistory:
+    def test_get_activity_history(self, activity_service):
+        # Given
+        mock_response = {
+            "id": "test_history_id",
+            "jobId": "test_job_id",
+            "status": "SUCCESS",
+            "datasetId": "test_dataset_id",
+            "parameters": {"param1": "value1"},
+            "progress": {"current": 50, "total": 100},
+            "createdAt": "2024-01-01T00:00:00Z",
+            "createdBy": "test_user",
+            "updatedAt": "2024-01-01T01:00:00Z",
+            "updatedBy": "test_user",
+            "meta": {"type": "export"}
+        }
+        activity_service.request_gql = MagicMock(return_value=mock_response)
+        
+        # When
+        history = activity_service.get_activity_history(
+            dataset_id="test_dataset_id",
+            activity_history_id="test_history_id"
+        )
+        
+        # Then
+        assert isinstance(history, ActivityHistory)
+        assert history.id == "test_history_id"
+        assert history.activity_id == "test_job_id"
+        assert history.status == ActivityStatus.SUCCESS
+        assert history.dataset_id == "test_dataset_id"
+        assert history.parameters == {"param1": "value1"}
+        assert history.progress == {"current": 50, "total": 100}
+        assert history.created_at == "2024-01-01T00:00:00Z"
+        assert history.created_by == "test_user"
+        assert history.updated_at == "2024-01-01T01:00:00Z"
+        assert history.updated_by == "test_user"
+        assert history.meta == {"type": "export"}
+    
+    def test_get_activity_history_minimal_data(self, activity_service):
+        # Given
+        mock_response = {
+            "id": "test_history_id",
+            "jobId": "test_job_id",
+            "status": "PENDING",
+            "datasetId": "test_dataset_id"
+        }
+        activity_service.request_gql = MagicMock(return_value=mock_response)
+        
+        # When
+        history = activity_service.get_activity_history(
+            dataset_id="test_dataset_id",
+            activity_history_id="test_history_id"
+        )
+        
+        # Then
+        assert isinstance(history, ActivityHistory)
+        assert history.id == "test_history_id"
+        assert history.activity_id == "test_job_id"
+        assert history.status == ActivityStatus.PENDING
+        assert history.dataset_id == "test_dataset_id"
+        assert history.parameters is None
+        assert history.progress is None
+        assert history.meta is None
+    
+    def test_activity_history_model_validation(self):
+        # Given
+        history_data = {
+            "id": "test_history_id",
+            "jobId": "test_job_id",
+            "status": "RUNNING",
+            "datasetId": "test_dataset_id",
+            "parameters": {"param1": "value1"},
+            "progress": {"current": 25, "total": 100},
+            "createdAt": "2024-01-01T00:00:00Z",
+            "createdBy": "test_user",
+            "updatedAt": "2024-01-01T01:00:00Z",
+            "updatedBy": "test_user",
+            "meta": {"type": "export", "version": "1.0"}
+        }
+        
+        # When
+        history = ActivityHistory.model_validate(history_data)
+        
+        # Then
+        assert isinstance(history, ActivityHistory)
+        assert history.id == "test_history_id"
+        assert history.activity_id == "test_job_id"
+        assert history.status == ActivityStatus.RUNNING
+        assert history.dataset_id == "test_dataset_id"
+        assert history.parameters == {"param1": "value1"}
+        assert history.progress == {"current": 25, "total": 100}
+        assert history.created_at == "2024-01-01T00:00:00Z"
+        assert history.created_by == "test_user"
+        assert history.updated_at == "2024-01-01T01:00:00Z"
+        assert history.updated_by == "test_user"
+        assert history.meta == {"type": "export", "version": "1.0"}
+    
+    def test_get_activity_history_with_different_statuses(self, activity_service):
+        # Test different status values
+        statuses = [
+            ("PENDING", ActivityStatus.PENDING),
+            ("RUNNING", ActivityStatus.RUNNING),
+            ("SUCCESS", ActivityStatus.SUCCESS),
+            ("FAILED", ActivityStatus.FAILED),
+            ("CANCELLED", ActivityStatus.CANCELLED),
+        ]
+        
+        for status_value, expected_status in statuses:
+            # Given
+            mock_response = {
+                "id": f"history_{status_value.lower()}",
+                "jobId": "test_job_id",
+                "status": status_value,
+                "datasetId": "test_dataset_id"
+            }
+            activity_service.request_gql = MagicMock(return_value=mock_response)
+            
+            # When
+            history = activity_service.get_activity_history(
+                dataset_id="test_dataset_id",
+                activity_history_id=f"history_{status_value.lower()}"
+            )
+            
+            # Then
+            assert history.status == expected_status
+            assert history.id == f"history_{status_value.lower()}"