SK-2142 return None on empty error response

Author: raushan-skyflow

skyflow/utils/_utils.py

@@ -211,7 +211,6 @@ def get_metrics():
     }
     return details_dic
 
-
 def parse_insert_response(api_response, continue_on_error):
     # Retrieve the headers and data from the API response
     api_response_headers = api_response.headers
@@ -244,8 +243,7 @@ def parse_insert_response(api_response, continue_on_error):
                 errors.append(error)
 
             insert_response.inserted_fields = inserted_fields
-            insert_response.errors = errors
-
+            insert_response.errors = errors if len(errors) > 0 else None
     else:
         for record in api_response_data.records:
             field_data = {
@@ -257,6 +255,7 @@ def parse_insert_response(api_response, continue_on_error):
 
             inserted_fields.append(field_data)
         insert_response.inserted_fields = inserted_fields
+        insert_response.errors = None
 
     return insert_response
 
@@ -275,21 +274,17 @@ def parse_delete_response(api_response: V1BulkDeleteRecordResponse):
     delete_response = DeleteResponse()
     deleted_ids = api_response.record_id_response
     delete_response.deleted_ids = deleted_ids
-    delete_response.errors = []
+    delete_response.errors = None
     return delete_response
 
-
 def parse_get_response(api_response: V1BulkGetRecordResponse):
     get_response = GetResponse()
     data = []
-    errors = []
     for record in api_response.records:
         field_data = {field: value for field, value in record.fields.items()}
         data.append(field_data)
 
     get_response.data = data
-    get_response.errors = errors
-
     return get_response
 
 def parse_detokenize_response(api_response: HttpResponse[V1DetokenizeResponse]):
@@ -320,7 +315,7 @@ def parse_detokenize_response(api_response: HttpResponse[V1DetokenizeResponse]):
     errors = errors
     detokenize_response = DetokenizeResponse()
     detokenize_response.detokenized_fields = detokenized_fields
-    detokenize_response.errors = errors
+    detokenize_response.errors = errors if len(errors) > 0 else None
 
     return detokenize_response
 

skyflow/vault/controller/_detect.py

@@ -137,7 +137,7 @@ def output_to_dict_list(output):
             entities=entities,
             run_id=run_id_val,
             status=status_val,
-            errors=[]
+            errors=None
         )
 
     def __get_token_format(self, request):

skyflow/vault/data/_insert_response.py

@@ -1,7 +1,5 @@
 class InsertResponse:
     def __init__(self, inserted_fields = None, errors=None):
-        if errors is None:
-            errors = list()
         self.inserted_fields = inserted_fields
         self.errors = errors
 

skyflow/vault/data/_query_response.py

@@ -1,7 +1,7 @@
 class QueryResponse:
     def __init__(self):
         self.fields = []
-        self.errors = []
+        self.errors = None
 
     def __repr__(self):
         return f"QueryResponse(fields={self.fields}, errors={self.errors})"

skyflow/vault/data/_update_response.py

@@ -1,7 +1,7 @@
 class UpdateResponse:
     def __init__(self, updated_field = None, errors=None):
         self.updated_field = updated_field
-        self.errors = errors if errors is not None else []
+        self.errors = errors
 
     def __repr__(self):
         return f"UpdateResponse(updated_field={self.updated_field}, errors={self.errors})"

skyflow/vault/detect/_deidentify_file_response.py

@@ -13,7 +13,7 @@ def __init__(
         entities: list = None,  # list of dicts with keys 'file' and 'extension'
         run_id: str = None,
         status: str = None,
-        errors: list = [],
+        errors: list = None,
     ):
         self.file = file
         self.type = type

tests/vault/controller/test__detect.py

@@ -153,7 +153,7 @@ def test_deidentify_file_txt_success(self, mock_open, mock_basename, mock_base64
                                                                  word_count=1, char_count=1, size_in_kb=1,
                                                                  duration_in_seconds=None, page_count=None,
                                                                  slide_count=None, entities=[], run_id="runid123",
-                                                                 status="SUCCESS", errors=[])) as mock_parse:
+                                                                 status="SUCCESS", errors=None)) as mock_parse:
             result = self.detect.deidentify_file(req)
             mock_validate.assert_called_once()
             files_api.deidentify_text.assert_called_once()
@@ -196,7 +196,7 @@ def test_deidentify_file_audio_success(self, mock_base64, mock_validate):
                                                                  word_count=1, char_count=1, size_in_kb=1,
                                                                  duration_in_seconds=1, page_count=None,
                                                                  slide_count=None, entities=[], run_id="runid456",
-                                                                 status="SUCCESS", errors=[])) as mock_parse:
+                                                                 status="SUCCESS", errors=None)) as mock_parse:
             result = self.detect.deidentify_file(req)
             mock_validate.assert_called_once()
             files_api.deidentify_audio.assert_called_once()
@@ -238,7 +238,7 @@ def test_get_detect_run_success(self, mock_validate):
                                                               char_count=1, size_in_kb=1, duration_in_seconds=None,
                                                               page_count=None, slide_count=None, entities=[],
                                                               run_id="runid789", status="SUCCESS",
