adding additional params to retrieve_study, iter_study, retrieve_series, iter_series

Author: chinacat567

src/dicomweb_client/web.py

@@ -2013,6 +2013,7 @@ def retrieve_study(
         self,
         study_instance_uid: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> List[pydicom.dataset.Dataset]:
         """Retrieve all instances of a study.
 
@@ -2023,6 +2024,8 @@ def retrieve_study(
         media_types: Union[Tuple[Union[str, Tuple[str, str]], ...], None], optional
             Acceptable media types and optionally the UIDs of the
             acceptable transfer syntaxes
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2044,14 +2047,16 @@ def retrieve_study(
             self._get_study(
                 study_instance_uid=study_instance_uid,
                 media_types=media_types,
-                stream=False
+                stream=False,
+                additional_params=additional_params
             )
         )
 
     def iter_study(
         self,
         study_instance_uid: str,
         media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[pydicom.dataset.Dataset]:
         """Iterate over all instances of a study.
 
@@ -2062,6 +2067,8 @@ def iter_study(
         media_types: Union[Tuple[Union[str, Tuple[str, str]], ...], None], optional
             Acceptable media types and optionally the UIDs of the
             acceptable transfer syntaxes
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2086,7 +2093,8 @@ def iter_study(
         return self._get_study(
             study_instance_uid=study_instance_uid,
             media_types=media_types,
-            stream=True
+            stream=True,
+            additional_params=additional_params
         )
 
     def retrieve_study_metadata(
@@ -2317,7 +2325,8 @@ def retrieve_series(
         self,
         study_instance_uid: str,
         series_instance_uid: str,
-        media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None
+        media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> List[pydicom.dataset.Dataset]:
         """Retrieve all instances of a series.
 
@@ -2330,6 +2339,8 @@ def retrieve_series(
         media_types: Union[Tuple[Union[str, Tuple[str, str]], ...], None], optional
             Acceptable media types and optionally the UIDs of the
             acceptable transfer syntaxes
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2352,15 +2363,17 @@ def retrieve_series(
                 study_instance_uid=study_instance_uid,
                 series_instance_uid=series_instance_uid,
                 media_types=media_types,
-                stream=False
+                stream=False,
+                additional_params=additional_params
             )
         )
 
     def iter_series(
         self,
         study_instance_uid: str,
         series_instance_uid: str,
-        media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None
+        media_types: Optional[Tuple[Union[str, Tuple[str, str]], ...]] = None,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> Iterator[pydicom.dataset.Dataset]:
         """Iterate over all instances of a series.
 
@@ -2373,6 +2386,8 @@ def iter_series(
         media_types: Union[Tuple[Union[str, Tuple[str, str]], ...], None], optional
             Acceptable media types and optionally the UIDs of the
             acceptable transfer syntaxes
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP GET query parameters
 
         Returns
         -------
@@ -2398,7 +2413,8 @@ def iter_series(
             study_instance_uid=study_instance_uid,
             series_instance_uid=series_instance_uid,
             media_types=media_types,
-            stream=True
+            stream=True,
+            additional_params=additional_params
         )
 
     def retrieve_series_metadata(

tests/test_web.py

@@ -554,6 +554,53 @@ def test_iter_series(client, httpserver, cache_dir):
     assert len(response) == n_resources
 
 
+def test_iter_series_with_additional_params(client, httpserver, cache_dir):
+    cache_filename = str(cache_dir.joinpath('file.dcm'))
+    with open(cache_filename, 'rb') as f:
+        data = f.read()
+
+    n_resources = 3
+    chunk_size = 10**3
+    media_type = 'application/dicom'
+    boundary = 'boundary'
+    headers = {
+        'content-type': (
+            'multipart/related; '
+            f'type="{media_type}"; '
+            f'boundary="{boundary}"'
+        ),
+        'transfer-encoding': 'chunked'
+    }
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+
+    message = DICOMwebClient._encode_multipart_message(
+        content=[data for _ in range(n_resources)],
+        content_type=headers['content-type']
+    )
+    chunked_message = _chunk_message(message, chunk_size)
+
+    httpserver.serve_content(content=chunked_message, code=200, headers=headers)
+    study_uid = '1.2.3'
+    series_uid = '1.2.4'
+    iterator = client.iter_series(
+        study_uid, series_uid, additional_params=params
+    )
+    assert isinstance(iterator, Generator)
+    response = list(iterator)
+    for instance in response:
+        with BytesIO() as fp:
+            pydicom.dcmwrite(fp, instance)
+            raw_result = fp.getvalue()
+        assert raw_result == data
+    request = httpserver.requests[0]
+    assert request.path == f'/studies/{study_uid}/series/{series_uid}'
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+    assert request.accept_mimetypes[0][0][:43] == headers['content-type'][:43]
+    assert len(response) == n_resources
+
+
 def test_retrieve_series(client, httpserver, cache_dir):
     cache_filename = str(cache_dir.joinpath('file.dcm'))
     with open(cache_filename, 'rb') as f:
@@ -594,6 +641,50 @@ def test_retrieve_series(client, httpserver, cache_dir):
     assert len(response) == n_resources
 
 
+def test_retrieve_series_with_additional_params(client, httpserver, cache_dir):
+    cache_filename = str(cache_dir.joinpath('file.dcm'))
+    with open(cache_filename, 'rb') as f:
+        data = f.read()
+
+    n_resources = 3
+    media_type = 'application/dicom'
+    boundary = 'boundary'
+    headers = {
+        'content-type': (
+            'multipart/related; '
+            f'type="{media_type}"; '
+            f'boundary="{boundary}"'
+        ),
+    }
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    message = DICOMwebClient._encode_multipart_message(
+        content=[data for _ in range(n_resources)],
+        content_type=headers['content-type']
+    )
+    httpserver.serve_content(content=message, code=200, headers=headers)
+    study_instance_uid = '1.2.3'
+    series_instance_uid = '1.2.4'
+    response = client.retrieve_series(
+        study_instance_uid, series_instance_uid, additional_params=params
+    )
+    for resource in response:
+        with BytesIO() as fp:
+            pydicom.dcmwrite(fp, resource)
+            raw_result = fp.getvalue()
+        assert raw_result == data
+    request = httpserver.requests[0]
+    expected_path = (
+        f'/studies/{study_instance_uid}'
+        f'/series/{series_instance_uid}'
+    )
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+    assert request.path == expected_path
+    assert request.accept_mimetypes[0][0][:43] == headers['content-type'][:43]
+    assert len(response) == n_resources
+
+
 def test_retrieve_instance(httpserver, client, cache_dir):
     cache_filename = str(cache_dir.joinpath('file.dcm'))
     with open(cache_filename, 'rb') as f: