Merge pull request #797 from adamtheturtle/test-target-list

Add function for listing targets

Author: adamtheturtle

src/vws/vws.py

@@ -6,7 +6,7 @@
 import io
 import json
 from time import sleep
-from typing import Any, Dict, Union
+from typing import Any, Dict, List, Union
 from urllib.parse import urljoin
 
 import requests
@@ -179,3 +179,21 @@ def wait_for_target_processed(self, target_id: str) -> None:
             # number of calls made to the API, to decrease the likelihood of
             # hitting the request quota.
             sleep(0.2)
+
+    def list_targets(self) -> List[str]:
+        """
+        Get a list of targets.
+
+        Returns:
+            The IDs of all targets in the database.
+        """
+        response = _target_api_request(
+            server_access_key=self._server_access_key,
+            server_secret_key=self._server_secret_key,
+            method='GET',
+            content=b'',
+            request_path='/targets',
+            base_vws_url=self._base_vws_url,
+        )
+
+        return list(response.json()['results'])

tests/test_target_list.py

@@ -0,0 +1,25 @@
+"""
+Tests for helper function for getting a list of targets.
+"""
+
+import io
+
+from vws import VWS
+
+
+class TestListTargets:
+    """
+    Test for listing targets.
+    """
+
+    def test_list_targets(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        It is possible to get a list of target IDs.
+        """
+        id_1 = client.add_target(name='x', width=1, image=high_quality_image)
+        id_2 = client.add_target(name='a', width=1, image=high_quality_image)
+        assert sorted(client.list_targets()) == sorted([id_1, id_2])