-                                                              errors=[])) as mock_parse:
+                                                              errors=None)) as mock_parse:
             result = self.detect.get_detect_run(req)
             mock_validate.assert_called_once()
             files_api.get_run.assert_called_once()
@@ -289,7 +289,7 @@ def test_deidentify_file_all_branches(self, mock_poll, mock_open, mock_basename,
                               file="dGVzdCBjb250ZW50", type="pdf", extension="pdf",
                               word_count=1, char_count=1, size_in_kb=1,
                               duration_in_seconds=1, page_count=1, slide_count=1,
-                              entities=[], run_id="runid123", status="SUCCESS", errors=[]
+                              entities=[], run_id="runid123", status="SUCCESS", errors=None
                           )) as mock_parse:
             # Test configuration for different file types
             test_cases = [

tests/vault/controller/test__vault.py

@@ -123,7 +123,7 @@ def test_insert_with_continue_on_error_false(self, mock_parse_response, mock_val
 
         # Assert that the result matches the expected InsertResponse
         self.assertEqual(result.inserted_fields, expected_inserted_fields)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_insert_request")
     def test_insert_handles_generic_error(self, mock_validate):
@@ -181,7 +181,7 @@ def test_insert_with_continue_on_error_false_when_tokens_are_not_none(self, mock
 
         # Assert that the result matches the expected InsertResponse
         self.assertEqual(result.inserted_fields, expected_inserted_fields)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_update_request")
     @patch("skyflow.vault.controller._vault.parse_update_record_response")
@@ -223,7 +223,7 @@ def test_update_successful(self, mock_parse_response, mock_validate):
 
         # Check that the result matches the expected UpdateResponse
         self.assertEqual(result.updated_field, expected_updated_field)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_update_request")
     def test_update_handles_generic_error(self, mock_validate):
@@ -257,7 +257,7 @@ def test_delete_successful(self, mock_parse_response, mock_validate):
 
         # Expected parsed response
         expected_deleted_ids = ["12345", "67890"]
-        expected_response = DeleteResponse(deleted_ids=expected_deleted_ids, errors=[])
+        expected_response = DeleteResponse(deleted_ids=expected_deleted_ids, errors=None)
 
         # Set the return value for the parse response
         mock_parse_response.return_value = expected_response
@@ -273,7 +273,7 @@ def test_delete_successful(self, mock_parse_response, mock_validate):
 
         # Check that the result matches the expected DeleteResponse
         self.assertEqual(result.deleted_ids, expected_deleted_ids)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_delete_request")
     def test_delete_handles_generic_exception(self, mock_validate):
@@ -330,7 +330,7 @@ def test_get_successful(self, mock_parse_response, mock_validate):
             {"field1": "value1", "field2": "value2"},
             {"field1": "value3", "field2": "value4"}
         ]
-        expected_response = GetResponse(data=expected_data, errors=[])
+        expected_response = GetResponse(data=expected_data, errors=None)
 
         # Set the return value for parse_get_response
         mock_parse_response.return_value = expected_response
@@ -346,7 +346,7 @@ def test_get_successful(self, mock_parse_response, mock_validate):
 
         # Check that the result matches the expected GetResponse
         self.assertEqual(result.data, expected_data)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_get_request")
     @patch("skyflow.vault.controller._vault.parse_get_response")
@@ -381,7 +381,7 @@ def test_get_successful_with_column_values(self, mock_parse_response, mock_valid
             {"field1": "value1", "field2": "value2"},
             {"field1": "value3", "field2": "value4"}
         ]
-        expected_response = GetResponse(data=expected_data, errors=[])
+        expected_response = GetResponse(data=expected_data, errors=None)
 
         # Set the return value for parse_get_response
         mock_parse_response.return_value = expected_response
@@ -397,7 +397,7 @@ def test_get_successful_with_column_values(self, mock_parse_response, mock_valid
 
         # Check that the result matches the expected GetResponse
         self.assertEqual(result.data, expected_data)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_get_request")
     def test_get_handles_generic_error(self, mock_validate):
@@ -446,7 +446,7 @@ def test_query_successful(self, mock_parse_response, mock_validate):
 
         # Check that the result matches the expected QueryResponse
         self.assertEqual(result.fields, expected_fields)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_query_request")
     def test_query_handles_generic_error(self, mock_validate):
@@ -495,7 +495,7 @@ def test_detokenize_successful(self, mock_parse_response, mock_validate):
             {"token": "token1", "value": "value1", "type": "STRING"},
             {"token": "token2", "value": "value2", "type": "STRING"}
         ]
-        expected_response = DetokenizeResponse(detokenized_fields=expected_fields, errors=[])
+        expected_response = DetokenizeResponse(detokenized_fields=expected_fields, errors=None)
 
         # Set the return value for parse_detokenize_response
         mock_parse_response.return_value = expected_response
@@ -511,7 +511,7 @@ def test_detokenize_successful(self, mock_parse_response, mock_validate):
 
         # Check that the result matches the expected DetokenizeResponse
         self.assertEqual(result.detokenized_fields, expected_fields)
-        self.assertEqual(result.errors, [])  # No errors expected
+        self.assertEqual(result.errors, None)  # No errors expected
 
     @patch("skyflow.vault.controller._vault.validate_detokenize_request")
     def test_detokenize_handles_generic_error(self, mock_validate):