synapse-sdk 1.0.0a46__py3-none-any.whl → 1.0.0a47__py3-none-any.whl

synapse_sdk/clients/backend/integration.py

@@ -1,4 +1,4 @@
-from synapse_sdk.clients.backend.models import Storage
+from synapse_sdk.clients.backend.models import Storage, UpdateJob
 from synapse_sdk.clients.base import BaseClient
 from synapse_sdk.utils.file import convert_file_to_base64
 
@@ -43,7 +43,7 @@ class IntegrationClientMixin(BaseClient):
 
     def update_job(self, pk, data):
         path = f'jobs/{pk}/'
-        return self._patch(path, data=data)
+        return self._patch(path, request_model=UpdateJob, data=data)
 
     def list_job_console_logs(self, pk):
         path = f'jobs/{pk}/console_logs/'
@@ -82,4 +82,4 @@ class IntegrationClientMixin(BaseClient):
     def get_storage(self, pk):
         """Get specific storage data from synapse backend."""
         path = f'storages/{pk}/'
-        return self._get(path, pydantic_model=Storage)
+        return self._get(path, response_model=Storage)

synapse_sdk/clients/backend/models.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Dict
+from typing import Dict, Optional
 
 from pydantic import BaseModel
 
@@ -42,3 +42,35 @@ class Storage(BaseModel):
     provider: StorageProvider
     configuration: Dict
     is_default: bool
+
+
+class JobStatus(str, Enum):
+    """Synapse Backend Job Status Enum."""
+
+    PENDING = 'pending'
+    RUNNING = 'running'
+    STOPPED = 'stopped'
+    SUCCEEDED = 'succeeded'
+    FAILED = 'failed'
+
+
+class UpdateJob(BaseModel):
+    """Synapse Backend Update Job Request Payload Model.
+
+    Attrs:
+        status (str): The job status. (ex: pending, running, stopped, succeeded, failed)
+        progress_record (Dict): The job progress record.
+        console_logs (Dict): The job console logs.
+        result (Dict): The job result.
+    """
+
+    status: Optional[JobStatus] = None
+    progress_record: Optional[Dict] = None
+    console_logs: Optional[Dict] = None
+    result: Optional[Dict] = None
+
+    def model_dump(self, **kwargs):
+        data = super().model_dump(**kwargs)
+        if data.get('status') is not None:
+            data['status'] = data['status'].value
+        return data

synapse_sdk/clients/base.py

@@ -86,14 +86,15 @@ class BaseClient:
         except ValueError:
             return response.text
 
