Added tests and additional params to more methods

Author: chinacat567

src/dicomweb_client/web.py

@@ -1802,6 +1802,7 @@ def _get_bulkdata(
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
         byte_range: Optional[Tuple[int, int]] = None,
         stream: bool = False,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[bytes]:
         """Get bulk data items at a given location.
 
@@ -1817,6 +1818,8 @@ def _get_bulkdata(
         stream: bool, optional
             Whether data should be streamed (i.e., requested using chunked
             transfer encoding)
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -1826,26 +1829,45 @@ def _get_bulkdata(
         """  # noqa: E501
         if media_types is None:
             return self._http_get_multipart(
-                url, media_types, byte_range=byte_range, stream=stream
+                url,
+                media_types,
+                byte_range=byte_range,
+                params=additional_params,
+                stream=stream,
             )
         common_media_types = self._get_common_media_types(media_types)
         if len(common_media_types) > 1:
             return self._http_get_multipart(
-                url, media_types, byte_range=byte_range, stream=stream
+                url, media_types,
+                byte_range=byte_range,
+                params=additional_params,
+                stream=stream,
             )
         else:
             common_media_type = common_media_types[0]
             if common_media_type == 'application/octet-stream':
                 return self._http_get_multipart_application_octet_stream(
-                    url, media_types, byte_range=byte_range, stream=stream
+                    url,
+                    media_types,
+                    byte_range=byte_range,
+                    params=additional_params,
+                    stream=stream
                 )
             elif common_media_type.startswith('image'):
                 return self._http_get_multipart_image(
-                    url, media_types, byte_range=byte_range, stream=stream
+                    url,
+                    media_types,
+                    byte_range=byte_range,
+                    params=additional_params,
+                    stream=stream
                 )
             elif common_media_type.startswith('video'):
                 return self._http_get_multipart_video(
-                    url, media_types, byte_range=byte_range, stream=stream
+                    url,
+                    media_types,
+                    byte_range=byte_range,
+                    params=additional_params,
+                    stream=stream
                 )
             else:
                 raise ValueError(
@@ -1857,7 +1879,8 @@ def retrieve_bulkdata(
         self,
         url: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
-        byte_range: Optional[Tuple[int, int]] = None
+        byte_range: Optional[Tuple[int, int]] = None,
+        additional_params: Optional[Dict[str, Any]] = None,
     ) -> List[bytes]:
         """Retrieve bulk data at a given location.
 
@@ -1870,6 +1893,8 @@ def retrieve_bulkdata(
             corresponding transfer syntaxes
         byte_range: Union[Tuple[int, int], None], optional
             Start and end of byte range
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -1882,15 +1907,17 @@ def retrieve_bulkdata(
                 url=url,
                 media_types=media_types,
                 byte_range=byte_range,
-                stream=False
+                stream=False,
+                additional_params=additional_params,
             )
         )
 
     def iter_bulkdata(
         self,
         url: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
-        byte_range: Optional[Tuple[int, int]] = None
+        byte_range: Optional[Tuple[int, int]] = None,
+        additional_params: Optional[Dict[str, Any]] = None,
     ) -> Iterator[bytes]:
         """Iterate over bulk data items at a given location.
 
@@ -1903,6 +1930,8 @@ def iter_bulkdata(
             corresponding transfer syntaxes
         byte_range: Union[Tuple[int, int], None], optional
             Start and end of byte range
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -1918,15 +1947,16 @@ def iter_bulkdata(
             url=url,
             media_types=media_types,
             byte_range=byte_range,
-            stream=True
+            stream=True,
+            additional_params=additional_params,
         )
 
     def _get_study(
         self,
         study_instance_uid: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
         stream: bool = False,
-        params: Optional[Dict[str, Any]] = None
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[pydicom.dataset.Dataset]:
         """Get all instances of a study.
 
@@ -1940,7 +1970,7 @@ def _get_study(
         stream: bool, optional
             Whether data should be streamed (i.e., requested using chunked
             transfer encoding)
-        params: Union[Dict[str, Any], None], optional
+        additional_params: Union[Dict[str, Any], None], optional
             Additional HTTP GET query parameters
 
         Returns
@@ -1957,7 +1987,7 @@ def _get_study(
         if media_types is None:
             return self._http_get_multipart_application_dicom(
                 url,
-                params=params,
+                params=additional_params,
                 stream=stream
             )
         common_media_types = self._get_common_media_types(media_types)
@@ -1975,7 +2005,7 @@ def _get_study(
         return self._http_get_multipart_application_dicom(
             url,
             media_types=media_types,
-            params=params,
+            params=additional_params,
             stream=stream
         )
 
@@ -2061,14 +2091,17 @@ def iter_study(
 
     def retrieve_study_metadata(
         self,
-        study_instance_uid: str
+        study_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> List[Dict[str, dict]]:
         """Retrieve metadata of all instances of a study.
 
         Parameters
         ----------
         study_instance_uid: str
             Study Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters 
 
         Returns
         -------
@@ -2083,7 +2116,7 @@ def retrieve_study_metadata(
             )
         url = self._get_studies_url(_Transaction.RETRIEVE, study_instance_uid)
         url += '/metadata'
-        return self._http_get_application_json(url)
+        return self._http_get_application_json(url, params=additional_params)
 
     def delete_study(self, study_instance_uid: str) -> None:
         """Delete all instances of a study.
@@ -2211,7 +2244,7 @@ def _get_series(
         series_instance_uid: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
         stream: bool = False,
-        params: Optional[Dict[str, Any]] = None
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[pydicom.dataset.Dataset]:
         """Get instances of a series.
 
@@ -2227,7 +2260,7 @@ def _get_series(
         stream: bool, optional
             Whether data should be streamed (i.e., requested using chunked
             transfer encoding)
-        params: Union[Dict[str, Any], None], optional
+        additional_params: Union[Dict[str, Any], None], optional
             Additional HTTP GET query parameters
 
         Returns
@@ -2258,7 +2291,7 @@ def _get_series(
         if media_types is None:
             return self._http_get_multipart_application_dicom(
                 url,
-                params=params,
+                params=additional_params,
                 stream=stream
             )
         common_media_types = self._get_common_media_types(media_types)
@@ -2276,7 +2309,7 @@ def _get_series(
         return self._http_get_multipart_application_dicom(
             url,
             media_types=media_types,
-            params=params,
+            params=additional_params,
             stream=stream
         )
 
@@ -2372,6 +2405,7 @@ def retrieve_series_metadata(
         self,
         study_instance_uid: str,
         series_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> List[Dict[str, dict]]:
         """Retrieve metadata for all instances of a series.
 
@@ -2381,6 +2415,8 @@ def retrieve_series_metadata(
             Study Instance UID
         series_instance_uid: str
             Series Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2410,7 +2446,7 @@ def retrieve_series_metadata(
             series_instance_uid
         )
         url += '/metadata'
-        return self._http_get_application_json(url)
+        return self._http_get_application_json(url, params=additional_params)
 
     def retrieve_series_rendered(
         self, study_instance_uid,
@@ -2602,6 +2638,8 @@ def search_for_instances(
             fields=fields,
             search_filters=search_filters
         )
+        if additional_params:
+            params.update(additional_params)
         return self._http_get_application_json(
             url,
             params=params,
@@ -2614,7 +2652,7 @@ def retrieve_instance(
         series_instance_uid: str,
         sop_instance_uid: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
-        params: Optional[Dict[str, Any]] = None
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> pydicom.dataset.Dataset:
         """Retrieve an individual instance.
 
@@ -2629,7 +2667,7 @@ def retrieve_instance(
         media_types: Union[Tuple[Union[str, Tuple[str, str]], ...], None], optional
             Acceptable media types and optionally the UIDs of the
             acceptable transfer syntaxes
-        params: Union[Dict[str, Any], None], optional
+        additional_params: Union[Dict[str, Any], None], optional
             Additional HTTP GET query parameters
 
         Returns
@@ -2692,7 +2730,7 @@ def retrieve_instance(
         iterator = self._http_get_multipart_application_dicom(
             url,
             media_types=media_types,
-            params=params
+            params=additional_params
         )
         instances = list(iterator)
         if len(instances) > 1:
@@ -2789,7 +2827,8 @@ def retrieve_instance_metadata(
         self,
         study_instance_uid: str,
         series_instance_uid: str,
-        sop_instance_uid: str
+        sop_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Dict[str, dict]:
         """Retrieve metadata of an individual instance.
 
@@ -2801,6 +2840,8 @@ def retrieve_instance_metadata(
             Series Instance UID
         sop_instance_uid: str
             SOP Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2830,7 +2871,7 @@ def retrieve_instance_metadata(
             sop_instance_uid
         )
         url += '/metadata'
-        return self._http_get_application_json(url)[0]
+        return self._http_get_application_json(url, params=additional_params)[0]
 
     def retrieve_instance_rendered(
         self,
@@ -2920,7 +2961,8 @@ def _get_instance_frames(
         sop_instance_uid: str,
         frame_numbers: Sequence[int],
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
-        stream: bool = False
+        stream: bool = False,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[bytes]:
         """Get frames of an instance.
 
@@ -2940,6 +2982,8 @@ def _get_instance_frames(
         stream: bool, optional
             Whether data should be streamed (i.e., requested using chunked
             transfer encoding)
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2968,40 +3012,49 @@ def _get_instance_frames(
         frame_list = ','.join([str(n) for n in frame_numbers])
         url += f'/frames/{frame_list}'
         if media_types is None:
-            return self._http_get_multipart(url, stream=stream)
+            return self._http_get_multipart(
+                url, 
+                stream=stream,
+                params=additional_params
+                )
 
         common_media_types = self._get_common_media_types(media_types)
         if len(common_media_types) > 1:
             return self._http_get_multipart(
                 url,
                 media_types=media_types,
-                stream=stream
+                stream=stream,
+                params=additional_params
             )
 
         common_media_type = common_media_types[0]
         if common_media_type == 'application/octet-stream':
             return self._http_get_multipart_application_octet_stream(
                 url,
                 media_types=media_types,
-                stream=stream
+                stream=stream,
+                params=additional_params
             )
         elif common_media_type.startswith('image'):
             return self._http_get_multipart_image(
                 url,
                 media_types=media_types,
-                stream=stream
+                stream=stream,
+                params=additional_params
             )
         elif common_media_type.startswith('video'):
             return self._http_get_multipart_video(
                 url,
                 media_types=media_types,
-                stream=stream
+                stream=stream,
+                params=additional_params
             )
         elif common_media_type.startswith('*'):
             return self._http_get_multipart(
                 url,
                 media_types=media_types,
-                stream=stream
+                stream=stream,
+                params=additional_params
             )
         else:
             raise ValueError(