adding additional_params to delete methods (delete_study, delete_series, delete_instance)

Author: chinacat567

src/dicomweb_client/web.py

@@ -21,7 +21,7 @@
     Union,
     Tuple,
 )
-from urllib.parse import urlparse
+from urllib.parse import urlencode, urlparse
 from warnings import warn
 from xml.etree.ElementTree import (
     Element,
@@ -2126,13 +2126,19 @@ def retrieve_study_metadata(
         url += '/metadata'
         return self._http_get_application_json(url, params=additional_params)
 
-    def delete_study(self, study_instance_uid: str) -> None:
+    def delete_study(
+        self,
+        study_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
+    ) -> None:
         """Delete all instances of a study.
 
         Parameters
         ----------
         study_instance_uid: str
             Study Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP DELETE query parameters
 
         Note
         ----
@@ -2149,6 +2155,12 @@ def delete_study(self, study_instance_uid: str) -> None:
                 'Study Instance UID is required for deletion of a study.'
             )
         url = self._get_studies_url(_Transaction.DELETE, 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}'
         self._http_delete(url)
 
     def _assert_uid_format(self, uid: str) -> None:
@@ -2541,7 +2553,8 @@ def retrieve_series_rendered(
     def delete_series(
         self,
         study_instance_uid: str,
-        series_instance_uid: str
+        series_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> None:
         """Delete all instances of a series.
 
@@ -2551,6 +2564,8 @@ def delete_series(
             Study Instance UID
         series_instance_uid: str
             Series Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP DELETE query parameters
 
         Note
         ----
@@ -2579,6 +2594,12 @@ def delete_series(
             study_instance_uid,
             series_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}'
         self._http_delete(url)
 
     def search_for_instances(
@@ -2796,7 +2817,8 @@ def delete_instance(
         self,
         study_instance_uid: str,
         series_instance_uid: str,
-        sop_instance_uid: str
+        sop_instance_uid: str,
+        additional_params: Optional[Dict[str, Any]] = None
     ) -> None:
         """Delete specified instance.
 
@@ -2808,6 +2830,8 @@ def delete_instance(
             Series Instance UID
         sop_instance_uid: str
             SOP Instance UID
+        additional_params: Union[Dict[str, Any], None], optional
+            Additional HTTP DELETE query parameters
 
         Note
         ----
@@ -2837,6 +2861,12 @@ def delete_instance(
             series_instance_uid,
             sop_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}'
         self._http_delete(url)
 
     def retrieve_instance_metadata(

tests/test_web.py

@@ -1342,6 +1342,31 @@ def test_delete_study_error(httpserver, client, cache_dir):
     assert request.method == 'DELETE'
 
 
+def test_delete_study_error_with_additional_params(
+    httpserver, client, cache_dir
+):
+    study_instance_uid = '1.2.3'
+    httpserver.serve_content(
+        content='',
+        code=HTTPStatus.METHOD_NOT_ALLOWED,
+        headers=''
+    )
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    with pytest.raises(HTTPError):
+        client.delete_study(
+            study_instance_uid=study_instance_uid,
+            additional_params=params
+        )
+    assert len(httpserver.requests) == 1
+    request = httpserver.requests[0]
+    expected_path = f'/studies/{study_instance_uid}'
+    assert request.path == expected_path
+    assert request.method == 'DELETE'
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+
+
 def test_delete_series_error(httpserver, client, cache_dir):
     study_instance_uid = '1.2.3'
     series_instance_uid = '1.2.4'
@@ -1363,6 +1388,34 @@ def test_delete_series_error(httpserver, client, cache_dir):
     assert request.method == 'DELETE'
 
 
+def test_delete_series_error_with_additional_params(
+    httpserver, client, cache_dir
+):
+    study_instance_uid = '1.2.3'
+    series_instance_uid = '1.2.4'
+    httpserver.serve_content(
+        content='',
+        code=HTTPStatus.METHOD_NOT_ALLOWED,
+        headers=''
+    )
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    with pytest.raises(HTTPError):
+        client.delete_series(study_instance_uid=study_instance_uid,
+                             series_instance_uid=series_instance_uid,
+                             additional_params=params)
+    assert len(httpserver.requests) == 1
+    request = httpserver.requests[0]
+    expected_path = (
+        f'/studies/{study_instance_uid}'
+        f'/series/{series_instance_uid}'
+    )
+    assert request.path == expected_path
+    assert request.method == 'DELETE'
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+
+
 def test_delete_instance_error(httpserver, client, cache_dir):
     study_instance_uid = '1.2.3'
     series_instance_uid = '1.2.4'
@@ -1387,6 +1440,37 @@ def test_delete_instance_error(httpserver, client, cache_dir):
     assert request.method == 'DELETE'
 
 
+def test_delete_instance_error_with_additional_params(
+    httpserver, client, cache_dir
+):
+    study_instance_uid = '1.2.3'
+    series_instance_uid = '1.2.4'
+    sop_instance_uid = '1.2.5'
+    httpserver.serve_content(
+        content='',
+        code=HTTPStatus.METHOD_NOT_ALLOWED,
+        headers=''
+    )
+    params = {"key1": ["value1", "value2"], "key2": "value3"}
+    with pytest.raises(HTTPError):
+        client.delete_instance(study_instance_uid=study_instance_uid,
+                               series_instance_uid=series_instance_uid,
+                               sop_instance_uid=sop_instance_uid,
+                               additional_params=params)
+    assert len(httpserver.requests) == 1
+    request = httpserver.requests[0]
+    expected_path = (
+        f'/studies/{study_instance_uid}'
+        f'/series/{series_instance_uid}'
+        f'/instances/{sop_instance_uid}'
+    )
+    assert request.path == expected_path
+    assert request.method == 'DELETE'
+    assert request.query_string.decode() == (
+        'key1=value1&key1=value2&key2=value3'
+    )
+
+
 def test_load_json_dataset_da(httpserver, client, cache_dir):
     value = ['2018-11-21']
     dicom_json = {