Merge pull request #113 from doccano/feature/filter-example-by-confirmation-state

Enable to filter examples by confirmation state

Author: Hironsan

doccano_client/client.py

@@ -526,16 +526,17 @@ def upload_label_type(self, project_id: int, file_path: str, type: Literal["cate
         """
         self._get_label_type_usecase(type).upload(project_id, file_path)
 
-    def list_examples(self, project_id: int) -> Iterator[Example]:
+    def list_examples(self, project_id: int, is_confirmed: Optional[bool] = None) -> Iterator[Example]:
         """Return all examples.
 
         Args:
             project_id (int): The id of the project.
+            is_confirmed (bool, optional): Filter by confirmed state. Defaults to None.
 
         Yields:
             Example: The examples in the project.
         """
-        yield from self.example.list(project_id)
+        yield from self.example.list(project_id, is_confirmed)
 
     def find_example_by_id(self, project_id: int, example_id: int) -> Example:
         """Find an example by id.

doccano_client/repositories/example.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Iterator, List
+from typing import Iterator, List, Optional
 
 from doccano_client.models.example import Example
 from doccano_client.repositories.base import BaseRepository
@@ -37,16 +37,20 @@ def count(self, project_id: int) -> int:
         response = self._client.get(f"projects/{project_id}/examples")
         return response.json()["count"]
 
-    def list(self, project_id: int) -> Iterator[Example]:
+    def list(self, project_id: int, is_confirmed: Optional[bool] = None) -> Iterator[Example]:
         """Return all examples in which you are a member
 
         Args:
             project_id (int): The id of the project
+            is_confirmed (bool, optional): Filter by confirmed state. Defaults to None.
 
         Yields:
             Example: The next example.
         """
-        response = self._client.get(f"projects/{project_id}/examples")
+        params = {}
+        if is_confirmed is not None:
+            params["confirmed"] = is_confirmed
+        response = self._client.get(f"projects/{project_id}/examples", params=params)
 
         while True:
             examples = response.json()

doccano_client/usecase/example.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Iterator, List
+from typing import Any, Dict, Iterator, List, Optional
 
 from doccano_client.models.example import Example
 from doccano_client.repositories.example import ExampleRepository
@@ -31,16 +31,17 @@ def count(self, project_id: int) -> int:
         """
         return self._repository.count(project_id)
 
-    def list(self, project_id: int) -> Iterator[Example]:
+    def list(self, project_id: int, is_confirmed: Optional[bool] = None) -> Iterator[Example]:
         """Return all examples
 
         Args:
             project_id (int): The id of the project
+            is_confirmed (bool, optional): Filter by confirmed state. Defaults to None.
 
         Yields:
             Example: The examples in the project.
         """
-        yield from self._repository.list(project_id)
+        yield from self._repository.list(project_id, is_confirmed)
 
     def create(
         self,

tests/unit/usecase/test_example.py

@@ -25,7 +25,7 @@ def test_find_by_id(self):
 
     def test_list(self):
         list(self.usecase.list(0))
-        self.repository.list.assert_called_once_with(0)
+        self.repository.list.assert_called_once_with(0, None)
 
     def test_create(self, payload):
         project_id = 0