[MCC-1493223] Python SDK-Update Get Studies Function

dataconnect/models.py

@@ -22,7 +22,7 @@ class Study:
 
 @dataclass(frozen=True)
 class StudiesResult:
-    total: int
+    total_records: int
     studies: list[Study]
 
 

dataconnect/service/default.py

@@ -41,19 +41,18 @@ def get_studies(self, search_study_name: str | None = None) -> StudiesResult:
 
         Returns:
             A :class:`StudiesResult` containing:
-            - ``total``: total number of studies accessible to the authenticated user.
+            - ``total_records``: total number of studies accessible to the authenticated user.
             - ``studies``: list of :class:`Study` objects matching the criteria.
         """
 
         request = ResourceQuery(action=_ACTION_LIST_STUDIES)
-        if search_study_name and search_study_name.strip() != "":
-            request = request.append_body({"search_study_name": search_study_name})
+        request = request.append_body({"search_study_name": search_study_name})
 
         try:
             resources = self._transport.list_resources(request)
-            total = resources[0].total_records if resources else 0
+            total_records = resources[0].total_records if resources else 0
             studies = [resource_to_study(r) for r in resources]
-            return StudiesResult(total=total, studies=studies)
+            return StudiesResult(total_records=total_records, studies=studies)
         except Exception as ex:
             raise translate_error(ex) from ex
 

tests/test_client.py

@@ -8,7 +8,7 @@
 # # import pytest
 
 # from dataconnect.client import DataConnectClient
-# from dataconnect.models import Dataset, DatasetVersion, Study, StudiesResult
+# from dataconnect.models import StudiesResult
 
 
 # def _make_dataframe() -> pd.DataFrame:
@@ -162,7 +162,7 @@
 
 #     def get_studies(self, search_study_name: str | None = None) -> StudiesResult:
 #         self.search_study_name = search_study_name
-#         return StudiesResult(total=0, studies=[])
+#         return StudiesResult(total_records=0, studies=[])
 
 #     def close(self) -> None:
 #         self.was_closed = True
@@ -175,7 +175,7 @@
 #     result = client.get_studies()
 
 #     assert isinstance(result, StudiesResult)
-#     assert result.total == 0
+#     assert result.total_records == 0
 #     assert result.studies == []
 #     assert service.search_study_name is None
 
@@ -187,7 +187,7 @@
 #     result = client.get_studies(search_study_name="cardio")
 
 #     assert isinstance(result, StudiesResult)
-#     assert result.total == 0
+#     assert result.total_records == 0
 #     assert result.studies == []
 #     assert service.search_study_name == "cardio"
 

tests/test_service_default.py

@@ -1,8 +1,5 @@
 # from __future__ import annotations
 
-# import pytest
-
-# from dataconnect.exceptions import ValidationError
 # from dataconnect.models import StudiesResult
 # from dataconnect.service.default import DefaultDataConnectService
 # from dataconnect.transport.models import DataRef, ResourceInfo, ResourceQuery
@@ -32,19 +29,21 @@
 #     )
 
 
-# def test_get_studies_without_search_name_uses_empty_request_body() -> None:
+# def test_get_studies_without_search_name_uses_none_in_body() -> None:
+#     # When called without a filter, search_study_name defaults to None and is
+#     # included in the JSON body as null.
 #     transport = StubTransport(resources=[_study_resource()])
 #     service = DefaultDataConnectService(transport)
 
 #     result = service.get_studies()
 
 #     assert isinstance(result, StudiesResult)
-#     assert result.total == 1
+#     assert result.total_records == 1
 #     assert len(result.studies) == 1
 #     assert result.studies[0].name == "Study A"
 #     assert transport.last_request is not None
 #     assert transport.last_request.action == "studies.list"
-#     assert transport.last_request.body == ""
+#     assert transport.last_request.body == '{"search_study_name":null}'
 
 
 # def test_get_studies_with_search_name_sets_request_body() -> None:
@@ -54,7 +53,7 @@
 #     result = service.get_studies(search_study_name="Cardio")
 
 #     assert isinstance(result, StudiesResult)
-#     assert result.total == 5
+#     assert result.total_records == 5
 #     assert len(result.studies) == 1
 #     assert result.studies[0].name == "Cardio Study"
 #     assert transport.last_request is not None
@@ -68,11 +67,12 @@
 #     result = service.get_studies()
 
 #     assert isinstance(result, StudiesResult)
-#     assert result.total == 0
+#     assert result.total_records == 0
 #     assert result.studies == []
 
 
 # def test_get_studies_accepts_none_search_name() -> None:
+#     # Passing None explicitly is the same as the default — body contains null.
 #     transport = StubTransport(resources=[_study_resource()])
 #     service = DefaultDataConnectService(transport)
 
@@ -81,4 +81,4 @@
 #     assert isinstance(result, StudiesResult)
 #     assert len(result.studies) == 1
 #     assert transport.last_request is not None
-#     assert transport.last_request.body == ""
+#     assert transport.last_request.body == '{"search_study_name":null}'