adding additional params to POST method (store_instances)

Author: chinacat567

src/dicomweb_client/web.py

@@ -2778,7 +2778,8 @@ def retrieve_instance(
     def store_instances(
         self,
         datasets: Sequence[pydicom.dataset.Dataset],
-        study_instance_uid: Optional[str] = None
+        study_instance_uid: Optional[str] = None,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> pydicom.dataset.Dataset:
         """Store instances.
 
@@ -2788,6 +2789,8 @@ def store_instances(
             Instances that should be stored
         study_instance_uid: Union[str, None], optional
             Study Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP POST query parameters
 
         Returns
         -------
@@ -2807,6 +2810,12 @@ def _iter_encoded_datasets(datasets):
             message += f' of study "{study_instance_uid}"'
         logger.info(message)
         url = self._get_studies_url(_Transaction.STORE, study_instance_uid)
+        # Append query string if additional_params is provided
+        if additional_params:
+            additional_params_query_string = urlencode(
+                additional_params, doseq=True
+            )
+            url += f'?{additional_params_query_string}'
         encoded_datasets = _iter_encoded_datasets(datasets)
         return self._http_post_multipart_application_dicom(
             url,

tests/test_web.py

@@ -1307,6 +1307,36 @@ def test_store_instance_error_with_retries(httpserver, client, cache_dir):
     )
 
 
+def test_store_instance_error_with_retries_and_additional_params(
+    httpserver, client, cache_dir
+):
+    dataset = pydicom.Dataset.from_json({})
+    dataset.is_little_endian = True
+    dataset.is_implicit_VR = True
+    max_attempts = 2
+    client.set_http_retry_params(
+        retry=True,
+        max_attempts=max_attempts,
+        wait_exponential_multiplier=10
+    )
+    httpserver.serve_content(
+        content='',
+        code=HTTPStatus.REQUEST_TIMEOUT,
+        headers=''
+    )
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    with pytest.raises(RetryError):
+        client.store_instances([dataset], additional_params=params)
+    assert len(httpserver.requests) == max_attempts
+    request = httpserver.requests[0]
+    assert request.headers['Content-Type'].startswith(
+        'multipart/related; type="application/dicom"'
+    )
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+
+
 def test_store_instance_error_with_no_retries(httpserver, client, cache_dir):
     dataset = pydicom.Dataset.from_json({})
     dataset.is_little_endian = True
@@ -1326,6 +1356,31 @@ def test_store_instance_error_with_no_retries(httpserver, client, cache_dir):
     )
 
 
+def test_store_instance_error_with_no_retries_and_additional_params(
+    httpserver, client, cache_dir
+):
+    dataset = pydicom.Dataset.from_json({})
+    dataset.is_little_endian = True
+    dataset.is_implicit_VR = True
+    client.set_http_retry_params(retry=False)
+    httpserver.serve_content(
+        content='',
+        code=HTTPStatus.REQUEST_TIMEOUT,
+        headers=''
+    )
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    with pytest.raises(HTTPError):
+        client.store_instances([dataset], additional_params=params)
+    assert len(httpserver.requests) == 1
+    request = httpserver.requests[0]
+    assert request.headers['Content-Type'].startswith(
+        'multipart/related; type="application/dicom"'
+    )
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+
+
 def test_delete_study_error(httpserver, client, cache_dir):
     study_instance_uid = '1.2.3'
     httpserver.serve_content(