APP-14644 BinaryDataByIDs allow specifying include_binary (#1053)

Author: n0nick

src/viam/app/data_client.py

@@ -790,6 +790,7 @@ async def binary_data_by_filter(
     async def binary_data_by_ids(
         self,
         binary_ids: Union[List[BinaryID], List[str]],
+        include_binary_data: bool = True,
         dest: Optional[str] = None,
     ) -> List[BinaryData]:
         """Filter and download binary data.
@@ -812,6 +813,8 @@ async def binary_data_by_ids(
                 :class:`BinaryID` objects. Must be non-empty.
                 *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
                 list of strings.*
+            include_binary_data (bool): Boolean specifying whether to actually include the binary file data with each retrieved file.
+                Defaults to true (that is, both the files' data and metadata are returned).
             dest (str): Optional filepath for writing retrieved data.
 
         Raises:
@@ -825,10 +828,10 @@ async def binary_data_by_ids(
         request = BinaryDataByIDsRequest()
         if len(binary_ids) > 0 and isinstance(binary_ids[0], str):
             binary_data_ids = cast(List[str], binary_ids)
-            request = BinaryDataByIDsRequest(binary_data_ids=binary_data_ids, include_binary=True)
+            request = BinaryDataByIDsRequest(binary_data_ids=binary_data_ids, include_binary=include_binary_data)
         else:
             bin_ids = cast(List[BinaryID], binary_ids)
-            request = BinaryDataByIDsRequest(binary_ids=bin_ids, include_binary=True)
+            request = BinaryDataByIDsRequest(binary_ids=bin_ids, include_binary=include_binary_data)
         response: BinaryDataByIDsResponse = await self._data_client.BinaryDataByIDs(request, metadata=self._metadata)
         if dest:
             try:

tests/mocks/services.py

@@ -928,6 +928,7 @@ async def BinaryDataByIDs(self, stream: Stream[BinaryDataByIDsRequest, BinaryDat
         assert request is not None
         self.binary_ids = request.binary_ids
         self.binary_data_ids = request.binary_data_ids
+        self.include_binary = request.include_binary
         await stream.send_message(BinaryDataByIDsResponse(data=self.binary_response))
 
     async def DeleteTabularData(self, stream: Stream[DeleteTabularDataRequest, DeleteTabularDataResponse]) -> None:

tests/test_data_client.py

@@ -308,10 +308,18 @@ async def test_binary_data_by_ids(self, service: MockData):
             client = DataClient(channel, DATA_SERVICE_METADATA)
             binary_data = await client.binary_data_by_ids(binary_ids=BINARY_IDS)
             assert binary_data == BINARY_RESPONSE
+            assert service.include_binary is True
             self.assert_binary_ids(binary_ids=list(service.binary_ids))
             binary_data = await client.binary_data_by_ids(binary_ids=BINARY_DATA_IDS)
             assert binary_data == BINARY_RESPONSE
+            assert service.include_binary is True
             self.assert_binary_data_ids(binary_data_ids=list(service.binary_data_ids))
+            binary_data = await client.binary_data_by_ids(binary_ids=BINARY_IDS, include_binary_data=False)
+            assert binary_data == BINARY_RESPONSE
+            assert service.include_binary is False
+            binary_data = await client.binary_data_by_ids(binary_ids=BINARY_DATA_IDS, include_binary_data=False)
+            assert binary_data == BINARY_RESPONSE
+            assert service.include_binary is False
 
     async def test_delete_tabular_data(self, service: MockData):
         async with ChannelFor([service]) as channel: