Rename QIDO-RS methods

All ``search_*`` methods were renamed to ``search_for*`` to match the
names of the corresponding QIDO-RS resources.

Author: hackermd

src/dicomweb_client/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '0.1.2'
+__version__ = '0.2.0'
 
 from dicomweb_client.api import DICOMWebClient

src/dicomweb_client/api.py

@@ -564,9 +564,9 @@ def _http_post_multipart_application_dicom(self, url, datasets):
         data = self._encode_multipart_message(encoded_datasets, content_type)
         self._http_post(url, data, headers={'Content-Type': content_type})
 
-    def search_studies(self, fuzzymatching=None, limit=None, offset=None,
-                       fields=None, search_filters={}):
-        '''Searches DICOM studies.
+    def search_for_studies(self, fuzzymatching=None, limit=None, offset=None,
+                           fields=None, search_filters={}):
+        '''Searches for DICOM studies.
 
         Parameters
         ----------
@@ -641,9 +641,10 @@ def retrieve_study_metadata(self, study_instance_uid):
         url += '/metadata'
         return self._http_get_application_json(url)
 
-    def search_series(self, study_instance_uid=None, fuzzymatching=None,
-                      limit=None, offset=None, fields=None, search_filters={}):
-        '''Searches DICOM series.
+    def search_for_series(self, study_instance_uid=None, fuzzymatching=None,
+                          limit=None, offset=None, fields=None,
+                          search_filters={}):
+        '''Searches for DICOM series.
 
         Parameters
         ----------
@@ -730,11 +731,11 @@ def retrieve_series_metadata(self, study_instance_uid, series_instance_uid):
         url += '/metadata'
         return self._http_get_application_json(url)
 
-    def search_instances(self, study_instance_uid=None,
-                         series_instance_uid=None, fuzzymatching=None,
-                         limit=None, offset=None, fields=None,
-                         search_filters={}):
-        '''Searches DICOM instances.
+    def search_for_instances(self, study_instance_uid=None,
+                             series_instance_uid=None, fuzzymatching=None,
+                             limit=None, offset=None, fields=None,
+                             search_filters={}):
+        '''Searches for DICOM instances.
 
         Parameters
         ----------

src/dicomweb_client/cli.py

@@ -155,33 +155,33 @@ def _get_parser():
     search_subparsers.required = True
 
     # QIDO - Studies