-    def _get(self, path, url_conversion=None, pydantic_model=None, **kwargs):
+    def _get(self, path, url_conversion=None, response_model=None, **kwargs):
         """
         Perform a GET request and optionally convert response to a pydantic model.
 
         Args:
             path (str): URL path to request.
             url_conversion (dict, optional): Configuration for URL to path conversion.
-            pydantic_model (Type, optional): Pydantic model to convert the response to.
+            request_model (pydantic.BaseModel, optional): Pydantic model to validate the request.
+            response_model (pydantic.BaseModel, optional): Pydantic model to validate the response.
             **kwargs: Additional keyword arguments to pass to the request.
 
         Returns:
@@ -107,36 +108,100 @@ class BaseClient:
             else:
                 files_url_to_path_from_objs(response, **url_conversion)
 
-        if pydantic_model:
-            return self._validate_response_with_pydantic_model(response, pydantic_model)
+        if response_model:
+            return self._validate_response_with_pydantic_model(response, response_model)
 
         return response
 
-    def _post(self, path, pydantic_model=None, **kwargs):
+    def _post(self, path, request_model=None, response_model=None, **kwargs):
+        """
+        Perform a POST request and optionally convert response to a pydantic model.
+
+        Args:
+            path (str): URL path to request.
+            request_model (pydantic.BaseModel, optional): Pydantic model to validate the request.
+            response_model (pydantic.BaseModel, optional): Pydantic model to validate the response.
+            **kwargs: Additional keyword arguments to pass to the request.
+
+        Returns:
+            The response data, optionally converted to a pydantic model.
+        """
+        if kwargs.get('data') and request_model:
+            kwargs['data'] = self._validate_request_body_with_pydantic_model(kwargs['data'], request_model)
         response = self._request('post', path, **kwargs)
-        if pydantic_model:
-            return self._validate_response_with_pydantic_model(response, pydantic_model)
+        if response_model:
+            return self._validate_response_with_pydantic_model(response, response_model)
         else:
             return response
 
-    def _put(self, path, pydantic_model=None, **kwargs):
+    def _put(self, path, request_model=None, response_model=None, **kwargs):
+        """
+        Perform a PUT request to the specified path.
+
+        Args:
+            path (str): The URL path for the request.
+            request_model (Optional[Type[BaseModel]]): A Pydantic model class to validate the request body against.
+            response_model (Optional[Type[BaseModel]]): A Pydantic model class to validate and parse the response.
+            **kwargs: Additional arguments to pass to the request method.
+                - data: The request body to be sent. If provided along with request_model, it will be validated.
+
+        Returns:
+            Union[dict, BaseModel]:
+                If response_model is provided, returns an instance of that model populated with the response data.
+        """
+        if kwargs.get('data') and request_model:
+            kwargs['data'] = self._validate_request_body_with_pydantic_model(kwargs['data'], request_model)
         response = self._request('put', path, **kwargs)
-        if pydantic_model:
-            return self._validate_response_with_pydantic_model(response, pydantic_model)
+        if response_model:
+            return self._validate_response_with_pydantic_model(response, response_model)
         else:
             return response
 
-    def _patch(self, path, pydantic_model=None, **kwargs):
+    def _patch(self, path, request_model=None, response_model=None, **kwargs):
+        """
+        Perform a PATCH HTTP request to the specified path.
+
+        Args:
+            path (str): The API endpoint path to make the request to.
+            request_model (Optional[Type[BaseModel]]): A Pydantic model class used to validate the request body.
+            response_model (Optional[Type[BaseModel]]): A Pydantic model class used to validate and parse the response.
+            **kwargs: Additional keyword arguments to pass to the request method.
+                - data: The request body data. If provided along with request_model, it will be validated.
+
+        Returns:
+            Union[dict, BaseModel]: If response_model is provided, returns an instance of that model.
+                Otherwise, returns the raw response data.
+        """
+
+        if kwargs.get('data') and request_model:
+            kwargs['data'] = self._validate_request_body_with_pydantic_model(kwargs['data'], request_model)
         response = self._request('patch', path, **kwargs)
-        if pydantic_model:
-            return self._validate_response_with_pydantic_model(response, pydantic_model)
+        if response_model:
+            return self._validate_response_with_pydantic_model(response, response_model)
         else:
             return response
 
-    def _delete(self, path, pydantic_model=None, **kwargs):
+    def _delete(self, path, request_model=None, response_model=None, **kwargs):
+        """
+        Performs a DELETE request to the specified path.
+
+        Args:
+            path (str): The API endpoint path to send the DELETE request to.
+            request_model (Optional[Type[BaseModel]]): Pydantic model to validate the request data against.
+            response_model (Optional[Type[BaseModel]]): Pydantic model to validate and convert the response data.
+            **kwargs: Additional keyword arguments passed to the request method.
+                - data: Request payload to send. Will be validated against request_model if both are provided.
+
+        Returns:
+            Union[dict, BaseModel]: If response_model is provided, returns an instance of that model.
+                                   Otherwise, returns the raw response data as a dictionary.
+        """
+
+        if kwargs.get('data') and request_model:
+            kwargs['data'] = self._validate_request_body_with_pydantic_model(kwargs['data'], request_model)
         response = self._request('delete', path, **kwargs)
-        if pydantic_model:
-            return self._validate_response_with_pydantic_model(response, pydantic_model)
+        if response_model:
+            return self._validate_response_with_pydantic_model(response, response_model)
         else:
             return response
 
@@ -170,3 +235,19 @@ class BaseClient:
         else:
             # Not a pydantic model
             raise TypeError('The provided model is not a pydantic model')
+
+    def _validate_request_body_with_pydantic_model(self, request_body, pydantic_model):
+        """Validate a request body with a pydantic model."""
+        # Check if model is a pydantic model (has the __pydantic_model__ attribute)
+        if (
+            hasattr(pydantic_model, '__pydantic_model__')
+            or hasattr(pydantic_model, 'model_validate')
+            or hasattr(pydantic_model, 'parse_obj')
+        ):
+            # Validate the request body and convert to model instance
+            model_instance = pydantic_model.model_validate(request_body)
+            # Convert model to dict and remove None values
+            return {k: v for k, v in model_instance.model_dump().items() if v is not None}
+        else:
+            # Not a pydantic model
+            raise TypeError('The provided model is not a pydantic model')

synapse_sdk/plugins/categories/export/actions/export.py

@@ -1,4 +1,3 @@
-import json
 from abc import ABC, abstractmethod
 from datetime import datetime
 from typing import Annotated, Any, Literal
@@ -17,12 +16,18 @@ from synapse_sdk.utils.pydantic.validators import non_blank
 from synapse_sdk.utils.storage import get_pathlib
 
 
+class DataFileInfo(BaseModel):
+    """Schema for data_file_info."""
+
+    file_name: str
+
+
 class ExportRun(Run):
     class DataFileLog(BaseModel):
         """Data file log model."""
 
         target_id: int
-        data_file_info: str | None
+        data_file_info: DataFileInfo
         status: ExportStatus
         error: str | None = None
         created: str
@@ -44,7 +49,7 @@ class ExportRun(Run):
             log_type,
             self.DataFileLog(
                 target_id=target_id,
-                data_file_info=json.dumps(data_file_info),
+                data_file_info=data_file_info,
                 status=status.value,
                 error=error,
                 created=now,

{synapse_sdk-1.0.0a46.dist-info → synapse_sdk-1.0.0a47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0a46
+Version: 1.0.0a47
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT

{synapse_sdk-1.0.0a46.dist-info → synapse_sdk-1.0.0a47.dist-info}/RECORD

@@ -21,7 +21,7 @@ synapse_sdk/cli/plugin/create.py,sha256=HpYTpohV1NbSrULaVUlc4jWLWznPrx7glgydTM3s
 synapse_sdk/cli/plugin/publish.py,sha256=sIl1wiuSC3lAUpE3rOF4UDKDy2G5EVLlelMjk2aT05g,1221
 synapse_sdk/cli/plugin/run.py,sha256=xz5LRm3zh8Y9DMjw5FFRFVRWSCWtYfZJskfCmrPikaQ,2598
 synapse_sdk/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/clients/base.py,sha256=emtffTGGtPOSz6tT_NCL9cGE7ZEOv9pTHyc9BRfoe2s,6462
+synapse_sdk/clients/base.py,sha256=K6wPKG8DFus5hG7nOUnKWS9-FuzG4ndkbNYCLBA_30Y,10957
 synapse_sdk/clients/exceptions.py,sha256=ylv7x10eOp4aA3a48jwonnvqvkiYwzJYXjkVkRTAjwk,220
 synapse_sdk/clients/utils.py,sha256=8pPJTdzHiRPSbZMoQYHAgR2BAMO6u_R_jMV6a2p34iQ,392
 synapse_sdk/clients/agent/__init__.py,sha256=Pz8_iTbIbnb7ywGJ3feqoZVmO2I3mEbwpWsISIxh0BU,1968
@@ -33,9 +33,9 @@ synapse_sdk/clients/backend/annotation.py,sha256=f4jS4qlXH7M7mQ3EuCq-NrjJ_hJNDz8
 synapse_sdk/clients/backend/core.py,sha256=5XAOdo6JZ0drfk-FMPJ96SeTd9oja-VnTwzGXdvK7Bg,1027
 synapse_sdk/clients/backend/dataset.py,sha256=11R5LuTva9jgXatxQAlKy7UEJmwIWzTsLVdFf3MZ9F8,3400
 synapse_sdk/clients/backend/hitl.py,sha256=na2mSXFud92p4zUEuagcDWk2klxO7xn-e86cm0VZEvs,709
-synapse_sdk/clients/backend/integration.py,sha256=Xi-DIimjaDSaLZWWd0rmFgj4uFav8H4r4gxTSsjX0vo,2647
+synapse_sdk/clients/backend/integration.py,sha256=9LjkYcBpi7aog-MODSDS4RlmYahypu65qxBj-AcY7xc,2683
 synapse_sdk/clients/backend/ml.py,sha256=JoPH9Ly2E3HJ7S5mdGLtcGq7ruQVVrYfWArogwZLlms,1193
-synapse_sdk/clients/backend/models.py,sha256=ycuzIBi3pyKIFkNzrNGsv3cA49BjLmjyylNHBSRG4bI,1047
+synapse_sdk/clients/backend/models.py,sha256=XYG6SmEnSvKRE1UD8M_3GiN56gWTGSOW5oMex3-mTtE,1947
 synapse_sdk/clients/ray/__init__.py,sha256=9ZSPXVVxlJ8Wp8ku7l021ENtPjVrGgQDgqifkkVAXgM,187
 synapse_sdk/clients/ray/core.py,sha256=a4wyCocAma2HAm-BHlbZnoVbpfdR-Aad2FM0z6vPFvw,731
 synapse_sdk/clients/ray/serve.py,sha256=rbCpXZYWf0oP8XJ9faa9QFNPYU7h8dltIG8xn9ZconY,907
@@ -61,7 +61,7 @@ synapse_sdk/plugins/categories/data_validation/templates/plugin/validation.py,sh
 synapse_sdk/plugins/categories/export/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/export/enums.py,sha256=gtyngvQ1DKkos9iKGcbecwTVQQ6sDwbrBPSGPNb5Am0,127
 synapse_sdk/plugins/categories/export/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/export/actions/export.py,sha256=xqPB_MufeMP3riaKCbGVFGukV8RdXcg6-zUrkw4t1-A,9922
+synapse_sdk/plugins/categories/export/actions/export.py,sha256=sVga8cgprKFpZB-RCiZghCGQcBnr7Y58-jig9vPMbrc,9990
 synapse_sdk/plugins/categories/export/templates/config.yaml,sha256=N7YmnFROb3s3M35SA9nmabyzoSb5O2t2TRPicwFNN2o,56
 synapse_sdk/plugins/categories/export/templates/plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/export/templates/plugin/export.py,sha256=UzPOYvH2rwUlTUpMgcbn7mBsenf3hmWytE-eD_cB_9A,5202
@@ -134,9 +134,9 @@ synapse_sdk/utils/storage/providers/__init__.py,sha256=x7RGwZryT2FpVxS7fGWryRVpq
 synapse_sdk/utils/storage/providers/gcp.py,sha256=i2BQCu1Kej1If9SuNr2_lEyTcr5M_ncGITZrL0u5wEA,363
 synapse_sdk/utils/storage/providers/s3.py,sha256=W94rQvhGRXti3R4mYP7gmU5pcyCQpGFIBLvxxqLVdRM,2231
 synapse_sdk/utils/storage/providers/sftp.py,sha256=_8s9hf0JXIO21gvm-JVS00FbLsbtvly4c-ETLRax68A,1426
-synapse_sdk-1.0.0a46.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
-synapse_sdk-1.0.0a46.dist-info/METADATA,sha256=FBaND1uI65IAg7m8rySWXXhXU39wTMvAp1MWeFy8sfI,1203
-synapse_sdk-1.0.0a46.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-synapse_sdk-1.0.0a46.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
-synapse_sdk-1.0.0a46.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
-synapse_sdk-1.0.0a46.dist-info/RECORD,,
+synapse_sdk-1.0.0a47.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
+synapse_sdk-1.0.0a47.dist-info/METADATA,sha256=m85ag15c0Y0vLrK6u7J6FVg8DgP9ew_bfXr-9ERl-jA,1203
+synapse_sdk-1.0.0a47.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+synapse_sdk-1.0.0a47.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
+synapse_sdk-1.0.0a47.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
+synapse_sdk-1.0.0a47.dist-info/RECORD,,