turn schema to required; fix delete_none_key

Author: Lingling Peng

synapseclient/models/curation.py

@@ -1008,15 +1008,15 @@ class GridCsvImportRequest(AsynchronousCommunicator):
     file_handle_id: str
     """The id of the file handle that contains the CSV data."""
 
+    schema: list[Column]
+    """The list of ColumnModel that describe the CSV file. Currently this is required."""
+
     concrete_type: str = GRID_CSV_IMPORT_REQUEST
     """The concrete type for this request."""
 
     csv_descriptor: CsvTableDescriptor = field(default_factory=CsvTableDescriptor)
     """The description of a csv for upload or download."""
 
-    schema: Optional[List[Column]] = None
-    """The list of ColumnModel that describe the CSV file. Currently this is required."""
-
     # Response fields (populated by fill_from_dict)
     total_count: Optional[int] = field(default=None, compare=False)
     """The total number of rows in the CSV."""
@@ -1089,7 +1089,7 @@ class UploadToTablePreviewRequest(AsynchronousCommunicator):
     csv_table_descriptor: CsvTableDescriptor = field(default_factory=CsvTableDescriptor)
     """The description of a csv for upload or download."""
 
-    do_full_file_scan: Optional[bool] = None
+    do_full_file_scan: Optional[bool] = False
     """When set to true the full file will be scanned for a schema suggestions. A full scan is more accurate but can take more time. When set to false only a sub-set of the first rows will be scanned, which can be faster but is less accurate. The default value is false."""
 
     # Response fields (populated by fill_from_dict)
@@ -1140,9 +1140,12 @@ def to_synapse_request(self) -> Dict[str, Any]:
             "concreteType": self.concrete_type,
             "uploadFileHandleId": self.upload_file_handle_id,
             "linesToSkip": self.lines_to_skip,
-            "csvTableDescriptor": self.csv_table_descriptor.to_synapse_request(),
             "doFullFileScan": self.do_full_file_scan,
         }
+        if self.csv_table_descriptor is not None:
+            request_dict["csvTableDescriptor"] = (
+                self.csv_table_descriptor.to_synapse_request()
+            )
         delete_none_keys(request_dict)
         return request_dict
 

tests/unit/synapseclient/models/async/unit_test_curation_async.py

@@ -859,6 +859,7 @@ async def test_import_csv_async(self) -> None:
         mock_import_response = GridCsvImportRequest(
             session_id=SESSION_ID,
             file_handle_id=FILE_HANDLE_ID,
+            schema=expected_columns,
             total_count=1,
             created_count=1,
             updated_count=1,
@@ -1055,7 +1056,9 @@ def test_fill_from_dict(self) -> None:
 
         # WHEN I fill a GridCsvImportRequest from the response
         import_req = GridCsvImportRequest(
-            session_id=SESSION_ID, file_handle_id=FILE_HANDLE_ID
+            session_id=SESSION_ID,
+            file_handle_id=FILE_HANDLE_ID,
+            schema=[Column(name="col1", column_type="STRING")],
         )
         result = import_req.fill_from_dict(raw_synapse_response)