Merge pull request #21 from ntenenz/master

Add more specific return types: Sequence -> List

Author: hackermd

src/dicomweb_client/api.py

@@ -694,7 +694,7 @@ def _decode_multipart_message(
             self,
             body: bytes,
             headers: Dict[str, str]
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Extracts parts of a HTTP multipart response message.
 
         Parameters
@@ -706,7 +706,7 @@ def _decode_multipart_message(
 
         Returns
         -------
-        Sequence[bytes]
+        List[bytes]
             message parts
 
         '''
@@ -946,7 +946,7 @@ def _http_get_multipart_application_dicom(
             url: str,
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None,
             params: Optional[Dict[str, Any]] = None
-        ) -> Sequence[pydicom.dataset.Dataset]:
+        ) -> List[pydicom.dataset.Dataset]:
         '''Performs a HTTP GET request that accepts a multipart message with
         "applicaton/dicom" media type.
 
@@ -1009,7 +1009,7 @@ def _http_get_multipart_application_octet_stream(
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None,
             byte_range: Optional[Tuple[int, int]] = None,
             params: Optional[Dict[str, Any]] = None
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Performs a HTTP GET request that accepts a multipart message with
         "applicaton/octet-stream" media type.
 
@@ -1059,7 +1059,7 @@ def _http_get_multipart_image(
             byte_range: Optional[Tuple[int, int]] = None,
             params: Optional[Dict[str, Any]] = None,
             rendered: bool = False
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Performs a HTTP GET request that accepts a multipart message with
         an image media type.
 
@@ -1125,7 +1125,7 @@ def _http_get_multipart_video(
             byte_range: Optional[Tuple[int, int]] = None,
             params: Optional[Dict[str, Any]] = None,
             rendered: bool = False
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Performs a HTTP GET request that accepts a multipart message with
         a video media type.
 
@@ -1411,7 +1411,7 @@ def search_for_studies(
             offset: Optional[int] = None,
             fields: Optional[Sequence[str]] = None,
             search_filters: Optional[Dict[str, Any]] = None
-        ) -> Sequence[Dict[str, dict]]:
+        ) -> List[Dict[str, dict]]:
         '''Searches for DICOM studies.
 
         Parameters
@@ -1450,7 +1450,7 @@ def search_for_studies(
         studies = self._http_get_application_json(url, params)
         if studies is None:
             return []
-        if not(isinstance(studies, list)):
+        if not isinstance(studies, list):
             studies = [studies]
         return studies
 
@@ -1529,7 +1529,7 @@ def retrieve_bulkdata(
             url: str,
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None,
             byte_range: Optional[Tuple[int, int]] = None
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Retrieves bulk data from a given location.
 
         Parameters
@@ -1571,7 +1571,7 @@ def retrieve_study(
             self,
             study_instance_uid: str,
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None,
-        ) -> Sequence[pydicom.dataset.Dataset]:
+        ) -> List[pydicom.dataset.Dataset]:
         '''Retrieves instances of a given DICOM study.
 
         Parameters
@@ -1621,7 +1621,7 @@ def retrieve_study(
     def retrieve_study_metadata(
             self,
             study_instance_uid: str
-        ) -> Sequence[Dict[str, dict]]:
+        ) -> List[Dict[str, dict]]:
         '''Retrieves metadata of instances of a given DICOM study.
 
         Parameters
@@ -1644,7 +1644,7 @@ def retrieve_study_metadata(
         url += '/metadata'
         return self._http_get_application_json(url)
 
-    def _assert_uid_format(self, uid: str):
+    def _assert_uid_format(self, uid: str) -> None:
         '''Checks whether a DICOM UID has the correct format.
 
         Parameters
@@ -1675,7 +1675,7 @@ def search_for_series(
             offset: Optional[int] = None,
             fields: Optional[Sequence[str]] = None,
             search_filters: Optional[Dict[str, Any]] = None
-        ) -> Sequence[Dict[str, dict]]:
+        ) -> List[Dict[str, dict]]:
         '''Searches for DICOM series.
 
         Parameters
@@ -1727,7 +1727,7 @@ def retrieve_series(
             study_instance_uid: str,
             series_instance_uid: str,
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None
-        ) -> Sequence[pydicom.dataset.Dataset]:
+        ) -> List[pydicom.dataset.Dataset]:
         '''Retrieves instances of a given DICOM series.
 
         Parameters
@@ -1788,7 +1788,7 @@ def retrieve_series_metadata(
             self,
             study_instance_uid: str,
             series_instance_uid: str,
-        ) -> Sequence[Dict[str, dict]]:
+        ) -> List[Dict[str, dict]]:
         '''Retrieves metadata for instances of a given DICOM series.
 
         Parameters
@@ -1892,7 +1892,7 @@ def search_for_instances(
             offset: Optional[int] = None,
             fields: Optional[Sequence[str]] = None,
             search_filters: Optional[Dict[str, Any]] = None
-        ) -> Sequence[Dict[str, dict]]:
+        ) -> List[Dict[str, dict]]:
         '''Searches for DICOM instances.
 
         Parameters
@@ -2175,7 +2175,7 @@ def retrieve_instance_frames(
             sop_instance_uid: str,
             frame_numbers: Sequence[int],
             media_types: Optional[Tuple[Union[str, Tuple[str, str]]]] = None
-        ) -> Sequence[bytes]:
+        ) -> List[bytes]:
         '''Retrieves one or more frames of an individual DICOM instance.
 
         Parameters