synapse-sdk 1.0.0a85__py3-none-any.whl → 1.0.0a86__py3-none-any.whl

synapse_sdk/plugins/categories/data_validation/actions/validation.py

@@ -1,10 +1,82 @@
+from enum import Enum
+from typing import Any, Dict, List
+
+from pydantic import BaseModel
+
 from synapse_sdk.plugins.categories.base import Action
 from synapse_sdk.plugins.categories.decorators import register_action
 from synapse_sdk.plugins.enums import PluginCategory, RunMethod
 
 
+class ValidationDataStatus(str, Enum):
+    """Validation data status enumeration.
+
+    Represents the possible status values for validation operations.
+
+    Attributes:
+        SUCCESS: Validation completed successfully with no errors.
+        FAILED: Validation failed with one or more errors.
+    """
+
+    SUCCESS = 'success'
+    FAILED = 'failed'
+
+
+class ValidationResult(BaseModel):
+    """Validation result model.
+
+    Args:
+        status: The validation status.
+        errors: List of validation errors.
+    """
+
+    status: ValidationDataStatus
+    errors: List[str]
+
+
+class CriticalError(Exception):
+    """Critical error exception for validation processing.
+
+    Raised when a critical error occurs during validation that prevents
+    the validation process from continuing normally.
+
+    Args:
+        message: Custom error message. Defaults to a standard critical error message.
+
+    Attributes:
+        message: The error message associated with this exception.
+    """
+
+    def __init__(self, message: str = 'Critical error occured while processing validation'):
+        self.message = message
+        super().__init__(self.message)
+
+
+class ValidationParams(BaseModel):
+    """Validation action parameters.
+
+    Args:
+        data (dict): The validation data.
+    """
+
+    data: Dict[str, Any]
+
+
 @register_action
 class ValidationAction(Action):
+    """Validation action for data validation processing.
+
+    This action handles the process of validating data with assignment IDs.
+    It supports validation methods and provides structured logging.
+
+    Attrs:
+        name (str): Action name, set to 'validation'.
+        category (PluginCategory): Plugin category, set to DATA_VALIDATION.
+        method (RunMethod): Execution method, set to TASK.
+        params_model (Type[ValidationParams]): Parameter validation model.
+    """
+
     name = 'validation'
     category = PluginCategory.DATA_VALIDATION
     method = RunMethod.TASK
+    params_model = ValidationParams

synapse_sdk/plugins/categories/data_validation/templates/plugin/validation.py

@@ -1,5 +1,29 @@
-def validate(data, assignment_id, **kwargs):
-    errors = []
-    if data.get('errors'):
-        errors += data['errors']
-    return errors
+from typing import Any, Dict, List, Optional
+
+from synapse_sdk.plugins.categories.data_validation.actions.validation import ValidationDataStatus, ValidationResult
+
+
+def validate(data: Optional[Dict[str, Any]] = None, **kwargs: Any) -> ValidationResult:
+    """Validate data with assignment data.
+
+    * Custom validation logic can be added here.
+    * Error messages can be added to the errors list if errors exist in data.
+    * The validation result will be returned as a dict with ValidationResult structure.
+
+    Args:
+        data: The data to validate.
+        **kwargs: Additional arguments.
+
+    Returns:
+        ValidationResult: The validation result with status and errors.
+    """
+    errors: List[str] = []
+
+    # Add custom validation logic here
+
+    # Add error messages into errors list if errors exist in data
+
+    # Determine status based on errors
+    status = ValidationDataStatus.FAILED if errors else ValidationDataStatus.SUCCESS
+
+    return ValidationResult(status=status, errors=errors)

{synapse_sdk-1.0.0a85.dist-info → synapse_sdk-1.0.0a86.dist-info}/METADATA

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

{synapse_sdk-1.0.0a85.dist-info → synapse_sdk-1.0.0a86.dist-info}/RECORD

@@ -117,10 +117,10 @@ synapse_sdk/plugins/categories/registry.py,sha256=KdQR8SUlLT-3kgYzDNWawS1uJnAhrc
 synapse_sdk/plugins/categories/templates.py,sha256=FF5FerhkZMeW1YcKLY5cylC0SkWSYdJODA_Qcm4OGYQ,887
 synapse_sdk/plugins/categories/data_validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 synapse_sdk/plugins/categories/data_validation/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/data_validation/actions/validation.py,sha256=U1lA36RyGmtRuF1AIpr1mE30z0cByCAC_PDKtEptDTc,338
+synapse_sdk/plugins/categories/data_validation/actions/validation.py,sha256=E6irjH3aylnS_nIlXVDdqwpkvMxlTwzmedYeXj5sgSk,2262
 synapse_sdk/plugins/categories/data_validation/templates/config.yaml,sha256=Hijb-b3hy0msZsTV_bbr3Hvlk8ok-Rk0a05mlLGTCAg,66
 synapse_sdk/plugins/categories/data_validation/templates/plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-synapse_sdk/plugins/categories/data_validation/templates/plugin/validation.py,sha256=90I5boUpEXvO3mEuKKBs528ls2A4h8Iw4ReOID2h00Y,139
+synapse_sdk/plugins/categories/data_validation/templates/plugin/validation.py,sha256=_K1fAp027Q75msY-H_Vyv3hb60A4OthE2nmHtXjSCNw,1011
 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
@@ -221,9 +221,9 @@ synapse_sdk/utils/storage/providers/gcp.py,sha256=i2BQCu1Kej1If9SuNr2_lEyTcr5M_n
 synapse_sdk/utils/storage/providers/http.py,sha256=2DhIulND47JOnS5ZY7MZUex7Su3peAPksGo1Wwg07L4,5828
 synapse_sdk/utils/storage/providers/s3.py,sha256=ZmqekAvIgcQBdRU-QVJYv1Rlp6VHfXwtbtjTSphua94,2573
 synapse_sdk/utils/storage/providers/sftp.py,sha256=_8s9hf0JXIO21gvm-JVS00FbLsbtvly4c-ETLRax68A,1426
-synapse_sdk-1.0.0a85.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
-synapse_sdk-1.0.0a85.dist-info/METADATA,sha256=lnvtAkzoGwUHFDJaquTJ4__V14LCGxF6qA9p-s-aGKY,3805
-synapse_sdk-1.0.0a85.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-synapse_sdk-1.0.0a85.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
-synapse_sdk-1.0.0a85.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
-synapse_sdk-1.0.0a85.dist-info/RECORD,,
+synapse_sdk-1.0.0a86.dist-info/licenses/LICENSE,sha256=bKzmC5YAg4V1Fhl8OO_tqY8j62hgdncAkN7VrdjmrGk,1101
+synapse_sdk-1.0.0a86.dist-info/METADATA,sha256=Spzp2B5PSKr6fMRT2fiV_UhJtqgGQUmx1hg1-s7cDOY,3805
+synapse_sdk-1.0.0a86.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+synapse_sdk-1.0.0a86.dist-info/entry_points.txt,sha256=VNptJoGoNJI8yLXfBmhgUefMsmGI0m3-0YoMvrOgbxo,48
+synapse_sdk-1.0.0a86.dist-info/top_level.txt,sha256=ytgJMRK1slVOKUpgcw3LEyHHP7S34J6n_gJzdkcSsw8,12
+synapse_sdk-1.0.0a86.dist-info/RECORD,,