get_user_submissions returns generator object

Author: jaymedina

synapseclient/api/evaluation_services.py

@@ -487,12 +487,11 @@ async def get_evaluation_submissions(
 async def get_user_submissions(
     evaluation_id: str,
     user_id: Optional[str] = None,
-    limit: int = 20,
-    offset: int = 0,
+    *,
     synapse_client: Optional["Synapse"] = None,
-) -> dict:
+) -> AsyncGenerator[Dict[str, Any], None]:
     """
-    Retrieves Submissions for a specified Evaluation queue and user.
+    Generator to get all user Submissions for a specified Evaluation queue.
     If user_id is omitted, this returns the submissions of the caller.
 
     <https://rest-docs.synapse.org/rest/GET/evaluation/evalId/submission.html>
@@ -501,28 +500,26 @@ async def get_user_submissions(
         evaluation_id: The ID of the evaluation queue.
         user_id: Optionally specify the ID of the user whose submissions will be returned.
                 If omitted, this returns the submissions of the caller.
-        limit: Limits the number of submissions in a single response. Default to 20.
-        offset: The offset index determines where this page will start from.
-                An index of 0 is the first submission. Default to 0.
         synapse_client: If not passed in and caching was not disabled by `Synapse.allow_client_caching(False)`
                         this will use the last created instance from the Synapse class constructor.
 
-    Returns:
-        A response JSON containing a paginated list of user submissions for the evaluation queue.
+    Yields:
+        Individual Submission objects from each page of the response.
     """
     from synapseclient import Synapse
 
     client = Synapse.get_client(synapse_client=synapse_client)
 
     uri = f"/evaluation/{evaluation_id}/submission"
-    query_params = {"limit": limit, "offset": offset}
+    query_params = {}
 
     if user_id:
         query_params["userId"] = user_id
 