-    search_studies_parser = search_subparsers.add_parser(
+    search_for_studies_parser = search_subparsers.add_parser(
         'studies',
         description='Search for DICOM studies.',
         parents=[abstract_search_parser, abstract_fmt_parser]
     )
-    search_studies_parser.set_defaults(func=_search_studies)
+    search_for_studies_parser.set_defaults(func=_search_for_studies)
 
     # QUIDO - Series
-    search_series_parser = search_subparsers.add_parser(
+    search_for_series_parser = search_subparsers.add_parser(
         'series',
         description='Search for DICOM series.',
         parents=[
             abstract_search_parser, abstract_fmt_parser,
             abstract_optional_study_parser
         ]
     )
-    search_series_parser.set_defaults(func=_search_series)
+    search_for_series_parser.set_defaults(func=_search_for_series)
 
     # QIDO - Instances
-    search_instances_parser = search_subparsers.add_parser(
+    search_for_instances_parser = search_subparsers.add_parser(
         'instances', description='Search for DICOM instances.',
         parents=[
             abstract_fmt_parser, abstract_search_parser,
             abstract_optional_study_parser, abstract_optional_series_parser
         ]
     )
-    search_instances_parser.set_defaults(func=_search_instances)
+    search_for_instances_parser.set_defaults(func=_search_for_instances)
 
     # WADO
     retrieve_parser = subparsers.add_parser(
@@ -429,27 +429,27 @@ def _print_pixeldata(image):
     print('\n')
 
 
-def _search_studies(args):
+def _search_for_studies(args):
     '''Searches for *Studies* and writes metadata to standard output.'''
     params = _parse_search_parameters(args)
     client = DICOMWebClient(args.url, args.username, args.password)
-    studies = client.search_studies(**params)
+    studies = client.search_for_studies(**params)
     _print_metadata(studies, args.prettify, args.dicomize)
 
 
-def _search_series(args):
+def _search_for_series(args):
     '''Searches for Series and writes metadata to standard output.'''
     params = _parse_search_parameters(args)
     client = DICOMWebClient(args.url, args.username, args.password)
-    series = client.search_series(args.study_instance_uid, **params)
+    series = client.search_for_series(args.study_instance_uid, **params)
     _print_metadata(series, args.prettify, args.dicomize)
 
 
-def _search_instances(args):
+def _search_for_instances(args):
     '''Searches for Instances and writes metadata to standard output.'''
     params = _parse_search_parameters(args)
     client = DICOMWebClient(args.url, args.username, args.password)
-    instances = client.search_instances(
+    instances = client.search_for_instances(
         args.study_instance_uid, args.series_instance_uid, **params
     )
     _print_metadata(instances, args.prettify, args.dicomize)

src/dicomweb_client/data/search_instances.json renamed to src/dicomweb_client/data/search_for_instances.json

@@ -6,29 +6,29 @@
 from PIL import Image
 
 
-def test_search_studies(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_studies.json')
+def test_search_for_studies(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_studies.json')
     with open(cache_filename, 'r') as f:
         content = f.read()
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_studies() == parsed_content
+    assert client.search_for_studies() == parsed_content
     request = httpserver.requests[0]
     assert request.path == '/studies'
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_studies_limit_offset(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_studies.json')
+def test_search_for_studies_limit_offset(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_studies.json')
     with open(cache_filename, 'r') as f:
         data = json.loads(f.read())
     # We will limit the search to 2 studies starting with the 2nd.
     content = json.dumps(data[1:3])
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_studies(limit=2, offset=1) == parsed_content
+    assert client.search_for_studies(limit=2, offset=1) == parsed_content
     request = httpserver.requests[0]
     assert (
         request.query_string.decode() == 'limit=2&offset=1' or
@@ -38,28 +38,28 @@ def test_search_studies_limit_offset(httpserver, client, cache_dir):
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_series(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_series.json')
+def test_search_for_series(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_series.json')
     with open(cache_filename, 'r') as f:
         content = f.read()
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_series() == parsed_content
+    assert client.search_for_series() == parsed_content
     request = httpserver.requests[0]
     assert request.path == '/series'
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_series_limit_offset(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_series.json')
+def test_search_for_series_limit_offset(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_series.json')
     with open(cache_filename, 'r') as f:
         data = json.loads(f.read())
     content = json.dumps(data[1:3])
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_studies(limit=2, offset=1) == parsed_content
+    assert client.search_for_studies(limit=2, offset=1) == parsed_content
     request = httpserver.requests[0]
     assert (
         request.query_string.decode() == 'limit=2&offset=1' or
@@ -69,27 +69,27 @@ def test_search_series_limit_offset(httpserver, client, cache_dir):
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_instances(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_instances.json')
+def test_search_for_instances(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_instances.json')
     with open(cache_filename, 'r') as f:
         content = f.read()
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_instances() == parsed_content
+    assert client.search_for_instances() == parsed_content
     request = httpserver.requests[0]
     assert request.path == '/instances'
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_instances_limit_offset(httpserver, client, cache_dir):
-    cache_filename = os.path.join(cache_dir, 'search_instances.json')
+def test_search_for_instances_limit_offset(httpserver, client, cache_dir):
+    cache_filename = os.path.join(cache_dir, 'search_for_instances.json')
     with open(cache_filename, 'r') as f:
         content = f.read()
     parsed_content = json.loads(content)
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content=content, code=200, headers=headers)
-    assert client.search_instances(limit=2, offset=1) == parsed_content
+    assert client.search_for_instances(limit=2, offset=1) == parsed_content
     request = httpserver.requests[0]
     assert (
         request.query_string.decode() == 'limit=2&offset=1' or
@@ -99,12 +99,12 @@ def test_search_instances_limit_offset(httpserver, client, cache_dir):
     assert request.accept_mimetypes == [('application/dicom+json', 1)]
 
 
-def test_search_instances_includefields(httpserver, client, cache_dir):
+def test_search_for_instances_includefields(httpserver, client, cache_dir):
     headers = {'content-type': 'application/dicom+json'}
     httpserver.serve_content(content='', code=200, headers=headers)
     f1 = 'StudyInstanceUID'
     f2 = 'SeriesInstanceUID'
-    client.search_instances(fields={f1, f2})
+    client.search_for_instances(fields={f1, f2})
     request = httpserver.requests[0]
     query_string_opt_1 = 'includefield={}&includefield={}'.format(f1, f2)
     query_string_opt_2 = 'includefield={}&includefield={}'.format(f2, f1)