rename to form submission status

Author: Lingling Peng

synapseclient/models/mixins/__init__.py

@@ -6,8 +6,8 @@
     FormChangeRequest,
     FormData,
     FormGroup,
+    FormSubmissionStatus,
     StateEnum,
-    SubmissionStatus,
 )
 from synapseclient.models.mixins.json_schema import (
     BaseJSONSchema,
@@ -38,6 +38,6 @@
     "FormGroup",
     "FormData",
     "FormChangeRequest",
-    "SubmissionStatus",
+    "FormSubmissionStatus",
     "StateEnum",
 ]

synapseclient/models/mixins/form.py

@@ -64,7 +64,7 @@ class StateEnum(str, Enum):
 
 
 @dataclass
-class SubmissionStatus:
+class FormSubmissionStatus:
     """
     The status of a submitted FormData object.
     """
@@ -84,15 +84,17 @@ class SubmissionStatus:
     rejection_message: Optional[str] = None
     """The message provided by the reviewer when a submission is rejected."""
 
-    def fill_from_dict(self, synapse_response: dict[str, Any]) -> "SubmissionStatus":
+    def fill_from_dict(
+        self, synapse_response: dict[str, Any]
+    ) -> "FormSubmissionStatus":
         """
         Converts a response from the REST API into this dataclass.
 
         Arguments:
             synapse_response: The response dictionary from the Synapse REST API.
 
         Returns:
-            This SubmissionStatus object with populated fields.
+            This FormSubmissionStatus object with populated fields.
         """
         self.submitted_on = synapse_response.get("submittedOn", None)
         self.reviewed_on = synapse_response.get("reviewedOn", None)
@@ -139,7 +141,7 @@ class FormData:
     data_file_handle_id: Optional[str] = None
     """The identifier of the data FileHandle for this object."""
 
-    submission_status: Optional[SubmissionStatus] = None
+    submission_status: Optional[FormSubmissionStatus] = None
     """The status of a submitted FormData object."""
 
     def fill_from_dict(self, synapse_response: dict[str, Any]) -> "FormData":
@@ -165,7 +167,7 @@ def fill_from_dict(self, synapse_response: dict[str, Any]) -> "FormData":
             "submissionStatus" in synapse_response
             and synapse_response["submissionStatus"] is not None
         ):
-            self.submission_status = SubmissionStatus().fill_from_dict(
+            self.submission_status = FormSubmissionStatus().fill_from_dict(
                 synapse_response["submissionStatus"]
             )
 

tests/unit/synapseclient/mixins/unit_test_form.py

@@ -2,8 +2,8 @@
     FormChangeRequest,
     FormData,
     FormGroup,
+    FormSubmissionStatus,
     StateEnum,
-    SubmissionStatus,
 )
 
 
@@ -67,12 +67,12 @@ def test_to_dict_with_all_fields(self):
         assert result == {"name": "my_form_name", "fileHandleId": "123456"}
 
 
-class TestSubmissionStatus:
+class TestFormSubmissionStatus:
     """Unit tests for SubmissionStatus dataclass"""
 
-    def test_submission_status_initialization(self) -> None:
-        """Test initialization of SubmissionStatus with all fields"""
-        status = SubmissionStatus(
+    def test_form_submission_status_initialization(self) -> None:
+        """Test initialization of FormSubmissionStatus with all fields"""
+        status = FormSubmissionStatus(
             submitted_on="2024-01-01T00:00:00.000Z",
             reviewed_on="2024-01-02T00:00:00.000Z",
             reviewed_by="user_123",
@@ -83,14 +83,14 @@ def test_submission_status_initialization(self) -> None:
         assert status.reviewed_by == "user_123"
 
     def test_fill_from_dict(self) -> None:
-        """Test fill_from_dict method of SubmissionStatus"""
+        """Test fill_from_dict method of FormSubmissionStatus"""
         response_dict = {
             "submittedOn": "2024-01-01T00:00:00.000Z",
             "reviewedOn": "2024-01-02T00:00:00.000Z",
             "reviewedBy": "user_123",
         }
 
-        status = SubmissionStatus().fill_from_dict(response_dict)
+        status = FormSubmissionStatus().fill_from_dict(response_dict)
 
         assert status.submitted_on == "2024-01-01T00:00:00.000Z"
         assert status.reviewed_on == "2024-01-02T00:00:00.000Z"
@@ -103,7 +103,7 @@ def test_fill_from_dict_missing_fields(self) -> None:
             # 'reviewedOn' and 'reviewedBy' are missing
         }
 
-        status = SubmissionStatus().fill_from_dict(response_dict)
+        status = FormSubmissionStatus().fill_from_dict(response_dict)
 
         assert status.submitted_on == "2024-01-01T00:00:00.000Z"
         assert status.reviewed_on is None