-    response = await client.rest_get_async(uri, params=query_params)
-
-    return response
+    async for item in rest_get_paginated_async(
+        uri=uri, params=query_params, synapse_client=client
+    ):
+        yield item
 
 
 async def get_submission_count(

synapseclient/models/submission.py

@@ -192,32 +192,28 @@ def get_evaluation_submissions(
             synapse_client=synapse_client,
         )
 
-    @staticmethod
+    @classmethod
     def get_user_submissions(
+        cls,
         evaluation_id: str,
         user_id: Optional[str] = None,
-        limit: int = 20,
-        offset: int = 0,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> Dict:
+    ) -> Generator["Submission", None, None]:
         """
-        Retrieves Submissions for a specified Evaluation queue and user.
+        Retrieves all user Submissions for a specified Evaluation queue.
         If user_id is omitted, this returns the submissions of the caller.
 
         Arguments:
             evaluation_id: The ID of the evaluation queue.
             user_id: Optionally specify the ID of the user whose submissions will be returned.
                     If omitted, this returns the submissions of the caller.
-            limit: Limits the number of submissions in a single response. Default to 20.
-            offset: The offset index determines where this page will start from.
-                    An index of 0 is the first submission. Default to 0.
             synapse_client: If not passed in and caching was not disabled by
                 `Synapse.allow_client_caching(False)` this will use the last created
                 instance from the Synapse class constructor.
 
         Returns:
-            A response JSON containing a paginated list of user submissions for the evaluation queue.
+            Submission objects as they are retrieved from the API.
 
         Example: Getting user submissions
             ```python
@@ -227,15 +223,19 @@ def get_user_submissions(
             syn = Synapse()
             syn.login()
 
-            response = Submission.get_user_submissions(
+            submissions = list(Submission.get_user_submissions(
                 evaluation_id="9999999",
-                user_id="123456",
-                limit=10
-            )
-            print(f"Found {len(response['results'])} user submissions")
+                user_id="123456"
+            ))
+            print(f"Found {len(submissions)} user submissions")
             ```
         """
-        return {}
+        yield from wrap_async_generator_to_sync_generator(
+            async_gen_func=cls.get_user_submissions_async,
+            evaluation_id=evaluation_id,
+            user_id=user_id,
+            synapse_client=synapse_client,
+        )
 
     @staticmethod
     def get_submission_count(
@@ -706,32 +706,29 @@ async def get_evaluation_submissions_example():
             submission_object = cls().fill_from_dict(synapse_submission=submission_data)
             yield submission_object
 
-    @staticmethod
+    @skip_async_to_sync
+    @classmethod
     async def get_user_submissions_async(
+        cls,
         evaluation_id: str,
         user_id: Optional[str] = None,
-        limit: int = 20,
-        offset: int = 0,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> Dict:
+    ) -> AsyncGenerator["Submission", None]:
         """
-        Retrieves Submissions for a specified Evaluation queue and user.
+        Generator to get all user Submissions for a specified Evaluation queue.
         If user_id is omitted, this returns the submissions of the caller.
 
         Arguments:
             evaluation_id: The ID of the evaluation queue.
             user_id: Optionally specify the ID of the user whose submissions will be returned.
                     If omitted, this returns the submissions of the caller.
-            limit: Limits the number of submissions in a single response. Default to 20.
-            offset: The offset index determines where this page will start from.
-                    An index of 0 is the first submission. Default to 0.
             synapse_client: If not passed in and caching was not disabled by
                 `Synapse.allow_client_caching(False)` this will use the last created
                 instance from the Synapse class constructor.
 
-        Returns:
-            A response JSON containing a paginated list of user submissions for the evaluation queue.
+        Yields:
+            Individual Submission objects from each page of the response.
 
         Example: Getting user submissions
             ```python
@@ -743,23 +740,24 @@ async def get_user_submissions_async(
             syn.login()
 
             async def get_user_submissions_example():
-                response = await Submission.get_user_submissions_async(
+                submissions = []
+                async for submission in Submission.get_user_submissions_async(
                     evaluation_id="9999999",
-                    user_id="123456",
-                    limit=10
-                )
-                print(f"Found {len(response['results'])} user submissions")
+                    user_id="123456"
+                ):
+                    submissions.append(submission)
+                print(f"Found {len(submissions)} user submissions")
 
             asyncio.run(get_user_submissions_example())
             ```
         """
-        return await evaluation_services.get_user_submissions(
+        async for submission_data in evaluation_services.get_user_submissions(
             evaluation_id=evaluation_id,
             user_id=user_id,
-            limit=limit,
-            offset=offset,
             synapse_client=synapse_client,
-        )
+        ):
+            submission_object = cls().fill_from_dict(synapse_submission=submission_data)
+            yield submission_object
 
     @staticmethod
     async def get_submission_count_async(

tests/integration/synapseclient/models/async/test_submission_async.py

@@ -295,14 +295,34 @@ async def test_get_evaluation_submissions_async_generator_behavior(
         assert all(isinstance(sub, Submission) for sub in submissions)
 
     async def test_get_user_submissions_async(self, test_evaluation: Evaluation):
-        # WHEN I get submissions for the current user using async method
-        response = await Submission.get_user_submissions_async(
+        # WHEN I get submissions for the current user using async generator
+        submissions = []
+        async for submission in Submission.get_user_submissions_async(
             evaluation_id=test_evaluation.id, synapse_client=self.syn
-        )
+        ):
+            submissions.append(submission)
 
-        # THEN I should get a response with user submissions
-        assert "results" in response
+        # THEN all submissions should be valid Submission objects
         # Note: Could be empty if user hasn't made submissions to this evaluation
+        assert all(isinstance(sub, Submission) for sub in submissions)
+
+    async def test_get_user_submissions_async_generator_behavior(
+        self, test_evaluation: Evaluation
+    ):
+        # WHEN I get user submissions using the async generator
+        submissions_generator = Submission.get_user_submissions_async(
+            evaluation_id=test_evaluation.id,
+            synapse_client=self.syn,
+        )
+
+        # THEN I should be able to iterate through the results
+        submissions = []
+        async for submission in submissions_generator:
+            assert isinstance(submission, Submission)
+            submissions.append(submission)
+            
+        # AND all submissions should be valid Submission objects
+        assert all(isinstance(sub, Submission) for sub in submissions)
 
     async def test_get_submission_count_async(self, test_evaluation: Evaluation):
         # WHEN I get the submission count for an evaluation using async method

tests/integration/synapseclient/models/synchronous/test_submission.py

@@ -285,13 +285,32 @@ async def test_get_evaluation_submissions_generator_behavior(
 
     async def test_get_user_submissions(self, test_evaluation: Evaluation):
         # WHEN I get submissions for the current user
-        response = Submission.get_user_submissions(
+        submissions_generator = Submission.get_user_submissions(
             evaluation_id=test_evaluation.id, synapse_client=self.syn
         )
 
-        # THEN I should get a response with user submissions
-        assert "results" in response
+        # THEN I should get a generator that yields Submission objects
+        submissions = list(submissions_generator)
         # Note: Could be empty if user hasn't made submissions to this evaluation
+        assert all(isinstance(sub, Submission) for sub in submissions)
+
+    async def test_get_user_submissions_generator_behavior(
+        self, test_evaluation: Evaluation
+    ):
+        # WHEN I get user submissions using the generator
+        submissions_generator = Submission.get_user_submissions(
+            evaluation_id=test_evaluation.id,
+            synapse_client=self.syn,
+        )
+
+        # THEN I should be able to iterate through the results
+        submissions = []
+        for submission in submissions_generator:
+            assert isinstance(submission, Submission)
+            submissions.append(submission)
+            
+        # AND all submissions should be valid Submission objects
+        assert all(isinstance(sub, Submission) for sub in submissions)
 
     async def test_get_submission_count(self, test_evaluation: Evaluation):
         # WHEN I get the submission count for an evaluation

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

@@ -515,37 +515,36 @@ async def test_get_user_submissions_async(self) -> None:
         # GIVEN user submission parameters
         evaluation_id = EVALUATION_ID
         user_id = USER_ID
-        limit = 15
-        offset = 0
-
-        expected_response = {
-            "results": [self.get_example_submission_response()],
-            "totalNumberOfResults": 1,
-        }
 
         # WHEN I call get_user_submissions_async
         with patch(
-            "synapseclient.api.evaluation_services.get_user_submissions",
-            new_callable=AsyncMock,
-            return_value=expected_response,
+            "synapseclient.api.evaluation_services.get_user_submissions"
         ) as mock_get_user_submissions:
-            response = await Submission.get_user_submissions_async(
+            # Create an async generator function that yields submission data
+            async def mock_async_gen(*args, **kwargs):
+                submission_data = self.get_example_submission_response()
+                yield submission_data
+
+            # Make the mock return our async generator when called
+            mock_get_user_submissions.side_effect = mock_async_gen
+
+            submissions = []
+            async for submission in Submission.get_user_submissions_async(
                 evaluation_id=evaluation_id,
                 user_id=user_id,
-                limit=limit,
-                offset=offset,
                 synapse_client=self.syn,
-            )
+            ):
+                submissions.append(submission)
 
-            # THEN it should call the API with correct parameters
+            # THEN it should call the API with correct parameters and yield Submission objects
             mock_get_user_submissions.assert_called_once_with(
                 evaluation_id=evaluation_id,
                 user_id=user_id,
-                limit=limit,
-                offset=offset,
                 synapse_client=self.syn,
             )
-            assert response == expected_response
+            assert len(submissions) == 1
+            assert isinstance(submissions[0], Submission)
+            assert submissions[0].id == SUBMISSION_ID
 
     @pytest.mark.asyncio
     async def test_get_submission_count_async(self) -> None:

tests/unit/synapseclient/models/synchronous/unit_test_submission.py

@@ -678,37 +678,36 @@ async def test_get_user_submissions_async(self) -> None:
         # GIVEN user submission parameters
         evaluation_id = EVALUATION_ID
         user_id = USER_ID
-        limit = 15
-        offset = 0
-
-        expected_response = {
-            "results": [self.get_example_submission_response()],
-            "totalNumberOfResults": 1,
-        }
 
         # WHEN I call get_user_submissions_async
         with patch(
-            "synapseclient.api.evaluation_services.get_user_submissions",
-            new_callable=AsyncMock,
-            return_value=expected_response,
+            "synapseclient.api.evaluation_services.get_user_submissions"
         ) as mock_get_user_submissions:
-            response = await Submission.get_user_submissions_async(
+            # Create an async generator function that yields submission data
+            async def mock_async_gen(*args, **kwargs):
+                submission_data = self.get_example_submission_response()
+                yield submission_data
+
+            # Make the mock return our async generator when called
+            mock_get_user_submissions.side_effect = mock_async_gen
+
+            submissions = []
+            async for submission in Submission.get_user_submissions_async(
                 evaluation_id=evaluation_id,
                 user_id=user_id,
-                limit=limit,
-                offset=offset,
                 synapse_client=self.syn,
-            )
+            ):
+                submissions.append(submission)
 
-            # THEN it should call the API with correct parameters
+            # THEN it should call the API with correct parameters and yield Submission objects
             mock_get_user_submissions.assert_called_once_with(
                 evaluation_id=evaluation_id,
                 user_id=user_id,
-                limit=limit,
-                offset=offset,
                 synapse_client=self.syn,
             )
-            assert response == expected_response
+            assert len(submissions) == 1
+            assert isinstance(submissions[0], Submission)
+            assert submissions[0].id == SUBMISSION_ID
 
     @pytest.mark.asyncio
     async def test_get_submission_count_async(self) -> None: